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 };
  55
  56 /** Switch information returned by mlx5_nl_switch_info(). */
  57 struct mlx5_switch_info {
  58         uint32_t master:1; /**< Master device. */
  59         uint32_t representor:1; /**< Representor device. */
  60         int32_t port_name; /**< Representor port name. */
  61         uint64_t switch_id; /**< Switch identifier. */
  62 };
  63
  64 LIST_HEAD(mlx5_dev_list, priv);
  65
  66 /* Shared memory between primary and secondary processes. */
  67 struct mlx5_shared_data {
  68         struct mlx5_dev_list mem_event_cb_list;
  69         rte_rwlock_t mem_event_rwlock;
  70 };
  71
  72 extern struct mlx5_shared_data *mlx5_shared_data;
  73
  74 struct mlx5_xstats_ctrl {
  75         /* Number of device stats. */
  76         uint16_t stats_n;
  77         /* Index in the device counters table. */
  78         uint16_t dev_table_idx[MLX5_MAX_XSTATS];
  79         uint64_t base[MLX5_MAX_XSTATS];
  80 };
  81
  82 /* Flow list . */
  83 TAILQ_HEAD(mlx5_flows, rte_flow);
  84
  85 /* Default PMD specific parameter value. */
  86 #define MLX5_ARG_UNSET (-1)
  87
  88 /*
  89  * Device configuration structure.
  90  *
  91  * Merged configuration from:
  92  *
  93  *  - Device capabilities,
  94  *  - User device parameters disabled features.
  95  */
  96 struct mlx5_dev_config {
  97         unsigned int hw_csum:1; /* Checksum offload is supported. */
  98         unsigned int hw_vlan_strip:1; /* VLAN stripping is supported. */
  99         unsigned int hw_fcs_strip:1; /* FCS stripping is supported. */
 100         unsigned int hw_padding:1; /* End alignment padding is supported. */
 101         unsigned int vf:1; /* This is a VF. */
 102         unsigned int mps:2; /* Multi-packet send supported mode. */
 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 swp:1; /* Tx generic tunnel checksum and TSO offload. */
 115         struct {
 116                 unsigned int enabled:1; /* Whether MPRQ is enabled. */
 117                 unsigned int stride_num_n; /* Number of strides. */
 118                 unsigned int min_stride_size_n; /* Min size of a stride. */
 119                 unsigned int max_stride_size_n; /* Max size of a stride. */
 120                 unsigned int max_memcpy_len;
 121                 /* Maximum packet size to memcpy Rx packets. */
 122                 unsigned int min_rxqs_num;
 123                 /* Rx queue count threshold to enable MPRQ. */
 124         } mprq; /* Configurations for Multi-Packet RQ. */
 125         unsigned int max_verbs_prio; /* Number of Verb flow priorities. */
 126         unsigned int tso_max_payload_sz; /* Maximum TCP payload for TSO. */
 127         unsigned int ind_table_max_size; /* Maximum indirection table size. */
 128         int txq_inline; /* Maximum packet size for inlining. */
 129         int txqs_inline; /* Queue number threshold for inlining. */
 130         int inline_max_packet_sz; /* Max packet size for inlining. */
 131 };
 132
 133 /**
 134  * Type of objet being allocated.
 135  */
 136 enum mlx5_verbs_alloc_type {
 137         MLX5_VERBS_ALLOC_TYPE_NONE,
 138         MLX5_VERBS_ALLOC_TYPE_TX_QUEUE,
 139         MLX5_VERBS_ALLOC_TYPE_RX_QUEUE,
 140 };
 141
 142 /* 8 Verbs priorities. */
 143 #define MLX5_VERBS_FLOW_PRIO_8 8
 144
 145 /**
 146  * Verbs allocator needs a context to know in the callback which kind of
 147  * resources it is allocating.
 148  */
 149 struct mlx5_verbs_alloc_ctx {
 150         enum mlx5_verbs_alloc_type type; /* Kind of object being allocated. */
 151         const void *obj; /* Pointer to the DPDK object. */
 152 };
 153
 154 LIST_HEAD(mlx5_mr_list, mlx5_mr);
 155
 156 struct priv {
 157         LIST_ENTRY(priv) mem_event_cb; /* Called by memory event callback. */
 158         struct rte_eth_dev_data *dev_data;  /* Pointer to device data. */
 159         struct ibv_context *ctx; /* Verbs context. */
 160         struct ibv_device_attr_ex device_attr; /* Device properties. */
 161         struct ibv_pd *pd; /* Protection Domain. */
 162         char ibdev_path[IBV_SYSFS_PATH_MAX]; /* IB device path for secondary */
 163         struct ether_addr mac[MLX5_MAX_MAC_ADDRESSES]; /* MAC addresses. */
 164         BITFIELD_DECLARE(mac_own, uint64_t, MLX5_MAX_MAC_ADDRESSES);
 165         /* Bit-field of MAC addresses owned by the PMD. */
 166         uint16_t vlan_filter[MLX5_MAX_VLAN_IDS]; /* VLAN filters table. */
 167         unsigned int vlan_filter_n; /* Number of configured VLAN filters. */
 168         /* Device properties. */
 169         uint16_t mtu; /* Configured MTU. */
 170         unsigned int isolated:1; /* Whether isolated mode is enabled. */
 171         /* RX/TX queues. */
 172         unsigned int rxqs_n; /* RX queues array size. */
 173         unsigned int txqs_n; /* TX queues array size. */
 174         struct mlx5_rxq_data *(*rxqs)[]; /* RX queues. */
 175         struct mlx5_txq_data *(*txqs)[]; /* TX queues. */
 176         struct rte_mempool *mprq_mp; /* Mempool for Multi-Packet RQ. */
 177         struct rte_eth_rss_conf rss_conf; /* RSS configuration. */
 178         struct rte_intr_handle intr_handle; /* Interrupt handler. */
 179         unsigned int (*reta_idx)[]; /* RETA index table. */
 180         unsigned int reta_idx_n; /* RETA index size. */
 181         struct mlx5_hrxq_drop *flow_drop_queue; /* Flow drop queue. */
 182         struct mlx5_flows flows; /* RTE Flow rules. */
 183         struct mlx5_flows ctrl_flows; /* Control flow rules. */
 184         struct {
 185                 uint32_t dev_gen; /* Generation number to flush local caches. */
 186                 rte_rwlock_t rwlock; /* MR Lock. */
 187                 struct mlx5_mr_btree cache; /* Global MR cache table. */
 188                 struct mlx5_mr_list mr_list; /* Registered MR list. */
 189                 struct mlx5_mr_list mr_free_list; /* Freed MR list. */
 190         } mr;
 191         LIST_HEAD(rxq, mlx5_rxq_ctrl) rxqsctrl; /* DPDK Rx queues. */
 192         LIST_HEAD(rxqibv, mlx5_rxq_ibv) rxqsibv; /* Verbs Rx queues. */
 193         LIST_HEAD(hrxq, mlx5_hrxq) hrxqs; /* Verbs Hash Rx queues. */
 194         LIST_HEAD(txq, mlx5_txq_ctrl) txqsctrl; /* DPDK Tx queues. */
 195         LIST_HEAD(txqibv, mlx5_txq_ibv) txqsibv; /* Verbs Tx queues. */
 196         /* Verbs Indirection tables. */
 197         LIST_HEAD(ind_tables, mlx5_ind_table_ibv) ind_tbls;
 198         uint32_t link_speed_capa; /* Link speed capabilities. */
 199         struct mlx5_xstats_ctrl xstats_ctrl; /* Extended stats control. */
 200         int primary_socket; /* Unix socket for primary process. */
 201         void *uar_base; /* Reserved address space for UAR mapping */
 202         struct rte_intr_handle intr_handle_socket; /* Interrupt handler. */
 203         struct mlx5_dev_config config; /* Device configuration. */
 204         struct mlx5_verbs_alloc_ctx verbs_alloc_ctx;
 205         /* Context for Verbs allocator. */
 206         int nl_socket_rdma; /* Netlink socket (NETLINK_RDMA). */
 207         int nl_socket_route; /* Netlink socket (NETLINK_ROUTE). */
 208         uint32_t nl_sn; /* Netlink message sequence number. */
 209 };
 210
 211 #define PORT_ID(priv) ((priv)->dev_data->port_id)
 212 #define ETH_DEV(priv) (&rte_eth_devices[PORT_ID(priv)])
 213
 214 /* mlx5.c */
 215
 216 int mlx5_getenv_int(const char *);
 217
 218 /* mlx5_ethdev.c */
 219
 220 int mlx5_get_ifname(const struct rte_eth_dev *dev, char (*ifname)[IF_NAMESIZE]);
 221 int mlx5_ifindex(const struct rte_eth_dev *dev);
 222 int mlx5_ifreq(const struct rte_eth_dev *dev, int req, struct ifreq *ifr);
 223 int mlx5_get_mtu(struct rte_eth_dev *dev, uint16_t *mtu);
 224 int mlx5_set_flags(struct rte_eth_dev *dev, unsigned int keep,
 225                    unsigned int flags);
 226 int mlx5_dev_configure(struct rte_eth_dev *dev);
 227 void mlx5_dev_infos_get(struct rte_eth_dev *dev, struct rte_eth_dev_info *info);
 228 const uint32_t *mlx5_dev_supported_ptypes_get(struct rte_eth_dev *dev);
 229 int mlx5_link_update(struct rte_eth_dev *dev, int wait_to_complete);
 230 int mlx5_force_link_status_change(struct rte_eth_dev *dev, int status);
 231 int mlx5_dev_set_mtu(struct rte_eth_dev *dev, uint16_t mtu);
 232 int mlx5_dev_get_flow_ctrl(struct rte_eth_dev *dev,
 233                            struct rte_eth_fc_conf *fc_conf);
 234 int mlx5_dev_set_flow_ctrl(struct rte_eth_dev *dev,
 235                            struct rte_eth_fc_conf *fc_conf);
 236 int mlx5_ibv_device_to_pci_addr(const struct ibv_device *device,
 237                                 struct rte_pci_addr *pci_addr);
 238 void mlx5_dev_link_status_handler(void *arg);
 239 void mlx5_dev_interrupt_handler(void *arg);
 240 void mlx5_dev_interrupt_handler_uninstall(struct rte_eth_dev *dev);
 241 void mlx5_dev_interrupt_handler_install(struct rte_eth_dev *dev);
 242 int mlx5_set_link_down(struct rte_eth_dev *dev);
 243 int mlx5_set_link_up(struct rte_eth_dev *dev);
 244 int mlx5_is_removed(struct rte_eth_dev *dev);
 245 eth_tx_burst_t mlx5_select_tx_function(struct rte_eth_dev *dev);
 246 eth_rx_burst_t mlx5_select_rx_function(struct rte_eth_dev *dev);
 247
 248 /* mlx5_mac.c */
 249
 250 int mlx5_get_mac(struct rte_eth_dev *dev, uint8_t (*mac)[ETHER_ADDR_LEN]);
 251 void mlx5_mac_addr_remove(struct rte_eth_dev *dev, uint32_t index);
 252 int mlx5_mac_addr_add(struct rte_eth_dev *dev, struct ether_addr *mac,
 253                       uint32_t index, uint32_t vmdq);
 254 int mlx5_mac_addr_set(struct rte_eth_dev *dev, struct ether_addr *mac_addr);
 255 int mlx5_set_mc_addr_list(struct rte_eth_dev *dev,
 256                           struct ether_addr *mc_addr_set, uint32_t nb_mc_addr);
 257
 258 /* mlx5_rss.c */
 259
 260 int mlx5_rss_hash_update(struct rte_eth_dev *dev,
 261                          struct rte_eth_rss_conf *rss_conf);
 262 int mlx5_rss_hash_conf_get(struct rte_eth_dev *dev,
 263                            struct rte_eth_rss_conf *rss_conf);
 264 int mlx5_rss_reta_index_resize(struct rte_eth_dev *dev, unsigned int reta_size);
 265 int mlx5_dev_rss_reta_query(struct rte_eth_dev *dev,
 266                             struct rte_eth_rss_reta_entry64 *reta_conf,
 267                             uint16_t reta_size);
 268 int mlx5_dev_rss_reta_update(struct rte_eth_dev *dev,
 269                              struct rte_eth_rss_reta_entry64 *reta_conf,
 270                              uint16_t reta_size);
 271
 272 /* mlx5_rxmode.c */
 273
 274 void mlx5_promiscuous_enable(struct rte_eth_dev *dev);
 275 void mlx5_promiscuous_disable(struct rte_eth_dev *dev);
 276 void mlx5_allmulticast_enable(struct rte_eth_dev *dev);
 277 void mlx5_allmulticast_disable(struct rte_eth_dev *dev);
 278
 279 /* mlx5_stats.c */
 280
 281 void mlx5_xstats_init(struct rte_eth_dev *dev);
 282 int mlx5_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats);
 283 void mlx5_stats_reset(struct rte_eth_dev *dev);
 284 int mlx5_xstats_get(struct rte_eth_dev *dev, struct rte_eth_xstat *stats,
 285                     unsigned int n);
 286 void mlx5_xstats_reset(struct rte_eth_dev *dev);
 287 int mlx5_xstats_get_names(struct rte_eth_dev *dev __rte_unused,
 288                           struct rte_eth_xstat_name *xstats_names,
 289                           unsigned int n);
 290
 291 /* mlx5_vlan.c */
 292
 293 int mlx5_vlan_filter_set(struct rte_eth_dev *dev, uint16_t vlan_id, int on);
 294 void mlx5_vlan_strip_queue_set(struct rte_eth_dev *dev, uint16_t queue, int on);
 295 int mlx5_vlan_offload_set(struct rte_eth_dev *dev, int mask);
 296
 297 /* mlx5_trigger.c */
 298
 299 int mlx5_dev_start(struct rte_eth_dev *dev);
 300 void mlx5_dev_stop(struct rte_eth_dev *dev);
 301 int mlx5_traffic_enable(struct rte_eth_dev *dev);
 302 void mlx5_traffic_disable(struct rte_eth_dev *dev);
 303 int mlx5_traffic_restart(struct rte_eth_dev *dev);
 304
 305 /* mlx5_flow.c */
 306
 307 unsigned int mlx5_get_max_verbs_prio(struct rte_eth_dev *dev);
 308 int mlx5_flow_validate(struct rte_eth_dev *dev,
 309                        const struct rte_flow_attr *attr,
 310                        const struct rte_flow_item items[],
 311                        const struct rte_flow_action actions[],
 312                        struct rte_flow_error *error);
 313 struct rte_flow *mlx5_flow_create(struct rte_eth_dev *dev,
 314                                   const struct rte_flow_attr *attr,
 315                                   const struct rte_flow_item items[],
 316                                   const struct rte_flow_action actions[],
 317                                   struct rte_flow_error *error);
 318 int mlx5_flow_destroy(struct rte_eth_dev *dev, struct rte_flow *flow,
 319                       struct rte_flow_error *error);
 320 void mlx5_flow_list_flush(struct rte_eth_dev *dev, struct mlx5_flows *list);
 321 int mlx5_flow_flush(struct rte_eth_dev *dev, struct rte_flow_error *error);
 322 int mlx5_flow_query(struct rte_eth_dev *dev, struct rte_flow *flow,
 323                     const struct rte_flow_action *action, void *data,
 324                     struct rte_flow_error *error);
 325 int mlx5_flow_isolate(struct rte_eth_dev *dev, int enable,
 326                       struct rte_flow_error *error);
 327 int mlx5_dev_filter_ctrl(struct rte_eth_dev *dev,
 328                          enum rte_filter_type filter_type,
 329                          enum rte_filter_op filter_op,
 330                          void *arg);
 331 int mlx5_flow_start(struct rte_eth_dev *dev, struct mlx5_flows *list);
 332 void mlx5_flow_stop(struct rte_eth_dev *dev, struct mlx5_flows *list);
 333 int mlx5_flow_verify(struct rte_eth_dev *dev);
 334 int mlx5_ctrl_flow_vlan(struct rte_eth_dev *dev,
 335                         struct rte_flow_item_eth *eth_spec,
 336                         struct rte_flow_item_eth *eth_mask,
 337                         struct rte_flow_item_vlan *vlan_spec,
 338                         struct rte_flow_item_vlan *vlan_mask);
 339 int mlx5_ctrl_flow(struct rte_eth_dev *dev,
 340                    struct rte_flow_item_eth *eth_spec,
 341                    struct rte_flow_item_eth *eth_mask);
 342 int mlx5_flow_create_drop_queue(struct rte_eth_dev *dev);
 343 void mlx5_flow_delete_drop_queue(struct rte_eth_dev *dev);
 344
 345 /* mlx5_socket.c */
 346
 347 int mlx5_socket_init(struct rte_eth_dev *priv);
 348 void mlx5_socket_uninit(struct rte_eth_dev *priv);
 349 void mlx5_socket_handle(struct rte_eth_dev *priv);
 350 int mlx5_socket_connect(struct rte_eth_dev *priv);
 351
 352 /* mlx5_nl.c */
 353
 354 int mlx5_nl_init(uint32_t nlgroups, int protocol);
 355 int mlx5_nl_mac_addr_add(struct rte_eth_dev *dev, struct ether_addr *mac,
 356                          uint32_t index);
 357 int mlx5_nl_mac_addr_remove(struct rte_eth_dev *dev, struct ether_addr *mac,
 358                             uint32_t index);
 359 void mlx5_nl_mac_addr_sync(struct rte_eth_dev *dev);
 360 void mlx5_nl_mac_addr_flush(struct rte_eth_dev *dev);
 361 int mlx5_nl_promisc(struct rte_eth_dev *dev, int enable);
 362 int mlx5_nl_allmulti(struct rte_eth_dev *dev, int enable);
 363 unsigned int mlx5_nl_ifindex(int nl, const char *name);
 364 int mlx5_nl_switch_info(int nl, unsigned int ifindex,
 365                         struct mlx5_switch_info *info);
 366
 367 #endif /* RTE_PMD_MLX5_H_ */