xref: /titanic_51/usr/src/uts/common/sys/ib/ibtl/ibci.h (revision e42d2a1c942c82ff0fa3de86624e48f22c4457c0)
1 /*
2  * CDDL HEADER START
3  *
4  * The contents of this file are subject to the terms of the
5  * Common Development and Distribution License, Version 1.0 only
6  * (the "License").  You may not use this file except in compliance
7  * with the License.
8  *
9  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
10  * or http://www.opensolaris.org/os/licensing.
11  * See the License for the specific language governing permissions
12  * and limitations under the License.
13  *
14  * When distributing Covered Code, include this CDDL HEADER in each
15  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
16  * If applicable, add the following below this CDDL HEADER, with the
17  * fields enclosed by brackets "[]" replaced with your own identifying
18  * information: Portions Copyright [yyyy] [name of copyright owner]
19  *
20  * CDDL HEADER END
21  */
22 /*
23  * Copyright 2005 Sun Microsystems, Inc.  All rights reserved.
24  * Use is subject to license terms.
25  */
26 
27 #ifndef	_SYS_IB_IBTL_IBCI_H
28 #define	_SYS_IB_IBTL_IBCI_H
29 
30 #pragma ident	"%Z%%M%	%I%	%E% SMI"
31 
32 /*
33  * ibci.h
34  *
35  * Define the data structures and function prototypes that comprise
36  * the IB Channel API (API for HCA drivers).  All CI handles are opaque
37  * to the IBTF here, real data is accessed in the HCA driver by a
38  * typecast to a driver specific struct.
39  */
40 
41 #include <sys/ib/ibtl/ibtl_types.h>
42 #include <sys/ib/ibtl/ibtl_ci_types.h>
43 #include <sys/modctl.h>
44 
45 
46 #ifdef	__cplusplus
47 extern "C" {
48 #endif
49 
50 /*
51  * Define CI opaque IBTF handles.
52  */
53 typedef	struct	ibtl_qp_s	*ibtl_qp_hdl_t;		/* ibt_alloc_qp() */
54 typedef struct	ibtl_eec_s	*ibtl_eec_hdl_t;	/* ibt_alloc_eec() */
55 
56 /*
57  * Define IBTF opaque CI handles.
58  */
59 typedef struct ibc_hca_s	*ibc_hca_hdl_t; /* HCA/CI Handle */
60 typedef struct ibc_pd_s		*ibc_pd_hdl_t;	/* Protection Domain Handle */
61 typedef	struct ibc_rdd_s	*ibc_rdd_hdl_t;	/* Reliable Datagram Domain */
62 typedef struct ibc_ah_s		*ibc_ah_hdl_t;	/* Address Handle */
63 typedef struct ibc_qp_s		*ibc_qp_hdl_t;	/* Queue Pair Handle */
64 typedef struct ibc_srq_s	*ibc_srq_hdl_t;	/* Shared Receive Queue Hdl */
65 typedef struct ibc_qpn_s	*ibc_qpn_hdl_t;	/* Queue Pair Number Handle */
66 typedef struct ibc_cq_s		*ibc_cq_hdl_t;	/* Completion Queue Handle */
67 typedef struct ibc_eec_s	*ibc_eec_hdl_t; /* End-to-End Context Handle */
68 
69 #define	ibc_mr_hdl_t	ibt_mr_hdl_t	/* Memory Region Handle */
70 #define	ibc_mw_hdl_t	ibt_mw_hdl_t	/* Memory Window Handle */
71 #define	ibc_ma_hdl_t	ibt_ma_hdl_t	/* Memory Area Handle */
72 
73 /* Handle used by CI for up calls to IBTF */
74 typedef struct ibtl_hca_devinfo_s *ibc_clnt_hdl_t;	/* ibc_attach() */
75 
76 /*
77  * Fields opaque to TI, but visible to CI
78  */
79 
80 /*
81  * ibt_qp_alloc_attr_t
82  */
83 #define	qp_ibc_scq_hdl	qp_opaque1
84 #define	qp_ibc_rcq_hdl	qp_opaque2
85 #define	qp_ibc_srq_hdl	qp_opaque3
86 
87 
88 /*
89  * ibt_status_t
90  */
91 #define	IBT_HCA_RAWD_CHAN_EXCEEDED	IBT_ERR_OPAQUE1	/* Requested raw QP */
92 							/* exceeds HCA max */
93 							/* limit */
94 #define	IBT_CHAN_RAWD_NOT_SUPPORTED	IBT_ERR_OPAQUE2	/* Raw datagram QPs */
95 							/* not supported */
96 #define	IBT_CHAN_RD_NOT_SUPPORTED	IBT_ERR_OPAQUE3	/* RD not supported */
97 #define	IBT_EEC_HDL_INVALID		IBT_ERR_OPAQUE4	/* Invalid EEC handle */
98 #define	IBT_EEC_STATE_INVALID		IBT_ERR_OPAQUE5	/* Invalid EEC State */
99 #define	IBT_EEC_ATTR_RO			IBT_ERR_OPAQUE6	/* Can't Change EEC */
100 							/* Attribute */
101 #define	IBT_RDD_IN_USE			IBT_ERR_OPAQUE7	/* RDD in Use */
102 #define	IBT_RDD_HDL_INVALID		IBT_ERR_OPAQUE8	/* Invalid RDD */
103 #define	IBT_RNR_NAK_TIMER_INVALID	IBT_ERR_OPAQUE9	/* Invalid RNR NAK */
104 							/* Timer Value */
105 #define	IBT_RDD_NOT_SUPPORTED		IBT_ERR_OPAQUE10
106 
107 
108 /*
109  * ibt_wc_status_t
110  */
111 #define	IBT_WC_LOCAL_EEC_OP_ERR		12	/* Internal consistency error */
112 #define	IBT_WC_LOCAL_RDD_VIOLATION_ERR	30	/* The RDD associated with */
113 						/* the QP does not match */
114 						/* the RDD associated with */
115 						/* the EE Context */
116 #define	IBT_WC_REMOTE_RD_REQ_INVALID	31	/* Detected an invalid */
117 						/* incoming RD message */
118 #define	IBT_WC_EEC_REMOTE_ABORTED	32	/* Requester aborted the */
119 						/* operation */
120 #define	IBT_WC_EEC_NUM_INVALID		33	/* Invalid EEC Number */
121 						/* detected */
122 #define	IBT_WC_EEC_STATE_INVALID	34	/* Invalid EEC state */
123 
124 /*
125  * ibt_async_code_t
126  */
127 #define	IBT_EVENT_PATH_MIGRATED_EEC	IBT_ASYNC_OPAQUE1
128 #define	IBT_ERROR_CATASTROPHIC_EEC	IBT_ASYNC_OPAQUE3
129 #define	IBT_ERROR_PATH_MIGRATE_REQ_EEC	IBT_ASYNC_OPAQUE4
130 
131 /*
132  * ibt_object_type_t
133  */
134 #define	IBT_HDL_EEC	IBT_HDL_OPAQUE1
135 #define	IBT_HDL_RDD	IBT_HDL_OPAQUE2
136 
137 
138 /*
139  * ibt_hca_attr_t
140  */
141 #define	hca_max_rdd		hca_opaque2	/* Max RDDs in HCA */
142 #define	hca_max_eec		hca_opaque3	/* Max EEContexts in HCA */
143 #define	hca_max_rd_sgl		hca_opaque4	/* Max SGL entries per RD WR */
144 #define	hca_max_rdma_in_ee	hca_opaque5	/* Max RDMA Reads/Atomics in */
145 						/* per EEC with HCA as target */
146 #define	hca_max_rdma_out_ee	hca_opaque6	/* Max RDMA Reads/Atomics out */
147 						/* per EE by this HCA */
148 #define	hca_max_ipv6_qp		hca_max_ipv6_chan
149 #define	hca_max_ether_qp	hca_max_ether_chan
150 #define	hca_eec_max_ci_priv_sz	hca_opaque7
151 #define	hca_rdd_max_ci_priv_sz	hca_opaque8
152 
153 
154 /*
155  * ibt_wc_t
156  */
157 #define	wc_eecn		wc_opaque3	/* End-to-End Context RD's only */
158 
159 
160 /* Channel Interface version */
161 typedef enum ibc_version_e {
162 	IBCI_V1		= 1
163 } ibc_version_t;
164 
165 
166 typedef enum ibc_free_qp_flags_e {
167 	IBC_FREE_QP_AND_QPN	= 0,	/* free all qp resources */
168 	IBC_FREE_QP_ONLY	= 1	/* OK to free the QP, but the QPN */
169 					/* cannot be reused until a future */
170 					/* call to ibc_release_qpn(qpn_hdl), */
171 					/* where qpn_hdl is a return value */
172 					/* of ibc_free_qp() */
173 } ibc_free_qp_flags_t;
174 
175 /*
176  * RDD alloc flags
177  */
178 typedef enum ibc_rdd_flags_e {
179 	IBT_RDD_NO_FLAGS	= 0,
180 	IBT_RDD_USER_MAP	= (1 << 0),
181 	IBT_RDD_DEFER_ALLOC	= (1 << 1)
182 } ibc_rdd_flags_t;
183 
184 /*
185  * EEC alloc flags
186  */
187 typedef enum ibc_eec_flags_e {
188 	IBT_EEC_NO_FLAGS	= 0,
189 	IBT_EEC_USER_MAP	= (1 << 0),
190 	IBT_EEC_DEFER_ALLOC	= (1 << 1)
191 } ibc_eec_flags_t;
192 
193 
194 /*
195  * Completion Queues
196  *
197  */
198 
199 /*
200  * CQ handler attribute structure.
201  */
202 typedef struct ibc_cq_handler_attr_s {
203 	ibt_cq_handler_id_t	h_id;		/* Valid ID != NULL */
204 	int			h_flags;	/* Flags of ddi_intr_get_cap */
205 	int			h_pri;		/* priority from */
206 						/* ddi_intr_get_pri */
207 	void			*h_bind;	/* unknown intrd stuff */
208 } ibc_cq_handler_attr_t;
209 
210 
211 /*
212  * Event data for asynchronous events and errors. The QP/EEC/CQ/SRQ handle,
213  * or port number associated with the Event/Error is passed as an argument
214  * to the async handler.
215  */
216 typedef struct ibc_async_event_s {
217 	uint64_t	ev_fma_ena;	/* fault management error data */
218 	ibtl_qp_hdl_t	ev_qp_hdl;	/* IBTF QP handle. */
219 	ibtl_eec_hdl_t	ev_eec_hdl;	/* IBTF EEC handle. */
220 	ibt_cq_hdl_t	ev_cq_hdl;	/* IBT CQ handle. */
221 	uint8_t		ev_port;	/* Valid for PORT UP/DOWN events */
222 	ibt_srq_hdl_t	ev_srq_hdl;	/* SRQ handle */
223 } ibc_async_event_t;
224 
225 
226 typedef struct ibc_operations_s {
227 	/* HCA */
228 	ibt_status_t (*ibc_query_hca_ports)(ibc_hca_hdl_t hca, uint8_t port,
229 	    ibt_hca_portinfo_t *info_p);
230 	ibt_status_t (*ibc_modify_ports)(ibc_hca_hdl_t hca, uint8_t port,
231 	    ibt_port_modify_flags_t flags, uint8_t init_type);
232 	ibt_status_t (*ibc_modify_system_image)(ibc_hca_hdl_t hca,
233 	    ib_guid_t sys_guid);
234 
235 	/* Protection Domain */
236 	ibt_status_t (*ibc_alloc_pd)(ibc_hca_hdl_t hca, ibt_pd_flags_t flags,
237 	    ibc_pd_hdl_t *pd_p);
238 	ibt_status_t (*ibc_free_pd)(ibc_hca_hdl_t hca, ibc_pd_hdl_t pd);
239 
240 	/* Reliable Datagram Domain */
241 	ibt_status_t (*ibc_alloc_rdd)(ibc_hca_hdl_t hca, ibc_rdd_flags_t flags,
242 	    ibc_rdd_hdl_t *rdd_p);
243 	ibt_status_t (*ibc_free_rdd)(ibc_hca_hdl_t hca, ibc_rdd_hdl_t rdd);
244 
245 	/* Address Handle */
246 	ibt_status_t (*ibc_alloc_ah)(ibc_hca_hdl_t hca, ibt_ah_flags_t flags,
247 	    ibc_pd_hdl_t pd, ibt_adds_vect_t *attr_p, ibc_ah_hdl_t *ah_p);
248 	ibt_status_t (*ibc_free_ah)(ibc_hca_hdl_t hca, ibc_ah_hdl_t ah);
249 	ibt_status_t (*ibc_query_ah)(ibc_hca_hdl_t hca, ibc_ah_hdl_t ah,
250 	    ibc_pd_hdl_t *pd_p, ibt_adds_vect_t *attr_p);
251 	ibt_status_t (*ibc_modify_ah)(ibc_hca_hdl_t hca, ibc_ah_hdl_t ah,
252 	    ibt_adds_vect_t *attr_p);
253 
254 	/* Queue Pair */
255 	ibt_status_t (*ibc_alloc_qp)(ibc_hca_hdl_t hca, ibtl_qp_hdl_t ibtl_qp,
256 	    ibt_qp_type_t type, ibt_qp_alloc_attr_t *attr_p,
257 	    ibt_chan_sizes_t *queue_sizes_p, ib_qpn_t *qpn, ibc_qp_hdl_t *qp_p);
258 	ibt_status_t (*ibc_alloc_special_qp)(ibc_hca_hdl_t hca, uint8_t port,
259 	    ibtl_qp_hdl_t ibt_qp, ibt_sqp_type_t type,
260 	    ibt_qp_alloc_attr_t *attr_p, ibt_chan_sizes_t *queue_sizes_p,
261 	    ibc_qp_hdl_t *qp_p);
262 	ibt_status_t (*ibc_free_qp)(ibc_hca_hdl_t hca, ibc_qp_hdl_t qp,
263 	    ibc_free_qp_flags_t free_qp_flags, ibc_qpn_hdl_t *qpnh_p);
264 	ibt_status_t (*ibc_release_qpn)(ibc_hca_hdl_t hca, ibc_qpn_hdl_t qpnh);
265 	ibt_status_t (*ibc_query_qp)(ibc_hca_hdl_t hca, ibc_qp_hdl_t qp,
266 	    ibt_qp_query_attr_t *attr_p);
267 	ibt_status_t (*ibc_modify_qp)(ibc_hca_hdl_t hca, ibc_qp_hdl_t qp,
268 	    ibt_cep_modify_flags_t flags, ibt_qp_info_t *info_p,
269 	    ibt_queue_sizes_t *actual_sz);
270 
271 	/* Completion Queues */
272 	ibt_status_t (*ibc_alloc_cq)(ibc_hca_hdl_t hca, ibt_cq_hdl_t ibt_cq,
273 	    ibt_cq_attr_t *attr_p, ibc_cq_hdl_t *cq_p, uint_t *actual_size);
274 	ibt_status_t (*ibc_free_cq)(ibc_hca_hdl_t hca, ibc_cq_hdl_t cq);
275 	ibt_status_t (*ibc_query_cq)(ibc_hca_hdl_t hca, ibc_cq_hdl_t cq,
276 	    uint_t *entries);
277 	ibt_status_t (*ibc_resize_cq)(ibc_hca_hdl_t hca, ibc_cq_hdl_t cq,
278 	    uint_t size, uint_t *actual_size);
279 	ibt_status_t (*ibc_alloc_cq_sched)(ibc_hca_hdl_t hca,
280 	    ibt_cq_sched_flags_t flags, ibc_cq_handler_attr_t *handler_attrs_p);
281 	ibt_status_t (*ibc_free_cq_sched)(ibc_hca_hdl_t hca,
282 	    ibt_cq_handler_id_t id);
283 
284 	/* EE Context */
285 	ibt_status_t (*ibc_alloc_eec)(ibc_hca_hdl_t hca, ibc_eec_flags_t flags,
286 	    ibtl_eec_hdl_t ibtl_eec, ibc_rdd_hdl_t rdd, ibc_eec_hdl_t *eec_p);
287 	ibt_status_t (*ibc_free_eec)(ibc_hca_hdl_t hca, ibc_eec_hdl_t eec);
288 	ibt_status_t (*ibc_query_eec)(ibc_hca_hdl_t hca, ibc_eec_hdl_t eec,
289 	    ibt_eec_query_attr_t *attr_p);
290 	ibt_status_t (*ibc_modify_eec)(ibc_hca_hdl_t hca, ibc_eec_hdl_t eec,
291 	    ibt_cep_modify_flags_t flags, ibt_eec_info_t *info_p);
292 
293 	/* Memory Registration */
294 	ibt_status_t (*ibc_register_mr)(ibc_hca_hdl_t hca, ibc_pd_hdl_t pd,
295 	    ibt_mr_attr_t *attr_p, void *ibtl_reserved, ibc_mr_hdl_t *mr_p,
296 	    ibt_mr_desc_t *mem_desc);
297 	ibt_status_t (*ibc_register_buf)(ibc_hca_hdl_t hca, ibc_pd_hdl_t pd,
298 	    ibt_smr_attr_t *attrp, struct buf *buf, void *ibtl_reserved,
299 	    ibc_mr_hdl_t *mr_hdl_p, ibt_mr_desc_t *mem_desc);
300 	ibt_status_t (*ibc_register_shared_mr)(ibc_hca_hdl_t hca,
301 	    ibc_mr_hdl_t mr, ibc_pd_hdl_t pd, ibt_smr_attr_t *attr_p,
302 	    void *ibtl_reserved, ibc_mr_hdl_t *mr_p, ibt_mr_desc_t *mem_desc);
303 	ibt_status_t (*ibc_deregister_mr)(ibc_hca_hdl_t hca, ibc_mr_hdl_t mr);
304 	ibt_status_t (*ibc_query_mr)(ibc_hca_hdl_t hca, ibc_mr_hdl_t mr,
305 	    ibt_mr_query_attr_t *info_p);
306 	ibt_status_t (*ibc_reregister_mr)(ibc_hca_hdl_t hca, ibc_mr_hdl_t mr,
307 	    ibc_pd_hdl_t pd, ibt_mr_attr_t *attr_p, void *ibtl_reserved,
308 	    ibc_mr_hdl_t *mr_p, ibt_mr_desc_t *mem_desc);
309 	ibt_status_t (*ibc_reregister_buf)(ibc_hca_hdl_t hca, ibc_mr_hdl_t mr,
310 	    ibc_pd_hdl_t pd, ibt_smr_attr_t *attrp, struct buf *buf,
311 	    void *ibtl_reserved, ibc_mr_hdl_t *mr_p, ibt_mr_desc_t *mem_desc);
312 	ibt_status_t (*ibc_sync_mr)(ibc_hca_hdl_t hca,
313 	    ibt_mr_sync_t *mr_segments, size_t	num_segments);
314 
315 	/* Memory Window */
316 	ibt_status_t (*ibc_alloc_mw)(ibc_hca_hdl_t hca, ibc_pd_hdl_t pd,
317 	    ibt_mw_flags_t flags, ibc_mw_hdl_t *mw_p, ibt_rkey_t *rkey_p);
318 	ibt_status_t (*ibc_free_mw)(ibc_hca_hdl_t hca, ibc_mw_hdl_t mw);
319 	ibt_status_t (*ibc_query_mw)(ibc_hca_hdl_t hca, ibc_mw_hdl_t mw,
320 	    ibt_mw_query_attr_t *mw_attr_p);
321 
322 	/* Multicast Group */
323 	ibt_status_t (*ibc_attach_mcg)(ibc_hca_hdl_t hca, ibc_qp_hdl_t qp,
324 	    ib_gid_t gid, ib_lid_t lid);
325 	ibt_status_t (*ibc_detach_mcg)(ibc_hca_hdl_t hca, ibc_qp_hdl_t qp,
326 	    ib_gid_t gid, ib_lid_t lid);
327 
328 	/* WR processing */
329 	ibt_status_t (*ibc_post_send)(ibc_hca_hdl_t hca, ibc_qp_hdl_t qp,
330 	    ibt_send_wr_t *wr_p, uint_t num_wr, uint_t *num_posted);
331 	ibt_status_t (*ibc_post_recv)(ibc_hca_hdl_t hca, ibc_qp_hdl_t qp,
332 	    ibt_recv_wr_t *wr_p, uint_t num_wr, uint_t *num_posted);
333 	ibt_status_t (*ibc_poll_cq)(ibc_hca_hdl_t hca, ibc_cq_hdl_t cq,
334 	    ibt_wc_t *wc_p, uint_t num_wc, uint_t *num_polled);
335 	ibt_status_t (*ibc_notify_cq)(ibc_hca_hdl_t hca, ibc_cq_hdl_t cq,
336 	    ibt_cq_notify_flags_t flags);
337 
338 	/* CI Object Private Data */
339 	ibt_status_t (*ibc_ci_data_in)(ibc_hca_hdl_t hca,
340 	    ibt_ci_data_flags_t flags, ibt_object_type_t object,
341 	    void *ibc_object_handle, void *data_p, size_t data_sz);
342 	ibt_status_t (*ibc_ci_data_out)(ibc_hca_hdl_t hca,
343 	    ibt_ci_data_flags_t flags, ibt_object_type_t object,
344 	    void *ibc_object_handle, void *data_p, size_t data_sz);
345 
346 	/* Shared Receive Queues */
347 	ibt_status_t (*ibc_alloc_srq)(ibc_hca_hdl_t hca, ibt_srq_flags_t flags,
348 	    ibt_srq_hdl_t ibt_srq, ibc_pd_hdl_t pd, ibt_srq_sizes_t *sizes,
349 	    ibc_srq_hdl_t *ibc_srq_p, ibt_srq_sizes_t *real_size_p);
350 	ibt_status_t (*ibc_free_srq)(ibc_hca_hdl_t hca, ibc_srq_hdl_t srq);
351 	ibt_status_t (*ibc_query_srq)(ibc_hca_hdl_t hca, ibc_srq_hdl_t srq,
352 	    ibc_pd_hdl_t *pd_p, ibt_srq_sizes_t *sizes_p, uint_t *limit);
353 	ibt_status_t (*ibc_modify_srq)(ibc_hca_hdl_t hca, ibc_srq_hdl_t srq,
354 	    ibt_srq_modify_flags_t flags, uint_t size, uint_t limit,
355 	    uint_t *real_size_p);
356 	ibt_status_t (*ibc_post_srq)(ibc_hca_hdl_t hca, ibc_srq_hdl_t srq,
357 	    ibt_recv_wr_t *wr, uint_t num_wr, uint_t *num_posted_p);
358 
359 	/* Address translation */
360 	ibt_status_t (*ibc_map_mem_area)(ibc_hca_hdl_t hca_hdl,
361 	    ibt_va_attr_t *va_attrs, void *ibtl_reserved,
362 	    uint_t paddr_list_len, ibt_phys_buf_t *paddr_list_p,
363 	    uint_t *num_paddr_p, ibc_ma_hdl_t *ibc_ma_hdl_p);
364 	ibt_status_t (*ibc_unmap_mem_area)(ibc_hca_hdl_t hca_hdl,
365 	    ibc_ma_hdl_t ma_hdl);
366 
367 	/* Allocate L_Key */
368 	ibt_status_t (*ibc_alloc_lkey)(ibc_hca_hdl_t hca_hdl, ibc_pd_hdl_t pd,
369 	    ibt_lkey_flags_t flags, uint_t phys_buf_list_sz,
370 	    ibc_mr_hdl_t *mr_p, ibt_pmr_desc_t *mem_desc_p);
371 
372 	/* Physical Register Memory Region */
373 	ibt_status_t (*ibc_register_physical_mr)(ibc_hca_hdl_t hca,
374 	    ibc_pd_hdl_t pd, ibt_pmr_attr_t *mem_pattr, void *ibtl_reserved,
375 	    ibc_mr_hdl_t *mr_p, ibt_pmr_desc_t *mem_desc_p);
376 	ibt_status_t (*ibc_reregister_physical_mr)(ibc_hca_hdl_t hca,
377 	    ibc_mr_hdl_t mr, ibc_pd_hdl_t pd, ibt_pmr_attr_t *mem_pattr,
378 	    void *ibtl_reserved, ibc_mr_hdl_t *mr_p,
379 	    ibt_pmr_desc_t *mem_desc_p);
380 } ibc_operations_t;
381 
382 
383 /*
384  * The ibc_hca_info_s structure is used for HCA drivers to communicate its
385  * HCA specific information to IBTF when it attaches a device via ibc_attach().
386  *
387  * IBTF assumes that the structures pointed to by the hca_ops and hca_attr
388  * structure members are persistent.
389  */
390 typedef struct ibc_hca_info_s {
391 	ibc_version_t		hca_ci_vers;	/* CI Version */
392 	dev_info_t		*hca_dip;	/* HCA dev_info */
393 	ibc_hca_hdl_t		hca_handle;	/* used for call through */
394 						/* "hca_ops" */
395 	ibc_operations_t	*hca_ops;
396 	ibt_hca_attr_t		*hca_attr;
397 	ibc_cq_handler_attr_t	hca_def_cq_handler_attr;
398 } ibc_hca_info_t;
399 
400 
401 /* Channel Interface return status */
402 typedef enum ibc_status_e {
403 	IBC_SUCCESS = 0,
404 	IBC_FAILURE = 1
405 } ibc_status_t;
406 
407 /*
408  * CI up-calls to IBTF.
409  */
410 
411 /*
412  * ibc_init
413  *	Registers CI clients with the Solaris I/O framework
414  *
415  * ibc_fini
416  *	Un-Registers CI clients with the Solaris I/O framework
417  */
418 int ibc_init(struct modlinkage *modlp);
419 void ibc_fini(struct modlinkage *modlp);
420 
421 /*
422  * ibc_attach
423  *	Register HCA device with IBTF. During this call HCA driver provides
424  *	driver's information neededby IBTF.
425  *
426  * ibc_post_attach
427  *	After a successful ibc_attach, this must be called.
428  *
429  * ibc_pre_detach
430  *	Attempt to De-Register HCA Device from IBTF.
431  *	This requires the cooperation of IBTF clients to
432  *	stop using this HCA.  Upon success, the HCA driver
433  *	is committed to calling ibc_detach.
434  *
435  * ibc_detach
436  *	De-Register HCA Device from IBTF.
437  *	This function will succeed if ibc_pre_detach has previously
438  *	succeeded for this device.
439  */
440 ibc_status_t ibc_attach(ibc_clnt_hdl_t *ibc_hdl_p, ibc_hca_info_t *info_p);
441 void ibc_post_attach(ibc_clnt_hdl_t ibc_hdl);
442 ibc_status_t ibc_pre_detach(ibc_clnt_hdl_t ibc_hdl, ddi_detach_cmd_t cmd);
443 void ibc_detach(ibc_clnt_hdl_t ibc_hdl);
444 
445 /*
446  * ibc_cq_handler
447  *	IBTF Completion Queue Notification Handler.
448  */
449 void ibc_cq_handler(ibc_clnt_hdl_t ibc_hdl, ibt_cq_hdl_t ibt_cq);
450 
451 /*
452  * ibc_async_handler
453  *	IBTF Asynchronous event/error handler.
454  */
455 void ibc_async_handler(ibc_clnt_hdl_t ibc_hdl, ibt_async_code_t code,
456     ibc_async_event_t *event_p);
457 
458 /*
459  * ibc_memory_handler
460  *	IBTF memory event/error handler.
461  */
462 void ibc_memory_handler(ibc_clnt_hdl_t ibc_hdl, ibt_mem_code_t code,
463     ibt_mem_data_t *data_p, void *ibtl_reserved);
464 
465 /*
466  * ibc_get_ci_failure()
467  *
468  *	Used to obtain a special IBTF failure code for CI specific failures,
469  *	failures other than those defined in ibt_status_t.
470  */
471 ibt_status_t ibc_get_ci_failure(uint64_t ena);
472 
473 #ifdef __cplusplus
474 }
475 #endif
476 
477 #endif	/* _SYS_IB_IBTL_IBCI_H */
478