xref: /freebsd/contrib/ofed/libirdma/irdma_user.h (revision 55141f2c8991b2a6adbf30bb0fe3e6cbc303f06d)
1 /*-
2  * SPDX-License-Identifier: GPL-2.0 or Linux-OpenIB
3  *
4  * Copyright (c) 2015 - 2023 Intel Corporation
5  *
6  * This software is available to you under a choice of one of two
7  * licenses.  You may choose to be licensed under the terms of the GNU
8  * General Public License (GPL) Version 2, available from the file
9  * COPYING in the main directory of this source tree, or the
10  * OpenFabrics.org BSD license below:
11  *
12  *   Redistribution and use in source and binary forms, with or
13  *   without modification, are permitted provided that the following
14  *   conditions are met:
15  *
16  *    - Redistributions of source code must retain the above
17  *	copyright notice, this list of conditions and the following
18  *	disclaimer.
19  *
20  *    - Redistributions in binary form must reproduce the above
21  *	copyright notice, this list of conditions and the following
22  *	disclaimer in the documentation and/or other materials
23  *	provided with the distribution.
24  *
25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
28  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
29  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
30  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
31  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32  * SOFTWARE.
33  */
34 /*$FreeBSD$*/
35 
36 #ifndef IRDMA_USER_H
37 #define IRDMA_USER_H
38 
39 #include "osdep.h"
40 
41 #define irdma_handle void *
42 #define irdma_adapter_handle irdma_handle
43 #define irdma_qp_handle irdma_handle
44 #define irdma_cq_handle irdma_handle
45 #define irdma_pd_id irdma_handle
46 #define irdma_stag_handle irdma_handle
47 #define irdma_stag_index u32
48 #define irdma_stag u32
49 #define irdma_stag_key u8
50 #define irdma_tagged_offset u64
51 #define irdma_access_privileges u32
52 #define irdma_physical_fragment u64
53 #define irdma_address_list u64 *
54 #define irdma_sgl struct irdma_sge *
55 
56 #define IRDMA_MAX_MR_SIZE	0x200000000000ULL
57 
58 #define IRDMA_ACCESS_FLAGS_LOCALREAD		0x01
59 #define IRDMA_ACCESS_FLAGS_LOCALWRITE		0x02
60 #define IRDMA_ACCESS_FLAGS_REMOTEREAD_ONLY	0x04
61 #define IRDMA_ACCESS_FLAGS_REMOTEREAD		0x05
62 #define IRDMA_ACCESS_FLAGS_REMOTEWRITE_ONLY	0x08
63 #define IRDMA_ACCESS_FLAGS_REMOTEWRITE		0x0a
64 #define IRDMA_ACCESS_FLAGS_BIND_WINDOW		0x10
65 #define IRDMA_ACCESS_FLAGS_ZERO_BASED		0x20
66 #define IRDMA_ACCESS_FLAGS_ALL			0x3f
67 
68 #define IRDMA_OP_TYPE_RDMA_WRITE		0x00
69 #define IRDMA_OP_TYPE_RDMA_READ			0x01
70 #define IRDMA_OP_TYPE_SEND			0x03
71 #define IRDMA_OP_TYPE_SEND_INV			0x04
72 #define IRDMA_OP_TYPE_SEND_SOL			0x05
73 #define IRDMA_OP_TYPE_SEND_SOL_INV		0x06
74 #define IRDMA_OP_TYPE_RDMA_WRITE_SOL		0x0d
75 #define IRDMA_OP_TYPE_BIND_MW			0x08
76 #define IRDMA_OP_TYPE_FAST_REG_NSMR		0x09
77 #define IRDMA_OP_TYPE_INV_STAG			0x0a
78 #define IRDMA_OP_TYPE_RDMA_READ_INV_STAG	0x0b
79 #define IRDMA_OP_TYPE_NOP			0x0c
80 #define IRDMA_OP_TYPE_REC	0x3e
81 #define IRDMA_OP_TYPE_REC_IMM	0x3f
82 
83 #define IRDMA_FLUSH_MAJOR_ERR 1
84 #define IRDMA_SRQFLUSH_RSVD_MAJOR_ERR 0xfffe
85 
86 /* Async Events codes */
87 #define IRDMA_AE_AMP_UNALLOCATED_STAG					0x0102
88 #define IRDMA_AE_AMP_INVALID_STAG					0x0103
89 #define IRDMA_AE_AMP_BAD_QP						0x0104
90 #define IRDMA_AE_AMP_BAD_PD						0x0105
91 #define IRDMA_AE_AMP_BAD_STAG_KEY					0x0106
92 #define IRDMA_AE_AMP_BAD_STAG_INDEX					0x0107
93 #define IRDMA_AE_AMP_BOUNDS_VIOLATION					0x0108
94 #define IRDMA_AE_AMP_RIGHTS_VIOLATION					0x0109
95 #define IRDMA_AE_AMP_TO_WRAP						0x010a
96 #define IRDMA_AE_AMP_FASTREG_VALID_STAG					0x010c
97 #define IRDMA_AE_AMP_FASTREG_MW_STAG					0x010d
98 #define IRDMA_AE_AMP_FASTREG_INVALID_RIGHTS				0x010e
99 #define IRDMA_AE_AMP_FASTREG_INVALID_LENGTH				0x0110
100 #define IRDMA_AE_AMP_INVALIDATE_SHARED					0x0111
101 #define IRDMA_AE_AMP_INVALIDATE_NO_REMOTE_ACCESS_RIGHTS			0x0112
102 #define IRDMA_AE_AMP_INVALIDATE_MR_WITH_BOUND_WINDOWS			0x0113
103 #define IRDMA_AE_AMP_MWBIND_VALID_STAG					0x0114
104 #define IRDMA_AE_AMP_MWBIND_OF_MR_STAG					0x0115
105 #define IRDMA_AE_AMP_MWBIND_TO_ZERO_BASED_STAG				0x0116
106 #define IRDMA_AE_AMP_MWBIND_TO_MW_STAG					0x0117
107 #define IRDMA_AE_AMP_MWBIND_INVALID_RIGHTS				0x0118
108 #define IRDMA_AE_AMP_MWBIND_INVALID_BOUNDS				0x0119
109 #define IRDMA_AE_AMP_MWBIND_TO_INVALID_PARENT				0x011a
110 #define IRDMA_AE_AMP_MWBIND_BIND_DISABLED				0x011b
111 #define IRDMA_AE_PRIV_OPERATION_DENIED					0x011c
112 #define IRDMA_AE_AMP_INVALIDATE_TYPE1_MW				0x011d
113 #define IRDMA_AE_AMP_MWBIND_ZERO_BASED_TYPE1_MW				0x011e
114 #define IRDMA_AE_AMP_FASTREG_INVALID_PBL_HPS_CFG			0x011f
115 #define IRDMA_AE_AMP_MWBIND_WRONG_TYPE					0x0120
116 #define IRDMA_AE_AMP_FASTREG_PBLE_MISMATCH				0x0121
117 #define IRDMA_AE_UDA_XMIT_DGRAM_TOO_LONG				0x0132
118 #define IRDMA_AE_UDA_XMIT_BAD_PD					0x0133
119 #define IRDMA_AE_UDA_XMIT_DGRAM_TOO_SHORT				0x0134
120 #define IRDMA_AE_UDA_L4LEN_INVALID					0x0135
121 #define IRDMA_AE_BAD_CLOSE						0x0201
122 #define IRDMA_AE_RDMAP_ROE_BAD_LLP_CLOSE				0x0202
123 #define IRDMA_AE_CQ_OPERATION_ERROR					0x0203
124 #define IRDMA_AE_RDMA_READ_WHILE_ORD_ZERO				0x0205
125 #define IRDMA_AE_STAG_ZERO_INVALID					0x0206
126 #define IRDMA_AE_IB_RREQ_AND_Q1_FULL					0x0207
127 #define IRDMA_AE_IB_INVALID_REQUEST					0x0208
128 #define IRDMA_AE_WQE_UNEXPECTED_OPCODE					0x020a
129 #define IRDMA_AE_WQE_INVALID_PARAMETER					0x020b
130 #define IRDMA_AE_WQE_INVALID_FRAG_DATA					0x020c
131 #define IRDMA_AE_IB_REMOTE_ACCESS_ERROR					0x020d
132 #define IRDMA_AE_IB_REMOTE_OP_ERROR					0x020e
133 #define IRDMA_AE_WQE_LSMM_TOO_LONG					0x0220
134 #define IRDMA_AE_DDP_INVALID_MSN_GAP_IN_MSN				0x0301
135 #define IRDMA_AE_DDP_UBE_DDP_MESSAGE_TOO_LONG_FOR_AVAILABLE_BUFFER	0x0303
136 #define IRDMA_AE_DDP_UBE_INVALID_DDP_VERSION				0x0304
137 #define IRDMA_AE_DDP_UBE_INVALID_MO					0x0305
138 #define IRDMA_AE_DDP_UBE_INVALID_MSN_NO_BUFFER_AVAILABLE		0x0306
139 #define IRDMA_AE_DDP_UBE_INVALID_QN					0x0307
140 #define IRDMA_AE_DDP_NO_L_BIT						0x0308
141 #define IRDMA_AE_RDMAP_ROE_INVALID_RDMAP_VERSION			0x0311
142 #define IRDMA_AE_RDMAP_ROE_UNEXPECTED_OPCODE				0x0312
143 #define IRDMA_AE_ROE_INVALID_RDMA_READ_REQUEST				0x0313
144 #define IRDMA_AE_ROE_INVALID_RDMA_WRITE_OR_READ_RESP			0x0314
145 #define IRDMA_AE_ROCE_RSP_LENGTH_ERROR					0x0316
146 #define IRDMA_AE_ROCE_EMPTY_MCG						0x0380
147 #define IRDMA_AE_ROCE_BAD_MC_IP_ADDR					0x0381
148 #define IRDMA_AE_ROCE_BAD_MC_QPID					0x0382
149 #define IRDMA_AE_MCG_QP_PROTOCOL_MISMATCH				0x0383
150 #define IRDMA_AE_INVALID_ARP_ENTRY					0x0401
151 #define IRDMA_AE_INVALID_TCP_OPTION_RCVD				0x0402
152 #define IRDMA_AE_STALE_ARP_ENTRY					0x0403
153 #define IRDMA_AE_INVALID_AH_ENTRY					0x0406
154 #define IRDMA_AE_LLP_CLOSE_COMPLETE					0x0501
155 #define IRDMA_AE_LLP_CONNECTION_RESET					0x0502
156 #define IRDMA_AE_LLP_FIN_RECEIVED					0x0503
157 #define IRDMA_AE_LLP_RECEIVED_MARKER_AND_LENGTH_FIELDS_DONT_MATCH	0x0504
158 #define IRDMA_AE_LLP_RECEIVED_MPA_CRC_ERROR				0x0505
159 #define IRDMA_AE_LLP_SEGMENT_TOO_SMALL					0x0507
160 #define IRDMA_AE_LLP_SYN_RECEIVED					0x0508
161 #define IRDMA_AE_LLP_TERMINATE_RECEIVED					0x0509
162 #define IRDMA_AE_LLP_TOO_MANY_RETRIES					0x050a
163 #define IRDMA_AE_LLP_TOO_MANY_KEEPALIVE_RETRIES				0x050b
164 #define IRDMA_AE_LLP_DOUBT_REACHABILITY					0x050c
165 #define IRDMA_AE_LLP_CONNECTION_ESTABLISHED				0x050e
166 #define IRDMA_AE_RESOURCE_EXHAUSTION					0x0520
167 #define IRDMA_AE_RESET_SENT						0x0601
168 #define IRDMA_AE_TERMINATE_SENT						0x0602
169 #define IRDMA_AE_RESET_NOT_SENT						0x0603
170 #define IRDMA_AE_LCE_QP_CATASTROPHIC					0x0700
171 #define IRDMA_AE_LCE_FUNCTION_CATASTROPHIC				0x0701
172 #define IRDMA_AE_LCE_CQ_CATASTROPHIC					0x0702
173 #define IRDMA_AE_QP_SUSPEND_COMPLETE					0x0900
174 
175 enum irdma_device_caps_const {
176 	IRDMA_WQE_SIZE =			4,
177 	IRDMA_CQP_WQE_SIZE =			8,
178 	IRDMA_CQE_SIZE =			4,
179 	IRDMA_EXTENDED_CQE_SIZE =		8,
180 	IRDMA_AEQE_SIZE =			2,
181 	IRDMA_CEQE_SIZE =			1,
182 	IRDMA_CQP_CTX_SIZE =			8,
183 	IRDMA_SHADOW_AREA_SIZE =		8,
184 	IRDMA_GATHER_STATS_BUF_SIZE =		1024,
185 	IRDMA_MIN_IW_QP_ID =			0,
186 	IRDMA_QUERY_FPM_BUF_SIZE =		176,
187 	IRDMA_COMMIT_FPM_BUF_SIZE =		176,
188 	IRDMA_MAX_IW_QP_ID =			262143,
189 	IRDMA_MIN_CEQID =			0,
190 	IRDMA_MAX_CEQID =			1023,
191 	IRDMA_CEQ_MAX_COUNT =			IRDMA_MAX_CEQID + 1,
192 	IRDMA_MIN_CQID =			0,
193 	IRDMA_MAX_CQID =			524287,
194 	IRDMA_MIN_AEQ_ENTRIES =			1,
195 	IRDMA_MAX_AEQ_ENTRIES =			524287,
196 	IRDMA_MIN_CEQ_ENTRIES =			1,
197 	IRDMA_MAX_CEQ_ENTRIES =			262143,
198 	IRDMA_MIN_CQ_SIZE =			1,
199 	IRDMA_MAX_CQ_SIZE =			1048575,
200 	IRDMA_DB_ID_ZERO =			0,
201 	/* 64K + 1 */
202 	IRDMA_MAX_OUTBOUND_MSG_SIZE =		65537,
203 	/* 64K +1 */
204 	IRDMA_MAX_INBOUND_MSG_SIZE =		65537,
205 	IRDMA_MAX_PUSH_PAGE_COUNT =		1024,
206 	IRDMA_MAX_PE_ENA_VF_COUNT =		32,
207 	IRDMA_MAX_VF_FPM_ID =			47,
208 	IRDMA_MAX_SQ_PAYLOAD_SIZE =		2145386496,
209 	IRDMA_MAX_INLINE_DATA_SIZE =		101,
210 	IRDMA_MAX_WQ_ENTRIES =			32768,
211 	IRDMA_Q2_BUF_SIZE =			256,
212 	IRDMA_QP_CTX_SIZE =			256,
213 	IRDMA_MAX_PDS =				262144,
214 };
215 
216 enum irdma_addressing_type {
217 	IRDMA_ADDR_TYPE_ZERO_BASED = 0,
218 	IRDMA_ADDR_TYPE_VA_BASED   = 1,
219 };
220 
221 enum irdma_flush_opcode {
222 	FLUSH_INVALID = 0,
223 	FLUSH_GENERAL_ERR,
224 	FLUSH_PROT_ERR,
225 	FLUSH_REM_ACCESS_ERR,
226 	FLUSH_LOC_QP_OP_ERR,
227 	FLUSH_REM_OP_ERR,
228 	FLUSH_LOC_LEN_ERR,
229 	FLUSH_FATAL_ERR,
230 	FLUSH_RETRY_EXC_ERR,
231 	FLUSH_MW_BIND_ERR,
232 	FLUSH_REM_INV_REQ_ERR,
233 };
234 
235 enum irdma_qp_event_type {
236 	IRDMA_QP_EVENT_CATASTROPHIC,
237 	IRDMA_QP_EVENT_ACCESS_ERR,
238 	IRDMA_QP_EVENT_REQ_ERR,
239 };
240 
241 enum irdma_cmpl_status {
242 	IRDMA_COMPL_STATUS_SUCCESS = 0,
243 	IRDMA_COMPL_STATUS_FLUSHED,
244 	IRDMA_COMPL_STATUS_INVALID_WQE,
245 	IRDMA_COMPL_STATUS_QP_CATASTROPHIC,
246 	IRDMA_COMPL_STATUS_REMOTE_TERMINATION,
247 	IRDMA_COMPL_STATUS_INVALID_STAG,
248 	IRDMA_COMPL_STATUS_BASE_BOUND_VIOLATION,
249 	IRDMA_COMPL_STATUS_ACCESS_VIOLATION,
250 	IRDMA_COMPL_STATUS_INVALID_PD_ID,
251 	IRDMA_COMPL_STATUS_WRAP_ERROR,
252 	IRDMA_COMPL_STATUS_STAG_INVALID_PDID,
253 	IRDMA_COMPL_STATUS_RDMA_READ_ZERO_ORD,
254 	IRDMA_COMPL_STATUS_QP_NOT_PRIVLEDGED,
255 	IRDMA_COMPL_STATUS_STAG_NOT_INVALID,
256 	IRDMA_COMPL_STATUS_INVALID_PHYS_BUF_SIZE,
257 	IRDMA_COMPL_STATUS_INVALID_PHYS_BUF_ENTRY,
258 	IRDMA_COMPL_STATUS_INVALID_FBO,
259 	IRDMA_COMPL_STATUS_INVALID_LEN,
260 	IRDMA_COMPL_STATUS_INVALID_ACCESS,
261 	IRDMA_COMPL_STATUS_PHYS_BUF_LIST_TOO_LONG,
262 	IRDMA_COMPL_STATUS_INVALID_VIRT_ADDRESS,
263 	IRDMA_COMPL_STATUS_INVALID_REGION,
264 	IRDMA_COMPL_STATUS_INVALID_WINDOW,
265 	IRDMA_COMPL_STATUS_INVALID_TOTAL_LEN,
266 	IRDMA_COMPL_STATUS_UNKNOWN,
267 };
268 
269 enum irdma_cmpl_notify {
270 	IRDMA_CQ_COMPL_EVENT     = 0,
271 	IRDMA_CQ_COMPL_SOLICITED = 1,
272 };
273 
274 enum irdma_qp_caps {
275 	IRDMA_WRITE_WITH_IMM = 1,
276 	IRDMA_SEND_WITH_IMM  = 2,
277 	IRDMA_ROCE	     = 4,
278 	IRDMA_PUSH_MODE      = 8,
279 };
280 
281 struct irdma_qp_uk;
282 struct irdma_cq_uk;
283 struct irdma_qp_uk_init_info;
284 struct irdma_cq_uk_init_info;
285 
286 struct irdma_sge {
287 	irdma_tagged_offset tag_off;
288 	u32 len;
289 	irdma_stag stag;
290 };
291 
292 struct irdma_ring {
293 	volatile u32 head;
294 	volatile u32 tail;	/* effective tail */
295 	u32 size;
296 };
297 
298 struct irdma_cqe {
299 	__le64 buf[IRDMA_CQE_SIZE];
300 };
301 
302 struct irdma_extended_cqe {
303 	__le64 buf[IRDMA_EXTENDED_CQE_SIZE];
304 };
305 
306 struct irdma_post_send {
307 	irdma_sgl sg_list;
308 	u32 num_sges;
309 	u32 qkey;
310 	u32 dest_qp;
311 	u32 ah_id;
312 };
313 
314 struct irdma_post_rq_info {
315 	u64 wr_id;
316 	irdma_sgl sg_list;
317 	u32 num_sges;
318 };
319 
320 struct irdma_rdma_write {
321 	irdma_sgl lo_sg_list;
322 	u32 num_lo_sges;
323 	struct irdma_sge rem_addr;
324 };
325 
326 struct irdma_rdma_read {
327 	irdma_sgl lo_sg_list;
328 	u32 num_lo_sges;
329 	struct irdma_sge rem_addr;
330 };
331 
332 struct irdma_bind_window {
333 	irdma_stag mr_stag;
334 	u64 bind_len;
335 	void *va;
336 	enum irdma_addressing_type addressing_type;
337 	bool ena_reads:1;
338 	bool ena_writes:1;
339 	irdma_stag mw_stag;
340 	bool mem_window_type_1:1;
341 };
342 
343 struct irdma_inv_local_stag {
344 	irdma_stag target_stag;
345 };
346 
347 struct irdma_post_sq_info {
348 	u64 wr_id;
349 	u8 op_type;
350 	u8 l4len;
351 	bool signaled:1;
352 	bool read_fence:1;
353 	bool local_fence:1;
354 	bool inline_data:1;
355 	bool imm_data_valid:1;
356 	bool push_wqe:1;
357 	bool report_rtt:1;
358 	bool udp_hdr:1;
359 	bool defer_flag:1;
360 	u32 imm_data;
361 	u32 stag_to_inv;
362 	union {
363 		struct irdma_post_send send;
364 		struct irdma_rdma_write rdma_write;
365 		struct irdma_rdma_read rdma_read;
366 		struct irdma_bind_window bind_window;
367 		struct irdma_inv_local_stag inv_local_stag;
368 	} op;
369 };
370 
371 struct irdma_cq_poll_info {
372 	u64 wr_id;
373 	irdma_qp_handle qp_handle;
374 	u32 bytes_xfered;
375 	u32 qp_id;
376 	u32 ud_src_qpn;
377 	u32 imm_data;
378 	irdma_stag inv_stag; /* or L_R_Key */
379 	enum irdma_cmpl_status comp_status;
380 	u16 major_err;
381 	u16 minor_err;
382 	u16 ud_vlan;
383 	u8 ud_smac[6];
384 	u8 op_type;
385 	u8 q_type;
386 	bool stag_invalid_set:1; /* or L_R_Key set */
387 	bool push_dropped:1;
388 	bool error:1;
389 	bool solicited_event:1;
390 	bool ipv4:1;
391 	bool ud_vlan_valid:1;
392 	bool ud_smac_valid:1;
393 	bool imm_valid:1;
394 	bool signaled:1;
395 	union {
396 		u32 tcp_sqn;
397 		u32 roce_psn;
398 		u32 rtt;
399 		u32 raw;
400 	} stat;
401 };
402 
403 struct qp_err_code {
404 	enum irdma_flush_opcode flush_code;
405 	enum irdma_qp_event_type event_type;
406 };
407 
408 int irdma_uk_inline_rdma_write(struct irdma_qp_uk *qp,
409 			       struct irdma_post_sq_info *info, bool post_sq);
410 int irdma_uk_inline_send(struct irdma_qp_uk *qp,
411 			 struct irdma_post_sq_info *info, bool post_sq);
412 int irdma_uk_mw_bind(struct irdma_qp_uk *qp, struct irdma_post_sq_info *info,
413 		     bool post_sq);
414 int irdma_uk_post_nop(struct irdma_qp_uk *qp, u64 wr_id, bool signaled,
415 		      bool post_sq);
416 int irdma_uk_post_receive(struct irdma_qp_uk *qp,
417 			  struct irdma_post_rq_info *info);
418 void irdma_uk_qp_post_wr(struct irdma_qp_uk *qp);
419 int irdma_uk_rdma_read(struct irdma_qp_uk *qp, struct irdma_post_sq_info *info,
420 		       bool inv_stag, bool post_sq);
421 int irdma_uk_rdma_write(struct irdma_qp_uk *qp, struct irdma_post_sq_info *info,
422 			bool post_sq);
423 int irdma_uk_send(struct irdma_qp_uk *qp, struct irdma_post_sq_info *info,
424 		  bool post_sq);
425 int irdma_uk_stag_local_invalidate(struct irdma_qp_uk *qp,
426 				   struct irdma_post_sq_info *info,
427 				   bool post_sq);
428 
429 struct irdma_wqe_uk_ops {
430 	void (*iw_copy_inline_data)(u8 *dest, struct irdma_sge *sge_list, u32 num_sges, u8 polarity);
431 	u16 (*iw_inline_data_size_to_quanta)(u32 data_size);
432 	void (*iw_set_fragment)(__le64 *wqe, u32 offset, struct irdma_sge *sge,
433 				u8 valid);
434 	void (*iw_set_mw_bind_wqe)(__le64 *wqe,
435 				   struct irdma_bind_window *op_info);
436 };
437 
438 int irdma_uk_cq_poll_cmpl(struct irdma_cq_uk *cq,
439 			  struct irdma_cq_poll_info *info);
440 void irdma_uk_cq_request_notification(struct irdma_cq_uk *cq,
441 				      enum irdma_cmpl_notify cq_notify);
442 void irdma_uk_cq_resize(struct irdma_cq_uk *cq, void *cq_base, int size);
443 void irdma_uk_cq_set_resized_cnt(struct irdma_cq_uk *qp, u16 cnt);
444 int irdma_uk_cq_init(struct irdma_cq_uk *cq,
445 		     struct irdma_cq_uk_init_info *info);
446 int irdma_uk_qp_init(struct irdma_qp_uk *qp,
447 		     struct irdma_qp_uk_init_info *info);
448 void irdma_uk_calc_shift_wq(struct irdma_qp_uk_init_info *ukinfo, u8 *sq_shift,
449 			    u8 *rq_shift);
450 int irdma_uk_calc_depth_shift_sq(struct irdma_qp_uk_init_info *ukinfo,
451 				 u32 *sq_depth, u8 *sq_shift);
452 int irdma_uk_calc_depth_shift_rq(struct irdma_qp_uk_init_info *ukinfo,
453 				 u32 *rq_depth, u8 *rq_shift);
454 struct irdma_sq_uk_wr_trk_info {
455 	u64 wrid;
456 	u32 wr_len;
457 	u16 quanta;
458 	u8 signaled;
459 	u8 reserved[1];
460 };
461 
462 struct irdma_qp_quanta {
463 	__le64 elem[IRDMA_WQE_SIZE];
464 };
465 
466 struct irdma_qp_uk {
467 	struct irdma_qp_quanta *sq_base;
468 	struct irdma_qp_quanta *rq_base;
469 	struct irdma_uk_attrs *uk_attrs;
470 	u32 IOMEM *wqe_alloc_db;
471 	struct irdma_sq_uk_wr_trk_info *sq_wrtrk_array;
472 	struct irdma_sig_wr_trk_info *sq_sigwrtrk_array;
473 	u64 *rq_wrid_array;
474 	__le64 *shadow_area;
475 	__le32 *push_db;
476 	__le64 *push_wqe;
477 	struct irdma_ring sq_ring;
478 	struct irdma_ring sq_sig_ring;
479 	struct irdma_ring rq_ring;
480 	struct irdma_ring initial_ring;
481 	u32 qp_id;
482 	u32 qp_caps;
483 	u32 sq_size;
484 	u32 rq_size;
485 	u32 max_sq_frag_cnt;
486 	u32 max_rq_frag_cnt;
487 	u32 max_inline_data;
488 	u32 last_rx_cmpl_idx;
489 	u32 last_tx_cmpl_idx;
490 	struct irdma_wqe_uk_ops wqe_ops;
491 	u16 conn_wqes;
492 	u8 qp_type;
493 	u8 swqe_polarity;
494 	u8 swqe_polarity_deferred;
495 	u8 rwqe_polarity;
496 	u8 rq_wqe_size;
497 	u8 rq_wqe_size_multiplier;
498 	bool deferred_flag:1;
499 	bool push_mode:1; /* whether the last post wqe was pushed */
500 	bool push_dropped:1;
501 	bool first_sq_wq:1;
502 	bool sq_flush_complete:1; /* Indicates flush was seen and SQ was empty after the flush */
503 	bool rq_flush_complete:1; /* Indicates flush was seen and RQ was empty after the flush */
504 	bool destroy_pending:1; /* Indicates the QP is being destroyed */
505 	void *back_qp;
506 	pthread_spinlock_t *lock;
507 	u8 dbg_rq_flushed;
508 	u16 ord_cnt;
509 	u8 sq_flush_seen;
510 	u8 rq_flush_seen;
511 	u8 rd_fence_rate;
512 };
513 
514 struct irdma_cq_uk {
515 	struct irdma_cqe *cq_base;
516 	u32 IOMEM *cqe_alloc_db;
517 	u32 IOMEM *cq_ack_db;
518 	__le64 *shadow_area;
519 	u32 cq_id;
520 	u32 cq_size;
521 	struct irdma_ring cq_ring;
522 	u8 polarity;
523 	bool avoid_mem_cflct:1;
524 };
525 
526 struct irdma_qp_uk_init_info {
527 	struct irdma_qp_quanta *sq;
528 	struct irdma_qp_quanta *rq;
529 	struct irdma_uk_attrs *uk_attrs;
530 	u32 IOMEM *wqe_alloc_db;
531 	__le64 *shadow_area;
532 	struct irdma_sq_uk_wr_trk_info *sq_wrtrk_array;
533 	struct irdma_sig_wr_trk_info *sq_sigwrtrk_array;
534 	u64 *rq_wrid_array;
535 	u32 qp_id;
536 	u32 qp_caps;
537 	u32 sq_size;
538 	u32 rq_size;
539 	u32 max_sq_frag_cnt;
540 	u32 max_rq_frag_cnt;
541 	u32 max_inline_data;
542 	u32 sq_depth;
543 	u32 rq_depth;
544 	u8 first_sq_wq;
545 	u8 type;
546 	u8 sq_shift;
547 	u8 rq_shift;
548 	u8 rd_fence_rate;
549 	int abi_ver;
550 	bool legacy_mode;
551 };
552 
553 struct irdma_cq_uk_init_info {
554 	u32 IOMEM *cqe_alloc_db;
555 	u32 IOMEM *cq_ack_db;
556 	struct irdma_cqe *cq_base;
557 	__le64 *shadow_area;
558 	u32 cq_size;
559 	u32 cq_id;
560 	bool avoid_mem_cflct;
561 };
562 
563 __le64 *irdma_qp_get_next_send_wqe(struct irdma_qp_uk *qp, u32 *wqe_idx,
564 				   u16 *quanta, u32 total_size,
565 				   struct irdma_post_sq_info *info);
566 __le64 *irdma_qp_get_next_recv_wqe(struct irdma_qp_uk *qp, u32 *wqe_idx);
567 int irdma_uk_clean_cq(void *q, struct irdma_cq_uk *cq);
568 int irdma_nop(struct irdma_qp_uk *qp, u64 wr_id, bool signaled, bool post_sq);
569 int irdma_fragcnt_to_quanta_sq(u32 frag_cnt, u16 *quanta);
570 int irdma_fragcnt_to_wqesize_rq(u32 frag_cnt, u16 *wqe_size);
571 void irdma_get_wqe_shift(struct irdma_uk_attrs *uk_attrs, u32 sge,
572 			 u32 inline_data, u8 *shift);
573 int irdma_get_sqdepth(struct irdma_uk_attrs *uk_attrs, u32 sq_size, u8 shift, u32 *sqdepth);
574 int irdma_get_rqdepth(struct irdma_uk_attrs *uk_attrs, u32 rq_size, u8 shift, u32 *rqdepth);
575 void irdma_qp_push_wqe(struct irdma_qp_uk *qp, __le64 *wqe, u16 quanta,
576 		       u32 wqe_idx, bool post_sq);
577 void irdma_clr_wqes(struct irdma_qp_uk *qp, u32 qp_wqe_idx);
578 
579 static inline struct qp_err_code irdma_ae_to_qp_err_code(u16 ae_id)
580 {
581 	struct qp_err_code qp_err = { 0 };
582 
583 	switch (ae_id) {
584 	case IRDMA_AE_AMP_BOUNDS_VIOLATION:
585 	case IRDMA_AE_AMP_INVALID_STAG:
586 	case IRDMA_AE_AMP_RIGHTS_VIOLATION:
587 	case IRDMA_AE_AMP_UNALLOCATED_STAG:
588 	case IRDMA_AE_AMP_BAD_PD:
589 	case IRDMA_AE_AMP_BAD_QP:
590 	case IRDMA_AE_AMP_BAD_STAG_KEY:
591 	case IRDMA_AE_AMP_BAD_STAG_INDEX:
592 	case IRDMA_AE_AMP_TO_WRAP:
593 	case IRDMA_AE_PRIV_OPERATION_DENIED:
594 		qp_err.flush_code = FLUSH_PROT_ERR;
595 		qp_err.event_type = IRDMA_QP_EVENT_ACCESS_ERR;
596 		break;
597 	case IRDMA_AE_UDA_XMIT_BAD_PD:
598 	case IRDMA_AE_WQE_UNEXPECTED_OPCODE:
599 		qp_err.flush_code = FLUSH_LOC_QP_OP_ERR;
600 		qp_err.event_type = IRDMA_QP_EVENT_CATASTROPHIC;
601 		break;
602 	case IRDMA_AE_UDA_XMIT_DGRAM_TOO_SHORT:
603 	case IRDMA_AE_UDA_XMIT_DGRAM_TOO_LONG:
604 	case IRDMA_AE_UDA_L4LEN_INVALID:
605 	case IRDMA_AE_DDP_UBE_INVALID_MO:
606 	case IRDMA_AE_DDP_UBE_DDP_MESSAGE_TOO_LONG_FOR_AVAILABLE_BUFFER:
607 		qp_err.flush_code = FLUSH_LOC_LEN_ERR;
608 		qp_err.event_type = IRDMA_QP_EVENT_CATASTROPHIC;
609 		break;
610 	case IRDMA_AE_AMP_INVALIDATE_NO_REMOTE_ACCESS_RIGHTS:
611 	case IRDMA_AE_IB_REMOTE_ACCESS_ERROR:
612 		qp_err.flush_code = FLUSH_REM_ACCESS_ERR;
613 		qp_err.event_type = IRDMA_QP_EVENT_ACCESS_ERR;
614 		break;
615 	case IRDMA_AE_AMP_MWBIND_INVALID_RIGHTS:
616 	case IRDMA_AE_AMP_MWBIND_BIND_DISABLED:
617 	case IRDMA_AE_AMP_MWBIND_INVALID_BOUNDS:
618 	case IRDMA_AE_AMP_MWBIND_VALID_STAG:
619 		qp_err.flush_code = FLUSH_MW_BIND_ERR;
620 		qp_err.event_type = IRDMA_QP_EVENT_ACCESS_ERR;
621 		break;
622 	case IRDMA_AE_LLP_TOO_MANY_RETRIES:
623 		qp_err.flush_code = FLUSH_RETRY_EXC_ERR;
624 		qp_err.event_type = IRDMA_QP_EVENT_CATASTROPHIC;
625 		break;
626 	case IRDMA_AE_IB_INVALID_REQUEST:
627 		qp_err.flush_code = FLUSH_REM_INV_REQ_ERR;
628 		qp_err.event_type = IRDMA_QP_EVENT_REQ_ERR;
629 		break;
630 	case IRDMA_AE_LLP_SEGMENT_TOO_SMALL:
631 	case IRDMA_AE_LLP_RECEIVED_MPA_CRC_ERROR:
632 	case IRDMA_AE_ROCE_RSP_LENGTH_ERROR:
633 	case IRDMA_AE_IB_REMOTE_OP_ERROR:
634 		qp_err.flush_code = FLUSH_REM_OP_ERR;
635 		qp_err.event_type = IRDMA_QP_EVENT_CATASTROPHIC;
636 		break;
637 	case IRDMA_AE_LCE_QP_CATASTROPHIC:
638 		qp_err.flush_code = FLUSH_FATAL_ERR;
639 		qp_err.event_type = IRDMA_QP_EVENT_CATASTROPHIC;
640 		break;
641 	default:
642 		qp_err.flush_code = FLUSH_GENERAL_ERR;
643 		qp_err.event_type = IRDMA_QP_EVENT_CATASTROPHIC;
644 		break;
645 	}
646 
647 	return qp_err;
648 }
649 #endif /* IRDMA_USER_H */
650