xref: /linux/drivers/infiniband/hw/mlx4/mlx4_ib.h (revision 2b8232ce512105e28453f301d1510de8363bccd1)
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 enum {
47 	MLX4_IB_DB_PER_PAGE	= PAGE_SIZE / 4
48 };
49 
50 struct mlx4_ib_db_pgdir;
51 struct mlx4_ib_user_db_page;
52 
53 struct mlx4_ib_db {
54 	__be32		       *db;
55 	union {
56 		struct mlx4_ib_db_pgdir	       *pgdir;
57 		struct mlx4_ib_user_db_page    *user_page;
58 	}			u;
59 	dma_addr_t		dma;
60 	int			index;
61 	int			order;
62 };
63 
64 struct mlx4_ib_ucontext {
65 	struct ib_ucontext	ibucontext;
66 	struct mlx4_uar		uar;
67 	struct list_head	db_page_list;
68 	struct mutex		db_page_mutex;
69 };
70 
71 struct mlx4_ib_pd {
72 	struct ib_pd		ibpd;
73 	u32			pdn;
74 };
75 
76 struct mlx4_ib_cq_buf {
77 	struct mlx4_buf		buf;
78 	struct mlx4_mtt		mtt;
79 };
80 
81 struct mlx4_ib_cq {
82 	struct ib_cq		ibcq;
83 	struct mlx4_cq		mcq;
84 	struct mlx4_ib_cq_buf	buf;
85 	struct mlx4_ib_db	db;
86 	spinlock_t		lock;
87 	struct ib_umem	       *umem;
88 };
89 
90 struct mlx4_ib_mr {
91 	struct ib_mr		ibmr;
92 	struct mlx4_mr		mmr;
93 	struct ib_umem	       *umem;
94 };
95 
96 struct mlx4_ib_fmr {
97 	struct ib_fmr           ibfmr;
98 	struct mlx4_fmr         mfmr;
99 };
100 
101 struct mlx4_ib_wq {
102 	u64		       *wrid;
103 	spinlock_t		lock;
104 	int			wqe_cnt;
105 	int			max_post;
106 	int			max_gs;
107 	int			offset;
108 	int			wqe_shift;
109 	unsigned		head;
110 	unsigned		tail;
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_ib_db	db;
119 	struct mlx4_ib_wq	rq;
120 
121 	u32			doorbell_qpn;
122 	__be32			sq_signal_bits;
123 	int			sq_spare_wqes;
124 	struct mlx4_ib_wq	sq;
125 
126 	struct ib_umem	       *umem;
127 	struct mlx4_mtt		mtt;
128 	int			buf_size;
129 	struct mutex		mutex;
130 	u8			port;
131 	u8			alt_port;
132 	u8			atomic_rd_en;
133 	u8			resp_depth;
134 	u8			sq_no_prefetch;
135 	u8			state;
136 };
137 
138 struct mlx4_ib_srq {
139 	struct ib_srq		ibsrq;
140 	struct mlx4_srq		msrq;
141 	struct mlx4_buf		buf;
142 	struct mlx4_ib_db	db;
143 	u64		       *wrid;
144 	spinlock_t		lock;
145 	int			head;
146 	int			tail;
147 	u16			wqe_ctr;
148 	struct ib_umem	       *umem;
149 	struct mlx4_mtt		mtt;
150 	struct mutex		mutex;
151 };
152 
153 struct mlx4_ib_ah {
154 	struct ib_ah		ibah;
155 	struct mlx4_av		av;
156 };
157 
158 struct mlx4_ib_dev {
159 	struct ib_device	ib_dev;
160 	struct mlx4_dev	       *dev;
161 	void __iomem	       *uar_map;
162 
163 	struct list_head	pgdir_list;
164 	struct mutex		pgdir_mutex;
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_fmr *to_mfmr(struct ib_fmr *ibfmr)
208 {
209 	return container_of(ibfmr, struct mlx4_ib_fmr, ibfmr);
210 }
211 static inline struct mlx4_ib_qp *to_mqp(struct ib_qp *ibqp)
212 {
213 	return container_of(ibqp, struct mlx4_ib_qp, ibqp);
214 }
215 
216 static inline struct mlx4_ib_qp *to_mibqp(struct mlx4_qp *mqp)
217 {
218 	return container_of(mqp, struct mlx4_ib_qp, mqp);
219 }
220 
221 static inline struct mlx4_ib_srq *to_msrq(struct ib_srq *ibsrq)
222 {
223 	return container_of(ibsrq, struct mlx4_ib_srq, ibsrq);
224 }
225 
226 static inline struct mlx4_ib_srq *to_mibsrq(struct mlx4_srq *msrq)
227 {
228 	return container_of(msrq, struct mlx4_ib_srq, msrq);
229 }
230 
231 static inline struct mlx4_ib_ah *to_mah(struct ib_ah *ibah)
232 {
233 	return container_of(ibah, struct mlx4_ib_ah, ibah);
234 }
235 
236 int mlx4_ib_db_alloc(struct mlx4_ib_dev *dev, struct mlx4_ib_db *db, int order);
237 void mlx4_ib_db_free(struct mlx4_ib_dev *dev, struct mlx4_ib_db *db);
238 int mlx4_ib_db_map_user(struct mlx4_ib_ucontext *context, unsigned long virt,
239 			struct mlx4_ib_db *db);
240 void mlx4_ib_db_unmap_user(struct mlx4_ib_ucontext *context, struct mlx4_ib_db *db);
241 
242 struct ib_mr *mlx4_ib_get_dma_mr(struct ib_pd *pd, int acc);
243 int mlx4_ib_umem_write_mtt(struct mlx4_ib_dev *dev, struct mlx4_mtt *mtt,
244 			   struct ib_umem *umem);
245 struct ib_mr *mlx4_ib_reg_user_mr(struct ib_pd *pd, u64 start, u64 length,
246 				  u64 virt_addr, int access_flags,
247 				  struct ib_udata *udata);
248 int mlx4_ib_dereg_mr(struct ib_mr *mr);
249 
250 struct ib_cq *mlx4_ib_create_cq(struct ib_device *ibdev, int entries, int vector,
251 				struct ib_ucontext *context,
252 				struct ib_udata *udata);
253 int mlx4_ib_destroy_cq(struct ib_cq *cq);
254 int mlx4_ib_poll_cq(struct ib_cq *ibcq, int num_entries, struct ib_wc *wc);
255 int mlx4_ib_arm_cq(struct ib_cq *cq, enum ib_cq_notify_flags flags);
256 void __mlx4_ib_cq_clean(struct mlx4_ib_cq *cq, u32 qpn, struct mlx4_ib_srq *srq);
257 void mlx4_ib_cq_clean(struct mlx4_ib_cq *cq, u32 qpn, struct mlx4_ib_srq *srq);
258 
259 struct ib_ah *mlx4_ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
260 int mlx4_ib_query_ah(struct ib_ah *ibah, struct ib_ah_attr *ah_attr);
261 int mlx4_ib_destroy_ah(struct ib_ah *ah);
262 
263 struct ib_srq *mlx4_ib_create_srq(struct ib_pd *pd,
264 				  struct ib_srq_init_attr *init_attr,
265 				  struct ib_udata *udata);
266 int mlx4_ib_modify_srq(struct ib_srq *ibsrq, struct ib_srq_attr *attr,
267 		       enum ib_srq_attr_mask attr_mask, struct ib_udata *udata);
268 int mlx4_ib_query_srq(struct ib_srq *srq, struct ib_srq_attr *srq_attr);
269 int mlx4_ib_destroy_srq(struct ib_srq *srq);
270 void mlx4_ib_free_srq_wqe(struct mlx4_ib_srq *srq, int wqe_index);
271 int mlx4_ib_post_srq_recv(struct ib_srq *ibsrq, struct ib_recv_wr *wr,
272 			  struct ib_recv_wr **bad_wr);
273 
274 struct ib_qp *mlx4_ib_create_qp(struct ib_pd *pd,
275 				struct ib_qp_init_attr *init_attr,
276 				struct ib_udata *udata);
277 int mlx4_ib_destroy_qp(struct ib_qp *qp);
278 int mlx4_ib_modify_qp(struct ib_qp *ibqp, struct ib_qp_attr *attr,
279 		      int attr_mask, struct ib_udata *udata);
280 int mlx4_ib_query_qp(struct ib_qp *ibqp, struct ib_qp_attr *qp_attr, int qp_attr_mask,
281 		     struct ib_qp_init_attr *qp_init_attr);
282 int mlx4_ib_post_send(struct ib_qp *ibqp, struct ib_send_wr *wr,
283 		      struct ib_send_wr **bad_wr);
284 int mlx4_ib_post_recv(struct ib_qp *ibqp, struct ib_recv_wr *wr,
285 		      struct ib_recv_wr **bad_wr);
286 
287 int mlx4_MAD_IFC(struct mlx4_ib_dev *dev, int ignore_mkey, int ignore_bkey,
288 		 int port, struct ib_wc *in_wc, struct ib_grh *in_grh,
289 		 void *in_mad, void *response_mad);
290 int mlx4_ib_process_mad(struct ib_device *ibdev, int mad_flags,	u8 port_num,
291 			struct ib_wc *in_wc, struct ib_grh *in_grh,
292 			struct ib_mad *in_mad, struct ib_mad *out_mad);
293 int mlx4_ib_mad_init(struct mlx4_ib_dev *dev);
294 void mlx4_ib_mad_cleanup(struct mlx4_ib_dev *dev);
295 
296 struct ib_fmr *mlx4_ib_fmr_alloc(struct ib_pd *pd, int mr_access_flags,
297 				  struct ib_fmr_attr *fmr_attr);
298 int mlx4_ib_map_phys_fmr(struct ib_fmr *ibfmr, u64 *page_list, int npages,
299 			 u64 iova);
300 int mlx4_ib_unmap_fmr(struct list_head *fmr_list);
301 int mlx4_ib_fmr_dealloc(struct ib_fmr *fmr);
302 
303 static inline int mlx4_ib_ah_grh_present(struct mlx4_ib_ah *ah)
304 {
305 	return !!(ah->av.g_slid & 0x80);
306 }
307 
308 #endif /* MLX4_IB_H */
309