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
 151 /* Get the CQ index from a Start of Packet(SOP) RQ index */
 152 static inline unsigned int enic_sop_rq_idx_to_cq_idx(unsigned int sop_idx)
 153 {
 154         return sop_idx / 2;
 155 }
 156
 157 /* Get the RTE RQ index from a Start of Packet(SOP) RQ index */
 158 static inline unsigned int enic_sop_rq_idx_to_rte_idx(unsigned int sop_idx)
 159 {
 160         return sop_idx / 2;
 161 }
 162
 163 /* Get the Start of Packet(SOP) RQ index from a RTE RQ index */
 164 static inline unsigned int enic_rte_rq_idx_to_sop_idx(unsigned int rte_idx)
 165 {
 166         return rte_idx * 2;
 167 }
 168
 169 /* Get the Data RQ index from a RTE RQ index */
 170 static inline unsigned int enic_rte_rq_idx_to_data_idx(unsigned int rte_idx)
 171 {
 172         return rte_idx * 2 + 1;
 173 }
 174
 175 static inline unsigned int enic_vnic_rq_count(struct enic *enic)
 176 {
 177         return enic->rq_count * 2;
 178 }
 179
 180 static inline unsigned int enic_cq_rq(__rte_unused struct enic *enic, unsigned int rq)
 181 {
 182         /* Scatter rx uses two receive queues together with one
 183          * completion queue, so the completion queue number is no
 184          * longer the same as the rq number.
 185          */
 186         return rq / 2;
 187 }
 188
 189 static inline unsigned int enic_cq_wq(struct enic *enic, unsigned int wq)
 190 {
 191         return enic->rq_count + wq;
 192 }
 193
 194 static inline struct enic *pmd_priv(struct rte_eth_dev *eth_dev)
 195 {
 196         return (struct enic *)eth_dev->data->dev_private;
 197 }
 198
 199 static inline uint32_t
 200 enic_ring_add(uint32_t n_descriptors, uint32_t i0, uint32_t i1)
 201 {
 202         uint32_t d = i0 + i1;
 203         d -= (d >= n_descriptors) ? n_descriptors : 0;
 204         return d;
 205 }
 206
 207 static inline uint32_t
 208 enic_ring_sub(uint32_t n_descriptors, uint32_t i0, uint32_t i1)
 209 {
 210         int32_t d = i1 - i0;
 211         return (uint32_t)((d < 0) ? ((int32_t)n_descriptors + d) : d);
 212 }
 213
 214 static inline uint32_t
 215 enic_ring_incr(uint32_t n_descriptors, uint32_t idx)
 216 {
 217         idx++;
 218         if (unlikely(idx == n_descriptors))
 219                 idx = 0;
 220         return idx;
 221 }
 222
 223 extern void enic_fdir_stats_get(struct enic *enic,
 224         struct rte_eth_fdir_stats *stats);
 225 extern int enic_fdir_add_fltr(struct enic *enic,
 226         struct rte_eth_fdir_filter *params);
 227 extern int enic_fdir_del_fltr(struct enic *enic,
 228         struct rte_eth_fdir_filter *params);
 229 extern void enic_free_wq(void *txq);
 230 extern int enic_alloc_intr_resources(struct enic *enic);
 231 extern int enic_setup_finish(struct enic *enic);
 232 extern int enic_alloc_wq(struct enic *enic, uint16_t queue_idx,
 233         unsigned int socket_id, uint16_t nb_desc);
 234 extern void enic_start_wq(struct enic *enic, uint16_t queue_idx);
 235 extern int enic_stop_wq(struct enic *enic, uint16_t queue_idx);
 236 extern void enic_start_rq(struct enic *enic, uint16_t queue_idx);
 237 extern int enic_stop_rq(struct enic *enic, uint16_t queue_idx);
 238 extern void enic_free_rq(void *rxq);
 239 extern int enic_alloc_rq(struct enic *enic, uint16_t queue_idx,
 240         unsigned int socket_id, struct rte_mempool *mp,
 241         uint16_t nb_desc, uint16_t free_thresh);
 242 extern int enic_set_rss_nic_cfg(struct enic *enic);
 243 extern int enic_set_vnic_res(struct enic *enic);
 244 extern int enic_enable(struct enic *enic);
 245 extern int enic_disable(struct enic *enic);
 246 extern void enic_remove(struct enic *enic);
 247 extern int enic_get_link_status(struct enic *enic);
 248 extern int enic_dev_stats_get(struct enic *enic,
 249         struct rte_eth_stats *r_stats);
 250 extern void enic_dev_stats_clear(struct enic *enic);
 251 extern void enic_add_packet_filter(struct enic *enic);
 252 int enic_set_mac_address(struct enic *enic, uint8_t *mac_addr);
 253 void enic_del_mac_address(struct enic *enic, int mac_index);
 254 extern unsigned int enic_cleanup_wq(struct enic *enic, struct vnic_wq *wq);
 255 extern void enic_send_pkt(struct enic *enic, struct vnic_wq *wq,
 256                           struct rte_mbuf *tx_pkt, unsigned short len,
 257                           uint8_t sop, uint8_t eop, uint8_t cq_entry,
 258                           uint16_t ol_flags, uint16_t vlan_tag);
 259
 260 extern void enic_post_wq_index(struct vnic_wq *wq);
 261 extern int enic_probe(struct enic *enic);
 262 extern int enic_clsf_init(struct enic *enic);
 263 extern void enic_clsf_destroy(struct enic *enic);
 264 uint16_t enic_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 265                         uint16_t nb_pkts);
 266 uint16_t enic_dummy_recv_pkts(void *rx_queue,
 267                               struct rte_mbuf **rx_pkts,
 268                               uint16_t nb_pkts);
 269 uint16_t enic_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 270                                uint16_t nb_pkts);
 271 uint16_t enic_prep_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 272                         uint16_t nb_pkts);
 273 int enic_set_mtu(struct enic *enic, uint16_t new_mtu);
 274 int enic_link_update(struct enic *enic);
 275 void enic_fdir_info(struct enic *enic);
 276 void enic_fdir_info_get(struct enic *enic, struct rte_eth_fdir_info *stats);
 277 void copy_fltr_v1(struct filter_v2 *fltr, struct rte_eth_fdir_input *input,
 278                   struct rte_eth_fdir_masks *masks);
 279 void copy_fltr_v2(struct filter_v2 *fltr, struct rte_eth_fdir_input *input,
 280                   struct rte_eth_fdir_masks *masks);
 281 extern const struct rte_flow_ops enic_flow_ops;
 282 #endif /* _ENIC_H_ */