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_index_node(struct be_queue_info *q, u16 index) 141 { 142 return q->dma_mem.va + index * q->entry_size; 143 } 144 145 static inline void queue_head_inc(struct be_queue_info *q) 146 { 147 index_inc(&q->head, q->len); 148 } 149 150 static inline void queue_tail_inc(struct be_queue_info *q) 151 { 152 index_inc(&q->tail, q->len); 153 } 154 155 struct be_eq_obj { 156 struct be_queue_info q; 157 char desc[32]; 158 159 /* Adaptive interrupt coalescing (AIC) info */ 160 bool enable_aic; 161 u16 min_eqd; /* in usecs */ 162 u16 max_eqd; /* in usecs */ 163 u16 cur_eqd; /* in usecs */ 164 u8 eq_idx; 165 166 struct napi_struct napi; 167 }; 168 169 struct be_mcc_obj { 170 struct be_queue_info q; 171 struct be_queue_info cq; 172 bool rearm_cq; 173 }; 174 175 struct be_tx_stats { 176 u64 tx_bytes; 177 u64 tx_pkts; 178 u64 tx_reqs; 179 u64 tx_wrbs; 180 u64 tx_compl; 181 ulong tx_jiffies; 182 u32 tx_stops; 183 struct u64_stats_sync sync; 184 struct u64_stats_sync sync_compl; 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 struct be_tx_stats stats; 193 }; 194 195 /* Struct to remember the pages posted for rx frags */ 196 struct be_rx_page_info { 197 struct page *page; 198 DEFINE_DMA_UNMAP_ADDR(bus); 199 u16 page_offset; 200 bool last_page_user; 201 }; 202 203 struct be_rx_stats { 204 u64 rx_bytes; 205 u64 rx_pkts; 206 u64 rx_pkts_prev; 207 ulong rx_jiffies; 208 u32 rx_drops_no_skbs; /* skb allocation errors */ 209 u32 rx_drops_no_frags; /* HW has no fetched frags */ 210 u32 rx_post_fail; /* page post alloc failures */ 211 u32 rx_polls; /* NAPI calls */ 212 u32 rx_events; 213 u32 rx_compl; 214 u32 rx_mcast_pkts; 215 u32 rx_compl_err; /* completions with err set */ 216 u32 rx_pps; /* pkts per second */ 217 struct u64_stats_sync sync; 218 }; 219 220 struct be_rx_compl_info { 221 u32 rss_hash; 222 u16 vlan_tag; 223 u16 pkt_size; 224 u16 rxq_idx; 225 u16 port; 226 u8 vlanf; 227 u8 num_rcvd; 228 u8 err; 229 u8 ipf; 230 u8 tcpf; 231 u8 udpf; 232 u8 ip_csum; 233 u8 l4_csum; 234 u8 ipv6; 235 u8 vtm; 236 u8 pkt_type; 237 }; 238 239 struct be_rx_obj { 240 struct be_adapter *adapter; 241 struct be_queue_info q; 242 struct be_queue_info cq; 243 struct be_rx_compl_info rxcp; 244 struct be_rx_page_info page_info_tbl[RX_Q_LEN]; 245 struct be_eq_obj rx_eq; 246 struct be_rx_stats stats; 247 u8 rss_id; 248 bool rx_post_starved; /* Zero rx frags have been posted to BE */ 249 u32 cache_line_barrier[16]; 250 }; 251 252 struct be_drv_stats { 253 u32 be_on_die_temperature; 254 u32 tx_events; 255 u32 eth_red_drops; 256 u32 rx_drops_no_pbuf; 257 u32 rx_drops_no_txpb; 258 u32 rx_drops_no_erx_descr; 259 u32 rx_drops_no_tpre_descr; 260 u32 rx_drops_too_many_frags; 261 u32 rx_drops_invalid_ring; 262 u32 forwarded_packets; 263 u32 rx_drops_mtu; 264 u32 rx_crc_errors; 265 u32 rx_alignment_symbol_errors; 266 u32 rx_pause_frames; 267 u32 rx_priority_pause_frames; 268 u32 rx_control_frames; 269 u32 rx_in_range_errors; 270 u32 rx_out_range_errors; 271 u32 rx_frame_too_long; 272 u32 rx_address_match_errors; 273 u32 rx_dropped_too_small; 274 u32 rx_dropped_too_short; 275 u32 rx_dropped_header_too_small; 276 u32 rx_dropped_tcp_length; 277 u32 rx_dropped_runt; 278 u32 rx_ip_checksum_errs; 279 u32 rx_tcp_checksum_errs; 280 u32 rx_udp_checksum_errs; 281 u32 tx_pauseframes; 282 u32 tx_priority_pauseframes; 283 u32 tx_controlframes; 284 u32 rxpp_fifo_overflow_drop; 285 u32 rx_input_fifo_overflow_drop; 286 u32 pmem_fifo_overflow_drop; 287 u32 jabber_events; 288 }; 289 290 struct be_vf_cfg { 291 unsigned char vf_mac_addr[ETH_ALEN]; 292 u32 vf_if_handle; 293 u32 vf_pmac_id; 294 u16 vf_vlan_tag; 295 u32 vf_tx_rate; 296 }; 297 298 #define BE_INVALID_PMAC_ID 0xffffffff 299 300 struct be_adapter { 301 struct pci_dev *pdev; 302 struct net_device *netdev; 303 304 u8 __iomem *csr; 305 u8 __iomem *db; /* Door Bell */ 306 307 struct mutex mbox_lock; /* For serializing mbox cmds to BE card */ 308 struct be_dma_mem mbox_mem; 309 /* Mbox mem is adjusted to align to 16 bytes. The allocated addr 310 * is stored for freeing purpose */ 311 struct be_dma_mem mbox_mem_alloced; 312 313 struct be_mcc_obj mcc_obj; 314 spinlock_t mcc_lock; /* For serializing mcc cmds to BE card */ 315 spinlock_t mcc_cq_lock; 316 317 struct msix_entry msix_entries[BE_MAX_MSIX_VECTORS]; 318 u32 num_msix_vec; 319 bool isr_registered; 320 321 /* TX Rings */ 322 struct be_eq_obj tx_eq; 323 struct be_tx_obj tx_obj[MAX_TX_QS]; 324 u8 num_tx_qs; 325 326 u32 cache_line_break[8]; 327 328 /* Rx rings */ 329 struct be_rx_obj rx_obj[MAX_RX_QS]; 330 u32 num_rx_qs; 331 u32 big_page_size; /* Compounded page size shared by rx wrbs */ 332 333 u8 eq_next_idx; 334 struct be_drv_stats drv_stats; 335 336 u16 vlans_added; 337 u16 max_vlans; /* Number of vlans supported */ 338 u8 vlan_tag[VLAN_N_VID]; 339 u8 vlan_prio_bmap; /* Available Priority BitMap */ 340 u16 recommended_prio; /* Recommended Priority */ 341 struct be_dma_mem rx_filter; /* Cmd DMA mem for rx-filter */ 342 343 struct be_dma_mem stats_cmd; 344 /* Work queue used to perform periodic tasks like getting statistics */ 345 struct delayed_work work; 346 u16 work_counter; 347 348 /* Ethtool knobs and info */ 349 char fw_ver[FW_VER_LEN]; 350 u32 if_handle; /* Used to configure filtering */ 351 u32 pmac_id; /* MAC addr handle used by BE card */ 352 u32 beacon_state; /* for set_phys_id */ 353 354 bool eeh_err; 355 u32 port_num; 356 bool promiscuous; 357 bool wol; 358 u32 function_mode; 359 u32 function_caps; 360 u32 rx_fc; /* Rx flow control */ 361 u32 tx_fc; /* Tx flow control */ 362 bool ue_detected; 363 bool stats_cmd_sent; 364 int link_speed; 365 u8 port_type; 366 u8 transceiver; 367 u8 autoneg; 368 u8 generation; /* BladeEngine ASIC generation */ 369 u32 flash_status; 370 struct completion flash_compl; 371 372 bool be3_native; 373 bool sriov_enabled; 374 struct be_vf_cfg *vf_cfg; 375 u8 is_virtfn; 376 u32 sli_family; 377 u8 hba_port_num; 378 u16 pvid; 379 }; 380 381 #define be_physfn(adapter) (!adapter->is_virtfn) 382 383 /* BladeEngine Generation numbers */ 384 #define BE_GEN2 2 385 #define BE_GEN3 3 386 387 #define ON 1 388 #define OFF 0 389 #define lancer_chip(adapter) ((adapter->pdev->device == OC_DEVICE_ID3) || \ 390 (adapter->pdev->device == OC_DEVICE_ID4)) 391 392 extern const struct ethtool_ops be_ethtool_ops; 393 394 #define msix_enabled(adapter) (adapter->num_msix_vec > 0) 395 #define tx_stats(txo) (&txo->stats) 396 #define rx_stats(rxo) (&rxo->stats) 397 398 #define BE_SET_NETDEV_OPS(netdev, ops) (netdev->netdev_ops = ops) 399 400 #define for_all_rx_queues(adapter, rxo, i) \ 401 for (i = 0, rxo = &adapter->rx_obj[i]; i < adapter->num_rx_qs; \ 402 i++, rxo++) 403 404 /* Just skip the first default non-rss queue */ 405 #define for_all_rss_queues(adapter, rxo, i) \ 406 for (i = 0, rxo = &adapter->rx_obj[i+1]; i < (adapter->num_rx_qs - 1);\ 407 i++, rxo++) 408 409 #define for_all_tx_queues(adapter, txo, i) \ 410 for (i = 0, txo = &adapter->tx_obj[i]; i < adapter->num_tx_qs; \ 411 i++, txo++) 412 413 #define PAGE_SHIFT_4K 12 414 #define PAGE_SIZE_4K (1 << PAGE_SHIFT_4K) 415 416 /* Returns number of pages spanned by the data starting at the given addr */ 417 #define PAGES_4K_SPANNED(_address, size) \ 418 ((u32)((((size_t)(_address) & (PAGE_SIZE_4K - 1)) + \ 419 (size) + (PAGE_SIZE_4K - 1)) >> PAGE_SHIFT_4K)) 420 421 /* Byte offset into the page corresponding to given address */ 422 #define OFFSET_IN_PAGE(addr) \ 423 ((size_t)(addr) & (PAGE_SIZE_4K-1)) 424 425 /* Returns bit offset within a DWORD of a bitfield */ 426 #define AMAP_BIT_OFFSET(_struct, field) \ 427 (((size_t)&(((_struct *)0)->field))%32) 428 429 /* Returns the bit mask of the field that is NOT shifted into location. */ 430 static inline u32 amap_mask(u32 bitsize) 431 { 432 return (bitsize == 32 ? 0xFFFFFFFF : (1 << bitsize) - 1); 433 } 434 435 static inline void 436 amap_set(void *ptr, u32 dw_offset, u32 mask, u32 offset, u32 value) 437 { 438 u32 *dw = (u32 *) ptr + dw_offset; 439 *dw &= ~(mask << offset); 440 *dw |= (mask & value) << offset; 441 } 442 443 #define AMAP_SET_BITS(_struct, field, ptr, val) \ 444 amap_set(ptr, \ 445 offsetof(_struct, field)/32, \ 446 amap_mask(sizeof(((_struct *)0)->field)), \ 447 AMAP_BIT_OFFSET(_struct, field), \ 448 val) 449 450 static inline u32 amap_get(void *ptr, u32 dw_offset, u32 mask, u32 offset) 451 { 452 u32 *dw = (u32 *) ptr; 453 return mask & (*(dw + dw_offset) >> offset); 454 } 455 456 #define AMAP_GET_BITS(_struct, field, ptr) \ 457 amap_get(ptr, \ 458 offsetof(_struct, field)/32, \ 459 amap_mask(sizeof(((_struct *)0)->field)), \ 460 AMAP_BIT_OFFSET(_struct, field)) 461 462 #define be_dws_cpu_to_le(wrb, len) swap_dws(wrb, len) 463 #define be_dws_le_to_cpu(wrb, len) swap_dws(wrb, len) 464 static inline void swap_dws(void *wrb, int len) 465 { 466 #ifdef __BIG_ENDIAN 467 u32 *dw = wrb; 468 BUG_ON(len % 4); 469 do { 470 *dw = cpu_to_le32(*dw); 471 dw++; 472 len -= 4; 473 } while (len); 474 #endif /* __BIG_ENDIAN */ 475 } 476 477 static inline u8 is_tcp_pkt(struct sk_buff *skb) 478 { 479 u8 val = 0; 480 481 if (ip_hdr(skb)->version == 4) 482 val = (ip_hdr(skb)->protocol == IPPROTO_TCP); 483 else if (ip_hdr(skb)->version == 6) 484 val = (ipv6_hdr(skb)->nexthdr == NEXTHDR_TCP); 485 486 return val; 487 } 488 489 static inline u8 is_udp_pkt(struct sk_buff *skb) 490 { 491 u8 val = 0; 492 493 if (ip_hdr(skb)->version == 4) 494 val = (ip_hdr(skb)->protocol == IPPROTO_UDP); 495 else if (ip_hdr(skb)->version == 6) 496 val = (ipv6_hdr(skb)->nexthdr == NEXTHDR_UDP); 497 498 return val; 499 } 500 501 static inline void be_check_sriov_fn_type(struct be_adapter *adapter) 502 { 503 u32 sli_intf; 504 505 pci_read_config_dword(adapter->pdev, SLI_INTF_REG_OFFSET, &sli_intf); 506 adapter->is_virtfn = (sli_intf & SLI_INTF_FT_MASK) ? 1 : 0; 507 } 508 509 static inline void be_vf_eth_addr_generate(struct be_adapter *adapter, u8 *mac) 510 { 511 u32 addr; 512 513 addr = jhash(adapter->netdev->dev_addr, ETH_ALEN, 0); 514 515 mac[5] = (u8)(addr & 0xFF); 516 mac[4] = (u8)((addr >> 8) & 0xFF); 517 mac[3] = (u8)((addr >> 16) & 0xFF); 518 /* Use the OUI from the current MAC address */ 519 memcpy(mac, adapter->netdev->dev_addr, 3); 520 } 521 522 static inline bool be_multi_rxq(const struct be_adapter *adapter) 523 { 524 return adapter->num_rx_qs > 1; 525 } 526 527 extern void be_cq_notify(struct be_adapter *adapter, u16 qid, bool arm, 528 u16 num_popped); 529 extern void be_link_status_update(struct be_adapter *adapter, u32 link_status); 530 extern void be_parse_stats(struct be_adapter *adapter); 531 extern int be_load_fw(struct be_adapter *adapter, u8 *func); 532 #endif /* BE_H */ 533