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