xref: /freebsd/sys/ofed/include/uapi/rdma/ib_user_ioctl_verbs.h (revision 744bfb213144c63cbaf38d91a1c4f7aebb9b9fbc)
1 /* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR Linux-OpenIB) */
2 /*
3  * Copyright (c) 2017-2018, Mellanox Technologies inc.  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_VERBS_H
35 #define IB_USER_IOCTL_VERBS_H
36 
37 #include <linux/types.h>
38 #include <rdma/ib_user_verbs.h>
39 
40 #ifndef RDMA_UAPI_PTR
41 #define RDMA_UAPI_PTR(_type, _name)	__aligned_u64 _name
42 #endif
43 
44 #define IB_UVERBS_ACCESS_OPTIONAL_FIRST (1 << 20)
45 #define IB_UVERBS_ACCESS_OPTIONAL_LAST (1 << 29)
46 
47 enum ib_uverbs_core_support {
48 	IB_UVERBS_CORE_SUPPORT_OPTIONAL_MR_ACCESS = 1 << 0,
49 };
50 
51 enum ib_uverbs_access_flags {
52 	IB_UVERBS_ACCESS_LOCAL_WRITE = 1 << 0,
53 	IB_UVERBS_ACCESS_REMOTE_WRITE = 1 << 1,
54 	IB_UVERBS_ACCESS_REMOTE_READ = 1 << 2,
55 	IB_UVERBS_ACCESS_REMOTE_ATOMIC = 1 << 3,
56 	IB_UVERBS_ACCESS_MW_BIND = 1 << 4,
57 	IB_UVERBS_ACCESS_ZERO_BASED = 1 << 5,
58 	IB_UVERBS_ACCESS_ON_DEMAND = 1 << 6,
59 	IB_UVERBS_ACCESS_HUGETLB = 1 << 7,
60 
61 	IB_UVERBS_ACCESS_RELAXED_ORDERING = IB_UVERBS_ACCESS_OPTIONAL_FIRST,
62 	IB_UVERBS_ACCESS_OPTIONAL_RANGE =
63 		((IB_UVERBS_ACCESS_OPTIONAL_LAST << 1) - 1) &
64 		~(IB_UVERBS_ACCESS_OPTIONAL_FIRST - 1)
65 };
66 
67 enum ib_uverbs_query_port_cap_flags {
68 	IB_UVERBS_PCF_SM = 1 << 1,
69 	IB_UVERBS_PCF_NOTICE_SUP = 1 << 2,
70 	IB_UVERBS_PCF_TRAP_SUP = 1 << 3,
71 	IB_UVERBS_PCF_OPT_IPD_SUP = 1 << 4,
72 	IB_UVERBS_PCF_AUTO_MIGR_SUP = 1 << 5,
73 	IB_UVERBS_PCF_SL_MAP_SUP = 1 << 6,
74 	IB_UVERBS_PCF_MKEY_NVRAM = 1 << 7,
75 	IB_UVERBS_PCF_PKEY_NVRAM = 1 << 8,
76 	IB_UVERBS_PCF_LED_INFO_SUP = 1 << 9,
77 	IB_UVERBS_PCF_SM_DISABLED = 1 << 10,
78 	IB_UVERBS_PCF_SYS_IMAGE_GUID_SUP = 1 << 11,
79 	IB_UVERBS_PCF_PKEY_SW_EXT_PORT_TRAP_SUP = 1 << 12,
80 	IB_UVERBS_PCF_EXTENDED_SPEEDS_SUP = 1 << 14,
81 	IB_UVERBS_PCF_CM_SUP = 1 << 16,
82 	IB_UVERBS_PCF_SNMP_TUNNEL_SUP = 1 << 17,
83 	IB_UVERBS_PCF_REINIT_SUP = 1 << 18,
84 	IB_UVERBS_PCF_DEVICE_MGMT_SUP = 1 << 19,
85 	IB_UVERBS_PCF_VENDOR_CLASS_SUP = 1 << 20,
86 	IB_UVERBS_PCF_DR_NOTICE_SUP = 1 << 21,
87 	IB_UVERBS_PCF_CAP_MASK_NOTICE_SUP = 1 << 22,
88 	IB_UVERBS_PCF_BOOT_MGMT_SUP = 1 << 23,
89 	IB_UVERBS_PCF_LINK_LATENCY_SUP = 1 << 24,
90 	IB_UVERBS_PCF_CLIENT_REG_SUP = 1 << 25,
91 	/*
92 	 * IsOtherLocalChangesNoticeSupported is aliased by IP_BASED_GIDS and
93 	 * is inaccessible
94 	 */
95 	IB_UVERBS_PCF_LINK_SPEED_WIDTH_TABLE_SUP = 1 << 27,
96 	IB_UVERBS_PCF_VENDOR_SPECIFIC_MADS_TABLE_SUP = 1 << 28,
97 	IB_UVERBS_PCF_MCAST_PKEY_TRAP_SUPPRESSION_SUP = 1 << 29,
98 	IB_UVERBS_PCF_MCAST_FDB_TOP_SUP = 1 << 30,
99 	IB_UVERBS_PCF_HIERARCHY_INFO_SUP = 1ULL << 31,
100 
101 	/* NOTE this is an internal flag, not an IBA flag */
102 	IB_UVERBS_PCF_IP_BASED_GIDS = 1 << 26,
103 };
104 
105 enum ib_uverbs_query_port_flags {
106 	IB_UVERBS_QPF_GRH_REQUIRED = 1 << 0,
107 };
108 
109 enum ib_uverbs_flow_action_esp_keymat {
110 	IB_UVERBS_FLOW_ACTION_ESP_KEYMAT_AES_GCM,
111 };
112 
113 enum ib_uverbs_flow_action_esp_keymat_aes_gcm_iv_algo {
114 	IB_UVERBS_FLOW_ACTION_IV_ALGO_SEQ,
115 };
116 
117 struct ib_uverbs_flow_action_esp_keymat_aes_gcm {
118 	__aligned_u64	iv;
119 	__u32		iv_algo; /* Use enum ib_uverbs_flow_action_esp_keymat_aes_gcm_iv_algo */
120 
121 	__u32		salt;
122 	__u32		icv_len;
123 
124 	__u32		key_len;
125 	__u32		aes_key[256 / 32];
126 };
127 
128 enum ib_uverbs_flow_action_esp_replay {
129 	IB_UVERBS_FLOW_ACTION_ESP_REPLAY_NONE,
130 	IB_UVERBS_FLOW_ACTION_ESP_REPLAY_BMP,
131 };
132 
133 struct ib_uverbs_flow_action_esp_replay_bmp {
134 	__u32	size;
135 };
136 
137 enum ib_uverbs_flow_action_esp_flags {
138 	IB_UVERBS_FLOW_ACTION_ESP_FLAGS_INLINE_CRYPTO	= 0UL << 0,	/* Default */
139 	IB_UVERBS_FLOW_ACTION_ESP_FLAGS_FULL_OFFLOAD	= 1UL << 0,
140 
141 	IB_UVERBS_FLOW_ACTION_ESP_FLAGS_TUNNEL		= 0UL << 1,	/* Default */
142 	IB_UVERBS_FLOW_ACTION_ESP_FLAGS_TRANSPORT	= 1UL << 1,
143 
144 	IB_UVERBS_FLOW_ACTION_ESP_FLAGS_DECRYPT		= 0UL << 2,	/* Default */
145 	IB_UVERBS_FLOW_ACTION_ESP_FLAGS_ENCRYPT		= 1UL << 2,
146 
147 	IB_UVERBS_FLOW_ACTION_ESP_FLAGS_ESN_NEW_WINDOW	= 1UL << 3,
148 };
149 
150 struct ib_uverbs_flow_action_esp_encap {
151 	/* This struct represents a list of pointers to flow_xxxx_filter that
152 	 * encapsulates the payload in ESP tunnel mode.
153 	 */
154 	RDMA_UAPI_PTR(void *, val_ptr); /* pointer to a flow_xxxx_filter */
155 	RDMA_UAPI_PTR(struct ib_uverbs_flow_action_esp_encap *, next_ptr);
156 	__u16	len;		/* Len of the filter struct val_ptr points to */
157 	__u16	type;		/* Use flow_spec_type enum */
158 };
159 
160 struct ib_uverbs_flow_action_esp {
161 	__u32		spi;
162 	__u32		seq;
163 	__u32		tfc_pad;
164 	__u32		flags;
165 	__aligned_u64	hard_limit_pkts;
166 };
167 
168 enum ib_uverbs_read_counters_flags {
169 	/* prefer read values from driver cache */
170 	IB_UVERBS_READ_COUNTERS_PREFER_CACHED = 1 << 0,
171 };
172 
173 enum ib_uverbs_advise_mr_advice {
174 	IB_UVERBS_ADVISE_MR_ADVICE_PREFETCH,
175 	IB_UVERBS_ADVISE_MR_ADVICE_PREFETCH_WRITE,
176 };
177 
178 enum ib_uverbs_advise_mr_flag {
179 	IB_UVERBS_ADVISE_MR_FLAG_FLUSH = 1 << 0,
180 };
181 
182 struct ib_uverbs_query_port_resp_ex {
183 	struct ib_uverbs_query_port_resp legacy_resp;
184 	__u16 port_cap_flags2;
185 	__u8  reserved[6];
186 };
187 
188 enum rdma_driver_id {
189 	RDMA_DRIVER_UNKNOWN,
190 	RDMA_DRIVER_MLX5,
191 	RDMA_DRIVER_MLX4,
192 	RDMA_DRIVER_CXGB3,
193 	RDMA_DRIVER_CXGB4,
194 	RDMA_DRIVER_MTHCA,
195 	RDMA_DRIVER_BNXT_RE,
196 	RDMA_DRIVER_OCRDMA,
197 	RDMA_DRIVER_NES,
198 	RDMA_DRIVER_I40IW,
199 	RDMA_DRIVER_VMW_PVRDMA,
200 	RDMA_DRIVER_QEDR,
201 	RDMA_DRIVER_HNS,
202 	RDMA_DRIVER_USNIC,
203 	RDMA_DRIVER_RXE,
204 	RDMA_DRIVER_HFI1,
205 	RDMA_DRIVER_QIB,
206 	RDMA_DRIVER_EFA,
207 	RDMA_DRIVER_SIW,
208 	RDMA_DRIVER_QLNXR,
209 };
210 
211 #endif
212