drivers/net/ethernet/cisco/enic/enic.h

   1 /*
   2  * Copyright 2008-2010 Cisco Systems, Inc.  All rights reserved.
   3  * Copyright 2007 Nuova Systems, Inc.  All rights reserved.
   4  *
   5  * This program is free software; you may redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; version 2 of the License.
   8  *
   9  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  10  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  11  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  12  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  13  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  14  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  15  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  16  * SOFTWARE.
  17  *
  18  */
  19
  20 #ifndef _ENIC_H_
  21 #define _ENIC_H_
  22
  23 #include "vnic_enet.h"
  24 #include "vnic_dev.h"
  25 #include "vnic_wq.h"
  26 #include "vnic_rq.h"
  27 #include "vnic_cq.h"
  28 #include "vnic_intr.h"
  29 #include "vnic_stats.h"
  30 #include "vnic_nic.h"
  31 #include "vnic_rss.h"
  32 #include <linux/irq.h>
  33
  34 #define DRV_NAME                "enic"
  35 #define DRV_DESCRIPTION         "Cisco VIC Ethernet NIC Driver"
  36 #define DRV_VERSION             "2.3.0.42"
  37 #define DRV_COPYRIGHT           "Copyright 2008-2013 Cisco Systems, Inc"
  38
  39 #define ENIC_BARS_MAX           6
  40
  41 #define ENIC_WQ_MAX             8
  42 #define ENIC_RQ_MAX             8
  43 #define ENIC_CQ_MAX             (ENIC_WQ_MAX + ENIC_RQ_MAX)
  44 #define ENIC_INTR_MAX           (ENIC_CQ_MAX + 2)
  45
  46 #define ENIC_AIC_LARGE_PKT_DIFF 3
  47
  48 struct enic_msix_entry {
  49         int requested;
  50         char devname[IFNAMSIZ + 8];
  51         irqreturn_t (*isr)(int, void *);
  52         void *devid;
  53         cpumask_var_t affinity_mask;
  54 };
  55
  56 /* Store only the lower range.  Higher range is given by fw. */
  57 struct enic_intr_mod_range {
  58         u32 small_pkt_range_start;
  59         u32 large_pkt_range_start;
  60 };
  61
  62 struct enic_intr_mod_table {
  63         u32 rx_rate;
  64         u32 range_percent;
  65 };
  66
  67 #define ENIC_MAX_LINK_SPEEDS            3
  68 #define ENIC_LINK_SPEED_10G             10000
  69 #define ENIC_LINK_SPEED_4G              4000
  70 #define ENIC_LINK_40G_INDEX             2
  71 #define ENIC_LINK_10G_INDEX             1
  72 #define ENIC_LINK_4G_INDEX              0
  73 #define ENIC_RX_COALESCE_RANGE_END      125
  74 #define ENIC_AIC_TS_BREAK               100
  75
  76 struct enic_rx_coal {
  77         u32 small_pkt_range_start;
  78         u32 large_pkt_range_start;
  79         u32 range_end;
  80         u32 use_adaptive_rx_coalesce;
  81 };
  82
  83 /* priv_flags */
  84 #define ENIC_SRIOV_ENABLED              (1 << 0)
  85
  86 /* enic port profile set flags */
  87 #define ENIC_PORT_REQUEST_APPLIED       (1 << 0)
  88 #define ENIC_SET_REQUEST                (1 << 1)
  89 #define ENIC_SET_NAME                   (1 << 2)
  90 #define ENIC_SET_INSTANCE               (1 << 3)
  91 #define ENIC_SET_HOST                   (1 << 4)
  92
  93 struct enic_port_profile {
  94         u32 set;
  95         u8 request;
  96         char name[PORT_PROFILE_MAX];
  97         u8 instance_uuid[PORT_UUID_MAX];
  98         u8 host_uuid[PORT_UUID_MAX];
  99         u8 vf_mac[ETH_ALEN];
 100         u8 mac_addr[ETH_ALEN];
 101 };
 102
 103 /* enic_rfs_fltr_node - rfs filter node in hash table
 104  *      @@keys: IPv4 5 tuple
 105  *      @flow_id: flow_id of clsf filter provided by kernel
 106  *      @fltr_id: filter id of clsf filter returned by adaptor
 107  *      @rq_id: desired rq index
 108  *      @node: hlist_node
 109  */
 110 struct enic_rfs_fltr_node {
 111         struct flow_keys keys;
 112         u32 flow_id;
 113         u16 fltr_id;
 114         u16 rq_id;
 115         struct hlist_node node;
 116 };
 117
 118 /* enic_rfs_flw_tbl - rfs flow table
 119  *      @max: Maximum number of filters vNIC supports
 120  *      @free: Number of free filters available
 121  *      @toclean: hash table index to clean next
 122  *      @ht_head: hash table list head
 123  *      @lock: spin lock
 124  *      @rfs_may_expire: timer function for enic_rps_may_expire_flow
 125  */
 126 struct enic_rfs_flw_tbl {
 127         u16 max;
 128         int free;
 129
 130 #define ENIC_RFS_FLW_BITSHIFT   (10)
 131 #define ENIC_RFS_FLW_MASK       ((1 << ENIC_RFS_FLW_BITSHIFT) - 1)
 132         u16 toclean:ENIC_RFS_FLW_BITSHIFT;
 133         struct hlist_head ht_head[1 << ENIC_RFS_FLW_BITSHIFT];
 134         spinlock_t lock;
 135         struct timer_list rfs_may_expire;
 136 };
 137
 138 struct vxlan_offload {
 139         u16 vxlan_udp_port_number;
 140         u8 patch_level;
 141 };
 142
 143 /* Per-instance private data structure */
 144 struct enic {
 145         struct net_device *netdev;
 146         struct pci_dev *pdev;
 147         struct vnic_enet_config config;
 148         struct vnic_dev_bar bar[ENIC_BARS_MAX];
 149         struct vnic_dev *vdev;
 150         struct timer_list notify_timer;
 151         struct work_struct reset;
 152         struct work_struct tx_hang_reset;
 153         struct work_struct change_mtu_work;
 154         struct msix_entry msix_entry[ENIC_INTR_MAX];
 155         struct enic_msix_entry msix[ENIC_INTR_MAX];
 156         u32 msg_enable;
 157         spinlock_t devcmd_lock;
 158         u8 mac_addr[ETH_ALEN];
 159         unsigned int flags;
 160         unsigned int priv_flags;
 161         unsigned int mc_count;
 162         unsigned int uc_count;
 163         u32 port_mtu;
 164         struct enic_rx_coal rx_coalesce_setting;
 165         u32 rx_coalesce_usecs;
 166         u32 tx_coalesce_usecs;
 167 #ifdef CONFIG_PCI_IOV
 168         u16 num_vfs;
 169 #endif
 170         spinlock_t enic_api_lock;
 171         bool enic_api_busy;
 172         struct enic_port_profile *pp;
 173
 174         /* work queue cache line section */
 175         ____cacheline_aligned struct vnic_wq wq[ENIC_WQ_MAX];
 176         spinlock_t wq_lock[ENIC_WQ_MAX];
 177         unsigned int wq_count;
 178         u16 loop_enable;
 179         u16 loop_tag;
 180
 181         /* receive queue cache line section */
 182         ____cacheline_aligned struct vnic_rq rq[ENIC_RQ_MAX];
 183         unsigned int rq_count;
 184         struct vxlan_offload vxlan;
 185         u64 rq_truncated_pkts;
 186         u64 rq_bad_fcs;
 187         struct napi_struct napi[ENIC_RQ_MAX + ENIC_WQ_MAX];
 188
 189         /* interrupt resource cache line section */
 190         ____cacheline_aligned struct vnic_intr intr[ENIC_INTR_MAX];
 191         unsigned int intr_count;
 192         u32 __iomem *legacy_pba;                /* memory-mapped */
 193
 194         /* completion queue cache line section */
 195         ____cacheline_aligned struct vnic_cq cq[ENIC_CQ_MAX];
 196         unsigned int cq_count;
 197         struct enic_rfs_flw_tbl rfs_h;
 198         u32 rx_copybreak;
 199         u8 rss_key[ENIC_RSS_LEN];
 200         struct vnic_gen_stats gen_stats;
 201 };
 202
 203 static inline struct net_device *vnic_get_netdev(struct vnic_dev *vdev)
 204 {
 205         struct enic *enic = vdev->priv;
 206
 207         return enic->netdev;
 208 }
 209
 210 /* wrappers function for kernel log
 211  */
 212 #define vdev_err(vdev, fmt, ...)                                        \
 213         dev_err(&(vdev)->pdev->dev, fmt, ##__VA_ARGS__)
 214 #define vdev_warn(vdev, fmt, ...)                                       \
 215         dev_warn(&(vdev)->pdev->dev, fmt, ##__VA_ARGS__)
 216 #define vdev_info(vdev, fmt, ...)                                       \
 217         dev_info(&(vdev)->pdev->dev, fmt, ##__VA_ARGS__)
 218
 219 #define vdev_neterr(vdev, fmt, ...)                                     \
 220         netdev_err(vnic_get_netdev(vdev), fmt, ##__VA_ARGS__)
 221 #define vdev_netwarn(vdev, fmt, ...)                                    \
 222         netdev_warn(vnic_get_netdev(vdev), fmt, ##__VA_ARGS__)
 223 #define vdev_netinfo(vdev, fmt, ...)                                    \
 224         netdev_info(vnic_get_netdev(vdev), fmt, ##__VA_ARGS__)
 225
 226 static inline struct device *enic_get_dev(struct enic *enic)
 227 {
 228         return &(enic->pdev->dev);
 229 }
 230
 231 static inline unsigned int enic_cq_rq(struct enic *enic, unsigned int rq)
 232 {
 233         return rq;
 234 }
 235
 236 static inline unsigned int enic_cq_wq(struct enic *enic, unsigned int wq)
 237 {
 238         return enic->rq_count + wq;
 239 }
 240
 241 static inline unsigned int enic_legacy_io_intr(void)
 242 {
 243         return 0;
 244 }
 245
 246 static inline unsigned int enic_legacy_err_intr(void)
 247 {
 248         return 1;
 249 }
 250
 251 static inline unsigned int enic_legacy_notify_intr(void)
 252 {
 253         return 2;
 254 }
 255
 256 static inline unsigned int enic_msix_rq_intr(struct enic *enic,
 257         unsigned int rq)
 258 {
 259         return enic->cq[enic_cq_rq(enic, rq)].interrupt_offset;
 260 }
 261
 262 static inline unsigned int enic_msix_wq_intr(struct enic *enic,
 263         unsigned int wq)
 264 {
 265         return enic->cq[enic_cq_wq(enic, wq)].interrupt_offset;
 266 }
 267
 268 static inline unsigned int enic_msix_err_intr(struct enic *enic)
 269 {
 270         return enic->rq_count + enic->wq_count;
 271 }
 272
 273 static inline unsigned int enic_msix_notify_intr(struct enic *enic)
 274 {
 275         return enic->rq_count + enic->wq_count + 1;
 276 }
 277
 278 static inline bool enic_is_err_intr(struct enic *enic, int intr)
 279 {
 280         switch (vnic_dev_get_intr_mode(enic->vdev)) {
 281         case VNIC_DEV_INTR_MODE_INTX:
 282                 return intr == enic_legacy_err_intr();
 283         case VNIC_DEV_INTR_MODE_MSIX:
 284                 return intr == enic_msix_err_intr(enic);
 285         case VNIC_DEV_INTR_MODE_MSI:
 286         default:
 287                 return false;
 288         }
 289 }
 290
 291 static inline bool enic_is_notify_intr(struct enic *enic, int intr)
 292 {
 293         switch (vnic_dev_get_intr_mode(enic->vdev)) {
 294         case VNIC_DEV_INTR_MODE_INTX:
 295                 return intr == enic_legacy_notify_intr();
 296         case VNIC_DEV_INTR_MODE_MSIX:
 297                 return intr == enic_msix_notify_intr(enic);
 298         case VNIC_DEV_INTR_MODE_MSI:
 299         default:
 300                 return false;
 301         }
 302 }
 303
 304 static inline int enic_dma_map_check(struct enic *enic, dma_addr_t dma_addr)
 305 {
 306         if (unlikely(pci_dma_mapping_error(enic->pdev, dma_addr))) {
 307                 net_warn_ratelimited("%s: PCI dma mapping failed!\n",
 308                                      enic->netdev->name);
 309                 enic->gen_stats.dma_map_error++;
 310
 311                 return -ENOMEM;
 312         }
 313
 314         return 0;
 315 }
 316
 317 void enic_reset_addr_lists(struct enic *enic);
 318 int enic_sriov_enabled(struct enic *enic);
 319 int enic_is_valid_vf(struct enic *enic, int vf);
 320 int enic_is_dynamic(struct enic *enic);
 321 void enic_set_ethtool_ops(struct net_device *netdev);
 322 int __enic_set_rsskey(struct enic *enic);
 323
 324 #endif /* _ENIC_H_ */