269473047d747f7815af570197e4ef7322d3632cEvan Yan/*
269473047d747f7815af570197e4ef7322d3632cEvan Yan * CDDL HEADER START
269473047d747f7815af570197e4ef7322d3632cEvan Yan *
269473047d747f7815af570197e4ef7322d3632cEvan Yan * The contents of this file are subject to the terms of the
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Common Development and Distribution License (the "License").
269473047d747f7815af570197e4ef7322d3632cEvan Yan * You may not use this file except in compliance with the License.
269473047d747f7815af570197e4ef7322d3632cEvan Yan *
269473047d747f7815af570197e4ef7322d3632cEvan Yan * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
269473047d747f7815af570197e4ef7322d3632cEvan Yan * or http://www.opensolaris.org/os/licensing.
269473047d747f7815af570197e4ef7322d3632cEvan Yan * See the License for the specific language governing permissions
269473047d747f7815af570197e4ef7322d3632cEvan Yan * and limitations under the License.
269473047d747f7815af570197e4ef7322d3632cEvan Yan *
269473047d747f7815af570197e4ef7322d3632cEvan Yan * When distributing Covered Code, include this CDDL HEADER in each
269473047d747f7815af570197e4ef7322d3632cEvan Yan * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
269473047d747f7815af570197e4ef7322d3632cEvan Yan * If applicable, add the following below this CDDL HEADER, with the
269473047d747f7815af570197e4ef7322d3632cEvan Yan * fields enclosed by brackets "[]" replaced with your own identifying
269473047d747f7815af570197e4ef7322d3632cEvan Yan * information: Portions Copyright [yyyy] [name of copyright owner]
269473047d747f7815af570197e4ef7322d3632cEvan Yan *
269473047d747f7815af570197e4ef7322d3632cEvan Yan * CDDL HEADER END
269473047d747f7815af570197e4ef7322d3632cEvan Yan */
269473047d747f7815af570197e4ef7322d3632cEvan Yan/*
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Copyright 2009 Sun Microsystems, Inc. All rights reserved.
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Use is subject to license terms.
269473047d747f7815af570197e4ef7322d3632cEvan Yan */
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan#ifndef _SYS_DDI_HP_IMPL_H
269473047d747f7815af570197e4ef7322d3632cEvan Yan#define _SYS_DDI_HP_IMPL_H
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan/*
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Sun DDI hotplug implementation specific definitions
269473047d747f7815af570197e4ef7322d3632cEvan Yan */
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan#ifdef __cplusplus
269473047d747f7815af570197e4ef7322d3632cEvan Yanextern "C" {
269473047d747f7815af570197e4ef7322d3632cEvan Yan#endif
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan#ifdef _KERNEL
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan/* Flags for sync request and async hotplug request */
269473047d747f7815af570197e4ef7322d3632cEvan Yan#define DDI_HP_REQ_SYNC 0x0001
269473047d747f7815af570197e4ef7322d3632cEvan Yan#define DDI_HP_REQ_ASYNC 0x0002
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan/* Check if a handle represents a port or a connector */
269473047d747f7815af570197e4ef7322d3632cEvan Yan#define DDI_HP_IS_VIRTUAL_PORT(hdlp) \
269473047d747f7815af570197e4ef7322d3632cEvan Yan (hdlp->cn_info.cn_type == DDI_HP_CN_TYPE_VIRTUAL_PORT)
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan/*
269473047d747f7815af570197e4ef7322d3632cEvan Yan * ddi_hp_cn_handle_t
269473047d747f7815af570197e4ef7322d3632cEvan Yan *
269473047d747f7815af570197e4ef7322d3632cEvan Yan * DDI handle for a registered Hotplug Connection (CN)
269473047d747f7815af570197e4ef7322d3632cEvan Yan */
269473047d747f7815af570197e4ef7322d3632cEvan Yantypedef struct ddi_hp_cn_handle {
269473047d747f7815af570197e4ef7322d3632cEvan Yan dev_info_t *cn_dip; /* The dip that the handle is linked */
269473047d747f7815af570197e4ef7322d3632cEvan Yan ddi_hp_cn_info_t cn_info; /* Connection info */
269473047d747f7815af570197e4ef7322d3632cEvan Yan struct ddi_hp_cn_handle *next; /* Next Connector/Port. */
269473047d747f7815af570197e4ef7322d3632cEvan Yan} ddi_hp_cn_handle_t;
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yantypedef struct ddi_hp_cn_async_event_entry {
269473047d747f7815af570197e4ef7322d3632cEvan Yan dev_info_t *dip;
269473047d747f7815af570197e4ef7322d3632cEvan Yan char *cn_name;
269473047d747f7815af570197e4ef7322d3632cEvan Yan ddi_hp_cn_state_t target_state;
269473047d747f7815af570197e4ef7322d3632cEvan Yan} ddi_hp_cn_async_event_entry_t;
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan/*
269473047d747f7815af570197e4ef7322d3632cEvan Yan * ddi_hp_op_t
269473047d747f7815af570197e4ef7322d3632cEvan Yan *
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Typedef for Hotplug OPS commands used with bus_hp_op()
269473047d747f7815af570197e4ef7322d3632cEvan Yan */
269473047d747f7815af570197e4ef7322d3632cEvan Yantypedef enum {
269473047d747f7815af570197e4ef7322d3632cEvan Yan DDI_HPOP_CN_GET_STATE = 1, /* Get Connection state */
269473047d747f7815af570197e4ef7322d3632cEvan Yan DDI_HPOP_CN_CHANGE_STATE, /* Change Connection state */
269473047d747f7815af570197e4ef7322d3632cEvan Yan DDI_HPOP_CN_PROBE, /* Probe Connection */
269473047d747f7815af570197e4ef7322d3632cEvan Yan DDI_HPOP_CN_UNPROBE, /* Unprobe Connection */
269473047d747f7815af570197e4ef7322d3632cEvan Yan DDI_HPOP_CN_GET_PROPERTY, /* Get bus specific property */
269473047d747f7815af570197e4ef7322d3632cEvan Yan DDI_HPOP_CN_SET_PROPERTY, /* Set bus specific property */
269473047d747f7815af570197e4ef7322d3632cEvan Yan DDI_HPOP_CN_CREATE_PORT, /* Create a port for virtual hotplug */
269473047d747f7815af570197e4ef7322d3632cEvan Yan DDI_HPOP_CN_REMOVE_PORT /* Remove an empty port */
269473047d747f7815af570197e4ef7322d3632cEvan Yan} ddi_hp_op_t;
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan#define DDIHP_CN_OPS(hdlp, op, arg, result, ret) \
269473047d747f7815af570197e4ef7322d3632cEvan Yan if (DDI_HP_IS_VIRTUAL_PORT(hdlp)) \
269473047d747f7815af570197e4ef7322d3632cEvan Yan ret = ddihp_port_ops(hdlp, op, arg, result); \
269473047d747f7815af570197e4ef7322d3632cEvan Yan else \
269473047d747f7815af570197e4ef7322d3632cEvan Yan ret = ddihp_connector_ops(hdlp, op, arg, result);
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan#define NEXUS_HAS_HP_OP(dip) \
269473047d747f7815af570197e4ef7322d3632cEvan Yan ((DEVI(dip)->devi_ops->devo_bus_ops) && \
269473047d747f7815af570197e4ef7322d3632cEvan Yan (DEVI(dip)->devi_ops->devo_bus_ops->busops_rev >= BUSO_REV_10) && \
269473047d747f7815af570197e4ef7322d3632cEvan Yan (DEVI(dip)->devi_ops->devo_bus_ops->bus_hp_op))
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan/*
269473047d747f7815af570197e4ef7322d3632cEvan Yan * ddi_hp_cn_sysevent_t
269473047d747f7815af570197e4ef7322d3632cEvan Yan *
269473047d747f7815af570197e4ef7322d3632cEvan Yan * The following correspond to sysevent defined subclasses
269473047d747f7815af570197e4ef7322d3632cEvan Yan */
269473047d747f7815af570197e4ef7322d3632cEvan Yantypedef enum {
269473047d747f7815af570197e4ef7322d3632cEvan Yan DDI_HP_CN_STATE_CHANGE,
269473047d747f7815af570197e4ef7322d3632cEvan Yan DDI_HP_CN_REQ
269473047d747f7815af570197e4ef7322d3632cEvan Yan} ddi_hp_cn_sysevent_t;
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan/*
269473047d747f7815af570197e4ef7322d3632cEvan Yan * Misc
269473047d747f7815af570197e4ef7322d3632cEvan Yan */
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan/* Append a node to list */
269473047d747f7815af570197e4ef7322d3632cEvan Yan#define DDIHP_LIST_APPEND(type, head, node) \
269473047d747f7815af570197e4ef7322d3632cEvan Yanif (node) { \
269473047d747f7815af570197e4ef7322d3632cEvan Yan type *curr, *prev = NULL; \
269473047d747f7815af570197e4ef7322d3632cEvan Yan (node)->next = NULL; \
269473047d747f7815af570197e4ef7322d3632cEvan Yan for (curr = (head); curr; prev = curr, curr = curr->next); \
269473047d747f7815af570197e4ef7322d3632cEvan Yan if (prev == NULL) \
269473047d747f7815af570197e4ef7322d3632cEvan Yan (head) = (node); \
269473047d747f7815af570197e4ef7322d3632cEvan Yan else \
269473047d747f7815af570197e4ef7322d3632cEvan Yan prev->next = (node); \
269473047d747f7815af570197e4ef7322d3632cEvan Yan}
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan/* Remove a node from a list */
269473047d747f7815af570197e4ef7322d3632cEvan Yan#define DDIHP_LIST_REMOVE(type, head, node) \
269473047d747f7815af570197e4ef7322d3632cEvan Yanif (node) { \
269473047d747f7815af570197e4ef7322d3632cEvan Yan type *curr, *prev = NULL; \
269473047d747f7815af570197e4ef7322d3632cEvan Yan for (curr = (head); curr; prev = curr, curr = curr->next) { \
269473047d747f7815af570197e4ef7322d3632cEvan Yan if (curr == (node)) \
269473047d747f7815af570197e4ef7322d3632cEvan Yan break; \
269473047d747f7815af570197e4ef7322d3632cEvan Yan } \
269473047d747f7815af570197e4ef7322d3632cEvan Yan if (curr) { \
269473047d747f7815af570197e4ef7322d3632cEvan Yan if (prev == NULL) \
269473047d747f7815af570197e4ef7322d3632cEvan Yan (head) = (head)->next; \
269473047d747f7815af570197e4ef7322d3632cEvan Yan else \
269473047d747f7815af570197e4ef7322d3632cEvan Yan prev->next = curr->next; \
269473047d747f7815af570197e4ef7322d3632cEvan Yan } \
269473047d747f7815af570197e4ef7322d3632cEvan Yan}
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yanint ddihp_modctl(int hp_op, char *path, char *cn_name, uintptr_t arg,
269473047d747f7815af570197e4ef7322d3632cEvan Yan uintptr_t rval);
269473047d747f7815af570197e4ef7322d3632cEvan Yanddi_hp_cn_handle_t *ddihp_cn_name_to_handle(dev_info_t *dip, char *cn_name);
269473047d747f7815af570197e4ef7322d3632cEvan Yanint ddihp_cn_getstate(ddi_hp_cn_handle_t *hdlp);
269473047d747f7815af570197e4ef7322d3632cEvan Yanint ddihp_port_ops(ddi_hp_cn_handle_t *hdlp, ddi_hp_op_t op,
269473047d747f7815af570197e4ef7322d3632cEvan Yan void *arg, void *result);
269473047d747f7815af570197e4ef7322d3632cEvan Yanint ddihp_connector_ops(ddi_hp_cn_handle_t *hdlp,
269473047d747f7815af570197e4ef7322d3632cEvan Yan ddi_hp_op_t op, void *arg, void *result);
269473047d747f7815af570197e4ef7322d3632cEvan Yanvoid ddihp_cn_gen_sysevent(ddi_hp_cn_handle_t *hdlp,
269473047d747f7815af570197e4ef7322d3632cEvan Yan ddi_hp_cn_sysevent_t event_sub_class, int hint, int kmflag);
269473047d747f7815af570197e4ef7322d3632cEvan Yanint ddihp_cn_unregister(ddi_hp_cn_handle_t *hdlp);
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan#endif /* _KERNEL */
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan#ifdef __cplusplus
269473047d747f7815af570197e4ef7322d3632cEvan Yan}
269473047d747f7815af570197e4ef7322d3632cEvan Yan#endif
269473047d747f7815af570197e4ef7322d3632cEvan Yan
269473047d747f7815af570197e4ef7322d3632cEvan Yan#endif /* _SYS_DDI_HP_IMPL_H */