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
  50 #define DRV_NAME                "enic_pmd"
  51 #define DRV_DESCRIPTION         "Cisco VIC Ethernet NIC Poll-mode Driver"
  52 #define DRV_VERSION             "1.0.0.6"
  53 #define DRV_COPYRIGHT           "Copyright 2008-2015 Cisco Systems, Inc"
  54
  55 #define ENIC_WQ_MAX             8
  56 /* With Rx scatter support, we use two RQs on VIC per RQ used by app. Both
  57  * RQs use the same CQ.
  58  */
  59 #define ENIC_RQ_MAX             16
  60 #define ENIC_CQ_MAX             (ENIC_WQ_MAX + (ENIC_RQ_MAX / 2))
  61 #define ENIC_INTR_MAX           (ENIC_CQ_MAX + 2)
  62
  63 #define VLAN_ETH_HLEN           18
  64
  65 #define ENICPMD_SETTING(enic, f) ((enic->config.flags & VENETF_##f) ? 1 : 0)
  66
  67 #define ENICPMD_BDF_LENGTH      13   /* 0000:00:00.0'\0' */
  68 #define ENIC_CALC_IP_CKSUM      1
  69 #define ENIC_CALC_TCP_UDP_CKSUM 2
  70 #define ENIC_MAX_MTU            9000
  71 #define ENIC_PAGE_SIZE          4096
  72 #define PAGE_ROUND_UP(x) \
  73         ((((unsigned long)(x)) + ENIC_PAGE_SIZE-1) & (~(ENIC_PAGE_SIZE-1)))
  74
  75 #define ENICPMD_VFIO_PATH          "/dev/vfio/vfio"
  76 /*#define ENIC_DESC_COUNT_MAKE_ODD (x) do{if ((~(x)) & 1) { (x)--; } }while(0)*/
  77
  78 #define PCI_DEVICE_ID_CISCO_VIC_ENET         0x0043  /* ethernet vnic */
  79 #define PCI_DEVICE_ID_CISCO_VIC_ENET_VF      0x0071  /* enet SRIOV VF */
  80
  81
  82 #define ENICPMD_FDIR_MAX           64
  83
  84 struct enic_fdir_node {
  85         struct rte_eth_fdir_filter filter;
  86         u16 fltr_id;
  87         u16 rq_index;
  88 };
  89
  90 struct enic_fdir {
  91         struct rte_eth_fdir_stats stats;
  92         struct rte_hash *hash;
  93         struct enic_fdir_node *nodes[ENICPMD_FDIR_MAX];
  94 };
  95
  96 struct enic_soft_stats {
  97         rte_atomic64_t rx_nombuf;
  98         rte_atomic64_t rx_packet_errors;
  99 };
 100
 101 /* Per-instance private data structure */
 102 struct enic {
 103         struct enic *next;
 104         struct rte_pci_device *pdev;
 105         struct vnic_enet_config config;
 106         struct vnic_dev_bar bar0;
 107         struct vnic_dev *vdev;
 108
 109         unsigned int port_id;
 110         struct rte_eth_dev *rte_dev;
 111         struct enic_fdir fdir;
 112         char bdf_name[ENICPMD_BDF_LENGTH];
 113         int dev_fd;
 114         int iommu_group_fd;
 115         int iommu_groupid;
 116         int eventfd;
 117         uint8_t mac_addr[ETH_ALEN];
 118         pthread_t err_intr_thread;
 119         int promisc;
 120         int allmulti;
 121         u8 ig_vlan_strip_en;
 122         int link_status;
 123         u8 hw_ip_checksum;
 124
 125         unsigned int flags;
 126         unsigned int priv_flags;
 127
 128         /* work queue */
 129         struct vnic_wq wq[ENIC_WQ_MAX];
 130         unsigned int wq_count;
 131
 132         /* receive queue */
 133         struct vnic_rq rq[ENIC_RQ_MAX];
 134         unsigned int rq_count;
 135
 136         /* completion queue */
 137         struct vnic_cq cq[ENIC_CQ_MAX];
 138         unsigned int cq_count;
 139
 140         /* interrupt resource */
 141         struct vnic_intr intr;
 142         unsigned int intr_count;
 143
 144         /* software counters */
 145         struct enic_soft_stats soft_stats;
 146 };
 147
 148 static inline unsigned int enic_sop_rq(unsigned int rq)
 149 {
 150         return rq * 2;
 151 }
 152
 153 static inline unsigned int enic_data_rq(unsigned int rq)
 154 {
 155         return rq * 2 + 1;
 156 }
 157
 158 static inline unsigned int enic_vnic_rq_count(struct enic *enic)
 159 {
 160         return enic->rq_count * 2;
 161 }
 162
 163 static inline unsigned int enic_cq_rq(__rte_unused struct enic *enic, unsigned int rq)
 164 {
 165         return rq;
 166 }
 167
 168 static inline unsigned int enic_cq_wq(struct enic *enic, unsigned int wq)
 169 {
 170         return enic->rq_count + wq;
 171 }
 172
 173 static inline unsigned int enic_msix_err_intr(__rte_unused struct enic *enic)
 174 {
 175         return 0;
 176 }
 177
 178 static inline struct enic *pmd_priv(struct rte_eth_dev *eth_dev)
 179 {
 180         return (struct enic *)eth_dev->data->dev_private;
 181 }
 182
 183 static inline uint32_t
 184 enic_ring_add(uint32_t n_descriptors, uint32_t i0, uint32_t i1)
 185 {
 186         uint32_t d = i0 + i1;
 187         d -= (d >= n_descriptors) ? n_descriptors : 0;
 188         return d;
 189 }
 190
 191 static inline uint32_t
 192 enic_ring_sub(uint32_t n_descriptors, uint32_t i0, uint32_t i1)
 193 {
 194         int32_t d = i1 - i0;
 195         return (uint32_t)((d < 0) ? ((int32_t)n_descriptors + d) : d);
 196 }
 197
 198 static inline uint32_t
 199 enic_ring_incr(uint32_t n_descriptors, uint32_t idx)
 200 {
 201         idx++;
 202         if (unlikely(idx == n_descriptors))
 203                 idx = 0;
 204         return idx;
 205 }
 206
 207 #if RTE_LOG_LEVEL >= RTE_LOG_DEBUG
 208 #define ENIC_ASSERT(cond)                               \
 209         do {                                                            \
 210                 if (unlikely(!(cond))) {                                \
 211                         rte_panic("line %d\tassert \"" #cond "\""       \
 212                                         "failed\n", __LINE__);          \
 213                 }                                                       \
 214         } while (0)
 215 #else
 216 #define ENIC_ASSERT(cond) do {} while (0)
 217 #endif
 218
 219 extern void enic_fdir_stats_get(struct enic *enic,
 220         struct rte_eth_fdir_stats *stats);
 221 extern int enic_fdir_add_fltr(struct enic *enic,
 222         struct rte_eth_fdir_filter *params);
 223 extern int enic_fdir_del_fltr(struct enic *enic,
 224         struct rte_eth_fdir_filter *params);
 225 extern void enic_free_wq(void *txq);
 226 extern int enic_alloc_intr_resources(struct enic *enic);
 227 extern int enic_setup_finish(struct enic *enic);
 228 extern int enic_alloc_wq(struct enic *enic, uint16_t queue_idx,
 229         unsigned int socket_id, uint16_t nb_desc);
 230 extern void enic_start_wq(struct enic *enic, uint16_t queue_idx);
 231 extern int enic_stop_wq(struct enic *enic, uint16_t queue_idx);
 232 extern void enic_start_rq(struct enic *enic, uint16_t queue_idx);
 233 extern int enic_stop_rq(struct enic *enic, uint16_t queue_idx);
 234 extern void enic_free_rq(void *rxq);
 235 extern int enic_alloc_rq(struct enic *enic, uint16_t queue_idx,
 236         unsigned int socket_id, struct rte_mempool *mp,
 237         uint16_t nb_desc);
 238 extern int enic_set_rss_nic_cfg(struct enic *enic);
 239 extern int enic_set_vnic_res(struct enic *enic);
 240 extern void enic_set_hdr_split_size(struct enic *enic, u16 split_hdr_size);
 241 extern int enic_enable(struct enic *enic);
 242 extern int enic_disable(struct enic *enic);
 243 extern void enic_remove(struct enic *enic);
 244 extern int enic_get_link_status(struct enic *enic);
 245 extern void enic_dev_stats_get(struct enic *enic,
 246         struct rte_eth_stats *r_stats);
 247 extern void enic_dev_stats_clear(struct enic *enic);
 248 extern void enic_add_packet_filter(struct enic *enic);
 249 extern void enic_set_mac_address(struct enic *enic, uint8_t *mac_addr);
 250 extern void enic_del_mac_address(struct enic *enic);
 251 extern unsigned int enic_cleanup_wq(struct enic *enic, struct vnic_wq *wq);
 252 extern void enic_send_pkt(struct enic *enic, struct vnic_wq *wq,
 253                           struct rte_mbuf *tx_pkt, unsigned short len,
 254                           uint8_t sop, uint8_t eop, uint8_t cq_entry,
 255                           uint16_t ol_flags, uint16_t vlan_tag);
 256
 257 extern void enic_post_wq_index(struct vnic_wq *wq);
 258 extern int enic_probe(struct enic *enic);
 259 extern int enic_clsf_init(struct enic *enic);
 260 extern void enic_clsf_destroy(struct enic *enic);
 261 uint16_t enic_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 262                         uint16_t nb_pkts);
 263 uint16_t enic_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 264                                uint16_t nb_pkts);
 265 #endif /* _ENIC_H_ */