mlx5-abi.h 11.2 KB
Newer Older
1
/* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR BSD-2-Clause) */
2
/*
3
 * Copyright (c) 2013-2015, Mellanox Technologies. All rights reserved.
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33
 *
 * This software is available to you under a choice of one of two
 * licenses.  You may choose to be licensed under the terms of the GNU
 * General Public License (GPL) Version 2, available from the file
 * COPYING in the main directory of this source tree, or the
 * OpenIB.org BSD license below:
 *
 *     Redistribution and use in source and binary forms, with or
 *     without modification, are permitted provided that the following
 *     conditions are met:
 *
 *      - Redistributions of source code must retain the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer.
 *
 *      - Redistributions in binary form must reproduce the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer in the documentation and/or other materials
 *        provided with the distribution.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

34 35
#ifndef MLX5_ABI_USER_H
#define MLX5_ABI_USER_H
36 37

#include <linux/types.h>
38
#include <linux/if_ether.h>	/* For ETH_ALEN. */
39 40 41 42

enum {
	MLX5_QP_FLAG_SIGNATURE		= 1 << 0,
	MLX5_QP_FLAG_SCATTER_CQE	= 1 << 1,
43
	MLX5_QP_FLAG_TUNNEL_OFFLOADS	= 1 << 2,
44
	MLX5_QP_FLAG_BFREG_INDEX	= 1 << 3,
45 46
	MLX5_QP_FLAG_TYPE_DCT		= 1 << 4,
	MLX5_QP_FLAG_TYPE_DCI		= 1 << 5,
47 48 49 50 51 52
};

enum {
	MLX5_SRQ_FLAG_SIGNATURE		= 1 << 0,
};

53 54 55 56
enum {
	MLX5_WQ_FLAG_SIGNATURE		= 1 << 0,
};

57 58 59 60 61 62 63 64 65 66 67 68 69
/* Increment this value if any changes that break userspace ABI
 * compatibility are made.
 */
#define MLX5_IB_UVERBS_ABI_VERSION	1

/* Make sure that all structs defined in this file remain laid out so
 * that they pack the same way on 32-bit and 64-bit architectures (to
 * avoid incompatibility between 32-bit userspace and 64-bit kernels).
 * In particular do not use pointer types -- pass pointers in __u64
 * instead.
 */

struct mlx5_ib_alloc_ucontext_req {
70 71
	__u32	total_num_bfregs;
	__u32	num_low_latency_bfregs;
72 73
};

E
Eli Cohen 已提交
74
enum mlx5_lib_caps {
75
	MLX5_LIB_CAP_4K_UAR	= (__u64)1 << 0,
E
Eli Cohen 已提交
76 77
};

78
struct mlx5_ib_alloc_ucontext_req_v2 {
79 80
	__u32	total_num_bfregs;
	__u32	num_low_latency_bfregs;
81
	__u32	flags;
82
	__u32	comp_mask;
83 84 85 86
	__u8	max_cqe_version;
	__u8	reserved0;
	__u16	reserved1;
	__u32	reserved2;
87
	__aligned_u64 lib_caps;
88 89 90 91
};

enum mlx5_ib_alloc_ucontext_resp_mask {
	MLX5_IB_ALLOC_UCONTEXT_RESP_MASK_CORE_CLOCK_OFFSET = 1UL << 0,
92 93
};

94 95
enum mlx5_user_cmds_supp_uhw {
	MLX5_USER_CMDS_SUPP_UHW_QUERY_DEVICE = 1 << 0,
96
	MLX5_USER_CMDS_SUPP_UHW_CREATE_AH    = 1 << 1,
97 98
};

99 100 101 102 103 104 105 106 107 108 109
/* The eth_min_inline response value is set to off-by-one vs the FW
 * returned value to allow user-space to deal with older kernels.
 */
enum mlx5_user_inline_mode {
	MLX5_USER_INLINE_MODE_NA,
	MLX5_USER_INLINE_MODE_NONE,
	MLX5_USER_INLINE_MODE_L2,
	MLX5_USER_INLINE_MODE_IP,
	MLX5_USER_INLINE_MODE_TCP_UDP,
};

110 111 112 113 114 115 116 117
enum {
	MLX5_USER_ALLOC_UCONTEXT_FLOW_ACTION_FLAGS_ESP_AES_GCM = 1 << 0,
	MLX5_USER_ALLOC_UCONTEXT_FLOW_ACTION_FLAGS_ESP_AES_GCM_REQ_METADATA = 1 << 1,
	MLX5_USER_ALLOC_UCONTEXT_FLOW_ACTION_FLAGS_ESP_AES_GCM_SPI_STEERING = 1 << 2,
	MLX5_USER_ALLOC_UCONTEXT_FLOW_ACTION_FLAGS_ESP_AES_GCM_FULL_OFFLOAD = 1 << 3,
	MLX5_USER_ALLOC_UCONTEXT_FLOW_ACTION_FLAGS_ESP_AES_GCM_TX_IV_IS_ESN = 1 << 4,
};

