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