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