118 119 120
struct mlx5_ib_alloc_ucontext_resp {
	__u32	qp_tab_size;
	__u32	bf_reg_size;
121
	__u32	tot_bfregs;
122 123 124 125 126 127 128
	__u32	cache_line_size;
	__u16	max_sq_desc_sz;
	__u16	max_rq_desc_sz;
	__u32	max_send_wqebb;
	__u32	max_recv_wr;
	__u32	max_srq_recv_wr;
	__u16	num_ports;
129
	__u16	flow_action_flags;
130 131
	__u32	comp_mask;
	__u32	response_length;
132
	__u8	cqe_version;
133
	__u8	cmds_supp_uhw;
134
	__u8	eth_min_inline;
135
	__u8	clock_info_versions;
136
	__aligned_u64 hca_core_clock_offset;
E
Eli Cohen 已提交
137 138
	__u32	log_uar_size;
	__u32	num_uars_per_page;
139 140
	__u32	num_dyn_bfregs;
	__u32	reserved3;
141 142 143 144 145 146
};

struct mlx5_ib_alloc_pd_resp {
	__u32	pdn;
};

147 148 149 150 151 152 153 154 155 156
struct mlx5_ib_tso_caps {
	__u32 max_tso; /* Maximum tso payload size in bytes */

	/* Corresponding bit will be set if qp type from
	 * 'enum ib_qp_type' is supported, e.g.
	 * supported_qpts |= 1 << IB_QPT_UD
	 */
	__u32 supported_qpts;
};

157
struct mlx5_ib_rss_caps {
158
	__aligned_u64 rx_hash_fields_mask; /* enum mlx5_rx_hash_fields */
159 160 161 162
	__u8 rx_hash_function; /* enum mlx5_rx_hash_function_flags */
	__u8 reserved[7];
};

163 164 165 166 167 168 169 170 171 172 173
enum mlx5_ib_cqe_comp_res_format {
	MLX5_IB_CQE_RES_FORMAT_HASH	= 1 << 0,
	MLX5_IB_CQE_RES_FORMAT_CSUM	= 1 << 1,
	MLX5_IB_CQE_RES_RESERVED	= 1 << 2,
};

struct mlx5_ib_cqe_comp_caps {
	__u32 max_num;
	__u32 supported_format; /* enum mlx5_ib_cqe_comp_res_format */
};

174 175 176 177
enum mlx5_ib_packet_pacing_cap_flags {
	MLX5_IB_PP_SUPPORT_BURST	= 1 << 0,
};

178 179 180 181 182 183 184 185 186
struct mlx5_packet_pacing_caps {
	__u32 qp_rate_limit_min;
	__u32 qp_rate_limit_max; /* In kpbs */

	/* Corresponding bit will be set if qp type from
	 * 'enum ib_qp_type' is supported, e.g.
	 * supported_qpts |= 1 << IB_QPT_RAW_PACKET
	 */
	__u32 supported_qpts;
187 188
	__u8  cap_flags; /* enum mlx5_ib_packet_pacing_cap_flags */
	__u8  reserved[3];
189 190
};

191 192 193
enum mlx5_ib_mpw_caps {
	MPW_RESERVED		= 1 << 0,
	MLX5_IB_ALLOW_MPW	= 1 << 1,
194
	MLX5_IB_SUPPORT_EMPW	= 1 << 2,
195 196
};

197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212
enum mlx5_ib_sw_parsing_offloads {
	MLX5_IB_SW_PARSING = 1 << 0,
	MLX5_IB_SW_PARSING_CSUM = 1 << 1,
	MLX5_IB_SW_PARSING_LSO = 1 << 2,
};

struct mlx5_ib_sw_parsing_caps {
	__u32 sw_parsing_offloads; /* enum mlx5_ib_sw_parsing_offloads */

	/* Corresponding bit will be set if qp type from
	 * 'enum ib_qp_type' is supported, e.g.
	 * supported_qpts |= 1 << IB_QPT_RAW_PACKET
	 */
	__u32 supported_qpts;
};

213 214 215 216 217 218 219 220 221 222 223
struct mlx5_ib_striding_rq_caps {
	__u32 min_single_stride_log_num_of_bytes;
	__u32 max_single_stride_log_num_of_bytes;
	__u32 min_single_wqe_log_num_of_strides;
	__u32 max_single_wqe_log_num_of_strides;

