1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2019 Mellanox Technologies, Ltd
5 #ifndef RTE_PMD_MLX5_DEVX_CMDS_H_
6 #define RTE_PMD_MLX5_DEVX_CMDS_H_
10 #include <rte_compat.h>
13 * Defines the amount of retries to allocate the first UAR in the page.
14 * OFED 5.0.x and Upstream rdma_core before v29 returned the NULL as
15 * UAR base address if UAR was not the first object in the UAR page.
16 * It caused the PMD failure and we should try to get another UAR
17 * till we get the first one with non-NULL base address returned.
19 #define MLX5_ALLOC_UAR_RETRY 32
21 /* This is limitation of libibverbs: in length variable type is u16. */
22 #define MLX5_DEVX_MAX_KLM_ENTRIES ((UINT16_MAX - \
23 MLX5_ST_SZ_DW(create_mkey_in) * 4) / (MLX5_ST_SZ_DW(klm) * 4))
25 struct mlx5_devx_mkey_attr {
30 uint32_t log_entity_size;
32 uint32_t relaxed_ordering_write:1;
33 uint32_t relaxed_ordering_read:1;
36 uint32_t set_remote_rw:1;
37 struct mlx5_klm *klm_array;
41 /* HCA qos attributes. */
42 struct mlx5_hca_qos_attr {
43 uint32_t sup:1; /* Whether QOS is supported. */
44 uint32_t flow_meter_old:1; /* Flow meter is supported, old version. */
45 uint32_t packet_pacing:1; /* Packet pacing is supported. */
46 uint32_t wqe_rate_pp:1; /* Packet pacing WQE rate mode. */
47 uint32_t flow_meter:1;
49 * Flow meter is supported, updated version.
50 * When flow_meter is 1, it indicates that REG_C sharing is supported.
51 * If flow_meter is 1, flow_meter_old is also 1.
52 * Using older driver versions, flow_meter_old can be 1
53 * while flow_meter is 0.
55 uint32_t flow_meter_aso_sup:1;
56 /* Whether FLOW_METER_ASO Object is supported. */
57 uint8_t log_max_flow_meter;
58 /* Power of the maximum supported meters. */
59 uint8_t flow_meter_reg_c_ids;
60 /* Bitmap of the reg_Cs available for flow meter to use. */
61 uint32_t log_meter_aso_granularity:5;
62 /* Power of the minimum allocation granularity Object. */
63 uint32_t log_meter_aso_max_alloc:5;
64 /* Power of the maximum allocation granularity Object. */
65 uint32_t log_max_num_meter_aso:5;
66 /* Power of the maximum number of supported objects. */
70 struct mlx5_hca_vdpa_attr {
71 uint8_t virtio_queue_type;
73 uint32_t desc_tunnel_offload_type:1;
74 uint32_t eth_frame_offload_type:1;
75 uint32_t virtio_version_1_0:1;
80 uint32_t event_mode:3;
81 uint32_t log_doorbell_stride:5;
82 uint32_t log_doorbell_bar_size:5;
83 uint32_t queue_counters_valid:1;
84 uint32_t max_num_virtio_queues;
89 uint64_t doorbell_bar_offset;
92 /* HCA supports this number of time periods for LRO. */
93 #define MLX5_LRO_NUM_SUPP_PERIODS 4
96 struct mlx5_hca_attr {
97 uint32_t eswitch_manager:1;
98 uint32_t flow_counters_dump:1;
99 uint32_t log_max_rqt_size:5;
100 uint32_t parse_graph_flex_node:1;
101 uint8_t flow_counter_bulk_alloc_bitmap;
102 uint32_t eth_net_offloads:1;
104 uint32_t wqe_vlan_insert:1;
106 uint32_t wqe_inline_mode:2;
107 uint32_t vport_inline_mode:3;
108 uint32_t tunnel_stateless_geneve_rx:1;
109 uint32_t geneve_max_opt_len:1; /* 0x0: 14DW, 0x1: 63DW */
110 uint32_t tunnel_stateless_gtp:1;
112 uint32_t tunnel_lro_gre:1;
113 uint32_t tunnel_lro_vxlan:1;
114 uint32_t lro_max_msg_sz_mode:2;
115 uint32_t lro_timer_supported_periods[MLX5_LRO_NUM_SUPP_PERIODS];
116 uint16_t lro_min_mss_size;
117 uint32_t flex_parser_protocols;
118 uint32_t max_geneve_tlv_options;
119 uint32_t max_geneve_tlv_option_data_len;
121 uint32_t log_max_hairpin_queues:5;
122 uint32_t log_max_hairpin_wq_data_sz:5;
123 uint32_t log_max_hairpin_num_packets:5;
125 uint32_t relaxed_ordering_write:1;
126 uint32_t relaxed_ordering_read:1;
127 uint32_t access_register_user:1;
128 uint32_t wqe_index_ignore:1;
129 uint32_t cross_channel:1;
130 uint32_t non_wire_sq:1; /* SQ with non-wire ops is supported. */
131 uint32_t log_max_static_sq_wq:5; /* Static WQE size SQ. */
132 uint32_t num_lag_ports:4; /* Number of ports can be bonded. */
133 uint32_t dev_freq_khz; /* Timestamp counter frequency, kHz. */
134 uint32_t scatter_fcs_w_decap_disable:1;
135 uint32_t flow_hit_aso:1; /* General obj type FLOW_HIT_ASO supported. */
137 uint32_t rq_ts_format:2;
138 uint32_t sq_ts_format:2;
139 uint32_t qp_ts_format:2;
141 uint32_t reg_c_preserve:1;
142 uint32_t crypto:1; /* Crypto engine is supported. */
143 uint32_t aes_xts:1; /* AES-XTS crypto is supported. */
144 uint32_t dek:1; /* General obj type DEK is supported. */
145 uint32_t import_kek:1; /* General obj type IMPORT_KEK supported. */
146 uint32_t credential:1; /* General obj type CREDENTIAL supported. */
147 uint32_t crypto_login:1; /* General obj type CRYPTO_LOGIN supported. */
148 uint32_t regexp_num_of_engines;
149 uint32_t log_max_ft_sampler_num:8;
150 uint32_t geneve_tlv_opt;
151 uint32_t cqe_compression:1;
152 uint32_t mini_cqe_resp_flow_tag:1;
153 uint32_t mini_cqe_resp_l3_l4_tag:1;
154 uint32_t pkt_integrity_match:1; /* 1 if HW supports integrity item */
155 struct mlx5_hca_qos_attr qos;
156 struct mlx5_hca_vdpa_attr vdpa;
162 uint32_t log_max_mrw_sz;
163 uint32_t log_max_srq;
164 uint32_t log_max_srq_sz;
165 uint32_t rss_ind_tbl_cap;
166 uint32_t mmo_dma_en:1;
167 uint32_t mmo_compress_en:1;
168 uint32_t mmo_decompress_en:1;
169 uint32_t compress_min_block_size:4;
170 uint32_t log_max_mmo_dma:5;
171 uint32_t log_max_mmo_compress:5;
172 uint32_t log_max_mmo_decompress:5;
173 uint32_t umr_modify_entity_size_disabled:1;
174 uint32_t umr_indirect_mkey_disabled:1;
177 struct mlx5_devx_wq_attr {
179 uint32_t wq_signature:1;
180 uint32_t end_padding_mode:2;
182 uint32_t hds_skip_first_sge:1;
183 uint32_t log2_hds_buf_size:3;
184 uint32_t page_offset:5;
187 uint32_t uar_page:24;
191 uint32_t log_wq_stride:4;
192 uint32_t log_wq_pg_sz:5;
193 uint32_t log_wq_sz:5;
194 uint32_t dbr_umem_valid:1;
195 uint32_t wq_umem_valid:1;
196 uint32_t log_hairpin_num_packets:5;
197 uint32_t log_hairpin_data_sz:5;
198 uint32_t single_wqe_log_num_of_strides:4;
199 uint32_t two_byte_shift_en:1;
200 uint32_t single_stride_log_num_of_bytes:3;
201 uint32_t dbr_umem_id;
203 uint64_t wq_umem_offset;
206 /* Create RQ attributes structure, used by create RQ operation. */
207 struct mlx5_devx_create_rq_attr {
209 uint32_t delay_drop_en:1;
210 uint32_t scatter_fcs:1;
212 uint32_t mem_rq_type:4;
214 uint32_t flush_in_error_en:1;
216 uint32_t ts_format:2;
217 uint32_t user_index:24;
219 uint32_t counter_set_id:8;
221 struct mlx5_devx_wq_attr wq_attr;
224 /* Modify RQ attributes structure, used by modify RQ operation. */
225 struct mlx5_devx_modify_rq_attr {
227 uint32_t rq_state:4; /* Current RQ state. */
228 uint32_t state:4; /* Required RQ state. */
229 uint32_t scatter_fcs:1;
231 uint32_t counter_set_id:8;
232 uint32_t hairpin_peer_sq:24;
233 uint32_t hairpin_peer_vhca:16;
234 uint64_t modify_bitmask;
235 uint32_t lwm:16; /* Contained WQ lwm. */
238 struct mlx5_rx_hash_field_select {
239 uint32_t l3_prot_type:1;
240 uint32_t l4_prot_type:1;
241 uint32_t selected_fields:30;
244 /* TIR attributes structure, used by TIR operations. */
245 struct mlx5_devx_tir_attr {
246 uint32_t disp_type:4;
247 uint32_t lro_timeout_period_usecs:16;
248 uint32_t lro_enable_mask:4;
249 uint32_t lro_max_msg_sz:8;
250 uint32_t inline_rqn:24;
251 uint32_t rx_hash_symmetric:1;
252 uint32_t tunneled_offload_en:1;
253 uint32_t indirect_table:24;
254 uint32_t rx_hash_fn:4;
255 uint32_t self_lb_block:2;
256 uint32_t transport_domain:24;
257 uint8_t rx_hash_toeplitz_key[MLX5_RSS_HASH_KEY_LEN];
258 struct mlx5_rx_hash_field_select rx_hash_field_selector_outer;
259 struct mlx5_rx_hash_field_select rx_hash_field_selector_inner;
262 /* TIR attributes structure, used by TIR modify. */
263 struct mlx5_devx_modify_tir_attr {
265 uint64_t modify_bitmask;
266 struct mlx5_devx_tir_attr tir;
269 /* RQT attributes structure, used by RQT operations. */
270 struct mlx5_devx_rqt_attr {
272 uint32_t rqt_max_size:16;
273 uint32_t rqt_actual_size:16;
277 /* TIS attributes structure. */
278 struct mlx5_devx_tis_attr {
279 uint32_t strict_lag_tx_port_affinity:1;
281 uint32_t lag_tx_port_affinity:4;
283 uint32_t transport_domain:24;
286 /* SQ attributes structure, used by SQ create operation. */
287 struct mlx5_devx_create_sq_attr {
289 uint32_t cd_master:1;
291 uint32_t flush_in_error_en:1;
292 uint32_t allow_multi_pkt_send_wqe:1;
293 uint32_t min_wqe_inline_mode:3;
296 uint32_t allow_swp:1;
299 uint32_t static_sq_wq:1;
300 uint32_t ts_format:2;
301 uint32_t user_index:24;
303 uint32_t packet_pacing_rate_limit_index:16;
304 uint32_t tis_lst_sz:16;
306 struct mlx5_devx_wq_attr wq_attr;
309 /* SQ attributes structure, used by SQ modify operation. */
310 struct mlx5_devx_modify_sq_attr {
313 uint32_t hairpin_peer_rq:24;
314 uint32_t hairpin_peer_vhca:16;
318 /* CQ attributes structure, used by CQ operations. */
319 struct mlx5_devx_cq_attr {
320 uint32_t q_umem_valid:1;
321 uint32_t db_umem_valid:1;
322 uint32_t use_first_only:1;
323 uint32_t overrun_ignore:1;
324 uint32_t cqe_comp_en:1;
325 uint32_t mini_cqe_res_format:2;
326 uint32_t mini_cqe_res_format_ext:2;
327 uint32_t log_cq_size:5;
328 uint32_t log_page_size:5;
329 uint32_t uar_page_id;
331 uint64_t q_umem_offset;
333 uint64_t db_umem_offset;
338 /* Virtq attributes structure, used by VIRTQ operations. */
339 struct mlx5_devx_virtq_attr {
340 uint16_t hw_available_index;
341 uint16_t hw_used_index;
344 uint32_t virtio_version_1_0:1;
349 uint32_t event_mode:3;
351 uint32_t hw_latency_mode:2;
352 uint32_t hw_max_latency_us:12;
353 uint32_t hw_max_pending_comp:16;
354 uint32_t dirty_bitmap_dump_enable:1;
355 uint32_t dirty_bitmap_mkey;
356 uint32_t dirty_bitmap_size;
359 uint32_t queue_index;
361 uint32_t counters_obj_id;
362 uint64_t dirty_bitmap_addr;
366 uint64_t available_addr;
376 struct mlx5_devx_qp_attr {
378 uint32_t uar_index:24;
380 uint32_t log_page_size:5;
381 uint32_t rq_size:17; /* Must be power of 2. */
382 uint32_t log_rq_stride:3;
383 uint32_t sq_size:17; /* Must be power of 2. */
384 uint32_t ts_format:2;
385 uint32_t dbr_umem_valid:1;
386 uint32_t dbr_umem_id;
387 uint64_t dbr_address;
389 uint64_t wq_umem_offset;
392 struct mlx5_devx_virtio_q_couners_attr {
393 uint64_t received_desc;
394 uint64_t completed_desc;
396 uint32_t bad_desc_errors;
397 uint32_t exceed_max_chain;
398 uint32_t invalid_buffer;
402 * graph flow match sample attributes structure,
403 * used by flex parser operations.
405 struct mlx5_devx_match_sample_attr {
406 uint32_t flow_match_sample_en:1;
407 uint32_t flow_match_sample_field_offset:16;
408 uint32_t flow_match_sample_offset_mode:4;
409 uint32_t flow_match_sample_field_offset_mask;
410 uint32_t flow_match_sample_field_offset_shift:4;
411 uint32_t flow_match_sample_field_base_offset:8;
412 uint32_t flow_match_sample_tunnel_mode:3;
413 uint32_t flow_match_sample_field_id;
416 /* graph node arc attributes structure, used by flex parser operations. */
417 struct mlx5_devx_graph_arc_attr {
418 uint32_t compare_condition_value:16;
419 uint32_t start_inner_tunnel:1;
420 uint32_t arc_parse_graph_node:8;
421 uint32_t parse_graph_node_handle;
424 /* Maximal number of samples per graph node. */
425 #define MLX5_GRAPH_NODE_SAMPLE_NUM 8
427 /* Maximal number of input/output arcs per graph node. */
428 #define MLX5_GRAPH_NODE_ARC_NUM 8
430 /* parse graph node attributes structure, used by flex parser operations. */
431 struct mlx5_devx_graph_node_attr {
432 uint32_t modify_field_select;
433 uint32_t header_length_mode:4;
434 uint32_t header_length_base_value:16;
435 uint32_t header_length_field_shift:4;
436 uint32_t header_length_field_offset:16;
437 uint32_t header_length_field_mask;
438 struct mlx5_devx_match_sample_attr sample[MLX5_GRAPH_NODE_SAMPLE_NUM];
439 uint32_t next_header_field_offset:16;
440 uint32_t next_header_field_size:5;
441 struct mlx5_devx_graph_arc_attr in[MLX5_GRAPH_NODE_ARC_NUM];
442 struct mlx5_devx_graph_arc_attr out[MLX5_GRAPH_NODE_ARC_NUM];
445 /* Encryption key size is up to 1024 bit, 128 bytes. */
446 #define MLX5_CRYPTO_KEY_MAX_SIZE 128
448 struct mlx5_devx_dek_attr {
450 uint32_t has_keytag:1;
451 uint32_t key_purpose:4;
454 uint8_t key[MLX5_CRYPTO_KEY_MAX_SIZE];
457 struct mlx5_devx_import_kek_attr {
458 uint64_t modify_field_select;
461 uint8_t key[MLX5_CRYPTO_KEY_MAX_SIZE];
464 #define MLX5_CRYPTO_CREDENTIAL_SIZE 48
466 struct mlx5_devx_credential_attr {
467 uint64_t modify_field_select;
469 uint32_t credential_role:8;
470 uint8_t credential[MLX5_CRYPTO_CREDENTIAL_SIZE];
473 struct mlx5_devx_crypto_login_attr {
474 uint64_t modify_field_select;
475 uint32_t credential_pointer:24;
476 uint32_t session_import_kek_ptr:24;
477 uint8_t credential[MLX5_CRYPTO_CREDENTIAL_SIZE];
480 /* mlx5_devx_cmds.c */
483 struct mlx5_devx_obj *mlx5_devx_cmd_flow_counter_alloc(void *ctx,
486 int mlx5_devx_cmd_destroy(struct mlx5_devx_obj *obj);
488 int mlx5_devx_cmd_flow_counter_query(struct mlx5_devx_obj *dcs,
489 int clear, uint32_t n_counters,
490 uint64_t *pkts, uint64_t *bytes,
491 uint32_t mkey, void *addr,
495 int mlx5_devx_cmd_query_hca_attr(void *ctx,
496 struct mlx5_hca_attr *attr);
498 struct mlx5_devx_obj *mlx5_devx_cmd_mkey_create(void *ctx,
499 struct mlx5_devx_mkey_attr *attr);
501 int mlx5_devx_get_out_command_status(void *out);
503 int mlx5_devx_cmd_qp_query_tis_td(void *qp, uint32_t tis_num,
506 struct mlx5_devx_obj *mlx5_devx_cmd_create_rq(void *ctx,
507 struct mlx5_devx_create_rq_attr *rq_attr,
510 int mlx5_devx_cmd_modify_rq(struct mlx5_devx_obj *rq,
511 struct mlx5_devx_modify_rq_attr *rq_attr);
513 struct mlx5_devx_obj *mlx5_devx_cmd_create_tir(void *ctx,
514 struct mlx5_devx_tir_attr *tir_attr);
516 struct mlx5_devx_obj *mlx5_devx_cmd_create_rqt(void *ctx,
517 struct mlx5_devx_rqt_attr *rqt_attr);
519 struct mlx5_devx_obj *mlx5_devx_cmd_create_sq(void *ctx,
520 struct mlx5_devx_create_sq_attr *sq_attr);
522 int mlx5_devx_cmd_modify_sq(struct mlx5_devx_obj *sq,
523 struct mlx5_devx_modify_sq_attr *sq_attr);
525 struct mlx5_devx_obj *mlx5_devx_cmd_create_tis(void *ctx,
526 struct mlx5_devx_tis_attr *tis_attr);
528 struct mlx5_devx_obj *mlx5_devx_cmd_create_td(void *ctx);
530 int mlx5_devx_cmd_flow_dump(void *fdb_domain, void *rx_domain, void *tx_domain,
533 int mlx5_devx_cmd_flow_single_dump(void *rule, FILE *file);
535 struct mlx5_devx_obj *mlx5_devx_cmd_create_cq(void *ctx,
536 struct mlx5_devx_cq_attr *attr);
538 struct mlx5_devx_obj *mlx5_devx_cmd_create_virtq(void *ctx,
539 struct mlx5_devx_virtq_attr *attr);
541 int mlx5_devx_cmd_modify_virtq(struct mlx5_devx_obj *virtq_obj,
542 struct mlx5_devx_virtq_attr *attr);
544 int mlx5_devx_cmd_query_virtq(struct mlx5_devx_obj *virtq_obj,
545 struct mlx5_devx_virtq_attr *attr);
547 struct mlx5_devx_obj *mlx5_devx_cmd_create_qp(void *ctx,
548 struct mlx5_devx_qp_attr *attr);
550 int mlx5_devx_cmd_modify_qp_state(struct mlx5_devx_obj *qp,
551 uint32_t qp_st_mod_op, uint32_t remote_qp_id);
553 int mlx5_devx_cmd_modify_rqt(struct mlx5_devx_obj *rqt,
554 struct mlx5_devx_rqt_attr *rqt_attr);
556 int mlx5_devx_cmd_modify_tir(struct mlx5_devx_obj *tir,
557 struct mlx5_devx_modify_tir_attr *tir_attr);
559 int mlx5_devx_cmd_query_parse_samples(struct mlx5_devx_obj *flex_obj,
560 uint32_t ids[], uint32_t num);
563 struct mlx5_devx_obj *mlx5_devx_cmd_create_flex_parser(void *ctx,
564 struct mlx5_devx_graph_node_attr *data);
567 int mlx5_devx_cmd_register_read(void *ctx, uint16_t reg_id,
568 uint32_t arg, uint32_t *data, uint32_t dw_cnt);
571 int mlx5_devx_cmd_register_write(void *ctx, uint16_t reg_id,
572 uint32_t arg, uint32_t *data, uint32_t dw_cnt);
575 struct mlx5_devx_obj *
576 mlx5_devx_cmd_create_geneve_tlv_option(void *ctx,
577 uint16_t class, uint8_t type, uint8_t len);
580 * Create virtio queue counters object DevX API.
586 * The DevX object created, NULL otherwise and rte_errno is set.
589 struct mlx5_devx_obj *mlx5_devx_cmd_create_virtio_q_counters(void *ctx);
592 * Query virtio queue counters object using DevX API.
594 * @param[in] couners_obj
595 * Pointer to virtq object structure.
596 * @param [in/out] attr
597 * Pointer to virtio queue counters attributes structure.
600 * 0 on success, a negative errno value otherwise and rte_errno is set.
603 int mlx5_devx_cmd_query_virtio_q_counters(struct mlx5_devx_obj *couners_obj,
604 struct mlx5_devx_virtio_q_couners_attr *attr);
606 struct mlx5_devx_obj *mlx5_devx_cmd_create_flow_hit_aso_obj(void *ctx,
609 struct mlx5_devx_obj *mlx5_devx_cmd_alloc_pd(void *ctx);
612 int mlx5_devx_cmd_wq_query(void *wq, uint32_t *counter_set_id);
615 struct mlx5_devx_obj *mlx5_devx_cmd_queue_counter_alloc(void *ctx);
617 int mlx5_devx_cmd_queue_counter_query(struct mlx5_devx_obj *dcs, int clear,
618 uint32_t *out_of_buffers);
620 * Create general object of type FLOW_METER_ASO using DevX API..
625 * PD value to associate the FLOW_METER_ASO object with.
626 * @param [in] log_obj_size
627 * log_obj_size define to allocate number of 2 * meters
628 * in one FLOW_METER_ASO object.
631 * The DevX object created, NULL otherwise and rte_errno is set.
634 struct mlx5_devx_obj *mlx5_devx_cmd_create_flow_meter_aso_obj(void *ctx,
635 uint32_t pd, uint32_t log_obj_size);
637 struct mlx5_devx_obj *
638 mlx5_devx_cmd_create_dek_obj(void *ctx, struct mlx5_devx_dek_attr *attr);
641 struct mlx5_devx_obj *
642 mlx5_devx_cmd_create_import_kek_obj(void *ctx,
643 struct mlx5_devx_import_kek_attr *attr);
646 struct mlx5_devx_obj *
647 mlx5_devx_cmd_create_credential_obj(void *ctx,
648 struct mlx5_devx_credential_attr *attr);
651 struct mlx5_devx_obj *
652 mlx5_devx_cmd_create_crypto_login_obj(void *ctx,
653 struct mlx5_devx_crypto_login_attr *attr);
655 #endif /* RTE_PMD_MLX5_DEVX_CMDS_H_ */