drivers/net/ethernet/emulex/benet/be.h

   1 /*
   2  * Copyright (C) 2005 - 2011 Emulex
   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@emulex.com
  12  *
  13  * Emulex
  14  * 3333 Susan Street
  15  * Costa Mesa, CA 92626
  16  */
  17
  18 #ifndef BE_H
  19 #define BE_H
  20
  21 #include <linux/pci.h>
  22 #include <linux/etherdevice.h>
  23 #include <linux/delay.h>
  24 #include <net/tcp.h>
  25 #include <net/ip.h>
  26 #include <net/ipv6.h>
  27 #include <linux/if_vlan.h>
  28 #include <linux/workqueue.h>
  29 #include <linux/interrupt.h>
  30 #include <linux/firmware.h>
  31 #include <linux/slab.h>
  32 #include <linux/u64_stats_sync.h>
  33
  34 #include "be_hw.h"
  35
  36 #define DRV_VER                 "4.0.100u"
  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_NAME_BE              OC_NAME "(be3)"
  42 #define OC_NAME_LANCER          OC_NAME "(Lancer)"
  43 #define DRV_DESC                "ServerEngines BladeEngine 10Gbps NIC Driver"
  44
  45 #define BE_VENDOR_ID            0x19a2
  46 #define EMULEX_VENDOR_ID        0x10df
  47 #define BE_DEVICE_ID1           0x211
  48 #define BE_DEVICE_ID2           0x221
  49 #define OC_DEVICE_ID1           0x700   /* Device Id for BE2 cards */
  50 #define OC_DEVICE_ID2           0x710   /* Device Id for BE3 cards */
  51 #define OC_DEVICE_ID3           0xe220  /* Device id for Lancer cards */
  52 #define OC_DEVICE_ID4           0xe228   /* Device id for VF in Lancer */
  53
  54 static inline char *nic_name(struct pci_dev *pdev)
  55 {
  56         switch (pdev->device) {
  57         case OC_DEVICE_ID1:
  58                 return OC_NAME;
  59         case OC_DEVICE_ID2:
  60                 return OC_NAME_BE;
  61         case OC_DEVICE_ID3:
  62         case OC_DEVICE_ID4:
  63                 return OC_NAME_LANCER;
  64         case BE_DEVICE_ID2:
  65                 return BE3_NAME;
  66         default:
  67                 return BE_NAME;
  68         }
  69 }
  70
  71 /* Number of bytes of an RX frame that are copied to skb->data */
  72 #define BE_HDR_LEN              ((u16) 64)
  73 #define BE_MAX_JUMBO_FRAME_SIZE 9018
  74 #define BE_MIN_MTU              256
  75
  76 #define BE_NUM_VLANS_SUPPORTED  64
  77 #define BE_MAX_EQD              96
  78 #define BE_MAX_TX_FRAG_COUNT    30
  79
  80 #define EVNT_Q_LEN              1024
  81 #define TX_Q_LEN                2048
  82 #define TX_CQ_LEN               1024
  83 #define RX_Q_LEN                1024    /* Does not support any other value */
  84 #define RX_CQ_LEN               1024
  85 #define MCC_Q_LEN               128     /* total size not to exceed 8 pages */
  86 #define MCC_CQ_LEN              256
  87
  88 #define MAX_RSS_QS              4       /* BE limit is 4 queues/port */
  89 #define MAX_RX_QS               (MAX_RSS_QS + 1) /* RSS qs + 1 def Rx */
  90 #define MAX_TX_QS               8
  91 #define BE_MAX_MSIX_VECTORS     (MAX_RX_QS + 1)/* RX + TX */
  92 #define BE_NAPI_WEIGHT          64
  93 #define MAX_RX_POST             BE_NAPI_WEIGHT /* Frags posted at a time */
  94 #define RX_FRAGS_REFILL_WM      (RX_Q_LEN - MAX_RX_POST)
  95
  96 #define FW_VER_LEN              32
  97
  98 struct be_dma_mem {
  99         void *va;
 100         dma_addr_t dma;
 101         u32 size;
 102 };
 103
 104 struct be_queue_info {
 105         struct be_dma_mem dma_mem;
 106         u16 len;
 107         u16 entry_size; /* Size of an element in the queue */
 108         u16 id;
 109         u16 tail, head;
 110         bool created;
 111         atomic_t used;  /* Number of valid elements in the queue */
 112 };
 113
 114 static inline u32 MODULO(u16 val, u16 limit)
 115 {
 116         BUG_ON(limit & (limit - 1));
 117         return val & (limit - 1);
 118 }
 119
 120 static inline void index_adv(u16 *index, u16 val, u16 limit)
 121 {
 122         *index = MODULO((*index + val), limit);
 123 }
 124
 125 static inline void index_inc(u16 *index, u16 limit)
 126 {
 127         *index = MODULO((*index + 1), limit);
 128 }
 129
 130 static inline void *queue_head_node(struct be_queue_info *q)
 131 {
 132         return q->dma_mem.va + q->head * q->entry_size;
 133 }
 134
 135 static inline void *queue_tail_node(struct be_queue_info *q)
 136 {
 137         return q->dma_mem.va + q->tail * q->entry_size;
 138 }
 139
 140 static inline void queue_head_inc(struct be_queue_info *q)
 141 {
 142         index_inc(&q->head, q->len);
 143 }
 144
 145 static inline void queue_tail_inc(struct be_queue_info *q)
 146 {
 147         index_inc(&q->tail, q->len);
 148 }
 149
 150 struct be_eq_obj {
 151         struct be_queue_info q;
 152         char desc[32];
 153
 154         /* Adaptive interrupt coalescing (AIC) info */
 155         bool enable_aic;
 156         u16 min_eqd;            /* in usecs */
 157         u16 max_eqd;            /* in usecs */
 158         u16 cur_eqd;            /* in usecs */
 159         u8  eq_idx;
 160
 161         struct napi_struct napi;
 162 };
 163
 164 struct be_mcc_obj {
 165         struct be_queue_info q;
 166         struct be_queue_info cq;
 167         bool rearm_cq;
 168 };
 169
 170 struct be_tx_stats {
 171         u64 tx_bytes;
 172         u64 tx_pkts;
 173         u64 tx_reqs;
 174         u64 tx_wrbs;
 175         u64 tx_compl;
 176         ulong tx_jiffies;
 177         u32 tx_stops;
 178         struct u64_stats_sync sync;
 179         struct u64_stats_sync sync_compl;
 180 };
 181
 182 struct be_tx_obj {
 183         struct be_queue_info q;
 184         struct be_queue_info cq;
 185         /* Remember the skbs that were transmitted */
 186         struct sk_buff *sent_skb_list[TX_Q_LEN];
 187         struct be_tx_stats stats;
 188 };
 189
 190 /* Struct to remember the pages posted for rx frags */
 191 struct be_rx_page_info {
 192         struct page *page;
 193         DEFINE_DMA_UNMAP_ADDR(bus);
 194         u16 page_offset;
 195         bool last_page_user;
 196 };
 197
 198 struct be_rx_stats {
 199         u64 rx_bytes;
 200         u64 rx_pkts;
 201         u64 rx_pkts_prev;
 202         ulong rx_jiffies;
 203         u32 rx_drops_no_skbs;   /* skb allocation errors */
 204         u32 rx_drops_no_frags;  /* HW has no fetched frags */
 205         u32 rx_post_fail;       /* page post alloc failures */
 206         u32 rx_polls;           /* NAPI calls */
 207         u32 rx_events;
 208         u32 rx_compl;
 209         u32 rx_mcast_pkts;
 210         u32 rx_compl_err;       /* completions with err set */
 211         u32 rx_pps;             /* pkts per second */
 212         struct u64_stats_sync sync;
 213 };
 214
 215 struct be_rx_compl_info {
 216         u32 rss_hash;
 217         u16 vlan_tag;
 218         u16 pkt_size;
 219         u16 rxq_idx;
 220         u16 port;
 221         u8 vlanf;
 222         u8 num_rcvd;
 223         u8 err;
 224         u8 ipf;
 225         u8 tcpf;
 226         u8 udpf;
 227         u8 ip_csum;
 228         u8 l4_csum;
 229         u8 ipv6;
 230         u8 vtm;
 231         u8 pkt_type;
 232 };
 233
 234 struct be_rx_obj {
 235         struct be_adapter *adapter;
 236         struct be_queue_info q;
 237         struct be_queue_info cq;
 238         struct be_rx_compl_info rxcp;
 239         struct be_rx_page_info page_info_tbl[RX_Q_LEN];
 240         struct be_eq_obj rx_eq;
 241         struct be_rx_stats stats;
 242         u8 rss_id;
 243         bool rx_post_starved;   /* Zero rx frags have been posted to BE */
 244         u32 cache_line_barrier[16];
 245 };
 246
 247 struct be_drv_stats {
 248         u8 be_on_die_temperature;
 249         u32 tx_events;
 250         u32 eth_red_drops;
 251         u32 rx_drops_no_pbuf;
 252         u32 rx_drops_no_txpb;
 253         u32 rx_drops_no_erx_descr;
 254         u32 rx_drops_no_tpre_descr;
 255         u32 rx_drops_too_many_frags;
 256         u32 rx_drops_invalid_ring;
 257         u32 forwarded_packets;
 258         u32 rx_drops_mtu;
 259         u32 rx_crc_errors;
 260         u32 rx_alignment_symbol_errors;
 261         u32 rx_pause_frames;
 262         u32 rx_priority_pause_frames;
 263         u32 rx_control_frames;
 264         u32 rx_in_range_errors;
 265         u32 rx_out_range_errors;
 266         u32 rx_frame_too_long;
 267         u32 rx_address_match_errors;
 268         u32 rx_dropped_too_small;
 269         u32 rx_dropped_too_short;
 270         u32 rx_dropped_header_too_small;
 271         u32 rx_dropped_tcp_length;
 272         u32 rx_dropped_runt;
 273         u32 rx_ip_checksum_errs;
 274         u32 rx_tcp_checksum_errs;
 275         u32 rx_udp_checksum_errs;
 276         u32 tx_pauseframes;
 277         u32 tx_priority_pauseframes;
 278         u32 tx_controlframes;
 279         u32 rxpp_fifo_overflow_drop;
 280         u32 rx_input_fifo_overflow_drop;
 281         u32 pmem_fifo_overflow_drop;
 282         u32 jabber_events;
 283 };
 284
 285 struct be_vf_cfg {
 286         unsigned char vf_mac_addr[ETH_ALEN];
 287         u32 vf_if_handle;
 288         u32 vf_pmac_id;
 289         u16 vf_vlan_tag;
 290         u32 vf_tx_rate;
 291 };
 292
 293 #define BE_INVALID_PMAC_ID              0xffffffff
 294
 295 struct be_adapter {
 296         struct pci_dev *pdev;
 297         struct net_device *netdev;
 298
 299         u8 __iomem *csr;
 300         u8 __iomem *db;         /* Door Bell */
 301         u8 __iomem *pcicfg;     /* PCI config space */
 302
 303         struct mutex mbox_lock; /* For serializing mbox cmds to BE card */
 304         struct be_dma_mem mbox_mem;
 305         /* Mbox mem is adjusted to align to 16 bytes. The allocated addr
 306          * is stored for freeing purpose */
 307         struct be_dma_mem mbox_mem_alloced;
 308
 309         struct be_mcc_obj mcc_obj;
 310         spinlock_t mcc_lock;    /* For serializing mcc cmds to BE card */
 311         spinlock_t mcc_cq_lock;
 312
 313         struct msix_entry msix_entries[BE_MAX_MSIX_VECTORS];
 314         u32 num_msix_vec;
 315         bool isr_registered;
 316
 317         /* TX Rings */
 318         struct be_eq_obj tx_eq;
 319         struct be_tx_obj tx_obj[MAX_TX_QS];
 320         u8 num_tx_qs;
 321
 322         u32 cache_line_break[8];
 323
 324         /* Rx rings */
 325         struct be_rx_obj rx_obj[MAX_RX_QS];
 326         u32 num_rx_qs;
 327         u32 big_page_size;      /* Compounded page size shared by rx wrbs */
 328
 329         u8 eq_next_idx;
 330         struct be_drv_stats drv_stats;
 331
 332         u16 vlans_added;
 333         u16 max_vlans;  /* Number of vlans supported */
 334         u8 vlan_tag[VLAN_N_VID];
 335         u8 vlan_prio_bmap;      /* Available Priority BitMap */
 336         u16 recommended_prio;   /* Recommended Priority */
 337         struct be_dma_mem rx_filter; /* Cmd DMA mem for rx-filter */
 338
 339         struct be_dma_mem stats_cmd;
 340         /* Work queue used to perform periodic tasks like getting statistics */
 341         struct delayed_work work;
 342         u16 work_counter;
 343
 344         /* Ethtool knobs and info */
 345         char fw_ver[FW_VER_LEN];
 346         u32 if_handle;          /* Used to configure filtering */
 347         u32 pmac_id;            /* MAC addr handle used by BE card */
 348         u32 beacon_state;       /* for set_phys_id */
 349
 350         bool eeh_err;
 351         bool link_up;
 352         u32 port_num;
 353         bool promiscuous;
 354         bool wol;
 355         u32 function_mode;
 356         u32 function_caps;
 357         u32 rx_fc;              /* Rx flow control */
 358         u32 tx_fc;              /* Tx flow control */
 359         bool ue_detected;
 360         bool stats_cmd_sent;
 361         int link_speed;
 362         u8 port_type;
 363         u8 transceiver;
 364         u8 autoneg;
 365         u8 generation;          /* BladeEngine ASIC generation */
 366         u32 flash_status;
 367         struct completion flash_compl;
 368
 369         bool be3_native;
 370         bool sriov_enabled;
 371         struct be_vf_cfg *vf_cfg;
 372         u8 is_virtfn;
 373         u32 sli_family;
 374         u8 hba_port_num;
 375         u16 pvid;
 376 };
 377
 378 #define be_physfn(adapter) (!adapter->is_virtfn)
 379
 380 /* BladeEngine Generation numbers */
 381 #define BE_GEN2 2
 382 #define BE_GEN3 3
 383
 384 #define ON                              1
 385 #define OFF                             0
 386 #define lancer_chip(adapter)    ((adapter->pdev->device == OC_DEVICE_ID3) || \
 387                                  (adapter->pdev->device == OC_DEVICE_ID4))
 388
 389 extern const struct ethtool_ops be_ethtool_ops;
 390
 391 #define msix_enabled(adapter)           (adapter->num_msix_vec > 0)
 392 #define tx_stats(txo)                   (&txo->stats)
 393 #define rx_stats(rxo)                   (&rxo->stats)
 394
 395 #define BE_SET_NETDEV_OPS(netdev, ops)  (netdev->netdev_ops = ops)
 396
 397 #define for_all_rx_queues(adapter, rxo, i)                              \
 398         for (i = 0, rxo = &adapter->rx_obj[i]; i < adapter->num_rx_qs;  \
 399                 i++, rxo++)
 400
 401 /* Just skip the first default non-rss queue */
 402 #define for_all_rss_queues(adapter, rxo, i)                             \
 403         for (i = 0, rxo = &adapter->rx_obj[i+1]; i < (adapter->num_rx_qs - 1);\
 404                 i++, rxo++)
 405
 406 #define for_all_tx_queues(adapter, txo, i)                              \
 407         for (i = 0, txo = &adapter->tx_obj[i]; i < adapter->num_tx_qs;  \
 408                 i++, txo++)
 409
 410 #define PAGE_SHIFT_4K           12
 411 #define PAGE_SIZE_4K            (1 << PAGE_SHIFT_4K)
 412
 413 /* Returns number of pages spanned by the data starting at the given addr */
 414 #define PAGES_4K_SPANNED(_address, size)                                \
 415                 ((u32)((((size_t)(_address) & (PAGE_SIZE_4K - 1)) +     \
 416                         (size) + (PAGE_SIZE_4K - 1)) >> PAGE_SHIFT_4K))
 417
 418 /* Byte offset into the page corresponding to given address */
 419 #define OFFSET_IN_PAGE(addr)                                            \
 420                  ((size_t)(addr) & (PAGE_SIZE_4K-1))
 421
 422 /* Returns bit offset within a DWORD of a bitfield */
 423 #define AMAP_BIT_OFFSET(_struct, field)                                 \
 424                 (((size_t)&(((_struct *)0)->field))%32)
 425
 426 /* Returns the bit mask of the field that is NOT shifted into location. */
 427 static inline u32 amap_mask(u32 bitsize)
 428 {
 429         return (bitsize == 32 ? 0xFFFFFFFF : (1 << bitsize) - 1);
 430 }
 431
 432 static inline void
 433 amap_set(void *ptr, u32 dw_offset, u32 mask, u32 offset, u32 value)
 434 {
 435         u32 *dw = (u32 *) ptr + dw_offset;
 436         *dw &= ~(mask << offset);
 437         *dw |= (mask & value) << offset;
 438 }
 439
 440 #define AMAP_SET_BITS(_struct, field, ptr, val)                         \
 441                 amap_set(ptr,                                           \
 442                         offsetof(_struct, field)/32,                    \
 443                         amap_mask(sizeof(((_struct *)0)->field)),       \
 444                         AMAP_BIT_OFFSET(_struct, field),                \
 445                         val)
 446
 447 static inline u32 amap_get(void *ptr, u32 dw_offset, u32 mask, u32 offset)
 448 {
 449         u32 *dw = (u32 *) ptr;
 450         return mask & (*(dw + dw_offset) >> offset);
 451 }
 452
 453 #define AMAP_GET_BITS(_struct, field, ptr)                              \
 454                 amap_get(ptr,                                           \
 455                         offsetof(_struct, field)/32,                    \
 456                         amap_mask(sizeof(((_struct *)0)->field)),       \
 457                         AMAP_BIT_OFFSET(_struct, field))
 458
 459 #define be_dws_cpu_to_le(wrb, len)      swap_dws(wrb, len)
 460 #define be_dws_le_to_cpu(wrb, len)      swap_dws(wrb, len)
 461 static inline void swap_dws(void *wrb, int len)
 462 {
 463 #ifdef __BIG_ENDIAN
 464         u32 *dw = wrb;
 465         BUG_ON(len % 4);
 466         do {
 467                 *dw = cpu_to_le32(*dw);
 468                 dw++;
 469                 len -= 4;
 470         } while (len);
 471 #endif                          /* __BIG_ENDIAN */
 472 }
 473
 474 static inline u8 is_tcp_pkt(struct sk_buff *skb)
 475 {
 476         u8 val = 0;
 477
 478         if (ip_hdr(skb)->version == 4)
 479                 val = (ip_hdr(skb)->protocol == IPPROTO_TCP);
 480         else if (ip_hdr(skb)->version == 6)
 481                 val = (ipv6_hdr(skb)->nexthdr == NEXTHDR_TCP);
 482
 483         return val;
 484 }
 485
 486 static inline u8 is_udp_pkt(struct sk_buff *skb)
 487 {
 488         u8 val = 0;
 489
 490         if (ip_hdr(skb)->version == 4)
 491                 val = (ip_hdr(skb)->protocol == IPPROTO_UDP);
 492         else if (ip_hdr(skb)->version == 6)
 493                 val = (ipv6_hdr(skb)->nexthdr == NEXTHDR_UDP);
 494
 495         return val;
 496 }
 497
 498 static inline void be_check_sriov_fn_type(struct be_adapter *adapter)
 499 {
 500         u32 sli_intf;
 501
 502         pci_read_config_dword(adapter->pdev, SLI_INTF_REG_OFFSET, &sli_intf);
 503         adapter->is_virtfn = (sli_intf & SLI_INTF_FT_MASK) ? 1 : 0;
 504 }
 505
 506 static inline void be_vf_eth_addr_generate(struct be_adapter *adapter, u8 *mac)
 507 {
 508         u32 addr;
 509
 510         addr = jhash(adapter->netdev->dev_addr, ETH_ALEN, 0);
 511
 512         mac[5] = (u8)(addr & 0xFF);
 513         mac[4] = (u8)((addr >> 8) & 0xFF);
 514         mac[3] = (u8)((addr >> 16) & 0xFF);
 515         /* Use the OUI from the current MAC address */
 516         memcpy(mac, adapter->netdev->dev_addr, 3);
 517 }
 518
 519 static inline bool be_multi_rxq(const struct be_adapter *adapter)
 520 {
 521         return adapter->num_rx_qs > 1;
 522 }
 523
 524 extern void be_cq_notify(struct be_adapter *adapter, u16 qid, bool arm,
 525                 u16 num_popped);
 526 extern void be_link_status_update(struct be_adapter *adapter, u32 link_status);
 527 extern void be_parse_stats(struct be_adapter *adapter);
 528 extern int be_load_fw(struct be_adapter *adapter, u8 *func);
 529 #endif                          /* BE_H */