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 VLAN_ETH_HLEN           18
  57
  58 #define ENICPMD_SETTING(enic, f) ((enic->config.flags & VENETF_##f) ? 1 : 0)
  59
  60 #define ENICPMD_BDF_LENGTH      13   /* 0000:00:00.0'\0' */
  61 #define ENIC_CALC_IP_CKSUM      1
  62 #define ENIC_CALC_TCP_UDP_CKSUM 2
  63 #define ENIC_MAX_MTU            9000
  64 #define ENIC_PAGE_SIZE          4096
  65 #define PAGE_ROUND_UP(x) \
  66         ((((unsigned long)(x)) + ENIC_PAGE_SIZE-1) & (~(ENIC_PAGE_SIZE-1)))
  67
  68 #define ENICPMD_VFIO_PATH          "/dev/vfio/vfio"
  69 /*#define ENIC_DESC_COUNT_MAKE_ODD (x) do{if ((~(x)) & 1) { (x)--; } }while(0)*/
  70
  71 #define PCI_DEVICE_ID_CISCO_VIC_ENET         0x0043  /* ethernet vnic */
  72 #define PCI_DEVICE_ID_CISCO_VIC_ENET_VF      0x0071  /* enet SRIOV VF */
  73
  74
  75 #define ENICPMD_FDIR_MAX           64
  76
  77 struct enic_fdir_node {
  78         struct rte_eth_fdir_filter filter;
  79         u16 fltr_id;
  80         u16 rq_index;
  81 };
  82
  83 struct enic_fdir {
  84         struct rte_eth_fdir_stats stats;
  85         struct rte_hash *hash;
  86         struct enic_fdir_node *nodes[ENICPMD_FDIR_MAX];
  87         u32 modes;
  88         u32 types_mask;
  89         void (*copy_fltr_fn)(struct filter_v2 *filt,
  90                              struct rte_eth_fdir_input *input,
  91                              struct rte_eth_fdir_masks *masks);
  92 };
  93
  94 struct enic_soft_stats {
  95         rte_atomic64_t rx_nombuf;
  96         rte_atomic64_t rx_packet_errors;
  97         rte_atomic64_t tx_oversized;
  98 };
  99
 100 struct enic_memzone_entry {
 101         const struct rte_memzone *rz;
 102         LIST_ENTRY(enic_memzone_entry) entries;
 103 };
 104
 105 /* Per-instance private data structure */
 106 struct enic {
 107         struct enic *next;
 108         struct rte_pci_device *pdev;
 109         struct vnic_enet_config config;
 110         struct vnic_dev_bar bar0;
 111         struct vnic_dev *vdev;
 112
 113         unsigned int port_id;
 114         struct rte_eth_dev *rte_dev;
 115         struct enic_fdir fdir;
 116         char bdf_name[ENICPMD_BDF_LENGTH];
 117         int dev_fd;
 118         int iommu_group_fd;
 119         int iommu_groupid;
 120         int eventfd;
 121         uint8_t mac_addr[ETH_ALEN];
 122         pthread_t err_intr_thread;
 123         int promisc;
 124         int allmulti;
 125         u8 ig_vlan_strip_en;
 126         int link_status;
 127         u8 hw_ip_checksum;
 128         u16 max_mtu;
 129         u16 adv_filters;
 130         uint8_t ig_vlan_rewrite_mode; /* devargs ig-vlan-rewrite */
 131
 132         unsigned int flags;
 133         unsigned int priv_flags;
 134
 135         /* work queue (len = conf_wq_count) */
 136         struct vnic_wq *wq;
 137         unsigned int wq_count; /* equals eth_dev nb_tx_queues */
 138
 139         /* receive queue (len = conf_rq_count) */
 140         struct vnic_rq *rq;
 141         unsigned int rq_count; /* equals eth_dev nb_rx_queues */
 142
 143         /* completion queue (len = conf_cq_count) */
 144         struct vnic_cq *cq;
 145         unsigned int cq_count; /* equals rq_count + wq_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         rte_spinlock_t mtu_lock;
 164
 165 };
 166
 167 /* Get the CQ index from a Start of Packet(SOP) RQ index */
 168 static inline unsigned int enic_sop_rq_idx_to_cq_idx(unsigned int sop_idx)
 169 {
 170         return sop_idx / 2;
 171 }
 172
 173 /* Get the RTE RQ index from a Start of Packet(SOP) RQ index */
 174 static inline unsigned int enic_sop_rq_idx_to_rte_idx(unsigned int sop_idx)
 175 {
 176         return sop_idx / 2;
 177 }
 178
 179 /* Get the Start of Packet(SOP) RQ index from a RTE RQ index */
 180 static inline unsigned int enic_rte_rq_idx_to_sop_idx(unsigned int rte_idx)
 181 {
 182         return rte_idx * 2;
 183 }
 184
 185 /* Get the Data RQ index from a RTE RQ index */
 186 static inline unsigned int enic_rte_rq_idx_to_data_idx(unsigned int rte_idx)
 187 {
 188         return rte_idx * 2 + 1;
 189 }
 190
 191 static inline unsigned int enic_vnic_rq_count(struct enic *enic)
 192 {
 193         return enic->rq_count * 2;
 194 }
 195
 196 static inline unsigned int enic_cq_rq(__rte_unused struct enic *enic, unsigned int rq)
 197 {
 198         /* Scatter rx uses two receive queues together with one
 199          * completion queue, so the completion queue number is no
 200          * longer the same as the rq number.
 201          */
 202         return rq / 2;
 203 }
 204
 205 static inline unsigned int enic_cq_wq(struct enic *enic, unsigned int wq)
 206 {
 207         return enic->rq_count + wq;
 208 }
 209
 210 static inline unsigned int enic_msix_err_intr(__rte_unused struct enic *enic)
 211 {
 212         return 0;
 213 }
 214
 215 static inline struct enic *pmd_priv(struct rte_eth_dev *eth_dev)
 216 {
 217         return (struct enic *)eth_dev->data->dev_private;
 218 }
 219
 220 static inline uint32_t
 221 enic_ring_add(uint32_t n_descriptors, uint32_t i0, uint32_t i1)
 222 {
 223         uint32_t d = i0 + i1;
 224         d -= (d >= n_descriptors) ? n_descriptors : 0;
 225         return d;
 226 }
 227
 228 static inline uint32_t
 229 enic_ring_sub(uint32_t n_descriptors, uint32_t i0, uint32_t i1)
 230 {
 231         int32_t d = i1 - i0;
 232         return (uint32_t)((d < 0) ? ((int32_t)n_descriptors + d) : d);
 233 }
 234
 235 static inline uint32_t
 236 enic_ring_incr(uint32_t n_descriptors, uint32_t idx)
 237 {
 238         idx++;
 239         if (unlikely(idx == n_descriptors))
 240                 idx = 0;
 241         return idx;
 242 }
 243
 244 extern void enic_fdir_stats_get(struct enic *enic,
 245         struct rte_eth_fdir_stats *stats);
 246 extern int enic_fdir_add_fltr(struct enic *enic,
 247         struct rte_eth_fdir_filter *params);
 248 extern int enic_fdir_del_fltr(struct enic *enic,
 249         struct rte_eth_fdir_filter *params);
 250 extern void enic_free_wq(void *txq);
 251 extern int enic_alloc_intr_resources(struct enic *enic);
 252 extern int enic_setup_finish(struct enic *enic);
 253 extern int enic_alloc_wq(struct enic *enic, uint16_t queue_idx,
 254         unsigned int socket_id, uint16_t nb_desc);
 255 extern void enic_start_wq(struct enic *enic, uint16_t queue_idx);
 256 extern int enic_stop_wq(struct enic *enic, uint16_t queue_idx);
 257 extern void enic_start_rq(struct enic *enic, uint16_t queue_idx);
 258 extern int enic_stop_rq(struct enic *enic, uint16_t queue_idx);
 259 extern void enic_free_rq(void *rxq);
 260 extern int enic_alloc_rq(struct enic *enic, uint16_t queue_idx,
 261         unsigned int socket_id, struct rte_mempool *mp,
 262         uint16_t nb_desc, uint16_t free_thresh);
 263 extern int enic_set_rss_nic_cfg(struct enic *enic);
 264 extern int enic_set_vnic_res(struct enic *enic);
 265 extern void enic_set_hdr_split_size(struct enic *enic, u16 split_hdr_size);
 266 extern int enic_enable(struct enic *enic);
 267 extern int enic_disable(struct enic *enic);
 268 extern void enic_remove(struct enic *enic);
 269 extern int enic_get_link_status(struct enic *enic);
 270 extern void enic_dev_stats_get(struct enic *enic,
 271         struct rte_eth_stats *r_stats);
 272 extern void enic_dev_stats_clear(struct enic *enic);
 273 extern void enic_add_packet_filter(struct enic *enic);
 274 extern void enic_set_mac_address(struct enic *enic, uint8_t *mac_addr);
 275 extern void enic_del_mac_address(struct enic *enic);
 276 extern unsigned int enic_cleanup_wq(struct enic *enic, struct vnic_wq *wq);
 277 extern void enic_send_pkt(struct enic *enic, struct vnic_wq *wq,
 278                           struct rte_mbuf *tx_pkt, unsigned short len,
 279                           uint8_t sop, uint8_t eop, uint8_t cq_entry,
 280                           uint16_t ol_flags, uint16_t vlan_tag);
 281
 282 extern void enic_post_wq_index(struct vnic_wq *wq);
 283 extern int enic_probe(struct enic *enic);
 284 extern int enic_clsf_init(struct enic *enic);
 285 extern void enic_clsf_destroy(struct enic *enic);
 286 uint16_t enic_recv_pkts(void *rx_queue, struct rte_mbuf **rx_pkts,
 287                         uint16_t nb_pkts);
 288 uint16_t enic_dummy_recv_pkts(__rte_unused void *rx_queue,
 289                               __rte_unused struct rte_mbuf **rx_pkts,
 290                               __rte_unused uint16_t nb_pkts);
 291 uint16_t enic_xmit_pkts(void *tx_queue, struct rte_mbuf **tx_pkts,
 292                                uint16_t nb_pkts);
 293 int enic_set_mtu(struct enic *enic, uint16_t new_mtu);
 294 int enic_link_update(struct enic *enic);
 295 void enic_fdir_info(struct enic *enic);
 296 void enic_fdir_info_get(struct enic *enic, struct rte_eth_fdir_info *stats);
 297 void copy_fltr_v1(struct filter_v2 *fltr, struct rte_eth_fdir_input *input,
 298                   __rte_unused struct rte_eth_fdir_masks *masks);
 299 void copy_fltr_v2(struct filter_v2 *fltr, struct rte_eth_fdir_input *input,
 300                   struct rte_eth_fdir_masks *masks);
 301 #endif /* _ENIC_H_ */