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 
39 #include <rdma/ib_verbs.h>
40 #include <rdma/ib_umem.h>
41 
42 #include <linux/mlx4/device.h>
43 #include <linux/mlx4/doorbell.h>
44 
45 enum {
46 	MLX4_IB_DB_PER_PAGE	= PAGE_SIZE / 4
47 };
48 
49 struct mlx4_ib_db_pgdir;
50 struct mlx4_ib_user_db_page;
51 
52 struct mlx4_ib_db {
53 	__be32		       *db;
54 	union {
55 		struct mlx4_ib_db_pgdir	       *pgdir;
56 		struct mlx4_ib_user_db_page    *user_page;
57 	}			u;
58 	dma_addr_t		dma;
59 	int			index;
60 	int			order;
61 };
62 
63 struct mlx4_ib_ucontext {
64 	struct ib_ucontext	ibucontext;
65 	struct mlx4_uar		uar;
66 	struct list_head	db_page_list;
67 	struct mutex		db_page_mutex;
68 };
69 
70 struct mlx4_ib_pd {
71 	struct ib_pd		ibpd;
72 	u32			pdn;
73 };
74 
75 struct mlx4_ib_cq_buf {
76 	struct mlx4_buf		buf;
77 	struct mlx4_mtt		mtt;
78 };
79 
80 struct mlx4_ib_cq {
81 	struct ib_cq		ibcq;
82 	struct mlx4_cq		mcq;
83 	struct mlx4_ib_cq_buf	buf;
84 	struct mlx4_ib_db	db;
85 	spinlock_t		lock;
86 	struct ib_umem	       *umem;
87 };
88 
89 struct mlx4_ib_mr {
90 	struct ib_mr		ibmr;
91 	struct mlx4_mr		mmr;
92 	struct ib_umem	       *umem;
93 };
94 
95 struct mlx4_ib_wq {
96 	u64		       *wrid;
97 	spinlock_t		lock;
98 	int			wqe_cnt;
99 	int			max_post;
100 	int			max_gs;
101 	int			offset;
102 	int			wqe_shift;
103 	unsigned		head;
104 	unsigned		tail;
105 };
106 
107 struct mlx4_ib_qp {
108 	struct ib_qp		ibqp;
109 	struct mlx4_qp		mqp;
110 	struct mlx4_buf		buf;
111 
112 	struct mlx4_ib_db	db;
113 	struct mlx4_ib_wq	rq;
114 
115 	u32			doorbell_qpn;
116 	__be32			sq_signal_bits;
117 	int			sq_spare_wqes;
118 	struct mlx4_ib_wq	sq;
119 
120 	struct ib_umem	       *umem;
121 	struct mlx4_mtt		mtt;
122 	int			buf_size;
123 	struct mutex		mutex;
124 	u8			port;
125 	u8			alt_port;
126 	u8			atomic_rd_en;
127 	u8			resp_depth;
128 	u8			sq_no_prefetch;
129 	u8			state;
130 };
131 
132 struct mlx4_ib_srq {
133 	struct ib_srq		ibsrq;
134 	struct mlx4_srq		msrq;
135 	struct mlx4_buf		buf;
136 	struct mlx4_ib_db	db;
137 	u64		       *wrid;
138 	spinlock_t		lock;
139 	int			head;
140 	int			tail;
141 	u16			wqe_ctr;
142 	struct ib_umem	       *umem;
143 	struct mlx4_mtt		mtt;
144 	struct mutex		mutex;
145 };
146 
147 struct mlx4_ib_ah {
148 	struct ib_ah		ibah;
149 	struct mlx4_av		av;
150 };
151 
152 struct mlx4_ib_dev {
153 	struct ib_device	ib_dev;
154 	struct mlx4_dev	       *dev;
155 	void __iomem	       *uar_map;
156 
157 	struct list_head	pgdir_list;
158 	struct mutex		pgdir_mutex;
159 
160 	struct mlx4_uar		priv_uar;
161 	u32			priv_pdn;
162 	MLX4_DECLARE_DOORBELL_LOCK(uar_lock);
163 
164 	struct ib_mad_agent    *send_agent[MLX4_MAX_PORTS][2];
165 	struct ib_ah	       *sm_ah[MLX4_MAX_PORTS];
166 	spinlock_t		sm_lock;
167 
168 	struct mutex		cap_mask_mutex;
169 };
170 
171 static inline struct mlx4_ib_dev *to_mdev(struct ib_device *ibdev)
172 {
173 	return container_of(ibdev, struct mlx4_ib_dev, ib_dev);
174 }
175 
176 static inline struct mlx4_ib_ucontext *to_mucontext(struct ib_ucontext *ibucontext)
177 {
178 	return container_of(ibucontext, struct mlx4_ib_ucontext, ibucontext);
179 }
180 
181 static inline struct mlx4_ib_pd *to_mpd(struct ib_pd *ibpd)
182 {
183 	return container_of(ibpd, struct mlx4_ib_pd, ibpd);
184 }
185 
186 static inline struct mlx4_ib_cq *to_mcq(struct ib_cq *ibcq)
187 {
188 	return container_of(ibcq, struct mlx4_ib_cq, ibcq);
189 }
190 
191 static inline struct mlx4_ib_cq *to_mibcq(struct mlx4_cq *mcq)
192 {
193 	return container_of(mcq, struct mlx4_ib_cq, mcq);
194 }
195 
196 static inline struct mlx4_ib_mr *to_mmr(struct ib_mr *ibmr)
197 {
198 	return container_of(ibmr, struct mlx4_ib_mr, ibmr);
199 }
200 
201 static inline struct mlx4_ib_qp *to_mqp(struct ib_qp *ibqp)
202 {
203 	return container_of(ibqp, struct mlx4_ib_qp, ibqp);
204 }
205 
206 static inline struct mlx4_ib_qp *to_mibqp(struct mlx4_qp *mqp)
207 {
208 	return container_of(mqp, struct mlx4_ib_qp, mqp);
209 }
210 
211 static inline struct mlx4_ib_srq *to_msrq(struct ib_srq *ibsrq)
212 {
213 	return container_of(ibsrq, struct mlx4_ib_srq, ibsrq);
214 }
215 
216 static inline struct mlx4_ib_srq *to_mibsrq(struct mlx4_srq *msrq)
217 {
218 	return container_of(msrq, struct mlx4_ib_srq, msrq);
219 }
220 
221 static inline struct mlx4_ib_ah *to_mah(struct ib_ah *ibah)
222 {
223 	return container_of(ibah, struct mlx4_ib_ah, ibah);
224 }
225 
226 int mlx4_ib_db_alloc(struct mlx4_ib_dev *dev, struct mlx4_ib_db *db, int order);
227 void mlx4_ib_db_free(struct mlx4_ib_dev *dev, struct mlx4_ib_db *db);
228 int mlx4_ib_db_map_user(struct mlx4_ib_ucontext *context, unsigned long virt,
229 			struct mlx4_ib_db *db);
230 void mlx4_ib_db_unmap_user(struct mlx4_ib_ucontext *context, struct mlx4_ib_db *db);
231 
232 struct ib_mr *mlx4_ib_get_dma_mr(struct ib_pd *pd, int acc);
233 int mlx4_ib_umem_write_mtt(struct mlx4_ib_dev *dev, struct mlx4_mtt *mtt,
234 			   struct ib_umem *umem);
235 struct ib_mr *mlx4_ib_reg_user_mr(struct ib_pd *pd, u64 start, u64 length,
236 				  u64 virt_addr, int access_flags,
237 				  struct ib_udata *udata);
238 int mlx4_ib_dereg_mr(struct ib_mr *mr);
239 
240 struct ib_cq *mlx4_ib_create_cq(struct ib_device *ibdev, int entries, int vector,
241 				struct ib_ucontext *context,
242 				struct ib_udata *udata);
243 int mlx4_ib_destroy_cq(struct ib_cq *cq);
244 int mlx4_ib_poll_cq(struct ib_cq *ibcq, int num_entries, struct ib_wc *wc);
245 int mlx4_ib_arm_cq(struct ib_cq *cq, enum ib_cq_notify_flags flags);
246 void __mlx4_ib_cq_clean(struct mlx4_ib_cq *cq, u32 qpn, struct mlx4_ib_srq *srq);
247 void mlx4_ib_cq_clean(struct mlx4_ib_cq *cq, u32 qpn, struct mlx4_ib_srq *srq);
248 
249 struct ib_ah *mlx4_ib_create_ah(struct ib_pd *pd, struct ib_ah_attr *ah_attr);
250 int mlx4_ib_query_ah(struct ib_ah *ibah, struct ib_ah_attr *ah_attr);
251 int mlx4_ib_destroy_ah(struct ib_ah *ah);
252 
253 struct ib_srq *mlx4_ib_create_srq(struct ib_pd *pd,
254 				  struct ib_srq_init_attr *init_attr,
255 				  struct ib_udata *udata);
256 int mlx4_ib_modify_srq(struct ib_srq *ibsrq, struct ib_srq_attr *attr,
257 		       enum ib_srq_attr_mask attr_mask, struct ib_udata *udata);
258 int mlx4_ib_destroy_srq(struct ib_srq *srq);
259 void mlx4_ib_free_srq_wqe(struct mlx4_ib_srq *srq, int wqe_index);
260 int mlx4_ib_post_srq_recv(struct ib_srq *ibsrq, struct ib_recv_wr *wr,
261 			  struct ib_recv_wr **bad_wr);
262 
263 struct ib_qp *mlx4_ib_create_qp(struct ib_pd *pd,
264 				struct ib_qp_init_attr *init_attr,
265 				struct ib_udata *udata);
266 int mlx4_ib_destroy_qp(struct ib_qp *qp);
267 int mlx4_ib_modify_qp(struct ib_qp *ibqp, struct ib_qp_attr *attr,
268 		      int attr_mask, struct ib_udata *udata);
269 int mlx4_ib_post_send(struct ib_qp *ibqp, struct ib_send_wr *wr,
270 		      struct ib_send_wr **bad_wr);
271 int mlx4_ib_post_recv(struct ib_qp *ibqp, struct ib_recv_wr *wr,
272 		      struct ib_recv_wr **bad_wr);
273 
274 int mlx4_MAD_IFC(struct mlx4_ib_dev *dev, int ignore_mkey, int ignore_bkey,
275 		 int port, struct ib_wc *in_wc, struct ib_grh *in_grh,
276 		 void *in_mad, void *response_mad);
277 int mlx4_ib_process_mad(struct ib_device *ibdev, int mad_flags,	u8 port_num,
278 			struct ib_wc *in_wc, struct ib_grh *in_grh,
279 			struct ib_mad *in_mad, struct ib_mad *out_mad);
280 int mlx4_ib_mad_init(struct mlx4_ib_dev *dev);
281 void mlx4_ib_mad_cleanup(struct mlx4_ib_dev *dev);
282 
283 static inline int mlx4_ib_ah_grh_present(struct mlx4_ib_ah *ah)
284 {
285 	return !!(ah->av.g_slid & 0x80);
286 }
287 
288 #endif /* MLX4_IB_H */
289