drivers/net/mlx5/mlx5.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2015 6WIND S.A.
   3  * Copyright 2015 Mellanox Technologies, Ltd
   4  */
   5
   6 #ifndef RTE_PMD_MLX5_H_
   7 #define RTE_PMD_MLX5_H_
   8
   9 #include <stddef.h>
  10 #include <stdint.h>
  11 #include <limits.h>
  12 #include <net/if.h>
  13 #include <netinet/in.h>
  14 #include <sys/queue.h>
  15
  16 /* Verbs header. */
  17 /* ISO C doesn't support unnamed structs/unions, disabling -pedantic. */
  18 #ifdef PEDANTIC
  19 #pragma GCC diagnostic ignored "-Wpedantic"
  20 #endif
  21 #include <infiniband/verbs.h>
  22 #ifdef PEDANTIC
  23 #pragma GCC diagnostic error "-Wpedantic"
  24 #endif
  25
  26 #include <rte_pci.h>
  27 #include <rte_ether.h>
  28 #include <rte_ethdev_driver.h>
  29 #include <rte_rwlock.h>
  30 #include <rte_interrupts.h>
  31 #include <rte_errno.h>
  32 #include <rte_flow.h>
  33
  34 #include "mlx5_utils.h"
  35 #include "mlx5_mr.h"
  36 #include "mlx5_rxtx.h"
  37 #include "mlx5_autoconf.h"
  38 #include "mlx5_defs.h"
  39
  40 enum {
  41         PCI_VENDOR_ID_MELLANOX = 0x15b3,
  42 };
  43
  44 enum {
  45         PCI_DEVICE_ID_MELLANOX_CONNECTX4 = 0x1013,
  46         PCI_DEVICE_ID_MELLANOX_CONNECTX4VF = 0x1014,
  47         PCI_DEVICE_ID_MELLANOX_CONNECTX4LX = 0x1015,
  48         PCI_DEVICE_ID_MELLANOX_CONNECTX4LXVF = 0x1016,
  49         PCI_DEVICE_ID_MELLANOX_CONNECTX5 = 0x1017,
  50         PCI_DEVICE_ID_MELLANOX_CONNECTX5VF = 0x1018,
  51         PCI_DEVICE_ID_MELLANOX_CONNECTX5EX = 0x1019,
  52         PCI_DEVICE_ID_MELLANOX_CONNECTX5EXVF = 0x101a,
  53         PCI_DEVICE_ID_MELLANOX_CONNECTX5BF = 0xa2d2,
  54         PCI_DEVICE_ID_MELLANOX_CONNECTX5BFVF = 0xa2d3,
  55 };
  56
  57 /** Switch information returned by mlx5_nl_switch_info(). */
  58 struct mlx5_switch_info {
  59         uint32_t master:1; /**< Master device. */
  60         uint32_t representor:1; /**< Representor device. */
  61         int32_t port_name; /**< Representor port name. */
  62         uint64_t switch_id; /**< Switch identifier. */
  63 };
  64
  65 LIST_HEAD(mlx5_dev_list, priv);
  66
  67 /* Shared memory between primary and secondary processes. */
  68 struct mlx5_shared_data {
  69         struct mlx5_dev_list mem_event_cb_list;
  70         rte_rwlock_t mem_event_rwlock;
  71 };
  72
  73 extern struct mlx5_shared_data *mlx5_shared_data;
  74
  75 struct mlx5_xstats_ctrl {
  76         /* Number of device stats. */
  77         uint16_t stats_n;
  78         /* Index in the device counters table. */
  79         uint16_t dev_table_idx[MLX5_MAX_XSTATS];
  80         uint64_t base[MLX5_MAX_XSTATS];
  81 };
  82
  83 /* Flow list . */
  84 TAILQ_HEAD(mlx5_flows, rte_flow);
  85
  86 /* Default PMD specific parameter value. */
  87 #define MLX5_ARG_UNSET (-1)
  88
  89 /*
  90  * Device configuration structure.
  91  *
  92  * Merged configuration from:
  93  *
  94  *  - Device capabilities,
  95  *  - User device parameters disabled features.
  96  */
  97 struct mlx5_dev_config {
  98         unsigned int hw_csum:1; /* Checksum offload is supported. */
  99         unsigned int hw_vlan_strip:1; /* VLAN stripping is supported. */
 100         unsigned int hw_fcs_strip:1; /* FCS stripping is supported. */
 101         unsigned int hw_padding:1; /* End alignment padding is supported. */
 102         unsigned int vf:1; /* This is a VF. */
 103         unsigned int tunnel_en:1;
 104         /* Whether tunnel stateless offloads are supported. */
 105         unsigned int mpls_en:1; /* MPLS over GRE/UDP is enabled. */
 106         unsigned int flow_counter_en:1; /* Whether flow counter is supported. */
 107         unsigned int cqe_comp:1; /* CQE compression is enabled. */
 108         unsigned int tso:1; /* Whether TSO is supported. */
 109         unsigned int tx_vec_en:1; /* Tx vector is enabled. */
 110         unsigned int rx_vec_en:1; /* Rx vector is enabled. */
 111         unsigned int mpw_hdr_dseg:1; /* Enable DSEGs in the title WQEBB. */
 112         unsigned int l3_vxlan_en:1; /* Enable L3 VXLAN flow creation. */
 113         unsigned int vf_nl_en:1; /* Enable Netlink requests in VF mode. */
 114         unsigned int dv_flow_en:1; /* Enable DV flow. */
 115         unsigned int swp:1; /* Tx generic tunnel checksum and TSO offload. */
 116         struct {
 117                 unsigned int enabled:1; /* Whether MPRQ is enabled. */
 118                 unsigned int stride_num_n; /* Number of strides. */
 119                 unsigned int min_stride_size_n; /* Min size of a stride. */
 120                 unsigned int max_stride_size_n; /* Max size of a stride. */
 121                 unsigned int max_memcpy_len;
 122                 /* Maximum packet size to memcpy Rx packets. */
 123                 unsigned int min_rxqs_num;
 124                 /* Rx queue count threshold to enable MPRQ. */
 125         } mprq; /* Configurations for Multi-Packet RQ. */
 126         int mps; /* Multi-packet send supported mode. */
 127         unsigned int flow_prio; /* Number of flow priorities. */
 128         unsigned int tso_max_payload_sz; /* Maximum TCP payload for TSO. */
 129         unsigned int ind_table_max_size; /* Maximum indirection table size. */
 130         int txq_inline; /* Maximum packet size for inlining. */
 131         int txqs_inline; /* Queue number threshold for inlining. */
 132         int inline_max_packet_sz; /* Max packet size for inlining. */
 133 };
 134
 135 /**
 136  * Type of objet being allocated.
 137  */
 138 enum mlx5_verbs_alloc_type {
 139         MLX5_VERBS_ALLOC_TYPE_NONE,
 140         MLX5_VERBS_ALLOC_TYPE_TX_QUEUE,
 141         MLX5_VERBS_ALLOC_TYPE_RX_QUEUE,
 142 };
 143
 144 /**
 145  * Verbs allocator needs a context to know in the callback which kind of
 146  * resources it is allocating.
 147  */
 148 struct mlx5_verbs_alloc_ctx {
 149         enum mlx5_verbs_alloc_type type; /* Kind of object being allocated. */
 150         const void *obj; /* Pointer to the DPDK object. */
 151 };
 152
 153 LIST_HEAD(mlx5_mr_list, mlx5_mr);
 154
 155 /* Flow drop context necessary due to Verbs API. */
 156 struct mlx5_drop {
 157         struct mlx5_hrxq *hrxq; /* Hash Rx queue queue. */
 158         struct mlx5_rxq_ibv *rxq; /* Verbs Rx queue. */
 159 };
 160
 161 /** DPDK port to network interface index (ifindex) conversion. */
 162 struct mlx5_nl_flow_ptoi {
 163         uint16_t port_id; /**< DPDK port ID. */
 164         unsigned int ifindex; /**< Network interface index. */
 165 };
 166
 167 struct mnl_socket;
 168
 169 struct priv {
 170         LIST_ENTRY(priv) mem_event_cb; /* Called by memory event callback. */
 171         struct rte_eth_dev_data *dev_data;  /* Pointer to device data. */
 172         struct ibv_context *ctx; /* Verbs context. */
 173         struct ibv_device_attr_ex device_attr; /* Device properties. */
 174         struct ibv_pd *pd; /* Protection Domain. */
 175         char ibdev_name[IBV_SYSFS_NAME_MAX]; /* IB device name. */
 176         char ibdev_path[IBV_SYSFS_PATH_MAX]; /* IB device path for secondary */
 177         struct ether_addr mac[MLX5_MAX_MAC_ADDRESSES]; /* MAC addresses. */
 178         BITFIELD_DECLARE(mac_own, uint64_t, MLX5_MAX_MAC_ADDRESSES);
 179         /* Bit-field of MAC addresses owned by the PMD. */
 180         uint16_t vlan_filter[MLX5_MAX_VLAN_IDS]; /* VLAN filters table. */
 181         unsigned int vlan_filter_n; /* Number of configured VLAN filters. */
 182         /* Device properties. */
 183         uint16_t mtu; /* Configured MTU. */
 184         unsigned int isolated:1; /* Whether isolated mode is enabled. */
 185         unsigned int representor:1; /* Device is a port representor. */
 186         uint16_t domain_id; /* Switch domain identifier. */
 187         int32_t representor_id; /* Port representor identifier. */
 188         /* RX/TX queues. */
 189         unsigned int rxqs_n; /* RX queues array size. */
 190         unsigned int txqs_n; /* TX queues array size. */
 191         struct mlx5_rxq_data *(*rxqs)[]; /* RX queues. */
 192         struct mlx5_txq_data *(*txqs)[]; /* TX queues. */
 193         struct rte_mempool *mprq_mp; /* Mempool for Multi-Packet RQ. */
 194         struct rte_eth_rss_conf rss_conf; /* RSS configuration. */
 195         struct rte_intr_handle intr_handle; /* Interrupt handler. */
 196         unsigned int (*reta_idx)[]; /* RETA index table. */
 197         unsigned int reta_idx_n; /* RETA index size. */
 198         struct mlx5_drop drop_queue; /* Flow drop queues. */
 199         struct mlx5_flows flows; /* RTE Flow rules. */
 200         struct mlx5_flows ctrl_flows; /* Control flow rules. */
 201         LIST_HEAD(counters, mlx5_flow_counter) flow_counters;
 202         /* Flow counters. */
 203         struct {
 204                 uint32_t dev_gen; /* Generation number to flush local caches. */
 205                 rte_rwlock_t rwlock; /* MR Lock. */
 206                 struct mlx5_mr_btree cache; /* Global MR cache table. */
 207                 struct mlx5_mr_list mr_list; /* Registered MR list. */
 208                 struct mlx5_mr_list mr_free_list; /* Freed MR list. */
 209         } mr;
 210         LIST_HEAD(rxq, mlx5_rxq_ctrl) rxqsctrl; /* DPDK Rx queues. */
 211         LIST_HEAD(rxqibv, mlx5_rxq_ibv) rxqsibv; /* Verbs Rx queues. */
 212         LIST_HEAD(hrxq, mlx5_hrxq) hrxqs; /* Verbs Hash Rx queues. */
 213         LIST_HEAD(txq, mlx5_txq_ctrl) txqsctrl; /* DPDK Tx queues. */
 214         LIST_HEAD(txqibv, mlx5_txq_ibv) txqsibv; /* Verbs Tx queues. */
 215         /* Verbs Indirection tables. */
 216         LIST_HEAD(ind_tables, mlx5_ind_table_ibv) ind_tbls;
 217         LIST_HEAD(matchers, mlx5_flow_dv_matcher) matchers;
 218         uint32_t link_speed_capa; /* Link speed capabilities. */
 219         struct mlx5_xstats_ctrl xstats_ctrl; /* Extended stats control. */
 220         int primary_socket; /* Unix socket for primary process. */
 221         void *uar_base; /* Reserved address space for UAR mapping */
 222         struct rte_intr_handle intr_handle_socket; /* Interrupt handler. */
 223         struct mlx5_dev_config config; /* Device configuration. */
 224         struct mlx5_verbs_alloc_ctx verbs_alloc_ctx;
 225         /* Context for Verbs allocator. */
 226         int nl_socket_rdma; /* Netlink socket (NETLINK_RDMA). */
 227         int nl_socket_route; /* Netlink socket (NETLINK_ROUTE). */
 228         uint32_t nl_sn; /* Netlink message sequence number. */
 229 #ifndef RTE_ARCH_64
 230         rte_spinlock_t uar_lock_cq; /* CQs share a common distinct UAR */
 231         rte_spinlock_t uar_lock[MLX5_UAR_PAGE_NUM_MAX];
 232         /* UAR same-page access control required in 32bit implementations. */
 233 #endif
 234         struct mnl_socket *mnl_socket; /* Libmnl socket. */
 235 };
 236
 237 #define PORT_ID(priv) ((priv)->dev_data->port_id)
 238 #define ETH_DEV(priv) (&rte_eth_devices[PORT_ID(priv)])
 239
 240 /* mlx5.c */
 241
 242 int mlx5_getenv_int(const char *);
 243
 244 /* mlx5_ethdev.c */
 245
 246 int mlx5_get_master_ifname(const struct rte_eth_dev *dev,
 247                            char (*ifname)[IF_NAMESIZE]);
 248 int mlx5_get_ifname(const struct rte_eth_dev *dev, char (*ifname)[IF_NAMESIZE]);
 249 unsigned int mlx5_ifindex(const struct rte_eth_dev *dev);
 250 int mlx5_ifreq(const struct rte_eth_dev *dev, int req, struct ifreq *ifr,
 251                int master);
 252 int mlx5_get_mtu(struct rte_eth_dev *dev, uint16_t *mtu);
 253 int mlx5_set_flags(struct rte_eth_dev *dev, unsigned int keep,
 254                    unsigned int flags);
 255 int mlx5_dev_configure(struct rte_eth_dev *dev);
 256 void mlx5_dev_infos_get(struct rte_eth_dev *dev, struct rte_eth_dev_info *info);
 257 const uint32_t *mlx5_dev_supported_ptypes_get(struct rte_eth_dev *dev);
 258 int mlx5_link_update(struct rte_eth_dev *dev, int wait_to_complete);
 259 int mlx5_force_link_status_change(struct rte_eth_dev *dev, int status);
 260 int mlx5_dev_set_mtu(struct rte_eth_dev *dev, uint16_t mtu);
 261 int mlx5_dev_get_flow_ctrl(struct rte_eth_dev *dev,
 262                            struct rte_eth_fc_conf *fc_conf);
 263 int mlx5_dev_set_flow_ctrl(struct rte_eth_dev *dev,
 264                            struct rte_eth_fc_conf *fc_conf);
 265 int mlx5_ibv_device_to_pci_addr(const struct ibv_device *device,
 266                                 struct rte_pci_addr *pci_addr);
 267 void mlx5_dev_link_status_handler(void *arg);
 268 void mlx5_dev_interrupt_handler(void *arg);
 269 void mlx5_dev_interrupt_handler_uninstall(struct rte_eth_dev *dev);
 270 void mlx5_dev_interrupt_handler_install(struct rte_eth_dev *dev);
 271 int mlx5_set_link_down(struct rte_eth_dev *dev);
 272 int mlx5_set_link_up(struct rte_eth_dev *dev);
 273 int mlx5_is_removed(struct rte_eth_dev *dev);
 274 eth_tx_burst_t mlx5_select_tx_function(struct rte_eth_dev *dev);
 275 eth_rx_burst_t mlx5_select_rx_function(struct rte_eth_dev *dev);
 276 unsigned int mlx5_dev_to_port_id(const struct rte_device *dev,
 277                                  uint16_t *port_list,
 278                                  unsigned int port_list_n);
 279 int mlx5_sysfs_switch_info(unsigned int ifindex,
 280                            struct mlx5_switch_info *info);
 281
 282 /* mlx5_mac.c */
 283
 284 int mlx5_get_mac(struct rte_eth_dev *dev, uint8_t (*mac)[ETHER_ADDR_LEN]);
 285 void mlx5_mac_addr_remove(struct rte_eth_dev *dev, uint32_t index);
 286 int mlx5_mac_addr_add(struct rte_eth_dev *dev, struct ether_addr *mac,
 287                       uint32_t index, uint32_t vmdq);
 288 int mlx5_mac_addr_set(struct rte_eth_dev *dev, struct ether_addr *mac_addr);
 289 int mlx5_set_mc_addr_list(struct rte_eth_dev *dev,
 290                           struct ether_addr *mc_addr_set, uint32_t nb_mc_addr);
 291
 292 /* mlx5_rss.c */
 293
 294 int mlx5_rss_hash_update(struct rte_eth_dev *dev,
 295                          struct rte_eth_rss_conf *rss_conf);
 296 int mlx5_rss_hash_conf_get(struct rte_eth_dev *dev,
 297                            struct rte_eth_rss_conf *rss_conf);
 298 int mlx5_rss_reta_index_resize(struct rte_eth_dev *dev, unsigned int reta_size);
 299 int mlx5_dev_rss_reta_query(struct rte_eth_dev *dev,
 300                             struct rte_eth_rss_reta_entry64 *reta_conf,
 301                             uint16_t reta_size);
 302 int mlx5_dev_rss_reta_update(struct rte_eth_dev *dev,
 303                              struct rte_eth_rss_reta_entry64 *reta_conf,
 304                              uint16_t reta_size);
 305
 306 /* mlx5_rxmode.c */
 307
 308 void mlx5_promiscuous_enable(struct rte_eth_dev *dev);
 309 void mlx5_promiscuous_disable(struct rte_eth_dev *dev);
 310 void mlx5_allmulticast_enable(struct rte_eth_dev *dev);
 311 void mlx5_allmulticast_disable(struct rte_eth_dev *dev);
 312
 313 /* mlx5_stats.c */
 314
 315 void mlx5_xstats_init(struct rte_eth_dev *dev);
 316 int mlx5_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats);
 317 void mlx5_stats_reset(struct rte_eth_dev *dev);
 318 int mlx5_xstats_get(struct rte_eth_dev *dev, struct rte_eth_xstat *stats,
 319                     unsigned int n);
 320 void mlx5_xstats_reset(struct rte_eth_dev *dev);
 321 int mlx5_xstats_get_names(struct rte_eth_dev *dev __rte_unused,
 322                           struct rte_eth_xstat_name *xstats_names,
 323                           unsigned int n);
 324
 325 /* mlx5_vlan.c */
 326
 327 int mlx5_vlan_filter_set(struct rte_eth_dev *dev, uint16_t vlan_id, int on);
 328 void mlx5_vlan_strip_queue_set(struct rte_eth_dev *dev, uint16_t queue, int on);
 329 int mlx5_vlan_offload_set(struct rte_eth_dev *dev, int mask);
 330
 331 /* mlx5_trigger.c */
 332
 333 int mlx5_dev_start(struct rte_eth_dev *dev);
 334 void mlx5_dev_stop(struct rte_eth_dev *dev);
 335 int mlx5_traffic_enable(struct rte_eth_dev *dev);
 336 void mlx5_traffic_disable(struct rte_eth_dev *dev);
 337 int mlx5_traffic_restart(struct rte_eth_dev *dev);
 338
 339 /* mlx5_flow.c */
 340
 341 int mlx5_flow_discover_priorities(struct rte_eth_dev *dev);
 342 void mlx5_flow_print(struct rte_flow *flow);
 343 int mlx5_flow_validate(struct rte_eth_dev *dev,
 344                        const struct rte_flow_attr *attr,
 345                        const struct rte_flow_item items[],
 346                        const struct rte_flow_action actions[],
 347                        struct rte_flow_error *error);
 348 struct rte_flow *mlx5_flow_create(struct rte_eth_dev *dev,
 349                                   const struct rte_flow_attr *attr,
 350                                   const struct rte_flow_item items[],
 351                                   const struct rte_flow_action actions[],
 352                                   struct rte_flow_error *error);
 353 int mlx5_flow_destroy(struct rte_eth_dev *dev, struct rte_flow *flow,
 354                       struct rte_flow_error *error);
 355 void mlx5_flow_list_flush(struct rte_eth_dev *dev, struct mlx5_flows *list);
 356 int mlx5_flow_flush(struct rte_eth_dev *dev, struct rte_flow_error *error);
 357 int mlx5_flow_query(struct rte_eth_dev *dev, struct rte_flow *flow,
 358                     const struct rte_flow_action *action, void *data,
 359                     struct rte_flow_error *error);
 360 int mlx5_flow_isolate(struct rte_eth_dev *dev, int enable,
 361                       struct rte_flow_error *error);
 362 int mlx5_dev_filter_ctrl(struct rte_eth_dev *dev,
 363                          enum rte_filter_type filter_type,
 364                          enum rte_filter_op filter_op,
 365                          void *arg);
 366 int mlx5_flow_start(struct rte_eth_dev *dev, struct mlx5_flows *list);
 367 void mlx5_flow_stop(struct rte_eth_dev *dev, struct mlx5_flows *list);
 368 int mlx5_flow_verify(struct rte_eth_dev *dev);
 369 int mlx5_ctrl_flow_vlan(struct rte_eth_dev *dev,
 370                         struct rte_flow_item_eth *eth_spec,
 371                         struct rte_flow_item_eth *eth_mask,
 372                         struct rte_flow_item_vlan *vlan_spec,
 373                         struct rte_flow_item_vlan *vlan_mask);
 374 int mlx5_ctrl_flow(struct rte_eth_dev *dev,
 375                    struct rte_flow_item_eth *eth_spec,
 376                    struct rte_flow_item_eth *eth_mask);
 377 int mlx5_flow_create_drop_queue(struct rte_eth_dev *dev);
 378 void mlx5_flow_delete_drop_queue(struct rte_eth_dev *dev);
 379
 380 /* mlx5_socket.c */
 381
 382 int mlx5_socket_init(struct rte_eth_dev *priv);
 383 void mlx5_socket_uninit(struct rte_eth_dev *priv);
 384 void mlx5_socket_handle(struct rte_eth_dev *priv);
 385 int mlx5_socket_connect(struct rte_eth_dev *priv);
 386
 387 /* mlx5_nl.c */
 388
 389 int mlx5_nl_init(int protocol);
 390 int mlx5_nl_mac_addr_add(struct rte_eth_dev *dev, struct ether_addr *mac,
 391                          uint32_t index);
 392 int mlx5_nl_mac_addr_remove(struct rte_eth_dev *dev, struct ether_addr *mac,
 393                             uint32_t index);
 394 void mlx5_nl_mac_addr_sync(struct rte_eth_dev *dev);
 395 void mlx5_nl_mac_addr_flush(struct rte_eth_dev *dev);
 396 int mlx5_nl_promisc(struct rte_eth_dev *dev, int enable);
 397 int mlx5_nl_allmulti(struct rte_eth_dev *dev, int enable);
 398 unsigned int mlx5_nl_ifindex(int nl, const char *name);
 399 int mlx5_nl_switch_info(int nl, unsigned int ifindex,
 400                         struct mlx5_switch_info *info);
 401
 402 /* mlx5_nl_flow.c */
 403
 404 int mlx5_nl_flow_transpose(void *buf,
 405                            size_t size,
 406                            const struct mlx5_nl_flow_ptoi *ptoi,
 407                            const struct rte_flow_attr *attr,
 408                            const struct rte_flow_item *pattern,
 409                            const struct rte_flow_action *actions,
 410                            struct rte_flow_error *error);
 411 void mlx5_nl_flow_brand(void *buf, uint32_t handle);
 412 int mlx5_nl_flow_create(struct mnl_socket *nl, void *buf,
 413                         struct rte_flow_error *error);
 414 int mlx5_nl_flow_destroy(struct mnl_socket *nl, void *buf,
 415                          struct rte_flow_error *error);
 416 int mlx5_nl_flow_init(struct mnl_socket *nl, unsigned int ifindex,
 417                       struct rte_flow_error *error);
 418 struct mnl_socket *mlx5_nl_flow_socket_create(void);
 419 void mlx5_nl_flow_socket_destroy(struct mnl_socket *nl);
 420
 421 #endif /* RTE_PMD_MLX5_H_ */