drivers/common/mlx5/mlx5_devx_cmds.h

   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 "mlx5_glue.h"
   9 #include "mlx5_prm.h"
  10
  11
  12 /* This is limitation of libibverbs: in length variable type is u16. */
  13 #define MLX5_DEVX_MAX_KLM_ENTRIES ((UINT16_MAX - \
  14                 MLX5_ST_SZ_DW(create_mkey_in) * 4) / (MLX5_ST_SZ_DW(klm) * 4))
  15
  16 struct mlx5_devx_mkey_attr {
  17         uint64_t addr;
  18         uint64_t size;
  19         uint32_t umem_id;
  20         uint32_t pd;
  21         uint32_t log_entity_size;
  22         uint32_t pg_access:1;
  23         uint32_t relaxed_ordering:1;
  24         struct mlx5_klm *klm_array;
  25         int klm_num;
  26 };
  27
  28 /* HCA qos attributes. */
  29 struct mlx5_hca_qos_attr {
  30         uint32_t sup:1; /* Whether QOS is supported. */
  31         uint32_t srtcm_sup:1; /* Whether srTCM mode is supported. */
  32         uint32_t packet_pacing:1; /* Packet pacing is supported. */
  33         uint32_t wqe_rate_pp:1; /* Packet pacing WQE rate mode. */
  34         uint32_t flow_meter_reg_share:1;
  35         /* Whether reg_c share is supported. */
  36         uint8_t log_max_flow_meter;
  37         /* Power of the maximum supported meters. */
  38         uint8_t flow_meter_reg_c_ids;
  39         /* Bitmap of the reg_Cs available for flow meter to use. */
  40
  41 };
  42
  43 struct mlx5_hca_vdpa_attr {
  44         uint8_t virtio_queue_type;
  45         uint32_t valid:1;
  46         uint32_t desc_tunnel_offload_type:1;
  47         uint32_t eth_frame_offload_type:1;
  48         uint32_t virtio_version_1_0:1;
  49         uint32_t tso_ipv4:1;
  50         uint32_t tso_ipv6:1;
  51         uint32_t tx_csum:1;
  52         uint32_t rx_csum:1;
  53         uint32_t event_mode:3;
  54         uint32_t log_doorbell_stride:5;
  55         uint32_t log_doorbell_bar_size:5;
  56         uint32_t queue_counters_valid:1;
  57         uint32_t max_num_virtio_queues;
  58         struct {
  59                 uint32_t a;
  60                 uint32_t b;
  61         } umems[3];
  62         uint64_t doorbell_bar_offset;
  63 };
  64
  65 /* HCA supports this number of time periods for LRO. */
  66 #define MLX5_LRO_NUM_SUPP_PERIODS 4
  67
  68 /* HCA attributes. */
  69 struct mlx5_hca_attr {
  70         uint32_t eswitch_manager:1;
  71         uint32_t flow_counters_dump:1;
  72         uint32_t log_max_rqt_size:5;
  73         uint32_t parse_graph_flex_node:1;
  74         uint8_t flow_counter_bulk_alloc_bitmap;
  75         uint32_t eth_net_offloads:1;
  76         uint32_t eth_virt:1;
  77         uint32_t wqe_vlan_insert:1;
  78         uint32_t wqe_inline_mode:2;
  79         uint32_t vport_inline_mode:3;
  80         uint32_t tunnel_stateless_geneve_rx:1;
  81         uint32_t geneve_max_opt_len:1; /* 0x0: 14DW, 0x1: 63DW */
  82         uint32_t tunnel_stateless_gtp:1;
  83         uint32_t lro_cap:1;
  84         uint32_t tunnel_lro_gre:1;
  85         uint32_t tunnel_lro_vxlan:1;
  86         uint32_t lro_max_msg_sz_mode:2;
  87         uint32_t lro_timer_supported_periods[MLX5_LRO_NUM_SUPP_PERIODS];
  88         uint16_t lro_min_mss_size;
  89         uint32_t flex_parser_protocols;
  90         uint32_t hairpin:1;
  91         uint32_t log_max_hairpin_queues:5;
  92         uint32_t log_max_hairpin_wq_data_sz:5;
  93         uint32_t log_max_hairpin_num_packets:5;
  94         uint32_t vhca_id:16;
  95         uint32_t relaxed_ordering_write:1;
  96         uint32_t relaxed_ordering_read:1;
  97         uint32_t access_register_user:1;
  98         uint32_t wqe_index_ignore:1;
  99         uint32_t cross_channel:1;
 100         uint32_t non_wire_sq:1; /* SQ with non-wire ops is supported. */
 101         uint32_t log_max_static_sq_wq:5; /* Static WQE size SQ. */
 102         uint32_t num_lag_ports:4; /* Number of ports can be bonded. */
 103         uint32_t dev_freq_khz; /* Timestamp counter frequency, kHz. */
 104         uint32_t scatter_fcs_w_decap_disable:1;
 105         uint32_t regex:1;
 106         uint32_t regexp_num_of_engines;
 107         uint32_t log_max_ft_sampler_num:8;
 108         struct mlx5_hca_qos_attr qos;
 109         struct mlx5_hca_vdpa_attr vdpa;
 110 };
 111
 112 struct mlx5_devx_wq_attr {
 113         uint32_t wq_type:4;
 114         uint32_t wq_signature:1;
 115         uint32_t end_padding_mode:2;
 116         uint32_t cd_slave:1;
 117         uint32_t hds_skip_first_sge:1;
 118         uint32_t log2_hds_buf_size:3;
 119         uint32_t page_offset:5;
 120         uint32_t lwm:16;
 121         uint32_t pd:24;
 122         uint32_t uar_page:24;
 123         uint64_t dbr_addr;
 124         uint32_t hw_counter;
 125         uint32_t sw_counter;
 126         uint32_t log_wq_stride:4;
 127         uint32_t log_wq_pg_sz:5;
 128         uint32_t log_wq_sz:5;
 129         uint32_t dbr_umem_valid:1;
 130         uint32_t wq_umem_valid:1;
 131         uint32_t log_hairpin_num_packets:5;
 132         uint32_t log_hairpin_data_sz:5;
 133         uint32_t single_wqe_log_num_of_strides:4;
 134         uint32_t two_byte_shift_en:1;
 135         uint32_t single_stride_log_num_of_bytes:3;
 136         uint32_t dbr_umem_id;
 137         uint32_t wq_umem_id;
 138         uint64_t wq_umem_offset;
 139 };
 140
 141 /* Create RQ attributes structure, used by create RQ operation. */
 142 struct mlx5_devx_create_rq_attr {
 143         uint32_t rlky:1;
 144         uint32_t delay_drop_en:1;
 145         uint32_t scatter_fcs:1;
 146         uint32_t vsd:1;
 147         uint32_t mem_rq_type:4;
 148         uint32_t state:4;
 149         uint32_t flush_in_error_en:1;
 150         uint32_t hairpin:1;
 151         uint32_t user_index:24;
 152         uint32_t cqn:24;
 153         uint32_t counter_set_id:8;
 154         uint32_t rmpn:24;
 155         struct mlx5_devx_wq_attr wq_attr;
 156 };
 157
 158 /* Modify RQ attributes structure, used by modify RQ operation. */
 159 struct mlx5_devx_modify_rq_attr {
 160         uint32_t rqn:24;
 161         uint32_t rq_state:4; /* Current RQ state. */
 162         uint32_t state:4; /* Required RQ state. */
 163         uint32_t scatter_fcs:1;
 164         uint32_t vsd:1;
 165         uint32_t counter_set_id:8;
 166         uint32_t hairpin_peer_sq:24;
 167         uint32_t hairpin_peer_vhca:16;
 168         uint64_t modify_bitmask;
 169         uint32_t lwm:16; /* Contained WQ lwm. */
 170 };
 171
 172 struct mlx5_rx_hash_field_select {
 173         uint32_t l3_prot_type:1;
 174         uint32_t l4_prot_type:1;
 175         uint32_t selected_fields:30;
 176 };
 177
 178 /* TIR attributes structure, used by TIR operations. */
 179 struct mlx5_devx_tir_attr {
 180         uint32_t disp_type:4;
 181         uint32_t lro_timeout_period_usecs:16;
 182         uint32_t lro_enable_mask:4;
 183         uint32_t lro_max_msg_sz:8;
 184         uint32_t inline_rqn:24;
 185         uint32_t rx_hash_symmetric:1;
 186         uint32_t tunneled_offload_en:1;
 187         uint32_t indirect_table:24;
 188         uint32_t rx_hash_fn:4;
 189         uint32_t self_lb_block:2;
 190         uint32_t transport_domain:24;
 191         uint8_t rx_hash_toeplitz_key[MLX5_RSS_HASH_KEY_LEN];
 192         struct mlx5_rx_hash_field_select rx_hash_field_selector_outer;
 193         struct mlx5_rx_hash_field_select rx_hash_field_selector_inner;
 194 };
 195
 196 /* TIR attributes structure, used by TIR modify. */
 197 struct mlx5_devx_modify_tir_attr {
 198         uint32_t tirn:24;
 199         uint64_t modify_bitmask;
 200         struct mlx5_devx_tir_attr tir;
 201 };
 202
 203 /* RQT attributes structure, used by RQT operations. */
 204 struct mlx5_devx_rqt_attr {
 205         uint8_t rq_type;
 206         uint32_t rqt_max_size:16;
 207         uint32_t rqt_actual_size:16;
 208         uint32_t rq_list[];
 209 };
 210
 211 /* TIS attributes structure. */
 212 struct mlx5_devx_tis_attr {
 213         uint32_t strict_lag_tx_port_affinity:1;
 214         uint32_t tls_en:1;
 215         uint32_t lag_tx_port_affinity:4;
 216         uint32_t prio:4;
 217         uint32_t transport_domain:24;
 218 };
 219
 220 /* SQ attributes structure, used by SQ create operation. */
 221 struct mlx5_devx_create_sq_attr {
 222         uint32_t rlky:1;
 223         uint32_t cd_master:1;
 224         uint32_t fre:1;
 225         uint32_t flush_in_error_en:1;
 226         uint32_t allow_multi_pkt_send_wqe:1;
 227         uint32_t min_wqe_inline_mode:3;
 228         uint32_t state:4;
 229         uint32_t reg_umr:1;
 230         uint32_t allow_swp:1;
 231         uint32_t hairpin:1;
 232         uint32_t non_wire:1;
 233         uint32_t static_sq_wq:1;
 234         uint32_t user_index:24;
 235         uint32_t cqn:24;
 236         uint32_t packet_pacing_rate_limit_index:16;
 237         uint32_t tis_lst_sz:16;
 238         uint32_t tis_num:24;
 239         struct mlx5_devx_wq_attr wq_attr;
 240 };
 241
 242 /* SQ attributes structure, used by SQ modify operation. */
 243 struct mlx5_devx_modify_sq_attr {
 244         uint32_t sq_state:4;
 245         uint32_t state:4;
 246         uint32_t hairpin_peer_rq:24;
 247         uint32_t hairpin_peer_vhca:16;
 248 };
 249
 250
 251 /* CQ attributes structure, used by CQ operations. */
 252 struct mlx5_devx_cq_attr {
 253         uint32_t q_umem_valid:1;
 254         uint32_t db_umem_valid:1;
 255         uint32_t use_first_only:1;
 256         uint32_t overrun_ignore:1;
 257         uint32_t cqe_comp_en:1;
 258         uint32_t mini_cqe_res_format:2;
 259         uint32_t mini_cqe_res_format_ext:2;
 260         uint32_t cqe_size:3;
 261         uint32_t log_cq_size:5;
 262         uint32_t log_page_size:5;
 263         uint32_t uar_page_id;
 264         uint32_t q_umem_id;
 265         uint64_t q_umem_offset;
 266         uint32_t db_umem_id;
 267         uint64_t db_umem_offset;
 268         uint32_t eqn;
 269         uint64_t db_addr;
 270 };
 271
 272 /* Virtq attributes structure, used by VIRTQ operations. */
 273 struct mlx5_devx_virtq_attr {
 274         uint16_t hw_available_index;
 275         uint16_t hw_used_index;
 276         uint16_t q_size;
 277         uint32_t pd:24;
 278         uint32_t virtio_version_1_0:1;
 279         uint32_t tso_ipv4:1;
 280         uint32_t tso_ipv6:1;
 281         uint32_t tx_csum:1;
 282         uint32_t rx_csum:1;
 283         uint32_t event_mode:3;
 284         uint32_t state:4;
 285         uint32_t dirty_bitmap_dump_enable:1;
 286         uint32_t dirty_bitmap_mkey;
 287         uint32_t dirty_bitmap_size;
 288         uint32_t mkey;
 289         uint32_t qp_id;
 290         uint32_t queue_index;
 291         uint32_t tis_id;
 292         uint32_t counters_obj_id;
 293         uint64_t dirty_bitmap_addr;
 294         uint64_t type;
 295         uint64_t desc_addr;
 296         uint64_t used_addr;
 297         uint64_t available_addr;
 298         struct {
 299                 uint32_t id;
 300                 uint32_t size;
 301                 uint64_t offset;
 302         } umems[3];
 303         uint8_t error_type;
 304 };
 305
 306
 307 struct mlx5_devx_qp_attr {
 308         uint32_t pd:24;
 309         uint32_t uar_index:24;
 310         uint32_t cqn:24;
 311         uint32_t log_page_size:5;
 312         uint32_t rq_size:17; /* Must be power of 2. */
 313         uint32_t log_rq_stride:3;
 314         uint32_t sq_size:17; /* Must be power of 2. */
 315         uint32_t dbr_umem_valid:1;
 316         uint32_t dbr_umem_id;
 317         uint64_t dbr_address;
 318         uint32_t wq_umem_id;
 319         uint64_t wq_umem_offset;
 320 };
 321
 322 struct mlx5_devx_virtio_q_couners_attr {
 323         uint64_t received_desc;
 324         uint64_t completed_desc;
 325         uint32_t error_cqes;
 326         uint32_t bad_desc_errors;
 327         uint32_t exceed_max_chain;
 328         uint32_t invalid_buffer;
 329 };
 330
 331 /*
 332  * graph flow match sample attributes structure,
 333  * used by flex parser operations.
 334  */
 335 struct mlx5_devx_match_sample_attr {
 336         uint32_t flow_match_sample_en:1;
 337         uint32_t flow_match_sample_field_offset:16;
 338         uint32_t flow_match_sample_offset_mode:4;
 339         uint32_t flow_match_sample_field_offset_mask;
 340         uint32_t flow_match_sample_field_offset_shift:4;
 341         uint32_t flow_match_sample_field_base_offset:8;
 342         uint32_t flow_match_sample_tunnel_mode:3;
 343         uint32_t flow_match_sample_field_id;
 344 };
 345
 346 /* graph node arc attributes structure, used by flex parser operations. */
 347 struct mlx5_devx_graph_arc_attr {
 348         uint32_t compare_condition_value:16;
 349         uint32_t start_inner_tunnel:1;
 350         uint32_t arc_parse_graph_node:8;
 351         uint32_t parse_graph_node_handle;
 352 };
 353
 354 /* Maximal number of samples per graph node. */
 355 #define MLX5_GRAPH_NODE_SAMPLE_NUM 8
 356
 357 /* Maximal number of input/output arcs per graph node. */
 358 #define MLX5_GRAPH_NODE_ARC_NUM 8
 359
 360 /* parse graph node attributes structure, used by flex parser operations. */
 361 struct mlx5_devx_graph_node_attr {
 362         uint32_t modify_field_select;
 363         uint32_t header_length_mode:4;
 364         uint32_t header_length_base_value:16;
 365         uint32_t header_length_field_shift:4;
 366         uint32_t header_length_field_offset:16;
 367         uint32_t header_length_field_mask;
 368         struct mlx5_devx_match_sample_attr sample[MLX5_GRAPH_NODE_SAMPLE_NUM];
 369         uint32_t next_header_field_offset:16;
 370         uint32_t next_header_field_size:5;
 371         struct mlx5_devx_graph_arc_attr in[MLX5_GRAPH_NODE_ARC_NUM];
 372         struct mlx5_devx_graph_arc_attr out[MLX5_GRAPH_NODE_ARC_NUM];
 373 };
 374
 375 /* mlx5_devx_cmds.c */
 376
 377 __rte_internal
 378 struct mlx5_devx_obj *mlx5_devx_cmd_flow_counter_alloc(void *ctx,
 379                                                        uint32_t bulk_sz);
 380 __rte_internal
 381 int mlx5_devx_cmd_destroy(struct mlx5_devx_obj *obj);
 382 __rte_internal
 383 int mlx5_devx_cmd_flow_counter_query(struct mlx5_devx_obj *dcs,
 384                                      int clear, uint32_t n_counters,
 385                                      uint64_t *pkts, uint64_t *bytes,
 386                                      uint32_t mkey, void *addr,
 387                                      void *cmd_comp,
 388                                      uint64_t async_id);
 389 __rte_internal
 390 int mlx5_devx_cmd_query_hca_attr(void *ctx,
 391                                  struct mlx5_hca_attr *attr);
 392 __rte_internal
 393 struct mlx5_devx_obj *mlx5_devx_cmd_mkey_create(void *ctx,
 394                                               struct mlx5_devx_mkey_attr *attr);
 395 __rte_internal
 396 int mlx5_devx_get_out_command_status(void *out);
 397 __rte_internal
 398 int mlx5_devx_cmd_qp_query_tis_td(void *qp, uint32_t tis_num,
 399                                   uint32_t *tis_td);
 400 __rte_internal
 401 struct mlx5_devx_obj *mlx5_devx_cmd_create_rq(void *ctx,
 402                                        struct mlx5_devx_create_rq_attr *rq_attr,
 403                                        int socket);
 404 __rte_internal
 405 int mlx5_devx_cmd_modify_rq(struct mlx5_devx_obj *rq,
 406                             struct mlx5_devx_modify_rq_attr *rq_attr);
 407 __rte_internal
 408 struct mlx5_devx_obj *mlx5_devx_cmd_create_tir(void *ctx,
 409                                            struct mlx5_devx_tir_attr *tir_attr);
 410 __rte_internal
 411 struct mlx5_devx_obj *mlx5_devx_cmd_create_rqt(void *ctx,
 412                                            struct mlx5_devx_rqt_attr *rqt_attr);
 413 __rte_internal
 414 struct mlx5_devx_obj *mlx5_devx_cmd_create_sq(void *ctx,
 415                                       struct mlx5_devx_create_sq_attr *sq_attr);
 416 __rte_internal
 417 int mlx5_devx_cmd_modify_sq(struct mlx5_devx_obj *sq,
 418                             struct mlx5_devx_modify_sq_attr *sq_attr);
 419 __rte_internal
 420 struct mlx5_devx_obj *mlx5_devx_cmd_create_tis(void *ctx,
 421                                            struct mlx5_devx_tis_attr *tis_attr);
 422 __rte_internal
 423 struct mlx5_devx_obj *mlx5_devx_cmd_create_td(void *ctx);
 424 __rte_internal
 425 int mlx5_devx_cmd_flow_dump(void *fdb_domain, void *rx_domain, void *tx_domain,
 426                             FILE *file);
 427 __rte_internal
 428 struct mlx5_devx_obj *mlx5_devx_cmd_create_cq(void *ctx,
 429                                               struct mlx5_devx_cq_attr *attr);
 430 __rte_internal
 431 struct mlx5_devx_obj *mlx5_devx_cmd_create_virtq(void *ctx,
 432                                              struct mlx5_devx_virtq_attr *attr);
 433 __rte_internal
 434 int mlx5_devx_cmd_modify_virtq(struct mlx5_devx_obj *virtq_obj,
 435                                struct mlx5_devx_virtq_attr *attr);
 436 __rte_internal
 437 int mlx5_devx_cmd_query_virtq(struct mlx5_devx_obj *virtq_obj,
 438                               struct mlx5_devx_virtq_attr *attr);
 439 __rte_internal
 440 struct mlx5_devx_obj *mlx5_devx_cmd_create_qp(void *ctx,
 441                                               struct mlx5_devx_qp_attr *attr);
 442 __rte_internal
 443 int mlx5_devx_cmd_modify_qp_state(struct mlx5_devx_obj *qp,
 444                                   uint32_t qp_st_mod_op, uint32_t remote_qp_id);
 445 __rte_internal
 446 int mlx5_devx_cmd_modify_rqt(struct mlx5_devx_obj *rqt,
 447                              struct mlx5_devx_rqt_attr *rqt_attr);
 448 __rte_internal
 449 int mlx5_devx_cmd_modify_tir(struct mlx5_devx_obj *tir,
 450                              struct mlx5_devx_modify_tir_attr *tir_attr);
 451 __rte_internal
 452 int mlx5_devx_cmd_query_parse_samples(struct mlx5_devx_obj *flex_obj,
 453                                       uint32_t ids[], uint32_t num);
 454
 455 __rte_internal
 456 struct mlx5_devx_obj *mlx5_devx_cmd_create_flex_parser(void *ctx,
 457                                         struct mlx5_devx_graph_node_attr *data);
 458
 459 __rte_internal
 460 int mlx5_devx_cmd_register_read(void *ctx, uint16_t reg_id,
 461                                 uint32_t arg, uint32_t *data, uint32_t dw_cnt);
 462 /**
 463  * Create virtio queue counters object DevX API.
 464  *
 465  * @param[in] ctx
 466  *   Device context.
 467
 468  * @return
 469  *   The DevX object created, NULL otherwise and rte_errno is set.
 470  */
 471 __rte_internal
 472 struct mlx5_devx_obj *mlx5_devx_cmd_create_virtio_q_counters(void *ctx);
 473
 474 /**
 475  * Query virtio queue counters object using DevX API.
 476  *
 477  * @param[in] couners_obj
 478  *   Pointer to virtq object structure.
 479  * @param [in/out] attr
 480  *   Pointer to virtio queue counters attributes structure.
 481  *
 482  * @return
 483  *   0 on success, a negative errno value otherwise and rte_errno is set.
 484  */
 485 __rte_internal
 486 int mlx5_devx_cmd_query_virtio_q_counters(struct mlx5_devx_obj *couners_obj,
 487                                   struct mlx5_devx_virtio_q_couners_attr *attr);
 488
 489 __rte_internal
 490 struct mlx5_devx_obj *mlx5_devx_cmd_create_flow_hit_aso_obj(void *ctx,
 491                                                             uint32_t pd);
 492
 493 #endif /* RTE_PMD_MLX5_DEVX_CMDS_H_ */