xref: /dpdk/drivers/common/mlx5/mlx5_devx_cmds.h (revision ec17aa6a129531601f740ff4551a367e863e97e0)
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright 2019 Mellanox Technologies, Ltd
3  */
4 
5 #ifndef RTE_PMD_MLX5_DEVX_CMDS_H_
6 #define RTE_PMD_MLX5_DEVX_CMDS_H_
7 
8 #include <rte_compat.h>
9 #include <rte_bitops.h>
10 
11 #include "mlx5_glue.h"
12 #include "mlx5_prm.h"
13 
14 /* This is limitation of libibverbs: in length variable type is u16. */
15 #define MLX5_DEVX_MAX_KLM_ENTRIES ((UINT16_MAX - \
16 		MLX5_ST_SZ_DW(create_mkey_in) * 4) / (MLX5_ST_SZ_DW(klm) * 4))
17 
18 struct mlx5_devx_counter_attr {
19 	uint32_t pd_valid:1;
20 	uint32_t pd:24;
21 	uint32_t bulk_log_max_alloc:1;
22 	union {
23 		uint8_t flow_counter_bulk_log_size;
24 		uint8_t bulk_n_128;
25 	};
26 };
27 
28 struct mlx5_devx_mkey_attr {
29 	uint64_t addr;
30 	uint64_t size;
31 	uint32_t umem_id;
32 	uint32_t pd;
33 	uint32_t log_entity_size;
34 	uint32_t pg_access:1;
35 	uint32_t relaxed_ordering_write:1;
36 	uint32_t relaxed_ordering_read:1;
37 	uint32_t umr_en:1;
38 	uint32_t crypto_en:2;
39 	uint32_t set_remote_rw:1;
40 	struct mlx5_klm *klm_array;
41 	int klm_num;
42 };
43 
44 /* HCA qos attributes. */
45 struct mlx5_hca_qos_attr {
46 	uint32_t sup:1;	/* Whether QOS is supported. */
47 	uint32_t flow_meter_old:1; /* Flow meter is supported, old version. */
48 	uint32_t packet_pacing:1; /* Packet pacing is supported. */
49 	uint32_t wqe_rate_pp:1; /* Packet pacing WQE rate mode. */
50 	uint32_t flow_meter:1;
51 	/*
52 	 * Flow meter is supported, updated version.
53 	 * When flow_meter is 1, it indicates that REG_C sharing is supported.
54 	 * If flow_meter is 1, flow_meter_old is also 1.
55 	 * Using older driver versions, flow_meter_old can be 1
56 	 * while flow_meter is 0.
57 	 */
58 	uint32_t flow_meter_aso_sup:1;
59 	/* Whether FLOW_METER_ASO Object is supported. */
60 	uint8_t log_max_flow_meter;
61 	/* Power of the maximum supported meters. */
62 	uint8_t flow_meter_reg_c_ids;
63 	/* Bitmap of the reg_Cs available for flow meter to use. */
64 	uint32_t log_meter_aso_granularity:5;
65 	/* Power of the minimum allocation granularity Object. */
66 	uint32_t log_meter_aso_max_alloc:5;
67 	/* Power of the maximum allocation granularity Object. */
68 	uint32_t log_max_num_meter_aso:5;
69 	/* Power of the maximum number of supported objects. */
70 
71 };
72 
73 struct mlx5_hca_vdpa_attr {
74 	uint8_t virtio_queue_type;
75 	uint32_t valid:1;
76 	uint32_t desc_tunnel_offload_type:1;
77 	uint32_t eth_frame_offload_type:1;
78 	uint32_t virtio_version_1_0:1;
79 	uint32_t tso_ipv4:1;
80 	uint32_t tso_ipv6:1;
81 	uint32_t tx_csum:1;
82 	uint32_t rx_csum:1;
83 	uint32_t event_mode:3;
84 	uint32_t log_doorbell_stride:5;
85 	uint32_t log_doorbell_bar_size:5;
86 	uint32_t queue_counters_valid:1;
87 	uint32_t vnet_modify_ext:1;
88 	uint32_t virtio_net_q_addr_modify:1;
89 	uint32_t virtio_q_index_modify:1;
90 	uint32_t max_num_virtio_queues;
91 	struct {
92 		uint32_t a;
93 		uint32_t b;
94 	} umems[3];
95 	uint64_t doorbell_bar_offset;
96 };
97 
98 struct mlx5_hca_flow_attr {
99 	uint32_t tunnel_header_0_1;
100 	uint32_t tunnel_header_2_3;
101 };
102 
103 /**
104  * Accumulate port PARSE_GRAPH_NODE capabilities from
105  * PARSE_GRAPH_NODE Capabilities and HCA Capabilities 2 tables
106  */
107 __extension__
108 struct mlx5_hca_flex_attr {
109 	uint32_t node_in;
110 	uint32_t node_out;
111 	uint16_t header_length_mode;
112 	uint16_t sample_offset_mode;
113 	uint8_t  max_num_arc_in;
114 	uint8_t  max_num_arc_out;
115 	uint8_t  max_num_sample;
116 	uint8_t  max_num_prog_sample:5;	/* From HCA CAP 2 */
117 	uint8_t  parse_graph_anchor:1;
118 	uint8_t  query_match_sample_info:1; /* Support DevX query sample info. */
119 	uint8_t  sample_tunnel_inner2:1;
120 	uint8_t  zero_size_supported:1;
121 	uint8_t  sample_id_in_out:1;
122 	uint16_t max_base_header_length;
123 	uint8_t  max_sample_base_offset;
124 	uint16_t max_next_header_offset;
125 	uint8_t  header_length_mask_width;
126 };
127 
128 __extension__
129 struct mlx5_hca_crypto_mmo_attr {
130 	uint32_t crypto_mmo_qp:1;
131 	uint32_t gcm_256_encrypt:1;
132 	uint32_t gcm_128_encrypt:1;
133 	uint32_t gcm_256_decrypt:1;
134 	uint32_t gcm_128_decrypt:1;
135 	uint32_t gcm_auth_tag_128:1;
136 	uint32_t gcm_auth_tag_96:1;
137 	uint32_t log_crypto_mmo_max_size:6;
138 };
139 
140 /* ISO C restricts enumerator values to range of 'int' */
141 __extension__
142 enum {
143 	PARSE_GRAPH_NODE_CAP_SUPPORTED_PROTOCOL_HEAD          = RTE_BIT32(1),
144 	PARSE_GRAPH_NODE_CAP_SUPPORTED_PROTOCOL_MAC           = RTE_BIT32(2),
145 	PARSE_GRAPH_NODE_CAP_SUPPORTED_PROTOCOL_IP            = RTE_BIT32(3),
146 	PARSE_GRAPH_NODE_CAP_SUPPORTED_PROTOCOL_GRE           = RTE_BIT32(4),
147 	PARSE_GRAPH_NODE_CAP_SUPPORTED_PROTOCOL_UDP           = RTE_BIT32(5),
148 	PARSE_GRAPH_NODE_CAP_SUPPORTED_PROTOCOL_MPLS          = RTE_BIT32(6),
149 	PARSE_GRAPH_NODE_CAP_SUPPORTED_PROTOCOL_TCP           = RTE_BIT32(7),
150 	PARSE_GRAPH_NODE_CAP_SUPPORTED_PROTOCOL_VXLAN_GRE     = RTE_BIT32(8),
151 	PARSE_GRAPH_NODE_CAP_SUPPORTED_PROTOCOL_GENEVE        = RTE_BIT32(9),
152 	PARSE_GRAPH_NODE_CAP_SUPPORTED_PROTOCOL_IPSEC_ESP     = RTE_BIT32(10),
153 	PARSE_GRAPH_NODE_CAP_SUPPORTED_PROTOCOL_IPV4          = RTE_BIT32(11),
154 	PARSE_GRAPH_NODE_CAP_SUPPORTED_PROTOCOL_IPV6          = RTE_BIT32(12),
155 	PARSE_GRAPH_NODE_CAP_SUPPORTED_PROTOCOL_PROGRAMMABLE  = RTE_BIT32(31)
156 };
157 
158 enum {
159 	PARSE_GRAPH_NODE_CAP_LENGTH_MODE_FIXED          = RTE_BIT32(0),
160 	PARSE_GRAPH_NODE_CAP_LENGTH_MODE_EXPLISIT_FIELD = RTE_BIT32(1),
161 	PARSE_GRAPH_NODE_CAP_LENGTH_MODE_BITMASK_FIELD  = RTE_BIT32(2)
162 };
163 
164 /*
165  * DWORD shift is the base for calculating header_length_field_mask
166  * value in the MLX5_GRAPH_NODE_LEN_FIELD mode.
167  */
168 #define MLX5_PARSE_GRAPH_NODE_HDR_LEN_SHIFT_DWORD 0x02
169 
170 static inline uint32_t
171 mlx5_hca_parse_graph_node_base_hdr_len_mask
172 	(const struct mlx5_hca_flex_attr *attr)
173 {
174 	return (1 << attr->header_length_mask_width) - 1;
175 }
176 
177 /* HCA supports this number of time periods for LRO. */
178 #define MLX5_LRO_NUM_SUPP_PERIODS 4
179 
180 /* HCA attributes. */
181 struct mlx5_hca_attr {
182 	uint32_t eswitch_manager:1;
183 	uint32_t flow_counters_dump:1;
184 	uint32_t mem_rq_rmp:1;
185 	uint32_t log_max_rmp:5;
186 	uint32_t log_max_rqt_size:5;
187 	uint32_t parse_graph_flex_node:1;
188 	uint8_t flow_counter_bulk_alloc_bitmap;
189 	uint32_t eth_net_offloads:1;
190 	uint32_t eth_virt:1;
191 	uint32_t wqe_vlan_insert:1;
192 	uint32_t csum_cap:1;
193 	uint32_t vlan_cap:1;
194 	uint32_t wqe_inline_mode:2;
195 	uint32_t vport_inline_mode:3;
196 	uint32_t tunnel_stateless_geneve_rx:1;
197 	uint32_t geneve_max_opt_len:1; /* 0x0: 14DW, 0x1: 63DW */
198 	uint32_t tunnel_stateless_gtp:1;
199 	uint32_t tunnel_stateless_vxlan_gpe_nsh:1;
200 	uint32_t max_lso_cap;
201 	uint32_t scatter_fcs:1;
202 	uint32_t lro_cap:1;
203 	uint32_t tunnel_lro_gre:1;
204 	uint32_t tunnel_lro_vxlan:1;
205 	uint32_t tunnel_stateless_gre:1;
206 	uint32_t tunnel_stateless_vxlan:1;
207 	uint32_t swp:1;
208 	uint32_t swp_csum:1;
209 	uint32_t swp_lso:1;
210 	uint32_t lro_max_msg_sz_mode:2;
211 	uint32_t rq_delay_drop:1;
212 	uint32_t lro_timer_supported_periods[MLX5_LRO_NUM_SUPP_PERIODS];
213 	uint16_t lro_min_mss_size;
214 	uint32_t flex_parser_protocols;
215 	uint32_t max_geneve_tlv_options:8;
216 	uint32_t max_geneve_tlv_option_data_len:5;
217 	uint32_t geneve_tlv_sample:1;
218 	uint32_t geneve_tlv_option_offset:1;
219 	uint32_t geneve_tlv_option_sample_id:4;
220 	uint32_t hairpin:1;
221 	uint32_t log_max_hairpin_queues:5;
222 	uint32_t log_max_hairpin_wq_data_sz:5;
223 	uint32_t log_max_hairpin_num_packets:5;
224 	uint32_t hairpin_sq_wqe_bb_size:4;
225 	uint32_t hairpin_sq_wq_in_host_mem:1;
226 	uint32_t hairpin_data_buffer_locked:1;
227 	uint32_t vhca_id:16;
228 	uint32_t relaxed_ordering_write:1;
229 	uint32_t relaxed_ordering_read:1;
230 	uint32_t access_register_user:1;
231 	uint32_t wqe_index_ignore:1;
232 	uint32_t cross_channel:1;
233 	uint32_t non_wire_sq:1; /* SQ with non-wire ops is supported. */
234 	uint32_t log_max_static_sq_wq:5; /* Static WQE size SQ. */
235 	uint32_t num_lag_ports:4; /* Number of ports can be bonded. */
236 	uint32_t dev_freq_khz; /* Timestamp counter frequency, kHz. */
237 	uint32_t scatter_fcs_w_decap_disable:1;
238 	uint32_t flow_hit_aso:1; /* General obj type FLOW_HIT_ASO supported. */
239 	uint32_t roce:1;
240 	uint32_t wait_on_time:1;
241 	uint32_t rq_ts_format:2;
242 	uint32_t sq_ts_format:2;
243 	uint32_t steering_format_version:4;
244 	uint32_t qp_ts_format:2;
245 	uint32_t regexp_params:1;
246 	uint32_t regexp_version:3;
247 	uint32_t reg_c_preserve:1;
248 	uint32_t ct_offload:1; /* General obj type ASO CT offload supported. */
249 	uint32_t crypto:1; /* Crypto engine is supported. */
250 	uint32_t aes_xts:1; /* AES-XTS crypto is supported. */
251 	uint32_t dek:1; /* General obj type DEK is supported. */
252 	uint32_t import_kek:1; /* General obj type IMPORT_KEK supported. */
253 	uint32_t credential:1; /* General obj type CREDENTIAL supported. */
254 	uint32_t crypto_login:1; /* General obj type CRYPTO_LOGIN supported. */
255 	uint32_t regexp_num_of_engines;
256 	uint32_t log_max_ft_sampler_num:8;
257 	uint32_t inner_ipv4_ihl:1;
258 	uint32_t outer_ipv4_ihl:1;
259 	uint32_t geneve_tlv_opt;
260 	uint32_t cqe_compression:1;
261 	uint32_t mini_cqe_resp_flow_tag:1;
262 	uint32_t mini_cqe_resp_l3_l4_tag:1;
263 	uint32_t enhanced_cqe_compression:1;
264 	uint32_t pkt_integrity_match:1; /* 1 if HW supports integrity item */
265 	struct mlx5_hca_qos_attr qos;
266 	struct mlx5_hca_vdpa_attr vdpa;
267 	struct mlx5_hca_flow_attr flow;
268 	struct mlx5_hca_flex_attr flex;
269 	struct mlx5_hca_crypto_mmo_attr crypto_mmo;
270 	uint8_t log_max_wq_sz;
271 	uint8_t log_max_qp_sz;
272 	uint8_t log_max_cq_sz;
273 	uint8_t log_max_qp;
274 	uint8_t log_max_cq;
275 	uint32_t log_max_pd;
276 	uint32_t log_max_mrw_sz;
277 	uint32_t log_max_srq;
278 	uint32_t log_max_srq_sz;
279 	uint32_t rss_ind_tbl_cap;
280 	uint32_t mmo_dma_sq_en:1;
281 	uint32_t mmo_compress_sq_en:1;
282 	uint32_t mmo_decompress_sq_en:1;
283 	uint32_t mmo_dma_qp_en:1;
284 	uint32_t mmo_compress_qp_en:1;
285 	uint32_t decomp_deflate_v1_en:1;
286 	uint32_t decomp_deflate_v2_en:1;
287 	uint32_t mmo_regex_qp_en:1;
288 	uint32_t mmo_regex_sq_en:1;
289 	uint32_t compress_min_block_size:4;
290 	uint32_t log_max_mmo_dma:5;
291 	uint32_t log_max_mmo_compress:5;
292 	uint32_t log_max_mmo_decompress:5;
293 	uint32_t decomp_lz4_data_only_en:1;
294 	uint32_t decomp_lz4_no_checksum_en:1;
295 	uint32_t decomp_lz4_checksum_en:1;
296 	uint32_t umr_modify_entity_size_disabled:1;
297 	uint32_t umr_indirect_mkey_disabled:1;
298 	uint32_t log_min_stride_wqe_sz:5;
299 	uint32_t esw_mgr_vport_id_valid:1; /* E-Switch Mgr vport ID is valid. */
300 	uint32_t crypto_wrapped_import_method:1;
301 	uint16_t esw_mgr_vport_id; /* E-Switch Mgr vport ID . */
302 	uint16_t max_wqe_sz_sq;
303 	uint32_t striding_rq:1;
304 	uint32_t ext_stride_num_range:1;
305 	uint32_t cqe_compression_128:1;
306 	uint32_t multi_pkt_send_wqe:1;
307 	uint32_t enhanced_multi_pkt_send_wqe:1;
308 	uint32_t set_reg_c:16;
309 	uint32_t nic_flow_table:1;
310 	uint32_t modify_outer_ip_ecn:1;
311 	uint32_t modify_outer_ipv6_traffic_class:1;
312 	union {
313 		uint32_t max_flow_counter;
314 		struct {
315 			uint16_t max_flow_counter_15_0;
316 			uint16_t max_flow_counter_31_16;
317 		};
318 	};
319 	uint32_t flow_counter_bulk_log_max_alloc:5;
320 	uint32_t flow_counter_bulk_log_granularity:5;
321 	uint32_t alloc_flow_counter_pd:1;
322 	uint32_t flow_counter_access_aso:1;
323 	uint32_t query_match_sample_info:1;
324 	uint32_t flow_access_aso_opc_mod:8;
325 	uint32_t cross_vhca:1;
326 	uint32_t lag_rx_port_affinity:1;
327 	uint32_t wqe_based_flow_table_sup:1;
328 	uint8_t max_header_modify_pattern_length;
329 	uint64_t system_image_guid;
330 	uint32_t log_max_conn_track_offload:5;
331 };
332 
333 /* LAG Context. */
334 struct mlx5_devx_lag_context {
335 	uint32_t fdb_selection_mode:1;
336 	uint32_t port_select_mode:3;
337 	uint32_t lag_state:3;
338 	uint32_t tx_remap_affinity_1:4;
339 	uint32_t tx_remap_affinity_2:4;
340 };
341 
342 struct mlx5_devx_wq_attr {
343 	uint32_t wq_type:4;
344 	uint32_t wq_signature:1;
345 	uint32_t end_padding_mode:2;
346 	uint32_t cd_slave:1;
347 	uint32_t hds_skip_first_sge:1;
348 	uint32_t log2_hds_buf_size:3;
349 	uint32_t page_offset:5;
350 	uint32_t lwm:16;
351 	uint32_t pd:24;
352 	uint32_t uar_page:24;
353 	uint64_t dbr_addr;
354 	uint32_t hw_counter;
355 	uint32_t sw_counter;
356 	uint32_t log_wq_stride:4;
357 	uint32_t log_wq_pg_sz:5;
358 	uint32_t log_wq_sz:5;
359 	uint32_t dbr_umem_valid:1;
360 	uint32_t wq_umem_valid:1;
361 	uint32_t log_hairpin_num_packets:5;
362 	uint32_t log_hairpin_data_sz:5;
363 	uint32_t single_wqe_log_num_of_strides:4;
364 	uint32_t two_byte_shift_en:1;
365 	uint32_t single_stride_log_num_of_bytes:3;
366 	uint32_t dbr_umem_id;
367 	uint32_t wq_umem_id;
368 	uint64_t wq_umem_offset;
369 };
370 
371 /* Create RQ attributes structure, used by create RQ operation. */
372 struct mlx5_devx_create_rq_attr {
373 	uint32_t rlky:1;
374 	uint32_t delay_drop_en:1;
375 	uint32_t scatter_fcs:1;
376 	uint32_t vsd:1;
377 	uint32_t mem_rq_type:4;
378 	uint32_t state:4;
379 	uint32_t flush_in_error_en:1;
380 	uint32_t hairpin:1;
381 	uint32_t hairpin_data_buffer_type:3;
382 	uint32_t ts_format:2;
383 	uint32_t user_index:24;
384 	uint32_t cqn:24;
385 	uint32_t counter_set_id:8;
386 	uint32_t rmpn:24;
387 	struct mlx5_devx_wq_attr wq_attr;
388 };
389 
390 /* Modify RQ attributes structure, used by modify RQ operation. */
391 struct mlx5_devx_modify_rq_attr {
392 	uint32_t rqn:24;
393 	uint32_t rq_state:4; /* Current RQ state. */
394 	uint32_t state:4; /* Required RQ state. */
395 	uint32_t scatter_fcs:1;
396 	uint32_t vsd:1;
397 	uint32_t counter_set_id:8;
398 	uint32_t hairpin_peer_sq:24;
399 	uint32_t hairpin_peer_vhca:16;
400 	uint64_t modify_bitmask;
401 	uint32_t lwm:16; /* Contained WQ lwm. */
402 };
403 
404 /* Create RMP attributes structure, used by create RMP operation. */
405 struct mlx5_devx_create_rmp_attr {
406 	uint32_t rsvd0:8;
407 	uint32_t state:4;
408 	uint32_t rsvd1:20;
409 	uint32_t basic_cyclic_rcv_wqe:1;
410 	uint32_t rsvd4:31;
411 	uint32_t rsvd8[10];
412 	struct mlx5_devx_wq_attr wq_attr;
413 };
414 
415 struct mlx5_rx_hash_field_select {
416 	uint32_t l3_prot_type:1;
417 	uint32_t l4_prot_type:1;
418 	uint32_t selected_fields:30;
419 };
420 
421 /* TIR attributes structure, used by TIR operations. */
422 struct mlx5_devx_tir_attr {
423 	uint32_t disp_type:4;
424 	uint32_t lro_timeout_period_usecs:16;
425 	uint32_t lro_enable_mask:4;
426 	uint32_t lro_max_msg_sz:8;
427 	uint32_t inline_rqn:24;
428 	uint32_t rx_hash_symmetric:1;
429 	uint32_t tunneled_offload_en:1;
430 	uint32_t indirect_table:24;
431 	uint32_t rx_hash_fn:4;
432 	uint32_t self_lb_block:2;
433 	uint32_t transport_domain:24;
434 	uint8_t rx_hash_toeplitz_key[MLX5_RSS_HASH_KEY_LEN];
435 	struct mlx5_rx_hash_field_select rx_hash_field_selector_outer;
436 	struct mlx5_rx_hash_field_select rx_hash_field_selector_inner;
437 };
438 
439 /* TIR attributes structure, used by TIR modify. */
440 struct mlx5_devx_modify_tir_attr {
441 	uint32_t tirn:24;
442 	uint64_t modify_bitmask;
443 	struct mlx5_devx_tir_attr tir;
444 };
445 
446 /* RQT attributes structure, used by RQT operations. */
447 struct mlx5_devx_rqt_attr {
448 	uint8_t rq_type;
449 	uint32_t rqt_max_size:16;
450 	uint32_t rqt_actual_size:16;
451 	uint32_t rq_list[];
452 };
453 
454 /* TIS attributes structure. */
455 struct mlx5_devx_tis_attr {
456 	uint32_t strict_lag_tx_port_affinity:1;
457 	uint32_t tls_en:1;
458 	uint32_t lag_tx_port_affinity:4;
459 	uint32_t prio:4;
460 	uint32_t transport_domain:24;
461 };
462 
463 /* SQ attributes structure, used by SQ create operation. */
464 struct mlx5_devx_create_sq_attr {
465 	uint32_t rlky:1;
466 	uint32_t cd_master:1;
467 	uint32_t fre:1;
468 	uint32_t flush_in_error_en:1;
469 	uint32_t allow_multi_pkt_send_wqe:1;
470 	uint32_t min_wqe_inline_mode:3;
471 	uint32_t state:4;
472 	uint32_t reg_umr:1;
473 	uint32_t allow_swp:1;
474 	uint32_t hairpin:1;
475 	uint32_t non_wire:1;
476 	uint32_t static_sq_wq:1;
477 	uint32_t ts_format:2;
478 	uint32_t hairpin_wq_buffer_type:3;
479 	uint32_t user_index:24;
480 	uint32_t cqn:24;
481 	uint32_t packet_pacing_rate_limit_index:16;
482 	uint32_t tis_lst_sz:16;
483 	uint32_t tis_num:24;
484 	struct mlx5_devx_wq_attr wq_attr;
485 };
486 
487 /* SQ attributes structure, used by SQ modify operation. */
488 struct mlx5_devx_modify_sq_attr {
489 	uint32_t sq_state:4;
490 	uint32_t state:4;
491 	uint32_t hairpin_peer_rq:24;
492 	uint32_t hairpin_peer_vhca:16;
493 };
494 
495 
496 /* CQ attributes structure, used by CQ operations. */
497 struct mlx5_devx_cq_attr {
498 	uint32_t q_umem_valid:1;
499 	uint32_t db_umem_valid:1;
500 	uint32_t use_first_only:1;
501 	uint32_t overrun_ignore:1;
502 	uint32_t cqe_comp_en:1;
503 	uint32_t mini_cqe_res_format:2;
504 	uint32_t mini_cqe_res_format_ext:2;
505 	uint32_t cqe_comp_layout:2;
506 	uint32_t log_cq_size:5;
507 	uint32_t log_page_size:5;
508 	uint32_t uar_page_id;
509 	uint32_t q_umem_id;
510 	uint64_t q_umem_offset;
511 	uint32_t db_umem_id;
512 	uint64_t db_umem_offset;
513 	uint32_t eqn;
514 	uint64_t db_addr;
515 };
516 
517 /* Virtq attributes structure, used by VIRTQ operations. */
518 struct mlx5_devx_virtq_attr {
519 	uint16_t hw_available_index;
520 	uint16_t hw_used_index;
521 	uint16_t q_size;
522 	uint32_t pd:24;
523 	uint32_t virtio_version_1_0:1;
524 	uint32_t tso_ipv4:1;
525 	uint32_t tso_ipv6:1;
526 	uint32_t tx_csum:1;
527 	uint32_t rx_csum:1;
528 	uint32_t event_mode:3;
529 	uint32_t state:4;
530 	uint32_t hw_latency_mode:2;
531 	uint32_t hw_max_latency_us:12;
532 	uint32_t hw_max_pending_comp:16;
533 	uint32_t dirty_bitmap_dump_enable:1;
534 	uint32_t dirty_bitmap_mkey;
535 	uint32_t dirty_bitmap_size;
536 	uint32_t mkey;
537 	uint32_t qp_id;
538 	uint32_t queue_index;
539 	uint32_t tis_id;
540 	uint32_t counters_obj_id;
541 	uint64_t dirty_bitmap_addr;
542 	uint64_t mod_fields_bitmap;
543 	uint64_t desc_addr;
544 	uint64_t used_addr;
545 	uint64_t available_addr;
546 	struct {
547 		uint32_t id;
548 		uint32_t size;
549 		uint64_t offset;
550 	} umems[3];
551 	uint8_t error_type;
552 	uint8_t q_type;
553 };
554 
555 struct mlx5_devx_qp_attr {
556 	uint32_t pd:24;
557 	uint32_t uar_index:24;
558 	uint32_t cqn:24;
559 	uint32_t log_page_size:5;
560 	uint32_t num_of_receive_wqes:17; /* Must be power of 2. */
561 	uint32_t log_rq_stride:3;
562 	uint32_t num_of_send_wqbbs:17; /* Must be power of 2. */
563 	uint32_t ts_format:2;
564 	uint32_t dbr_umem_valid:1;
565 	uint32_t dbr_umem_id;
566 	uint64_t dbr_address;
567 	uint32_t wq_umem_id;
568 	uint64_t wq_umem_offset;
569 	uint32_t user_index:24;
570 	uint32_t mmo:1;
571 	uint32_t cd_master:1;
572 	uint32_t cd_slave_send:1;
573 	uint32_t cd_slave_recv:1;
574 };
575 
576 struct mlx5_devx_virtio_q_couners_attr {
577 	uint64_t received_desc;
578 	uint64_t completed_desc;
579 	uint32_t error_cqes;
580 	uint32_t bad_desc_errors;
581 	uint32_t exceed_max_chain;
582 	uint32_t invalid_buffer;
583 };
584 
585 /*
586  * Match sample info attributes structure, used by:
587  *  - GENEVE TLV option query.
588  *  - Graph flow match sample query.
589  */
590 struct mlx5_devx_match_sample_info_query_attr {
591 	uint32_t modify_field_id:12;
592 	uint32_t sample_dw_data:8;
593 	uint32_t sample_dw_ok_bit:8;
594 	uint32_t sample_dw_ok_bit_offset:5;
595 };
596 
597 /*
598  * graph flow match sample attributes structure,
599  * used by flex parser operations.
600  */
601 struct mlx5_devx_match_sample_attr {
602 	uint32_t flow_match_sample_en:1;
603 	uint32_t flow_match_sample_field_offset:16;
604 	uint32_t flow_match_sample_offset_mode:4;
605 	uint32_t flow_match_sample_field_offset_mask;
606 	uint32_t flow_match_sample_field_offset_shift:4;
607 	uint32_t flow_match_sample_field_base_offset:8;
608 	uint32_t flow_match_sample_tunnel_mode:3;
609 	uint32_t flow_match_sample_field_id;
610 };
611 
612 /* graph node arc attributes structure, used by flex parser operations. */
613 struct mlx5_devx_graph_arc_attr {
614 	uint32_t compare_condition_value:16;
615 	uint32_t start_inner_tunnel:1;
616 	uint32_t arc_parse_graph_node:8;
617 	uint32_t parse_graph_node_handle;
618 };
619 
620 /* Maximal number of samples per graph node. */
621 #define MLX5_GRAPH_NODE_SAMPLE_NUM 8
622 
623 /* Maximal number of input/output arcs per graph node. */
624 #define MLX5_GRAPH_NODE_ARC_NUM 8
625 
626 /* parse graph node attributes structure, used by flex parser operations. */
627 struct mlx5_devx_graph_node_attr {
628 	uint32_t modify_field_select;
629 	uint32_t header_length_mode:4;
630 	uint32_t header_length_base_value:16;
631 	uint32_t header_length_field_shift:4;
632 	uint32_t header_length_field_offset:16;
633 	uint32_t header_length_field_mask;
634 	struct mlx5_devx_match_sample_attr sample[MLX5_GRAPH_NODE_SAMPLE_NUM];
635 	uint32_t next_header_field_offset:16;
636 	uint32_t next_header_field_size:5;
637 	struct mlx5_devx_graph_arc_attr in[MLX5_GRAPH_NODE_ARC_NUM];
638 	struct mlx5_devx_graph_arc_attr out[MLX5_GRAPH_NODE_ARC_NUM];
639 };
640 
641 /* Encryption key size is up to 1024 bit, 128 bytes. */
642 #define MLX5_CRYPTO_KEY_MAX_SIZE	128
643 
644 struct mlx5_devx_dek_attr {
645 	uint32_t key_size:4;
646 	uint32_t has_keytag:1;
647 	uint32_t key_purpose:4;
648 	uint32_t pd:24;
649 	uint64_t opaque;
650 	uint8_t key[MLX5_CRYPTO_KEY_MAX_SIZE];
651 };
652 
653 struct mlx5_devx_import_kek_attr {
654 	uint64_t modify_field_select;
655 	uint32_t state:8;
656 	uint32_t key_size:4;
657 	uint8_t key[MLX5_CRYPTO_KEY_MAX_SIZE];
658 };
659 
660 #define MLX5_CRYPTO_CREDENTIAL_SIZE	48
661 
662 struct mlx5_devx_credential_attr {
663 	uint64_t modify_field_select;
664 	uint32_t state:8;
665 	uint32_t credential_role:8;
666 	uint8_t credential[MLX5_CRYPTO_CREDENTIAL_SIZE];
667 };
668 
669 struct mlx5_devx_crypto_login_attr {
670 	uint64_t modify_field_select;
671 	uint32_t credential_pointer:24;
672 	uint32_t session_import_kek_ptr:24;
673 	uint8_t credential[MLX5_CRYPTO_CREDENTIAL_SIZE];
674 };
675 
676 /*
677  * GENEVE TLV option attributes structure, used by GENEVE TLV option create.
678  */
679 struct mlx5_devx_geneve_tlv_option_attr {
680 	uint32_t option_class:16;
681 	uint32_t option_type:8;
682 	uint32_t option_data_len:5;
683 	uint32_t option_class_ignore:1;
684 	uint32_t offset_valid:1;
685 	uint32_t sample_offset:8;
686 };
687 
688 /* mlx5_devx_cmds.c */
689 
690 __rte_internal
691 struct mlx5_devx_obj *
692 mlx5_devx_cmd_flow_counter_alloc_general(void *ctx,
693 				struct mlx5_devx_counter_attr *attr);
694 
695 __rte_internal
696 struct mlx5_devx_obj *mlx5_devx_cmd_flow_counter_alloc(void *ctx,
697 						       uint32_t bulk_sz);
698 __rte_internal
699 int mlx5_devx_cmd_destroy(struct mlx5_devx_obj *obj);
700 __rte_internal
701 int mlx5_devx_cmd_flow_counter_query(struct mlx5_devx_obj *dcs,
702 				     int clear, uint32_t n_counters,
703 				     uint64_t *pkts, uint64_t *bytes,
704 				     uint32_t mkey, void *addr,
705 				     void *cmd_comp,
706 				     uint64_t async_id);
707 __rte_internal
708 int mlx5_devx_cmd_query_hca_attr(void *ctx,
709 				 struct mlx5_hca_attr *attr);
710 __rte_internal
711 struct mlx5_devx_obj *mlx5_devx_cmd_mkey_create(void *ctx,
712 					      struct mlx5_devx_mkey_attr *attr);
713 __rte_internal
714 int mlx5_devx_get_out_command_status(void *out);
715 __rte_internal
716 int mlx5_devx_cmd_qp_query_tis_td(void *qp, uint32_t tis_num,
717 				  uint32_t *tis_td);
718 __rte_internal
719 struct mlx5_devx_obj *mlx5_devx_cmd_create_rq(void *ctx,
720 				       struct mlx5_devx_create_rq_attr *rq_attr,
721 				       int socket);
722 __rte_internal
723 int mlx5_devx_cmd_modify_rq(struct mlx5_devx_obj *rq,
724 			    struct mlx5_devx_modify_rq_attr *rq_attr);
725 __rte_internal
726 struct mlx5_devx_obj *mlx5_devx_cmd_create_rmp(void *ctx,
727 			struct mlx5_devx_create_rmp_attr *rq_attr, int socket);
728 __rte_internal
729 struct mlx5_devx_obj *mlx5_devx_cmd_create_tir(void *ctx,
730 					   struct mlx5_devx_tir_attr *tir_attr);
731 __rte_internal
732 struct mlx5_devx_obj *mlx5_devx_cmd_create_rqt(void *ctx,
733 					   struct mlx5_devx_rqt_attr *rqt_attr);
734 __rte_internal
735 struct mlx5_devx_obj *mlx5_devx_cmd_create_sq(void *ctx,
736 				      struct mlx5_devx_create_sq_attr *sq_attr);
737 __rte_internal
738 int mlx5_devx_cmd_modify_sq(struct mlx5_devx_obj *sq,
739 			    struct mlx5_devx_modify_sq_attr *sq_attr);
740 __rte_internal
741 int mlx5_devx_cmd_query_sq(struct mlx5_devx_obj *sq, void *out, size_t outlen);
742 
743 __rte_internal
744 int mlx5_devx_cmd_query_cq(struct mlx5_devx_obj *cq, void *out, size_t outlen);
745 
746 __rte_internal
747 int mlx5_devx_cmd_query_rq(struct mlx5_devx_obj *rq, void *out, size_t outlen);
748 
749 __rte_internal
750 struct mlx5_devx_obj *mlx5_devx_cmd_create_tis(void *ctx,
751 					   struct mlx5_devx_tis_attr *tis_attr);
752 __rte_internal
753 struct mlx5_devx_obj *mlx5_devx_cmd_create_td(void *ctx);
754 __rte_internal
755 int mlx5_devx_cmd_flow_dump(void *fdb_domain, void *rx_domain, void *tx_domain,
756 			    FILE *file);
757 __rte_internal
758 int mlx5_devx_cmd_flow_single_dump(void *rule, FILE *file);
759 __rte_internal
760 struct mlx5_devx_obj *mlx5_devx_cmd_create_cq(void *ctx,
761 					      struct mlx5_devx_cq_attr *attr);
762 __rte_internal
763 struct mlx5_devx_obj *mlx5_devx_cmd_create_virtq(void *ctx,
764 					     struct mlx5_devx_virtq_attr *attr);
765 __rte_internal
766 int mlx5_devx_cmd_modify_virtq(struct mlx5_devx_obj *virtq_obj,
767 			       struct mlx5_devx_virtq_attr *attr);
768 __rte_internal
769 int mlx5_devx_cmd_query_virtq(struct mlx5_devx_obj *virtq_obj,
770 			      struct mlx5_devx_virtq_attr *attr);
771 __rte_internal
772 struct mlx5_devx_obj *mlx5_devx_cmd_create_qp(void *ctx,
773 					      struct mlx5_devx_qp_attr *attr);
774 __rte_internal
775 int mlx5_devx_cmd_modify_qp_state(struct mlx5_devx_obj *qp,
776 				  uint32_t qp_st_mod_op, uint32_t remote_qp_id);
777 __rte_internal
778 int mlx5_devx_cmd_modify_rqt(struct mlx5_devx_obj *rqt,
779 			     struct mlx5_devx_rqt_attr *rqt_attr);
780 __rte_internal
781 int mlx5_devx_cmd_modify_tir(struct mlx5_devx_obj *tir,
782 			     struct mlx5_devx_modify_tir_attr *tir_attr);
783 __rte_internal
784 int mlx5_devx_cmd_match_sample_info_query(void *ctx, uint32_t sample_field_id,
785 					  struct mlx5_devx_match_sample_info_query_attr *attr);
786 __rte_internal
787 int mlx5_devx_cmd_query_parse_samples(struct mlx5_devx_obj *flex_obj,
788 				      uint32_t *ids,
789 				      uint32_t num, uint8_t *anchor);
790 
791 __rte_internal
792 struct mlx5_devx_obj *
793 mlx5_devx_cmd_create_flex_parser(void *ctx,
794 				 struct mlx5_devx_graph_node_attr *data);
795 
796 __rte_internal
797 int mlx5_devx_cmd_register_read(void *ctx, uint16_t reg_id,
798 				uint32_t arg, uint32_t *data, uint32_t dw_cnt);
799 
800 __rte_internal
801 int mlx5_devx_cmd_register_write(void *ctx, uint16_t reg_id,
802 				 uint32_t arg, uint32_t *data, uint32_t dw_cnt);
803 
804 __rte_internal
805 struct mlx5_devx_obj *
806 mlx5_devx_cmd_create_geneve_tlv_option(void *ctx,
807 				 struct mlx5_devx_geneve_tlv_option_attr *attr);
808 
809 __rte_internal
810 int
811 mlx5_devx_cmd_query_geneve_tlv_option(void *ctx,
812 				      struct mlx5_devx_obj *geneve_tlv_opt_obj,
813 				      struct mlx5_devx_match_sample_info_query_attr *attr);
814 
815 /**
816  * Create virtio queue counters object DevX API.
817  *
818  * @param[in] ctx
819  *   Device context.
820 
821  * @return
822  *   The DevX object created, NULL otherwise and rte_errno is set.
823  */
824 __rte_internal
825 struct mlx5_devx_obj *mlx5_devx_cmd_create_virtio_q_counters(void *ctx);
826 
827 /**
828  * Query virtio queue counters object using DevX API.
829  *
830  * @param[in] couners_obj
831  *   Pointer to virtq object structure.
832  * @param [in/out] attr
833  *   Pointer to virtio queue counters attributes structure.
834  *
835  * @return
836  *   0 on success, a negative errno value otherwise and rte_errno is set.
837  */
838 __rte_internal
839 int mlx5_devx_cmd_query_virtio_q_counters(struct mlx5_devx_obj *couners_obj,
840 				  struct mlx5_devx_virtio_q_couners_attr *attr);
841 __rte_internal
842 struct mlx5_devx_obj *mlx5_devx_cmd_create_flow_hit_aso_obj(void *ctx,
843 							    uint32_t pd);
844 __rte_internal
845 struct mlx5_devx_obj *mlx5_devx_cmd_alloc_pd(void *ctx);
846 
847 __rte_internal
848 int mlx5_devx_cmd_wq_query(void *wq, uint32_t *counter_set_id);
849 
850 __rte_internal
851 struct mlx5_devx_obj *mlx5_devx_cmd_queue_counter_alloc(void *ctx);
852 __rte_internal
853 int mlx5_devx_cmd_queue_counter_query(struct mlx5_devx_obj *dcs, int clear,
854 				      uint32_t *out_of_buffers);
855 __rte_internal
856 struct mlx5_devx_obj *mlx5_devx_cmd_create_conn_track_offload_obj(void *ctx,
857 					uint32_t pd, uint32_t log_obj_size);
858 
859 /**
860  * Create general object of type FLOW_METER_ASO using DevX API..
861  *
862  * @param[in] ctx
863  *   Device context.
864  * @param [in] pd
865  *   PD value to associate the FLOW_METER_ASO object with.
866  * @param [in] log_obj_size
867  *   log_obj_size define to allocate number of 2 * meters
868  *   in one FLOW_METER_ASO object.
869  *
870  * @return
871  *   The DevX object created, NULL otherwise and rte_errno is set.
872  */
873 __rte_internal
874 struct mlx5_devx_obj *mlx5_devx_cmd_create_flow_meter_aso_obj(void *ctx,
875 					uint32_t pd, uint32_t log_obj_size);
876 __rte_internal
877 struct mlx5_devx_obj *
878 mlx5_devx_cmd_create_dek_obj(void *ctx, struct mlx5_devx_dek_attr *attr);
879 
880 __rte_internal
881 struct mlx5_devx_obj *
882 mlx5_devx_cmd_create_import_kek_obj(void *ctx,
883 				    struct mlx5_devx_import_kek_attr *attr);
884 
885 __rte_internal
886 struct mlx5_devx_obj *
887 mlx5_devx_cmd_create_credential_obj(void *ctx,
888 				    struct mlx5_devx_credential_attr *attr);
889 
890 __rte_internal
891 struct mlx5_devx_obj *
892 mlx5_devx_cmd_create_crypto_login_obj(void *ctx,
893 				      struct mlx5_devx_crypto_login_attr *attr);
894 
895 __rte_internal
896 int
897 mlx5_devx_cmd_query_lag(void *ctx,
898 			struct mlx5_devx_lag_context *lag_ctx);
899 
900 #endif /* RTE_PMD_MLX5_DEVX_CMDS_H_ */
901