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