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