xref: /freebsd/sys/dev/mlx5/mlx5_ib/mlx5_ib.h (revision 5bf5ca772c6de2d53344a78cf461447cc322ccea)
1 /*-
2  * Copyright (c) 2013-2015, Mellanox Technologies, Ltd.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS `AS IS' AND
14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16  * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23  * SUCH DAMAGE.
24  *
25  * $FreeBSD$
26  */
27 
28 #ifndef MLX5_IB_H
29 #define MLX5_IB_H
30 
31 #include <linux/kernel.h>
32 #include <linux/sched.h>
33 #include <linux/printk.h>
34 #include <rdma/ib_verbs.h>
35 #include <rdma/ib_smi.h>
36 #include <dev/mlx5/cq.h>
37 #include <dev/mlx5/qp.h>
38 #include <dev/mlx5/srq.h>
39 #include <linux/types.h>
40 #include <dev/mlx5/mlx5_core/transobj.h>
41 #include <rdma/ib_user_verbs.h>
42 #include <rdma/mlx5-abi.h>
43 
44 #define mlx5_ib_dbg(dev, format, arg...)				\
45 pr_debug("%s:%s:%d:(pid %d): " format, (dev)->ib_dev.name, __func__,	\
46 	 __LINE__, current->pid, ##arg)
47 
48 #define mlx5_ib_err(dev, format, arg...)				\
49 pr_err("%s:%s:%d:(pid %d): " format, (dev)->ib_dev.name, __func__,	\
50 	__LINE__, current->pid, ##arg)
51 
52 #define mlx5_ib_warn(dev, format, arg...)				\
53 pr_warn("%s:%s:%d:(pid %d): " format, (dev)->ib_dev.name, __func__,	\
54 	__LINE__, current->pid, ##arg)
55 
56 #define field_avail(type, fld, sz) (offsetof(type, fld) +		\
57 				    sizeof(((type *)0)->fld) <= (sz))
58 #define MLX5_IB_DEFAULT_UIDX 0xffffff
59 #define MLX5_USER_ASSIGNED_UIDX_MASK __mlx5_mask(qpc, user_index)
60 
61 enum {
62 	MLX5_IB_MMAP_CMD_SHIFT	= 8,
63 	MLX5_IB_MMAP_CMD_MASK	= 0xff,
64 };
65 
66 enum mlx5_ib_mmap_cmd {
67 	MLX5_IB_MMAP_REGULAR_PAGE		= 0,
68 	MLX5_IB_MMAP_GET_CONTIGUOUS_PAGES	= 1,
69 	MLX5_IB_MMAP_WC_PAGE			= 2,
70 	MLX5_IB_MMAP_NC_PAGE			= 3,
71 	/* 5 is chosen in order to be compatible with old versions of libmlx5 */
72 	MLX5_IB_MMAP_CORE_CLOCK			= 5,
73 };
74 
75 enum {
76 	MLX5_RES_SCAT_DATA32_CQE	= 0x1,
77 	MLX5_RES_SCAT_DATA64_CQE	= 0x2,
78 	MLX5_REQ_SCAT_DATA32_CQE	= 0x11,
79 	MLX5_REQ_SCAT_DATA64_CQE	= 0x22,
80 };
81 
82 enum mlx5_ib_latency_class {
83 	MLX5_IB_LATENCY_CLASS_LOW,
84 	MLX5_IB_LATENCY_CLASS_MEDIUM,
85 	MLX5_IB_LATENCY_CLASS_HIGH,
86 	MLX5_IB_LATENCY_CLASS_FAST_PATH
87 };
88 
89 enum mlx5_ib_mad_ifc_flags {
90 	MLX5_MAD_IFC_IGNORE_MKEY	= 1,
91 	MLX5_MAD_IFC_IGNORE_BKEY	= 2,
92 	MLX5_MAD_IFC_NET_VIEW		= 4,
93 };
94 
95 enum {
96 	MLX5_CROSS_CHANNEL_UUAR         = 0,
97 };
98 
99 enum {
100 	MLX5_CQE_VERSION_V0,
101 	MLX5_CQE_VERSION_V1,
102 };
103 
104 struct mlx5_ib_vma_private_data {
105 	struct list_head list;
106 	struct vm_area_struct *vma;
107 };
108 
109 struct mlx5_ib_ucontext {
110 	struct ib_ucontext	ibucontext;
111 	struct list_head	db_page_list;
112 
113 	/* protect doorbell record alloc/free
114 	 */
115 	struct mutex		db_page_mutex;
116 	struct mlx5_uuar_info	uuari;
117 	u8			cqe_version;
118 	/* Transport Domain number */
119 	u32			tdn;
120 	struct list_head	vma_private_list;
121 };
122 
123 static inline struct mlx5_ib_ucontext *to_mucontext(struct ib_ucontext *ibucontext)
124 {
125 	return container_of(ibucontext, struct mlx5_ib_ucontext, ibucontext);
126 }
127 
128 struct mlx5_ib_pd {
129 	struct ib_pd		ibpd;
130 	u32			pdn;
131 };
132 
133 #define MLX5_IB_FLOW_MCAST_PRIO		(MLX5_BY_PASS_NUM_PRIOS - 1)
134 #define MLX5_IB_FLOW_LAST_PRIO		(MLX5_BY_PASS_NUM_REGULAR_PRIOS - 1)
135 #if (MLX5_IB_FLOW_LAST_PRIO <= 0)
136 #error "Invalid number of bypass priorities"
137 #endif
138 #define MLX5_IB_FLOW_LEFTOVERS_PRIO	(MLX5_IB_FLOW_MCAST_PRIO + 1)
139 
140 #define MLX5_IB_NUM_FLOW_FT		(MLX5_IB_FLOW_LEFTOVERS_PRIO + 1)
141 #define MLX5_IB_NUM_SNIFFER_FTS		2
142 struct mlx5_ib_flow_prio {
143 	struct mlx5_flow_table		*flow_table;
144 	unsigned int			refcount;
145 };
146 
147 struct mlx5_ib_flow_handler {
148 	struct list_head		list;
149 	struct ib_flow			ibflow;
150 	struct mlx5_ib_flow_prio	*prio;
151 	struct mlx5_flow_rule	*rule;
152 };
153 
154 struct mlx5_ib_flow_db {
155 	struct mlx5_ib_flow_prio	prios[MLX5_IB_NUM_FLOW_FT];
156 	struct mlx5_ib_flow_prio	sniffer[MLX5_IB_NUM_SNIFFER_FTS];
157 	struct mlx5_flow_table		*lag_demux_ft;
158 	/* Protect flow steering bypass flow tables
159 	 * when add/del flow rules.
160 	 * only single add/removal of flow steering rule could be done
161 	 * simultaneously.
162 	 */
163 	struct mutex			lock;
164 };
165 
166 /* Use macros here so that don't have to duplicate
167  * enum ib_send_flags and enum ib_qp_type for low-level driver
168  */
169 
170 #define MLX5_IB_SEND_UMR_UNREG	IB_SEND_RESERVED_START
171 #define MLX5_IB_SEND_UMR_FAIL_IF_FREE (IB_SEND_RESERVED_START << 1)
172 #define MLX5_IB_SEND_UMR_UPDATE_MTT (IB_SEND_RESERVED_START << 2)
173 
174 #define MLX5_IB_SEND_UMR_UPDATE_TRANSLATION	(IB_SEND_RESERVED_START << 3)
175 #define MLX5_IB_SEND_UMR_UPDATE_PD		(IB_SEND_RESERVED_START << 4)
176 #define MLX5_IB_SEND_UMR_UPDATE_ACCESS		IB_SEND_RESERVED_END
177 
178 #define MLX5_IB_QPT_REG_UMR	IB_QPT_RESERVED1
179 /*
180  * IB_QPT_GSI creates the software wrapper around GSI, and MLX5_IB_QPT_HW_GSI
181  * creates the actual hardware QP.
182  */
183 #define MLX5_IB_QPT_HW_GSI	IB_QPT_RESERVED2
184 #define MLX5_IB_WR_UMR		IB_WR_RESERVED1
185 
186 /* Private QP creation flags to be passed in ib_qp_init_attr.create_flags.
187  *
188  * These flags are intended for internal use by the mlx5_ib driver, and they
189  * rely on the range reserved for that use in the ib_qp_create_flags enum.
190  */
191 
192 /* Create a UD QP whose source QP number is 1 */
193 static inline enum ib_qp_create_flags mlx5_ib_create_qp_sqpn_qp1(void)
194 {
195 	return IB_QP_CREATE_RESERVED_START;
196 }
197 
198 struct wr_list {
199 	u16	opcode;
200 	u16	next;
201 };
202 
203 struct mlx5_ib_wq {
204 	u64		       *wrid;
205 	u32		       *wr_data;
206 	struct wr_list	       *w_list;
207 	unsigned	       *wqe_head;
208 	u16		        unsig_count;
209 
210 	/* serialize post to the work queue
211 	 */
212 	spinlock_t		lock;
213 	int			wqe_cnt;
214 	int			max_post;
215 	int			max_gs;
216 	int			offset;
217 	int			wqe_shift;
218 	unsigned		head;
219 	unsigned		tail;
220 	u16			cur_post;
221 	u16			last_poll;
222 	void		       *qend;
223 };
224 
225 struct mlx5_ib_rwq {
226 	struct ib_wq		ibwq;
227 	struct mlx5_core_qp	core_qp;
228 	u32			rq_num_pas;
229 	u32			log_rq_stride;
230 	u32			log_rq_size;
231 	u32			rq_page_offset;
232 	u32			log_page_size;
233 	struct ib_umem		*umem;
234 	size_t			buf_size;
235 	unsigned int		page_shift;
236 	int			create_type;
237 	struct mlx5_db		db;
238 	u32			user_index;
239 	u32			wqe_count;
240 	u32			wqe_shift;
241 	int			wq_sig;
242 };
243 
244 enum {
245 	MLX5_QP_USER,
246 	MLX5_QP_KERNEL,
247 	MLX5_QP_EMPTY
248 };
249 
250 enum {
251 	MLX5_WQ_USER,
252 	MLX5_WQ_KERNEL
253 };
254 
255 struct mlx5_ib_rwq_ind_table {
256 	struct ib_rwq_ind_table ib_rwq_ind_tbl;
257 	u32			rqtn;
258 };
259 
260 /*
261  * Connect-IB can trigger up to four concurrent pagefaults
262  * per-QP.
263  */
264 enum mlx5_ib_pagefault_context {
265 	MLX5_IB_PAGEFAULT_RESPONDER_READ,
266 	MLX5_IB_PAGEFAULT_REQUESTOR_READ,
267 	MLX5_IB_PAGEFAULT_RESPONDER_WRITE,
268 	MLX5_IB_PAGEFAULT_REQUESTOR_WRITE,
269 	MLX5_IB_PAGEFAULT_CONTEXTS
270 };
271 
272 static inline enum mlx5_ib_pagefault_context
273 	mlx5_ib_get_pagefault_context(struct mlx5_pagefault *pagefault)
274 {
275 	return pagefault->flags & (MLX5_PFAULT_REQUESTOR | MLX5_PFAULT_WRITE);
276 }
277 
278 struct mlx5_ib_pfault {
279 	struct work_struct	work;
280 	struct mlx5_pagefault	mpfault;
281 };
282 
283 struct mlx5_ib_ubuffer {
284 	struct ib_umem	       *umem;
285 	int			buf_size;
286 	u64			buf_addr;
287 };
288 
289 struct mlx5_ib_qp_base {
290 	struct mlx5_ib_qp	*container_mibqp;
291 	struct mlx5_core_qp	mqp;
292 	struct mlx5_ib_ubuffer	ubuffer;
293 };
294 
295 struct mlx5_ib_qp_trans {
296 	struct mlx5_ib_qp_base	base;
297 	u16			xrcdn;
298 	u8			alt_port;
299 	u8			atomic_rd_en;
300 	u8			resp_depth;
301 };
302 
303 struct mlx5_ib_rss_qp {
304 	u32	tirn;
305 };
306 
307 struct mlx5_ib_rq {
308 	struct mlx5_ib_qp_base base;
309 	struct mlx5_ib_wq	*rq;
310 	struct mlx5_ib_ubuffer	ubuffer;
311 	struct mlx5_db		*doorbell;
312 	u32			tirn;
313 	u8			state;
314 };
315 
316 struct mlx5_ib_sq {
317 	struct mlx5_ib_qp_base base;
318 	struct mlx5_ib_wq	*sq;
319 	struct mlx5_ib_ubuffer  ubuffer;
320 	struct mlx5_db		*doorbell;
321 	u32			tisn;
322 	u8			state;
323 };
324 
325 struct mlx5_ib_raw_packet_qp {
326 	struct mlx5_ib_sq sq;
327 	struct mlx5_ib_rq rq;
328 };
329 
330 struct mlx5_ib_qp {
331 	struct ib_qp		ibqp;
332 	union {
333 		struct mlx5_ib_qp_trans trans_qp;
334 		struct mlx5_ib_raw_packet_qp raw_packet_qp;
335 		struct mlx5_ib_rss_qp rss_qp;
336 	};
337 	struct mlx5_buf		buf;
338 
339 	struct mlx5_db		db;
340 	struct mlx5_ib_wq	rq;
341 
342 	u8			sq_signal_bits;
343 	u8			fm_cache;
344 	struct mlx5_ib_wq	sq;
345 
346 	/* serialize qp state modifications
347 	 */
348 	struct mutex		mutex;
349 	u32			flags;
350 	u8			port;
351 	u8			state;
352 	int			wq_sig;
353 	int			scat_cqe;
354 	int			max_inline_data;
355 	struct mlx5_bf	       *bf;
356 	int			has_rq;
357 
358 	/* only for user space QPs. For kernel
359 	 * we have it from the bf object
360 	 */
361 	int			uuarn;
362 
363 	int			create_type;
364 
365 	/* Store signature errors */
366 	bool			signature_en;
367 
368 #ifdef CONFIG_INFINIBAND_ON_DEMAND_PAGING
369 	/*
370 	 * A flag that is true for QP's that are in a state that doesn't
371 	 * allow page faults, and shouldn't schedule any more faults.
372 	 */
373 	int                     disable_page_faults;
374 	/*
375 	 * The disable_page_faults_lock protects a QP's disable_page_faults
376 	 * field, allowing for a thread to atomically check whether the QP
377 	 * allows page faults, and if so schedule a page fault.
378 	 */
379 	spinlock_t              disable_page_faults_lock;
380 	struct mlx5_ib_pfault	pagefaults[MLX5_IB_PAGEFAULT_CONTEXTS];
381 #endif
382 	struct list_head	qps_list;
383 	struct list_head	cq_recv_list;
384 	struct list_head	cq_send_list;
385 };
386 
387 struct mlx5_ib_cq_buf {
388 	struct mlx5_buf		buf;
389 	struct ib_umem		*umem;
390 	int			cqe_size;
391 	int			nent;
392 };
393 
394 enum mlx5_ib_qp_flags {
395 	MLX5_IB_QP_LSO                          = IB_QP_CREATE_IPOIB_UD_LSO,
396 	MLX5_IB_QP_BLOCK_MULTICAST_LOOPBACK     = IB_QP_CREATE_BLOCK_MULTICAST_LOOPBACK,
397 	MLX5_IB_QP_CROSS_CHANNEL            = IB_QP_CREATE_CROSS_CHANNEL,
398 	MLX5_IB_QP_MANAGED_SEND             = IB_QP_CREATE_MANAGED_SEND,
399 	MLX5_IB_QP_MANAGED_RECV             = IB_QP_CREATE_MANAGED_RECV,
400 	MLX5_IB_QP_SIGNATURE_HANDLING           = 1 << 5,
401 	/* QP uses 1 as its source QP number */
402 	MLX5_IB_QP_SQPN_QP1			= 1 << 6,
403 	MLX5_IB_QP_CAP_SCATTER_FCS		= 1 << 7,
404 	MLX5_IB_QP_RSS				= 1 << 8,
405 };
406 
407 struct mlx5_umr_wr {
408 	struct ib_send_wr		wr;
409 	union {
410 		u64			virt_addr;
411 		u64			offset;
412 	} target;
413 	struct ib_pd		       *pd;
414 	unsigned int			page_shift;
415 	unsigned int			npages;
416 	u32				length;
417 	int				access_flags;
418 	u32				mkey;
419 };
420 
421 static inline struct mlx5_umr_wr *umr_wr(struct ib_send_wr *wr)
422 {
423 	return container_of(wr, struct mlx5_umr_wr, wr);
424 }
425 
426 struct mlx5_shared_mr_info {
427 	int mr_id;
428 	struct ib_umem		*umem;
429 };
430 
431 struct mlx5_ib_cq {
432 	struct ib_cq		ibcq;
433 	struct mlx5_core_cq	mcq;
434 	struct mlx5_ib_cq_buf	buf;
435 	struct mlx5_db		db;
436 
437 	/* serialize access to the CQ
438 	 */
439 	spinlock_t		lock;
440 
441 	/* protect resize cq
442 	 */
443 	struct mutex		resize_mutex;
444 	struct mlx5_ib_cq_buf  *resize_buf;
445 	struct ib_umem	       *resize_umem;
446 	int			cqe_size;
447 	struct list_head	list_send_qp;
448 	struct list_head	list_recv_qp;
449 	u32			create_flags;
450 	struct list_head	wc_list;
451 	enum ib_cq_notify_flags notify_flags;
452 	struct work_struct	notify_work;
453 };
454 
455 struct mlx5_ib_wc {
456 	struct ib_wc wc;
457 	struct list_head list;
458 };
459 
460 struct mlx5_ib_srq {
461 	struct ib_srq		ibsrq;
462 	struct mlx5_core_srq	msrq;
463 	struct mlx5_buf		buf;
464 	struct mlx5_db		db;
465 	u64		       *wrid;
466 	/* protect SRQ hanlding
467 	 */
468 	spinlock_t		lock;
469 	int			head;
470 	int			tail;
471 	u16			wqe_ctr;
472 	struct ib_umem	       *umem;
473 	/* serialize arming a SRQ
474 	 */
475 	struct mutex		mutex;
476 	int			wq_sig;
477 };
478 
479 struct mlx5_ib_xrcd {
480 	struct ib_xrcd		ibxrcd;
481 	u32			xrcdn;
482 };
483 
484 enum mlx5_ib_mtt_access_flags {
485 	MLX5_IB_MTT_READ  = (1 << 0),
486 	MLX5_IB_MTT_WRITE = (1 << 1),
487 };
488 
489 #define MLX5_IB_MTT_PRESENT (MLX5_IB_MTT_READ | MLX5_IB_MTT_WRITE)
490 
491 struct mlx5_ib_mr {
492 	struct ib_mr		ibmr;
493 	void			*descs;
494 	dma_addr_t		desc_map;
495 	int			ndescs;
496 	int			max_descs;
497 	int			desc_size;
498 	int			access_mode;
499 	struct mlx5_core_mr	mmkey;
500 	struct ib_umem	       *umem;
501 	struct mlx5_shared_mr_info	*smr_info;
502 	struct list_head	list;
503 	int			order;
504 	int			umred;
505 	int			npages;
506 	struct mlx5_ib_dev     *dev;
507 	u32 out[MLX5_ST_SZ_DW(create_mkey_out)];
508 	struct mlx5_core_sig_ctx    *sig;
509 	int			live;
510 	void			*descs_alloc;
511 	int			access_flags; /* Needed for rereg MR */
512 };
513 
514 struct mlx5_ib_mw {
515 	struct ib_mw		ibmw;
516 	struct mlx5_core_mr	mmkey;
517 };
518 
519 struct mlx5_ib_umr_context {
520 	struct ib_cqe		cqe;
521 	enum ib_wc_status	status;
522 	struct completion	done;
523 };
524 
525 struct umr_common {
526 	struct ib_pd	*pd;
527 	struct ib_cq	*cq;
528 	struct ib_qp	*qp;
529 	/* control access to UMR QP
530 	 */
531 	struct semaphore	sem;
532 };
533 
534 enum {
535 	MLX5_FMR_INVALID,
536 	MLX5_FMR_VALID,
537 	MLX5_FMR_BUSY,
538 };
539 
540 struct mlx5_cache_ent {
541 	struct list_head	head;
542 	/* sync access to the cahce entry
543 	 */
544 	spinlock_t		lock;
545 
546 
547 	struct dentry	       *dir;
548 	char                    name[4];
549 	u32                     order;
550 	u32			size;
551 	u32                     cur;
552 	u32                     miss;
553 	u32			limit;
554 
555 	struct dentry          *fsize;
556 	struct dentry          *fcur;
557 	struct dentry          *fmiss;
558 	struct dentry          *flimit;
559 
560 	struct mlx5_ib_dev     *dev;
561 	struct work_struct	work;
562 	struct delayed_work	dwork;
563 	int			pending;
564 };
565 
566 struct mlx5_mr_cache {
567 	struct workqueue_struct *wq;
568 	struct mlx5_cache_ent	ent[MAX_MR_CACHE_ENTRIES];
569 	int			stopped;
570 	struct dentry		*root;
571 	unsigned long		last_add;
572 };
573 
574 struct mlx5_ib_gsi_qp;
575 
576 struct mlx5_ib_port_resources {
577 	struct mlx5_ib_resources *devr;
578 	struct mlx5_ib_gsi_qp *gsi;
579 	struct work_struct pkey_change_work;
580 };
581 
582 struct mlx5_ib_resources {
583 	struct ib_cq	*c0;
584 	struct ib_xrcd	*x0;
585 	struct ib_xrcd	*x1;
586 	struct ib_pd	*p0;
587 	struct ib_srq	*s0;
588 	struct ib_srq	*s1;
589 	struct mlx5_ib_port_resources ports[2];
590 	/* Protects changes to the port resources */
591 	struct mutex	mutex;
592 };
593 
594 struct mlx5_ib_port {
595 	u16 q_cnt_id;
596 };
597 
598 struct mlx5_roce {
599 	/* Protect mlx5_ib_get_netdev from invoking dev_hold() with a NULL
600 	 * netdev pointer
601 	 */
602 	rwlock_t		netdev_lock;
603 	struct net_device	*netdev;
604 	struct notifier_block	nb;
605 	atomic_t		next_port;
606 };
607 
608 struct mlx5_ib_dev {
609 	struct ib_device		ib_dev;
610 	struct mlx5_core_dev		*mdev;
611 	struct mlx5_roce		roce;
612 	MLX5_DECLARE_DOORBELL_LOCK(uar_lock);
613 	int				num_ports;
614 	/* serialize update of capability mask
615 	 */
616 	struct mutex			cap_mask_mutex;
617 	bool				ib_active;
618 	struct umr_common		umrc;
619 	/* sync used page count stats
620 	 */
621 	struct mlx5_ib_resources	devr;
622 	struct mlx5_mr_cache		cache;
623 	struct timer_list		delay_timer;
624 	/* Prevents soft lock on massive reg MRs */
625 	struct mutex			slow_path_mutex;
626 	int				fill_delay;
627 #ifdef CONFIG_INFINIBAND_ON_DEMAND_PAGING
628 	struct ib_odp_caps	odp_caps;
629 	/*
630 	 * Sleepable RCU that prevents destruction of MRs while they are still
631 	 * being used by a page fault handler.
632 	 */
633 	struct srcu_struct      mr_srcu;
634 #endif
635 	struct mlx5_ib_flow_db	flow_db;
636 	/* protect resources needed as part of reset flow */
637 	spinlock_t		reset_flow_resource_lock;
638 	struct list_head	qp_list;
639 	/* Array with num_ports elements */
640 	struct mlx5_ib_port	*port;
641 };
642 
643 static inline struct mlx5_ib_cq *to_mibcq(struct mlx5_core_cq *mcq)
644 {
645 	return container_of(mcq, struct mlx5_ib_cq, mcq);
646 }
647 
648 static inline struct mlx5_ib_xrcd *to_mxrcd(struct ib_xrcd *ibxrcd)
649 {
650 	return container_of(ibxrcd, struct mlx5_ib_xrcd, ibxrcd);
651 }
652 
653 static inline struct mlx5_ib_dev *to_mdev(struct ib_device *ibdev)
654 {
655 	return container_of(ibdev, struct mlx5_ib_dev, ib_dev);
656 }
657 
658 static inline struct mlx5_ib_cq *to_mcq(struct ib_cq *ibcq)
659 {
660 	return container_of(ibcq, struct mlx5_ib_cq, ibcq);
661 }
662 
663 static inline struct mlx5_ib_qp *to_mibqp(struct mlx5_core_qp *mqp)
664 {
665 	return container_of(mqp, struct mlx5_ib_qp_base, mqp)->container_mibqp;
666 }
667 
668 static inline struct mlx5_ib_rwq *to_mibrwq(struct mlx5_core_qp *core_qp)
669 {
670 	return container_of(core_qp, struct mlx5_ib_rwq, core_qp);
671 }
672 
673 static inline struct mlx5_ib_mr *to_mibmr(struct mlx5_core_mr *mmkey)
674 {
675 	return container_of(mmkey, struct mlx5_ib_mr, mmkey);
676 }
677 
678 static inline struct mlx5_ib_pd *to_mpd(struct ib_pd *ibpd)
679 {
680 	return container_of(ibpd, struct mlx5_ib_pd, ibpd);
681 }
682 
683 static inline struct mlx5_ib_srq *to_msrq(struct ib_srq *ibsrq)
684 {
685 	return container_of(ibsrq, struct mlx5_ib_srq, ibsrq);
686 }
687 
688 static inline struct mlx5_ib_qp *to_mqp(struct ib_qp *ibqp)
689 {
690 	return container_of(ibqp, struct mlx5_ib_qp, ibqp);
691 }
692 
693 static inline struct mlx5_ib_rwq *to_mrwq(struct ib_wq *ibwq)
694 {
695 	return container_of(ibwq, struct mlx5_ib_rwq, ibwq);
696 }
697 
698 static inline struct mlx5_ib_rwq_ind_table *to_mrwq_ind_table(struct ib_rwq_ind_table *ib_rwq_ind_tbl)
699 {
700 	return container_of(ib_rwq_ind_tbl, struct mlx5_ib_rwq_ind_table, ib_rwq_ind_tbl);
701 }
702 
703 static inline struct mlx5_ib_srq *to_mibsrq(struct mlx5_core_srq *msrq)
704 {
705 	return container_of(msrq, struct mlx5_ib_srq, msrq);
706 }
707 
708 static inline struct mlx5_ib_mr *to_mmr(struct ib_mr *ibmr)
709 {
710 	return container_of(ibmr, struct mlx5_ib_mr, ibmr);
711 }
712 
713 static inline struct mlx5_ib_mw *to_mmw(struct ib_mw *ibmw)
714 {
715 	return container_of(ibmw, struct mlx5_ib_mw, ibmw);
716 }
717 
718 struct mlx5_ib_ah {
719 	struct ib_ah		ibah;
720 	struct mlx5_av		av;
721 };
722 
723 static inline struct mlx5_ib_ah *to_mah(struct ib_ah *ibah)
724 {
725 	return container_of(ibah, struct mlx5_ib_ah, ibah);
726 }
727 
728 int mlx5_ib_db_map_user(struct mlx5_ib_ucontext *context, unsigned long virt,
729 			struct mlx5_db *db);
730 void mlx5_ib_db_unmap_user(struct mlx5_ib_ucontext *context, struct mlx5_db *db);
731 void __mlx5_ib_cq_clean(struct mlx5_ib_cq *cq, u32 qpn, struct mlx5_ib_srq *srq);
732 void mlx5_ib_cq_clean(struct mlx5_ib_cq *cq, u32 qpn, struct mlx5_ib_srq *srq);
733 void mlx5_ib_free_srq_wqe(struct mlx5_ib_srq *srq, int wqe_index);
734 int mlx5_MAD_IFC(struct mlx5_ib_dev *dev, int ignore_mkey, int ignore_bkey,
735 		 u8 port, const struct ib_wc *in_wc, const struct ib_grh *in_grh,
736 		 const void *in_mad, void *response_mad);
737 struct ib_ah *mlx5_ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr,
738 				struct ib_udata *udata);
739 int mlx5_ib_query_ah(struct ib_ah *ibah, struct ib_ah_attr *ah_attr);
740 int mlx5_ib_destroy_ah(struct ib_ah *ah);
741 struct ib_srq *mlx5_ib_create_srq(struct ib_pd *pd,
742 				  struct ib_srq_init_attr *init_attr,
743 				  struct ib_udata *udata);
744 int mlx5_ib_modify_srq(struct ib_srq *ibsrq, struct ib_srq_attr *attr,
745 		       enum ib_srq_attr_mask attr_mask, struct ib_udata *udata);
746 int mlx5_ib_query_srq(struct ib_srq *ibsrq, struct ib_srq_attr *srq_attr);
747 int mlx5_ib_destroy_srq(struct ib_srq *srq);
748 int mlx5_ib_post_srq_recv(struct ib_srq *ibsrq, struct ib_recv_wr *wr,
749 			  struct ib_recv_wr **bad_wr);
750 struct ib_qp *mlx5_ib_create_qp(struct ib_pd *pd,
751 				struct ib_qp_init_attr *init_attr,
752 				struct ib_udata *udata);
753 int mlx5_ib_modify_qp(struct ib_qp *ibqp, struct ib_qp_attr *attr,
754 		      int attr_mask, struct ib_udata *udata);
755 int mlx5_ib_query_qp(struct ib_qp *ibqp, struct ib_qp_attr *qp_attr, int qp_attr_mask,
756 		     struct ib_qp_init_attr *qp_init_attr);
757 int mlx5_ib_destroy_qp(struct ib_qp *qp);
758 int mlx5_ib_post_send(struct ib_qp *ibqp, struct ib_send_wr *wr,
759 		      struct ib_send_wr **bad_wr);
760 int mlx5_ib_post_recv(struct ib_qp *ibqp, struct ib_recv_wr *wr,
761 		      struct ib_recv_wr **bad_wr);
762 void *mlx5_get_send_wqe(struct mlx5_ib_qp *qp, int n);
763 int mlx5_ib_read_user_wqe(struct mlx5_ib_qp *qp, int send, int wqe_index,
764 			  void *buffer, u32 length,
765 			  struct mlx5_ib_qp_base *base);
766 struct ib_cq *mlx5_ib_create_cq(struct ib_device *ibdev,
767 				const struct ib_cq_init_attr *attr,
768 				struct ib_ucontext *context,
769 				struct ib_udata *udata);
770 int mlx5_ib_destroy_cq(struct ib_cq *cq);
771 int mlx5_ib_poll_cq(struct ib_cq *ibcq, int num_entries, struct ib_wc *wc);
772 int mlx5_ib_arm_cq(struct ib_cq *ibcq, enum ib_cq_notify_flags flags);
773 int mlx5_ib_modify_cq(struct ib_cq *cq, u16 cq_count, u16 cq_period);
774 int mlx5_ib_resize_cq(struct ib_cq *ibcq, int entries, struct ib_udata *udata);
775 struct ib_mr *mlx5_ib_get_dma_mr(struct ib_pd *pd, int acc);
776 struct ib_mr *mlx5_ib_reg_user_mr(struct ib_pd *pd, u64 start, u64 length,
777 				  u64 virt_addr, int access_flags,
778 				  struct ib_udata *udata);
779 struct ib_mw *mlx5_ib_alloc_mw(struct ib_pd *pd, enum ib_mw_type type,
780 			       struct ib_udata *udata);
781 int mlx5_ib_dealloc_mw(struct ib_mw *mw);
782 int mlx5_ib_update_mtt(struct mlx5_ib_mr *mr, u64 start_page_index,
783 		       int npages, int zap);
784 int mlx5_ib_rereg_user_mr(struct ib_mr *ib_mr, int flags, u64 start,
785 			  u64 length, u64 virt_addr, int access_flags,
786 			  struct ib_pd *pd, struct ib_udata *udata);
787 int mlx5_ib_dereg_mr(struct ib_mr *ibmr);
788 struct ib_mr *mlx5_ib_alloc_mr(struct ib_pd *pd,
789 			       enum ib_mr_type mr_type,
790 			       u32 max_num_sg);
791 int mlx5_ib_map_mr_sg(struct ib_mr *ibmr, struct scatterlist *sg, int sg_nents,
792 		      unsigned int *sg_offset);
793 int mlx5_ib_process_mad(struct ib_device *ibdev, int mad_flags, u8 port_num,
794 			const struct ib_wc *in_wc, const struct ib_grh *in_grh,
795 			const struct ib_mad_hdr *in, size_t in_mad_size,
796 			struct ib_mad_hdr *out, size_t *out_mad_size,
797 			u16 *out_mad_pkey_index);
798 struct ib_xrcd *mlx5_ib_alloc_xrcd(struct ib_device *ibdev,
799 					  struct ib_ucontext *context,
800 					  struct ib_udata *udata);
801 int mlx5_ib_dealloc_xrcd(struct ib_xrcd *xrcd);
802 int mlx5_ib_get_buf_offset(u64 addr, int page_shift, u32 *offset);
803 int mlx5_query_ext_port_caps(struct mlx5_ib_dev *dev, u8 port);
804 int mlx5_query_mad_ifc_smp_attr_node_info(struct ib_device *ibdev,
805 					  struct ib_smp *out_mad);
806 int mlx5_query_mad_ifc_system_image_guid(struct ib_device *ibdev,
807 					 __be64 *sys_image_guid);
808 int mlx5_query_mad_ifc_max_pkeys(struct ib_device *ibdev,
809 				 u16 *max_pkeys);
810 int mlx5_query_mad_ifc_vendor_id(struct ib_device *ibdev,
811 				 u32 *vendor_id);
812 int mlx5_query_mad_ifc_node_desc(struct mlx5_ib_dev *dev, char *node_desc);
813 int mlx5_query_mad_ifc_node_guid(struct mlx5_ib_dev *dev, __be64 *node_guid);
814 int mlx5_query_mad_ifc_pkey(struct ib_device *ibdev, u8 port, u16 index,
815 			    u16 *pkey);
816 int mlx5_query_mad_ifc_gids(struct ib_device *ibdev, u8 port, int index,
817 			    union ib_gid *gid);
818 int mlx5_query_mad_ifc_port(struct ib_device *ibdev, u8 port,
819 			    struct ib_port_attr *props);
820 int mlx5_ib_query_port(struct ib_device *ibdev, u8 port,
821 		       struct ib_port_attr *props);
822 int mlx5_ib_init_fmr(struct mlx5_ib_dev *dev);
823 void mlx5_ib_cleanup_fmr(struct mlx5_ib_dev *dev);
824 void mlx5_ib_cont_pages(struct ib_umem *umem, u64 addr, int *count, int *shift,
825 			int *ncont, int *order);
826 void __mlx5_ib_populate_pas(struct mlx5_ib_dev *dev, struct ib_umem *umem,
827 			    int page_shift, size_t offset, size_t num_pages,
828 			    __be64 *pas, int access_flags);
829 void mlx5_ib_populate_pas(struct mlx5_ib_dev *dev, struct ib_umem *umem,
830 			  int page_shift, __be64 *pas, int access_flags);
831 void mlx5_ib_copy_pas(u64 *old, u64 *new, int step, int num);
832 int mlx5_ib_get_cqe_size(struct mlx5_ib_dev *dev, struct ib_cq *ibcq);
833 int mlx5_mr_cache_init(struct mlx5_ib_dev *dev);
834 int mlx5_mr_cache_cleanup(struct mlx5_ib_dev *dev);
835 int mlx5_mr_ib_cont_pages(struct ib_umem *umem, u64 addr, int *count, int *shift);
836 int mlx5_ib_check_mr_status(struct ib_mr *ibmr, u32 check_mask,
837 			    struct ib_mr_status *mr_status);
838 struct ib_wq *mlx5_ib_create_wq(struct ib_pd *pd,
839 				struct ib_wq_init_attr *init_attr,
840 				struct ib_udata *udata);
841 int mlx5_ib_destroy_wq(struct ib_wq *wq);
842 int mlx5_ib_modify_wq(struct ib_wq *wq, struct ib_wq_attr *wq_attr,
843 		      u32 wq_attr_mask, struct ib_udata *udata);
844 struct ib_rwq_ind_table *mlx5_ib_create_rwq_ind_table(struct ib_device *device,
845 						      struct ib_rwq_ind_table_init_attr *init_attr,
846 						      struct ib_udata *udata);
847 int mlx5_ib_destroy_rwq_ind_table(struct ib_rwq_ind_table *wq_ind_table);
848 
849 #ifdef CONFIG_INFINIBAND_ON_DEMAND_PAGING
850 extern struct workqueue_struct *mlx5_ib_page_fault_wq;
851 
852 void mlx5_ib_internal_fill_odp_caps(struct mlx5_ib_dev *dev);
853 void mlx5_ib_mr_pfault_handler(struct mlx5_ib_qp *qp,
854 			       struct mlx5_ib_pfault *pfault);
855 void mlx5_ib_odp_create_qp(struct mlx5_ib_qp *qp);
856 int mlx5_ib_odp_init_one(struct mlx5_ib_dev *ibdev);
857 void mlx5_ib_odp_remove_one(struct mlx5_ib_dev *ibdev);
858 int __init mlx5_ib_odp_init(void);
859 void mlx5_ib_odp_cleanup(void);
860 void mlx5_ib_qp_disable_pagefaults(struct mlx5_ib_qp *qp);
861 void mlx5_ib_qp_enable_pagefaults(struct mlx5_ib_qp *qp);
862 void mlx5_ib_invalidate_range(struct ib_umem *umem, unsigned long start,
863 			      unsigned long end);
864 #else /* CONFIG_INFINIBAND_ON_DEMAND_PAGING */
865 static inline void mlx5_ib_internal_fill_odp_caps(struct mlx5_ib_dev *dev)
866 {
867 	return;
868 }
869 
870 static inline void mlx5_ib_odp_create_qp(struct mlx5_ib_qp *qp)		{}
871 static inline int mlx5_ib_odp_init_one(struct mlx5_ib_dev *ibdev) { return 0; }
872 static inline void mlx5_ib_odp_remove_one(struct mlx5_ib_dev *ibdev)	{}
873 static inline int mlx5_ib_odp_init(void) { return 0; }
874 static inline void mlx5_ib_odp_cleanup(void)				{}
875 static inline void mlx5_ib_qp_disable_pagefaults(struct mlx5_ib_qp *qp) {}
876 static inline void mlx5_ib_qp_enable_pagefaults(struct mlx5_ib_qp *qp)  {}
877 
878 #endif /* CONFIG_INFINIBAND_ON_DEMAND_PAGING */
879 
880 int mlx5_ib_get_vf_config(struct ib_device *device, int vf,
881 			  u8 port, struct ifla_vf_info *info);
882 int mlx5_ib_set_vf_link_state(struct ib_device *device, int vf,
883 			      u8 port, int state);
884 int mlx5_ib_get_vf_stats(struct ib_device *device, int vf,
885 			 u8 port, struct ifla_vf_stats *stats);
886 int mlx5_ib_set_vf_guid(struct ib_device *device, int vf, u8 port,
887 			u64 guid, int type);
888 
889 __be16 mlx5_get_roce_udp_sport(struct mlx5_ib_dev *dev, u8 port_num,
890 			       int index);
891 
892 /* GSI QP helper functions */
893 struct ib_qp *mlx5_ib_gsi_create_qp(struct ib_pd *pd,
894 				    struct ib_qp_init_attr *init_attr);
895 int mlx5_ib_gsi_destroy_qp(struct ib_qp *qp);
896 int mlx5_ib_gsi_modify_qp(struct ib_qp *qp, struct ib_qp_attr *attr,
897 			  int attr_mask);
898 int mlx5_ib_gsi_query_qp(struct ib_qp *qp, struct ib_qp_attr *qp_attr,
899 			 int qp_attr_mask,
900 			 struct ib_qp_init_attr *qp_init_attr);
901 int mlx5_ib_gsi_post_send(struct ib_qp *qp, struct ib_send_wr *wr,
902 			  struct ib_send_wr **bad_wr);
903 int mlx5_ib_gsi_post_recv(struct ib_qp *qp, struct ib_recv_wr *wr,
904 			  struct ib_recv_wr **bad_wr);
905 void mlx5_ib_gsi_pkey_change(struct mlx5_ib_gsi_qp *gsi);
906 
907 int mlx5_ib_generate_wc(struct ib_cq *ibcq, struct ib_wc *wc);
908 
909 static inline void init_query_mad(struct ib_smp *mad)
910 {
911 	mad->base_version  = 1;
912 	mad->mgmt_class    = IB_MGMT_CLASS_SUBN_LID_ROUTED;
913 	mad->class_version = 1;
914 	mad->method	   = IB_MGMT_METHOD_GET;
915 }
916 
917 static inline u8 convert_access(int acc)
918 {
919 	return (acc & IB_ACCESS_REMOTE_ATOMIC ? MLX5_PERM_ATOMIC       : 0) |
920 	       (acc & IB_ACCESS_REMOTE_WRITE  ? MLX5_PERM_REMOTE_WRITE : 0) |
921 	       (acc & IB_ACCESS_REMOTE_READ   ? MLX5_PERM_REMOTE_READ  : 0) |
922 	       (acc & IB_ACCESS_LOCAL_WRITE   ? MLX5_PERM_LOCAL_WRITE  : 0) |
923 	       MLX5_PERM_LOCAL_READ;
924 }
925 
926 static inline int is_qp1(enum ib_qp_type qp_type)
927 {
928 	return qp_type == MLX5_IB_QPT_HW_GSI;
929 }
930 
931 #define MLX5_MAX_UMR_SHIFT 16
932 #define MLX5_MAX_UMR_PAGES (1 << MLX5_MAX_UMR_SHIFT)
933 
934 static inline u32 check_cq_create_flags(u32 flags)
935 {
936 	/*
937 	 * It returns non-zero value for unsupported CQ
938 	 * create flags, otherwise it returns zero.
939 	 */
940 	return (flags & ~(IB_CQ_FLAGS_IGNORE_OVERRUN |
941 			  IB_CQ_FLAGS_TIMESTAMP_COMPLETION));
942 }
943 
944 static inline int verify_assign_uidx(u8 cqe_version, u32 cmd_uidx,
945 				     u32 *user_index)
946 {
947 	if (cqe_version) {
948 		if ((cmd_uidx == MLX5_IB_DEFAULT_UIDX) ||
949 		    (cmd_uidx & ~MLX5_USER_ASSIGNED_UIDX_MASK))
950 			return -EINVAL;
951 		*user_index = cmd_uidx;
952 	} else {
953 		*user_index = MLX5_IB_DEFAULT_UIDX;
954 	}
955 
956 	return 0;
957 }
958 
959 static inline int get_qp_user_index(struct mlx5_ib_ucontext *ucontext,
960 				    struct mlx5_ib_create_qp *ucmd,
961 				    int inlen,
962 				    u32 *user_index)
963 {
964 	u8 cqe_version = ucontext->cqe_version;
965 
966 	if (field_avail(struct mlx5_ib_create_qp, uidx, inlen) &&
967 	    !cqe_version && (ucmd->uidx == MLX5_IB_DEFAULT_UIDX))
968 		return 0;
969 
970 	if (!!(field_avail(struct mlx5_ib_create_qp, uidx, inlen) !=
971 	       !!cqe_version))
972 		return -EINVAL;
973 
974 	return verify_assign_uidx(cqe_version, ucmd->uidx, user_index);
975 }
976 
977 static inline int get_srq_user_index(struct mlx5_ib_ucontext *ucontext,
978 				     struct mlx5_ib_create_srq *ucmd,
979 				     int inlen,
980 				     u32 *user_index)
981 {
982 	u8 cqe_version = ucontext->cqe_version;
983 
984 	if (field_avail(struct mlx5_ib_create_srq, uidx, inlen) &&
985 	    !cqe_version && (ucmd->uidx == MLX5_IB_DEFAULT_UIDX))
986 		return 0;
987 
988 	if (!!(field_avail(struct mlx5_ib_create_srq, uidx, inlen) !=
989 	       !!cqe_version))
990 		return -EINVAL;
991 
992 	return verify_assign_uidx(cqe_version, ucmd->uidx, user_index);
993 }
994 #endif /* MLX5_IB_H */
995