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_cq_buf {
60 	struct mlx4_buf		buf;
61 	struct mlx4_mtt		mtt;
62 };
63 
64 struct mlx4_ib_cq_resize {
65 	struct mlx4_ib_cq_buf	buf;
66 	int			cqe;
67 };
68 
69 struct mlx4_ib_cq {
70 	struct ib_cq		ibcq;
71 	struct mlx4_cq		mcq;
72 	struct mlx4_ib_cq_buf	buf;
73 	struct mlx4_ib_cq_resize *resize_buf;
74 	struct mlx4_db		db;
75 	spinlock_t		lock;
76 	struct mutex		resize_mutex;
77 	struct ib_umem	       *umem;
78 	struct ib_umem	       *resize_umem;
79 };
80 
81 struct mlx4_ib_mr {
82 	struct ib_mr		ibmr;
83 	struct mlx4_mr		mmr;
84 	struct ib_umem	       *umem;
85 };
86 
87 struct mlx4_ib_fast_reg_page_list {
88 	struct ib_fast_reg_page_list	ibfrpl;
89 	__be64			       *mapped_page_list;
90 	dma_addr_t			map;
91 };
92 
93 struct mlx4_ib_fmr {
94 	struct ib_fmr           ibfmr;
95 	struct mlx4_fmr         mfmr;
96 };
97 
98 struct mlx4_ib_wq {
99 	u64		       *wrid;
100 	spinlock_t		lock;
101 	int			wqe_cnt;
102 	int			max_post;
103 	int			max_gs;
104 	int			offset;
105 	int			wqe_shift;
106 	unsigned		head;
107 	unsigned		tail;
108 };
109 
110 enum mlx4_ib_qp_flags {
111 	MLX4_IB_QP_LSO				= 1 << 0,
112 	MLX4_IB_QP_BLOCK_MULTICAST_LOOPBACK	= 1 << 1,
113 };
114 
115 struct mlx4_ib_gid_entry {
116 	struct list_head	list;
117 	union ib_gid		gid;
118 	int			added;
119 	u8			port;
120 };
121 
122 struct mlx4_ib_qp {
123 	struct ib_qp		ibqp;
124 	struct mlx4_qp		mqp;
125 	struct mlx4_buf		buf;
126 
127 	struct mlx4_db		db;
128 	struct mlx4_ib_wq	rq;
129 
130 	u32			doorbell_qpn;
131 	__be32			sq_signal_bits;
132 	unsigned		sq_next_wqe;
133 	int			sq_max_wqes_per_wr;
134 	int			sq_spare_wqes;
135 	struct mlx4_ib_wq	sq;
136 
137 	struct ib_umem	       *umem;
138 	struct mlx4_mtt		mtt;
139 	int			buf_size;
140 	struct mutex		mutex;
141 	u32			flags;
142 	u8			port;
143 	u8			alt_port;
144 	u8			atomic_rd_en;
145 	u8			resp_depth;
146 	u8			sq_no_prefetch;
147 	u8			state;
148 	int			mlx_type;
149 	struct list_head	gid_list;
150 };
151 
152 struct mlx4_ib_srq {
153 	struct ib_srq		ibsrq;
154 	struct mlx4_srq		msrq;
155 	struct mlx4_buf		buf;
156 	struct mlx4_db		db;
157 	u64		       *wrid;
158 	spinlock_t		lock;
159 	int			head;
160 	int			tail;
161 	u16			wqe_ctr;
162 	struct ib_umem	       *umem;
163 	struct mlx4_mtt		mtt;
164 	struct mutex		mutex;
165 };
166 
167 struct mlx4_ib_ah {
168 	struct ib_ah		ibah;
169 	union mlx4_ext_av       av;
170 };
171 
172 struct mlx4_ib_iboe {
173 	spinlock_t		lock;
174 	struct net_device      *netdevs[MLX4_MAX_PORTS];
175 	struct notifier_block 	nb;
176 	union ib_gid		gid_table[MLX4_MAX_PORTS][128];
177 };
178 
179 struct mlx4_ib_dev {
180 	struct ib_device	ib_dev;
181 	struct mlx4_dev	       *dev;
182 	int			num_ports;
183 	void __iomem	       *uar_map;
184 
185 	struct mlx4_uar		priv_uar;
186 	u32			priv_pdn;
187 	MLX4_DECLARE_DOORBELL_LOCK(uar_lock);
188 
189 	struct ib_mad_agent    *send_agent[MLX4_MAX_PORTS][2];
190 	struct ib_ah	       *sm_ah[MLX4_MAX_PORTS];
191 	spinlock_t		sm_lock;
192 
193 	struct mutex		cap_mask_mutex;
194 	bool			ib_active;
195 	struct mlx4_ib_iboe	iboe;
196 };
197 
198 static inline struct mlx4_ib_dev *to_mdev(struct ib_device *ibdev)
199 {
200 	return container_of(ibdev, struct mlx4_ib_dev, ib_dev);
201 }
202 
203 static inline struct mlx4_ib_ucontext *to_mucontext(struct ib_ucontext *ibucontext)
204 {
205 	return container_of(ibucontext, struct mlx4_ib_ucontext, ibucontext);
206 }
207 
208 static inline struct mlx4_ib_pd *to_mpd(struct ib_pd *ibpd)
209 {
210 	return container_of(ibpd, struct mlx4_ib_pd, ibpd);
211 }
212 
213 static inline struct mlx4_ib_cq *to_mcq(struct ib_cq *ibcq)
214 {
215 	return container_of(ibcq, struct mlx4_ib_cq, ibcq);
216 }
217 
218 static inline struct mlx4_ib_cq *to_mibcq(struct mlx4_cq *mcq)
219 {
220 	return container_of(mcq, struct mlx4_ib_cq, mcq);
221 }
222 
223 static inline struct mlx4_ib_mr *to_mmr(struct ib_mr *ibmr)
224 {
225 	return container_of(ibmr, struct mlx4_ib_mr, ibmr);
226 }
227 
228 static inline struct mlx4_ib_fast_reg_page_list *to_mfrpl(struct ib_fast_reg_page_list *ibfrpl)
229 {
230 	return container_of(ibfrpl, struct mlx4_ib_fast_reg_page_list, ibfrpl);
231 }
232 
233 static inline struct mlx4_ib_fmr *to_mfmr(struct ib_fmr *ibfmr)
234 {
235 	return container_of(ibfmr, struct mlx4_ib_fmr, ibfmr);
236 }
237 static inline struct mlx4_ib_qp *to_mqp(struct ib_qp *ibqp)
238 {
239 	return container_of(ibqp, struct mlx4_ib_qp, ibqp);
240 }
241 
242 static inline struct mlx4_ib_qp *to_mibqp(struct mlx4_qp *mqp)
243 {
244 	return container_of(mqp, struct mlx4_ib_qp, mqp);
245 }
246 
247 static inline struct mlx4_ib_srq *to_msrq(struct ib_srq *ibsrq)
248 {
249 	return container_of(ibsrq, struct mlx4_ib_srq, ibsrq);
250 }
251 
252 static inline struct mlx4_ib_srq *to_mibsrq(struct mlx4_srq *msrq)
253 {
254 	return container_of(msrq, struct mlx4_ib_srq, msrq);
255 }
256 
257 static inline struct mlx4_ib_ah *to_mah(struct ib_ah *ibah)
258 {
259 	return container_of(ibah, struct mlx4_ib_ah, ibah);
260 }
261 
262 int mlx4_ib_db_map_user(struct mlx4_ib_ucontext *context, unsigned long virt,
263 			struct mlx4_db *db);
264 void mlx4_ib_db_unmap_user(struct mlx4_ib_ucontext *context, struct mlx4_db *db);
265 
266 struct ib_mr *mlx4_ib_get_dma_mr(struct ib_pd *pd, int acc);
267 int mlx4_ib_umem_write_mtt(struct mlx4_ib_dev *dev, struct mlx4_mtt *mtt,
268 			   struct ib_umem *umem);
269 struct ib_mr *mlx4_ib_reg_user_mr(struct ib_pd *pd, u64 start, u64 length,
270 				  u64 virt_addr, int access_flags,
271 				  struct ib_udata *udata);
272 int mlx4_ib_dereg_mr(struct ib_mr *mr);
273 struct ib_mr *mlx4_ib_alloc_fast_reg_mr(struct ib_pd *pd,
274 					int max_page_list_len);
275 struct ib_fast_reg_page_list *mlx4_ib_alloc_fast_reg_page_list(struct ib_device *ibdev,
276 							       int page_list_len);
277 void mlx4_ib_free_fast_reg_page_list(struct ib_fast_reg_page_list *page_list);
278 
279 int mlx4_ib_modify_cq(struct ib_cq *cq, u16 cq_count, u16 cq_period);
280 int mlx4_ib_resize_cq(struct ib_cq *ibcq, int entries, struct ib_udata *udata);
281 struct ib_cq *mlx4_ib_create_cq(struct ib_device *ibdev, int entries, int vector,
282 				struct ib_ucontext *context,
283 				struct ib_udata *udata);
284 int mlx4_ib_destroy_cq(struct ib_cq *cq);
285 int mlx4_ib_poll_cq(struct ib_cq *ibcq, int num_entries, struct ib_wc *wc);
286 int mlx4_ib_arm_cq(struct ib_cq *cq, enum ib_cq_notify_flags flags);
287 void __mlx4_ib_cq_clean(struct mlx4_ib_cq *cq, u32 qpn, struct mlx4_ib_srq *srq);
288 void mlx4_ib_cq_clean(struct mlx4_ib_cq *cq, u32 qpn, struct mlx4_ib_srq *srq);
289 
290 struct ib_ah *mlx4_ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
291 int mlx4_ib_query_ah(struct ib_ah *ibah, struct ib_ah_attr *ah_attr);
292 int mlx4_ib_destroy_ah(struct ib_ah *ah);
293 
294 struct ib_srq *mlx4_ib_create_srq(struct ib_pd *pd,
295 				  struct ib_srq_init_attr *init_attr,
296 				  struct ib_udata *udata);
297 int mlx4_ib_modify_srq(struct ib_srq *ibsrq, struct ib_srq_attr *attr,
298 		       enum ib_srq_attr_mask attr_mask, struct ib_udata *udata);
299 int mlx4_ib_query_srq(struct ib_srq *srq, struct ib_srq_attr *srq_attr);
300 int mlx4_ib_destroy_srq(struct ib_srq *srq);
301 void mlx4_ib_free_srq_wqe(struct mlx4_ib_srq *srq, int wqe_index);
302 int mlx4_ib_post_srq_recv(struct ib_srq *ibsrq, struct ib_recv_wr *wr,
303 			  struct ib_recv_wr **bad_wr);
304 
305 struct ib_qp *mlx4_ib_create_qp(struct ib_pd *pd,
306 				struct ib_qp_init_attr *init_attr,
307 				struct ib_udata *udata);
308 int mlx4_ib_destroy_qp(struct ib_qp *qp);
309 int mlx4_ib_modify_qp(struct ib_qp *ibqp, struct ib_qp_attr *attr,
310 		      int attr_mask, struct ib_udata *udata);
311 int mlx4_ib_query_qp(struct ib_qp *ibqp, struct ib_qp_attr *qp_attr, int qp_attr_mask,
312 		     struct ib_qp_init_attr *qp_init_attr);
313 int mlx4_ib_post_send(struct ib_qp *ibqp, struct ib_send_wr *wr,
314 		      struct ib_send_wr **bad_wr);
315 int mlx4_ib_post_recv(struct ib_qp *ibqp, struct ib_recv_wr *wr,
316 		      struct ib_recv_wr **bad_wr);
317 
318 int mlx4_MAD_IFC(struct mlx4_ib_dev *dev, int ignore_mkey, int ignore_bkey,
319 		 int port, struct ib_wc *in_wc, struct ib_grh *in_grh,
320 		 void *in_mad, void *response_mad);
321 int mlx4_ib_process_mad(struct ib_device *ibdev, int mad_flags,	u8 port_num,
322 			struct ib_wc *in_wc, struct ib_grh *in_grh,
323 			struct ib_mad *in_mad, struct ib_mad *out_mad);
324 int mlx4_ib_mad_init(struct mlx4_ib_dev *dev);
325 void mlx4_ib_mad_cleanup(struct mlx4_ib_dev *dev);
326 
327 struct ib_fmr *mlx4_ib_fmr_alloc(struct ib_pd *pd, int mr_access_flags,
328 				  struct ib_fmr_attr *fmr_attr);
329 int mlx4_ib_map_phys_fmr(struct ib_fmr *ibfmr, u64 *page_list, int npages,
330 			 u64 iova);
331 int mlx4_ib_unmap_fmr(struct list_head *fmr_list);
332 int mlx4_ib_fmr_dealloc(struct ib_fmr *fmr);
333 
334 int mlx4_ib_resolve_grh(struct mlx4_ib_dev *dev, const struct ib_ah_attr *ah_attr,
335 			u8 *mac, int *is_mcast, u8 port);
336 
337 static inline int mlx4_ib_ah_grh_present(struct mlx4_ib_ah *ah)
338 {
339 	u8 port = be32_to_cpu(ah->av.ib.port_pd) >> 24 & 3;
340 
341 	if (rdma_port_get_link_layer(ah->ibah.device, port) == IB_LINK_LAYER_ETHERNET)
342 		return 1;
343 
344 	return !!(ah->av.ib.g_slid & 0x80);
345 }
346 
347 int mlx4_ib_add_mc(struct mlx4_ib_dev *mdev, struct mlx4_ib_qp *mqp,
348 		   union ib_gid *gid);
349 
350 #endif /* MLX4_IB_H */
351