	/* Corresponding bit will be set if qp type from
	 * 'enum ib_qp_type' is supported, e.g.
	 * supported_qpts |= 1 << IB_QPT_RAW_PACKET
	 */
	__u32 supported_qpts;
224
	__u32 reserved;
225 226
};

227 228 229
enum mlx5_ib_query_dev_resp_flags {
	/* Support 128B CQE compression */
	MLX5_IB_QUERY_DEV_RESP_FLAGS_CQE_128B_COMP = 1 << 0,
230
	MLX5_IB_QUERY_DEV_RESP_FLAGS_CQE_128B_PAD  = 1 << 1,
231 232
};

233 234 235 236 237 238
enum mlx5_ib_tunnel_offloads {
	MLX5_IB_TUNNELED_OFFLOADS_VXLAN  = 1 << 0,
	MLX5_IB_TUNNELED_OFFLOADS_GRE    = 1 << 1,
	MLX5_IB_TUNNELED_OFFLOADS_GENEVE = 1 << 2
};

239 240 241 242
struct mlx5_ib_query_device_resp {
	__u32	comp_mask;
	__u32	response_length;
	struct	mlx5_ib_tso_caps tso_caps;
243
	struct	mlx5_ib_rss_caps rss_caps;
244
	struct	mlx5_ib_cqe_comp_caps cqe_comp_caps;
245
	struct	mlx5_packet_pacing_caps packet_pacing_caps;
246
	__u32	mlx5_ib_support_multi_pkt_send_wqes;
247
	__u32	flags; /* Use enum mlx5_ib_query_dev_resp_flags */
248
	struct mlx5_ib_sw_parsing_caps sw_parsing_caps;
249
	struct mlx5_ib_striding_rq_caps striding_rq_caps;
250 251
	__u32	tunnel_offloads_caps; /* enum mlx5_ib_tunnel_offloads */
	__u32	reserved;
252 253
};

254 255
enum mlx5_ib_create_cq_flags {
	MLX5_IB_CREATE_CQ_FLAGS_CQE_128B_PAD	= 1 << 0,
256 257
};

258
struct mlx5_ib_create_cq {
259 260
	__aligned_u64 buf_addr;
	__aligned_u64 db_addr;
261
	__u32	cqe_size;
262 263
	__u8    cqe_comp_en;
	__u8    cqe_comp_res_format;
264
	__u16	flags;
265 266 267 268 269 270 271 272
};

struct mlx5_ib_create_cq_resp {
	__u32	cqn;
	__u32	reserved;
};

struct mlx5_ib_resize_cq {
273
	__aligned_u64 buf_addr;
E
Eli Cohen 已提交
274 275 276
	__u16	cqe_size;
	__u16	reserved0;
	__u32	reserved1;
277 278 279
};

struct mlx5_ib_create_srq {
280 281
	__aligned_u64 buf_addr;
	__aligned_u64 db_addr;
282
	__u32	flags;
283 284 285
	__u32	reserved0; /* explicit padding (optional on i386) */
	__u32	uidx;
	__u32	reserved1;
286 287 288 289 290 291 292 293
};

struct mlx5_ib_create_srq_resp {
	__u32	srqn;
	__u32	reserved;
};

struct mlx5_ib_create_qp {
294 295
	__aligned_u64 buf_addr;
	__aligned_u64 db_addr;
296 297 298 299
	__u32	sq_wqe_count;
	__u32	rq_wqe_count;
	__u32	rq_wqe_shift;
	__u32	flags;
300
	__u32	uidx;
301
	__u32	bfreg_index;
302
	union {
303 304
		__aligned_u64 sq_buf_addr;
		__aligned_u64 access_key;
305
	};
306 307
};

Y
Yishai Hadas 已提交
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
/* RX Hash function flags */
enum mlx5_rx_hash_function_flags {
	MLX5_RX_HASH_FUNC_TOEPLITZ	= 1 << 0,
};

/*
 * RX Hash flags, these flags allows to set which incoming packet's field should
 * participates in RX Hash. Each flag represent certain packet's field,
 * when the flag is set the field that is represented by the flag will
 * participate in RX Hash calculation.
 * Note: *IPV4 and *IPV6 flags can't be enabled together on the same QP
 * and *TCP and *UDP flags can't be enabled together on the same QP.
*/
enum mlx5_rx_hash_fields {
	MLX5_RX_HASH_SRC_IPV4	= 1 << 0,
	MLX5_RX_HASH_DST_IPV4	= 1 << 1,
	MLX5_RX_HASH_SRC_IPV6	= 1 << 2,
	MLX5_RX_HASH_DST_IPV6	= 1 << 3,
	MLX5_RX_HASH_SRC_PORT_TCP	= 1 << 4,
	MLX5_RX_HASH_DST_PORT_TCP	= 1 << 5,
	MLX5_RX_HASH_SRC_PORT_UDP	= 1 << 6,
329
	MLX5_RX_HASH_DST_PORT_UDP	= 1 << 7,
330
	MLX5_RX_HASH_IPSEC_SPI		= 1 << 8,
331
	/* Save bits for future fields */
332
	MLX5_RX_HASH_INNER		= (1UL << 31),
Y
Yishai Hadas 已提交
333 334 335
};

