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 ENIC_MAX_MAC_ADDR       64
  29
  30 #define VLAN_ETH_HLEN           18
  31
  32 #define ENICPMD_SETTING(enic, f) ((enic->config.flags & VENETF_##f) ? 1 : 0)
  33
  34 #define ENICPMD_BDF_LENGTH      13   /* 0000:00:00.0'\0' */
  35 #define ENIC_CALC_IP_CKSUM      1
  36 #define ENIC_CALC_TCP_UDP_CKSUM 2
  37 #define ENIC_MAX_MTU            9000
  38 #define ENIC_PAGE_SIZE          4096
  39 #define PAGE_ROUND_UP(x) \
  40         ((((unsigned long)(x)) + ENIC_PAGE_SIZE-1) & (~(ENIC_PAGE_SIZE-1)))
  41
  42 /* must be >= VNIC_COUNTER_DMA_MIN_PERIOD */
  43 #define VNIC_FLOW_COUNTER_UPDATE_MSECS 500
  44
  45 #define ENICPMD_VFIO_PATH          "/dev/vfio/vfio"
  46 /*#define ENIC_DESC_COUNT_MAKE_ODD (x) do{if ((~(x)) & 1) { (x)--; } }while(0)*/
  47
  48 #define PCI_DEVICE_ID_CISCO_VIC_ENET         0x0043  /* ethernet vnic */
  49 #define PCI_DEVICE_ID_CISCO_VIC_ENET_VF      0x0071  /* enet SRIOV VF */
  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 /* HW default VXLAN port */
  57 #define ENIC_DEFAULT_VXLAN_PORT    4789
  58
  59 /*
  60  * Interrupt 0: LSC and errors
  61  * Interrupt 1: rx queue 0
  62  * Interrupt 2: rx queue 1
  63  * ...
  64  */
  65 #define ENICPMD_LSC_INTR_OFFSET 0
  66 #define ENICPMD_RXQ_INTR_OFFSET 1
  67
  68 struct enic_fdir_node {
  69         struct rte_eth_fdir_filter filter;
  70         u16 fltr_id;
  71         u16 rq_index;
  72 };
  73
  74 struct enic_fdir {
  75         struct rte_eth_fdir_stats stats;
  76         struct rte_hash *hash;
  77         struct enic_fdir_node *nodes[ENICPMD_FDIR_MAX];
  78         u32 modes;
  79         u32 types_mask;
  80         void (*copy_fltr_fn)(struct filter_v2 *filt,
  81                              struct rte_eth_fdir_input *input,
  82                              struct rte_eth_fdir_masks *masks);
  83 };
  84
  85 struct enic_soft_stats {
  86         rte_atomic64_t rx_nombuf;
  87         rte_atomic64_t rx_packet_errors;
  88         rte_atomic64_t tx_oversized;
  89 };
  90
  91 struct enic_memzone_entry {
  92         const struct rte_memzone *rz;
  93         LIST_ENTRY(enic_memzone_entry) entries;
  94 };
  95
  96 struct rte_flow {
  97         LIST_ENTRY(rte_flow) next;
  98         u16 enic_filter_id;
  99         struct filter_v2 enic_filter;
 100         int counter_idx; /* NIC allocated counter index (-1 = invalid) */
 101 };
 102
 103 /* Per-instance private data structure */
 104 struct enic {
 105         struct enic *next;
 106         struct rte_pci_device *pdev;
 107         struct vnic_enet_config config;
 108         struct vnic_dev_bar bar0;
 109         struct vnic_dev *vdev;
 110
 111         /*
 112          * mbuf_initializer contains 64 bits of mbuf rearm_data, used by
 113          * the avx2 handler at this time.
 114          */
 115         uint64_t mbuf_initializer;
 116         unsigned int port_id;
 117         bool overlay_offload;
 118         struct rte_eth_dev *rte_dev;
 119         struct enic_fdir fdir;
 120         char bdf_name[ENICPMD_BDF_LENGTH];
 121         int dev_fd;
 122         int iommu_group_fd;
 123         int iommu_groupid;
 124         int eventfd;
 125         uint8_t mac_addr[ETH_ALEN];
 126         pthread_t err_intr_thread;
 127         int promisc;
 128         int allmulti;
 129         u8 ig_vlan_strip_en;
 130         int link_status;
 131         u8 hw_ip_checksum;
 132         u16 max_mtu;
 133         u8 adv_filters;
 134         u32 flow_filter_mode;
 135         u8 filter_actions; /* HW supported actions */
 136         bool vxlan;
 137         bool disable_overlay; /* devargs disable_overlay=1 */
 138         uint8_t enable_avx2_rx;  /* devargs enable-avx2-rx=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
 144         unsigned int flags;
 145         unsigned int priv_flags;
 146
 147         /* work queue (len = conf_wq_count) */
 148         struct vnic_wq *wq;
 149         unsigned int wq_count; /* equals eth_dev nb_tx_queues */
 150
 151         /* receive queue (len = conf_rq_count) */
 152         struct vnic_rq *rq;
 153         unsigned int rq_count; /* equals eth_dev nb_rx_queues */
 154
 155         /* completion queue (len = conf_cq_count) */
 156         struct vnic_cq *cq;
 157         unsigned int cq_count; /* equals rq_count + wq_count */
 158
 159         /* interrupt vectors (len = conf_intr_count) */
 160         struct vnic_intr *intr;
 161         unsigned int intr_count; /* equals enabled interrupts (lsc + rxqs) */
 162
 163         /* software counters */
 164         struct enic_soft_stats soft_stats;
 165
 166         /* configured resources on vic */
 167         unsigned int conf_rq_count;
 168         unsigned int conf_wq_count;
 169         unsigned int conf_cq_count;
 170         unsigned int conf_intr_count;
 171
 172         /* linked list storing memory allocations */
 173         LIST_HEAD(enic_memzone_list, enic_memzone_entry) memzone_list;
 174         rte_spinlock_t memzone_list_lock;
 175         rte_spinlock_t mtu_lock;
 176
 177         LIST_HEAD(enic_flows, rte_flow) flows;
 178         int max_flow_counter;
 179         rte_spinlock_t flows_lock;
 180
 181         /* RSS */
 182         uint16_t reta_size;
 183         uint8_t hash_key_size;
 184         uint64_t flow_type_rss_offloads; /* 0 indicates RSS not supported */
 185         /*
 186          * Keep a copy of current RSS config for queries, as we cannot retrieve
 187          * it from the NIC.
 188          */
 189         uint8_t rss_hash_type; /* NIC_CFG_RSS_HASH_TYPE flags */
 190         uint8_t rss_enable;
 191         uint64_t rss_hf; /* ETH_RSS flags */
 192         union vnic_rss_key rss_key;
 193         union vnic_rss_cpu rss_cpu;
 194
 195         uint64_t rx_offload_capa; /* DEV_RX_OFFLOAD flags */
 196         uint64_t tx_offload_capa; /* DEV_TX_OFFLOAD flags */
 197         uint64_t tx_queue_offload_capa; /* DEV_TX_OFFLOAD flags */
 198         uint64_t tx_offload_mask; /* PKT_TX flags accepted */
 199 };
 200
 201 /* Compute ethdev's max packet size from MTU */
 202 static inline uint32_t enic_mtu_to_max_rx_pktlen(uint32_t mtu)
 203 {
 204         /* ethdev max size includes eth and crc whereas NIC MTU does not */
 205         return mtu + ETHER_HDR_LEN + ETHER_CRC_LEN;
 206 }
 207
 208 /* Get the CQ index from a Start of Packet(SOP) RQ index */
 209 static inline unsigned int enic_sop_rq_idx_to_cq_idx(unsigned int sop_idx)
 210 {
 211         return sop_idx / 2;
 212 }
 213
 214 /* Get the RTE RQ index from a Start of Packet(SOP) RQ index */
 215 static inline unsigned int enic_sop_rq_idx_to_rte_idx(unsigned int sop_idx)
 216 {
 217         return sop_idx / 2;
 218 }
 219
 220 /* Get the Start of Packet(SOP) RQ index from a RTE RQ index */
 221 static inline unsigned int enic_rte_rq_idx_to_sop_idx(unsigned int rte_idx)
 222 {
 223         return rte_idx * 2;
 224 }
 225
 226 /* Get the Data RQ index from a RTE RQ index */
 227 static inline unsigned int enic_rte_rq_idx_to_data_idx(unsigned int rte_idx)
 228 {
 229         return rte_idx * 2 + 1;
 230 }
 231
 232 static inline unsigned int enic_vnic_rq_count(struct enic *enic)
 233 {
 234         return enic->rq_count * 2;
 235 }
 236
 237 static inline unsigned int enic_cq_rq(__rte_unused struct enic *enic, unsigned int rq)
 238 {
 239         /* Scatter rx uses two receive queues together with one
 240          * completion queue, so the completion queue number is no
 241          * longer the same as the rq number.
 242          */
 243         return rq / 2;
 244 }
 245
 246 static inline unsigned int enic_cq_wq(struct enic *enic, unsigned int wq)
 247 {
 248         return enic->rq_count + wq;
 249 }
 250
 251 static inline struct enic *pmd_priv(struct rte_eth_dev *eth_dev)
 252 {
 253         return (struct enic *)eth_dev->data->dev_private;
 254 }
 255
 256 static inline uint32_t
 257 enic_ring_add(uint32_t n_descriptors, uint32_t i0, uint32_t i1)
 258 {
 259         uint32_t d = i0 + i1;
 260         d -= (d >= n_descriptors) ? n_descriptors : 0;
 261         return d;
 262 }
 263
 264 static inline uint32_t
 265 enic_ring_sub(uint32_t n_descriptors, uint32_t i0, uint32_t i1)
 266 {
 267         int32_t d = i1 - i0;
 268         return (uint32_t)((d < 0) ? ((int32_t)n_descriptors + d) : d);
 269 }
 270
 271 static inline uint32_t
 272 enic_ring_incr(uint32_t n_descriptors, uint32_t idx)
 273 {
 274         idx++;
 275         if (unlikely(idx == n_descriptors))
 276                 idx = 0;
 277         return idx;
 278 }
 279
 280 void enic_fdir_stats_get(struct enic *enic,
 281                          struct rte_eth_fdir_stats *stats);
 282 int enic_fdir_add_fltr(struct enic *enic,
 283                        struct rte_eth_fdir_filter *params);
 284 int enic_fdir_del_fltr(struct enic *enic,
 285                        struct rte_eth_fdir_filter *params);
 286 void enic_free_wq(void *txq);
 287 int enic_alloc_intr_resources(struct enic *enic);
 288 int enic_setup_finish(struct enic *enic);
 289 int enic_alloc_wq(struct enic *enic, uint16_t queue_idx,
 290                   unsigned int socket_id, uint16_t nb_desc);
 291 void enic_start_wq(struct enic *enic, uint16_t queue_idx);
 292 int enic_stop_wq(struct enic *enic, uint16_t queue_idx);
 293 void enic_start_rq(struct enic *enic, uint16_t queue_idx);
 294 int enic_stop_rq(struct enic *enic, uint16_t queue_idx);
 295 void enic_free_rq(void *rxq);
 296 int enic_alloc_rq(struct enic *enic, uint16_t queue_idx,
 297                   unsigned int socket_id, struct rte_mempool *mp,
 298                   uint16_t nb_desc, uint16_t free_thresh);
 299 int enic_set_vnic_res(struct enic *enic);
 300 int enic_init_rss_nic_cfg(struct enic *enic);
 301 int enic_set_rss_conf(struct enic *enic,
 302                       struct rte_eth_rss_conf *rss_conf);
 303 int enic_set_rss_reta(struct enic *enic, union vnic_rss_cpu *rss_cpu);
 304 int enic_set_vlan_strip(struct enic *enic);
 305 int enic_enable(struct enic *enic);
 306 int enic_disable(struct enic *enic);
 307 void enic_remove(struct enic *enic);
 308 int enic_get_link_status(struct enic *enic);
 309 int enic_dev_stats_get(struct enic *enic,
 310                        struct rte_eth_stats *r_stats);
 311 void enic_dev_stats_clear(struct enic *enic);
 312 void enic_add_packet_filter(struct enic *enic);
 313 int enic_set_mac_address(struct enic *enic, uint8_t *mac_addr);
 314 int enic_del_mac_address(struct enic *enic, int mac_index);
 315 unsigned int enic_cleanup_wq(struct enic *enic, struct vnic_wq *wq);
 316 void enic_send_pkt(struct enic *enic, struct vnic_wq *wq,
 317                    struct rte_mbuf *tx_pkt, unsigned short len,
 318                    uint8_t sop, uint8_t eop, uint8_t cq_entry,
 319                    uint16_t ol_flags, uint16_t vlan_tag);
 320
 321 void enic_post_wq_index(struct vnic_wq *wq);
 322 int enic_probe(struct enic *enic);
 323 int enic_clsf_init(struct enic *enic);
 324 void enic_clsf_destroy(struct enic *enic);
 325 uint16_t enic_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 326                         uint16_t nb_pkts);
 327 uint16_t enic_noscatter_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 328                                   uint16_t nb_pkts);
 329 uint16_t enic_dummy_recv_pkts(void *rx_queue,
 330                               struct rte_mbuf **rx_pkts,
 331                               uint16_t nb_pkts);
 332 uint16_t enic_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 333                         uint16_t nb_pkts);
 334 uint16_t enic_simple_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 335                                uint16_t nb_pkts);
 336 uint16_t enic_prep_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 337                         uint16_t nb_pkts);
 338 int enic_set_mtu(struct enic *enic, uint16_t new_mtu);
 339 int enic_link_update(struct enic *enic);
 340 bool enic_use_vector_rx_handler(struct enic *enic);
 341 void enic_fdir_info(struct enic *enic);
 342 void enic_fdir_info_get(struct enic *enic, struct rte_eth_fdir_info *stats);
 343 void copy_fltr_v1(struct filter_v2 *fltr, struct rte_eth_fdir_input *input,
 344                   struct rte_eth_fdir_masks *masks);
 345 void copy_fltr_v2(struct filter_v2 *fltr, struct rte_eth_fdir_input *input,
 346                   struct rte_eth_fdir_masks *masks);
 347 extern const struct rte_flow_ops enic_flow_ops;
 348 #endif /* _ENIC_H_ */