drivers/net/enic/enic.h

   1 /*
   2  * Copyright 2008-2014 Cisco Systems, Inc.  All rights reserved.
   3  * Copyright 2007 Nuova Systems, Inc.  All rights reserved.
   4  *
   5  * Copyright (c) 2014, Cisco Systems, Inc.
   6  * All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  *
  12  * 1. Redistributions of source code must retain the above copyright
  13  * notice, this list of conditions and the following disclaimer.
  14  *
  15  * 2. Redistributions in binary form must reproduce the above copyright
  16  * notice, this list of conditions and the following disclaimer in
  17  * the documentation and/or other materials provided with the
  18  * distribution.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  21  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  23  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  24  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  25  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  26  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  27  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
  28  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  29  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  30  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  31  * POSSIBILITY OF SUCH DAMAGE.
  32  *
  33  */
  34
  35 #ifndef _ENIC_H_
  36 #define _ENIC_H_
  37
  38 #include "vnic_enet.h"
  39 #include "vnic_dev.h"
  40 #include "vnic_wq.h"
  41 #include "vnic_rq.h"
  42 #include "vnic_cq.h"
  43 #include "vnic_intr.h"
  44 #include "vnic_stats.h"
  45 #include "vnic_nic.h"
  46 #include "vnic_rss.h"
  47 #include "enic_res.h"
  48 #include "cq_enet_desc.h"
  49 #include <sys/queue.h>
  50 #include <rte_spinlock.h>
  51
  52 #define DRV_NAME                "enic_pmd"
  53 #define DRV_DESCRIPTION         "Cisco VIC Ethernet NIC Poll-mode Driver"
  54 #define DRV_COPYRIGHT           "Copyright 2008-2015 Cisco Systems, Inc"
  55
  56 #define ENIC_WQ_MAX             8
  57 /* With Rx scatter support, we use two RQs on VIC per RQ used by app. Both
  58  * RQs use the same CQ.
  59  */
  60 #define ENIC_RQ_MAX             16
  61 #define ENIC_CQ_MAX             (ENIC_WQ_MAX + (ENIC_RQ_MAX / 2))
  62 #define ENIC_INTR_MAX           (ENIC_CQ_MAX + 2)
  63
  64 #define VLAN_ETH_HLEN           18
  65
  66 #define ENICPMD_SETTING(enic, f) ((enic->config.flags & VENETF_##f) ? 1 : 0)
  67
  68 #define ENICPMD_BDF_LENGTH      13   /* 0000:00:00.0'\0' */
  69 #define ENIC_CALC_IP_CKSUM      1
  70 #define ENIC_CALC_TCP_UDP_CKSUM 2
  71 #define ENIC_MAX_MTU            9000
  72 #define ENIC_PAGE_SIZE          4096
  73 #define PAGE_ROUND_UP(x) \
  74         ((((unsigned long)(x)) + ENIC_PAGE_SIZE-1) & (~(ENIC_PAGE_SIZE-1)))
  75
  76 #define ENICPMD_VFIO_PATH          "/dev/vfio/vfio"
  77 /*#define ENIC_DESC_COUNT_MAKE_ODD (x) do{if ((~(x)) & 1) { (x)--; } }while(0)*/
  78
  79 #define PCI_DEVICE_ID_CISCO_VIC_ENET         0x0043  /* ethernet vnic */
  80 #define PCI_DEVICE_ID_CISCO_VIC_ENET_VF      0x0071  /* enet SRIOV VF */
  81
  82
  83 #define ENICPMD_FDIR_MAX           64
  84
  85 struct enic_fdir_node {
  86         struct rte_eth_fdir_filter filter;
  87         u16 fltr_id;
  88         u16 rq_index;
  89 };
  90
  91 struct enic_fdir {
  92         struct rte_eth_fdir_stats stats;
  93         struct rte_hash *hash;
  94         struct enic_fdir_node *nodes[ENICPMD_FDIR_MAX];
  95 };
  96
  97 struct enic_soft_stats {
  98         rte_atomic64_t rx_nombuf;
  99         rte_atomic64_t rx_packet_errors;
 100 };
 101
 102 struct enic_memzone_entry {
 103         const struct rte_memzone *rz;
 104         LIST_ENTRY(enic_memzone_entry) entries;
 105 };
 106
 107 /* Per-instance private data structure */
 108 struct enic {
 109         struct enic *next;
 110         struct rte_pci_device *pdev;
 111         struct vnic_enet_config config;
 112         struct vnic_dev_bar bar0;
 113         struct vnic_dev *vdev;
 114
 115         unsigned int port_id;
 116         struct rte_eth_dev *rte_dev;
 117         struct enic_fdir fdir;
 118         char bdf_name[ENICPMD_BDF_LENGTH];
 119         int dev_fd;
 120         int iommu_group_fd;
 121         int iommu_groupid;
 122         int eventfd;
 123         uint8_t mac_addr[ETH_ALEN];
 124         pthread_t err_intr_thread;
 125         int promisc;
 126         int allmulti;
 127         u8 ig_vlan_strip_en;
 128         int link_status;
 129         u8 hw_ip_checksum;
 130         u16 max_mtu;
 131
 132         unsigned int flags;
 133         unsigned int priv_flags;
 134
 135         /* work queue */
 136         struct vnic_wq wq[ENIC_WQ_MAX];
 137         unsigned int wq_count;
 138
 139         /* receive queue */
 140         struct vnic_rq rq[ENIC_RQ_MAX];
 141         unsigned int rq_count;
 142
 143         /* completion queue */
 144         struct vnic_cq cq[ENIC_CQ_MAX];
 145         unsigned int cq_count;
 146
 147         /* interrupt resource */
 148         struct vnic_intr intr;
 149         unsigned int intr_count;
 150
 151         /* software counters */
 152         struct enic_soft_stats soft_stats;
 153
 154         /* configured resources on vic */
 155         unsigned int conf_rq_count;
 156         unsigned int conf_wq_count;
 157         unsigned int conf_cq_count;
 158         unsigned int conf_intr_count;
 159
 160         /* linked list storing memory allocations */
 161         LIST_HEAD(enic_memzone_list, enic_memzone_entry) memzone_list;
 162         rte_spinlock_t memzone_list_lock;
 163
 164 };
 165
 166 /* Get the CQ index from a Start of Packet(SOP) RQ index */
 167 static inline unsigned int enic_sop_rq_idx_to_cq_idx(unsigned int sop_idx)
 168 {
 169         return sop_idx / 2;
 170 }
 171
 172 static inline unsigned int enic_sop_rq(unsigned int rq)
 173 {
 174         return rq * 2;
 175 }
 176
 177 static inline unsigned int enic_data_rq(unsigned int rq)
 178 {
 179         return rq * 2 + 1;
 180 }
 181
 182 static inline unsigned int enic_vnic_rq_count(struct enic *enic)
 183 {
 184         return enic->rq_count * 2;
 185 }
 186
 187 static inline unsigned int enic_cq_rq(__rte_unused struct enic *enic, unsigned int rq)
 188 {
 189         /* Scatter rx uses two receive queues together with one
 190          * completion queue, so the completion queue number is no
 191          * longer the same as the rq number.
 192          */
 193         return rq / 2;
 194 }
 195
 196 static inline unsigned int enic_cq_wq(struct enic *enic, unsigned int wq)
 197 {
 198         return enic->rq_count + wq;
 199 }
 200
 201 static inline unsigned int enic_msix_err_intr(__rte_unused struct enic *enic)
 202 {
 203         return 0;
 204 }
 205
 206 static inline struct enic *pmd_priv(struct rte_eth_dev *eth_dev)
 207 {
 208         return (struct enic *)eth_dev->data->dev_private;
 209 }
 210
 211 static inline uint32_t
 212 enic_ring_add(uint32_t n_descriptors, uint32_t i0, uint32_t i1)
 213 {
 214         uint32_t d = i0 + i1;
 215         d -= (d >= n_descriptors) ? n_descriptors : 0;
 216         return d;
 217 }
 218
 219 static inline uint32_t
 220 enic_ring_sub(uint32_t n_descriptors, uint32_t i0, uint32_t i1)
 221 {
 222         int32_t d = i1 - i0;
 223         return (uint32_t)((d < 0) ? ((int32_t)n_descriptors + d) : d);
 224 }
 225
 226 static inline uint32_t
 227 enic_ring_incr(uint32_t n_descriptors, uint32_t idx)
 228 {
 229         idx++;
 230         if (unlikely(idx == n_descriptors))
 231                 idx = 0;
 232         return idx;
 233 }
 234
 235 extern void enic_fdir_stats_get(struct enic *enic,
 236         struct rte_eth_fdir_stats *stats);
 237 extern int enic_fdir_add_fltr(struct enic *enic,
 238         struct rte_eth_fdir_filter *params);
 239 extern int enic_fdir_del_fltr(struct enic *enic,
 240         struct rte_eth_fdir_filter *params);
 241 extern void enic_free_wq(void *txq);
 242 extern int enic_alloc_intr_resources(struct enic *enic);
 243 extern int enic_setup_finish(struct enic *enic);
 244 extern int enic_alloc_wq(struct enic *enic, uint16_t queue_idx,
 245         unsigned int socket_id, uint16_t nb_desc);
 246 extern void enic_start_wq(struct enic *enic, uint16_t queue_idx);
 247 extern int enic_stop_wq(struct enic *enic, uint16_t queue_idx);
 248 extern void enic_start_rq(struct enic *enic, uint16_t queue_idx);
 249 extern int enic_stop_rq(struct enic *enic, uint16_t queue_idx);
 250 extern void enic_free_rq(void *rxq);
 251 extern int enic_alloc_rq(struct enic *enic, uint16_t queue_idx,
 252         unsigned int socket_id, struct rte_mempool *mp,
 253         uint16_t nb_desc, uint16_t free_thresh);
 254 extern int enic_set_rss_nic_cfg(struct enic *enic);
 255 extern int enic_set_vnic_res(struct enic *enic);
 256 extern void enic_set_hdr_split_size(struct enic *enic, u16 split_hdr_size);
 257 extern int enic_enable(struct enic *enic);
 258 extern int enic_disable(struct enic *enic);
 259 extern void enic_remove(struct enic *enic);
 260 extern int enic_get_link_status(struct enic *enic);
 261 extern void enic_dev_stats_get(struct enic *enic,
 262         struct rte_eth_stats *r_stats);
 263 extern void enic_dev_stats_clear(struct enic *enic);
 264 extern void enic_add_packet_filter(struct enic *enic);
 265 extern void enic_set_mac_address(struct enic *enic, uint8_t *mac_addr);
 266 extern void enic_del_mac_address(struct enic *enic);
 267 extern unsigned int enic_cleanup_wq(struct enic *enic, struct vnic_wq *wq);
 268 extern void enic_send_pkt(struct enic *enic, struct vnic_wq *wq,
 269                           struct rte_mbuf *tx_pkt, unsigned short len,
 270                           uint8_t sop, uint8_t eop, uint8_t cq_entry,
 271                           uint16_t ol_flags, uint16_t vlan_tag);
 272
 273 extern void enic_post_wq_index(struct vnic_wq *wq);
 274 extern int enic_probe(struct enic *enic);
 275 extern int enic_clsf_init(struct enic *enic);
 276 extern void enic_clsf_destroy(struct enic *enic);
 277 uint16_t enic_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 278                         uint16_t nb_pkts);
 279 uint16_t enic_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 280                                uint16_t nb_pkts);
 281 int enic_set_mtu(struct enic *enic, uint16_t new_mtu);
 282 #endif /* _ENIC_H_ */