Merge tag 'wireless-drivers-next-for-davem-2016-02-12' of git://git.kernel.org/pub...
[cascardo/linux.git] / drivers / net / ethernet / emulex / benet / be.h
1 /*
2  * Copyright (C) 2005 - 2015 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 #include <linux/cpumask.h>
34 #include <linux/hwmon.h>
35 #include <linux/hwmon-sysfs.h>
36
37 #include "be_hw.h"
38 #include "be_roce.h"
39
40 #define DRV_VER                 "11.0.0.0"
41 #define DRV_NAME                "be2net"
42 #define BE_NAME                 "Emulex BladeEngine2"
43 #define BE3_NAME                "Emulex BladeEngine3"
44 #define OC_NAME                 "Emulex OneConnect"
45 #define OC_NAME_BE              OC_NAME "(be3)"
46 #define OC_NAME_LANCER          OC_NAME "(Lancer)"
47 #define OC_NAME_SH              OC_NAME "(Skyhawk)"
48 #define DRV_DESC                "Emulex OneConnect NIC Driver"
49
50 #define BE_VENDOR_ID            0x19a2
51 #define EMULEX_VENDOR_ID        0x10df
52 #define BE_DEVICE_ID1           0x211
53 #define BE_DEVICE_ID2           0x221
54 #define OC_DEVICE_ID1           0x700   /* Device Id for BE2 cards */
55 #define OC_DEVICE_ID2           0x710   /* Device Id for BE3 cards */
56 #define OC_DEVICE_ID3           0xe220  /* Device id for Lancer cards */
57 #define OC_DEVICE_ID4           0xe228   /* Device id for VF in Lancer */
58 #define OC_DEVICE_ID5           0x720   /* Device Id for Skyhawk cards */
59 #define OC_DEVICE_ID6           0x728   /* Device id for VF in SkyHawk */
60 #define OC_SUBSYS_DEVICE_ID1    0xE602
61 #define OC_SUBSYS_DEVICE_ID2    0xE642
62 #define OC_SUBSYS_DEVICE_ID3    0xE612
63 #define OC_SUBSYS_DEVICE_ID4    0xE652
64
65 /* Number of bytes of an RX frame that are copied to skb->data */
66 #define BE_HDR_LEN              ((u16) 64)
67 /* allocate extra space to allow tunneling decapsulation without head reallocation */
68 #define BE_RX_SKB_ALLOC_SIZE (BE_HDR_LEN + 64)
69
70 #define BE_MAX_JUMBO_FRAME_SIZE 9018
71 #define BE_MIN_MTU              256
72 #define BE_MAX_MTU              (BE_MAX_JUMBO_FRAME_SIZE -      \
73                                  (ETH_HLEN + ETH_FCS_LEN))
74
75 #define BE_NUM_VLANS_SUPPORTED  64
76 #define BE_MAX_EQD              128u
77 #define BE_MAX_TX_FRAG_COUNT    30
78
79 #define EVNT_Q_LEN              1024
80 #define TX_Q_LEN                2048
81 #define TX_CQ_LEN               1024
82 #define RX_Q_LEN                1024    /* Does not support any other value */
83 #define RX_CQ_LEN               1024
84 #define MCC_Q_LEN               128     /* total size not to exceed 8 pages */
85 #define MCC_CQ_LEN              256
86
87 #define BE2_MAX_RSS_QS          4
88 #define BE3_MAX_RSS_QS          16
89 #define BE3_MAX_TX_QS           16
90 #define BE3_MAX_EVT_QS          16
91 #define BE3_SRIOV_MAX_EVT_QS    8
92 #define SH_VF_MAX_NIC_EQS       3       /* Skyhawk VFs can have a max of 4 EQs
93                                          * and at least 1 is granted to either
94                                          * SURF/DPDK
95                                          */
96
97 #define MAX_RSS_IFACES          15
98 #define MAX_RX_QS               32
99 #define MAX_EVT_QS              32
100 #define MAX_TX_QS               32
101
102 #define MAX_ROCE_EQS            5
103 #define MAX_MSIX_VECTORS        32
104 #define MIN_MSIX_VECTORS        1
105 #define BE_NAPI_WEIGHT          64
106 #define MAX_RX_POST             BE_NAPI_WEIGHT /* Frags posted at a time */
107 #define RX_FRAGS_REFILL_WM      (RX_Q_LEN - MAX_RX_POST)
108 #define MAX_NUM_POST_ERX_DB     255u
109
110 #define MAX_VFS                 30 /* Max VFs supported by BE3 FW */
111 #define FW_VER_LEN              32
112 #define CNTL_SERIAL_NUM_WORDS   8  /* Controller serial number words */
113 #define CNTL_SERIAL_NUM_WORD_SZ (sizeof(u16)) /* Byte-sz of serial num word */
114
115 #define RSS_INDIR_TABLE_LEN     128
116 #define RSS_HASH_KEY_LEN        40
117
118 #define BE_UNKNOWN_PHY_STATE    0xFF
119
120 struct be_dma_mem {
121         void *va;
122         dma_addr_t dma;
123         u32 size;
124 };
125
126 struct be_queue_info {
127         struct be_dma_mem dma_mem;
128         u16 len;
129         u16 entry_size; /* Size of an element in the queue */
130         u16 id;
131         u16 tail, head;
132         bool created;
133         atomic_t used;  /* Number of valid elements in the queue */
134 };
135
136 static inline u32 MODULO(u16 val, u16 limit)
137 {
138         BUG_ON(limit & (limit - 1));
139         return val & (limit - 1);
140 }
141
142 static inline void index_adv(u16 *index, u16 val, u16 limit)
143 {
144         *index = MODULO((*index + val), limit);
145 }
146
147 static inline void index_inc(u16 *index, u16 limit)
148 {
149         *index = MODULO((*index + 1), limit);
150 }
151
152 static inline void *queue_head_node(struct be_queue_info *q)
153 {
154         return q->dma_mem.va + q->head * q->entry_size;
155 }
156
157 static inline void *queue_tail_node(struct be_queue_info *q)
158 {
159         return q->dma_mem.va + q->tail * q->entry_size;
160 }
161
162 static inline void *queue_index_node(struct be_queue_info *q, u16 index)
163 {
164         return q->dma_mem.va + index * q->entry_size;
165 }
166
167 static inline void queue_head_inc(struct be_queue_info *q)
168 {
169         index_inc(&q->head, q->len);
170 }
171
172 static inline void index_dec(u16 *index, u16 limit)
173 {
174         *index = MODULO((*index - 1), limit);
175 }
176
177 static inline void queue_tail_inc(struct be_queue_info *q)
178 {
179         index_inc(&q->tail, q->len);
180 }
181
182 struct be_eq_obj {
183         struct be_queue_info q;
184         char desc[32];
185
186         /* Adaptive interrupt coalescing (AIC) info */
187         bool enable_aic;
188         u32 min_eqd;            /* in usecs */
189         u32 max_eqd;            /* in usecs */
190         u32 eqd;                /* configured val when aic is off */
191         u32 cur_eqd;            /* in usecs */
192
193         u8 idx;                 /* array index */
194         u8 msix_idx;
195         u16 spurious_intr;
196         struct napi_struct napi;
197         struct be_adapter *adapter;
198         cpumask_var_t  affinity_mask;
199
200 #ifdef CONFIG_NET_RX_BUSY_POLL
201 #define BE_EQ_IDLE              0
202 #define BE_EQ_NAPI              1       /* napi owns this EQ */
203 #define BE_EQ_POLL              2       /* poll owns this EQ */
204 #define BE_EQ_LOCKED            (BE_EQ_NAPI | BE_EQ_POLL)
205 #define BE_EQ_NAPI_YIELD        4       /* napi yielded this EQ */
206 #define BE_EQ_POLL_YIELD        8       /* poll yielded this EQ */
207 #define BE_EQ_YIELD             (BE_EQ_NAPI_YIELD | BE_EQ_POLL_YIELD)
208 #define BE_EQ_USER_PEND         (BE_EQ_POLL | BE_EQ_POLL_YIELD)
209         unsigned int state;
210         spinlock_t lock;        /* lock to serialize napi and busy-poll */
211 #endif  /* CONFIG_NET_RX_BUSY_POLL */
212 } ____cacheline_aligned_in_smp;
213
214 struct be_aic_obj {             /* Adaptive interrupt coalescing (AIC) info */
215         bool enable;
216         u32 min_eqd;            /* in usecs */
217         u32 max_eqd;            /* in usecs */
218         u32 prev_eqd;           /* in usecs */
219         u32 et_eqd;             /* configured val when aic is off */
220         ulong jiffies;
221         u64 rx_pkts_prev;       /* Used to calculate RX pps */
222         u64 tx_reqs_prev;       /* Used to calculate TX pps */
223 };
224
225 enum {
226         NAPI_POLLING,
227         BUSY_POLLING
228 };
229
230 struct be_mcc_obj {
231         struct be_queue_info q;
232         struct be_queue_info cq;
233         bool rearm_cq;
234 };
235
236 struct be_tx_stats {
237         u64 tx_bytes;
238         u64 tx_pkts;
239         u64 tx_vxlan_offload_pkts;
240         u64 tx_reqs;
241         u64 tx_compl;
242         ulong tx_jiffies;
243         u32 tx_stops;
244         u32 tx_drv_drops;       /* pkts dropped by driver */
245         /* the error counters are described in be_ethtool.c */
246         u32 tx_hdr_parse_err;
247         u32 tx_dma_err;
248         u32 tx_tso_err;
249         u32 tx_spoof_check_err;
250         u32 tx_qinq_err;
251         u32 tx_internal_parity_err;
252         struct u64_stats_sync sync;
253         struct u64_stats_sync sync_compl;
254 };
255
256 /* Structure to hold some data of interest obtained from a TX CQE */
257 struct be_tx_compl_info {
258         u8 status;              /* Completion status */
259         u16 end_index;          /* Completed TXQ Index */
260 };
261
262 struct be_tx_obj {
263         u32 db_offset;
264         struct be_queue_info q;
265         struct be_queue_info cq;
266         struct be_tx_compl_info txcp;
267         /* Remember the skbs that were transmitted */
268         struct sk_buff *sent_skb_list[TX_Q_LEN];
269         struct be_tx_stats stats;
270         u16 pend_wrb_cnt;       /* Number of WRBs yet to be given to HW */
271         u16 last_req_wrb_cnt;   /* wrb cnt of the last req in the Q */
272         u16 last_req_hdr;       /* index of the last req's hdr-wrb */
273 } ____cacheline_aligned_in_smp;
274
275 /* Struct to remember the pages posted for rx frags */
276 struct be_rx_page_info {
277         struct page *page;
278         /* set to page-addr for last frag of the page & frag-addr otherwise */
279         DEFINE_DMA_UNMAP_ADDR(bus);
280         u16 page_offset;
281         bool last_frag;         /* last frag of the page */
282 };
283
284 struct be_rx_stats {
285         u64 rx_bytes;
286         u64 rx_pkts;
287         u64 rx_vxlan_offload_pkts;
288         u32 rx_drops_no_skbs;   /* skb allocation errors */
289         u32 rx_drops_no_frags;  /* HW has no fetched frags */
290         u32 rx_post_fail;       /* page post alloc failures */
291         u32 rx_compl;
292         u32 rx_mcast_pkts;
293         u32 rx_compl_err;       /* completions with err set */
294         struct u64_stats_sync sync;
295 };
296
297 struct be_rx_compl_info {
298         u32 rss_hash;
299         u16 vlan_tag;
300         u16 pkt_size;
301         u16 port;
302         u8 vlanf;
303         u8 num_rcvd;
304         u8 err;
305         u8 ipf;
306         u8 tcpf;
307         u8 udpf;
308         u8 ip_csum;
309         u8 l4_csum;
310         u8 ipv6;
311         u8 qnq;
312         u8 pkt_type;
313         u8 ip_frag;
314         u8 tunneled;
315 };
316
317 struct be_rx_obj {
318         struct be_adapter *adapter;
319         struct be_queue_info q;
320         struct be_queue_info cq;
321         struct be_rx_compl_info rxcp;
322         struct be_rx_page_info page_info_tbl[RX_Q_LEN];
323         struct be_rx_stats stats;
324         u8 rss_id;
325         bool rx_post_starved;   /* Zero rx frags have been posted to BE */
326 } ____cacheline_aligned_in_smp;
327
328 struct be_drv_stats {
329         u32 eth_red_drops;
330         u32 dma_map_errors;
331         u32 rx_drops_no_pbuf;
332         u32 rx_drops_no_txpb;
333         u32 rx_drops_no_erx_descr;
334         u32 rx_drops_no_tpre_descr;
335         u32 rx_drops_too_many_frags;
336         u32 forwarded_packets;
337         u32 rx_drops_mtu;
338         u32 rx_crc_errors;
339         u32 rx_alignment_symbol_errors;
340         u32 rx_pause_frames;
341         u32 rx_priority_pause_frames;
342         u32 rx_control_frames;
343         u32 rx_in_range_errors;
344         u32 rx_out_range_errors;
345         u32 rx_frame_too_long;
346         u32 rx_address_filtered;
347         u32 rx_dropped_too_small;
348         u32 rx_dropped_too_short;
349         u32 rx_dropped_header_too_small;
350         u32 rx_dropped_tcp_length;
351         u32 rx_dropped_runt;
352         u32 rx_ip_checksum_errs;
353         u32 rx_tcp_checksum_errs;
354         u32 rx_udp_checksum_errs;
355         u32 tx_pauseframes;
356         u32 tx_priority_pauseframes;
357         u32 tx_controlframes;
358         u32 rxpp_fifo_overflow_drop;
359         u32 rx_input_fifo_overflow_drop;
360         u32 pmem_fifo_overflow_drop;
361         u32 jabber_events;
362         u32 rx_roce_bytes_lsd;
363         u32 rx_roce_bytes_msd;
364         u32 rx_roce_frames;
365         u32 roce_drops_payload_len;
366         u32 roce_drops_crc;
367 };
368
369 /* A vlan-id of 0xFFFF must be used to clear transparent vlan-tagging */
370 #define BE_RESET_VLAN_TAG_ID    0xFFFF
371
372 struct be_vf_cfg {
373         unsigned char mac_addr[ETH_ALEN];
374         int if_handle;
375         int pmac_id;
376         u16 vlan_tag;
377         u32 tx_rate;
378         u32 plink_tracking;
379         u32 privileges;
380         bool spoofchk;
381 };
382
383 enum vf_state {
384         ENABLED = 0,
385         ASSIGNED = 1
386 };
387
388 #define BE_FLAGS_LINK_STATUS_INIT               BIT(1)
389 #define BE_FLAGS_SRIOV_ENABLED                  BIT(2)
390 #define BE_FLAGS_WORKER_SCHEDULED               BIT(3)
391 #define BE_FLAGS_NAPI_ENABLED                   BIT(6)
392 #define BE_FLAGS_QNQ_ASYNC_EVT_RCVD             BIT(7)
393 #define BE_FLAGS_VXLAN_OFFLOADS                 BIT(8)
394 #define BE_FLAGS_SETUP_DONE                     BIT(9)
395 #define BE_FLAGS_PHY_MISCONFIGURED              BIT(10)
396 #define BE_FLAGS_ERR_DETECTION_SCHEDULED        BIT(11)
397 #define BE_FLAGS_OS2BMC                         BIT(12)
398
399 #define BE_UC_PMAC_COUNT                        30
400 #define BE_VF_UC_PMAC_COUNT                     2
401
402 #define MAX_ERR_RECOVERY_RETRY_COUNT            3
403 #define ERR_DETECTION_DELAY                     1000
404 #define ERR_RECOVERY_RETRY_DELAY                30000
405
406 /* Ethtool set_dump flags */
407 #define LANCER_INITIATE_FW_DUMP                 0x1
408 #define LANCER_DELETE_FW_DUMP                   0x2
409
410 struct phy_info {
411 /* From SFF-8472 spec */
412 #define SFP_VENDOR_NAME_LEN                     17
413         u8 transceiver;
414         u8 autoneg;
415         u8 fc_autoneg;
416         u8 port_type;
417         u16 phy_type;
418         u16 interface_type;
419         u32 misc_params;
420         u16 auto_speeds_supported;
421         u16 fixed_speeds_supported;
422         int link_speed;
423         u32 advertising;
424         u32 supported;
425         u8 cable_type;
426         u8 vendor_name[SFP_VENDOR_NAME_LEN];
427         u8 vendor_pn[SFP_VENDOR_NAME_LEN];
428 };
429
430 struct be_resources {
431         u16 max_vfs;            /* Total VFs "really" supported by FW/HW */
432         u16 max_mcast_mac;
433         u16 max_tx_qs;
434         u16 max_rss_qs;
435         u16 max_rx_qs;
436         u16 max_cq_count;
437         u16 max_uc_mac;         /* Max UC MACs programmable */
438         u16 max_vlans;          /* Number of vlans supported */
439         u16 max_iface_count;
440         u16 max_mcc_count;
441         u16 max_evt_qs;
442         u32 if_cap_flags;
443         u32 vf_if_cap_flags;    /* VF if capability flags */
444 };
445
446 #define be_is_os2bmc_enabled(adapter) (adapter->flags & BE_FLAGS_OS2BMC)
447
448 struct rss_info {
449         u64 rss_flags;
450         u8 rsstable[RSS_INDIR_TABLE_LEN];
451         u8 rss_queue[RSS_INDIR_TABLE_LEN];
452         u8 rss_hkey[RSS_HASH_KEY_LEN];
453 };
454
455 #define BE_INVALID_DIE_TEMP     0xFF
456 struct be_hwmon {
457         struct device *hwmon_dev;
458         u8 be_on_die_temp;  /* Unit: millidegree Celsius */
459 };
460
461 /* Macros to read/write the 'features' word of be_wrb_params structure.
462  */
463 #define BE_WRB_F_BIT(name)                      BE_WRB_F_##name##_BIT
464 #define BE_WRB_F_MASK(name)                     BIT_MASK(BE_WRB_F_##name##_BIT)
465
466 #define BE_WRB_F_GET(word, name)        \
467         (((word) & (BE_WRB_F_MASK(name))) >> BE_WRB_F_BIT(name))
468
469 #define BE_WRB_F_SET(word, name, val)   \
470         ((word) |= (((val) << BE_WRB_F_BIT(name)) & BE_WRB_F_MASK(name)))
471
472 /* Feature/offload bits */
473 enum {
474         BE_WRB_F_CRC_BIT,               /* Ethernet CRC */
475         BE_WRB_F_IPCS_BIT,              /* IP csum */
476         BE_WRB_F_TCPCS_BIT,             /* TCP csum */
477         BE_WRB_F_UDPCS_BIT,             /* UDP csum */
478         BE_WRB_F_LSO_BIT,               /* LSO */
479         BE_WRB_F_LSO6_BIT,              /* LSO6 */
480         BE_WRB_F_VLAN_BIT,              /* VLAN */
481         BE_WRB_F_VLAN_SKIP_HW_BIT,      /* Skip VLAN tag (workaround) */
482         BE_WRB_F_OS2BMC_BIT             /* Send packet to the management ring */
483 };
484
485 /* The structure below provides a HW-agnostic abstraction of WRB params
486  * retrieved from a TX skb. This is in turn passed to chip specific routines
487  * during transmit, to set the corresponding params in the WRB.
488  */
489 struct be_wrb_params {
490         u32 features;   /* Feature bits */
491         u16 vlan_tag;   /* VLAN tag */
492         u16 lso_mss;    /* MSS for LSO */
493 };
494
495 struct be_adapter {
496         struct pci_dev *pdev;
497         struct net_device *netdev;
498
499         u8 __iomem *csr;        /* CSR BAR used only for BE2/3 */
500         u8 __iomem *db;         /* Door Bell */
501         u8 __iomem *pcicfg;     /* On SH,BEx only. Shadow of PCI config space */
502
503         struct mutex mbox_lock; /* For serializing mbox cmds to BE card */
504         struct be_dma_mem mbox_mem;
505         /* Mbox mem is adjusted to align to 16 bytes. The allocated addr
506          * is stored for freeing purpose */
507         struct be_dma_mem mbox_mem_alloced;
508
509         struct be_mcc_obj mcc_obj;
510         spinlock_t mcc_lock;    /* For serializing mcc cmds to BE card */
511         spinlock_t mcc_cq_lock;
512
513         u16 cfg_num_qs;         /* configured via set-channels */
514         u16 num_evt_qs;
515         u16 num_msix_vec;
516         struct be_eq_obj eq_obj[MAX_EVT_QS];
517         struct msix_entry msix_entries[MAX_MSIX_VECTORS];
518         bool isr_registered;
519
520         /* TX Rings */
521         u16 num_tx_qs;
522         struct be_tx_obj tx_obj[MAX_TX_QS];
523
524         /* Rx rings */
525         u16 num_rx_qs;
526         u16 num_rss_qs;
527         u16 need_def_rxq;
528         struct be_rx_obj rx_obj[MAX_RX_QS];
529         u32 big_page_size;      /* Compounded page size shared by rx wrbs */
530
531         struct be_drv_stats drv_stats;
532         struct be_aic_obj aic_obj[MAX_EVT_QS];
533         u8 vlan_prio_bmap;      /* Available Priority BitMap */
534         u16 recommended_prio_bits;/* Recommended Priority bits in vlan tag */
535         struct be_dma_mem rx_filter; /* Cmd DMA mem for rx-filter */
536
537         struct be_dma_mem stats_cmd;
538         /* Work queue used to perform periodic tasks like getting statistics */
539         struct delayed_work work;
540         u16 work_counter;
541
542         struct delayed_work be_err_detection_work;
543         u8 recovery_retries;
544         u8 err_flags;
545         u32 flags;
546         u32 cmd_privileges;
547         /* Ethtool knobs and info */
548         char fw_ver[FW_VER_LEN];
549         char fw_on_flash[FW_VER_LEN];
550
551         /* IFACE filtering fields */
552         int if_handle;          /* Used to configure filtering */
553         u32 if_flags;           /* Interface filtering flags */
554         u32 *pmac_id;           /* MAC addr handle used by BE card */
555         u32 uc_macs;            /* Count of secondary UC MAC programmed */
556         unsigned long vids[BITS_TO_LONGS(VLAN_N_VID)];
557         u16 vlans_added;
558
559         u32 beacon_state;       /* for set_phys_id */
560
561         u32 port_num;
562         char port_name;
563         u8 mc_type;
564         u32 function_mode;
565         u32 function_caps;
566         u32 rx_fc;              /* Rx flow control */
567         u32 tx_fc;              /* Tx flow control */
568         bool stats_cmd_sent;
569         struct {
570                 u32 size;
571                 u32 total_size;
572                 u64 io_addr;
573         } roce_db;
574         u32 num_msix_roce_vec;
575         struct ocrdma_dev *ocrdma_dev;
576         struct list_head entry;
577
578         u32 flash_status;
579         struct completion et_cmd_compl;
580
581         struct be_resources pool_res;   /* resources available for the port */
582         struct be_resources res;        /* resources available for the func */
583         u16 num_vfs;                    /* Number of VFs provisioned by PF */
584         u8 pf_num;                      /* Numbering used by FW, starts at 0 */
585         u8 vf_num;                      /* Numbering used by FW, starts at 1 */
586         u8 virtfn;
587         struct be_vf_cfg *vf_cfg;
588         bool be3_native;
589         u32 sli_family;
590         u8 hba_port_num;
591         u16 pvid;
592         __be16 vxlan_port;
593         int vxlan_port_count;
594         int vxlan_port_aliases;
595         struct phy_info phy;
596         u8 wol_cap;
597         bool wol_en;
598         u16 asic_rev;
599         u16 qnq_vid;
600         u32 msg_enable;
601         int be_get_temp_freq;
602         struct be_hwmon hwmon_info;
603         struct rss_info rss_info;
604         /* Filters for packets that need to be sent to BMC */
605         u32 bmc_filt_mask;
606         u32 fat_dump_len;
607         u16 serial_num[CNTL_SERIAL_NUM_WORDS];
608         u8 phy_state; /* state of sfp optics (functional, faulted, etc.,) */
609 };
610
611 #define be_physfn(adapter)              (!adapter->virtfn)
612 #define be_virtfn(adapter)              (adapter->virtfn)
613 #define sriov_enabled(adapter)          (adapter->flags &       \
614                                          BE_FLAGS_SRIOV_ENABLED)
615
616 #define for_all_vfs(adapter, vf_cfg, i)                                 \
617         for (i = 0, vf_cfg = &adapter->vf_cfg[i]; i < adapter->num_vfs; \
618                 i++, vf_cfg++)
619
620 #define ON                              1
621 #define OFF                             0
622
623 #define be_max_vlans(adapter)           (adapter->res.max_vlans)
624 #define be_max_uc(adapter)              (adapter->res.max_uc_mac)
625 #define be_max_mc(adapter)              (adapter->res.max_mcast_mac)
626 #define be_max_vfs(adapter)             (adapter->pool_res.max_vfs)
627 #define be_max_rss(adapter)             (adapter->res.max_rss_qs)
628 #define be_max_txqs(adapter)            (adapter->res.max_tx_qs)
629 #define be_max_prio_txqs(adapter)       (adapter->res.max_prio_tx_qs)
630 #define be_max_rxqs(adapter)            (adapter->res.max_rx_qs)
631 #define be_max_eqs(adapter)             (adapter->res.max_evt_qs)
632 #define be_if_cap_flags(adapter)        (adapter->res.if_cap_flags)
633
634 static inline u16 be_max_qs(struct be_adapter *adapter)
635 {
636         /* If no RSS, need atleast the one def RXQ */
637         u16 num = max_t(u16, be_max_rss(adapter), 1);
638
639         num = min(num, be_max_eqs(adapter));
640         return min_t(u16, num, num_online_cpus());
641 }
642
643 /* Is BE in pvid_tagging mode */
644 #define be_pvid_tagging_enabled(adapter)        (adapter->pvid)
645
646 /* Is BE in QNQ multi-channel mode */
647 #define be_is_qnq_mode(adapter)         (adapter->function_mode & QNQ_MODE)
648
649 #define lancer_chip(adapter)    (adapter->pdev->device == OC_DEVICE_ID3 || \
650                                  adapter->pdev->device == OC_DEVICE_ID4)
651
652 #define skyhawk_chip(adapter)   (adapter->pdev->device == OC_DEVICE_ID5 || \
653                                  adapter->pdev->device == OC_DEVICE_ID6)
654
655 #define BE3_chip(adapter)       (adapter->pdev->device == BE_DEVICE_ID2 || \
656                                  adapter->pdev->device == OC_DEVICE_ID2)
657
658 #define BE2_chip(adapter)       (adapter->pdev->device == BE_DEVICE_ID1 || \
659                                  adapter->pdev->device == OC_DEVICE_ID1)
660
661 #define BEx_chip(adapter)       (BE3_chip(adapter) || BE2_chip(adapter))
662
663 #define be_roce_supported(adapter)      (skyhawk_chip(adapter) && \
664                                         (adapter->function_mode & RDMA_ENABLED))
665
666 extern const struct ethtool_ops be_ethtool_ops;
667
668 #define msix_enabled(adapter)           (adapter->num_msix_vec > 0)
669 #define num_irqs(adapter)               (msix_enabled(adapter) ?        \
670                                                 adapter->num_msix_vec : 1)
671 #define tx_stats(txo)                   (&(txo)->stats)
672 #define rx_stats(rxo)                   (&(rxo)->stats)
673
674 /* The default RXQ is the last RXQ */
675 #define default_rxo(adpt)               (&adpt->rx_obj[adpt->num_rx_qs - 1])
676
677 #define for_all_rx_queues(adapter, rxo, i)                              \
678         for (i = 0, rxo = &adapter->rx_obj[i]; i < adapter->num_rx_qs;  \
679                 i++, rxo++)
680
681 #define for_all_rss_queues(adapter, rxo, i)                             \
682         for (i = 0, rxo = &adapter->rx_obj[i]; i < adapter->num_rss_qs; \
683                 i++, rxo++)
684
685 #define for_all_tx_queues(adapter, txo, i)                              \
686         for (i = 0, txo = &adapter->tx_obj[i]; i < adapter->num_tx_qs;  \
687                 i++, txo++)
688
689 #define for_all_evt_queues(adapter, eqo, i)                             \
690         for (i = 0, eqo = &adapter->eq_obj[i]; i < adapter->num_evt_qs; \
691                 i++, eqo++)
692
693 #define for_all_rx_queues_on_eq(adapter, eqo, rxo, i)                   \
694         for (i = eqo->idx, rxo = &adapter->rx_obj[i]; i < adapter->num_rx_qs;\
695                  i += adapter->num_evt_qs, rxo += adapter->num_evt_qs)
696
697 #define for_all_tx_queues_on_eq(adapter, eqo, txo, i)                   \
698         for (i = eqo->idx, txo = &adapter->tx_obj[i]; i < adapter->num_tx_qs;\
699                 i += adapter->num_evt_qs, txo += adapter->num_evt_qs)
700
701 #define is_mcc_eqo(eqo)                 (eqo->idx == 0)
702 #define mcc_eqo(adapter)                (&adapter->eq_obj[0])
703
704 #define PAGE_SHIFT_4K           12
705 #define PAGE_SIZE_4K            (1 << PAGE_SHIFT_4K)
706
707 /* Returns number of pages spanned by the data starting at the given addr */
708 #define PAGES_4K_SPANNED(_address, size)                                \
709                 ((u32)((((size_t)(_address) & (PAGE_SIZE_4K - 1)) +     \
710                         (size) + (PAGE_SIZE_4K - 1)) >> PAGE_SHIFT_4K))
711
712 /* Returns bit offset within a DWORD of a bitfield */
713 #define AMAP_BIT_OFFSET(_struct, field)                                 \
714                 (((size_t)&(((_struct *)0)->field))%32)
715
716 /* Returns the bit mask of the field that is NOT shifted into location. */
717 static inline u32 amap_mask(u32 bitsize)
718 {
719         return (bitsize == 32 ? 0xFFFFFFFF : (1 << bitsize) - 1);
720 }
721
722 static inline void
723 amap_set(void *ptr, u32 dw_offset, u32 mask, u32 offset, u32 value)
724 {
725         u32 *dw = (u32 *) ptr + dw_offset;
726         *dw &= ~(mask << offset);
727         *dw |= (mask & value) << offset;
728 }
729
730 #define AMAP_SET_BITS(_struct, field, ptr, val)                         \
731                 amap_set(ptr,                                           \
732                         offsetof(_struct, field)/32,                    \
733                         amap_mask(sizeof(((_struct *)0)->field)),       \
734                         AMAP_BIT_OFFSET(_struct, field),                \
735                         val)
736
737 static inline u32 amap_get(void *ptr, u32 dw_offset, u32 mask, u32 offset)
738 {
739         u32 *dw = (u32 *) ptr;
740         return mask & (*(dw + dw_offset) >> offset);
741 }
742
743 #define AMAP_GET_BITS(_struct, field, ptr)                              \
744                 amap_get(ptr,                                           \
745                         offsetof(_struct, field)/32,                    \
746                         amap_mask(sizeof(((_struct *)0)->field)),       \
747                         AMAP_BIT_OFFSET(_struct, field))
748
749 #define GET_RX_COMPL_V0_BITS(field, ptr)                                \
750                 AMAP_GET_BITS(struct amap_eth_rx_compl_v0, field, ptr)
751
752 #define GET_RX_COMPL_V1_BITS(field, ptr)                                \
753                 AMAP_GET_BITS(struct amap_eth_rx_compl_v1, field, ptr)
754
755 #define GET_TX_COMPL_BITS(field, ptr)                                   \
756                 AMAP_GET_BITS(struct amap_eth_tx_compl, field, ptr)
757
758 #define SET_TX_WRB_HDR_BITS(field, ptr, val)                            \
759                 AMAP_SET_BITS(struct amap_eth_hdr_wrb, field, ptr, val)
760
761 #define be_dws_cpu_to_le(wrb, len)      swap_dws(wrb, len)
762 #define be_dws_le_to_cpu(wrb, len)      swap_dws(wrb, len)
763 static inline void swap_dws(void *wrb, int len)
764 {
765 #ifdef __BIG_ENDIAN
766         u32 *dw = wrb;
767         BUG_ON(len % 4);
768         do {
769                 *dw = cpu_to_le32(*dw);
770                 dw++;
771                 len -= 4;
772         } while (len);
773 #endif                          /* __BIG_ENDIAN */
774 }
775
776 #define be_cmd_status(status)           (status > 0 ? -EIO : status)
777
778 static inline u8 is_tcp_pkt(struct sk_buff *skb)
779 {
780         u8 val = 0;
781
782         if (ip_hdr(skb)->version == 4)
783                 val = (ip_hdr(skb)->protocol == IPPROTO_TCP);
784         else if (ip_hdr(skb)->version == 6)
785                 val = (ipv6_hdr(skb)->nexthdr == NEXTHDR_TCP);
786
787         return val;
788 }
789
790 static inline u8 is_udp_pkt(struct sk_buff *skb)
791 {
792         u8 val = 0;
793
794         if (ip_hdr(skb)->version == 4)
795                 val = (ip_hdr(skb)->protocol == IPPROTO_UDP);
796         else if (ip_hdr(skb)->version == 6)
797                 val = (ipv6_hdr(skb)->nexthdr == NEXTHDR_UDP);
798
799         return val;
800 }
801
802 static inline bool is_ipv4_pkt(struct sk_buff *skb)
803 {
804         return skb->protocol == htons(ETH_P_IP) && ip_hdr(skb)->version == 4;
805 }
806
807 #define BE_ERROR_EEH            1
808 #define BE_ERROR_UE             BIT(1)
809 #define BE_ERROR_FW             BIT(2)
810 #define BE_ERROR_HW             (BE_ERROR_EEH | BE_ERROR_UE)
811 #define BE_ERROR_ANY            (BE_ERROR_EEH | BE_ERROR_UE | BE_ERROR_FW)
812 #define BE_CLEAR_ALL            0xFF
813
814 static inline u8 be_check_error(struct be_adapter *adapter, u32 err_type)
815 {
816         return (adapter->err_flags & err_type);
817 }
818
819 static inline void be_set_error(struct be_adapter *adapter, int err_type)
820 {
821         struct net_device *netdev = adapter->netdev;
822
823         adapter->err_flags |= err_type;
824         netif_carrier_off(netdev);
825
826         dev_info(&adapter->pdev->dev, "%s: Link down\n", netdev->name);
827 }
828
829 static inline void  be_clear_error(struct be_adapter *adapter, int err_type)
830 {
831         adapter->err_flags &= ~err_type;
832 }
833
834 static inline bool be_multi_rxq(const struct be_adapter *adapter)
835 {
836         return adapter->num_rx_qs > 1;
837 }
838
839 void be_cq_notify(struct be_adapter *adapter, u16 qid, bool arm,
840                   u16 num_popped);
841 void be_link_status_update(struct be_adapter *adapter, u8 link_status);
842 void be_parse_stats(struct be_adapter *adapter);
843 int be_load_fw(struct be_adapter *adapter, u8 *func);
844 bool be_is_wol_supported(struct be_adapter *adapter);
845 bool be_pause_supported(struct be_adapter *adapter);
846 u32 be_get_fw_log_level(struct be_adapter *adapter);
847 int be_update_queues(struct be_adapter *adapter);
848 int be_poll(struct napi_struct *napi, int budget);
849 void be_eqd_update(struct be_adapter *adapter, bool force_update);
850
851 /*
852  * internal function to initialize-cleanup roce device.
853  */
854 void be_roce_dev_add(struct be_adapter *);
855 void be_roce_dev_remove(struct be_adapter *);
856
857 /*
858  * internal function to open-close roce device during ifup-ifdown.
859  */
860 void be_roce_dev_shutdown(struct be_adapter *);
861
862 #endif                          /* BE_H */