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 struct mnl_socket;
 162
 163 struct priv {
 164         LIST_ENTRY(priv) mem_event_cb; /* Called by memory event callback. */
 165         struct rte_eth_dev_data *dev_data;  /* Pointer to device data. */
 166         struct ibv_context *ctx; /* Verbs context. */
 167         struct ibv_device_attr_ex device_attr; /* Device properties. */
 168         struct ibv_pd *pd; /* Protection Domain. */
 169         char ibdev_name[IBV_SYSFS_NAME_MAX]; /* IB device name. */
 170         char ibdev_path[IBV_SYSFS_PATH_MAX]; /* IB device path for secondary */
 171         struct ether_addr mac[MLX5_MAX_MAC_ADDRESSES]; /* MAC addresses. */
 172         BITFIELD_DECLARE(mac_own, uint64_t, MLX5_MAX_MAC_ADDRESSES);
 173         /* Bit-field of MAC addresses owned by the PMD. */
 174         uint16_t vlan_filter[MLX5_MAX_VLAN_IDS]; /* VLAN filters table. */
 175         unsigned int vlan_filter_n; /* Number of configured VLAN filters. */
 176         /* Device properties. */
 177         uint16_t mtu; /* Configured MTU. */
 178         unsigned int isolated:1; /* Whether isolated mode is enabled. */
 179         unsigned int representor:1; /* Device is a port representor. */
 180         uint16_t domain_id; /* Switch domain identifier. */
 181         int32_t representor_id; /* Port representor identifier. */
 182         /* RX/TX queues. */
 183         unsigned int rxqs_n; /* RX queues array size. */
 184         unsigned int txqs_n; /* TX queues array size. */
 185         struct mlx5_rxq_data *(*rxqs)[]; /* RX queues. */
 186         struct mlx5_txq_data *(*txqs)[]; /* TX queues. */
 187         struct rte_mempool *mprq_mp; /* Mempool for Multi-Packet RQ. */
 188         struct rte_eth_rss_conf rss_conf; /* RSS configuration. */
 189         struct rte_intr_handle intr_handle; /* Interrupt handler. */
 190         unsigned int (*reta_idx)[]; /* RETA index table. */
 191         unsigned int reta_idx_n; /* RETA index size. */
 192         struct mlx5_drop drop_queue; /* Flow drop queues. */
 193         struct mlx5_flows flows; /* RTE Flow rules. */
 194         struct mlx5_flows ctrl_flows; /* Control flow rules. */
 195         LIST_HEAD(counters, mlx5_flow_counter) flow_counters;
 196         /* Flow counters. */
 197         struct {
 198                 uint32_t dev_gen; /* Generation number to flush local caches. */
 199                 rte_rwlock_t rwlock; /* MR Lock. */
 200                 struct mlx5_mr_btree cache; /* Global MR cache table. */
 201                 struct mlx5_mr_list mr_list; /* Registered MR list. */
 202                 struct mlx5_mr_list mr_free_list; /* Freed MR list. */
 203         } mr;
 204         LIST_HEAD(rxq, mlx5_rxq_ctrl) rxqsctrl; /* DPDK Rx queues. */
 205         LIST_HEAD(rxqibv, mlx5_rxq_ibv) rxqsibv; /* Verbs Rx queues. */
 206         LIST_HEAD(hrxq, mlx5_hrxq) hrxqs; /* Verbs Hash Rx queues. */
 207         LIST_HEAD(txq, mlx5_txq_ctrl) txqsctrl; /* DPDK Tx queues. */
 208         LIST_HEAD(txqibv, mlx5_txq_ibv) txqsibv; /* Verbs Tx queues. */
 209         /* Verbs Indirection tables. */
 210         LIST_HEAD(ind_tables, mlx5_ind_table_ibv) ind_tbls;
 211         LIST_HEAD(matchers, mlx5_flow_dv_matcher) matchers;
 212         uint32_t link_speed_capa; /* Link speed capabilities. */
 213         struct mlx5_xstats_ctrl xstats_ctrl; /* Extended stats control. */
 214         int primary_socket; /* Unix socket for primary process. */
 215         void *uar_base; /* Reserved address space for UAR mapping */
 216         struct rte_intr_handle intr_handle_socket; /* Interrupt handler. */
 217         struct mlx5_dev_config config; /* Device configuration. */
 218         struct mlx5_verbs_alloc_ctx verbs_alloc_ctx;
 219         /* Context for Verbs allocator. */
 220         int nl_socket_rdma; /* Netlink socket (NETLINK_RDMA). */
 221         int nl_socket_route; /* Netlink socket (NETLINK_ROUTE). */
 222         uint32_t nl_sn; /* Netlink message sequence number. */
 223 #ifndef RTE_ARCH_64
 224         rte_spinlock_t uar_lock_cq; /* CQs share a common distinct UAR */
 225         rte_spinlock_t uar_lock[MLX5_UAR_PAGE_NUM_MAX];
 226         /* UAR same-page access control required in 32bit implementations. */
 227 #endif
 228         struct mnl_socket *mnl_socket; /* Libmnl socket. */
 229 };
 230
 231 #define PORT_ID(priv) ((priv)->dev_data->port_id)
 232 #define ETH_DEV(priv) (&rte_eth_devices[PORT_ID(priv)])
 233
 234 /* mlx5.c */
 235
 236 int mlx5_getenv_int(const char *);
 237
 238 /* mlx5_ethdev.c */
 239
 240 int mlx5_get_master_ifname(const struct rte_eth_dev *dev,
 241                            char (*ifname)[IF_NAMESIZE]);
 242 int mlx5_get_ifname(const struct rte_eth_dev *dev, char (*ifname)[IF_NAMESIZE]);
 243 unsigned int mlx5_ifindex(const struct rte_eth_dev *dev);
 244 int mlx5_ifreq(const struct rte_eth_dev *dev, int req, struct ifreq *ifr,
 245                int master);
 246 int mlx5_get_mtu(struct rte_eth_dev *dev, uint16_t *mtu);
 247 int mlx5_set_flags(struct rte_eth_dev *dev, unsigned int keep,
 248                    unsigned int flags);
 249 int mlx5_dev_configure(struct rte_eth_dev *dev);
 250 void mlx5_dev_infos_get(struct rte_eth_dev *dev, struct rte_eth_dev_info *info);
 251 const uint32_t *mlx5_dev_supported_ptypes_get(struct rte_eth_dev *dev);
 252 int mlx5_link_update(struct rte_eth_dev *dev, int wait_to_complete);
 253 int mlx5_force_link_status_change(struct rte_eth_dev *dev, int status);
 254 int mlx5_dev_set_mtu(struct rte_eth_dev *dev, uint16_t mtu);
 255 int mlx5_dev_get_flow_ctrl(struct rte_eth_dev *dev,
 256                            struct rte_eth_fc_conf *fc_conf);
 257 int mlx5_dev_set_flow_ctrl(struct rte_eth_dev *dev,
 258                            struct rte_eth_fc_conf *fc_conf);
 259 int mlx5_ibv_device_to_pci_addr(const struct ibv_device *device,
 260                                 struct rte_pci_addr *pci_addr);
 261 void mlx5_dev_link_status_handler(void *arg);
 262 void mlx5_dev_interrupt_handler(void *arg);
 263 void mlx5_dev_interrupt_handler_uninstall(struct rte_eth_dev *dev);
 264 void mlx5_dev_interrupt_handler_install(struct rte_eth_dev *dev);
 265 int mlx5_set_link_down(struct rte_eth_dev *dev);
 266 int mlx5_set_link_up(struct rte_eth_dev *dev);
 267 int mlx5_is_removed(struct rte_eth_dev *dev);
 268 eth_tx_burst_t mlx5_select_tx_function(struct rte_eth_dev *dev);
 269 eth_rx_burst_t mlx5_select_rx_function(struct rte_eth_dev *dev);
 270 unsigned int mlx5_dev_to_port_id(const struct rte_device *dev,
 271                                  uint16_t *port_list,
 272                                  unsigned int port_list_n);
 273 int mlx5_sysfs_switch_info(unsigned int ifindex,
 274                            struct mlx5_switch_info *info);
 275
 276 /* mlx5_mac.c */
 277
 278 int mlx5_get_mac(struct rte_eth_dev *dev, uint8_t (*mac)[ETHER_ADDR_LEN]);
 279 void mlx5_mac_addr_remove(struct rte_eth_dev *dev, uint32_t index);
 280 int mlx5_mac_addr_add(struct rte_eth_dev *dev, struct ether_addr *mac,
 281                       uint32_t index, uint32_t vmdq);
 282 int mlx5_mac_addr_set(struct rte_eth_dev *dev, struct ether_addr *mac_addr);
 283 int mlx5_set_mc_addr_list(struct rte_eth_dev *dev,
 284                           struct ether_addr *mc_addr_set, uint32_t nb_mc_addr);
 285
 286 /* mlx5_rss.c */
 287
 288 int mlx5_rss_hash_update(struct rte_eth_dev *dev,
 289                          struct rte_eth_rss_conf *rss_conf);
 290 int mlx5_rss_hash_conf_get(struct rte_eth_dev *dev,
 291                            struct rte_eth_rss_conf *rss_conf);
 292 int mlx5_rss_reta_index_resize(struct rte_eth_dev *dev, unsigned int reta_size);
 293 int mlx5_dev_rss_reta_query(struct rte_eth_dev *dev,
 294                             struct rte_eth_rss_reta_entry64 *reta_conf,
 295                             uint16_t reta_size);
 296 int mlx5_dev_rss_reta_update(struct rte_eth_dev *dev,
 297                              struct rte_eth_rss_reta_entry64 *reta_conf,
 298                              uint16_t reta_size);
 299
 300 /* mlx5_rxmode.c */
 301
 302 void mlx5_promiscuous_enable(struct rte_eth_dev *dev);
 303 void mlx5_promiscuous_disable(struct rte_eth_dev *dev);
 304 void mlx5_allmulticast_enable(struct rte_eth_dev *dev);
 305 void mlx5_allmulticast_disable(struct rte_eth_dev *dev);
 306
 307 /* mlx5_stats.c */
 308
 309 void mlx5_xstats_init(struct rte_eth_dev *dev);
 310 int mlx5_stats_get(struct rte_eth_dev *dev, struct rte_eth_stats *stats);
 311 void mlx5_stats_reset(struct rte_eth_dev *dev);
 312 int mlx5_xstats_get(struct rte_eth_dev *dev, struct rte_eth_xstat *stats,
 313                     unsigned int n);
 314 void mlx5_xstats_reset(struct rte_eth_dev *dev);
 315 int mlx5_xstats_get_names(struct rte_eth_dev *dev __rte_unused,
 316                           struct rte_eth_xstat_name *xstats_names,
 317                           unsigned int n);
 318
 319 /* mlx5_vlan.c */
 320
 321 int mlx5_vlan_filter_set(struct rte_eth_dev *dev, uint16_t vlan_id, int on);
 322 void mlx5_vlan_strip_queue_set(struct rte_eth_dev *dev, uint16_t queue, int on);
 323 int mlx5_vlan_offload_set(struct rte_eth_dev *dev, int mask);
 324
 325 /* mlx5_trigger.c */
 326
 327 int mlx5_dev_start(struct rte_eth_dev *dev);
 328 void mlx5_dev_stop(struct rte_eth_dev *dev);
 329 int mlx5_traffic_enable(struct rte_eth_dev *dev);
 330 void mlx5_traffic_disable(struct rte_eth_dev *dev);
 331 int mlx5_traffic_restart(struct rte_eth_dev *dev);
 332
 333 /* mlx5_flow.c */
 334
 335 int mlx5_flow_discover_priorities(struct rte_eth_dev *dev);
 336 void mlx5_flow_print(struct rte_flow *flow);
 337 int mlx5_flow_validate(struct rte_eth_dev *dev,
 338                        const struct rte_flow_attr *attr,
 339                        const struct rte_flow_item items[],
 340                        const struct rte_flow_action actions[],
 341                        struct rte_flow_error *error);
 342 struct rte_flow *mlx5_flow_create(struct rte_eth_dev *dev,
 343                                   const struct rte_flow_attr *attr,
 344                                   const struct rte_flow_item items[],
 345                                   const struct rte_flow_action actions[],
 346                                   struct rte_flow_error *error);
 347 int mlx5_flow_destroy(struct rte_eth_dev *dev, struct rte_flow *flow,
 348                       struct rte_flow_error *error);
 349 void mlx5_flow_list_flush(struct rte_eth_dev *dev, struct mlx5_flows *list);
 350 int mlx5_flow_flush(struct rte_eth_dev *dev, struct rte_flow_error *error);
 351 int mlx5_flow_query(struct rte_eth_dev *dev, struct rte_flow *flow,
 352                     const struct rte_flow_action *action, void *data,
 353                     struct rte_flow_error *error);
 354 int mlx5_flow_isolate(struct rte_eth_dev *dev, int enable,
 355                       struct rte_flow_error *error);
 356 int mlx5_dev_filter_ctrl(struct rte_eth_dev *dev,
 357                          enum rte_filter_type filter_type,
 358                          enum rte_filter_op filter_op,
 359                          void *arg);
 360 int mlx5_flow_start(struct rte_eth_dev *dev, struct mlx5_flows *list);
 361 void mlx5_flow_stop(struct rte_eth_dev *dev, struct mlx5_flows *list);
 362 int mlx5_flow_verify(struct rte_eth_dev *dev);
 363 int mlx5_ctrl_flow_vlan(struct rte_eth_dev *dev,
 364                         struct rte_flow_item_eth *eth_spec,
 365                         struct rte_flow_item_eth *eth_mask,
 366                         struct rte_flow_item_vlan *vlan_spec,
 367                         struct rte_flow_item_vlan *vlan_mask);
 368 int mlx5_ctrl_flow(struct rte_eth_dev *dev,
 369                    struct rte_flow_item_eth *eth_spec,
 370                    struct rte_flow_item_eth *eth_mask);
 371 int mlx5_flow_create_drop_queue(struct rte_eth_dev *dev);
 372 void mlx5_flow_delete_drop_queue(struct rte_eth_dev *dev);
 373
 374 /* mlx5_socket.c */
 375
 376 int mlx5_socket_init(struct rte_eth_dev *priv);
 377 void mlx5_socket_uninit(struct rte_eth_dev *priv);
 378 void mlx5_socket_handle(struct rte_eth_dev *priv);
 379 int mlx5_socket_connect(struct rte_eth_dev *priv);
 380
 381 /* mlx5_nl.c */
 382
 383 int mlx5_nl_init(int protocol);
 384 int mlx5_nl_mac_addr_add(struct rte_eth_dev *dev, struct ether_addr *mac,
 385                          uint32_t index);
 386 int mlx5_nl_mac_addr_remove(struct rte_eth_dev *dev, struct ether_addr *mac,
 387                             uint32_t index);
 388 void mlx5_nl_mac_addr_sync(struct rte_eth_dev *dev);
 389 void mlx5_nl_mac_addr_flush(struct rte_eth_dev *dev);
 390 int mlx5_nl_promisc(struct rte_eth_dev *dev, int enable);
 391 int mlx5_nl_allmulti(struct rte_eth_dev *dev, int enable);
 392 unsigned int mlx5_nl_ifindex(int nl, const char *name);
 393 int mlx5_nl_switch_info(int nl, unsigned int ifindex,
 394                         struct mlx5_switch_info *info);
 395
 396 #endif /* RTE_PMD_MLX5_H_ */