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