xref: /titanic_50/usr/src/uts/common/sys/ib/ibtl/ibci.h (revision 3c112a2b34403220c06c3e2fcac403358cfba168)
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 (the "License").
6  * You may not use this file except in compliance with the License.
7  *
8  * You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
9  * or http://www.opensolaris.org/os/licensing.
10  * See the License for the specific language governing permissions
11  * and limitations under the License.
12  *
13  * When distributing Covered Code, include this CDDL HEADER in each
14  * file and include the License file at usr/src/OPENSOLARIS.LICENSE.
15  * If applicable, add the following below this CDDL HEADER, with the
16  * fields enclosed by brackets "[]" replaced with your own identifying
17  * information: Portions Copyright [yyyy] [name of copyright owner]
18  *
19  * CDDL HEADER END
20  */
21 /*
22  * Copyright 2010 Sun Microsystems, Inc.  All rights reserved.
23  * Use is subject to license terms.
24  */
25 
26 #ifndef	_SYS_IB_IBTL_IBCI_H
27 #define	_SYS_IB_IBTL_IBCI_H
28 
29 /*
30  * ibci.h
31  *
32  * Define the data structures and function prototypes that comprise
33  * the IB Channel API (API for HCA drivers).  All CI handles are opaque
34  * to the IBTF here, real data is accessed in the HCA driver by a
35  * typecast to a driver specific struct.
36  */
37 
38 #include <sys/ib/ibtl/ibtl_types.h>
39 #include <sys/ib/ibtl/ibtl_ci_types.h>
40 #include <sys/modctl.h>
41 
42 
43 #ifdef	__cplusplus
44 extern "C" {
45 #endif
46 
47 /*
48  * Define CI opaque IBTF handles.
49  */
50 typedef	struct	ibtl_qp_s	*ibtl_qp_hdl_t;		/* ibt_alloc_qp() */
51 typedef struct	ibtl_eec_s	*ibtl_eec_hdl_t;	/* ibt_alloc_eec() */
52 
53 /*
54  * Define IBTF opaque CI handles.
55  */
56 typedef struct ibc_hca_s	*ibc_hca_hdl_t; /* HCA/CI Handle */
57 typedef struct ibc_pd_s		*ibc_pd_hdl_t;	/* Protection Domain Handle */
58 typedef	struct ibc_rdd_s	*ibc_rdd_hdl_t;	/* Reliable Datagram Domain */
59 typedef struct ibc_ah_s		*ibc_ah_hdl_t;	/* Address Handle */
60 typedef struct ibc_qp_s		*ibc_qp_hdl_t;	/* Queue Pair Handle */
61 typedef struct ibc_srq_s	*ibc_srq_hdl_t;	/* Shared Receive Queue Hdl */
62 typedef struct ibc_qpn_s	*ibc_qpn_hdl_t;	/* Queue Pair Number Handle */
63 typedef struct ibc_cq_s		*ibc_cq_hdl_t;	/* Completion Queue Handle */
64 typedef struct ibc_eec_s	*ibc_eec_hdl_t; /* End-to-End Context Handle */
65 typedef struct ibc_mem_alloc_s	*ibc_mem_alloc_hdl_t; /* Memory Handle */
66 
67 #define	ibc_fmr_pool_hdl_t	ibt_fmr_pool_hdl_t /* FMR Pool Handle */
68 #define	ibc_mr_hdl_t	ibt_mr_hdl_t	/* Memory Region Handle */
69 #define	ibc_mw_hdl_t	ibt_mw_hdl_t	/* Memory Window Handle */
70 #define	ibc_ma_hdl_t	ibt_ma_hdl_t	/* Memory Area Handle */
71 #define	ibc_mi_hdl_t	ibt_mi_hdl_t	/* Memory IOV 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_wc_t
140  */
141 #define	wc_eecn		wc_detail	/* End-to-End Context RD's only */
142 
143 
144 /* Channel Interface version */
145 typedef enum ibc_version_e {
146 	IBCI_V1		= 1,
147 	IBCI_V2		= 2,		/* FMR Support */
148 	IBCI_V3		= 3
149 } ibc_version_t;
150 
151 
152 typedef enum ibc_free_qp_flags_e {
153 	IBC_FREE_QP_AND_QPN	= 0,	/* free all qp resources */
154 	IBC_FREE_QP_ONLY	= 1	/* OK to free the QP, but the QPN */
155 					/* cannot be reused until a future */
156 					/* call to ibc_release_qpn(qpn_hdl), */
157 					/* where qpn_hdl is a return value */
158 					/* of ibc_free_qp() */
159 } ibc_free_qp_flags_t;
160 
161 /*
162  * RDD alloc flags
163  */
164 typedef enum ibc_rdd_flags_e {
165 	IBT_RDD_NO_FLAGS	= 0,
166 	IBT_RDD_USER_MAP	= (1 << 0),
167 	IBT_RDD_DEFER_ALLOC	= (1 << 1)
168 } ibc_rdd_flags_t;
169 
170 /*
171  * EEC alloc flags
172  */
173 typedef enum ibc_eec_flags_e {
174 	IBT_EEC_NO_FLAGS	= 0,
175 	IBT_EEC_USER_MAP	= (1 << 0),
176 	IBT_EEC_DEFER_ALLOC	= (1 << 1)
177 } ibc_eec_flags_t;
178 
179 
180 /*
181  * Completion Queues
182  *
183  */
184 
185 /*
186  * CQ handler attribute structure.
187  */
188 typedef struct ibc_cq_handler_attr_s {
189 	ibt_cq_handler_id_t	h_id;		/* Valid ID != NULL */
190 	int			h_flags;	/* Flags of ddi_intr_get_cap */
191 	int			h_pri;		/* priority from */
192 						/* ddi_intr_get_pri */
193 	void			*h_bind;	/* unknown intrd stuff */
194 } ibc_cq_handler_attr_t;
195 
196 
197 /*
198  * Event data for asynchronous events and errors. The QP/EEC/CQ/SRQ handle,
199  * or port number associated with the Event/Error is passed as an argument
200  * to the async handler.
201  */
202 typedef struct ibc_async_event_s {
203 	uint64_t	ev_fma_ena;	/* fault management error data */
204 	ibtl_qp_hdl_t	ev_qp_hdl;	/* IBTF QP handle. */
205 	ibtl_eec_hdl_t	ev_eec_hdl;	/* IBTF EEC handle. */
206 	ibt_cq_hdl_t	ev_cq_hdl;	/* IBT CQ handle. */
207 	ibt_srq_hdl_t	ev_srq_hdl;	/* SRQ handle */
208 	ibt_port_change_t ev_port_flags; /* Port Change flags */
209 	uint8_t		ev_port;	/* For PORT UP/DOWN/CHANGE events */
210 } ibc_async_event_t;
211 
212 
213 typedef struct ibc_operations_s {
214 	/* HCA */
215 	ibt_status_t (*ibc_query_hca_ports)(ibc_hca_hdl_t hca, uint8_t port,
216 	    ibt_hca_portinfo_t *info_p);
217 	ibt_status_t (*ibc_modify_ports)(ibc_hca_hdl_t hca, uint8_t port,
218 	    ibt_port_modify_flags_t flags, uint8_t init_type);
219 	ibt_status_t (*ibc_modify_system_image)(ibc_hca_hdl_t hca,
220 	    ib_guid_t sys_guid);
221 
222 	/* Protection Domain */
223 	ibt_status_t (*ibc_alloc_pd)(ibc_hca_hdl_t hca, ibt_pd_flags_t flags,
224 	    ibc_pd_hdl_t *pd_p);
225 	ibt_status_t (*ibc_free_pd)(ibc_hca_hdl_t hca, ibc_pd_hdl_t pd);
226 
227 	/* Reliable Datagram Domain */
228 	ibt_status_t (*ibc_alloc_rdd)(ibc_hca_hdl_t hca, ibc_rdd_flags_t flags,
229 	    ibc_rdd_hdl_t *rdd_p);
230 	ibt_status_t (*ibc_free_rdd)(ibc_hca_hdl_t hca, ibc_rdd_hdl_t rdd);
231 
232 	/* Address Handle */
233 	ibt_status_t (*ibc_alloc_ah)(ibc_hca_hdl_t hca, ibt_ah_flags_t flags,
234 	    ibc_pd_hdl_t pd, ibt_adds_vect_t *attr_p, ibc_ah_hdl_t *ah_p);
235 	ibt_status_t (*ibc_free_ah)(ibc_hca_hdl_t hca, ibc_ah_hdl_t ah);
236 	ibt_status_t (*ibc_query_ah)(ibc_hca_hdl_t hca, ibc_ah_hdl_t ah,
237 	    ibc_pd_hdl_t *pd_p, ibt_adds_vect_t *attr_p);
238 	ibt_status_t (*ibc_modify_ah)(ibc_hca_hdl_t hca, ibc_ah_hdl_t ah,
239 	    ibt_adds_vect_t *attr_p);
240 
241 	/* Queue Pair */
242 	ibt_status_t (*ibc_alloc_qp)(ibc_hca_hdl_t hca, ibtl_qp_hdl_t ibtl_qp,
243 	    ibt_qp_type_t type, ibt_qp_alloc_attr_t *attr_p,
244 	    ibt_chan_sizes_t *queue_sizes_p, ib_qpn_t *qpn, ibc_qp_hdl_t *qp_p);
245 	ibt_status_t (*ibc_alloc_special_qp)(ibc_hca_hdl_t hca, uint8_t port,
246 	    ibtl_qp_hdl_t ibt_qp, ibt_sqp_type_t type,
247 	    ibt_qp_alloc_attr_t *attr_p, ibt_chan_sizes_t *queue_sizes_p,
248 	    ibc_qp_hdl_t *qp_p);
249 	ibt_status_t (*ibc_alloc_qp_range)(ibc_hca_hdl_t hca, uint_t log2,
250 	    ibtl_qp_hdl_t *ibtl_qp_p, ibt_qp_type_t type,
251 	    ibt_qp_alloc_attr_t *attr_p, ibt_chan_sizes_t *queue_sizes_p,
252 	    ibc_cq_hdl_t *send_cq_p, ibc_cq_hdl_t *recv_cq_p,
253 	    ib_qpn_t *qpn_p, ibc_qp_hdl_t *qp_p);
254 	ibt_status_t (*ibc_free_qp)(ibc_hca_hdl_t hca, ibc_qp_hdl_t qp,
255 	    ibc_free_qp_flags_t free_qp_flags, ibc_qpn_hdl_t *qpnh_p);
256 	ibt_status_t (*ibc_release_qpn)(ibc_hca_hdl_t hca, ibc_qpn_hdl_t qpnh);
257 	ibt_status_t (*ibc_query_qp)(ibc_hca_hdl_t hca, ibc_qp_hdl_t qp,
258 	    ibt_qp_query_attr_t *attr_p);
259 	ibt_status_t (*ibc_modify_qp)(ibc_hca_hdl_t hca, ibc_qp_hdl_t qp,
260 	    ibt_cep_modify_flags_t flags, ibt_qp_info_t *info_p,
261 	    ibt_queue_sizes_t *actual_sz);
262 
263 	/* Completion Queues */
264 	ibt_status_t (*ibc_alloc_cq)(ibc_hca_hdl_t hca, ibt_cq_hdl_t ibt_cq,
265 	    ibt_cq_attr_t *attr_p, ibc_cq_hdl_t *cq_p, uint_t *actual_size);
266 	ibt_status_t (*ibc_free_cq)(ibc_hca_hdl_t hca, ibc_cq_hdl_t cq);
267 	ibt_status_t (*ibc_query_cq)(ibc_hca_hdl_t hca, ibc_cq_hdl_t cq,
268 	    uint_t *entries, uint_t *count_p, uint_t *usec_p,
269 	    ibt_cq_handler_id_t *hid_p);
270 	ibt_status_t (*ibc_resize_cq)(ibc_hca_hdl_t hca, ibc_cq_hdl_t cq,
271 	    uint_t size, uint_t *actual_size);
272 	ibt_status_t (*ibc_modify_cq)(ibc_hca_hdl_t hca, ibc_cq_hdl_t cq,
273 	    uint_t count, uint_t usec, ibt_cq_handler_id_t hid);
274 	ibt_status_t (*ibc_alloc_cq_sched)(ibc_hca_hdl_t hca,
275 	    ibt_cq_sched_flags_t flags, ibc_cq_handler_attr_t *handler_attrs_p);
276 	ibt_status_t (*ibc_free_cq_sched)(ibc_hca_hdl_t hca,
277 	    ibt_cq_handler_id_t id);
278 
279 	/* EE Context */
280 	ibt_status_t (*ibc_alloc_eec)(ibc_hca_hdl_t hca, ibc_eec_flags_t flags,
281 	    ibtl_eec_hdl_t ibtl_eec, ibc_rdd_hdl_t rdd, ibc_eec_hdl_t *eec_p);
282 	ibt_status_t (*ibc_free_eec)(ibc_hca_hdl_t hca, ibc_eec_hdl_t eec);
283 	ibt_status_t (*ibc_query_eec)(ibc_hca_hdl_t hca, ibc_eec_hdl_t eec,
284 	    ibt_eec_query_attr_t *attr_p);
285 	ibt_status_t (*ibc_modify_eec)(ibc_hca_hdl_t hca, ibc_eec_hdl_t eec,
286 	    ibt_cep_modify_flags_t flags, ibt_eec_info_t *info_p);
287 
288 	/* Memory Registration */
289 	ibt_status_t (*ibc_register_mr)(ibc_hca_hdl_t hca, ibc_pd_hdl_t pd,
290 	    ibt_mr_attr_t *attr_p, void *ibtl_reserved, ibc_mr_hdl_t *mr_p,
291 	    ibt_mr_desc_t *mem_desc);
292 	ibt_status_t (*ibc_register_buf)(ibc_hca_hdl_t hca, ibc_pd_hdl_t pd,
293 	    ibt_smr_attr_t *attrp, struct buf *buf, void *ibtl_reserved,
294 	    ibc_mr_hdl_t *mr_hdl_p, ibt_mr_desc_t *mem_desc);
295 	ibt_status_t (*ibc_register_shared_mr)(ibc_hca_hdl_t hca,
296 	    ibc_mr_hdl_t mr, ibc_pd_hdl_t pd, ibt_smr_attr_t *attr_p,
297 	    void *ibtl_reserved, ibc_mr_hdl_t *mr_p, ibt_mr_desc_t *mem_desc);
298 	ibt_status_t (*ibc_deregister_mr)(ibc_hca_hdl_t hca, ibc_mr_hdl_t mr);
299 	ibt_status_t (*ibc_query_mr)(ibc_hca_hdl_t hca, ibc_mr_hdl_t mr,
300 	    ibt_mr_query_attr_t *info_p);
301 	ibt_status_t (*ibc_reregister_mr)(ibc_hca_hdl_t hca, ibc_mr_hdl_t mr,
302 	    ibc_pd_hdl_t pd, ibt_mr_attr_t *attr_p, void *ibtl_reserved,
303 	    ibc_mr_hdl_t *mr_p, ibt_mr_desc_t *mem_desc);
304 	ibt_status_t (*ibc_reregister_buf)(ibc_hca_hdl_t hca, ibc_mr_hdl_t mr,
305 	    ibc_pd_hdl_t pd, ibt_smr_attr_t *attrp, struct buf *buf,
306 	    void *ibtl_reserved, ibc_mr_hdl_t *mr_p, ibt_mr_desc_t *mem_desc);
307 	ibt_status_t (*ibc_sync_mr)(ibc_hca_hdl_t hca,
308 	    ibt_mr_sync_t *mr_segments, size_t	num_segments);
309 
310 	/* Memory Window */
311 	ibt_status_t (*ibc_alloc_mw)(ibc_hca_hdl_t hca, ibc_pd_hdl_t pd,
312 	    ibt_mw_flags_t flags, ibc_mw_hdl_t *mw_p, ibt_rkey_t *rkey_p);
313 	ibt_status_t (*ibc_free_mw)(ibc_hca_hdl_t hca, ibc_mw_hdl_t mw);
314 	ibt_status_t (*ibc_query_mw)(ibc_hca_hdl_t hca, ibc_mw_hdl_t mw,
315 	    ibt_mw_query_attr_t *mw_attr_p);
316 
317 	/* Multicast Group */
318 	ibt_status_t (*ibc_attach_mcg)(ibc_hca_hdl_t hca, ibc_qp_hdl_t qp,
319 	    ib_gid_t gid, ib_lid_t lid);
320 	ibt_status_t (*ibc_detach_mcg)(ibc_hca_hdl_t hca, ibc_qp_hdl_t qp,
321 	    ib_gid_t gid, ib_lid_t lid);
322 
323 	/* WR processing */
324 	ibt_status_t (*ibc_post_send)(ibc_hca_hdl_t hca, ibc_qp_hdl_t qp,
325 	    ibt_send_wr_t *wr_p, uint_t num_wr, uint_t *num_posted);
326 	ibt_status_t (*ibc_post_recv)(ibc_hca_hdl_t hca, ibc_qp_hdl_t qp,
327 	    ibt_recv_wr_t *wr_p, uint_t num_wr, uint_t *num_posted);
328 	ibt_status_t (*ibc_poll_cq)(ibc_hca_hdl_t hca, ibc_cq_hdl_t cq,
329 	    ibt_wc_t *wc_p, uint_t num_wc, uint_t *num_polled);
330 	ibt_status_t (*ibc_notify_cq)(ibc_hca_hdl_t hca, ibc_cq_hdl_t cq,
331 	    ibt_cq_notify_flags_t flags);
332 
333 	/* CI Object Private Data */
334 	ibt_status_t (*ibc_ci_data_in)(ibc_hca_hdl_t hca,
335 	    ibt_ci_data_flags_t flags, ibt_object_type_t object,
336 	    void *ibc_object_handle, void *data_p, size_t data_sz);
337 	ibt_status_t (*ibc_ci_data_out)(ibc_hca_hdl_t hca,
338 	    ibt_ci_data_flags_t flags, ibt_object_type_t object,
339 	    void *ibc_object_handle, void *data_p, size_t data_sz);
340 
341 	/* Shared Receive Queues */
342 	ibt_status_t (*ibc_alloc_srq)(ibc_hca_hdl_t hca, ibt_srq_flags_t flags,
343 	    ibt_srq_hdl_t ibt_srq, ibc_pd_hdl_t pd, ibt_srq_sizes_t *sizes,
344 	    ibc_srq_hdl_t *ibc_srq_p, ibt_srq_sizes_t *real_size_p);
345 	ibt_status_t (*ibc_free_srq)(ibc_hca_hdl_t hca, ibc_srq_hdl_t srq);
346 	ibt_status_t (*ibc_query_srq)(ibc_hca_hdl_t hca, ibc_srq_hdl_t srq,
347 	    ibc_pd_hdl_t *pd_p, ibt_srq_sizes_t *sizes_p, uint_t *limit);
348 	ibt_status_t (*ibc_modify_srq)(ibc_hca_hdl_t hca, ibc_srq_hdl_t srq,
349 	    ibt_srq_modify_flags_t flags, uint_t size, uint_t limit,
350 	    uint_t *real_size_p);
351 	ibt_status_t (*ibc_post_srq)(ibc_hca_hdl_t hca, ibc_srq_hdl_t srq,
352 	    ibt_recv_wr_t *wr, uint_t num_wr, uint_t *num_posted_p);
353 
354 	/* Address translation */
355 	ibt_status_t (*ibc_map_mem_area)(ibc_hca_hdl_t hca_hdl,
356 	    ibt_va_attr_t *va_attrs, void *ibtl_reserved,
357 	    uint_t paddr_list_len, ibt_reg_req_t *reg_req,
358 	    ibc_ma_hdl_t *ma_hdl_p);
359 	ibt_status_t (*ibc_unmap_mem_area)(ibc_hca_hdl_t hca_hdl,
360 	    ibc_ma_hdl_t ma_hdl);
361 	ibt_status_t (*ibc_map_mem_iov)(ibc_hca_hdl_t hca_hdl,
362 	    ibt_iov_attr_t *iov_attr, ibt_all_wr_t *wr,
363 	    ibc_mi_hdl_t *mi_hdl);
364 	ibt_status_t (*ibc_unmap_mem_iov)(ibc_hca_hdl_t hca_hdl,
365 	    ibc_mi_hdl_t mi_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 
381 	/* Fast Memory Registration (FMR) */
382 	ibt_status_t (*ibc_create_fmr_pool)(ibc_hca_hdl_t hca, ibc_pd_hdl_t pd,
383 	    ibt_fmr_pool_attr_t *fmr_params, ibc_fmr_pool_hdl_t *fmr_pool_p);
384 	ibt_status_t (*ibc_destroy_fmr_pool)(ibc_hca_hdl_t hca,
385 	    ibc_fmr_pool_hdl_t fmr_pool);
386 	ibt_status_t (*ibc_flush_fmr_pool)(ibc_hca_hdl_t hca,
387 	    ibc_fmr_pool_hdl_t fmr_pool);
388 	ibt_status_t (*ibc_register_physical_fmr)(ibc_hca_hdl_t hca,
389 	    ibc_fmr_pool_hdl_t fmr_pool, ibt_pmr_attr_t *mem_pattr,
390 	    void *ibtl_reserved, ibc_mr_hdl_t *mr_hdl_p,
391 	    ibt_pmr_desc_t *mem_desc_p);
392 	ibt_status_t (*ibc_deregister_fmr)(ibc_hca_hdl_t hca, ibc_mr_hdl_t mr);
393 
394 	/* IO memory management */
395 	ibt_status_t (*ibc_alloc_io_mem)(ibc_hca_hdl_t hca_hdl, size_t size,
396 	    ibt_mr_flags_t mr_flag, caddr_t *kaddrp,
397 	    ibc_mem_alloc_hdl_t *mem_alloc_hdl);
398 	ibt_status_t (*ibc_free_io_mem)(ibc_hca_hdl_t hca_hdl,
399 	    ibc_mem_alloc_hdl_t mem_alloc_hdl);
400 
401 	/* Extended RC (XRC) */
402 	ibt_status_t (*ibc_alloc_xrc_domain)();
403 	ibt_status_t (*ibc_free_xrc_domain)();
404 	ibt_status_t (*ibc_alloc_xrc_srq)();
405 	ibt_status_t (*ibc_free_xrc_srq)();
406 	ibt_status_t (*ibc_query_xrc_srq)();
407 	ibt_status_t (*ibc_modify_xrc_srq)();
408 	ibt_status_t (*ibc_alloc_xrc_tgt_qp)();
409 	ibt_status_t (*ibc_free_xrc_tgt_qp)();
410 	ibt_status_t (*ibc_query_xrc_tgt_qp)();
411 	ibt_status_t (*ibc_modify_xrc_tgt_qp)();
412 } ibc_operations_t;
413 
414 
415 /*
416  * The ibc_hca_info_s structure is used for HCA drivers to communicate its
417  * HCA specific information to IBTF when it attaches a device via ibc_attach().
418  *
419  * IBTF assumes that the structures pointed to by the hca_ops and hca_attr
420  * structure members are persistent.
421  */
422 typedef struct ibc_hca_info_s {
423 	ibc_version_t		hca_ci_vers;	/* CI Version */
424 	dev_info_t		*hca_dip;	/* HCA dev_info */
425 	ibc_hca_hdl_t		hca_handle;	/* used for call through */
426 						/* "hca_ops" */
427 	ibc_operations_t	*hca_ops;
428 	ibt_hca_attr_t		*hca_attr;
429 	ibc_cq_handler_attr_t	hca_def_cq_handler_attr;
430 } ibc_hca_info_t;
431 
432 
433 /* Channel Interface return status */
434 typedef enum ibc_status_e {
435 	IBC_SUCCESS = 0,
436 	IBC_FAILURE = 1
437 } ibc_status_t;
438 
439 /*
440  * CI up-calls to IBTF.
441  */
442 
443 /*
444  * ibc_init
445  *	Registers CI clients with the Solaris I/O framework
446  *
447  * ibc_fini
448  *	Un-Registers CI clients with the Solaris I/O framework
449  */
450 int ibc_init(struct modlinkage *modlp);
451 void ibc_fini(struct modlinkage *modlp);
452 
453 /*
454  * ibc_attach
455  *	Register HCA device with IBTF. During this call HCA driver provides
456  *	driver's information neededby IBTF.
457  *
458  * ibc_post_attach
459  *	After a successful ibc_attach, this must be called.
460  *
461  * ibc_pre_detach
462  *	Attempt to De-Register HCA Device from IBTF.
463  *	This requires the cooperation of IBTF clients to
464  *	stop using this HCA.  Upon success, the HCA driver
465  *	is committed to calling ibc_detach.
466  *
467  * ibc_detach
468  *	De-Register HCA Device from IBTF.
469  *	This function will succeed if ibc_pre_detach has previously
470  *	succeeded for this device.
471  */
472 ibc_status_t ibc_attach(ibc_clnt_hdl_t *ibc_hdl_p, ibc_hca_info_t *info_p);
473 void ibc_post_attach(ibc_clnt_hdl_t ibc_hdl);
474 ibc_status_t ibc_pre_detach(ibc_clnt_hdl_t ibc_hdl, ddi_detach_cmd_t cmd);
475 void ibc_detach(ibc_clnt_hdl_t ibc_hdl);
476 
477 /*
478  * ibc_cq_handler
479  *	IBTF Completion Queue Notification Handler.
480  */
481 void ibc_cq_handler(ibc_clnt_hdl_t ibc_hdl, ibt_cq_hdl_t ibt_cq);
482 
483 /*
484  * ibc_async_handler
485  *	IBTF Asynchronous event/error handler.
486  */
487 void ibc_async_handler(ibc_clnt_hdl_t ibc_hdl, ibt_async_code_t code,
488     ibc_async_event_t *event_p);
489 
490 /*
491  * ibc_memory_handler
492  *	IBTF memory event/error handler.
493  */
494 void ibc_memory_handler(ibc_clnt_hdl_t ibc_hdl, ibt_mem_code_t code,
495     ibt_mem_data_t *data_p, void *ibtl_reserved);
496 
497 /*
498  * ibc_get_ci_failure()
499  *
500  *	Used to obtain a special IBTF failure code for CI specific failures,
501  *	failures other than those defined in ibt_status_t.
502  */
503 ibt_status_t ibc_get_ci_failure(uint64_t ena);
504 
505 #ifdef __cplusplus
506 }
507 #endif
508 
509 #endif	/* _SYS_IB_IBTL_IBCI_H */
510