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