1 /*
2  * Copyright (c) 2006, 2007 Cisco Systems.  All rights reserved.
3  * Copyright (c) 2007, 2008 Mellanox Technologies. All rights reserved.
4  *
5  * This software is available to you under a choice of one of two
6  * licenses.  You may choose to be licensed under the terms of the GNU
7  * General Public License (GPL) Version 2, available from the file
8  * COPYING in the main directory of this source tree, or the
9  * OpenIB.org BSD license below:
10  *
11  *     Redistribution and use in source and binary forms, with or
12  *     without modification, are permitted provided that the following
13  *     conditions are met:
14  *
15  *      - Redistributions of source code must retain the above
16  *        copyright notice, this list of conditions and the following
17  *        disclaimer.
18  *
19  *      - Redistributions in binary form must reproduce the above
20  *        copyright notice, this list of conditions and the following
21  *        disclaimer in the documentation and/or other materials
22  *        provided with the distribution.
23  *
24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31  * SOFTWARE.
32  */
33 
34 #ifndef MLX4_IB_H
35 #define MLX4_IB_H
36 
37 #include <linux/compiler.h>
38 #include <linux/list.h>
39 #include <linux/mutex.h>
40 
41 #include <rdma/ib_verbs.h>
42 #include <rdma/ib_umem.h>
43 
44 #include <linux/mlx4/device.h>
45 #include <linux/mlx4/doorbell.h>
46 
47 struct mlx4_ib_ucontext {
48 	struct ib_ucontext	ibucontext;
49 	struct mlx4_uar		uar;
50 	struct list_head	db_page_list;
51 	struct mutex		db_page_mutex;
52 };
53 
54 struct mlx4_ib_pd {
55 	struct ib_pd		ibpd;
56 	u32			pdn;
57 };
58 
59 struct mlx4_ib_xrcd {
60 	struct ib_xrcd		ibxrcd;
61 	u32			xrcdn;
62 	struct ib_pd	       *pd;
63 	struct ib_cq	       *cq;
64 };
65 
66 struct mlx4_ib_cq_buf {
67 	struct mlx4_buf		buf;
68 	struct mlx4_mtt		mtt;
69 };
70 
71 struct mlx4_ib_cq_resize {
72 	struct mlx4_ib_cq_buf	buf;
73 	int			cqe;
74 };
75 
76 struct mlx4_ib_cq {
77 	struct ib_cq		ibcq;
78 	struct mlx4_cq		mcq;
79 	struct mlx4_ib_cq_buf	buf;
80 	struct mlx4_ib_cq_resize *resize_buf;
81 	struct mlx4_db		db;
82 	spinlock_t		lock;
83 	struct mutex		resize_mutex;
84 	struct ib_umem	       *umem;
85 	struct ib_umem	       *resize_umem;
86 };
87 
88 struct mlx4_ib_mr {
89 	struct ib_mr		ibmr;
90 	struct mlx4_mr		mmr;
91 	struct ib_umem	       *umem;
92 };
93 
94 struct mlx4_ib_fast_reg_page_list {
95 	struct ib_fast_reg_page_list	ibfrpl;
96 	__be64			       *mapped_page_list;
97 	dma_addr_t			map;
98 };
99 
100 struct mlx4_ib_fmr {
101 	struct ib_fmr           ibfmr;
102 	struct mlx4_fmr         mfmr;
103 };
104 
105 struct mlx4_ib_wq {
106 	u64		       *wrid;
107 	spinlock_t		lock;
108 	int			wqe_cnt;
109 	int			max_post;
110 	int			max_gs;
111 	int			offset;
112 	int			wqe_shift;
113 	unsigned		head;
114 	unsigned		tail;
115 };
116 
117 enum mlx4_ib_qp_flags {
118 	MLX4_IB_QP_LSO				= 1 << 0,
119 	MLX4_IB_QP_BLOCK_MULTICAST_LOOPBACK	= 1 << 1,
120 };
121 
122 struct mlx4_ib_gid_entry {
123 	struct list_head	list;
124 	union ib_gid		gid;
125 	int			added;
126 	u8			port;
127 };
128 
129 struct mlx4_ib_qp {
130 	struct ib_qp		ibqp;
131 	struct mlx4_qp		mqp;
132 	struct mlx4_buf		buf;
133 
134 	struct mlx4_db		db;
135 	struct mlx4_ib_wq	rq;
136 
137 	u32			doorbell_qpn;
138 	__be32			sq_signal_bits;
139 	unsigned		sq_next_wqe;
140 	int			sq_max_wqes_per_wr;
141 	int			sq_spare_wqes;
142 	struct mlx4_ib_wq	sq;
143 
144 	struct ib_umem	       *umem;
145 	struct mlx4_mtt		mtt;
146 	int			buf_size;
147 	struct mutex		mutex;
148 	u16			xrcdn;
149 	u32			flags;
150 	u8			port;
151 	u8			alt_port;
152 	u8			atomic_rd_en;
153 	u8			resp_depth;
154 	u8			sq_no_prefetch;
155 	u8			state;
156 	int			mlx_type;
157 	struct list_head	gid_list;
158 };
159 
160 struct mlx4_ib_srq {
161 	struct ib_srq		ibsrq;
162 	struct mlx4_srq		msrq;
163 	struct mlx4_buf		buf;
164 	struct mlx4_db		db;
165 	u64		       *wrid;
166 	spinlock_t		lock;
167 	int			head;
168 	int			tail;
169 	u16			wqe_ctr;
170 	struct ib_umem	       *umem;
171 	struct mlx4_mtt		mtt;
172 	struct mutex		mutex;
173 };
174 
175 struct mlx4_ib_ah {
176 	struct ib_ah		ibah;
177 	union mlx4_ext_av       av;
178 };
179 
180 struct mlx4_ib_iboe {
181 	spinlock_t		lock;
182 	struct net_device      *netdevs[MLX4_MAX_PORTS];
183 	struct notifier_block 	nb;
184 	union ib_gid		gid_table[MLX4_MAX_PORTS][128];
185 };
186 
187 struct mlx4_ib_dev {
188 	struct ib_device	ib_dev;
189 	struct mlx4_dev	       *dev;
190 	int			num_ports;
191 	void __iomem	       *uar_map;
192 
193 	struct mlx4_uar		priv_uar;
194 	u32			priv_pdn;
195 	MLX4_DECLARE_DOORBELL_LOCK(uar_lock);
196 
197 	struct ib_mad_agent    *send_agent[MLX4_MAX_PORTS][2];
198 	struct ib_ah	       *sm_ah[MLX4_MAX_PORTS];
199 	spinlock_t		sm_lock;
200 
201 	struct mutex		cap_mask_mutex;
202 	bool			ib_active;
203 	struct mlx4_ib_iboe	iboe;
204 	int			counters[MLX4_MAX_PORTS];
205 };
206 
to_mdev(struct ib_device * ibdev)207 static inline struct mlx4_ib_dev *to_mdev(struct ib_device *ibdev)
208 {
209 	return container_of(ibdev, struct mlx4_ib_dev, ib_dev);
210 }
211 
to_mucontext(struct ib_ucontext * ibucontext)212 static inline struct mlx4_ib_ucontext *to_mucontext(struct ib_ucontext *ibucontext)
213 {
214 	return container_of(ibucontext, struct mlx4_ib_ucontext, ibucontext);
215 }
216 
to_mpd(struct ib_pd * ibpd)217 static inline struct mlx4_ib_pd *to_mpd(struct ib_pd *ibpd)
218 {
219 	return container_of(ibpd, struct mlx4_ib_pd, ibpd);
220 }
221 
to_mxrcd(struct ib_xrcd * ibxrcd)222 static inline struct mlx4_ib_xrcd *to_mxrcd(struct ib_xrcd *ibxrcd)
223 {
224 	return container_of(ibxrcd, struct mlx4_ib_xrcd, ibxrcd);
225 }
226 
to_mcq(struct ib_cq * ibcq)227 static inline struct mlx4_ib_cq *to_mcq(struct ib_cq *ibcq)
228 {
229 	return container_of(ibcq, struct mlx4_ib_cq, ibcq);
230 }
231 
to_mibcq(struct mlx4_cq * mcq)232 static inline struct mlx4_ib_cq *to_mibcq(struct mlx4_cq *mcq)
233 {
234 	return container_of(mcq, struct mlx4_ib_cq, mcq);
235 }
236 
to_mmr(struct ib_mr * ibmr)237 static inline struct mlx4_ib_mr *to_mmr(struct ib_mr *ibmr)
238 {
239 	return container_of(ibmr, struct mlx4_ib_mr, ibmr);
240 }
241 
to_mfrpl(struct ib_fast_reg_page_list * ibfrpl)242 static inline struct mlx4_ib_fast_reg_page_list *to_mfrpl(struct ib_fast_reg_page_list *ibfrpl)
243 {
244 	return container_of(ibfrpl, struct mlx4_ib_fast_reg_page_list, ibfrpl);
245 }
246 
to_mfmr(struct ib_fmr * ibfmr)247 static inline struct mlx4_ib_fmr *to_mfmr(struct ib_fmr *ibfmr)
248 {
249 	return container_of(ibfmr, struct mlx4_ib_fmr, ibfmr);
250 }
to_mqp(struct ib_qp * ibqp)251 static inline struct mlx4_ib_qp *to_mqp(struct ib_qp *ibqp)
252 {
253 	return container_of(ibqp, struct mlx4_ib_qp, ibqp);
254 }
255 
to_mibqp(struct mlx4_qp * mqp)256 static inline struct mlx4_ib_qp *to_mibqp(struct mlx4_qp *mqp)
257 {
258 	return container_of(mqp, struct mlx4_ib_qp, mqp);
259 }
260 
to_msrq(struct ib_srq * ibsrq)261 static inline struct mlx4_ib_srq *to_msrq(struct ib_srq *ibsrq)
262 {
263 	return container_of(ibsrq, struct mlx4_ib_srq, ibsrq);
264 }
265 
to_mibsrq(struct mlx4_srq * msrq)266 static inline struct mlx4_ib_srq *to_mibsrq(struct mlx4_srq *msrq)
267 {
268 	return container_of(msrq, struct mlx4_ib_srq, msrq);
269 }
270 
to_mah(struct ib_ah * ibah)271 static inline struct mlx4_ib_ah *to_mah(struct ib_ah *ibah)
272 {
273 	return container_of(ibah, struct mlx4_ib_ah, ibah);
274 }
275 
276 int mlx4_ib_db_map_user(struct mlx4_ib_ucontext *context, unsigned long virt,
277 			struct mlx4_db *db);
278 void mlx4_ib_db_unmap_user(struct mlx4_ib_ucontext *context, struct mlx4_db *db);
279 
280 struct ib_mr *mlx4_ib_get_dma_mr(struct ib_pd *pd, int acc);
281 int mlx4_ib_umem_write_mtt(struct mlx4_ib_dev *dev, struct mlx4_mtt *mtt,
282 			   struct ib_umem *umem);
283 struct ib_mr *mlx4_ib_reg_user_mr(struct ib_pd *pd, u64 start, u64 length,
284 				  u64 virt_addr, int access_flags,
285 				  struct ib_udata *udata);
286 int mlx4_ib_dereg_mr(struct ib_mr *mr);
287 struct ib_mr *mlx4_ib_alloc_fast_reg_mr(struct ib_pd *pd,
288 					int max_page_list_len);
289 struct ib_fast_reg_page_list *mlx4_ib_alloc_fast_reg_page_list(struct ib_device *ibdev,
290 							       int page_list_len);
291 void mlx4_ib_free_fast_reg_page_list(struct ib_fast_reg_page_list *page_list);
292 
293 int mlx4_ib_modify_cq(struct ib_cq *cq, u16 cq_count, u16 cq_period);
294 int mlx4_ib_resize_cq(struct ib_cq *ibcq, int entries, struct ib_udata *udata);
295 struct ib_cq *mlx4_ib_create_cq(struct ib_device *ibdev, int entries, int vector,
296 				struct ib_ucontext *context,
297 				struct ib_udata *udata);
298 int mlx4_ib_destroy_cq(struct ib_cq *cq);
299 int mlx4_ib_poll_cq(struct ib_cq *ibcq, int num_entries, struct ib_wc *wc);
300 int mlx4_ib_arm_cq(struct ib_cq *cq, enum ib_cq_notify_flags flags);
301 void __mlx4_ib_cq_clean(struct mlx4_ib_cq *cq, u32 qpn, struct mlx4_ib_srq *srq);
302 void mlx4_ib_cq_clean(struct mlx4_ib_cq *cq, u32 qpn, struct mlx4_ib_srq *srq);
303 
304 struct ib_ah *mlx4_ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
305 int mlx4_ib_query_ah(struct ib_ah *ibah, struct ib_ah_attr *ah_attr);
306 int mlx4_ib_destroy_ah(struct ib_ah *ah);
307 
308 struct ib_srq *mlx4_ib_create_srq(struct ib_pd *pd,
309 				  struct ib_srq_init_attr *init_attr,
310 				  struct ib_udata *udata);
311 int mlx4_ib_modify_srq(struct ib_srq *ibsrq, struct ib_srq_attr *attr,
312 		       enum ib_srq_attr_mask attr_mask, struct ib_udata *udata);
313 int mlx4_ib_query_srq(struct ib_srq *srq, struct ib_srq_attr *srq_attr);
314 int mlx4_ib_destroy_srq(struct ib_srq *srq);
315 void mlx4_ib_free_srq_wqe(struct mlx4_ib_srq *srq, int wqe_index);
316 int mlx4_ib_post_srq_recv(struct ib_srq *ibsrq, struct ib_recv_wr *wr,
317 			  struct ib_recv_wr **bad_wr);
318 
319 struct ib_qp *mlx4_ib_create_qp(struct ib_pd *pd,
320 				struct ib_qp_init_attr *init_attr,
321 				struct ib_udata *udata);
322 int mlx4_ib_destroy_qp(struct ib_qp *qp);
323 int mlx4_ib_modify_qp(struct ib_qp *ibqp, struct ib_qp_attr *attr,
324 		      int attr_mask, struct ib_udata *udata);
325 int mlx4_ib_query_qp(struct ib_qp *ibqp, struct ib_qp_attr *qp_attr, int qp_attr_mask,
326 		     struct ib_qp_init_attr *qp_init_attr);
327 int mlx4_ib_post_send(struct ib_qp *ibqp, struct ib_send_wr *wr,
328 		      struct ib_send_wr **bad_wr);
329 int mlx4_ib_post_recv(struct ib_qp *ibqp, struct ib_recv_wr *wr,
330 		      struct ib_recv_wr **bad_wr);
331 
332 int mlx4_MAD_IFC(struct mlx4_ib_dev *dev, int ignore_mkey, int ignore_bkey,
333 		 int port, struct ib_wc *in_wc, struct ib_grh *in_grh,
334 		 void *in_mad, void *response_mad);
335 int mlx4_ib_process_mad(struct ib_device *ibdev, int mad_flags,	u8 port_num,
336 			struct ib_wc *in_wc, struct ib_grh *in_grh,
337 			struct ib_mad *in_mad, struct ib_mad *out_mad);
338 int mlx4_ib_mad_init(struct mlx4_ib_dev *dev);
339 void mlx4_ib_mad_cleanup(struct mlx4_ib_dev *dev);
340 
341 struct ib_fmr *mlx4_ib_fmr_alloc(struct ib_pd *pd, int mr_access_flags,
342 				  struct ib_fmr_attr *fmr_attr);
343 int mlx4_ib_map_phys_fmr(struct ib_fmr *ibfmr, u64 *page_list, int npages,
344 			 u64 iova);
345 int mlx4_ib_unmap_fmr(struct list_head *fmr_list);
346 int mlx4_ib_fmr_dealloc(struct ib_fmr *fmr);
347 
348 int mlx4_ib_resolve_grh(struct mlx4_ib_dev *dev, const struct ib_ah_attr *ah_attr,
349 			u8 *mac, int *is_mcast, u8 port);
350 
mlx4_ib_ah_grh_present(struct mlx4_ib_ah * ah)351 static inline int mlx4_ib_ah_grh_present(struct mlx4_ib_ah *ah)
352 {
353 	u8 port = be32_to_cpu(ah->av.ib.port_pd) >> 24 & 3;
354 
355 	if (rdma_port_get_link_layer(ah->ibah.device, port) == IB_LINK_LAYER_ETHERNET)
356 		return 1;
357 
358 	return !!(ah->av.ib.g_slid & 0x80);
359 }
360 
361 int mlx4_ib_add_mc(struct mlx4_ib_dev *mdev, struct mlx4_ib_qp *mqp,
362 		   union ib_gid *gid);
363 
364 #endif /* MLX4_IB_H */
365