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