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