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
  49 #define DRV_NAME                "enic_pmd"
  50 #define DRV_DESCRIPTION         "Cisco VIC Ethernet NIC Poll-mode Driver"
  51 #define DRV_VERSION             "1.0.0.5"
  52 #define DRV_COPYRIGHT           "Copyright 2008-2015 Cisco Systems, Inc"
  53
  54 #define ENIC_WQ_MAX             8
  55 #define ENIC_RQ_MAX             8
  56 #define ENIC_CQ_MAX             (ENIC_WQ_MAX + ENIC_RQ_MAX)
  57 #define ENIC_INTR_MAX           (ENIC_CQ_MAX + 2)
  58
  59 #define VLAN_ETH_HLEN           18
  60
  61 #define ENICPMD_SETTING(enic, f) ((enic->config.flags & VENETF_##f) ? 1 : 0)
  62
  63 #define ENICPMD_BDF_LENGTH      13   /* 0000:00:00.0'\0' */
  64 #define PKT_TX_TCP_UDP_CKSUM    0x6000
  65 #define ENIC_CALC_IP_CKSUM      1
  66 #define ENIC_CALC_TCP_UDP_CKSUM 2
  67 #define ENIC_MAX_MTU            9000
  68 #define ENIC_PAGE_SIZE          4096
  69 #define PAGE_ROUND_UP(x) \
  70         ((((unsigned long)(x)) + ENIC_PAGE_SIZE-1) & (~(ENIC_PAGE_SIZE-1)))
  71
  72 #define ENICPMD_VFIO_PATH          "/dev/vfio/vfio"
  73 /*#define ENIC_DESC_COUNT_MAKE_ODD (x) do{if ((~(x)) & 1) { (x)--; } }while(0)*/
  74
  75 #define PCI_DEVICE_ID_CISCO_VIC_ENET         0x0043  /* ethernet vnic */
  76 #define PCI_DEVICE_ID_CISCO_VIC_ENET_VF      0x0071  /* enet SRIOV VF */
  77
  78
  79 #define ENICPMD_FDIR_MAX           64
  80
  81 struct enic_fdir_node {
  82         struct rte_eth_fdir_filter filter;
  83         u16 fltr_id;
  84         u16 rq_index;
  85 };
  86
  87 struct enic_fdir {
  88         struct rte_eth_fdir_stats stats;
  89         struct rte_hash *hash;
  90         struct enic_fdir_node *nodes[ENICPMD_FDIR_MAX];
  91 };
  92
  93 /* Per-instance private data structure */
  94 struct enic {
  95         struct enic *next;
  96         struct rte_pci_device *pdev;
  97         struct vnic_enet_config config;
  98         struct vnic_dev_bar bar0;
  99         struct vnic_dev *vdev;
 100
 101         unsigned int port_id;
 102         struct rte_eth_dev *rte_dev;
 103         struct enic_fdir fdir;
 104         char bdf_name[ENICPMD_BDF_LENGTH];
 105         int dev_fd;
 106         int iommu_group_fd;
 107         int iommu_groupid;
 108         int eventfd;
 109         uint8_t mac_addr[ETH_ALEN];
 110         pthread_t err_intr_thread;
 111         int promisc;
 112         int allmulti;
 113         u8 ig_vlan_strip_en;
 114         int link_status;
 115         u8 hw_ip_checksum;
 116
 117         unsigned int flags;
 118         unsigned int priv_flags;
 119
 120         /* work queue */
 121         struct vnic_wq wq[ENIC_WQ_MAX];
 122         unsigned int wq_count;
 123
 124         /* receive queue */
 125         struct vnic_rq rq[ENIC_RQ_MAX];
 126         unsigned int rq_count;
 127
 128         /* completion queue */
 129         struct vnic_cq cq[ENIC_CQ_MAX];
 130         unsigned int cq_count;
 131
 132         /* interrupt resource */
 133         struct vnic_intr intr;
 134         unsigned int intr_count;
 135 };
 136
 137 static inline unsigned int enic_cq_rq(__rte_unused struct enic *enic, unsigned int rq)
 138 {
 139         return rq;
 140 }
 141
 142 static inline unsigned int enic_cq_wq(struct enic *enic, unsigned int wq)
 143 {
 144         return enic->rq_count + wq;
 145 }
 146
 147 static inline unsigned int enic_msix_err_intr(__rte_unused struct enic *enic)
 148 {
 149         return 0;
 150 }
 151
 152 static inline struct enic *pmd_priv(struct rte_eth_dev *eth_dev)
 153 {
 154         return (struct enic *)eth_dev->data->dev_private;
 155 }
 156
 157 extern void enic_fdir_stats_get(struct enic *enic,
 158         struct rte_eth_fdir_stats *stats);
 159 extern int enic_fdir_add_fltr(struct enic *enic,
 160         struct rte_eth_fdir_filter *params);
 161 extern int enic_fdir_del_fltr(struct enic *enic,
 162         struct rte_eth_fdir_filter *params);
 163 extern void enic_free_wq(void *txq);
 164 extern int enic_alloc_intr_resources(struct enic *enic);
 165 extern int enic_setup_finish(struct enic *enic);
 166 extern int enic_alloc_wq(struct enic *enic, uint16_t queue_idx,
 167         unsigned int socket_id, uint16_t nb_desc);
 168 extern void enic_start_wq(struct enic *enic, uint16_t queue_idx);
 169 extern int enic_stop_wq(struct enic *enic, uint16_t queue_idx);
 170 extern void enic_start_rq(struct enic *enic, uint16_t queue_idx);
 171 extern int enic_stop_rq(struct enic *enic, uint16_t queue_idx);
 172 extern void enic_free_rq(void *rxq);
 173 extern int enic_alloc_rq(struct enic *enic, uint16_t queue_idx,
 174         unsigned int socket_id, struct rte_mempool *mp,
 175         uint16_t nb_desc);
 176 extern int enic_set_rss_nic_cfg(struct enic *enic);
 177 extern int enic_set_vnic_res(struct enic *enic);
 178 extern void enic_set_hdr_split_size(struct enic *enic, u16 split_hdr_size);
 179 extern int enic_enable(struct enic *enic);
 180 extern int enic_disable(struct enic *enic);
 181 extern void enic_remove(struct enic *enic);
 182 extern int enic_get_link_status(struct enic *enic);
 183 extern void enic_dev_stats_get(struct enic *enic,
 184         struct rte_eth_stats *r_stats);
 185 extern void enic_dev_stats_clear(struct enic *enic);
 186 extern void enic_add_packet_filter(struct enic *enic);
 187 extern void enic_set_mac_address(struct enic *enic, uint8_t *mac_addr);
 188 extern void enic_del_mac_address(struct enic *enic);
 189 extern unsigned int enic_cleanup_wq(struct enic *enic, struct vnic_wq *wq);
 190 extern int enic_send_pkt(struct enic *enic, struct vnic_wq *wq,
 191         struct rte_mbuf *tx_pkt, unsigned short len,
 192         uint8_t sop, uint8_t eop,
 193         uint16_t ol_flags, uint16_t vlan_tag);
 194 extern int enic_poll(struct vnic_rq *rq, struct rte_mbuf **rx_pkts,
 195         unsigned int budget, unsigned int *work_done);
 196 extern int enic_probe(struct enic *enic);
 197 extern int enic_clsf_init(struct enic *enic);
 198 extern void enic_clsf_destroy(struct enic *enic);
 199 #endif /* _ENIC_H_ */