struct mlx5_ib_create_qp_rss {
336
	__aligned_u64 rx_hash_fields_mask; /* enum mlx5_rx_hash_fields */
Y
Yishai Hadas 已提交
337 338 339 340 341
	__u8 rx_hash_function; /* enum mlx5_rx_hash_function_flags */
	__u8 rx_key_len; /* valid only for Toeplitz */
	__u8 reserved[6];
	__u8 rx_hash_key[128]; /* valid only for Toeplitz */
	__u32   comp_mask;
342
	__u32	flags;
Y
Yishai Hadas 已提交
343 344
};

345
struct mlx5_ib_create_qp_resp {
346
	__u32	bfreg_index;
347
	__u32   reserved;
348
};
349

350 351 352 353 354 355 356
struct mlx5_ib_alloc_mw {
	__u32	comp_mask;
	__u8	num_klms;
	__u8	reserved1;
	__u16	reserved2;
};

357 358 359 360
enum mlx5_ib_create_wq_mask {
	MLX5_IB_CREATE_WQ_STRIDING_RQ	= (1 << 0),
};

361
struct mlx5_ib_create_wq {
362 363
	__aligned_u64 buf_addr;
	__aligned_u64 db_addr;
364 365 366 367 368
	__u32   rq_wqe_count;
	__u32   rq_wqe_shift;
	__u32   user_index;
	__u32   flags;
	__u32   comp_mask;
369 370 371
	__u32	single_stride_log_num_of_bytes;
	__u32	single_wqe_log_num_of_strides;
	__u32	two_byte_shift_en;
372 373
};

374 375 376 377 378 379
struct mlx5_ib_create_ah_resp {
	__u32	response_length;
	__u8	dmac[ETH_ALEN];
	__u8	reserved[6];
};

380 381 382 383 384 385 386 387 388 389 390 391
struct mlx5_ib_burst_info {
	__u32       max_burst_sz;
	__u16       typical_pkt_sz;
	__u16       reserved;
};

struct mlx5_ib_modify_qp {
	__u32			   comp_mask;
	struct mlx5_ib_burst_info  burst_info;
	__u32			   reserved;
};

392 393 394 395 396
struct mlx5_ib_modify_qp_resp {
	__u32	response_length;
	__u32	dctn;
};

397 398 399 400 401
struct mlx5_ib_create_wq_resp {
	__u32	response_length;
	__u32	reserved;
};

402 403 404 405 406
struct mlx5_ib_create_rwq_ind_tbl_resp {
	__u32	response_length;
	__u32	reserved;
};

407 408 409 410
struct mlx5_ib_modify_wq {
	__u32	comp_mask;
	__u32	reserved;
};
411 412 413 414

struct mlx5_ib_clock_info {
	__u32 sign;
	__u32 resv;
415 416 417
	__aligned_u64 nsec;
	__aligned_u64 cycles;
	__aligned_u64 frac;
418 419
	__u32 mult;
	__u32 shift;
420 421
	__aligned_u64 mask;
	__aligned_u64 overflow_period;
422 423
};

424 425 426 427 428 429 430 431 432
enum mlx5_ib_mmap_cmd {
	MLX5_IB_MMAP_REGULAR_PAGE               = 0,
	MLX5_IB_MMAP_GET_CONTIGUOUS_PAGES       = 1,
	MLX5_IB_MMAP_WC_PAGE                    = 2,
	MLX5_IB_MMAP_NC_PAGE                    = 3,
	/* 5 is chosen in order to be compatible with old versions of libmlx5 */
	MLX5_IB_MMAP_CORE_CLOCK                 = 5,
	MLX5_IB_MMAP_ALLOC_WC                   = 6,
	MLX5_IB_MMAP_CLOCK_INFO                 = 7,
433
	MLX5_IB_MMAP_DEVICE_MEM                 = 8,
434 435
};

436 437 438
enum {
	MLX5_IB_CLOCK_INFO_KERNEL_UPDATING = 1,
};
439 440 441 442 443

/* Bit indexes for the mlx5_alloc_ucontext_resp.clock_info_versions bitmap */
enum {
	MLX5_IB_CLOCK_INFO_V1              = 0,
};
444
#endif /* MLX5_ABI_USER_H */