Revert "be2net: remove desc field from be_eq_obj"
[muen/linux.git] / drivers / net / ethernet / emulex / benet / be.h
1 /*
2  * Copyright (C) 2005 - 2016 Broadcom
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                 "12.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    256
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 /* Accommodate for QnQ configurations where VLAN insertion is enabled in HW */
76 #define BE_MAX_GSO_SIZE         (65535 - 2 * VLAN_HLEN)
77
78 #define BE_NUM_VLANS_SUPPORTED  64
79 #define BE_MAX_EQD              128u
80 #define BE_MAX_TX_FRAG_COUNT    30
81
82 #define EVNT_Q_LEN              1024
83 #define TX_Q_LEN                2048
84 #define TX_CQ_LEN               1024
85 #define RX_Q_LEN                1024    /* Does not support any other value */
86 #define RX_CQ_LEN               1024
87 #define MCC_Q_LEN               128     /* total size not to exceed 8 pages */
88 #define MCC_CQ_LEN              256
89
90 #define BE2_MAX_RSS_QS          4
91 #define BE3_MAX_RSS_QS          16
92 #define BE3_MAX_TX_QS           16
93 #define BE3_MAX_EVT_QS          16
94 #define BE3_SRIOV_MAX_EVT_QS    8
95 #define SH_VF_MAX_NIC_EQS       3       /* Skyhawk VFs can have a max of 4 EQs
96                                          * and at least 1 is granted to either
97                                          * SURF/DPDK
98                                          */
99
100 #define MAX_PORT_RSS_TABLES     15
101 #define MAX_NIC_FUNCS           16
102 #define MAX_RX_QS               32
103 #define MAX_EVT_QS              32
104 #define MAX_TX_QS               32
105
106 #define MAX_ROCE_EQS            5
107 #define MAX_MSIX_VECTORS        32
108 #define MIN_MSIX_VECTORS        1
109 #define BE_NAPI_WEIGHT          64
110 #define MAX_RX_POST             BE_NAPI_WEIGHT /* Frags posted at a time */
111 #define RX_FRAGS_REFILL_WM      (RX_Q_LEN - MAX_RX_POST)
112 #define MAX_NUM_POST_ERX_DB     255u
113
114 #define MAX_VFS                 30 /* Max VFs supported by BE3 FW */
115 #define FW_VER_LEN              32
116 #define CNTL_SERIAL_NUM_WORDS   8  /* Controller serial number words */
117 #define CNTL_SERIAL_NUM_WORD_SZ (sizeof(u16)) /* Byte-sz of serial num word */
118
119 #define RSS_INDIR_TABLE_LEN     128
120 #define RSS_HASH_KEY_LEN        40
121
122 #define BE_UNKNOWN_PHY_STATE    0xFF
123
124 struct be_dma_mem {
125         void *va;
126         dma_addr_t dma;
127         u32 size;
128 };
129
130 struct be_queue_info {
131         u32 len;
132         u32 entry_size; /* Size of an element in the queue */
133         u32 tail, head;
134         atomic_t used;  /* Number of valid elements in the queue */
135         u32 id;
136         struct be_dma_mem dma_mem;
137         bool created;
138 };
139
140 static inline u32 MODULO(u32 val, u32 limit)
141 {
142         BUG_ON(limit & (limit - 1));
143         return val & (limit - 1);
144 }
145
146 static inline void index_adv(u32 *index, u32 val, u32 limit)
147 {
148         *index = MODULO((*index + val), limit);
149 }
150
151 static inline void index_inc(u32 *index, u32 limit)
152 {
153         *index = MODULO((*index + 1), limit);
154 }
155
156 static inline void *queue_head_node(struct be_queue_info *q)
157 {
158         return q->dma_mem.va + q->head * q->entry_size;
159 }
160
161 static inline void *queue_tail_node(struct be_queue_info *q)
162 {
163         return q->dma_mem.va + q->tail * q->entry_size;
164 }
165
166 static inline void *queue_index_node(struct be_queue_info *q, u16 index)
167 {
168         return q->dma_mem.va + index * q->entry_size;
169 }
170
171 static inline void queue_head_inc(struct be_queue_info *q)
172 {
173         index_inc(&q->head, q->len);
174 }
175
176 static inline void index_dec(u32 *index, u32 limit)
177 {
178         *index = MODULO((*index - 1), limit);
179 }
180
181 static inline void queue_tail_inc(struct be_queue_info *q)
182 {
183         index_inc(&q->tail, q->len);
184 }
185
186 struct be_eq_obj {
187         struct be_queue_info q;
188         char desc[32];
189
190         struct be_adapter *adapter;
191         struct napi_struct napi;
192         u8 idx;                 /* array index */
193         u8 msix_idx;
194         u16 spurious_intr;
195         cpumask_var_t  affinity_mask;
196 } ____cacheline_aligned_in_smp;
197
198 struct be_aic_obj {             /* Adaptive interrupt coalescing (AIC) info */
199         bool enable;
200         u32 min_eqd;            /* in usecs */
201         u32 max_eqd;            /* in usecs */
202         u32 prev_eqd;           /* in usecs */
203         u32 et_eqd;             /* configured val when aic is off */
204         ulong jiffies;
205         u64 rx_pkts_prev;       /* Used to calculate RX pps */
206         u64 tx_reqs_prev;       /* Used to calculate TX pps */
207 };
208
209 struct be_mcc_obj {
210         struct be_queue_info q;
211         struct be_queue_info cq;
212         bool rearm_cq;
213 };
214
215 struct be_tx_stats {
216         u64 tx_bytes;
217         u64 tx_pkts;
218         u64 tx_vxlan_offload_pkts;
219         u64 tx_reqs;
220         u64 tx_compl;
221         u32 tx_stops;
222         u32 tx_drv_drops;       /* pkts dropped by driver */
223         /* the error counters are described in be_ethtool.c */
224         u32 tx_hdr_parse_err;
225         u32 tx_dma_err;
226         u32 tx_tso_err;
227         u32 tx_spoof_check_err;
228         u32 tx_qinq_err;
229         u32 tx_internal_parity_err;
230         u32 tx_sge_err;
231         struct u64_stats_sync sync;
232         struct u64_stats_sync sync_compl;
233 };
234
235 /* Structure to hold some data of interest obtained from a TX CQE */
236 struct be_tx_compl_info {
237         u8 status;              /* Completion status */
238         u16 end_index;          /* Completed TXQ Index */
239 };
240
241 struct be_tx_obj {
242         u32 db_offset;
243         struct be_tx_compl_info txcp;
244         struct be_queue_info q;
245         struct be_queue_info cq;
246         /* Remember the skbs that were transmitted */
247         struct sk_buff *sent_skb_list[TX_Q_LEN];
248         struct be_tx_stats stats;
249         u16 pend_wrb_cnt;       /* Number of WRBs yet to be given to HW */
250         u16 last_req_wrb_cnt;   /* wrb cnt of the last req in the Q */
251         u16 last_req_hdr;       /* index of the last req's hdr-wrb */
252 } ____cacheline_aligned_in_smp;
253
254 /* Struct to remember the pages posted for rx frags */
255 struct be_rx_page_info {
256         struct page *page;
257         /* set to page-addr for last frag of the page & frag-addr otherwise */
258         DEFINE_DMA_UNMAP_ADDR(bus);
259         u16 page_offset;
260         bool last_frag;         /* last frag of the page */
261 };
262
263 struct be_rx_stats {
264         u64 rx_bytes;
265         u64 rx_pkts;
266         u64 rx_vxlan_offload_pkts;
267         u32 rx_drops_no_skbs;   /* skb allocation errors */
268         u32 rx_drops_no_frags;  /* HW has no fetched frags */
269         u32 rx_post_fail;       /* page post alloc failures */
270         u32 rx_compl;
271         u32 rx_mcast_pkts;
272         u32 rx_compl_err;       /* completions with err set */
273         struct u64_stats_sync sync;
274 };
275
276 struct be_rx_compl_info {
277         u32 rss_hash;
278         u16 vlan_tag;
279         u16 pkt_size;
280         u16 port;
281         u8 vlanf;
282         u8 num_rcvd;
283         u8 err;
284         u8 ipf;
285         u8 tcpf;
286         u8 udpf;
287         u8 ip_csum;
288         u8 l4_csum;
289         u8 ipv6;
290         u8 qnq;
291         u8 pkt_type;
292         u8 ip_frag;
293         u8 tunneled;
294 };
295
296 struct be_rx_obj {
297         struct be_adapter *adapter;
298         struct be_queue_info q;
299         struct be_queue_info cq;
300         struct be_rx_compl_info rxcp;
301         struct be_rx_page_info page_info_tbl[RX_Q_LEN];
302         struct be_rx_stats stats;
303         u8 rss_id;
304         bool rx_post_starved;   /* Zero rx frags have been posted to BE */
305 } ____cacheline_aligned_in_smp;
306
307 struct be_drv_stats {
308         u32 eth_red_drops;
309         u32 dma_map_errors;
310         u32 rx_drops_no_pbuf;
311         u32 rx_drops_no_txpb;
312         u32 rx_drops_no_erx_descr;
313         u32 rx_drops_no_tpre_descr;
314         u32 rx_drops_too_many_frags;
315         u32 forwarded_packets;
316         u32 rx_drops_mtu;
317         u32 rx_crc_errors;
318         u32 rx_alignment_symbol_errors;
319         u32 rx_pause_frames;
320         u32 rx_priority_pause_frames;
321         u32 rx_control_frames;
322         u32 rx_in_range_errors;
323         u32 rx_out_range_errors;
324         u32 rx_frame_too_long;
325         u32 rx_address_filtered;
326         u32 rx_dropped_too_small;
327         u32 rx_dropped_too_short;
328         u32 rx_dropped_header_too_small;
329         u32 rx_dropped_tcp_length;
330         u32 rx_dropped_runt;
331         u32 rx_ip_checksum_errs;
332         u32 rx_tcp_checksum_errs;
333         u32 rx_udp_checksum_errs;
334         u32 tx_pauseframes;
335         u32 tx_priority_pauseframes;
336         u32 tx_controlframes;
337         u32 rxpp_fifo_overflow_drop;
338         u32 rx_input_fifo_overflow_drop;
339         u32 pmem_fifo_overflow_drop;
340         u32 jabber_events;
341         u32 rx_roce_bytes_lsd;
342         u32 rx_roce_bytes_msd;
343         u32 rx_roce_frames;
344         u32 roce_drops_payload_len;
345         u32 roce_drops_crc;
346 };
347
348 /* A vlan-id of 0xFFFF must be used to clear transparent vlan-tagging */
349 #define BE_RESET_VLAN_TAG_ID    0xFFFF
350
351 struct be_vf_cfg {
352         unsigned char mac_addr[ETH_ALEN];
353         int if_handle;
354         int pmac_id;
355         u16 vlan_tag;
356         u32 tx_rate;
357         u32 plink_tracking;
358         u32 privileges;
359         bool spoofchk;
360 };
361
362 enum vf_state {
363         ENABLED = 0,
364         ASSIGNED = 1
365 };
366
367 #define BE_FLAGS_LINK_STATUS_INIT               BIT(1)
368 #define BE_FLAGS_SRIOV_ENABLED                  BIT(2)
369 #define BE_FLAGS_WORKER_SCHEDULED               BIT(3)
370 #define BE_FLAGS_NAPI_ENABLED                   BIT(6)
371 #define BE_FLAGS_QNQ_ASYNC_EVT_RCVD             BIT(7)
372 #define BE_FLAGS_VXLAN_OFFLOADS                 BIT(8)
373 #define BE_FLAGS_SETUP_DONE                     BIT(9)
374 #define BE_FLAGS_PHY_MISCONFIGURED              BIT(10)
375 #define BE_FLAGS_ERR_DETECTION_SCHEDULED        BIT(11)
376 #define BE_FLAGS_OS2BMC                         BIT(12)
377 #define BE_FLAGS_TRY_RECOVERY                   BIT(13)
378
379 #define BE_UC_PMAC_COUNT                        30
380 #define BE_VF_UC_PMAC_COUNT                     2
381
382 #define MAX_ERR_RECOVERY_RETRY_COUNT            3
383 #define ERR_DETECTION_DELAY                     1000
384
385 /* Ethtool set_dump flags */
386 #define LANCER_INITIATE_FW_DUMP                 0x1
387 #define LANCER_DELETE_FW_DUMP                   0x2
388
389 struct phy_info {
390 /* From SFF-8472 spec */
391 #define SFP_VENDOR_NAME_LEN                     17
392         u8 transceiver;
393         u8 autoneg;
394         u8 fc_autoneg;
395         u8 port_type;
396         u16 phy_type;
397         u16 interface_type;
398         u32 misc_params;
399         u16 auto_speeds_supported;
400         u16 fixed_speeds_supported;
401         int link_speed;
402         u32 advertising;
403         u32 supported;
404         u8 cable_type;
405         u8 vendor_name[SFP_VENDOR_NAME_LEN];
406         u8 vendor_pn[SFP_VENDOR_NAME_LEN];
407 };
408
409 struct be_resources {
410         u16 max_vfs;            /* Total VFs "really" supported by FW/HW */
411         u16 max_mcast_mac;
412         u16 max_tx_qs;
413         u16 max_rss_qs;
414         u16 max_rx_qs;
415         u16 max_cq_count;
416         u16 max_uc_mac;         /* Max UC MACs programmable */
417         u16 max_vlans;          /* Number of vlans supported */
418         u16 max_iface_count;
419         u16 max_mcc_count;
420         u16 max_evt_qs;
421         u16 max_nic_evt_qs;     /* NIC's share of evt qs */
422         u32 if_cap_flags;
423         u32 vf_if_cap_flags;    /* VF if capability flags */
424         u32 flags;
425         /* Calculated PF Pool's share of RSS Tables. This is not enforced by
426          * the FW, but is a self-imposed driver limitation.
427          */
428         u16 max_rss_tables;
429 };
430
431 /* These are port-wide values */
432 struct be_port_resources {
433         u16 max_vfs;
434         u16 nic_pfs;
435 };
436
437 #define be_is_os2bmc_enabled(adapter) (adapter->flags & BE_FLAGS_OS2BMC)
438
439 struct rss_info {
440         u8 rsstable[RSS_INDIR_TABLE_LEN];
441         u8 rss_queue[RSS_INDIR_TABLE_LEN];
442         u8 rss_hkey[RSS_HASH_KEY_LEN];
443         u64 rss_flags;
444 };
445
446 #define BE_INVALID_DIE_TEMP     0xFF
447 struct be_hwmon {
448         struct device *hwmon_dev;
449         u8 be_on_die_temp;  /* Unit: millidegree Celsius */
450 };
451
452 /* Macros to read/write the 'features' word of be_wrb_params structure.
453  */
454 #define BE_WRB_F_BIT(name)                      BE_WRB_F_##name##_BIT
455 #define BE_WRB_F_MASK(name)                     BIT_MASK(BE_WRB_F_##name##_BIT)
456
457 #define BE_WRB_F_GET(word, name)        \
458         (((word) & (BE_WRB_F_MASK(name))) >> BE_WRB_F_BIT(name))
459
460 #define BE_WRB_F_SET(word, name, val)   \
461         ((word) |= (((val) << BE_WRB_F_BIT(name)) & BE_WRB_F_MASK(name)))
462
463 /* Feature/offload bits */
464 enum {
465         BE_WRB_F_CRC_BIT,               /* Ethernet CRC */
466         BE_WRB_F_IPCS_BIT,              /* IP csum */
467         BE_WRB_F_TCPCS_BIT,             /* TCP csum */
468         BE_WRB_F_UDPCS_BIT,             /* UDP csum */
469         BE_WRB_F_LSO_BIT,               /* LSO */
470         BE_WRB_F_LSO6_BIT,              /* LSO6 */
471         BE_WRB_F_VLAN_BIT,              /* VLAN */
472         BE_WRB_F_VLAN_SKIP_HW_BIT,      /* Skip VLAN tag (workaround) */
473         BE_WRB_F_OS2BMC_BIT             /* Send packet to the management ring */
474 };
475
476 /* The structure below provides a HW-agnostic abstraction of WRB params
477  * retrieved from a TX skb. This is in turn passed to chip specific routines
478  * during transmit, to set the corresponding params in the WRB.
479  */
480 struct be_wrb_params {
481         u32 features;   /* Feature bits */
482         u16 vlan_tag;   /* VLAN tag */
483         u16 lso_mss;    /* MSS for LSO */
484 };
485
486 struct be_eth_addr {
487         unsigned char mac[ETH_ALEN];
488 };
489
490 #define BE_SEC  1000                    /* in msec */
491 #define BE_MIN  (60 * BE_SEC)           /* in msec */
492 #define BE_HOUR (60 * BE_MIN)           /* in msec */
493
494 #define ERR_RECOVERY_MAX_RETRY_COUNT            3
495 #define ERR_RECOVERY_DETECTION_DELAY            BE_SEC
496 #define ERR_RECOVERY_RETRY_DELAY                (30 * BE_SEC)
497
498 /* UE-detection-duration in BEx/Skyhawk:
499  * All PFs must wait for this duration after they detect UE before reading
500  * SLIPORT_SEMAPHORE register. At the end of this duration, the Firmware
501  * guarantees that the SLIPORT_SEMAPHORE register is updated to indicate
502  * if the UE is recoverable.
503  */
504 #define ERR_RECOVERY_UE_DETECT_DURATION                 BE_SEC
505
506 /* Initial idle time (in msec) to elapse after driver load,
507  * before UE recovery is allowed.
508  */
509 #define ERR_IDLE_HR                     24
510 #define ERR_RECOVERY_IDLE_TIME          (ERR_IDLE_HR * BE_HOUR)
511
512 /* Time interval (in msec) after which UE recovery can be repeated */
513 #define ERR_INTERVAL_HR                 72
514 #define ERR_RECOVERY_INTERVAL           (ERR_INTERVAL_HR * BE_HOUR)
515
516 /* BEx/SH UE recovery state machine */
517 enum {
518         ERR_RECOVERY_ST_NONE = 0,               /* No Recovery */
519         ERR_RECOVERY_ST_DETECT = 1,             /* UE detection duration */
520         ERR_RECOVERY_ST_RESET = 2,              /* Reset Phase (PF0 only) */
521         ERR_RECOVERY_ST_PRE_POLL = 3,           /* Pre-Poll Phase (all PFs) */
522         ERR_RECOVERY_ST_REINIT = 4              /* Re-initialize Phase */
523 };
524
525 struct be_error_recovery {
526         union {
527                 u8 recovery_retries;    /* used for Lancer              */
528                 u8 recovery_state;      /* used for BEx and Skyhawk     */
529         };
530
531         /* BEx/Skyhawk error recovery variables */
532         bool recovery_supported;
533         u16 ue_to_reset_time;           /* Time after UE, to soft reset
534                                          * the chip - PF0 only
535                                          */
536         u16 ue_to_poll_time;            /* Time after UE, to Restart Polling
537                                          * of SLIPORT_SEMAPHORE reg
538                                          */
539         u16 last_err_code;
540         unsigned long probe_time;
541         unsigned long last_recovery_time;
542
543         /* Common to both Lancer & BEx/SH error recovery */
544         u32 resched_delay;
545         struct delayed_work err_detection_work;
546 };
547
548 /* Ethtool priv_flags */
549 #define BE_DISABLE_TPE_RECOVERY 0x1
550
551 struct be_vxlan_port {
552         struct list_head list;
553         __be16 port;            /* VxLAN UDP dst port */
554         int port_aliases;       /* alias count */
555 };
556
557 struct be_adapter {
558         struct pci_dev *pdev;
559         struct net_device *netdev;
560
561         u8 __iomem *csr;        /* CSR BAR used only for BE2/3 */
562         u8 __iomem *db;         /* Door Bell */
563         u8 __iomem *pcicfg;     /* On SH,BEx only. Shadow of PCI config space */
564
565         struct mutex mbox_lock; /* For serializing mbox cmds to BE card */
566         struct be_dma_mem mbox_mem;
567         /* Mbox mem is adjusted to align to 16 bytes. The allocated addr
568          * is stored for freeing purpose */
569         struct be_dma_mem mbox_mem_alloced;
570
571         struct be_mcc_obj mcc_obj;
572         struct mutex mcc_lock;  /* For serializing mcc cmds to BE card */
573         spinlock_t mcc_cq_lock;
574
575         u16 cfg_num_rx_irqs;            /* configured via set-channels */
576         u16 cfg_num_tx_irqs;            /* configured via set-channels */
577         u16 num_evt_qs;
578         u16 num_msix_vec;
579         struct be_eq_obj eq_obj[MAX_EVT_QS];
580         struct msix_entry msix_entries[MAX_MSIX_VECTORS];
581         bool isr_registered;
582
583         /* TX Rings */
584         u16 num_tx_qs;
585         struct be_tx_obj tx_obj[MAX_TX_QS];
586
587         /* Rx rings */
588         u16 num_rx_qs;
589         u16 num_rss_qs;
590         u16 need_def_rxq;
591         struct be_rx_obj rx_obj[MAX_RX_QS];
592         u32 big_page_size;      /* Compounded page size shared by rx wrbs */
593
594         struct be_drv_stats drv_stats;
595         struct be_aic_obj aic_obj[MAX_EVT_QS];
596         u8 vlan_prio_bmap;      /* Available Priority BitMap */
597         u16 recommended_prio_bits;/* Recommended Priority bits in vlan tag */
598         struct be_dma_mem rx_filter; /* Cmd DMA mem for rx-filter */
599
600         struct be_dma_mem stats_cmd;
601         /* Work queue used to perform periodic tasks like getting statistics */
602         struct delayed_work work;
603         u16 work_counter;
604
605         u8 recovery_retries;
606         u8 err_flags;
607         bool pcicfg_mapped;     /* pcicfg obtained via pci_iomap() */
608         u32 flags;
609         u32 cmd_privileges;
610         /* Ethtool knobs and info */
611         char fw_ver[FW_VER_LEN];
612         char fw_on_flash[FW_VER_LEN];
613
614         /* IFACE filtering fields */
615         int if_handle;          /* Used to configure filtering */
616         u32 if_flags;           /* Interface filtering flags */
617         u32 *pmac_id;           /* MAC addr handle used by BE card */
618         struct be_eth_addr *uc_list;/* list of uc-addrs programmed (not perm) */
619         u32 uc_macs;            /* Count of secondary UC MAC programmed */
620         struct be_eth_addr *mc_list;/* list of mcast addrs programmed */
621         u32 mc_count;
622         unsigned long vids[BITS_TO_LONGS(VLAN_N_VID)];
623         u16 vlans_added;
624         bool update_uc_list;
625         bool update_mc_list;
626         struct mutex rx_filter_lock;/* For protecting vids[] & mc/uc_list[] */
627
628         u32 beacon_state;       /* for set_phys_id */
629
630         u32 port_num;
631         char port_name;
632         u8 mc_type;
633         u32 function_mode;
634         u32 function_caps;
635         u32 rx_fc;              /* Rx flow control */
636         u32 tx_fc;              /* Tx flow control */
637         bool stats_cmd_sent;
638         struct {
639                 u32 size;
640                 u32 total_size;
641                 u64 io_addr;
642         } roce_db;
643         u32 num_msix_roce_vec;
644         struct ocrdma_dev *ocrdma_dev;
645         struct list_head entry;
646
647         u32 flash_status;
648         struct completion et_cmd_compl;
649
650         struct be_resources pool_res;   /* resources available for the port */
651         struct be_resources res;        /* resources available for the func */
652         u16 num_vfs;                    /* Number of VFs provisioned by PF */
653         u8 pf_num;                      /* Numbering used by FW, starts at 0 */
654         u8 vf_num;                      /* Numbering used by FW, starts at 1 */
655         u8 virtfn;
656         struct be_vf_cfg *vf_cfg;
657         bool be3_native;
658         u32 sli_family;
659         u8 hba_port_num;
660         u16 pvid;
661         __be16 vxlan_port;              /* offloaded vxlan port num */
662         int vxlan_port_count;           /* active vxlan port count */
663         struct list_head vxlan_port_list;       /* vxlan port list */
664         struct phy_info phy;
665         u8 wol_cap;
666         bool wol_en;
667         u16 asic_rev;
668         u16 qnq_vid;
669         u32 msg_enable;
670         int be_get_temp_freq;
671         struct be_hwmon hwmon_info;
672         struct rss_info rss_info;
673         /* Filters for packets that need to be sent to BMC */
674         u32 bmc_filt_mask;
675         u32 fat_dump_len;
676         u16 serial_num[CNTL_SERIAL_NUM_WORDS];
677         u8 phy_state; /* state of sfp optics (functional, faulted, etc.,) */
678         u8 dev_mac[ETH_ALEN];
679         u32 priv_flags; /* ethtool get/set_priv_flags() */
680         struct be_error_recovery error_recovery;
681 };
682
683 /* Used for defered FW config cmds. Add fields to this struct as reqd */
684 struct be_cmd_work {
685         struct work_struct work;
686         struct be_adapter *adapter;
687         union {
688                 __be16 vxlan_port;
689         } info;
690 };
691
692 #define be_physfn(adapter)              (!adapter->virtfn)
693 #define be_virtfn(adapter)              (adapter->virtfn)
694 #define sriov_enabled(adapter)          (adapter->flags &       \
695                                          BE_FLAGS_SRIOV_ENABLED)
696
697 #define for_all_vfs(adapter, vf_cfg, i)                                 \
698         for (i = 0, vf_cfg = &adapter->vf_cfg[i]; i < adapter->num_vfs; \
699                 i++, vf_cfg++)
700
701 #define ON                              1
702 #define OFF                             0
703
704 #define be_max_vlans(adapter)           (adapter->res.max_vlans)
705 #define be_max_uc(adapter)              (adapter->res.max_uc_mac)
706 #define be_max_mc(adapter)              (adapter->res.max_mcast_mac)
707 #define be_max_vfs(adapter)             (adapter->pool_res.max_vfs)
708 #define be_max_rss(adapter)             (adapter->res.max_rss_qs)
709 #define be_max_txqs(adapter)            (adapter->res.max_tx_qs)
710 #define be_max_prio_txqs(adapter)       (adapter->res.max_prio_tx_qs)
711 #define be_max_rxqs(adapter)            (adapter->res.max_rx_qs)
712 /* Max number of EQs available for the function (NIC + RoCE (if enabled)) */
713 #define be_max_func_eqs(adapter)        (adapter->res.max_evt_qs)
714 /* Max number of EQs available avaialble only for NIC */
715 #define be_max_nic_eqs(adapter)         (adapter->res.max_nic_evt_qs)
716 #define be_if_cap_flags(adapter)        (adapter->res.if_cap_flags)
717 #define be_max_pf_pool_rss_tables(adapter)      \
718                                 (adapter->pool_res.max_rss_tables)
719 /* Max irqs avaialble for NIC */
720 #define be_max_irqs(adapter)            \
721                         (min_t(u16, be_max_nic_eqs(adapter), num_online_cpus()))
722
723 /* Max irqs *needed* for RX queues */
724 static inline u16 be_max_rx_irqs(struct be_adapter *adapter)
725 {
726         /* If no RSS, need atleast one irq for def-RXQ */
727         u16 num = max_t(u16, be_max_rss(adapter), 1);
728
729         return min_t(u16, num, be_max_irqs(adapter));
730 }
731
732 /* Max irqs *needed* for TX queues */
733 static inline u16 be_max_tx_irqs(struct be_adapter *adapter)
734 {
735         return min_t(u16, be_max_txqs(adapter), be_max_irqs(adapter));
736 }
737
738 /* Max irqs *needed* for combined queues */
739 static inline u16 be_max_qp_irqs(struct be_adapter *adapter)
740 {
741         return min(be_max_tx_irqs(adapter), be_max_rx_irqs(adapter));
742 }
743
744 /* Max irqs *needed* for RX and TX queues together */
745 static inline u16 be_max_any_irqs(struct be_adapter *adapter)
746 {
747         return max(be_max_tx_irqs(adapter), be_max_rx_irqs(adapter));
748 }
749
750 /* Is BE in pvid_tagging mode */
751 #define be_pvid_tagging_enabled(adapter)        (adapter->pvid)
752
753 /* Is BE in QNQ multi-channel mode */
754 #define be_is_qnq_mode(adapter)         (adapter->function_mode & QNQ_MODE)
755
756 #ifdef CONFIG_BE2NET_LANCER
757 #define lancer_chip(adapter)    (adapter->pdev->device == OC_DEVICE_ID3 || \
758                                  adapter->pdev->device == OC_DEVICE_ID4)
759 #else
760 #define lancer_chip(adapter)    (0)
761 #endif /* CONFIG_BE2NET_LANCER */
762
763 #ifdef CONFIG_BE2NET_SKYHAWK
764 #define skyhawk_chip(adapter)   (adapter->pdev->device == OC_DEVICE_ID5 || \
765                                  adapter->pdev->device == OC_DEVICE_ID6)
766 #else
767 #define skyhawk_chip(adapter)   (0)
768 #endif /* CONFIG_BE2NET_SKYHAWK */
769
770 #ifdef CONFIG_BE2NET_BE3
771 #define BE3_chip(adapter)       (adapter->pdev->device == BE_DEVICE_ID2 || \
772                                  adapter->pdev->device == OC_DEVICE_ID2)
773 #else
774 #define BE3_chip(adapter)       (0)
775 #endif /* CONFIG_BE2NET_BE3 */
776
777 #ifdef CONFIG_BE2NET_BE2
778 #define BE2_chip(adapter)       (adapter->pdev->device == BE_DEVICE_ID1 || \
779                                  adapter->pdev->device == OC_DEVICE_ID1)
780 #else
781 #define BE2_chip(adapter)       (0)
782 #endif /* CONFIG_BE2NET_BE2 */
783
784 #define BEx_chip(adapter)       (BE3_chip(adapter) || BE2_chip(adapter))
785
786 #define be_roce_supported(adapter)      (skyhawk_chip(adapter) && \
787                                         (adapter->function_mode & RDMA_ENABLED))
788
789 extern const struct ethtool_ops be_ethtool_ops;
790
791 #define msix_enabled(adapter)           (adapter->num_msix_vec > 0)
792 #define num_irqs(adapter)               (msix_enabled(adapter) ?        \
793                                                 adapter->num_msix_vec : 1)
794 #define tx_stats(txo)                   (&(txo)->stats)
795 #define rx_stats(rxo)                   (&(rxo)->stats)
796
797 /* The default RXQ is the last RXQ */
798 #define default_rxo(adpt)               (&adpt->rx_obj[adpt->num_rx_qs - 1])
799
800 #define for_all_rx_queues(adapter, rxo, i)                              \
801         for (i = 0, rxo = &adapter->rx_obj[i]; i < adapter->num_rx_qs;  \
802                 i++, rxo++)
803
804 #define for_all_rss_queues(adapter, rxo, i)                             \
805         for (i = 0, rxo = &adapter->rx_obj[i]; i < adapter->num_rss_qs; \
806                 i++, rxo++)
807
808 #define for_all_tx_queues(adapter, txo, i)                              \
809         for (i = 0, txo = &adapter->tx_obj[i]; i < adapter->num_tx_qs;  \
810                 i++, txo++)
811
812 #define for_all_evt_queues(adapter, eqo, i)                             \
813         for (i = 0, eqo = &adapter->eq_obj[i]; i < adapter->num_evt_qs; \
814                 i++, eqo++)
815
816 #define for_all_rx_queues_on_eq(adapter, eqo, rxo, i)                   \
817         for (i = eqo->idx, rxo = &adapter->rx_obj[i]; i < adapter->num_rx_qs;\
818                  i += adapter->num_evt_qs, rxo += adapter->num_evt_qs)
819
820 #define for_all_tx_queues_on_eq(adapter, eqo, txo, i)                   \
821         for (i = eqo->idx, txo = &adapter->tx_obj[i]; i < adapter->num_tx_qs;\
822                 i += adapter->num_evt_qs, txo += adapter->num_evt_qs)
823
824 #define is_mcc_eqo(eqo)                 (eqo->idx == 0)
825 #define mcc_eqo(adapter)                (&adapter->eq_obj[0])
826
827 #define PAGE_SHIFT_4K           12
828 #define PAGE_SIZE_4K            (1 << PAGE_SHIFT_4K)
829
830 /* Returns number of pages spanned by the data starting at the given addr */
831 #define PAGES_4K_SPANNED(_address, size)                                \
832                 ((u32)((((size_t)(_address) & (PAGE_SIZE_4K - 1)) +     \
833                         (size) + (PAGE_SIZE_4K - 1)) >> PAGE_SHIFT_4K))
834
835 /* Returns bit offset within a DWORD of a bitfield */
836 #define AMAP_BIT_OFFSET(_struct, field)                                 \
837                 (((size_t)&(((_struct *)0)->field))%32)
838
839 /* Returns the bit mask of the field that is NOT shifted into location. */
840 static inline u32 amap_mask(u32 bitsize)
841 {
842         return (bitsize == 32 ? 0xFFFFFFFF : (1 << bitsize) - 1);
843 }
844
845 static inline void
846 amap_set(void *ptr, u32 dw_offset, u32 mask, u32 offset, u32 value)
847 {
848         u32 *dw = (u32 *) ptr + dw_offset;
849         *dw &= ~(mask << offset);
850         *dw |= (mask & value) << offset;
851 }
852
853 #define AMAP_SET_BITS(_struct, field, ptr, val)                         \
854                 amap_set(ptr,                                           \
855                         offsetof(_struct, field)/32,                    \
856                         amap_mask(sizeof(((_struct *)0)->field)),       \
857                         AMAP_BIT_OFFSET(_struct, field),                \
858                         val)
859
860 static inline u32 amap_get(void *ptr, u32 dw_offset, u32 mask, u32 offset)
861 {
862         u32 *dw = (u32 *) ptr;
863         return mask & (*(dw + dw_offset) >> offset);
864 }
865
866 #define AMAP_GET_BITS(_struct, field, ptr)                              \
867                 amap_get(ptr,                                           \
868                         offsetof(_struct, field)/32,                    \
869                         amap_mask(sizeof(((_struct *)0)->field)),       \
870                         AMAP_BIT_OFFSET(_struct, field))
871
872 #define GET_RX_COMPL_V0_BITS(field, ptr)                                \
873                 AMAP_GET_BITS(struct amap_eth_rx_compl_v0, field, ptr)
874
875 #define GET_RX_COMPL_V1_BITS(field, ptr)                                \
876                 AMAP_GET_BITS(struct amap_eth_rx_compl_v1, field, ptr)
877
878 #define GET_TX_COMPL_BITS(field, ptr)                                   \
879                 AMAP_GET_BITS(struct amap_eth_tx_compl, field, ptr)
880
881 #define SET_TX_WRB_HDR_BITS(field, ptr, val)                            \
882                 AMAP_SET_BITS(struct amap_eth_hdr_wrb, field, ptr, val)
883
884 #define be_dws_cpu_to_le(wrb, len)      swap_dws(wrb, len)
885 #define be_dws_le_to_cpu(wrb, len)      swap_dws(wrb, len)
886 static inline void swap_dws(void *wrb, int len)
887 {
888 #ifdef __BIG_ENDIAN
889         u32 *dw = wrb;
890         BUG_ON(len % 4);
891         do {
892                 *dw = cpu_to_le32(*dw);
893                 dw++;
894                 len -= 4;
895         } while (len);
896 #endif                          /* __BIG_ENDIAN */
897 }
898
899 #define be_cmd_status(status)           (status > 0 ? -EIO : status)
900
901 static inline u8 is_tcp_pkt(struct sk_buff *skb)
902 {
903         u8 val = 0;
904
905         if (ip_hdr(skb)->version == 4)
906                 val = (ip_hdr(skb)->protocol == IPPROTO_TCP);
907         else if (ip_hdr(skb)->version == 6)
908                 val = (ipv6_hdr(skb)->nexthdr == NEXTHDR_TCP);
909
910         return val;
911 }
912
913 static inline u8 is_udp_pkt(struct sk_buff *skb)
914 {
915         u8 val = 0;
916
917         if (ip_hdr(skb)->version == 4)
918                 val = (ip_hdr(skb)->protocol == IPPROTO_UDP);
919         else if (ip_hdr(skb)->version == 6)
920                 val = (ipv6_hdr(skb)->nexthdr == NEXTHDR_UDP);
921
922         return val;
923 }
924
925 static inline bool is_ipv4_pkt(struct sk_buff *skb)
926 {
927         return skb->protocol == htons(ETH_P_IP) && ip_hdr(skb)->version == 4;
928 }
929
930 static inline bool is_ipv6_ext_hdr(struct sk_buff *skb)
931 {
932         if (ip_hdr(skb)->version == 6)
933                 return ipv6_ext_hdr(ipv6_hdr(skb)->nexthdr);
934         else
935                 return false;
936 }
937
938 #define be_error_recovering(adapter)    \
939                 (adapter->flags & BE_FLAGS_TRY_RECOVERY)
940
941 #define BE_ERROR_EEH            1
942 #define BE_ERROR_UE             BIT(1)
943 #define BE_ERROR_FW             BIT(2)
944 #define BE_ERROR_TX             BIT(3)
945 #define BE_ERROR_HW             (BE_ERROR_EEH | BE_ERROR_UE | BE_ERROR_TX)
946 #define BE_ERROR_ANY            (BE_ERROR_EEH | BE_ERROR_UE | BE_ERROR_FW | \
947                                  BE_ERROR_TX)
948 #define BE_CLEAR_ALL            0xFF
949
950 static inline u8 be_check_error(struct be_adapter *adapter, u32 err_type)
951 {
952         return (adapter->err_flags & err_type);
953 }
954
955 static inline void be_set_error(struct be_adapter *adapter, int err_type)
956 {
957         struct net_device *netdev = adapter->netdev;
958
959         adapter->err_flags |= err_type;
960         netif_carrier_off(netdev);
961
962         dev_info(&adapter->pdev->dev, "%s: Link down\n", netdev->name);
963 }
964
965 static inline void  be_clear_error(struct be_adapter *adapter, int err_type)
966 {
967         adapter->err_flags &= ~err_type;
968 }
969
970 static inline bool be_multi_rxq(const struct be_adapter *adapter)
971 {
972         return adapter->num_rx_qs > 1;
973 }
974
975 void be_cq_notify(struct be_adapter *adapter, u16 qid, bool arm,
976                   u16 num_popped);
977 void be_link_status_update(struct be_adapter *adapter, u8 link_status);
978 void be_parse_stats(struct be_adapter *adapter);
979 int be_load_fw(struct be_adapter *adapter, u8 *func);
980 bool be_is_wol_supported(struct be_adapter *adapter);
981 bool be_pause_supported(struct be_adapter *adapter);
982 u32 be_get_fw_log_level(struct be_adapter *adapter);
983 int be_update_queues(struct be_adapter *adapter);
984 int be_poll(struct napi_struct *napi, int budget);
985 void be_eqd_update(struct be_adapter *adapter, bool force_update);
986
987 /*
988  * internal function to initialize-cleanup roce device.
989  */
990 void be_roce_dev_add(struct be_adapter *);
991 void be_roce_dev_remove(struct be_adapter *);
992
993 /*
994  * internal function to open-close roce device during ifup-ifdown.
995  */
996 void be_roce_dev_shutdown(struct be_adapter *);
997
998 #endif                          /* BE_H */