drivers/net/enic/enic.h

   1 /* SPDX-License-Identifier: BSD-3-Clause
   2  * Copyright 2008-2017 Cisco Systems, Inc.  All rights reserved.
   3  * Copyright 2007 Nuova Systems, Inc.  All rights reserved.
   4  */
   5
   6 #ifndef _ENIC_H_
   7 #define _ENIC_H_
   8
   9 #include <rte_vxlan.h>
  10 #include <rte_ether.h>
  11 #include "vnic_enet.h"
  12 #include "vnic_dev.h"
  13 #include "vnic_flowman.h"
  14 #include "vnic_wq.h"
  15 #include "vnic_rq.h"
  16 #include "vnic_cq.h"
  17 #include "vnic_intr.h"
  18 #include "vnic_stats.h"
  19 #include "vnic_nic.h"
  20 #include "vnic_rss.h"
  21 #include "enic_res.h"
  22 #include "cq_enet_desc.h"
  23 #include <stdbool.h>
  24 #include <sys/queue.h>
  25 #include <rte_spinlock.h>
  26
  27 #define DRV_NAME                "enic_pmd"
  28 #define DRV_DESCRIPTION         "Cisco VIC Ethernet NIC Poll-mode Driver"
  29 #define DRV_COPYRIGHT           "Copyright 2008-2015 Cisco Systems, Inc"
  30
  31 #define VLAN_ETH_HLEN           18
  32
  33 #define ENICPMD_SETTING(enic, f) ((enic->config.flags & VENETF_##f) ? 1 : 0)
  34
  35 #define ENICPMD_BDF_LENGTH      13   /* 0000:00:00.0'\0' */
  36 #define ENIC_CALC_IP_CKSUM      1
  37 #define ENIC_CALC_TCP_UDP_CKSUM 2
  38 #define ENIC_MAX_MTU            9000
  39 #define ENIC_PAGE_SIZE          4096
  40 #define PAGE_ROUND_UP(x) \
  41         ((((unsigned long)(x)) + ENIC_PAGE_SIZE-1) & (~(ENIC_PAGE_SIZE-1)))
  42
  43 #define ENICPMD_VFIO_PATH          "/dev/vfio/vfio"
  44 /*#define ENIC_DESC_COUNT_MAKE_ODD (x) do{if ((~(x)) & 1) { (x)--; } }while(0)*/
  45
  46 #define PCI_DEVICE_ID_CISCO_VIC_ENET         0x0043  /* ethernet vnic */
  47 #define PCI_DEVICE_ID_CISCO_VIC_ENET_VF      0x0071  /* enet SRIOV VF */
  48 /* enet SRIOV Standalone vNic VF */
  49 #define PCI_DEVICE_ID_CISCO_VIC_ENET_SN      0x02B7
  50
  51 /* Special Filter id for non-specific packet flagging. Don't change value */
  52 #define ENIC_MAGIC_FILTER_ID 0xffff
  53
  54 #define ENICPMD_FDIR_MAX           64
  55
  56 /*
  57  * Interrupt 0: LSC and errors
  58  * Interrupt 1: rx queue 0
  59  * Interrupt 2: rx queue 1
  60  * ...
  61  */
  62 #define ENICPMD_LSC_INTR_OFFSET 0
  63 #define ENICPMD_RXQ_INTR_OFFSET 1
  64
  65 struct enic_fdir_node {
  66         struct rte_eth_fdir_filter filter;
  67         uint16_t fltr_id;
  68         uint16_t rq_index;
  69 };
  70
  71 struct enic_fdir {
  72         struct rte_eth_fdir_stats stats;
  73         struct rte_hash *hash;
  74         struct enic_fdir_node *nodes[ENICPMD_FDIR_MAX];
  75         uint32_t modes;
  76         uint32_t types_mask;
  77         void (*copy_fltr_fn)(struct filter_v2 *filt,
  78                              const struct rte_eth_fdir_input *input,
  79                              const struct rte_eth_fdir_masks *masks);
  80 };
  81
  82 struct enic_soft_stats {
  83         rte_atomic64_t rx_nombuf;
  84         rte_atomic64_t rx_packet_errors;
  85         rte_atomic64_t tx_oversized;
  86 };
  87
  88 struct enic_memzone_entry {
  89         const struct rte_memzone *rz;
  90         LIST_ENTRY(enic_memzone_entry) entries;
  91 };
  92
  93 /* Defined in enic_fm_flow.c */
  94 struct enic_flowman;
  95 struct enic_fm_flow;
  96
  97 struct rte_flow {
  98         LIST_ENTRY(rte_flow) next;
  99         /* Data for filter API based flow (enic_flow.c) */
 100         uint16_t enic_filter_id;
 101         struct filter_v2 enic_filter;
 102         /* Data for flow manager based flow (enic_fm_flow.c) */
 103         struct enic_fm_flow *fm;
 104 };
 105
 106 /* Per-instance private data structure */
 107 struct enic {
 108         struct enic *next;
 109         struct rte_pci_device *pdev;
 110         struct vnic_enet_config config;
 111         struct vnic_dev_bar bar0;
 112         struct vnic_dev *vdev;
 113
 114         /*
 115          * mbuf_initializer contains 64 bits of mbuf rearm_data, used by
 116          * the avx2 handler at this time.
 117          */
 118         uint64_t mbuf_initializer;
 119         unsigned int port_id;
 120         bool overlay_offload;
 121         struct rte_eth_dev *rte_dev;
 122         struct rte_eth_dev_data *dev_data;
 123         struct enic_fdir fdir;
 124         char bdf_name[ENICPMD_BDF_LENGTH];
 125         int dev_fd;
 126         int iommu_group_fd;
 127         int iommu_groupid;
 128         int eventfd;
 129         uint8_t mac_addr[RTE_ETHER_ADDR_LEN];
 130         pthread_t err_intr_thread;
 131         int promisc;
 132         int allmulti;
 133         uint8_t ig_vlan_strip_en;
 134         int link_status;
 135         uint8_t hw_ip_checksum;
 136         uint16_t max_mtu;
 137         uint8_t adv_filters;
 138         uint32_t flow_filter_mode;
 139         uint8_t filter_actions; /* HW supported actions */
 140         bool vxlan;
 141         bool disable_overlay; /* devargs disable_overlay=1 */
 142         uint8_t enable_avx2_rx;  /* devargs enable-avx2-rx=1 */
 143         uint8_t geneve_opt_avail;    /* Geneve with options offload available */
 144         uint8_t geneve_opt_enabled;  /* Geneve with options offload enabled */
 145         uint8_t geneve_opt_request;  /* devargs geneve-opt=1 */
 146         bool nic_cfg_chk;     /* NIC_CFG_CHK available */
 147         bool udp_rss_weak;    /* Bodega style UDP RSS */
 148         uint8_t ig_vlan_rewrite_mode; /* devargs ig-vlan-rewrite */
 149         uint16_t vxlan_port;  /* current vxlan port pushed to NIC */
 150         int use_simple_tx_handler;
 151
 152         unsigned int flags;
 153         unsigned int priv_flags;
 154
 155         /* work queue (len = conf_wq_count) */
 156         struct vnic_wq *wq;
 157         unsigned int wq_count; /* equals eth_dev nb_tx_queues */
 158
 159         /* receive queue (len = conf_rq_count) */
 160         struct vnic_rq *rq;
 161         unsigned int rq_count; /* equals eth_dev nb_rx_queues */
 162
 163         /* completion queue (len = conf_cq_count) */
 164         struct vnic_cq *cq;
 165         unsigned int cq_count; /* equals rq_count + wq_count */
 166
 167         /* interrupt vectors (len = conf_intr_count) */
 168         struct vnic_intr *intr;
 169         unsigned int intr_count; /* equals enabled interrupts (lsc + rxqs) */
 170
 171         /* software counters */
 172         struct enic_soft_stats soft_stats;
 173
 174         /* configured resources on vic */
 175         unsigned int conf_rq_count;
 176         unsigned int conf_wq_count;
 177         unsigned int conf_cq_count;
 178         unsigned int conf_intr_count;
 179
 180         /* linked list storing memory allocations */
 181         LIST_HEAD(enic_memzone_list, enic_memzone_entry) memzone_list;
 182         rte_spinlock_t memzone_list_lock;
 183         rte_spinlock_t mtu_lock;
 184
 185         LIST_HEAD(enic_flows, rte_flow) flows;
 186
 187         /* RSS */
 188         uint16_t reta_size;
 189         uint8_t hash_key_size;
 190         uint64_t flow_type_rss_offloads; /* 0 indicates RSS not supported */
 191         /*
 192          * Keep a copy of current RSS config for queries, as we cannot retrieve
 193          * it from the NIC.
 194          */
 195         uint8_t rss_hash_type; /* NIC_CFG_RSS_HASH_TYPE flags */
 196         uint8_t rss_enable;
 197         uint64_t rss_hf; /* ETH_RSS flags */
 198         union vnic_rss_key rss_key;
 199         union vnic_rss_cpu rss_cpu;
 200
 201         uint64_t rx_offload_capa; /* DEV_RX_OFFLOAD flags */
 202         uint64_t tx_offload_capa; /* DEV_TX_OFFLOAD flags */
 203         uint64_t tx_queue_offload_capa; /* DEV_TX_OFFLOAD flags */
 204         uint64_t tx_offload_mask; /* PKT_TX flags accepted */
 205
 206         /* Multicast MAC addresses added to the NIC */
 207         uint32_t mc_count;
 208         struct rte_ether_addr mc_addrs[ENIC_MULTICAST_PERFECT_FILTERS];
 209
 210         /* Flow manager API */
 211         struct enic_flowman *fm;
 212 };
 213
 214 /* Compute ethdev's max packet size from MTU */
 215 static inline uint32_t enic_mtu_to_max_rx_pktlen(uint32_t mtu)
 216 {
 217         /* ethdev max size includes eth whereas NIC MTU does not */
 218         return mtu + RTE_ETHER_HDR_LEN;
 219 }
 220
 221 /* Get the CQ index from a Start of Packet(SOP) RQ index */
 222 static inline unsigned int enic_sop_rq_idx_to_cq_idx(unsigned int sop_idx)
 223 {
 224         return sop_idx / 2;
 225 }
 226
 227 /* Get the RTE RQ index from a Start of Packet(SOP) RQ index */
 228 static inline unsigned int enic_sop_rq_idx_to_rte_idx(unsigned int sop_idx)
 229 {
 230         return sop_idx / 2;
 231 }
 232
 233 /* Get the Start of Packet(SOP) RQ index from a RTE RQ index */
 234 static inline unsigned int enic_rte_rq_idx_to_sop_idx(unsigned int rte_idx)
 235 {
 236         return rte_idx * 2;
 237 }
 238
 239 /* Get the Data RQ index from a RTE RQ index */
 240 static inline unsigned int enic_rte_rq_idx_to_data_idx(unsigned int rte_idx)
 241 {
 242         return rte_idx * 2 + 1;
 243 }
 244
 245 static inline unsigned int enic_vnic_rq_count(struct enic *enic)
 246 {
 247         return enic->rq_count * 2;
 248 }
 249
 250 static inline unsigned int enic_cq_rq(__rte_unused struct enic *enic, unsigned int rq)
 251 {
 252         /* Scatter rx uses two receive queues together with one
 253          * completion queue, so the completion queue number is no
 254          * longer the same as the rq number.
 255          */
 256         return rq / 2;
 257 }
 258
 259 static inline unsigned int enic_cq_wq(struct enic *enic, unsigned int wq)
 260 {
 261         return enic->rq_count + wq;
 262 }
 263
 264 static inline struct enic *pmd_priv(struct rte_eth_dev *eth_dev)
 265 {
 266         return eth_dev->data->dev_private;
 267 }
 268
 269 static inline uint32_t
 270 enic_ring_add(uint32_t n_descriptors, uint32_t i0, uint32_t i1)
 271 {
 272         uint32_t d = i0 + i1;
 273         d -= (d >= n_descriptors) ? n_descriptors : 0;
 274         return d;
 275 }
 276
 277 static inline uint32_t
 278 enic_ring_sub(uint32_t n_descriptors, uint32_t i0, uint32_t i1)
 279 {
 280         int32_t d = i1 - i0;
 281         return (uint32_t)((d < 0) ? ((int32_t)n_descriptors + d) : d);
 282 }
 283
 284 static inline uint32_t
 285 enic_ring_incr(uint32_t n_descriptors, uint32_t idx)
 286 {
 287         idx++;
 288         if (unlikely(idx == n_descriptors))
 289                 idx = 0;
 290         return idx;
 291 }
 292
 293 int dev_is_enic(struct rte_eth_dev *dev);
 294 void enic_fdir_stats_get(struct enic *enic,
 295                          struct rte_eth_fdir_stats *stats);
 296 int enic_fdir_add_fltr(struct enic *enic,
 297                        struct rte_eth_fdir_filter *params);
 298 int enic_fdir_del_fltr(struct enic *enic,
 299                        struct rte_eth_fdir_filter *params);
 300 void enic_free_wq(void *txq);
 301 int enic_alloc_intr_resources(struct enic *enic);
 302 int enic_setup_finish(struct enic *enic);
 303 int enic_alloc_wq(struct enic *enic, uint16_t queue_idx,
 304                   unsigned int socket_id, uint16_t nb_desc);
 305 void enic_start_wq(struct enic *enic, uint16_t queue_idx);
 306 int enic_stop_wq(struct enic *enic, uint16_t queue_idx);
 307 void enic_start_rq(struct enic *enic, uint16_t queue_idx);
 308 int enic_stop_rq(struct enic *enic, uint16_t queue_idx);
 309 void enic_free_rq(void *rxq);
 310 int enic_alloc_rq(struct enic *enic, uint16_t queue_idx,
 311                   unsigned int socket_id, struct rte_mempool *mp,
 312                   uint16_t nb_desc, uint16_t free_thresh);
 313 int enic_set_vnic_res(struct enic *enic);
 314 int enic_init_rss_nic_cfg(struct enic *enic);
 315 int enic_set_rss_conf(struct enic *enic,
 316                       struct rte_eth_rss_conf *rss_conf);
 317 int enic_set_rss_reta(struct enic *enic, union vnic_rss_cpu *rss_cpu);
 318 int enic_set_vlan_strip(struct enic *enic);
 319 int enic_enable(struct enic *enic);
 320 int enic_disable(struct enic *enic);
 321 void enic_remove(struct enic *enic);
 322 int enic_get_link_status(struct enic *enic);
 323 int enic_dev_stats_get(struct enic *enic,
 324                        struct rte_eth_stats *r_stats);
 325 int enic_dev_stats_clear(struct enic *enic);
 326 int enic_add_packet_filter(struct enic *enic);
 327 int enic_set_mac_address(struct enic *enic, uint8_t *mac_addr);
 328 int enic_del_mac_address(struct enic *enic, int mac_index);
 329 unsigned int enic_cleanup_wq(struct enic *enic, struct vnic_wq *wq);
 330 void enic_send_pkt(struct enic *enic, struct vnic_wq *wq,
 331                    struct rte_mbuf *tx_pkt, unsigned short len,
 332                    uint8_t sop, uint8_t eop, uint8_t cq_entry,
 333                    uint16_t ol_flags, uint16_t vlan_tag);
 334
 335 void enic_post_wq_index(struct vnic_wq *wq);
 336 int enic_probe(struct enic *enic);
 337 int enic_clsf_init(struct enic *enic);
 338 void enic_clsf_destroy(struct enic *enic);
 339 int enic_fm_init(struct enic *enic);
 340 void enic_fm_destroy(struct enic *enic);
 341 void *enic_alloc_consistent(void *priv, size_t size, dma_addr_t *dma_handle,
 342                             uint8_t *name);
 343 void enic_free_consistent(void *priv, size_t size, void *vaddr,
 344                           dma_addr_t dma_handle);
 345 uint16_t enic_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 346                         uint16_t nb_pkts);
 347 uint16_t enic_noscatter_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 348                                   uint16_t nb_pkts);
 349 uint16_t enic_dummy_recv_pkts(void *rx_queue,
 350                               struct rte_mbuf **rx_pkts,
 351                               uint16_t nb_pkts);
 352 uint16_t enic_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 353                         uint16_t nb_pkts);
 354 uint16_t enic_simple_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 355                                uint16_t nb_pkts);
 356 uint16_t enic_prep_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 357                         uint16_t nb_pkts);
 358 int enic_set_mtu(struct enic *enic, uint16_t new_mtu);
 359 int enic_link_update(struct rte_eth_dev *eth_dev);
 360 bool enic_use_vector_rx_handler(struct rte_eth_dev *eth_dev);
 361 void enic_pick_rx_handler(struct rte_eth_dev *eth_dev);
 362 void enic_pick_tx_handler(struct rte_eth_dev *eth_dev);
 363 void enic_fdir_info(struct enic *enic);
 364 void enic_fdir_info_get(struct enic *enic, struct rte_eth_fdir_info *stats);
 365 extern const struct rte_flow_ops enic_flow_ops;
 366 extern const struct rte_flow_ops enic_fm_flow_ops;
 367 #endif /* _ENIC_H_ */