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