xref: /OK3568_Linux_fs/kernel/include/uapi/rdma/rdma_user_ioctl_cmds.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*
2*4882a593Smuzhiyun  * Copyright (c) 2018, Mellanox Technologies inc.  All rights reserved.
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * This software is available to you under a choice of one of two
5*4882a593Smuzhiyun  * licenses.  You may choose to be licensed under the terms of the GNU
6*4882a593Smuzhiyun  * General Public License (GPL) Version 2, available from the file
7*4882a593Smuzhiyun  * COPYING in the main directory of this source tree, or the
8*4882a593Smuzhiyun  * OpenIB.org BSD license below:
9*4882a593Smuzhiyun  *
10*4882a593Smuzhiyun  *     Redistribution and use in source and binary forms, with or
11*4882a593Smuzhiyun  *     without modification, are permitted provided that the following
12*4882a593Smuzhiyun  *     conditions are met:
13*4882a593Smuzhiyun  *
14*4882a593Smuzhiyun  *      - Redistributions of source code must retain the above
15*4882a593Smuzhiyun  *        copyright notice, this list of conditions and the following
16*4882a593Smuzhiyun  *        disclaimer.
17*4882a593Smuzhiyun  *
18*4882a593Smuzhiyun  *      - Redistributions in binary form must reproduce the above
19*4882a593Smuzhiyun  *        copyright notice, this list of conditions and the following
20*4882a593Smuzhiyun  *        disclaimer in the documentation and/or other materials
21*4882a593Smuzhiyun  *        provided with the distribution.
22*4882a593Smuzhiyun  *
23*4882a593Smuzhiyun  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24*4882a593Smuzhiyun  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25*4882a593Smuzhiyun  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26*4882a593Smuzhiyun  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27*4882a593Smuzhiyun  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28*4882a593Smuzhiyun  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29*4882a593Smuzhiyun  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30*4882a593Smuzhiyun  * SOFTWARE.
31*4882a593Smuzhiyun  */
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun #ifndef RDMA_USER_IOCTL_CMDS_H
34*4882a593Smuzhiyun #define RDMA_USER_IOCTL_CMDS_H
35*4882a593Smuzhiyun 
36*4882a593Smuzhiyun #include <linux/types.h>
37*4882a593Smuzhiyun #include <linux/ioctl.h>
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun /* Documentation/userspace-api/ioctl/ioctl-number.rst */
40*4882a593Smuzhiyun #define RDMA_IOCTL_MAGIC	0x1b
41*4882a593Smuzhiyun #define RDMA_VERBS_IOCTL \
42*4882a593Smuzhiyun 	_IOWR(RDMA_IOCTL_MAGIC, 1, struct ib_uverbs_ioctl_hdr)
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun enum {
45*4882a593Smuzhiyun 	/* User input */
46*4882a593Smuzhiyun 	UVERBS_ATTR_F_MANDATORY = 1U << 0,
47*4882a593Smuzhiyun 	/*
48*4882a593Smuzhiyun 	 * Valid output bit should be ignored and considered set in
49*4882a593Smuzhiyun 	 * mandatory fields. This bit is kernel output.
50*4882a593Smuzhiyun 	 */
51*4882a593Smuzhiyun 	UVERBS_ATTR_F_VALID_OUTPUT = 1U << 1,
52*4882a593Smuzhiyun };
53*4882a593Smuzhiyun 
54*4882a593Smuzhiyun struct ib_uverbs_attr {
55*4882a593Smuzhiyun 	__u16 attr_id;		/* command specific type attribute */
56*4882a593Smuzhiyun 	__u16 len;		/* only for pointers and IDRs array */
57*4882a593Smuzhiyun 	__u16 flags;		/* combination of UVERBS_ATTR_F_XXXX */
58*4882a593Smuzhiyun 	union {
59*4882a593Smuzhiyun 		struct {
60*4882a593Smuzhiyun 			__u8 elem_id;
61*4882a593Smuzhiyun 			__u8 reserved;
62*4882a593Smuzhiyun 		} enum_data;
63*4882a593Smuzhiyun 		__u16 reserved;
64*4882a593Smuzhiyun 	} attr_data;
65*4882a593Smuzhiyun 	union {
66*4882a593Smuzhiyun 		/*
67*4882a593Smuzhiyun 		 * ptr to command, inline data, idr/fd or
68*4882a593Smuzhiyun 		 * ptr to __u32 array of IDRs
69*4882a593Smuzhiyun 		 */
70*4882a593Smuzhiyun 		__aligned_u64 data;
71*4882a593Smuzhiyun 		/* Used by FD_IN and FD_OUT */
72*4882a593Smuzhiyun 		__s64 data_s64;
73*4882a593Smuzhiyun 	};
74*4882a593Smuzhiyun };
75*4882a593Smuzhiyun 
76*4882a593Smuzhiyun struct ib_uverbs_ioctl_hdr {
77*4882a593Smuzhiyun 	__u16 length;
78*4882a593Smuzhiyun 	__u16 object_id;
79*4882a593Smuzhiyun 	__u16 method_id;
80*4882a593Smuzhiyun 	__u16 num_attrs;
81*4882a593Smuzhiyun 	__aligned_u64 reserved1;
82*4882a593Smuzhiyun 	__u32 driver_id;
83*4882a593Smuzhiyun 	__u32 reserved2;
84*4882a593Smuzhiyun 	struct ib_uverbs_attr  attrs[0];
85*4882a593Smuzhiyun };
86*4882a593Smuzhiyun 
87*4882a593Smuzhiyun #endif
88