xref: /linux/include/uapi/rdma/ib_user_ioctl_cmds.h (revision 62de0e67328e9503459a24b9343c3358937cdeef)
1 /*
2  * Copyright (c) 2018, Mellanox Technologies inc.  All rights reserved.
3  * Copyright (c) 2020, Intel Corporation. All rights reserved.
4  *
5  * This software is available to you under a choice of one of two
6  * licenses.  You may choose to be licensed under the terms of the GNU
7  * General Public License (GPL) Version 2, available from the file
8  * COPYING in the main directory of this source tree, or the
9  * OpenIB.org BSD license below:
10  *
11  *     Redistribution and use in source and binary forms, with or
12  *     without modification, are permitted provided that the following
13  *     conditions are met:
14  *
15  *      - Redistributions of source code must retain the above
16  *        copyright notice, this list of conditions and the following
17  *        disclaimer.
18  *
19  *      - Redistributions in binary form must reproduce the above
20  *        copyright notice, this list of conditions and the following
21  *        disclaimer in the documentation and/or other materials
22  *        provided with the distribution.
23  *
24  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
28  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
29  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
30  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31  * SOFTWARE.
32  */
33 
34 #ifndef IB_USER_IOCTL_CMDS_H
35 #define IB_USER_IOCTL_CMDS_H
36 
37 #define UVERBS_ID_NS_MASK 0xF000
38 #define UVERBS_ID_NS_SHIFT 12
39 
40 enum uverbs_default_objects {
41 	UVERBS_OBJECT_DEVICE, /* No instances of DEVICE are allowed */
42 	UVERBS_OBJECT_PD,
43 	UVERBS_OBJECT_COMP_CHANNEL,
44 	UVERBS_OBJECT_CQ,
45 	UVERBS_OBJECT_QP,
46 	UVERBS_OBJECT_SRQ,
47 	UVERBS_OBJECT_AH,
48 	UVERBS_OBJECT_MR,
49 	UVERBS_OBJECT_MW,
50 	UVERBS_OBJECT_FLOW,
51 	UVERBS_OBJECT_XRCD,
52 	UVERBS_OBJECT_RWQ_IND_TBL,
53 	UVERBS_OBJECT_WQ,
54 	UVERBS_OBJECT_FLOW_ACTION,
55 	UVERBS_OBJECT_DM,
56 	UVERBS_OBJECT_COUNTERS,
57 	UVERBS_OBJECT_ASYNC_EVENT,
58 };
59 
60 enum {
61 	UVERBS_ID_DRIVER_NS = 1UL << UVERBS_ID_NS_SHIFT,
62 	UVERBS_ATTR_UHW_IN = UVERBS_ID_DRIVER_NS,
63 	UVERBS_ATTR_UHW_OUT,
64 	UVERBS_ID_DRIVER_NS_WITH_UHW,
65 };
66 
67 enum uverbs_methods_device {
68 	UVERBS_METHOD_INVOKE_WRITE,
69 	UVERBS_METHOD_INFO_HANDLES,
70 	UVERBS_METHOD_QUERY_PORT,
71 	UVERBS_METHOD_GET_CONTEXT,
72 	UVERBS_METHOD_QUERY_CONTEXT,
73 	UVERBS_METHOD_QUERY_GID_TABLE,
74 	UVERBS_METHOD_QUERY_GID_ENTRY,
75 };
76 
77 enum uverbs_attrs_invoke_write_cmd_attr_ids {
78 	UVERBS_ATTR_CORE_IN,
79 	UVERBS_ATTR_CORE_OUT,
80 	UVERBS_ATTR_WRITE_CMD,
81 };
82 
83 enum uverbs_attrs_query_port_cmd_attr_ids {
84 	UVERBS_ATTR_QUERY_PORT_PORT_NUM,
85 	UVERBS_ATTR_QUERY_PORT_RESP,
86 };
87 
88 enum uverbs_attrs_get_context_attr_ids {
89 	UVERBS_ATTR_GET_CONTEXT_NUM_COMP_VECTORS,
90 	UVERBS_ATTR_GET_CONTEXT_CORE_SUPPORT,
91 	UVERBS_ATTR_GET_CONTEXT_FD_ARR,
92 };
93 
94 enum uverbs_attrs_query_context_attr_ids {
95 	UVERBS_ATTR_QUERY_CONTEXT_NUM_COMP_VECTORS,
96 	UVERBS_ATTR_QUERY_CONTEXT_CORE_SUPPORT,
97 };
98 
99 enum uverbs_attrs_create_cq_cmd_attr_ids {
100 	UVERBS_ATTR_CREATE_CQ_HANDLE,
101 	UVERBS_ATTR_CREATE_CQ_CQE,
102 	UVERBS_ATTR_CREATE_CQ_USER_HANDLE,
103 	UVERBS_ATTR_CREATE_CQ_COMP_CHANNEL,
104 	UVERBS_ATTR_CREATE_CQ_COMP_VECTOR,
105 	UVERBS_ATTR_CREATE_CQ_FLAGS,
106 	UVERBS_ATTR_CREATE_CQ_RESP_CQE,
107 	UVERBS_ATTR_CREATE_CQ_EVENT_FD,
108 	UVERBS_ATTR_CREATE_CQ_BUFFER_VA,
109 	UVERBS_ATTR_CREATE_CQ_BUFFER_LENGTH,
110 	UVERBS_ATTR_CREATE_CQ_BUFFER_FD,
111 	UVERBS_ATTR_CREATE_CQ_BUFFER_OFFSET,
112 };
113 
114 enum uverbs_attrs_destroy_cq_cmd_attr_ids {
115 	UVERBS_ATTR_DESTROY_CQ_HANDLE,
116 	UVERBS_ATTR_DESTROY_CQ_RESP,
117 };
118 
119 enum uverbs_attrs_create_flow_action_esp {
120 	UVERBS_ATTR_CREATE_FLOW_ACTION_ESP_HANDLE,
121 	UVERBS_ATTR_FLOW_ACTION_ESP_ATTRS,
122 	UVERBS_ATTR_FLOW_ACTION_ESP_ESN,
123 	UVERBS_ATTR_FLOW_ACTION_ESP_KEYMAT,
124 	UVERBS_ATTR_FLOW_ACTION_ESP_REPLAY,
125 	UVERBS_ATTR_FLOW_ACTION_ESP_ENCAP,
126 };
127 
128 enum uverbs_attrs_modify_flow_action_esp {
129 	UVERBS_ATTR_MODIFY_FLOW_ACTION_ESP_HANDLE =
130 		UVERBS_ATTR_CREATE_FLOW_ACTION_ESP_HANDLE,
131 };
132 
133 enum uverbs_attrs_destroy_flow_action_esp {
134 	UVERBS_ATTR_DESTROY_FLOW_ACTION_HANDLE,
135 };
136 
137 enum uverbs_attrs_create_qp_cmd_attr_ids {
138 	UVERBS_ATTR_CREATE_QP_HANDLE,
139 	UVERBS_ATTR_CREATE_QP_XRCD_HANDLE,
140 	UVERBS_ATTR_CREATE_QP_PD_HANDLE,
141 	UVERBS_ATTR_CREATE_QP_SRQ_HANDLE,
142 	UVERBS_ATTR_CREATE_QP_SEND_CQ_HANDLE,
143 	UVERBS_ATTR_CREATE_QP_RECV_CQ_HANDLE,
144 	UVERBS_ATTR_CREATE_QP_IND_TABLE_HANDLE,
145 	UVERBS_ATTR_CREATE_QP_USER_HANDLE,
146 	UVERBS_ATTR_CREATE_QP_CAP,
147 	UVERBS_ATTR_CREATE_QP_TYPE,
148 	UVERBS_ATTR_CREATE_QP_FLAGS,
149 	UVERBS_ATTR_CREATE_QP_SOURCE_QPN,
150 	UVERBS_ATTR_CREATE_QP_EVENT_FD,
151 	UVERBS_ATTR_CREATE_QP_RESP_CAP,
152 	UVERBS_ATTR_CREATE_QP_RESP_QP_NUM,
153 };
154 
155 enum uverbs_attrs_destroy_qp_cmd_attr_ids {
156 	UVERBS_ATTR_DESTROY_QP_HANDLE,
157 	UVERBS_ATTR_DESTROY_QP_RESP,
158 };
159 
160 enum uverbs_methods_qp {
161 	UVERBS_METHOD_QP_CREATE,
162 	UVERBS_METHOD_QP_DESTROY,
163 };
164 
165 enum uverbs_attrs_create_srq_cmd_attr_ids {
166 	UVERBS_ATTR_CREATE_SRQ_HANDLE,
167 	UVERBS_ATTR_CREATE_SRQ_PD_HANDLE,
168 	UVERBS_ATTR_CREATE_SRQ_XRCD_HANDLE,
169 	UVERBS_ATTR_CREATE_SRQ_CQ_HANDLE,
170 	UVERBS_ATTR_CREATE_SRQ_USER_HANDLE,
171 	UVERBS_ATTR_CREATE_SRQ_MAX_WR,
172 	UVERBS_ATTR_CREATE_SRQ_MAX_SGE,
173 	UVERBS_ATTR_CREATE_SRQ_LIMIT,
174 	UVERBS_ATTR_CREATE_SRQ_MAX_NUM_TAGS,
175 	UVERBS_ATTR_CREATE_SRQ_TYPE,
176 	UVERBS_ATTR_CREATE_SRQ_EVENT_FD,
177 	UVERBS_ATTR_CREATE_SRQ_RESP_MAX_WR,
178 	UVERBS_ATTR_CREATE_SRQ_RESP_MAX_SGE,
179 	UVERBS_ATTR_CREATE_SRQ_RESP_SRQ_NUM,
180 };
181 
182 enum uverbs_attrs_destroy_srq_cmd_attr_ids {
183 	UVERBS_ATTR_DESTROY_SRQ_HANDLE,
184 	UVERBS_ATTR_DESTROY_SRQ_RESP,
185 };
186 
187 enum uverbs_methods_srq {
188 	UVERBS_METHOD_SRQ_CREATE,
189 	UVERBS_METHOD_SRQ_DESTROY,
190 };
191 
192 enum uverbs_methods_cq {
193 	UVERBS_METHOD_CQ_CREATE,
194 	UVERBS_METHOD_CQ_DESTROY,
195 };
196 
197 enum uverbs_attrs_create_wq_cmd_attr_ids {
198 	UVERBS_ATTR_CREATE_WQ_HANDLE,
199 	UVERBS_ATTR_CREATE_WQ_PD_HANDLE,
200 	UVERBS_ATTR_CREATE_WQ_CQ_HANDLE,
201 	UVERBS_ATTR_CREATE_WQ_USER_HANDLE,
202 	UVERBS_ATTR_CREATE_WQ_TYPE,
203 	UVERBS_ATTR_CREATE_WQ_EVENT_FD,
204 	UVERBS_ATTR_CREATE_WQ_MAX_WR,
205 	UVERBS_ATTR_CREATE_WQ_MAX_SGE,
206 	UVERBS_ATTR_CREATE_WQ_FLAGS,
207 	UVERBS_ATTR_CREATE_WQ_RESP_MAX_WR,
208 	UVERBS_ATTR_CREATE_WQ_RESP_MAX_SGE,
209 	UVERBS_ATTR_CREATE_WQ_RESP_WQ_NUM,
210 };
211 
212 enum uverbs_attrs_destroy_wq_cmd_attr_ids {
213 	UVERBS_ATTR_DESTROY_WQ_HANDLE,
214 	UVERBS_ATTR_DESTROY_WQ_RESP,
215 };
216 
217 enum uverbs_methods_wq {
218 	UVERBS_METHOD_WQ_CREATE,
219 	UVERBS_METHOD_WQ_DESTROY,
220 };
221 
222 enum uverbs_methods_actions_flow_action_ops {
223 	UVERBS_METHOD_FLOW_ACTION_ESP_CREATE,
224 	UVERBS_METHOD_FLOW_ACTION_DESTROY,
225 	UVERBS_METHOD_FLOW_ACTION_ESP_MODIFY,
226 };
227 
228 enum uverbs_attrs_alloc_dm_cmd_attr_ids {
229 	UVERBS_ATTR_ALLOC_DM_HANDLE,
230 	UVERBS_ATTR_ALLOC_DM_LENGTH,
231 	UVERBS_ATTR_ALLOC_DM_ALIGNMENT,
232 };
233 
234 enum uverbs_attrs_free_dm_cmd_attr_ids {
235 	UVERBS_ATTR_FREE_DM_HANDLE,
236 };
237 
238 enum uverbs_methods_dm {
239 	UVERBS_METHOD_DM_ALLOC,
240 	UVERBS_METHOD_DM_FREE,
241 };
242 
243 enum uverbs_attrs_reg_dm_mr_cmd_attr_ids {
244 	UVERBS_ATTR_REG_DM_MR_HANDLE,
245 	UVERBS_ATTR_REG_DM_MR_OFFSET,
246 	UVERBS_ATTR_REG_DM_MR_LENGTH,
247 	UVERBS_ATTR_REG_DM_MR_PD_HANDLE,
248 	UVERBS_ATTR_REG_DM_MR_ACCESS_FLAGS,
249 	UVERBS_ATTR_REG_DM_MR_DM_HANDLE,
250 	UVERBS_ATTR_REG_DM_MR_RESP_LKEY,
251 	UVERBS_ATTR_REG_DM_MR_RESP_RKEY,
252 };
253 
254 enum uverbs_methods_mr {
255 	UVERBS_METHOD_DM_MR_REG,
256 	UVERBS_METHOD_MR_DESTROY,
257 	UVERBS_METHOD_ADVISE_MR,
258 	UVERBS_METHOD_QUERY_MR,
259 	UVERBS_METHOD_REG_DMABUF_MR,
260 };
261 
262 enum uverbs_attrs_mr_destroy_ids {
263 	UVERBS_ATTR_DESTROY_MR_HANDLE,
264 };
265 
266 enum uverbs_attrs_advise_mr_cmd_attr_ids {
267 	UVERBS_ATTR_ADVISE_MR_PD_HANDLE,
268 	UVERBS_ATTR_ADVISE_MR_ADVICE,
269 	UVERBS_ATTR_ADVISE_MR_FLAGS,
270 	UVERBS_ATTR_ADVISE_MR_SGE_LIST,
271 };
272 
273 enum uverbs_attrs_query_mr_cmd_attr_ids {
274 	UVERBS_ATTR_QUERY_MR_HANDLE,
275 	UVERBS_ATTR_QUERY_MR_RESP_LKEY,
276 	UVERBS_ATTR_QUERY_MR_RESP_RKEY,
277 	UVERBS_ATTR_QUERY_MR_RESP_LENGTH,
278 	UVERBS_ATTR_QUERY_MR_RESP_IOVA,
279 };
280 
281 enum uverbs_attrs_reg_dmabuf_mr_cmd_attr_ids {
282 	UVERBS_ATTR_REG_DMABUF_MR_HANDLE,
283 	UVERBS_ATTR_REG_DMABUF_MR_PD_HANDLE,
284 	UVERBS_ATTR_REG_DMABUF_MR_OFFSET,
285 	UVERBS_ATTR_REG_DMABUF_MR_LENGTH,
286 	UVERBS_ATTR_REG_DMABUF_MR_IOVA,
287 	UVERBS_ATTR_REG_DMABUF_MR_FD,
288 	UVERBS_ATTR_REG_DMABUF_MR_ACCESS_FLAGS,
289 	UVERBS_ATTR_REG_DMABUF_MR_RESP_LKEY,
290 	UVERBS_ATTR_REG_DMABUF_MR_RESP_RKEY,
291 };
292 
293 enum uverbs_attrs_create_counters_cmd_attr_ids {
294 	UVERBS_ATTR_CREATE_COUNTERS_HANDLE,
295 };
296 
297 enum uverbs_attrs_destroy_counters_cmd_attr_ids {
298 	UVERBS_ATTR_DESTROY_COUNTERS_HANDLE,
299 };
300 
301 enum uverbs_attrs_read_counters_cmd_attr_ids {
302 	UVERBS_ATTR_READ_COUNTERS_HANDLE,
303 	UVERBS_ATTR_READ_COUNTERS_BUFF,
304 	UVERBS_ATTR_READ_COUNTERS_FLAGS,
305 };
306 
307 enum uverbs_methods_actions_counters_ops {
308 	UVERBS_METHOD_COUNTERS_CREATE,
309 	UVERBS_METHOD_COUNTERS_DESTROY,
310 	UVERBS_METHOD_COUNTERS_READ,
311 };
312 
313 enum uverbs_attrs_info_handles_id {
314 	UVERBS_ATTR_INFO_OBJECT_ID,
315 	UVERBS_ATTR_INFO_TOTAL_HANDLES,
316 	UVERBS_ATTR_INFO_HANDLES_LIST,
317 };
318 
319 enum uverbs_methods_pd {
320 	UVERBS_METHOD_PD_DESTROY,
321 };
322 
323 enum uverbs_attrs_pd_destroy_ids {
324 	UVERBS_ATTR_DESTROY_PD_HANDLE,
325 };
326 
327 enum uverbs_methods_mw {
328 	UVERBS_METHOD_MW_DESTROY,
329 };
330 
331 enum uverbs_attrs_mw_destroy_ids {
332 	UVERBS_ATTR_DESTROY_MW_HANDLE,
333 };
334 
335 enum uverbs_methods_xrcd {
336 	UVERBS_METHOD_XRCD_DESTROY,
337 };
338 
339 enum uverbs_attrs_xrcd_destroy_ids {
340 	UVERBS_ATTR_DESTROY_XRCD_HANDLE,
341 };
342 
343 enum uverbs_methods_ah {
344 	UVERBS_METHOD_AH_DESTROY,
345 };
346 
347 enum uverbs_attrs_ah_destroy_ids {
348 	UVERBS_ATTR_DESTROY_AH_HANDLE,
349 };
350 
351 enum uverbs_methods_rwq_ind_tbl {
352 	UVERBS_METHOD_RWQ_IND_TBL_DESTROY,
353 };
354 
355 enum uverbs_attrs_rwq_ind_tbl_destroy_ids {
356 	UVERBS_ATTR_DESTROY_RWQ_IND_TBL_HANDLE,
357 };
358 
359 enum uverbs_methods_flow {
360 	UVERBS_METHOD_FLOW_DESTROY,
361 };
362 
363 enum uverbs_attrs_flow_destroy_ids {
364 	UVERBS_ATTR_DESTROY_FLOW_HANDLE,
365 };
366 
367 enum uverbs_method_async_event {
368 	UVERBS_METHOD_ASYNC_EVENT_ALLOC,
369 };
370 
371 enum uverbs_attrs_async_event_create {
372 	UVERBS_ATTR_ASYNC_EVENT_ALLOC_FD_HANDLE,
373 };
374 
375 enum uverbs_attrs_query_gid_table_cmd_attr_ids {
376 	UVERBS_ATTR_QUERY_GID_TABLE_ENTRY_SIZE,
377 	UVERBS_ATTR_QUERY_GID_TABLE_FLAGS,
378 	UVERBS_ATTR_QUERY_GID_TABLE_RESP_ENTRIES,
379 	UVERBS_ATTR_QUERY_GID_TABLE_RESP_NUM_ENTRIES,
380 };
381 
382 enum uverbs_attrs_query_gid_entry_cmd_attr_ids {
383 	UVERBS_ATTR_QUERY_GID_ENTRY_PORT,
384 	UVERBS_ATTR_QUERY_GID_ENTRY_GID_INDEX,
385 	UVERBS_ATTR_QUERY_GID_ENTRY_FLAGS,
386 	UVERBS_ATTR_QUERY_GID_ENTRY_RESP_ENTRY,
387 };
388 
389 #endif
390