xref: /linux/include/uapi/rdma/bnxt_re-abi.h (revision 69050f8d6d075dc01af7a5f2f550a8067510366f)
1 /* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) */
2 /*
3  * Broadcom NetXtreme-E RoCE driver.
4  *
5  * Copyright (c) 2016 - 2017, Broadcom. All rights reserved.  The term
6  * Broadcom refers to Broadcom Limited and/or its subsidiaries.
7  *
8  * This software is available to you under a choice of one of two
9  * licenses.  You may choose to be licensed under the terms of the GNU
10  * General Public License (GPL) Version 2, available from the file
11  * COPYING in the main directory of this source tree, or the
12  * BSD license below:
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions
16  * are met:
17  *
18  * 1. Redistributions of source code must retain the above copyright
19  *    notice, this list of conditions and the following disclaimer.
20  * 2. Redistributions in binary form must reproduce the above copyright
21  *    notice, this list of conditions and the following disclaimer in
22  *    the documentation and/or other materials provided with the
23  *    distribution.
24  *
25  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS''
26  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
27  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS
29  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
32  * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
33  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
34  * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
35  * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36  *
37  * Description: Uverbs ABI header file
38  */
39 
40 #ifndef __BNXT_RE_UVERBS_ABI_H__
41 #define __BNXT_RE_UVERBS_ABI_H__
42 
43 #include <linux/types.h>
44 #include <rdma/ib_user_ioctl_cmds.h>
45 
46 #define BNXT_RE_ABI_VERSION	1
47 
48 #define BNXT_RE_CHIP_ID0_CHIP_NUM_SFT		0x00
49 #define BNXT_RE_CHIP_ID0_CHIP_REV_SFT		0x10
50 #define BNXT_RE_CHIP_ID0_CHIP_MET_SFT		0x18
51 
52 enum {
53 	BNXT_RE_UCNTX_CMASK_HAVE_CCTX = 0x1ULL,
54 	BNXT_RE_UCNTX_CMASK_HAVE_MODE = 0x02ULL,
55 	BNXT_RE_UCNTX_CMASK_WC_DPI_ENABLED = 0x04ULL,
56 	BNXT_RE_UCNTX_CMASK_DBR_PACING_ENABLED = 0x08ULL,
57 	BNXT_RE_UCNTX_CMASK_POW2_DISABLED = 0x10ULL,
58 	BNXT_RE_UCNTX_CMASK_MSN_TABLE_ENABLED = 0x40,
59 	BNXT_RE_UCNTX_CMASK_QP_RATE_LIMIT_ENABLED = 0x80ULL,
60 };
61 
62 enum bnxt_re_wqe_mode {
63 	BNXT_QPLIB_WQE_MODE_STATIC	= 0x00,
64 	BNXT_QPLIB_WQE_MODE_VARIABLE	= 0x01,
65 	BNXT_QPLIB_WQE_MODE_INVALID	= 0x02,
66 };
67 
68 enum {
69 	BNXT_RE_COMP_MASK_REQ_UCNTX_POW2_SUPPORT = 0x01,
70 	BNXT_RE_COMP_MASK_REQ_UCNTX_VAR_WQE_SUPPORT = 0x02,
71 };
72 
73 struct bnxt_re_uctx_req {
74 	__aligned_u64 comp_mask;
75 };
76 
77 struct bnxt_re_uctx_resp {
78 	__u32 dev_id;
79 	__u32 max_qp;
80 	__u32 pg_size;
81 	__u32 cqe_sz;
82 	__u32 max_cqd;
83 	__u32 rsvd;
84 	__aligned_u64 comp_mask;
85 	__u32 chip_id0;
86 	__u32 chip_id1;
87 	__u32 mode;
88 	__u32 rsvd1; /* padding */
89 };
90 
91 /*
92  * This struct is placed after the ib_uverbs_alloc_pd_resp struct, which is
93  * not 8 byted aligned. To avoid undesired padding in various cases we have to
94  * set this struct to packed.
95  */
96 struct bnxt_re_pd_resp {
97 	__u32 pdid;
98 	__u32 dpi;
99 	__u64 dbr;
100 } __attribute__((packed, aligned(4)));
101 
102 struct bnxt_re_cq_req {
103 	__aligned_u64 cq_va;
104 	__aligned_u64 cq_handle;
105 };
106 
107 enum bnxt_re_cq_mask {
108 	BNXT_RE_CQ_TOGGLE_PAGE_SUPPORT = 0x1,
109 };
110 
111 struct bnxt_re_cq_resp {
112 	__u32 cqid;
113 	__u32 tail;
114 	__u32 phase;
115 	__u32 rsvd;
116 	__aligned_u64 comp_mask;
117 };
118 
119 struct bnxt_re_resize_cq_req {
120 	__aligned_u64 cq_va;
121 };
122 
123 enum bnxt_re_qp_mask {
124 	BNXT_RE_QP_REQ_MASK_VAR_WQE_SQ_SLOTS = 0x1,
125 };
126 
127 struct bnxt_re_qp_req {
128 	__aligned_u64 qpsva;
129 	__aligned_u64 qprva;
130 	__aligned_u64 qp_handle;
131 	__aligned_u64 comp_mask;
132 	__u32 sq_slots;
133 };
134 
135 struct bnxt_re_qp_resp {
136 	__u32 qpid;
137 	__u32 rsvd;
138 };
139 
140 struct bnxt_re_srq_req {
141 	__aligned_u64 srqva;
142 	__aligned_u64 srq_handle;
143 };
144 
145 enum bnxt_re_srq_mask {
146 	BNXT_RE_SRQ_TOGGLE_PAGE_SUPPORT = 0x1,
147 };
148 
149 struct bnxt_re_srq_resp {
150 	__u32 srqid;
151 	__u32 rsvd; /* padding */
152 	__aligned_u64 comp_mask;
153 };
154 
155 enum bnxt_re_shpg_offt {
156 	BNXT_RE_BEG_RESV_OFFT	= 0x00,
157 	BNXT_RE_AVID_OFFT	= 0x10,
158 	BNXT_RE_AVID_SIZE	= 0x04,
159 	BNXT_RE_END_RESV_OFFT	= 0xFF0
160 };
161 
162 enum bnxt_re_objects {
163 	BNXT_RE_OBJECT_ALLOC_PAGE = (1U << UVERBS_ID_NS_SHIFT),
164 	BNXT_RE_OBJECT_NOTIFY_DRV,
165 	BNXT_RE_OBJECT_GET_TOGGLE_MEM,
166 };
167 
168 enum bnxt_re_alloc_page_type {
169 	BNXT_RE_ALLOC_WC_PAGE = 0,
170 	BNXT_RE_ALLOC_DBR_BAR_PAGE,
171 	BNXT_RE_ALLOC_DBR_PAGE,
172 };
173 
174 enum bnxt_re_var_alloc_page_attrs {
175 	BNXT_RE_ALLOC_PAGE_HANDLE = (1U << UVERBS_ID_NS_SHIFT),
176 	BNXT_RE_ALLOC_PAGE_TYPE,
177 	BNXT_RE_ALLOC_PAGE_DPI,
178 	BNXT_RE_ALLOC_PAGE_MMAP_OFFSET,
179 	BNXT_RE_ALLOC_PAGE_MMAP_LENGTH,
180 };
181 
182 enum bnxt_re_alloc_page_attrs {
183 	BNXT_RE_DESTROY_PAGE_HANDLE = (1U << UVERBS_ID_NS_SHIFT),
184 };
185 
186 enum bnxt_re_alloc_page_methods {
187 	BNXT_RE_METHOD_ALLOC_PAGE = (1U << UVERBS_ID_NS_SHIFT),
188 	BNXT_RE_METHOD_DESTROY_PAGE,
189 };
190 
191 enum bnxt_re_notify_drv_methods {
192 	BNXT_RE_METHOD_NOTIFY_DRV = (1U << UVERBS_ID_NS_SHIFT),
193 };
194 
195 /* Toggle mem */
196 
197 enum bnxt_re_get_toggle_mem_type {
198 	BNXT_RE_CQ_TOGGLE_MEM = 0,
199 	BNXT_RE_SRQ_TOGGLE_MEM,
200 };
201 
202 enum bnxt_re_var_toggle_mem_attrs {
203 	BNXT_RE_TOGGLE_MEM_HANDLE = (1U << UVERBS_ID_NS_SHIFT),
204 	BNXT_RE_TOGGLE_MEM_TYPE,
205 	BNXT_RE_TOGGLE_MEM_RES_ID,
206 	BNXT_RE_TOGGLE_MEM_MMAP_PAGE,
207 	BNXT_RE_TOGGLE_MEM_MMAP_OFFSET,
208 	BNXT_RE_TOGGLE_MEM_MMAP_LENGTH,
209 };
210 
211 enum bnxt_re_toggle_mem_attrs {
212 	BNXT_RE_RELEASE_TOGGLE_MEM_HANDLE = (1U << UVERBS_ID_NS_SHIFT),
213 };
214 
215 enum bnxt_re_toggle_mem_methods {
216 	BNXT_RE_METHOD_GET_TOGGLE_MEM = (1U << UVERBS_ID_NS_SHIFT),
217 	BNXT_RE_METHOD_RELEASE_TOGGLE_MEM,
218 };
219 
220 struct bnxt_re_packet_pacing_caps {
221 	__u32 qp_rate_limit_min;
222 	__u32 qp_rate_limit_max; /* In kbps */
223 	/* Corresponding bit will be set if qp type from
224 	 * 'enum ib_qp_type' is supported, e.g.
225 	 * supported_qpts |= 1 << IB_QPT_RC
226 	 */
227 	__u32 supported_qpts;
228 	__u32 reserved;
229 };
230 
231 struct bnxt_re_query_device_ex_resp {
232 	struct bnxt_re_packet_pacing_caps packet_pacing_caps;
233 };
234 #endif /* __BNXT_RE_UVERBS_ABI_H__*/
235