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