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