drivers/net/benet/be.h

   1 /*
   2  * Copyright (C) 2005 - 2009 ServerEngines
   3  * All rights reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public License version 2
   7  * as published by the Free Software Foundation.  The full GNU General
   8  * Public License is included in this distribution in the file called COPYING.
   9  *
  10  * Contact Information:
  11  * linux-drivers@serverengines.com
  12  *
  13  * ServerEngines
  14  * 209 N. Fair Oaks Ave
  15  * Sunnyvale, CA 94085
  16  */
  17
  18 #ifndef BE_H
  19 #define BE_H
  20
  21 #include <linux/pci.h>
  22 #include <linux/etherdevice.h>
  23 #include <linux/version.h>
  24 #include <linux/delay.h>
  25 #include <net/tcp.h>
  26 #include <net/ip.h>
  27 #include <net/ipv6.h>
  28 #include <linux/if_vlan.h>
  29 #include <linux/workqueue.h>
  30 #include <linux/interrupt.h>
  31
  32 #include "be_hw.h"
  33
  34 #define DRV_VER                 "2.0.400"
  35 #define DRV_NAME                "be2net"
  36 #define BE_NAME                 "ServerEngines BladeEngine2 10Gbps NIC"
  37 #define OC_NAME                 "Emulex OneConnect 10Gbps NIC"
  38 #define DRV_DESC                BE_NAME "Driver"
  39
  40 #define BE_VENDOR_ID            0x19a2
  41 #define BE_DEVICE_ID1           0x211
  42 #define OC_DEVICE_ID1           0x700
  43 #define OC_DEVICE_ID2           0x701
  44
  45 static inline char *nic_name(struct pci_dev *pdev)
  46 {
  47         if (pdev->device == OC_DEVICE_ID1 || pdev->device == OC_DEVICE_ID2)
  48                 return OC_NAME;
  49         else
  50                 return BE_NAME;
  51 }
  52
  53 /* Number of bytes of an RX frame that are copied to skb->data */
  54 #define BE_HDR_LEN              64
  55 #define BE_MAX_JUMBO_FRAME_SIZE 9018
  56 #define BE_MIN_MTU              256
  57
  58 #define BE_NUM_VLANS_SUPPORTED  64
  59 #define BE_MAX_EQD              96
  60 #define BE_MAX_TX_FRAG_COUNT    30
  61
  62 #define EVNT_Q_LEN              1024
  63 #define TX_Q_LEN                2048
  64 #define TX_CQ_LEN               1024
  65 #define RX_Q_LEN                1024    /* Does not support any other value */
  66 #define RX_CQ_LEN               1024
  67 #define MCC_Q_LEN               128     /* total size not to exceed 8 pages */
  68 #define MCC_CQ_LEN              256
  69
  70 #define BE_NAPI_WEIGHT          64
  71 #define MAX_RX_POST             BE_NAPI_WEIGHT /* Frags posted at a time */
  72 #define RX_FRAGS_REFILL_WM      (RX_Q_LEN - MAX_RX_POST)
  73
  74 #define FW_VER_LEN              32
  75
  76 struct be_dma_mem {
  77         void *va;
  78         dma_addr_t dma;
  79         u32 size;
  80 };
  81
  82 struct be_queue_info {
  83         struct be_dma_mem dma_mem;
  84         u16 len;
  85         u16 entry_size; /* Size of an element in the queue */
  86         u16 id;
  87         u16 tail, head;
  88         bool created;
  89         atomic_t used;  /* Number of valid elements in the queue */
  90 };
  91
  92 static inline u32 MODULO(u16 val, u16 limit)
  93 {
  94         BUG_ON(limit & (limit - 1));
  95         return val & (limit - 1);
  96 }
  97
  98 static inline void index_adv(u16 *index, u16 val, u16 limit)
  99 {
 100         *index = MODULO((*index + val), limit);
 101 }
 102
 103 static inline void index_inc(u16 *index, u16 limit)
 104 {
 105         *index = MODULO((*index + 1), limit);
 106 }
 107
 108 static inline void *queue_head_node(struct be_queue_info *q)
 109 {
 110         return q->dma_mem.va + q->head * q->entry_size;
 111 }
 112
 113 static inline void *queue_tail_node(struct be_queue_info *q)
 114 {
 115         return q->dma_mem.va + q->tail * q->entry_size;
 116 }
 117
 118 static inline void queue_head_inc(struct be_queue_info *q)
 119 {
 120         index_inc(&q->head, q->len);
 121 }
 122
 123 static inline void queue_tail_inc(struct be_queue_info *q)
 124 {
 125         index_inc(&q->tail, q->len);
 126 }
 127
 128 struct be_eq_obj {
 129         struct be_queue_info q;
 130         char desc[32];
 131
 132         /* Adaptive interrupt coalescing (AIC) info */
 133         bool enable_aic;
 134         u16 min_eqd;            /* in usecs */
 135         u16 max_eqd;            /* in usecs */
 136         u16 cur_eqd;            /* in usecs */
 137
 138         struct napi_struct napi;
 139 };
 140
 141 struct be_mcc_obj {
 142         struct be_queue_info q;
 143         struct be_queue_info cq;
 144 };
 145
 146 struct be_drvr_stats {
 147         u32 be_tx_reqs;         /* number of TX requests initiated */
 148         u32 be_tx_stops;        /* number of times TX Q was stopped */
 149         u32 be_fwd_reqs;        /* number of send reqs through forwarding i/f */
 150         u32 be_tx_wrbs;         /* number of tx WRBs used */
 151         u32 be_tx_events;       /* number of tx completion events  */
 152         u32 be_tx_compl;        /* number of tx completion entries processed */
 153         ulong be_tx_jiffies;
 154         u64 be_tx_bytes;
 155         u64 be_tx_bytes_prev;
 156         u32 be_tx_rate;
 157
 158         u32 cache_barrier[16];
 159
 160         u32 be_ethrx_post_fail;/* number of ethrx buffer alloc failures */
 161         u32 be_polls;           /* number of times NAPI called poll function */
 162         u32 be_rx_events;       /* number of ucast rx completion events  */
 163         u32 be_rx_compl;        /* number of rx completion entries processed */
 164         ulong be_rx_jiffies;
 165         u64 be_rx_bytes;
 166         u64 be_rx_bytes_prev;
 167         u32 be_rx_rate;
 168         /* number of non ether type II frames dropped where
 169          * frame len > length field of Mac Hdr */
 170         u32 be_802_3_dropped_frames;
 171         /* number of non ether type II frames malformed where
 172          * in frame len < length field of Mac Hdr */
 173         u32 be_802_3_malformed_frames;
 174         u32 be_rxcp_err;        /* Num rx completion entries w/ err set. */
 175         ulong rx_fps_jiffies;   /* jiffies at last FPS calc */
 176         u32 be_rx_frags;
 177         u32 be_prev_rx_frags;
 178         u32 be_rx_fps;          /* Rx frags per second */
 179 };
 180
 181 struct be_stats_obj {
 182         struct be_drvr_stats drvr_stats;
 183         struct net_device_stats net_stats;
 184         struct be_dma_mem cmd;
 185 };
 186
 187 struct be_tx_obj {
 188         struct be_queue_info q;
 189         struct be_queue_info cq;
 190         /* Remember the skbs that were transmitted */
 191         struct sk_buff *sent_skb_list[TX_Q_LEN];
 192 };
 193
 194 /* Struct to remember the pages posted for rx frags */
 195 struct be_rx_page_info {
 196         struct page *page;
 197         dma_addr_t bus;
 198         u16 page_offset;
 199         bool last_page_user;
 200 };
 201
 202 struct be_rx_obj {
 203         struct be_queue_info q;
 204         struct be_queue_info cq;
 205         struct be_rx_page_info page_info_tbl[RX_Q_LEN];
 206 };
 207
 208 #define BE_NUM_MSIX_VECTORS             2       /* 1 each for Tx and Rx */
 209 struct be_adapter {
 210         struct pci_dev *pdev;
 211         struct net_device *netdev;
 212
 213         u8 __iomem *csr;
 214         u8 __iomem *db;         /* Door Bell */
 215         u8 __iomem *pcicfg;     /* PCI config space */
 216
 217         spinlock_t mbox_lock;   /* For serializing mbox cmds to BE card */
 218         struct be_dma_mem mbox_mem;
 219         /* Mbox mem is adjusted to align to 16 bytes. The allocated addr
 220          * is stored for freeing purpose */
 221         struct be_dma_mem mbox_mem_alloced;
 222
 223         struct be_mcc_obj mcc_obj;
 224         spinlock_t mcc_lock;    /* For serializing mcc cmds to BE card */
 225         spinlock_t mcc_cq_lock;
 226
 227         struct msix_entry msix_entries[BE_NUM_MSIX_VECTORS];
 228         bool msix_enabled;
 229         bool isr_registered;
 230
 231         /* TX Rings */
 232         struct be_eq_obj tx_eq;
 233         struct be_tx_obj tx_obj;
 234
 235         u32 cache_line_break[8];
 236
 237         /* Rx rings */
 238         struct be_eq_obj rx_eq;
 239         struct be_rx_obj rx_obj;
 240         u32 big_page_size;      /* Compounded page size shared by rx wrbs */
 241         bool rx_post_starved;   /* Zero rx frags have been posted to BE */
 242
 243         struct vlan_group *vlan_grp;
 244         u16 num_vlans;
 245         u8 vlan_tag[VLAN_GROUP_ARRAY_LEN];
 246
 247         struct be_stats_obj stats;
 248         /* Work queue used to perform periodic tasks like getting statistics */
 249         struct delayed_work work;
 250
 251         /* Ethtool knobs and info */
 252         bool rx_csum;           /* BE card must perform rx-checksumming */
 253         char fw_ver[FW_VER_LEN];
 254         u32 if_handle;          /* Used to configure filtering */
 255         u32 pmac_id;            /* MAC addr handle used by BE card */
 256
 257         bool link_up;
 258         u32 port_num;
 259         bool promiscuous;
 260 };
 261
 262 extern const struct ethtool_ops be_ethtool_ops;
 263
 264 #define drvr_stats(adapter)             (&adapter->stats.drvr_stats)
 265
 266 static inline unsigned int be_pci_func(struct be_adapter *adapter)
 267 {
 268         return PCI_FUNC(adapter->pdev->devfn);
 269 }
 270
 271 #define BE_SET_NETDEV_OPS(netdev, ops)  (netdev->netdev_ops = ops)
 272
 273 #define PAGE_SHIFT_4K           12
 274 #define PAGE_SIZE_4K            (1 << PAGE_SHIFT_4K)
 275
 276 /* Returns number of pages spanned by the data starting at the given addr */
 277 #define PAGES_4K_SPANNED(_address, size)                                \
 278                 ((u32)((((size_t)(_address) & (PAGE_SIZE_4K - 1)) +     \
 279                         (size) + (PAGE_SIZE_4K - 1)) >> PAGE_SHIFT_4K))
 280
 281 /* Byte offset into the page corresponding to given address */
 282 #define OFFSET_IN_PAGE(addr)                                            \
 283                  ((size_t)(addr) & (PAGE_SIZE_4K-1))
 284
 285 /* Returns bit offset within a DWORD of a bitfield */
 286 #define AMAP_BIT_OFFSET(_struct, field)                                 \
 287                 (((size_t)&(((_struct *)0)->field))%32)
 288
 289 /* Returns the bit mask of the field that is NOT shifted into location. */
 290 static inline u32 amap_mask(u32 bitsize)
 291 {
 292         return (bitsize == 32 ? 0xFFFFFFFF : (1 << bitsize) - 1);
 293 }
 294
 295 static inline void
 296 amap_set(void *ptr, u32 dw_offset, u32 mask, u32 offset, u32 value)
 297 {
 298         u32 *dw = (u32 *) ptr + dw_offset;
 299         *dw &= ~(mask << offset);
 300         *dw |= (mask & value) << offset;
 301 }
 302
 303 #define AMAP_SET_BITS(_struct, field, ptr, val)                         \
 304                 amap_set(ptr,                                           \
 305                         offsetof(_struct, field)/32,                    \
 306                         amap_mask(sizeof(((_struct *)0)->field)),       \
 307                         AMAP_BIT_OFFSET(_struct, field),                \
 308                         val)
 309
 310 static inline u32 amap_get(void *ptr, u32 dw_offset, u32 mask, u32 offset)
 311 {
 312         u32 *dw = (u32 *) ptr;
 313         return mask & (*(dw + dw_offset) >> offset);
 314 }
 315
 316 #define AMAP_GET_BITS(_struct, field, ptr)                              \
 317                 amap_get(ptr,                                           \
 318                         offsetof(_struct, field)/32,                    \
 319                         amap_mask(sizeof(((_struct *)0)->field)),       \
 320                         AMAP_BIT_OFFSET(_struct, field))
 321
 322 #define be_dws_cpu_to_le(wrb, len)      swap_dws(wrb, len)
 323 #define be_dws_le_to_cpu(wrb, len)      swap_dws(wrb, len)
 324 static inline void swap_dws(void *wrb, int len)
 325 {
 326 #ifdef __BIG_ENDIAN
 327         u32 *dw = wrb;
 328         BUG_ON(len % 4);
 329         do {
 330                 *dw = cpu_to_le32(*dw);
 331                 dw++;
 332                 len -= 4;
 333         } while (len);
 334 #endif                          /* __BIG_ENDIAN */
 335 }
 336
 337 static inline u8 is_tcp_pkt(struct sk_buff *skb)
 338 {
 339         u8 val = 0;
 340
 341         if (ip_hdr(skb)->version == 4)
 342                 val = (ip_hdr(skb)->protocol == IPPROTO_TCP);
 343         else if (ip_hdr(skb)->version == 6)
 344                 val = (ipv6_hdr(skb)->nexthdr == NEXTHDR_TCP);
 345
 346         return val;
 347 }
 348
 349 static inline u8 is_udp_pkt(struct sk_buff *skb)
 350 {
 351         u8 val = 0;
 352
 353         if (ip_hdr(skb)->version == 4)
 354                 val = (ip_hdr(skb)->protocol == IPPROTO_UDP);
 355         else if (ip_hdr(skb)->version == 6)
 356                 val = (ipv6_hdr(skb)->nexthdr == NEXTHDR_UDP);
 357
 358         return val;
 359 }
 360
 361 extern void be_cq_notify(struct be_adapter *adapter, u16 qid, bool arm,
 362                 u16 num_popped);
 363 extern void be_link_status_update(struct be_adapter *adapter, bool link_up);
 364 #endif                          /* BE_H */