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 /*
  55  * Interrupt 0: LSC and errors
  56  * Interrupt 1: rx queue 0
  57  * Interrupt 2: rx queue 1
  58  * ...
  59  */
  60 #define ENICPMD_LSC_INTR_OFFSET 0
  61 #define ENICPMD_RXQ_INTR_OFFSET 1
  62
  63 struct enic_soft_stats {
  64         rte_atomic64_t rx_nombuf;
  65         rte_atomic64_t rx_packet_errors;
  66         rte_atomic64_t tx_oversized;
  67 };
  68
  69 struct enic_memzone_entry {
  70         const struct rte_memzone *rz;
  71         LIST_ENTRY(enic_memzone_entry) entries;
  72 };
  73
  74 /* Defined in enic_fm_flow.c */
  75 struct enic_flowman;
  76 struct enic_fm_flow;
  77
  78 struct rte_flow {
  79         LIST_ENTRY(rte_flow) next;
  80         /* Data for filter API based flow (enic_flow.c) */
  81         uint16_t enic_filter_id;
  82         struct filter_v2 enic_filter;
  83         /* Data for flow manager based flow (enic_fm_flow.c) */
  84         struct enic_fm_flow *fm;
  85         int internal;
  86 };
  87
  88 /* Per-instance private data structure */
  89 struct enic {
  90         struct rte_pci_device *pdev;
  91         struct vnic_enet_config config;
  92         struct vnic_dev_bar bar0;
  93         struct vnic_dev *vdev;
  94
  95         /*
  96          * mbuf_initializer contains 64 bits of mbuf rearm_data, used by
  97          * the avx2 handler at this time.
  98          */
  99         uint64_t mbuf_initializer;
 100         unsigned int port_id;
 101         bool overlay_offload;
 102         struct rte_eth_dev *rte_dev;
 103         struct rte_eth_dev_data *dev_data;
 104         char bdf_name[ENICPMD_BDF_LENGTH];
 105         int dev_fd;
 106         int iommu_group_fd;
 107         int iommu_groupid;
 108         int eventfd;
 109         uint8_t mac_addr[RTE_ETHER_ADDR_LEN];
 110         pthread_t err_intr_thread;
 111         int promisc;
 112         int allmulti;
 113         uint8_t ig_vlan_strip_en;
 114         int link_status;
 115         uint8_t hw_ip_checksum;
 116         uint16_t max_mtu;
 117         uint8_t adv_filters;
 118         uint32_t flow_filter_mode;
 119         uint8_t filter_actions; /* HW supported actions */
 120         bool vxlan;
 121         bool disable_overlay; /* devargs disable_overlay=1 */
 122         uint8_t enable_avx2_rx;  /* devargs enable-avx2-rx=1 */
 123         uint8_t geneve_opt_avail;    /* Geneve with options offload available */
 124         uint8_t geneve_opt_enabled;  /* Geneve with options offload enabled */
 125         uint8_t geneve_opt_request;  /* devargs geneve-opt=1 */
 126         bool nic_cfg_chk;     /* NIC_CFG_CHK available */
 127         bool udp_rss_weak;    /* Bodega style UDP RSS */
 128         uint8_t ig_vlan_rewrite_mode; /* devargs ig-vlan-rewrite */
 129         uint16_t vxlan_port;  /* current vxlan port pushed to NIC */
 130         int use_simple_tx_handler;
 131         int use_noscatter_vec_rx_handler;
 132
 133         unsigned int flags;
 134         unsigned int priv_flags;
 135
 136         /* work queue (len = conf_wq_count) */
 137         struct vnic_wq *wq;
 138         unsigned int wq_count; /* equals eth_dev nb_tx_queues */
 139
 140         /* receive queue (len = conf_rq_count) */
 141         struct vnic_rq *rq;
 142         unsigned int rq_count; /* equals eth_dev nb_rx_queues */
 143
 144         /* completion queue (len = conf_cq_count) */
 145         struct vnic_cq *cq;
 146         unsigned int cq_count; /* equals rq_count + wq_count */
 147
 148         /* interrupt vectors (len = conf_intr_count) */
 149         struct vnic_intr *intr;
 150         unsigned int intr_count; /* equals enabled interrupts (lsc + rxqs) */
 151
 152         /* software counters */
 153         struct enic_soft_stats soft_stats;
 154
 155         /* configured resources on vic */
 156         unsigned int conf_rq_count;
 157         unsigned int conf_wq_count;
 158         unsigned int conf_cq_count;
 159         unsigned int conf_intr_count;
 160
 161         /* linked list storing memory allocations */
 162         LIST_HEAD(enic_memzone_list, enic_memzone_entry) memzone_list;
 163         rte_spinlock_t memzone_list_lock;
 164         rte_spinlock_t mtu_lock;
 165
 166         LIST_HEAD(enic_flows, rte_flow) flows;
 167
 168         /* RSS */
 169         uint16_t reta_size;
 170         uint8_t hash_key_size;
 171         uint64_t flow_type_rss_offloads; /* 0 indicates RSS not supported */
 172         /*
 173          * Keep a copy of current RSS config for queries, as we cannot retrieve
 174          * it from the NIC.
 175          */
 176         uint8_t rss_hash_type; /* NIC_CFG_RSS_HASH_TYPE flags */
 177         uint8_t rss_enable;
 178         uint64_t rss_hf; /* ETH_RSS flags */
 179         union vnic_rss_key rss_key;
 180         union vnic_rss_cpu rss_cpu;
 181
 182         uint64_t rx_offload_capa; /* DEV_RX_OFFLOAD flags */
 183         uint64_t tx_offload_capa; /* DEV_TX_OFFLOAD flags */
 184         uint64_t tx_queue_offload_capa; /* DEV_TX_OFFLOAD flags */
 185         uint64_t tx_offload_mask; /* PKT_TX flags accepted */
 186
 187         /* Multicast MAC addresses added to the NIC */
 188         uint32_t mc_count;
 189         struct rte_ether_addr mc_addrs[ENIC_MULTICAST_PERFECT_FILTERS];
 190
 191         /* Flow manager API */
 192         struct enic_flowman *fm;
 193         uint64_t fm_vnic_handle;
 194         uint32_t fm_vnic_uif;
 195         /* switchdev */
 196         uint8_t switchdev_mode;
 197         uint16_t switch_domain_id;
 198         uint16_t max_vf_id;
 199         /* Number of queues needed for VF representor paths */
 200         uint32_t vf_required_wq;
 201         uint32_t vf_required_cq;
 202         uint32_t vf_required_rq;
 203         /*
 204          * Lock to serialize devcmds from PF, VF representors as they all share
 205          * the same PF devcmd instance in firmware.
 206          */
 207         rte_spinlock_t devcmd_lock;
 208 };
 209
 210 struct enic_vf_representor {
 211         struct enic enic;
 212         struct vnic_enet_config config;
 213         struct rte_eth_dev *eth_dev;
 214         struct rte_ether_addr mac_addr;
 215         struct rte_pci_addr bdf;
 216         struct enic *pf;
 217         uint16_t switch_domain_id;
 218         uint16_t vf_id;
 219         int allmulti;
 220         int promisc;
 221         /* Representor path uses PF queues. These are reserved during init */
 222         uint16_t pf_wq_idx;      /* WQ dedicated to VF rep */
 223         uint16_t pf_wq_cq_idx;   /* CQ for WQ */
 224         uint16_t pf_rq_sop_idx;  /* SOP RQ dedicated to VF rep */
 225         uint16_t pf_rq_data_idx; /* Data RQ */
 226         /* Representor flows managed by flowman */
 227         struct rte_flow *vf2rep_flow[2];
 228         struct rte_flow *rep2vf_flow[2];
 229 };
 230
 231 #define VF_ENIC_TO_VF_REP(vf_enic) \
 232         container_of(vf_enic, struct enic_vf_representor, enic)
 233
 234 static inline int enic_is_vf_rep(struct enic *enic)
 235 {
 236         return !!(enic->rte_dev->data->dev_flags & RTE_ETH_DEV_REPRESENTOR);
 237 }
 238
 239 /* Compute ethdev's max packet size from MTU */
 240 static inline uint32_t enic_mtu_to_max_rx_pktlen(uint32_t mtu)
 241 {
 242         /* ethdev max size includes eth whereas NIC MTU does not */
 243         return mtu + RTE_ETHER_HDR_LEN;
 244 }
 245
 246 /* Get the CQ index from a Start of Packet(SOP) RQ index */
 247 static inline unsigned int enic_sop_rq_idx_to_cq_idx(unsigned int sop_idx)
 248 {
 249         return sop_idx;
 250 }
 251
 252 /* Get the RTE RQ index from a Start of Packet(SOP) RQ index */
 253 static inline unsigned int enic_sop_rq_idx_to_rte_idx(unsigned int sop_idx)
 254 {
 255         return sop_idx;
 256 }
 257
 258 /* Get the Start of Packet(SOP) RQ index from a RTE RQ index */
 259 static inline unsigned int enic_rte_rq_idx_to_sop_idx(unsigned int rte_idx)
 260 {
 261         return rte_idx;
 262 }
 263
 264 /* Get the Data RQ index from a RTE RQ index */
 265 static inline unsigned int enic_rte_rq_idx_to_data_idx(unsigned int rte_idx,
 266                                                        struct enic *enic)
 267 {
 268         return enic->rq_count + rte_idx;
 269 }
 270
 271 static inline unsigned int enic_vnic_rq_count(struct enic *enic)
 272 {
 273         return enic->rq_count * 2;
 274 }
 275
 276 static inline unsigned int enic_cq_rq(__rte_unused struct enic *enic, unsigned int rq)
 277 {
 278         return rq;
 279 }
 280
 281 static inline unsigned int enic_cq_wq(struct enic *enic, unsigned int wq)
 282 {
 283         return enic->rq_count + wq;
 284 }
 285
 286 /*
 287  * WQ, RQ, CQ allocation scheme. Firmware gives the driver an array of
 288  * WQs, an array of RQs, and an array of CQs. Fow now, these are
 289  * statically allocated between PF app send/receive queues and VF
 290  * representor app send/receive queues. VF representor supports only 1
 291  * send and 1 receive queue. The number of PF app queue is not known
 292  * until the queue setup time.
 293  *
 294  * R = number of receive queues for PF app
 295  * S = number of send queues for PF app
 296  * V = number of VF representors
 297  *
 298  * wI = WQ for PF app send queue I
 299  * rI = SOP RQ for PF app receive queue I
 300  * dI = Data RQ for rI
 301  * cwI = CQ for wI
 302  * crI = CQ for rI
 303  * vwI = WQ for VF representor send queue I
 304  * vrI = SOP RQ for VF representor receive queue I
 305  * vdI = Data RQ for vrI
 306  * vcwI = CQ for vwI
 307  * vcrI = CQ for vrI
 308  *
 309  * WQ array: | w0 |..| wS-1 |..| vwV-1 |..| vw0 |
 310  *             ^         ^         ^         ^
 311  *    index    0        S-1       W-V       W-1    W=len(WQ array)
 312  *
 313  * RQ array: | r0  |..| rR-1  |d0 |..|dR-1|  ..|vdV-1 |..| vd0 |vrV-1 |..|vr0 |
 314  *             ^         ^     ^       ^         ^          ^     ^        ^
 315  *    index    0        R-1    R      2R-1      X-2V    X-(V+1)  X-V      X-1
 316  * X=len(RQ array)
 317  *
 318  * CQ array: | cr0 |..| crR-1 |cw0|..|cwS-1|..|vcwV-1|..| vcw0|vcrV-1|..|vcr0|..
 319  *              ^         ^     ^       ^        ^         ^      ^        ^
 320  *    index     0        R-1    R     R+S-1     X-2V    X-(V+1)  X-V      X-1
 321  * X is not a typo. It really is len(RQ array) to accommodate enic_cq_rq() used
 322  * throughout RX handlers. The current scheme requires
 323  * len(CQ array) >= len(RQ array).
 324  */
 325
 326 static inline unsigned int vf_wq_cq_idx(struct enic_vf_representor *vf)
 327 {
 328         /* rq is not a typo. index(vcwI) coincides with index(vdI) */
 329         return vf->pf->conf_rq_count - (vf->pf->max_vf_id + vf->vf_id + 2);
 330 }
 331
 332 static inline unsigned int vf_wq_idx(struct enic_vf_representor *vf)
 333 {
 334         return vf->pf->conf_wq_count - vf->vf_id - 1;
 335 }
 336
 337 static inline unsigned int vf_rq_sop_idx(struct enic_vf_representor *vf)
 338 {
 339         return vf->pf->conf_rq_count - vf->vf_id - 1;
 340 }
 341
 342 static inline unsigned int vf_rq_data_idx(struct enic_vf_representor *vf)
 343 {
 344         return vf->pf->conf_rq_count - (vf->pf->max_vf_id + vf->vf_id + 2);
 345 }
 346
 347 static inline struct enic *pmd_priv(struct rte_eth_dev *eth_dev)
 348 {
 349         return eth_dev->data->dev_private;
 350 }
 351
 352 static inline uint32_t
 353 enic_ring_add(uint32_t n_descriptors, uint32_t i0, uint32_t i1)
 354 {
 355         uint32_t d = i0 + i1;
 356         d -= (d >= n_descriptors) ? n_descriptors : 0;
 357         return d;
 358 }
 359
 360 static inline uint32_t
 361 enic_ring_sub(uint32_t n_descriptors, uint32_t i0, uint32_t i1)
 362 {
 363         int32_t d = i1 - i0;
 364         return (uint32_t)((d < 0) ? ((int32_t)n_descriptors + d) : d);
 365 }
 366
 367 static inline uint32_t
 368 enic_ring_incr(uint32_t n_descriptors, uint32_t idx)
 369 {
 370         idx++;
 371         if (unlikely(idx == n_descriptors))
 372                 idx = 0;
 373         return idx;
 374 }
 375
 376 int dev_is_enic(struct rte_eth_dev *dev);
 377 void enic_free_wq(void *txq);
 378 int enic_alloc_intr_resources(struct enic *enic);
 379 int enic_setup_finish(struct enic *enic);
 380 int enic_alloc_wq(struct enic *enic, uint16_t queue_idx,
 381                   unsigned int socket_id, uint16_t nb_desc);
 382 void enic_start_wq(struct enic *enic, uint16_t queue_idx);
 383 int enic_stop_wq(struct enic *enic, uint16_t queue_idx);
 384 void enic_start_rq(struct enic *enic, uint16_t queue_idx);
 385 int enic_stop_rq(struct enic *enic, uint16_t queue_idx);
 386 void enic_free_rq(void *rxq);
 387 int enic_alloc_rq(struct enic *enic, uint16_t queue_idx,
 388                   unsigned int socket_id, struct rte_mempool *mp,
 389                   uint16_t nb_desc, uint16_t free_thresh);
 390 int enic_set_vnic_res(struct enic *enic);
 391 int enic_init_rss_nic_cfg(struct enic *enic);
 392 int enic_set_rss_conf(struct enic *enic,
 393                       struct rte_eth_rss_conf *rss_conf);
 394 int enic_set_rss_reta(struct enic *enic, union vnic_rss_cpu *rss_cpu);
 395 int enic_set_vlan_strip(struct enic *enic);
 396 int enic_enable(struct enic *enic);
 397 int enic_disable(struct enic *enic);
 398 void enic_remove(struct enic *enic);
 399 int enic_get_link_status(struct enic *enic);
 400 int enic_dev_stats_get(struct enic *enic,
 401                        struct rte_eth_stats *r_stats);
 402 int enic_dev_stats_clear(struct enic *enic);
 403 int enic_add_packet_filter(struct enic *enic);
 404 int enic_set_mac_address(struct enic *enic, uint8_t *mac_addr);
 405 int enic_del_mac_address(struct enic *enic, int mac_index);
 406 unsigned int enic_cleanup_wq(struct enic *enic, struct vnic_wq *wq);
 407 void enic_send_pkt(struct enic *enic, struct vnic_wq *wq,
 408                    struct rte_mbuf *tx_pkt, unsigned short len,
 409                    uint8_t sop, uint8_t eop, uint8_t cq_entry,
 410                    uint16_t ol_flags, uint16_t vlan_tag);
 411
 412 void enic_post_wq_index(struct vnic_wq *wq);
 413 int enic_probe(struct enic *enic);
 414 int enic_fm_init(struct enic *enic);
 415 void enic_fm_destroy(struct enic *enic);
 416 void *enic_alloc_consistent(void *priv, size_t size, dma_addr_t *dma_handle,
 417                             uint8_t *name);
 418 void enic_free_consistent(void *priv, size_t size, void *vaddr,
 419                           dma_addr_t dma_handle);
 420 uint16_t enic_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 421                         uint16_t nb_pkts);
 422 uint16_t enic_noscatter_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 423                                   uint16_t nb_pkts);
 424 uint16_t enic_dummy_recv_pkts(void *rx_queue,
 425                               struct rte_mbuf **rx_pkts,
 426                               uint16_t nb_pkts);
 427 uint16_t enic_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 428                         uint16_t nb_pkts);
 429 uint16_t enic_simple_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 430                                uint16_t nb_pkts);
 431 uint16_t enic_prep_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 432                         uint16_t nb_pkts);
 433 int enic_set_mtu(struct enic *enic, uint16_t new_mtu);
 434 int enic_link_update(struct rte_eth_dev *eth_dev);
 435 bool enic_use_vector_rx_handler(struct rte_eth_dev *eth_dev);
 436 void enic_pick_rx_handler(struct rte_eth_dev *eth_dev);
 437 void enic_pick_tx_handler(struct rte_eth_dev *eth_dev);
 438 int enic_vf_representor_init(struct rte_eth_dev *eth_dev, void *init_params);
 439 int enic_vf_representor_uninit(struct rte_eth_dev *ethdev);
 440 int enic_fm_allocate_switch_domain(struct enic *pf);
 441 int enic_fm_add_rep2vf_flow(struct enic_vf_representor *vf);
 442 int enic_fm_add_vf2rep_flow(struct enic_vf_representor *vf);
 443 int enic_alloc_rx_queue_mbufs(struct enic *enic, struct vnic_rq *rq);
 444 void enic_rxmbuf_queue_release(struct enic *enic, struct vnic_rq *rq);
 445 void enic_free_wq_buf(struct rte_mbuf **buf);
 446 void enic_free_rq_buf(struct rte_mbuf **mbuf);
 447 extern const struct rte_flow_ops enic_flow_ops;
 448 extern const struct rte_flow_ops enic_fm_flow_ops;
 449
 450 #endif /* _ENIC_H_ */