xref: /linux/include/uapi/rdma/ib_user_ioctl_cmds.h (revision 23b0f90ba871f096474e1c27c3d14f455189d2d9)
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 	UVERBS_OBJECT_DMAH,
59 	UVERBS_OBJECT_DMABUF,
60 };
61 
62 enum {
63 	UVERBS_ID_DRIVER_NS = 1UL << UVERBS_ID_NS_SHIFT,
64 	UVERBS_ATTR_UHW_IN = UVERBS_ID_DRIVER_NS,
65 	UVERBS_ATTR_UHW_OUT,
66 	UVERBS_ID_DRIVER_NS_WITH_UHW,
67 };
68 
69 enum uverbs_methods_device {
70 	UVERBS_METHOD_INVOKE_WRITE,
71 	UVERBS_METHOD_INFO_HANDLES,
72 	UVERBS_METHOD_QUERY_PORT,
73 	UVERBS_METHOD_GET_CONTEXT,
74 	UVERBS_METHOD_QUERY_CONTEXT,
75 	UVERBS_METHOD_QUERY_GID_TABLE,
76 	UVERBS_METHOD_QUERY_GID_ENTRY,
77 	UVERBS_METHOD_QUERY_PORT_SPEED,
78 };
79 
80 enum uverbs_attrs_invoke_write_cmd_attr_ids {
81 	UVERBS_ATTR_CORE_IN,
82 	UVERBS_ATTR_CORE_OUT,
83 	UVERBS_ATTR_WRITE_CMD,
84 };
85 
86 enum uverbs_attrs_query_port_cmd_attr_ids {
87 	UVERBS_ATTR_QUERY_PORT_PORT_NUM,
88 	UVERBS_ATTR_QUERY_PORT_RESP,
89 };
90 
91 enum uverbs_attrs_query_port_speed_cmd_attr_ids {
92 	UVERBS_ATTR_QUERY_PORT_SPEED_PORT_NUM,
93 	UVERBS_ATTR_QUERY_PORT_SPEED_RESP,
94 };
95 
96 enum uverbs_attrs_get_context_attr_ids {
97 	UVERBS_ATTR_GET_CONTEXT_NUM_COMP_VECTORS,
98 	UVERBS_ATTR_GET_CONTEXT_CORE_SUPPORT,
99 	UVERBS_ATTR_GET_CONTEXT_FD_ARR,
100 };
101 
102 enum uverbs_attrs_query_context_attr_ids {
103 	UVERBS_ATTR_QUERY_CONTEXT_NUM_COMP_VECTORS,
104 	UVERBS_ATTR_QUERY_CONTEXT_CORE_SUPPORT,
105 };
106 
107 enum uverbs_attrs_create_cq_cmd_attr_ids {
108 	UVERBS_ATTR_CREATE_CQ_HANDLE,
109 	UVERBS_ATTR_CREATE_CQ_CQE,
110 	UVERBS_ATTR_CREATE_CQ_USER_HANDLE,
111 	UVERBS_ATTR_CREATE_CQ_COMP_CHANNEL,
112 	UVERBS_ATTR_CREATE_CQ_COMP_VECTOR,
113 	UVERBS_ATTR_CREATE_CQ_FLAGS,
114 	UVERBS_ATTR_CREATE_CQ_RESP_CQE,
115 	UVERBS_ATTR_CREATE_CQ_EVENT_FD,
116 	UVERBS_ATTR_CREATE_CQ_BUFFER_VA,
117 	UVERBS_ATTR_CREATE_CQ_BUFFER_LENGTH,
118 	UVERBS_ATTR_CREATE_CQ_BUFFER_FD,
119 	UVERBS_ATTR_CREATE_CQ_BUFFER_OFFSET,
120 };
121 
122 enum uverbs_attrs_destroy_cq_cmd_attr_ids {
123 	UVERBS_ATTR_DESTROY_CQ_HANDLE,
124 	UVERBS_ATTR_DESTROY_CQ_RESP,
125 };
126 
127 enum uverbs_attrs_create_flow_action_esp {
128 	UVERBS_ATTR_CREATE_FLOW_ACTION_ESP_HANDLE,
129 	UVERBS_ATTR_FLOW_ACTION_ESP_ATTRS,
130 	UVERBS_ATTR_FLOW_ACTION_ESP_ESN,
131 	UVERBS_ATTR_FLOW_ACTION_ESP_KEYMAT,
132 	UVERBS_ATTR_FLOW_ACTION_ESP_REPLAY,
133 	UVERBS_ATTR_FLOW_ACTION_ESP_ENCAP,
134 };
135 
136 enum uverbs_attrs_modify_flow_action_esp {
137 	UVERBS_ATTR_MODIFY_FLOW_ACTION_ESP_HANDLE =
138 		UVERBS_ATTR_CREATE_FLOW_ACTION_ESP_HANDLE,
139 };
140 
141 enum uverbs_attrs_destroy_flow_action_esp {
142 	UVERBS_ATTR_DESTROY_FLOW_ACTION_HANDLE,
143 };
144 
145 enum uverbs_attrs_create_qp_cmd_attr_ids {
146 	UVERBS_ATTR_CREATE_QP_HANDLE,
147 	UVERBS_ATTR_CREATE_QP_XRCD_HANDLE,
148 	UVERBS_ATTR_CREATE_QP_PD_HANDLE,
149 	UVERBS_ATTR_CREATE_QP_SRQ_HANDLE,
150 	UVERBS_ATTR_CREATE_QP_SEND_CQ_HANDLE,
151 	UVERBS_ATTR_CREATE_QP_RECV_CQ_HANDLE,
152 	UVERBS_ATTR_CREATE_QP_IND_TABLE_HANDLE,
153 	UVERBS_ATTR_CREATE_QP_USER_HANDLE,
154 	UVERBS_ATTR_CREATE_QP_CAP,
155 	UVERBS_ATTR_CREATE_QP_TYPE,
156 	UVERBS_ATTR_CREATE_QP_FLAGS,
157 	UVERBS_ATTR_CREATE_QP_SOURCE_QPN,
158 	UVERBS_ATTR_CREATE_QP_EVENT_FD,
159 	UVERBS_ATTR_CREATE_QP_RESP_CAP,
160 	UVERBS_ATTR_CREATE_QP_RESP_QP_NUM,
161 };
162 
163 enum uverbs_attrs_destroy_qp_cmd_attr_ids {
164 	UVERBS_ATTR_DESTROY_QP_HANDLE,
165 	UVERBS_ATTR_DESTROY_QP_RESP,
166 };
167 
168 enum uverbs_methods_qp {
169 	UVERBS_METHOD_QP_CREATE,
170 	UVERBS_METHOD_QP_DESTROY,
171 };
172 
173 enum uverbs_attrs_create_srq_cmd_attr_ids {
174 	UVERBS_ATTR_CREATE_SRQ_HANDLE,
175 	UVERBS_ATTR_CREATE_SRQ_PD_HANDLE,
176 	UVERBS_ATTR_CREATE_SRQ_XRCD_HANDLE,
177 	UVERBS_ATTR_CREATE_SRQ_CQ_HANDLE,
178 	UVERBS_ATTR_CREATE_SRQ_USER_HANDLE,
179 	UVERBS_ATTR_CREATE_SRQ_MAX_WR,
180 	UVERBS_ATTR_CREATE_SRQ_MAX_SGE,
181 	UVERBS_ATTR_CREATE_SRQ_LIMIT,
182 	UVERBS_ATTR_CREATE_SRQ_MAX_NUM_TAGS,
183 	UVERBS_ATTR_CREATE_SRQ_TYPE,
184 	UVERBS_ATTR_CREATE_SRQ_EVENT_FD,
185 	UVERBS_ATTR_CREATE_SRQ_RESP_MAX_WR,
186 	UVERBS_ATTR_CREATE_SRQ_RESP_MAX_SGE,
187 	UVERBS_ATTR_CREATE_SRQ_RESP_SRQ_NUM,
188 };
189 
190 enum uverbs_attrs_destroy_srq_cmd_attr_ids {
191 	UVERBS_ATTR_DESTROY_SRQ_HANDLE,
192 	UVERBS_ATTR_DESTROY_SRQ_RESP,
193 };
194 
195 enum uverbs_methods_srq {
196 	UVERBS_METHOD_SRQ_CREATE,
197 	UVERBS_METHOD_SRQ_DESTROY,
198 };
199 
200 enum uverbs_methods_cq {
201 	UVERBS_METHOD_CQ_CREATE,
202 	UVERBS_METHOD_CQ_DESTROY,
203 };
204 
205 enum uverbs_attrs_create_wq_cmd_attr_ids {
206 	UVERBS_ATTR_CREATE_WQ_HANDLE,
207 	UVERBS_ATTR_CREATE_WQ_PD_HANDLE,
208 	UVERBS_ATTR_CREATE_WQ_CQ_HANDLE,
209 	UVERBS_ATTR_CREATE_WQ_USER_HANDLE,
210 	UVERBS_ATTR_CREATE_WQ_TYPE,
211 	UVERBS_ATTR_CREATE_WQ_EVENT_FD,
212 	UVERBS_ATTR_CREATE_WQ_MAX_WR,
213 	UVERBS_ATTR_CREATE_WQ_MAX_SGE,
214 	UVERBS_ATTR_CREATE_WQ_FLAGS,
215 	UVERBS_ATTR_CREATE_WQ_RESP_MAX_WR,
216 	UVERBS_ATTR_CREATE_WQ_RESP_MAX_SGE,
217 	UVERBS_ATTR_CREATE_WQ_RESP_WQ_NUM,
218 };
219 
220 enum uverbs_attrs_destroy_wq_cmd_attr_ids {
221 	UVERBS_ATTR_DESTROY_WQ_HANDLE,
222 	UVERBS_ATTR_DESTROY_WQ_RESP,
223 };
224 
225 enum uverbs_methods_wq {
226 	UVERBS_METHOD_WQ_CREATE,
227 	UVERBS_METHOD_WQ_DESTROY,
228 };
229 
230 enum uverbs_methods_actions_flow_action_ops {
231 	UVERBS_METHOD_FLOW_ACTION_ESP_CREATE,
232 	UVERBS_METHOD_FLOW_ACTION_DESTROY,
233 	UVERBS_METHOD_FLOW_ACTION_ESP_MODIFY,
234 };
235 
236 enum uverbs_attrs_alloc_dm_cmd_attr_ids {
237 	UVERBS_ATTR_ALLOC_DM_HANDLE,
238 	UVERBS_ATTR_ALLOC_DM_LENGTH,
239 	UVERBS_ATTR_ALLOC_DM_ALIGNMENT,
240 };
241 
242 enum uverbs_attrs_free_dm_cmd_attr_ids {
243 	UVERBS_ATTR_FREE_DM_HANDLE,
244 };
245 
246 enum uverbs_methods_dm {
247 	UVERBS_METHOD_DM_ALLOC,
248 	UVERBS_METHOD_DM_FREE,
249 };
250 
251 enum uverbs_attrs_alloc_dmah_cmd_attr_ids {
252 	UVERBS_ATTR_ALLOC_DMAH_HANDLE,
253 	UVERBS_ATTR_ALLOC_DMAH_CPU_ID,
254 	UVERBS_ATTR_ALLOC_DMAH_TPH_MEM_TYPE,
255 	UVERBS_ATTR_ALLOC_DMAH_PH,
256 };
257 
258 enum uverbs_attrs_free_dmah_cmd_attr_ids {
259 	UVERBS_ATTR_FREE_DMA_HANDLE,
260 };
261 
262 enum uverbs_methods_dmah {
263 	UVERBS_METHOD_DMAH_ALLOC,
264 	UVERBS_METHOD_DMAH_FREE,
265 };
266 
267 enum uverbs_attrs_alloc_dmabuf_cmd_attr_ids {
268 	UVERBS_ATTR_ALLOC_DMABUF_HANDLE,
269 	UVERBS_ATTR_ALLOC_DMABUF_PGOFF,
270 };
271 
272 enum uverbs_methods_dmabuf {
273 	UVERBS_METHOD_DMABUF_ALLOC,
274 };
275 
276 enum uverbs_attrs_reg_dm_mr_cmd_attr_ids {
277 	UVERBS_ATTR_REG_DM_MR_HANDLE,
278 	UVERBS_ATTR_REG_DM_MR_OFFSET,
279 	UVERBS_ATTR_REG_DM_MR_LENGTH,
280 	UVERBS_ATTR_REG_DM_MR_PD_HANDLE,
281 	UVERBS_ATTR_REG_DM_MR_ACCESS_FLAGS,
282 	UVERBS_ATTR_REG_DM_MR_DM_HANDLE,
283 	UVERBS_ATTR_REG_DM_MR_RESP_LKEY,
284 	UVERBS_ATTR_REG_DM_MR_RESP_RKEY,
285 };
286 
287 enum uverbs_methods_mr {
288 	UVERBS_METHOD_DM_MR_REG,
289 	UVERBS_METHOD_MR_DESTROY,
290 	UVERBS_METHOD_ADVISE_MR,
291 	UVERBS_METHOD_QUERY_MR,
292 	UVERBS_METHOD_REG_DMABUF_MR,
293 	UVERBS_METHOD_REG_MR,
294 };
295 
296 enum uverbs_attrs_mr_destroy_ids {
297 	UVERBS_ATTR_DESTROY_MR_HANDLE,
298 };
299 
300 enum uverbs_attrs_advise_mr_cmd_attr_ids {
301 	UVERBS_ATTR_ADVISE_MR_PD_HANDLE,
302 	UVERBS_ATTR_ADVISE_MR_ADVICE,
303 	UVERBS_ATTR_ADVISE_MR_FLAGS,
304 	UVERBS_ATTR_ADVISE_MR_SGE_LIST,
305 };
306 
307 enum uverbs_attrs_query_mr_cmd_attr_ids {
308 	UVERBS_ATTR_QUERY_MR_HANDLE,
309 	UVERBS_ATTR_QUERY_MR_RESP_LKEY,
310 	UVERBS_ATTR_QUERY_MR_RESP_RKEY,
311 	UVERBS_ATTR_QUERY_MR_RESP_LENGTH,
312 	UVERBS_ATTR_QUERY_MR_RESP_IOVA,
313 };
314 
315 enum uverbs_attrs_reg_dmabuf_mr_cmd_attr_ids {
316 	UVERBS_ATTR_REG_DMABUF_MR_HANDLE,
317 	UVERBS_ATTR_REG_DMABUF_MR_PD_HANDLE,
318 	UVERBS_ATTR_REG_DMABUF_MR_OFFSET,
319 	UVERBS_ATTR_REG_DMABUF_MR_LENGTH,
320 	UVERBS_ATTR_REG_DMABUF_MR_IOVA,
321 	UVERBS_ATTR_REG_DMABUF_MR_FD,
322 	UVERBS_ATTR_REG_DMABUF_MR_ACCESS_FLAGS,
323 	UVERBS_ATTR_REG_DMABUF_MR_RESP_LKEY,
324 	UVERBS_ATTR_REG_DMABUF_MR_RESP_RKEY,
325 };
326 
327 enum uverbs_attrs_reg_mr_cmd_attr_ids {
328 	UVERBS_ATTR_REG_MR_HANDLE,
329 	UVERBS_ATTR_REG_MR_PD_HANDLE,
330 	UVERBS_ATTR_REG_MR_DMA_HANDLE,
331 	UVERBS_ATTR_REG_MR_IOVA,
332 	UVERBS_ATTR_REG_MR_ADDR,
333 	UVERBS_ATTR_REG_MR_LENGTH,
334 	UVERBS_ATTR_REG_MR_ACCESS_FLAGS,
335 	UVERBS_ATTR_REG_MR_FD,
336 	UVERBS_ATTR_REG_MR_FD_OFFSET,
337 	UVERBS_ATTR_REG_MR_RESP_LKEY,
338 	UVERBS_ATTR_REG_MR_RESP_RKEY,
339 };
340 
341 enum uverbs_attrs_create_counters_cmd_attr_ids {
342 	UVERBS_ATTR_CREATE_COUNTERS_HANDLE,
343 };
344 
345 enum uverbs_attrs_destroy_counters_cmd_attr_ids {
346 	UVERBS_ATTR_DESTROY_COUNTERS_HANDLE,
347 };
348 
349 enum uverbs_attrs_read_counters_cmd_attr_ids {
350 	UVERBS_ATTR_READ_COUNTERS_HANDLE,
351 	UVERBS_ATTR_READ_COUNTERS_BUFF,
352 	UVERBS_ATTR_READ_COUNTERS_FLAGS,
353 };
354 
355 enum uverbs_methods_actions_counters_ops {
356 	UVERBS_METHOD_COUNTERS_CREATE,
357 	UVERBS_METHOD_COUNTERS_DESTROY,
358 	UVERBS_METHOD_COUNTERS_READ,
359 };
360 
361 enum uverbs_attrs_info_handles_id {
362 	UVERBS_ATTR_INFO_OBJECT_ID,
363 	UVERBS_ATTR_INFO_TOTAL_HANDLES,
364 	UVERBS_ATTR_INFO_HANDLES_LIST,
365 };
366 
367 enum uverbs_methods_pd {
368 	UVERBS_METHOD_PD_DESTROY,
369 };
370 
371 enum uverbs_attrs_pd_destroy_ids {
372 	UVERBS_ATTR_DESTROY_PD_HANDLE,
373 };
374 
375 enum uverbs_methods_mw {
376 	UVERBS_METHOD_MW_DESTROY,
377 };
378 
379 enum uverbs_attrs_mw_destroy_ids {
380 	UVERBS_ATTR_DESTROY_MW_HANDLE,
381 };
382 
383 enum uverbs_methods_xrcd {
384 	UVERBS_METHOD_XRCD_DESTROY,
385 };
386 
387 enum uverbs_attrs_xrcd_destroy_ids {
388 	UVERBS_ATTR_DESTROY_XRCD_HANDLE,
389 };
390 
391 enum uverbs_methods_ah {
392 	UVERBS_METHOD_AH_DESTROY,
393 };
394 
395 enum uverbs_attrs_ah_destroy_ids {
396 	UVERBS_ATTR_DESTROY_AH_HANDLE,
397 };
398 
399 enum uverbs_methods_rwq_ind_tbl {
400 	UVERBS_METHOD_RWQ_IND_TBL_DESTROY,
401 };
402 
403 enum uverbs_attrs_rwq_ind_tbl_destroy_ids {
404 	UVERBS_ATTR_DESTROY_RWQ_IND_TBL_HANDLE,
405 };
406 
407 enum uverbs_methods_flow {
408 	UVERBS_METHOD_FLOW_DESTROY,
409 };
410 
411 enum uverbs_attrs_flow_destroy_ids {
412 	UVERBS_ATTR_DESTROY_FLOW_HANDLE,
413 };
414 
415 enum uverbs_method_async_event {
416 	UVERBS_METHOD_ASYNC_EVENT_ALLOC,
417 };
418 
419 enum uverbs_attrs_async_event_create {
420 	UVERBS_ATTR_ASYNC_EVENT_ALLOC_FD_HANDLE,
421 };
422 
423 enum uverbs_attrs_query_gid_table_cmd_attr_ids {
424 	UVERBS_ATTR_QUERY_GID_TABLE_ENTRY_SIZE,
425 	UVERBS_ATTR_QUERY_GID_TABLE_FLAGS,
426 	UVERBS_ATTR_QUERY_GID_TABLE_RESP_ENTRIES,
427 	UVERBS_ATTR_QUERY_GID_TABLE_RESP_NUM_ENTRIES,
428 };
429 
430 enum uverbs_attrs_query_gid_entry_cmd_attr_ids {
431 	UVERBS_ATTR_QUERY_GID_ENTRY_PORT,
432 	UVERBS_ATTR_QUERY_GID_ENTRY_GID_INDEX,
433 	UVERBS_ATTR_QUERY_GID_ENTRY_FLAGS,
434 	UVERBS_ATTR_QUERY_GID_ENTRY_RESP_ENTRY,
435 };
436 
437 #endif
438