drivers/net/benet/be.h

   1 /*
   2  * Copyright (C) 2005 - 2010 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 #include <linux/firmware.h>
  32 #include <linux/slab.h>
  33
  34 #include "be_hw.h"
  35
  36 #define DRV_VER                 "2.103.175u"
  37 #define DRV_NAME                "be2net"
  38 #define BE_NAME                 "ServerEngines BladeEngine2 10Gbps NIC"
  39 #define BE3_NAME                "ServerEngines BladeEngine3 10Gbps NIC"
  40 #define OC_NAME                 "Emulex OneConnect 10Gbps NIC"
  41 #define OC_NAME1                "Emulex OneConnect 10Gbps NIC (be3)"
  42 #define DRV_DESC                "ServerEngines BladeEngine 10Gbps NIC Driver"
  43
  44 #define BE_VENDOR_ID            0x19a2
  45 #define BE_DEVICE_ID1           0x211
  46 #define BE_DEVICE_ID2           0x221
  47 #define OC_DEVICE_ID1           0x700
  48 #define OC_DEVICE_ID2           0x710
  49
  50 static inline char *nic_name(struct pci_dev *pdev)
  51 {
  52         switch (pdev->device) {
  53         case OC_DEVICE_ID1:
  54                 return OC_NAME;
  55         case OC_DEVICE_ID2:
  56                 return OC_NAME1;
  57         case BE_DEVICE_ID2:
  58                 return BE3_NAME;
  59         default:
  60                 return BE_NAME;
  61         }
  62 }
  63
  64 /* Number of bytes of an RX frame that are copied to skb->data */
  65 #define BE_HDR_LEN              64
  66 #define BE_MAX_JUMBO_FRAME_SIZE 9018
  67 #define BE_MIN_MTU              256
  68
  69 #define BE_NUM_VLANS_SUPPORTED  64
  70 #define BE_MAX_EQD              96
  71 #define BE_MAX_TX_FRAG_COUNT    30
  72
  73 #define EVNT_Q_LEN              1024
  74 #define TX_Q_LEN                2048
  75 #define TX_CQ_LEN               1024
  76 #define RX_Q_LEN                1024    /* Does not support any other value */
  77 #define RX_CQ_LEN               1024
  78 #define MCC_Q_LEN               128     /* total size not to exceed 8 pages */
  79 #define MCC_CQ_LEN              256
  80
  81 #define MAX_RSS_QS              4       /* BE limit is 4 queues/port */
  82 #define BE_MAX_MSIX_VECTORS     (MAX_RSS_QS + 1 + 1)/* RSS qs + 1 def Rx + Tx */
  83 #define BE_NAPI_WEIGHT          64
  84 #define MAX_RX_POST             BE_NAPI_WEIGHT /* Frags posted at a time */
  85 #define RX_FRAGS_REFILL_WM      (RX_Q_LEN - MAX_RX_POST)
  86
  87 #define FW_VER_LEN              32
  88
  89 #define BE_MAX_VF               32
  90
  91 struct be_dma_mem {
  92         void *va;
  93         dma_addr_t dma;
  94         u32 size;
  95 };
  96
  97 struct be_queue_info {
  98         struct be_dma_mem dma_mem;
  99         u16 len;
 100         u16 entry_size; /* Size of an element in the queue */
 101         u16 id;
 102         u16 tail, head;
 103         bool created;
 104         atomic_t used;  /* Number of valid elements in the queue */
 105 };
 106
 107 static inline u32 MODULO(u16 val, u16 limit)
 108 {
 109         BUG_ON(limit & (limit - 1));
 110         return val & (limit - 1);
 111 }
 112
 113 static inline void index_adv(u16 *index, u16 val, u16 limit)
 114 {
 115         *index = MODULO((*index + val), limit);
 116 }
 117
 118 static inline void index_inc(u16 *index, u16 limit)
 119 {
 120         *index = MODULO((*index + 1), limit);
 121 }
 122
 123 static inline void *queue_head_node(struct be_queue_info *q)
 124 {
 125         return q->dma_mem.va + q->head * q->entry_size;
 126 }
 127
 128 static inline void *queue_tail_node(struct be_queue_info *q)
 129 {
 130         return q->dma_mem.va + q->tail * q->entry_size;
 131 }
 132
 133 static inline void queue_head_inc(struct be_queue_info *q)
 134 {
 135         index_inc(&q->head, q->len);
 136 }
 137
 138 static inline void queue_tail_inc(struct be_queue_info *q)
 139 {
 140         index_inc(&q->tail, q->len);
 141 }
 142
 143 struct be_eq_obj {
 144         struct be_queue_info q;
 145         char desc[32];
 146
 147         /* Adaptive interrupt coalescing (AIC) info */
 148         bool enable_aic;
 149         u16 min_eqd;            /* in usecs */
 150         u16 max_eqd;            /* in usecs */
 151         u16 cur_eqd;            /* in usecs */
 152
 153         struct napi_struct napi;
 154 };
 155
 156 struct be_mcc_obj {
 157         struct be_queue_info q;
 158         struct be_queue_info cq;
 159         bool rearm_cq;
 160 };
 161
 162 struct be_tx_stats {
 163         u32 be_tx_reqs;         /* number of TX requests initiated */
 164         u32 be_tx_stops;        /* number of times TX Q was stopped */
 165         u32 be_tx_wrbs;         /* number of tx WRBs used */
 166         u32 be_tx_events;       /* number of tx completion events  */
 167         u32 be_tx_compl;        /* number of tx completion entries processed */
 168         ulong be_tx_jiffies;
 169         u64 be_tx_bytes;
 170         u64 be_tx_bytes_prev;
 171         u64 be_tx_pkts;
 172         u32 be_tx_rate;
 173 };
 174
 175 struct be_tx_obj {
 176         struct be_queue_info q;
 177         struct be_queue_info cq;
 178         /* Remember the skbs that were transmitted */
 179         struct sk_buff *sent_skb_list[TX_Q_LEN];
 180 };
 181
 182 /* Struct to remember the pages posted for rx frags */
 183 struct be_rx_page_info {
 184         struct page *page;
 185         DEFINE_DMA_UNMAP_ADDR(bus);
 186         u16 page_offset;
 187         bool last_page_user;
 188 };
 189
 190 struct be_rx_stats {
 191         u32 rx_post_fail;/* number of ethrx buffer alloc failures */
 192         u32 rx_polls;   /* number of times NAPI called poll function */
 193         u32 rx_events;  /* number of ucast rx completion events  */
 194         u32 rx_compl;   /* number of rx completion entries processed */
 195         ulong rx_jiffies;
 196         u64 rx_bytes;
 197         u64 rx_bytes_prev;
 198         u64 rx_pkts;
 199         u32 rx_rate;
 200         u32 rx_mcast_pkts;
 201         u32 rxcp_err;   /* Num rx completion entries w/ err set. */
 202         ulong rx_fps_jiffies;   /* jiffies at last FPS calc */
 203         u32 rx_frags;
 204         u32 prev_rx_frags;
 205         u32 rx_fps;             /* Rx frags per second */
 206 };
 207
 208 struct be_rx_obj {
 209         struct be_adapter *adapter;
 210         struct be_queue_info q;
 211         struct be_queue_info cq;
 212         struct be_rx_page_info page_info_tbl[RX_Q_LEN];
 213         struct be_eq_obj rx_eq;
 214         struct be_rx_stats stats;
 215         u8 rss_id;
 216         bool rx_post_starved;   /* Zero rx frags have been posted to BE */
 217         u32 cache_line_barrier[16];
 218 };
 219
 220 struct be_vf_cfg {
 221         unsigned char vf_mac_addr[ETH_ALEN];
 222         u32 vf_if_handle;
 223         u32 vf_pmac_id;
 224         u16 vf_vlan_tag;
 225         u32 vf_tx_rate;
 226 };
 227
 228 #define BE_INVALID_PMAC_ID              0xffffffff
 229 struct be_adapter {
 230         struct pci_dev *pdev;
 231         struct net_device *netdev;
 232
 233         u8 __iomem *csr;
 234         u8 __iomem *db;         /* Door Bell */
 235         u8 __iomem *pcicfg;     /* PCI config space */
 236
 237         spinlock_t mbox_lock;   /* For serializing mbox cmds to BE card */
 238         struct be_dma_mem mbox_mem;
 239         /* Mbox mem is adjusted to align to 16 bytes. The allocated addr
 240          * is stored for freeing purpose */
 241         struct be_dma_mem mbox_mem_alloced;
 242
 243         struct be_mcc_obj mcc_obj;
 244         spinlock_t mcc_lock;    /* For serializing mcc cmds to BE card */
 245         spinlock_t mcc_cq_lock;
 246
 247         struct msix_entry msix_entries[BE_MAX_MSIX_VECTORS];
 248         bool msix_enabled;
 249         bool isr_registered;
 250
 251         /* TX Rings */
 252         struct be_eq_obj tx_eq;
 253         struct be_tx_obj tx_obj;
 254         struct be_tx_stats tx_stats;
 255
 256         u32 cache_line_break[8];
 257
 258         /* Rx rings */
 259         struct be_rx_obj rx_obj[MAX_RSS_QS + 1]; /* one default non-rss Q */
 260         u32 num_rx_qs;
 261         u32 big_page_size;      /* Compounded page size shared by rx wrbs */
 262
 263         struct vlan_group *vlan_grp;
 264         u16 vlans_added;
 265         u16 max_vlans;  /* Number of vlans supported */
 266         u8 vlan_tag[VLAN_GROUP_ARRAY_LEN];
 267         struct be_dma_mem mc_cmd_mem;
 268
 269         struct be_dma_mem stats_cmd;
 270         /* Work queue used to perform periodic tasks like getting statistics */
 271         struct delayed_work work;
 272
 273         /* Ethtool knobs and info */
 274         bool rx_csum;           /* BE card must perform rx-checksumming */
 275         char fw_ver[FW_VER_LEN];
 276         u32 if_handle;          /* Used to configure filtering */
 277         u32 pmac_id;            /* MAC addr handle used by BE card */
 278
 279         bool eeh_err;
 280         bool link_up;
 281         u32 port_num;
 282         bool promiscuous;
 283         bool wol;
 284         u32 function_mode;
 285         u32 function_caps;
 286         u32 rx_fc;              /* Rx flow control */
 287         u32 tx_fc;              /* Tx flow control */
 288         bool ue_detected;
 289         bool stats_ioctl_sent;
 290         int link_speed;
 291         u8 port_type;
 292         u8 transceiver;
 293         u8 autoneg;
 294         u8 generation;          /* BladeEngine ASIC generation */
 295         u32 flash_status;
 296         struct completion flash_compl;
 297
 298         bool sriov_enabled;
 299         struct be_vf_cfg vf_cfg[BE_MAX_VF];
 300         u8 base_eq_id;
 301         u8 is_virtfn;
 302 };
 303
 304 #define be_physfn(adapter) (!adapter->is_virtfn)
 305
 306 /* BladeEngine Generation numbers */
 307 #define BE_GEN2 2
 308 #define BE_GEN3 3
 309
 310 extern const struct ethtool_ops be_ethtool_ops;
 311
 312 #define tx_stats(adapter)               (&adapter->tx_stats)
 313 #define rx_stats(rxo)                   (&rxo->stats)
 314
 315 #define BE_SET_NETDEV_OPS(netdev, ops)  (netdev->netdev_ops = ops)
 316
 317 #define for_all_rx_queues(adapter, rxo, i)                              \
 318         for (i = 0, rxo = &adapter->rx_obj[i]; i < adapter->num_rx_qs;  \
 319                 i++, rxo++)
 320
 321 /* Just skip the first default non-rss queue */
 322 #define for_all_rss_queues(adapter, rxo, i)                             \
 323         for (i = 0, rxo = &adapter->rx_obj[i+1]; i < (adapter->num_rx_qs - 1);\
 324                 i++, rxo++)
 325
 326 #define PAGE_SHIFT_4K           12
 327 #define PAGE_SIZE_4K            (1 << PAGE_SHIFT_4K)
 328
 329 /* Returns number of pages spanned by the data starting at the given addr */
 330 #define PAGES_4K_SPANNED(_address, size)                                \
 331                 ((u32)((((size_t)(_address) & (PAGE_SIZE_4K - 1)) +     \
 332                         (size) + (PAGE_SIZE_4K - 1)) >> PAGE_SHIFT_4K))
 333
 334 /* Byte offset into the page corresponding to given address */
 335 #define OFFSET_IN_PAGE(addr)                                            \
 336                  ((size_t)(addr) & (PAGE_SIZE_4K-1))
 337
 338 /* Returns bit offset within a DWORD of a bitfield */
 339 #define AMAP_BIT_OFFSET(_struct, field)                                 \
 340                 (((size_t)&(((_struct *)0)->field))%32)
 341
 342 /* Returns the bit mask of the field that is NOT shifted into location. */
 343 static inline u32 amap_mask(u32 bitsize)
 344 {
 345         return (bitsize == 32 ? 0xFFFFFFFF : (1 << bitsize) - 1);
 346 }
 347
 348 static inline void
 349 amap_set(void *ptr, u32 dw_offset, u32 mask, u32 offset, u32 value)
 350 {
 351         u32 *dw = (u32 *) ptr + dw_offset;
 352         *dw &= ~(mask << offset);
 353         *dw |= (mask & value) << offset;
 354 }
 355
 356 #define AMAP_SET_BITS(_struct, field, ptr, val)                         \
 357                 amap_set(ptr,                                           \
 358                         offsetof(_struct, field)/32,                    \
 359                         amap_mask(sizeof(((_struct *)0)->field)),       \
 360                         AMAP_BIT_OFFSET(_struct, field),                \
 361                         val)
 362
 363 static inline u32 amap_get(void *ptr, u32 dw_offset, u32 mask, u32 offset)
 364 {
 365         u32 *dw = (u32 *) ptr;
 366         return mask & (*(dw + dw_offset) >> offset);
 367 }
 368
 369 #define AMAP_GET_BITS(_struct, field, ptr)                              \
 370                 amap_get(ptr,                                           \
 371                         offsetof(_struct, field)/32,                    \
 372                         amap_mask(sizeof(((_struct *)0)->field)),       \
 373                         AMAP_BIT_OFFSET(_struct, field))
 374
 375 #define be_dws_cpu_to_le(wrb, len)      swap_dws(wrb, len)
 376 #define be_dws_le_to_cpu(wrb, len)      swap_dws(wrb, len)
 377 static inline void swap_dws(void *wrb, int len)
 378 {
 379 #ifdef __BIG_ENDIAN
 380         u32 *dw = wrb;
 381         BUG_ON(len % 4);
 382         do {
 383                 *dw = cpu_to_le32(*dw);
 384                 dw++;
 385                 len -= 4;
 386         } while (len);
 387 #endif                          /* __BIG_ENDIAN */
 388 }
 389
 390 static inline u8 is_tcp_pkt(struct sk_buff *skb)
 391 {
 392         u8 val = 0;
 393
 394         if (ip_hdr(skb)->version == 4)
 395                 val = (ip_hdr(skb)->protocol == IPPROTO_TCP);
 396         else if (ip_hdr(skb)->version == 6)
 397                 val = (ipv6_hdr(skb)->nexthdr == NEXTHDR_TCP);
 398
 399         return val;
 400 }
 401
 402 static inline u8 is_udp_pkt(struct sk_buff *skb)
 403 {
 404         u8 val = 0;
 405
 406         if (ip_hdr(skb)->version == 4)
 407                 val = (ip_hdr(skb)->protocol == IPPROTO_UDP);
 408         else if (ip_hdr(skb)->version == 6)
 409                 val = (ipv6_hdr(skb)->nexthdr == NEXTHDR_UDP);
 410
 411         return val;
 412 }
 413
 414 static inline void be_check_sriov_fn_type(struct be_adapter *adapter)
 415 {
 416         u8 data;
 417
 418         pci_write_config_byte(adapter->pdev, 0xFE, 0xAA);
 419         pci_read_config_byte(adapter->pdev, 0xFE, &data);
 420         adapter->is_virtfn = (data != 0xAA);
 421 }
 422
 423 static inline void be_vf_eth_addr_generate(struct be_adapter *adapter, u8 *mac)
 424 {
 425         u32 addr;
 426
 427         addr = jhash(adapter->netdev->dev_addr, ETH_ALEN, 0);
 428
 429         mac[5] = (u8)(addr & 0xFF);
 430         mac[4] = (u8)((addr >> 8) & 0xFF);
 431         mac[3] = (u8)((addr >> 16) & 0xFF);
 432         mac[2] = 0xC9;
 433         mac[1] = 0x00;
 434         mac[0] = 0x00;
 435 }
 436
 437 extern void be_cq_notify(struct be_adapter *adapter, u16 qid, bool arm,
 438                 u16 num_popped);
 439 extern void be_link_status_update(struct be_adapter *adapter, bool link_up);
 440 extern void netdev_stats_update(struct be_adapter *adapter);
 441 extern int be_load_fw(struct be_adapter *adapter, u8 *func);
 442 #endif                          /* BE_H */