xref: /freebsd/sys/ofed/include/uapi/rdma/rdma_user_ioctl_cmds.h (revision 77013d11e6483b970af25e13c9b892075742f7e5)
1 /*
2  * Copyright (c) 2018, Mellanox Technologies 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 RDMA_USER_IOCTL_CMDS_H
34 #define RDMA_USER_IOCTL_CMDS_H
35 
36 #ifdef _KERNEL
37 #include <linux/types.h>
38 #include <linux/ioctl.h>
39 #else
40 #include <infiniband/types.h>
41 #include <sys/ioccom.h>
42 #endif
43 
44 /* Documentation/ioctl/ioctl-number.rst */
45 #define RDMA_IOCTL_MAGIC	0x1b
46 #define RDMA_VERBS_IOCTL \
47 	_IOWR(RDMA_IOCTL_MAGIC, 1, struct ib_uverbs_ioctl_hdr)
48 
49 enum {
50 	/* User input */
51 	UVERBS_ATTR_F_MANDATORY = 1U << 0,
52 	/*
53 	 * Valid output bit should be ignored and considered set in
54 	 * mandatory fields. This bit is kernel output.
55 	 */
56 	UVERBS_ATTR_F_VALID_OUTPUT = 1U << 1,
57 };
58 
59 struct ib_uverbs_attr {
60 	__u16 attr_id;		/* command specific type attribute */
61 	__u16 len;		/* only for pointers and IDRs array */
62 	__u16 flags;		/* combination of UVERBS_ATTR_F_XXXX */
63 	union {
64 		struct {
65 			__u8 elem_id;
66 			__u8 reserved;
67 		} enum_data;
68 		__u16 reserved;
69 	} attr_data;
70 	union {
71 		/*
72 		 * ptr to command, inline data, idr/fd or
73 		 * ptr to __u32 array of IDRs
74 		 */
75 		__aligned_u64 data;
76 		/* Used by FD_IN and FD_OUT */
77 		__s64 data_s64;
78 	};
79 };
80 
81 struct ib_uverbs_ioctl_hdr {
82 	__u16 length;
83 	__u16 object_id;
84 	__u16 method_id;
85 	__u16 num_attrs;
86 	__aligned_u64 reserved1;
87 	__u32 driver_id;
88 	__u32 reserved2;
89 	struct ib_uverbs_attr  attrs[0];
90 };
91 
92 #endif
93