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