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