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