xref: /linux-6.15/include/linux/mlx4/device.h (revision d289bf7b)
1 /*
2  * Copyright (c) 2006, 2007 Cisco Systems, Inc.  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_DEVICE_H
34 #define MLX4_DEVICE_H
35 
36 #include <linux/pci.h>
37 #include <linux/completion.h>
38 #include <linux/radix-tree.h>
39 
40 #include <asm/atomic.h>
41 
42 enum {
43 	MLX4_FLAG_MSI_X		= 1 << 0,
44 	MLX4_FLAG_OLD_PORT_CMDS	= 1 << 1,
45 };
46 
47 enum {
48 	MLX4_MAX_PORTS		= 2
49 };
50 
51 enum {
52 	MLX4_BOARD_ID_LEN = 64
53 };
54 
55 enum {
56 	MLX4_DEV_CAP_FLAG_RC		= 1 <<  0,
57 	MLX4_DEV_CAP_FLAG_UC		= 1 <<  1,
58 	MLX4_DEV_CAP_FLAG_UD		= 1 <<  2,
59 	MLX4_DEV_CAP_FLAG_SRQ		= 1 <<  6,
60 	MLX4_DEV_CAP_FLAG_IPOIB_CSUM	= 1 <<  7,
61 	MLX4_DEV_CAP_FLAG_BAD_PKEY_CNTR	= 1 <<  8,
62 	MLX4_DEV_CAP_FLAG_BAD_QKEY_CNTR	= 1 <<  9,
63 	MLX4_DEV_CAP_FLAG_MEM_WINDOW	= 1 << 16,
64 	MLX4_DEV_CAP_FLAG_APM		= 1 << 17,
65 	MLX4_DEV_CAP_FLAG_ATOMIC	= 1 << 18,
66 	MLX4_DEV_CAP_FLAG_RAW_MCAST	= 1 << 19,
67 	MLX4_DEV_CAP_FLAG_UD_AV_PORT	= 1 << 20,
68 	MLX4_DEV_CAP_FLAG_UD_MCAST	= 1 << 21
69 };
70 
71 enum mlx4_event {
72 	MLX4_EVENT_TYPE_COMP		   = 0x00,
73 	MLX4_EVENT_TYPE_PATH_MIG	   = 0x01,
74 	MLX4_EVENT_TYPE_COMM_EST	   = 0x02,
75 	MLX4_EVENT_TYPE_SQ_DRAINED	   = 0x03,
76 	MLX4_EVENT_TYPE_SRQ_QP_LAST_WQE	   = 0x13,
77 	MLX4_EVENT_TYPE_SRQ_LIMIT	   = 0x14,
78 	MLX4_EVENT_TYPE_CQ_ERROR	   = 0x04,
79 	MLX4_EVENT_TYPE_WQ_CATAS_ERROR	   = 0x05,
80 	MLX4_EVENT_TYPE_EEC_CATAS_ERROR	   = 0x06,
81 	MLX4_EVENT_TYPE_PATH_MIG_FAILED	   = 0x07,
82 	MLX4_EVENT_TYPE_WQ_INVAL_REQ_ERROR = 0x10,
83 	MLX4_EVENT_TYPE_WQ_ACCESS_ERROR	   = 0x11,
84 	MLX4_EVENT_TYPE_SRQ_CATAS_ERROR	   = 0x12,
85 	MLX4_EVENT_TYPE_LOCAL_CATAS_ERROR  = 0x08,
86 	MLX4_EVENT_TYPE_PORT_CHANGE	   = 0x09,
87 	MLX4_EVENT_TYPE_EQ_OVERFLOW	   = 0x0f,
88 	MLX4_EVENT_TYPE_ECC_DETECT	   = 0x0e,
89 	MLX4_EVENT_TYPE_CMD		   = 0x0a
90 };
91 
92 enum {
93 	MLX4_PORT_CHANGE_SUBTYPE_DOWN	= 1,
94 	MLX4_PORT_CHANGE_SUBTYPE_ACTIVE	= 4
95 };
96 
97 enum {
98 	MLX4_PERM_LOCAL_READ	= 1 << 10,
99 	MLX4_PERM_LOCAL_WRITE	= 1 << 11,
100 	MLX4_PERM_REMOTE_READ	= 1 << 12,
101 	MLX4_PERM_REMOTE_WRITE	= 1 << 13,
102 	MLX4_PERM_ATOMIC	= 1 << 14
103 };
104 
105 enum {
106 	MLX4_OPCODE_NOP			= 0x00,
107 	MLX4_OPCODE_SEND_INVAL		= 0x01,
108 	MLX4_OPCODE_RDMA_WRITE		= 0x08,
109 	MLX4_OPCODE_RDMA_WRITE_IMM	= 0x09,
110 	MLX4_OPCODE_SEND		= 0x0a,
111 	MLX4_OPCODE_SEND_IMM		= 0x0b,
112 	MLX4_OPCODE_LSO			= 0x0e,
113 	MLX4_OPCODE_RDMA_READ		= 0x10,
114 	MLX4_OPCODE_ATOMIC_CS		= 0x11,
115 	MLX4_OPCODE_ATOMIC_FA		= 0x12,
116 	MLX4_OPCODE_ATOMIC_MASK_CS	= 0x14,
117 	MLX4_OPCODE_ATOMIC_MASK_FA	= 0x15,
118 	MLX4_OPCODE_BIND_MW		= 0x18,
119 	MLX4_OPCODE_FMR			= 0x19,
120 	MLX4_OPCODE_LOCAL_INVAL		= 0x1b,
121 	MLX4_OPCODE_CONFIG_CMD		= 0x1f,
122 
123 	MLX4_RECV_OPCODE_RDMA_WRITE_IMM	= 0x00,
124 	MLX4_RECV_OPCODE_SEND		= 0x01,
125 	MLX4_RECV_OPCODE_SEND_IMM	= 0x02,
126 	MLX4_RECV_OPCODE_SEND_INVAL	= 0x03,
127 
128 	MLX4_CQE_OPCODE_ERROR		= 0x1e,
129 	MLX4_CQE_OPCODE_RESIZE		= 0x16,
130 };
131 
132 enum {
133 	MLX4_STAT_RATE_OFFSET	= 5
134 };
135 
136 static inline u64 mlx4_fw_ver(u64 major, u64 minor, u64 subminor)
137 {
138 	return (major << 32) | (minor << 16) | subminor;
139 }
140 
141 struct mlx4_caps {
142 	u64			fw_ver;
143 	int			num_ports;
144 	int			vl_cap[MLX4_MAX_PORTS + 1];
145 	int			mtu_cap[MLX4_MAX_PORTS + 1];
146 	int			gid_table_len[MLX4_MAX_PORTS + 1];
147 	int			pkey_table_len[MLX4_MAX_PORTS + 1];
148 	int			local_ca_ack_delay;
149 	int			num_uars;
150 	int			bf_reg_size;
151 	int			bf_regs_per_page;
152 	int			max_sq_sg;
153 	int			max_rq_sg;
154 	int			num_qps;
155 	int			max_wqes;
156 	int			max_sq_desc_sz;
157 	int			max_rq_desc_sz;
158 	int			max_qp_init_rdma;
159 	int			max_qp_dest_rdma;
160 	int			reserved_qps;
161 	int			sqp_start;
162 	int			num_srqs;
163 	int			max_srq_wqes;
164 	int			max_srq_sge;
165 	int			reserved_srqs;
166 	int			num_cqs;
167 	int			max_cqes;
168 	int			reserved_cqs;
169 	int			num_eqs;
170 	int			reserved_eqs;
171 	int			num_mpts;
172 	int			num_mtt_segs;
173 	int			fmr_reserved_mtts;
174 	int			reserved_mtts;
175 	int			reserved_mrws;
176 	int			reserved_uars;
177 	int			num_mgms;
178 	int			num_amgms;
179 	int			reserved_mcgs;
180 	int			num_qp_per_mgm;
181 	int			num_pds;
182 	int			reserved_pds;
183 	int			mtt_entry_sz;
184 	u32			max_msg_sz;
185 	u32			page_size_cap;
186 	u32			flags;
187 	u16			stat_rate_support;
188 	u8			port_width_cap[MLX4_MAX_PORTS + 1];
189 	int			max_gso_sz;
190 };
191 
192 struct mlx4_buf_list {
193 	void		       *buf;
194 	dma_addr_t		map;
195 };
196 
197 struct mlx4_buf {
198 	struct mlx4_buf_list	direct;
199 	struct mlx4_buf_list   *page_list;
200 	int			nbufs;
201 	int			npages;
202 	int			page_shift;
203 };
204 
205 struct mlx4_mtt {
206 	u32			first_seg;
207 	int			order;
208 	int			page_shift;
209 };
210 
211 struct mlx4_mr {
212 	struct mlx4_mtt		mtt;
213 	u64			iova;
214 	u64			size;
215 	u32			key;
216 	u32			pd;
217 	u32			access;
218 	int			enabled;
219 };
220 
221 struct mlx4_fmr {
222 	struct mlx4_mr		mr;
223 	struct mlx4_mpt_entry  *mpt;
224 	__be64		       *mtts;
225 	dma_addr_t		dma_handle;
226 	int			max_pages;
227 	int			max_maps;
228 	int			maps;
229 	u8			page_shift;
230 };
231 
232 struct mlx4_uar {
233 	unsigned long		pfn;
234 	int			index;
235 };
236 
237 struct mlx4_cq {
238 	void (*comp)		(struct mlx4_cq *);
239 	void (*event)		(struct mlx4_cq *, enum mlx4_event);
240 
241 	struct mlx4_uar	       *uar;
242 
243 	u32			cons_index;
244 
245 	__be32		       *set_ci_db;
246 	__be32		       *arm_db;
247 	int			arm_sn;
248 
249 	int			cqn;
250 
251 	atomic_t		refcount;
252 	struct completion	free;
253 };
254 
255 struct mlx4_qp {
256 	void (*event)		(struct mlx4_qp *, enum mlx4_event);
257 
258 	int			qpn;
259 
260 	atomic_t		refcount;
261 	struct completion	free;
262 };
263 
264 struct mlx4_srq {
265 	void (*event)		(struct mlx4_srq *, enum mlx4_event);
266 
267 	int			srqn;
268 	int			max;
269 	int			max_gs;
270 	int			wqe_shift;
271 
272 	atomic_t		refcount;
273 	struct completion	free;
274 };
275 
276 struct mlx4_av {
277 	__be32			port_pd;
278 	u8			reserved1;
279 	u8			g_slid;
280 	__be16			dlid;
281 	u8			reserved2;
282 	u8			gid_index;
283 	u8			stat_rate;
284 	u8			hop_limit;
285 	__be32			sl_tclass_flowlabel;
286 	u8			dgid[16];
287 };
288 
289 struct mlx4_dev {
290 	struct pci_dev	       *pdev;
291 	unsigned long		flags;
292 	struct mlx4_caps	caps;
293 	struct radix_tree_root	qp_table_tree;
294 	u32			rev_id;
295 	char			board_id[MLX4_BOARD_ID_LEN];
296 };
297 
298 struct mlx4_init_port_param {
299 	int			set_guid0;
300 	int			set_node_guid;
301 	int			set_si_guid;
302 	u16			mtu;
303 	int			port_width_cap;
304 	u16			vl_cap;
305 	u16			max_gid;
306 	u16			max_pkey;
307 	u64			guid0;
308 	u64			node_guid;
309 	u64			si_guid;
310 };
311 
312 int mlx4_buf_alloc(struct mlx4_dev *dev, int size, int max_direct,
313 		   struct mlx4_buf *buf);
314 void mlx4_buf_free(struct mlx4_dev *dev, int size, struct mlx4_buf *buf);
315 static inline void *mlx4_buf_offset(struct mlx4_buf *buf, int offset)
316 {
317 	if (BITS_PER_LONG == 64 || buf->nbufs == 1)
318 		return buf->direct.buf + offset;
319 	else
320 		return buf->page_list[offset >> PAGE_SHIFT].buf +
321 			(offset & (PAGE_SIZE - 1));
322 }
323 
324 int mlx4_pd_alloc(struct mlx4_dev *dev, u32 *pdn);
325 void mlx4_pd_free(struct mlx4_dev *dev, u32 pdn);
326 
327 int mlx4_uar_alloc(struct mlx4_dev *dev, struct mlx4_uar *uar);
328 void mlx4_uar_free(struct mlx4_dev *dev, struct mlx4_uar *uar);
329 
330 int mlx4_mtt_init(struct mlx4_dev *dev, int npages, int page_shift,
331 		  struct mlx4_mtt *mtt);
332 void mlx4_mtt_cleanup(struct mlx4_dev *dev, struct mlx4_mtt *mtt);
333 u64 mlx4_mtt_addr(struct mlx4_dev *dev, struct mlx4_mtt *mtt);
334 
335 int mlx4_mr_alloc(struct mlx4_dev *dev, u32 pd, u64 iova, u64 size, u32 access,
336 		  int npages, int page_shift, struct mlx4_mr *mr);
337 void mlx4_mr_free(struct mlx4_dev *dev, struct mlx4_mr *mr);
338 int mlx4_mr_enable(struct mlx4_dev *dev, struct mlx4_mr *mr);
339 int mlx4_write_mtt(struct mlx4_dev *dev, struct mlx4_mtt *mtt,
340 		   int start_index, int npages, u64 *page_list);
341 int mlx4_buf_write_mtt(struct mlx4_dev *dev, struct mlx4_mtt *mtt,
342 		       struct mlx4_buf *buf);
343 
344 int mlx4_cq_alloc(struct mlx4_dev *dev, int nent, struct mlx4_mtt *mtt,
345 		  struct mlx4_uar *uar, u64 db_rec, struct mlx4_cq *cq);
346 void mlx4_cq_free(struct mlx4_dev *dev, struct mlx4_cq *cq);
347 
348 int mlx4_qp_alloc(struct mlx4_dev *dev, int sqpn, struct mlx4_qp *qp);
349 void mlx4_qp_free(struct mlx4_dev *dev, struct mlx4_qp *qp);
350 
351 int mlx4_srq_alloc(struct mlx4_dev *dev, u32 pdn, struct mlx4_mtt *mtt,
352 		   u64 db_rec, struct mlx4_srq *srq);
353 void mlx4_srq_free(struct mlx4_dev *dev, struct mlx4_srq *srq);
354 int mlx4_srq_arm(struct mlx4_dev *dev, struct mlx4_srq *srq, int limit_watermark);
355 int mlx4_srq_query(struct mlx4_dev *dev, struct mlx4_srq *srq, int *limit_watermark);
356 
357 int mlx4_INIT_PORT(struct mlx4_dev *dev, int port);
358 int mlx4_CLOSE_PORT(struct mlx4_dev *dev, int port);
359 
360 int mlx4_multicast_attach(struct mlx4_dev *dev, struct mlx4_qp *qp, u8 gid[16]);
361 int mlx4_multicast_detach(struct mlx4_dev *dev, struct mlx4_qp *qp, u8 gid[16]);
362 
363 int mlx4_map_phys_fmr(struct mlx4_dev *dev, struct mlx4_fmr *fmr, u64 *page_list,
364 		      int npages, u64 iova, u32 *lkey, u32 *rkey);
365 int mlx4_fmr_alloc(struct mlx4_dev *dev, u32 pd, u32 access, int max_pages,
366 		   int max_maps, u8 page_shift, struct mlx4_fmr *fmr);
367 int mlx4_fmr_enable(struct mlx4_dev *dev, struct mlx4_fmr *fmr);
368 void mlx4_fmr_unmap(struct mlx4_dev *dev, struct mlx4_fmr *fmr,
369 		    u32 *lkey, u32 *rkey);
370 int mlx4_fmr_free(struct mlx4_dev *dev, struct mlx4_fmr *fmr);
371 int mlx4_SYNC_TPT(struct mlx4_dev *dev);
372 
373 #endif /* MLX4_DEVICE_H */
374