logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

mlx5-abi.h (13942B)


  1. /* SPDX-License-Identifier: ((GPL-2.0 WITH Linux-syscall-note) OR Linux-OpenIB) */
  2. /*
  3. * Copyright (c) 2013-2015, Mellanox Technologies. 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. #ifndef MLX5_ABI_USER_H
  34. #define MLX5_ABI_USER_H
  35. #include <linux/types.h>
  36. #include <linux/if_ether.h> /* For ETH_ALEN. */
  37. #include <rdma/ib_user_ioctl_verbs.h>
  38. #include <rdma/mlx5_user_ioctl_verbs.h>
  39. enum {
  40. MLX5_QP_FLAG_SIGNATURE = 1 << 0,
  41. MLX5_QP_FLAG_SCATTER_CQE = 1 << 1,
  42. MLX5_QP_FLAG_TUNNEL_OFFLOADS = 1 << 2,
  43. MLX5_QP_FLAG_BFREG_INDEX = 1 << 3,
  44. MLX5_QP_FLAG_TYPE_DCT = 1 << 4,
  45. MLX5_QP_FLAG_TYPE_DCI = 1 << 5,
  46. MLX5_QP_FLAG_TIR_ALLOW_SELF_LB_UC = 1 << 6,
  47. MLX5_QP_FLAG_TIR_ALLOW_SELF_LB_MC = 1 << 7,
  48. MLX5_QP_FLAG_ALLOW_SCATTER_CQE = 1 << 8,
  49. MLX5_QP_FLAG_PACKET_BASED_CREDIT_MODE = 1 << 9,
  50. MLX5_QP_FLAG_UAR_PAGE_INDEX = 1 << 10,
  51. MLX5_QP_FLAG_DCI_STREAM = 1 << 11,
  52. };
  53. enum {
  54. MLX5_SRQ_FLAG_SIGNATURE = 1 << 0,
  55. };
  56. enum {
  57. MLX5_WQ_FLAG_SIGNATURE = 1 << 0,
  58. };
  59. /* Increment this value if any changes that break userspace ABI
  60. * compatibility are made.
  61. */
  62. #define MLX5_IB_UVERBS_ABI_VERSION 1
  63. /* Make sure that all structs defined in this file remain laid out so
  64. * that they pack the same way on 32-bit and 64-bit architectures (to
  65. * avoid incompatibility between 32-bit userspace and 64-bit kernels).
  66. * In particular do not use pointer types -- pass pointers in __u64
  67. * instead.
  68. */
  69. struct mlx5_ib_alloc_ucontext_req {
  70. __u32 total_num_bfregs;
  71. __u32 num_low_latency_bfregs;
  72. };
  73. enum mlx5_lib_caps {
  74. MLX5_LIB_CAP_4K_UAR = (__u64)1 << 0,
  75. MLX5_LIB_CAP_DYN_UAR = (__u64)1 << 1,
  76. };
  77. enum mlx5_ib_alloc_uctx_v2_flags {
  78. MLX5_IB_ALLOC_UCTX_DEVX = 1 << 0,
  79. };
  80. struct mlx5_ib_alloc_ucontext_req_v2 {
  81. __u32 total_num_bfregs;
  82. __u32 num_low_latency_bfregs;
  83. __u32 flags;
  84. __u32 comp_mask;
  85. __u8 max_cqe_version;
  86. __u8 reserved0;
  87. __u16 reserved1;
  88. __u32 reserved2;
  89. __aligned_u64 lib_caps;
  90. };
  91. enum mlx5_ib_alloc_ucontext_resp_mask {
  92. MLX5_IB_ALLOC_UCONTEXT_RESP_MASK_CORE_CLOCK_OFFSET = 1UL << 0,
  93. MLX5_IB_ALLOC_UCONTEXT_RESP_MASK_DUMP_FILL_MKEY = 1UL << 1,
  94. MLX5_IB_ALLOC_UCONTEXT_RESP_MASK_ECE = 1UL << 2,
  95. MLX5_IB_ALLOC_UCONTEXT_RESP_MASK_SQD2RTS = 1UL << 3,
  96. MLX5_IB_ALLOC_UCONTEXT_RESP_MASK_REAL_TIME_TS = 1UL << 4,
  97. MLX5_IB_ALLOC_UCONTEXT_RESP_MASK_MKEY_UPDATE_TAG = 1UL << 5,
  98. };
  99. enum mlx5_user_cmds_supp_uhw {
  100. MLX5_USER_CMDS_SUPP_UHW_QUERY_DEVICE = 1 << 0,
  101. MLX5_USER_CMDS_SUPP_UHW_CREATE_AH = 1 << 1,
  102. };
  103. /* The eth_min_inline response value is set to off-by-one vs the FW
  104. * returned value to allow user-space to deal with older kernels.
  105. */
  106. enum mlx5_user_inline_mode {
  107. MLX5_USER_INLINE_MODE_NA,
  108. MLX5_USER_INLINE_MODE_NONE,
  109. MLX5_USER_INLINE_MODE_L2,
  110. MLX5_USER_INLINE_MODE_IP,
  111. MLX5_USER_INLINE_MODE_TCP_UDP,
  112. };
  113. enum {
  114. MLX5_USER_ALLOC_UCONTEXT_FLOW_ACTION_FLAGS_ESP_AES_GCM = 1 << 0,
  115. MLX5_USER_ALLOC_UCONTEXT_FLOW_ACTION_FLAGS_ESP_AES_GCM_REQ_METADATA = 1 << 1,
  116. MLX5_USER_ALLOC_UCONTEXT_FLOW_ACTION_FLAGS_ESP_AES_GCM_SPI_STEERING = 1 << 2,
  117. MLX5_USER_ALLOC_UCONTEXT_FLOW_ACTION_FLAGS_ESP_AES_GCM_FULL_OFFLOAD = 1 << 3,
  118. MLX5_USER_ALLOC_UCONTEXT_FLOW_ACTION_FLAGS_ESP_AES_GCM_TX_IV_IS_ESN = 1 << 4,
  119. };
  120. struct mlx5_ib_alloc_ucontext_resp {
  121. __u32 qp_tab_size;
  122. __u32 bf_reg_size;
  123. __u32 tot_bfregs;
  124. __u32 cache_line_size;
  125. __u16 max_sq_desc_sz;
  126. __u16 max_rq_desc_sz;
  127. __u32 max_send_wqebb;
  128. __u32 max_recv_wr;
  129. __u32 max_srq_recv_wr;
  130. __u16 num_ports;
  131. __u16 flow_action_flags;
  132. __u32 comp_mask;
  133. __u32 response_length;
  134. __u8 cqe_version;
  135. __u8 cmds_supp_uhw;
  136. __u8 eth_min_inline;
  137. __u8 clock_info_versions;
  138. __aligned_u64 hca_core_clock_offset;
  139. __u32 log_uar_size;
  140. __u32 num_uars_per_page;
  141. __u32 num_dyn_bfregs;
  142. __u32 dump_fill_mkey;
  143. };
  144. struct mlx5_ib_alloc_pd_resp {
  145. __u32 pdn;
  146. };
  147. struct mlx5_ib_tso_caps {
  148. __u32 max_tso; /* Maximum tso payload size in bytes */
  149. /* Corresponding bit will be set if qp type from
  150. * 'enum ib_qp_type' is supported, e.g.
  151. * supported_qpts |= 1 << IB_QPT_UD
  152. */
  153. __u32 supported_qpts;
  154. };
  155. struct mlx5_ib_rss_caps {
  156. __aligned_u64 rx_hash_fields_mask; /* enum mlx5_rx_hash_fields */
  157. __u8 rx_hash_function; /* enum mlx5_rx_hash_function_flags */
  158. __u8 reserved[7];
  159. };
  160. enum mlx5_ib_cqe_comp_res_format {
  161. MLX5_IB_CQE_RES_FORMAT_HASH = 1 << 0,
  162. MLX5_IB_CQE_RES_FORMAT_CSUM = 1 << 1,
  163. MLX5_IB_CQE_RES_FORMAT_CSUM_STRIDX = 1 << 2,
  164. };
  165. struct mlx5_ib_cqe_comp_caps {
  166. __u32 max_num;
  167. __u32 supported_format; /* enum mlx5_ib_cqe_comp_res_format */
  168. };
  169. enum mlx5_ib_packet_pacing_cap_flags {
  170. MLX5_IB_PP_SUPPORT_BURST = 1 << 0,
  171. };
  172. struct mlx5_packet_pacing_caps {
  173. __u32 qp_rate_limit_min;
  174. __u32 qp_rate_limit_max; /* In kpbs */
  175. /* Corresponding bit will be set if qp type from
  176. * 'enum ib_qp_type' is supported, e.g.
  177. * supported_qpts |= 1 << IB_QPT_RAW_PACKET
  178. */
  179. __u32 supported_qpts;
  180. __u8 cap_flags; /* enum mlx5_ib_packet_pacing_cap_flags */
  181. __u8 reserved[3];
  182. };
  183. enum mlx5_ib_mpw_caps {
  184. MPW_RESERVED = 1 << 0,
  185. MLX5_IB_ALLOW_MPW = 1 << 1,
  186. MLX5_IB_SUPPORT_EMPW = 1 << 2,
  187. };
  188. enum mlx5_ib_sw_parsing_offloads {
  189. MLX5_IB_SW_PARSING = 1 << 0,
  190. MLX5_IB_SW_PARSING_CSUM = 1 << 1,
  191. MLX5_IB_SW_PARSING_LSO = 1 << 2,
  192. };
  193. struct mlx5_ib_sw_parsing_caps {
  194. __u32 sw_parsing_offloads; /* enum mlx5_ib_sw_parsing_offloads */
  195. /* Corresponding bit will be set if qp type from
  196. * 'enum ib_qp_type' is supported, e.g.
  197. * supported_qpts |= 1 << IB_QPT_RAW_PACKET
  198. */
  199. __u32 supported_qpts;
  200. };
  201. struct mlx5_ib_striding_rq_caps {
  202. __u32 min_single_stride_log_num_of_bytes;
  203. __u32 max_single_stride_log_num_of_bytes;
  204. __u32 min_single_wqe_log_num_of_strides;
  205. __u32 max_single_wqe_log_num_of_strides;
  206. /* Corresponding bit will be set if qp type from
  207. * 'enum ib_qp_type' is supported, e.g.
  208. * supported_qpts |= 1 << IB_QPT_RAW_PACKET
  209. */
  210. __u32 supported_qpts;
  211. __u32 reserved;
  212. };
  213. struct mlx5_ib_dci_streams_caps {
  214. __u8 max_log_num_concurent;
  215. __u8 max_log_num_errored;
  216. };
  217. enum mlx5_ib_query_dev_resp_flags {
  218. /* Support 128B CQE compression */
  219. MLX5_IB_QUERY_DEV_RESP_FLAGS_CQE_128B_COMP = 1 << 0,
  220. MLX5_IB_QUERY_DEV_RESP_FLAGS_CQE_128B_PAD = 1 << 1,
  221. MLX5_IB_QUERY_DEV_RESP_PACKET_BASED_CREDIT_MODE = 1 << 2,
  222. MLX5_IB_QUERY_DEV_RESP_FLAGS_SCAT2CQE_DCT = 1 << 3,
  223. };
  224. enum mlx5_ib_tunnel_offloads {
  225. MLX5_IB_TUNNELED_OFFLOADS_VXLAN = 1 << 0,
  226. MLX5_IB_TUNNELED_OFFLOADS_GRE = 1 << 1,
  227. MLX5_IB_TUNNELED_OFFLOADS_GENEVE = 1 << 2,
  228. MLX5_IB_TUNNELED_OFFLOADS_MPLS_GRE = 1 << 3,
  229. MLX5_IB_TUNNELED_OFFLOADS_MPLS_UDP = 1 << 4,
  230. };
  231. struct mlx5_ib_query_device_resp {
  232. __u32 comp_mask;
  233. __u32 response_length;
  234. struct mlx5_ib_tso_caps tso_caps;
  235. struct mlx5_ib_rss_caps rss_caps;
  236. struct mlx5_ib_cqe_comp_caps cqe_comp_caps;
  237. struct mlx5_packet_pacing_caps packet_pacing_caps;
  238. __u32 mlx5_ib_support_multi_pkt_send_wqes;
  239. __u32 flags; /* Use enum mlx5_ib_query_dev_resp_flags */
  240. struct mlx5_ib_sw_parsing_caps sw_parsing_caps;
  241. struct mlx5_ib_striding_rq_caps striding_rq_caps;
  242. __u32 tunnel_offloads_caps; /* enum mlx5_ib_tunnel_offloads */
  243. struct mlx5_ib_dci_streams_caps dci_streams_caps;
  244. __u16 reserved;
  245. struct mlx5_ib_uapi_reg reg_c0;
  246. };
  247. enum mlx5_ib_create_cq_flags {
  248. MLX5_IB_CREATE_CQ_FLAGS_CQE_128B_PAD = 1 << 0,
  249. MLX5_IB_CREATE_CQ_FLAGS_UAR_PAGE_INDEX = 1 << 1,
  250. MLX5_IB_CREATE_CQ_FLAGS_REAL_TIME_TS = 1 << 2,
  251. };
  252. struct mlx5_ib_create_cq {
  253. __aligned_u64 buf_addr;
  254. __aligned_u64 db_addr;
  255. __u32 cqe_size;
  256. __u8 cqe_comp_en;
  257. __u8 cqe_comp_res_format;
  258. __u16 flags;
  259. __u16 uar_page_index;
  260. __u16 reserved0;
  261. __u32 reserved1;
  262. };
  263. struct mlx5_ib_create_cq_resp {
  264. __u32 cqn;
  265. __u32 reserved;
  266. };
  267. struct mlx5_ib_resize_cq {
  268. __aligned_u64 buf_addr;
  269. __u16 cqe_size;
  270. __u16 reserved0;
  271. __u32 reserved1;
  272. };
  273. struct mlx5_ib_create_srq {
  274. __aligned_u64 buf_addr;
  275. __aligned_u64 db_addr;
  276. __u32 flags;
  277. __u32 reserved0; /* explicit padding (optional on i386) */
  278. __u32 uidx;
  279. __u32 reserved1;
  280. };
  281. struct mlx5_ib_create_srq_resp {
  282. __u32 srqn;
  283. __u32 reserved;
  284. };
  285. struct mlx5_ib_create_qp_dci_streams {
  286. __u8 log_num_concurent;
  287. __u8 log_num_errored;
  288. };
  289. struct mlx5_ib_create_qp {
  290. __aligned_u64 buf_addr;
  291. __aligned_u64 db_addr;
  292. __u32 sq_wqe_count;
  293. __u32 rq_wqe_count;
  294. __u32 rq_wqe_shift;
  295. __u32 flags;
  296. __u32 uidx;
  297. __u32 bfreg_index;
  298. union {
  299. __aligned_u64 sq_buf_addr;
  300. __aligned_u64 access_key;
  301. };
  302. __u32 ece_options;
  303. struct mlx5_ib_create_qp_dci_streams dci_streams;
  304. __u16 reserved;
  305. };
  306. /* RX Hash function flags */
  307. enum mlx5_rx_hash_function_flags {
  308. MLX5_RX_HASH_FUNC_TOEPLITZ = 1 << 0,
  309. };
  310. /*
  311. * RX Hash flags, these flags allows to set which incoming packet's field should
  312. * participates in RX Hash. Each flag represent certain packet's field,
  313. * when the flag is set the field that is represented by the flag will
  314. * participate in RX Hash calculation.
  315. * Note: *IPV4 and *IPV6 flags can't be enabled together on the same QP
  316. * and *TCP and *UDP flags can't be enabled together on the same QP.
  317. */
  318. enum mlx5_rx_hash_fields {
  319. MLX5_RX_HASH_SRC_IPV4 = 1 << 0,
  320. MLX5_RX_HASH_DST_IPV4 = 1 << 1,
  321. MLX5_RX_HASH_SRC_IPV6 = 1 << 2,
  322. MLX5_RX_HASH_DST_IPV6 = 1 << 3,
  323. MLX5_RX_HASH_SRC_PORT_TCP = 1 << 4,
  324. MLX5_RX_HASH_DST_PORT_TCP = 1 << 5,
  325. MLX5_RX_HASH_SRC_PORT_UDP = 1 << 6,
  326. MLX5_RX_HASH_DST_PORT_UDP = 1 << 7,
  327. MLX5_RX_HASH_IPSEC_SPI = 1 << 8,
  328. /* Save bits for future fields */
  329. MLX5_RX_HASH_INNER = (1UL << 31),
  330. };
  331. struct mlx5_ib_create_qp_rss {
  332. __aligned_u64 rx_hash_fields_mask; /* enum mlx5_rx_hash_fields */
  333. __u8 rx_hash_function; /* enum mlx5_rx_hash_function_flags */
  334. __u8 rx_key_len; /* valid only for Toeplitz */
  335. __u8 reserved[6];
  336. __u8 rx_hash_key[128]; /* valid only for Toeplitz */
  337. __u32 comp_mask;
  338. __u32 flags;
  339. };
  340. enum mlx5_ib_create_qp_resp_mask {
  341. MLX5_IB_CREATE_QP_RESP_MASK_TIRN = 1UL << 0,
  342. MLX5_IB_CREATE_QP_RESP_MASK_TISN = 1UL << 1,
  343. MLX5_IB_CREATE_QP_RESP_MASK_RQN = 1UL << 2,
  344. MLX5_IB_CREATE_QP_RESP_MASK_SQN = 1UL << 3,
  345. MLX5_IB_CREATE_QP_RESP_MASK_TIR_ICM_ADDR = 1UL << 4,
  346. };
  347. struct mlx5_ib_create_qp_resp {
  348. __u32 bfreg_index;
  349. __u32 ece_options;
  350. __u32 comp_mask;
  351. __u32 tirn;
  352. __u32 tisn;
  353. __u32 rqn;
  354. __u32 sqn;
  355. __u32 reserved1;
  356. __u64 tir_icm_addr;
  357. };
  358. struct mlx5_ib_alloc_mw {
  359. __u32 comp_mask;
  360. __u8 num_klms;
  361. __u8 reserved1;
  362. __u16 reserved2;
  363. };
  364. enum mlx5_ib_create_wq_mask {
  365. MLX5_IB_CREATE_WQ_STRIDING_RQ = (1 << 0),
  366. };
  367. struct mlx5_ib_create_wq {
  368. __aligned_u64 buf_addr;
  369. __aligned_u64 db_addr;
  370. __u32 rq_wqe_count;
  371. __u32 rq_wqe_shift;
  372. __u32 user_index;
  373. __u32 flags;
  374. __u32 comp_mask;
  375. __u32 single_stride_log_num_of_bytes;
  376. __u32 single_wqe_log_num_of_strides;
  377. __u32 two_byte_shift_en;
  378. };
  379. struct mlx5_ib_create_ah_resp {
  380. __u32 response_length;
  381. __u8 dmac[ETH_ALEN];
  382. __u8 reserved[6];
  383. };
  384. struct mlx5_ib_burst_info {
  385. __u32 max_burst_sz;
  386. __u16 typical_pkt_sz;
  387. __u16 reserved;
  388. };
  389. struct mlx5_ib_modify_qp {
  390. __u32 comp_mask;
  391. struct mlx5_ib_burst_info burst_info;
  392. __u32 ece_options;
  393. };
  394. struct mlx5_ib_modify_qp_resp {
  395. __u32 response_length;
  396. __u32 dctn;
  397. __u32 ece_options;
  398. __u32 reserved;
  399. };
  400. struct mlx5_ib_create_wq_resp {
  401. __u32 response_length;
  402. __u32 reserved;
  403. };
  404. struct mlx5_ib_create_rwq_ind_tbl_resp {
  405. __u32 response_length;
  406. __u32 reserved;
  407. };
  408. struct mlx5_ib_modify_wq {
  409. __u32 comp_mask;
  410. __u32 reserved;
  411. };
  412. struct mlx5_ib_clock_info {
  413. __u32 sign;
  414. __u32 resv;
  415. __aligned_u64 nsec;
  416. __aligned_u64 cycles;
  417. __aligned_u64 frac;
  418. __u32 mult;
  419. __u32 shift;
  420. __aligned_u64 mask;
  421. __aligned_u64 overflow_period;
  422. };
  423. enum mlx5_ib_mmap_cmd {
  424. MLX5_IB_MMAP_REGULAR_PAGE = 0,
  425. MLX5_IB_MMAP_GET_CONTIGUOUS_PAGES = 1,
  426. MLX5_IB_MMAP_WC_PAGE = 2,
  427. MLX5_IB_MMAP_NC_PAGE = 3,
  428. /* 5 is chosen in order to be compatible with old versions of libmlx5 */
  429. MLX5_IB_MMAP_CORE_CLOCK = 5,
  430. MLX5_IB_MMAP_ALLOC_WC = 6,
  431. MLX5_IB_MMAP_CLOCK_INFO = 7,
  432. MLX5_IB_MMAP_DEVICE_MEM = 8,
  433. };
  434. enum {
  435. MLX5_IB_CLOCK_INFO_KERNEL_UPDATING = 1,
  436. };
  437. /* Bit indexes for the mlx5_alloc_ucontext_resp.clock_info_versions bitmap */
  438. enum {
  439. MLX5_IB_CLOCK_INFO_V1 = 0,
  440. };
  441. struct mlx5_ib_flow_counters_desc {
  442. __u32 description;
  443. __u32 index;
  444. };
  445. struct mlx5_ib_flow_counters_data {
  446. RDMA_UAPI_PTR(struct mlx5_ib_flow_counters_desc *, counters_data);
  447. __u32 ncounters;
  448. __u32 reserved;
  449. };
  450. struct mlx5_ib_create_flow {
  451. __u32 ncounters_data;
  452. __u32 reserved;
  453. /*
  454. * Following are counters data based on ncounters_data, each
  455. * entry in the data[] should match a corresponding counter object
  456. * that was pointed by a counters spec upon the flow creation
  457. */
  458. struct mlx5_ib_flow_counters_data data[];
  459. };
  460. #endif /* MLX5_ABI_USER_H */