xref: /linux/drivers/net/ethernet/intel/i40e/i40e.h (revision 98838d95075a5295f3478ceba18bcccf472e30f4)
1 /*******************************************************************************
2  *
3  * Intel Ethernet Controller XL710 Family Linux Driver
4  * Copyright(c) 2013 - 2016 Intel Corporation.
5  *
6  * This program is free software; you can redistribute it and/or modify it
7  * under the terms and conditions of the GNU General Public License,
8  * version 2, as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope it will be useful, but WITHOUT
11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
13  * more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program.  If not, see <http://www.gnu.org/licenses/>.
17  *
18  * The full GNU General Public License is included in this distribution in
19  * the file called "COPYING".
20  *
21  * Contact Information:
22  * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
23  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
24  *
25  ******************************************************************************/
26 
27 #ifndef _I40E_H_
28 #define _I40E_H_
29 
30 #include <net/tcp.h>
31 #include <net/udp.h>
32 #include <linux/types.h>
33 #include <linux/errno.h>
34 #include <linux/module.h>
35 #include <linux/pci.h>
36 #include <linux/aer.h>
37 #include <linux/netdevice.h>
38 #include <linux/ioport.h>
39 #include <linux/iommu.h>
40 #include <linux/slab.h>
41 #include <linux/list.h>
42 #include <linux/string.h>
43 #include <linux/in.h>
44 #include <linux/ip.h>
45 #include <linux/sctp.h>
46 #include <linux/pkt_sched.h>
47 #include <linux/ipv6.h>
48 #include <net/checksum.h>
49 #include <net/ip6_checksum.h>
50 #include <linux/ethtool.h>
51 #include <linux/if_vlan.h>
52 #include <linux/if_bridge.h>
53 #include <linux/clocksource.h>
54 #include <linux/net_tstamp.h>
55 #include <linux/ptp_clock_kernel.h>
56 #include "i40e_type.h"
57 #include "i40e_prototype.h"
58 #ifdef I40E_FCOE
59 #include "i40e_fcoe.h"
60 #endif
61 #include "i40e_client.h"
62 #include "i40e_virtchnl.h"
63 #include "i40e_virtchnl_pf.h"
64 #include "i40e_txrx.h"
65 #include "i40e_dcb.h"
66 
67 /* Useful i40e defaults */
68 #define I40E_MAX_VEB			16
69 
70 #define I40E_MAX_NUM_DESCRIPTORS	4096
71 #define I40E_MAX_CSR_SPACE		(4 * 1024 * 1024 - 64 * 1024)
72 #define I40E_DEFAULT_NUM_DESCRIPTORS	512
73 #define I40E_REQ_DESCRIPTOR_MULTIPLE	32
74 #define I40E_MIN_NUM_DESCRIPTORS	64
75 #define I40E_MIN_MSIX			2
76 #define I40E_DEFAULT_NUM_VMDQ_VSI	8 /* max 256 VSIs */
77 #define I40E_MIN_VSI_ALLOC		83 /* LAN, ATR, FCOE, 64 VF */
78 /* max 16 qps */
79 #define i40e_default_queues_per_vmdq(pf) \
80 		(((pf)->flags & I40E_FLAG_RSS_AQ_CAPABLE) ? 4 : 1)
81 #define I40E_DEFAULT_QUEUES_PER_VF	4
82 #define I40E_DEFAULT_QUEUES_PER_TC	1 /* should be a power of 2 */
83 #define i40e_pf_get_max_q_per_tc(pf) \
84 		(((pf)->flags & I40E_FLAG_128_QP_RSS_CAPABLE) ? 128 : 64)
85 #define I40E_FDIR_RING			0
86 #define I40E_FDIR_RING_COUNT		32
87 #ifdef I40E_FCOE
88 #define I40E_DEFAULT_FCOE		8 /* default number of QPs for FCoE */
89 #define I40E_MINIMUM_FCOE		1 /* minimum number of QPs for FCoE */
90 #endif /* I40E_FCOE */
91 #define I40E_MAX_AQ_BUF_SIZE		4096
92 #define I40E_AQ_LEN			256
93 #define I40E_AQ_WORK_LIMIT		66 /* max number of VFs + a little */
94 #define I40E_MAX_USER_PRIORITY		8
95 #define I40E_DEFAULT_MSG_ENABLE		4
96 #define I40E_QUEUE_WAIT_RETRY_LIMIT	10
97 #define I40E_INT_NAME_STR_LEN		(IFNAMSIZ + 16)
98 
99 /* Ethtool Private Flags */
100 #define I40E_PRIV_FLAGS_MFP_FLAG		BIT(0)
101 #define I40E_PRIV_FLAGS_LINKPOLL_FLAG		BIT(1)
102 #define I40E_PRIV_FLAGS_FD_ATR			BIT(2)
103 #define I40E_PRIV_FLAGS_VEB_STATS		BIT(3)
104 #define I40E_PRIV_FLAGS_HW_ATR_EVICT		BIT(4)
105 #define I40E_PRIV_FLAGS_TRUE_PROMISC_SUPPORT	BIT(5)
106 
107 #define I40E_NVM_VERSION_LO_SHIFT	0
108 #define I40E_NVM_VERSION_LO_MASK	(0xff << I40E_NVM_VERSION_LO_SHIFT)
109 #define I40E_NVM_VERSION_HI_SHIFT	12
110 #define I40E_NVM_VERSION_HI_MASK	(0xf << I40E_NVM_VERSION_HI_SHIFT)
111 #define I40E_OEM_VER_BUILD_MASK		0xffff
112 #define I40E_OEM_VER_PATCH_MASK		0xff
113 #define I40E_OEM_VER_BUILD_SHIFT	8
114 #define I40E_OEM_VER_SHIFT		24
115 #define I40E_PHY_DEBUG_ALL \
116 	(I40E_AQ_PHY_DEBUG_DISABLE_LINK_FW | \
117 	I40E_AQ_PHY_DEBUG_DISABLE_ALL_LINK_FW)
118 
119 /* The values in here are decimal coded as hex as is the case in the NVM map*/
120 #define I40E_CURRENT_NVM_VERSION_HI	0x2
121 #define I40E_CURRENT_NVM_VERSION_LO	0x40
122 
123 #define I40E_RX_DESC(R, i)	\
124 	(&(((union i40e_32byte_rx_desc *)((R)->desc))[i]))
125 #define I40E_TX_DESC(R, i)	\
126 	(&(((struct i40e_tx_desc *)((R)->desc))[i]))
127 #define I40E_TX_CTXTDESC(R, i)	\
128 	(&(((struct i40e_tx_context_desc *)((R)->desc))[i]))
129 #define I40E_TX_FDIRDESC(R, i)	\
130 	(&(((struct i40e_filter_program_desc *)((R)->desc))[i]))
131 
132 /* default to trying for four seconds */
133 #define I40E_TRY_LINK_TIMEOUT	(4 * HZ)
134 
135 /**
136  * i40e_is_mac_710 - Return true if MAC is X710/XL710
137  * @hw: ptr to the hardware info
138  **/
139 static inline bool i40e_is_mac_710(struct i40e_hw *hw)
140 {
141 	if ((hw->mac.type == I40E_MAC_X710) ||
142 	    (hw->mac.type == I40E_MAC_XL710))
143 		return true;
144 
145 	return false;
146 }
147 
148 /* driver state flags */
149 enum i40e_state_t {
150 	__I40E_TESTING,
151 	__I40E_CONFIG_BUSY,
152 	__I40E_CONFIG_DONE,
153 	__I40E_DOWN,
154 	__I40E_NEEDS_RESTART,
155 	__I40E_SERVICE_SCHED,
156 	__I40E_ADMINQ_EVENT_PENDING,
157 	__I40E_MDD_EVENT_PENDING,
158 	__I40E_VFLR_EVENT_PENDING,
159 	__I40E_RESET_RECOVERY_PENDING,
160 	__I40E_RESET_INTR_RECEIVED,
161 	__I40E_REINIT_REQUESTED,
162 	__I40E_PF_RESET_REQUESTED,
163 	__I40E_CORE_RESET_REQUESTED,
164 	__I40E_GLOBAL_RESET_REQUESTED,
165 	__I40E_EMP_RESET_REQUESTED,
166 	__I40E_EMP_RESET_INTR_RECEIVED,
167 	__I40E_FILTER_OVERFLOW_PROMISC,
168 	__I40E_SUSPENDED,
169 	__I40E_PTP_TX_IN_PROGRESS,
170 	__I40E_BAD_EEPROM,
171 	__I40E_DOWN_REQUESTED,
172 	__I40E_FD_FLUSH_REQUESTED,
173 	__I40E_RESET_FAILED,
174 	__I40E_PORT_TX_SUSPENDED,
175 	__I40E_VF_DISABLE,
176 };
177 
178 enum i40e_interrupt_policy {
179 	I40E_INTERRUPT_BEST_CASE,
180 	I40E_INTERRUPT_MEDIUM,
181 	I40E_INTERRUPT_LOWEST
182 };
183 
184 struct i40e_lump_tracking {
185 	u16 num_entries;
186 	u16 search_hint;
187 	u16 list[0];
188 #define I40E_PILE_VALID_BIT  0x8000
189 #define I40E_IWARP_IRQ_PILE_ID  (I40E_PILE_VALID_BIT - 2)
190 };
191 
192 #define I40E_DEFAULT_ATR_SAMPLE_RATE	20
193 #define I40E_FDIR_MAX_RAW_PACKET_SIZE	512
194 #define I40E_FDIR_BUFFER_FULL_MARGIN	10
195 #define I40E_FDIR_BUFFER_HEAD_ROOM	32
196 #define I40E_FDIR_BUFFER_HEAD_ROOM_FOR_ATR (I40E_FDIR_BUFFER_HEAD_ROOM * 4)
197 
198 #define I40E_HKEY_ARRAY_SIZE	((I40E_PFQF_HKEY_MAX_INDEX + 1) * 4)
199 #define I40E_HLUT_ARRAY_SIZE	((I40E_PFQF_HLUT_MAX_INDEX + 1) * 4)
200 #define I40E_VF_HLUT_ARRAY_SIZE	((I40E_VFQF_HLUT1_MAX_INDEX + 1) * 4)
201 
202 enum i40e_fd_stat_idx {
203 	I40E_FD_STAT_ATR,
204 	I40E_FD_STAT_SB,
205 	I40E_FD_STAT_ATR_TUNNEL,
206 	I40E_FD_STAT_PF_COUNT
207 };
208 #define I40E_FD_STAT_PF_IDX(pf_id) ((pf_id) * I40E_FD_STAT_PF_COUNT)
209 #define I40E_FD_ATR_STAT_IDX(pf_id) \
210 			(I40E_FD_STAT_PF_IDX(pf_id) + I40E_FD_STAT_ATR)
211 #define I40E_FD_SB_STAT_IDX(pf_id)  \
212 			(I40E_FD_STAT_PF_IDX(pf_id) + I40E_FD_STAT_SB)
213 #define I40E_FD_ATR_TUNNEL_STAT_IDX(pf_id) \
214 			(I40E_FD_STAT_PF_IDX(pf_id) + I40E_FD_STAT_ATR_TUNNEL)
215 
216 struct i40e_fdir_filter {
217 	struct hlist_node fdir_node;
218 	/* filter ipnut set */
219 	u8 flow_type;
220 	u8 ip4_proto;
221 	/* TX packet view of src and dst */
222 	__be32 dst_ip[4];
223 	__be32 src_ip[4];
224 	__be16 src_port;
225 	__be16 dst_port;
226 	__be32 sctp_v_tag;
227 	/* filter control */
228 	u16 q_index;
229 	u8  flex_off;
230 	u8  pctype;
231 	u16 dest_vsi;
232 	u8  dest_ctl;
233 	u8  fd_status;
234 	u16 cnt_index;
235 	u32 fd_id;
236 };
237 
238 #define I40E_ETH_P_LLDP			0x88cc
239 
240 #define I40E_DCB_PRIO_TYPE_STRICT	0
241 #define I40E_DCB_PRIO_TYPE_ETS		1
242 #define I40E_DCB_STRICT_PRIO_CREDITS	127
243 /* DCB per TC information data structure */
244 struct i40e_tc_info {
245 	u16	qoffset;	/* Queue offset from base queue */
246 	u16	qcount;		/* Total Queues */
247 	u8	netdev_tc;	/* Netdev TC index if netdev associated */
248 };
249 
250 /* TC configuration data structure */
251 struct i40e_tc_configuration {
252 	u8	numtc;		/* Total number of enabled TCs */
253 	u8	enabled_tc;	/* TC map */
254 	struct i40e_tc_info tc_info[I40E_MAX_TRAFFIC_CLASS];
255 };
256 
257 struct i40e_udp_port_config {
258 	__be16 index;
259 	u8 type;
260 };
261 
262 /* struct that defines the Ethernet device */
263 struct i40e_pf {
264 	struct pci_dev *pdev;
265 	struct i40e_hw hw;
266 	unsigned long state;
267 	struct msix_entry *msix_entries;
268 	bool fc_autoneg_status;
269 
270 	u16 eeprom_version;
271 	u16 num_vmdq_vsis;         /* num vmdq vsis this PF has set up */
272 	u16 num_vmdq_qps;          /* num queue pairs per vmdq pool */
273 	u16 num_vmdq_msix;         /* num queue vectors per vmdq pool */
274 	u16 num_req_vfs;           /* num VFs requested for this VF */
275 	u16 num_vf_qps;            /* num queue pairs per VF */
276 #ifdef I40E_FCOE
277 	u16 num_fcoe_qps;          /* num fcoe queues this PF has set up */
278 	u16 num_fcoe_msix;         /* num queue vectors per fcoe pool */
279 #endif /* I40E_FCOE */
280 	u16 num_lan_qps;           /* num lan queues this PF has set up */
281 	u16 num_lan_msix;          /* num queue vectors for the base PF vsi */
282 	u16 num_fdsb_msix;         /* num queue vectors for sideband Fdir */
283 	u16 num_iwarp_msix;        /* num of iwarp vectors for this PF */
284 	int iwarp_base_vector;
285 	int queues_left;           /* queues left unclaimed */
286 	u16 alloc_rss_size;        /* allocated RSS queues */
287 	u16 rss_size_max;          /* HW defined max RSS queues */
288 	u16 fdir_pf_filter_count;  /* num of guaranteed filters for this PF */
289 	u16 num_alloc_vsi;         /* num VSIs this driver supports */
290 	u8 atr_sample_rate;
291 	bool wol_en;
292 
293 	struct hlist_head fdir_filter_list;
294 	u16 fdir_pf_active_filters;
295 	unsigned long fd_flush_timestamp;
296 	u32 fd_flush_cnt;
297 	u32 fd_add_err;
298 	u32 fd_atr_cnt;
299 	u32 fd_tcp_rule;
300 
301 	struct i40e_udp_port_config udp_ports[I40E_MAX_PF_UDP_OFFLOAD_PORTS];
302 	u16 pending_udp_bitmap;
303 
304 	enum i40e_interrupt_policy int_policy;
305 	u16 rx_itr_default;
306 	u16 tx_itr_default;
307 	u32 msg_enable;
308 	char int_name[I40E_INT_NAME_STR_LEN];
309 	u16 adminq_work_limit; /* num of admin receive queue desc to process */
310 	unsigned long service_timer_period;
311 	unsigned long service_timer_previous;
312 	struct timer_list service_timer;
313 	struct work_struct service_task;
314 
315 	u64 flags;
316 #define I40E_FLAG_RX_CSUM_ENABLED		BIT_ULL(1)
317 #define I40E_FLAG_MSI_ENABLED			BIT_ULL(2)
318 #define I40E_FLAG_MSIX_ENABLED			BIT_ULL(3)
319 #define I40E_FLAG_RSS_ENABLED			BIT_ULL(6)
320 #define I40E_FLAG_VMDQ_ENABLED			BIT_ULL(7)
321 #define I40E_FLAG_FDIR_REQUIRES_REINIT		BIT_ULL(8)
322 #define I40E_FLAG_NEED_LINK_UPDATE		BIT_ULL(9)
323 #define I40E_FLAG_IWARP_ENABLED			BIT_ULL(10)
324 #ifdef I40E_FCOE
325 #define I40E_FLAG_FCOE_ENABLED			BIT_ULL(11)
326 #endif /* I40E_FCOE */
327 #define I40E_FLAG_CLEAN_ADMINQ			BIT_ULL(14)
328 #define I40E_FLAG_FILTER_SYNC			BIT_ULL(15)
329 #define I40E_FLAG_SERVICE_CLIENT_REQUESTED	BIT_ULL(16)
330 #define I40E_FLAG_PROCESS_MDD_EVENT		BIT_ULL(17)
331 #define I40E_FLAG_PROCESS_VFLR_EVENT		BIT_ULL(18)
332 #define I40E_FLAG_SRIOV_ENABLED			BIT_ULL(19)
333 #define I40E_FLAG_DCB_ENABLED			BIT_ULL(20)
334 #define I40E_FLAG_FD_SB_ENABLED			BIT_ULL(21)
335 #define I40E_FLAG_FD_ATR_ENABLED		BIT_ULL(22)
336 #define I40E_FLAG_PTP				BIT_ULL(25)
337 #define I40E_FLAG_MFP_ENABLED			BIT_ULL(26)
338 #define I40E_FLAG_UDP_FILTER_SYNC		BIT_ULL(27)
339 #define I40E_FLAG_PORT_ID_VALID			BIT_ULL(28)
340 #define I40E_FLAG_DCB_CAPABLE			BIT_ULL(29)
341 #define I40E_FLAG_RSS_AQ_CAPABLE		BIT_ULL(31)
342 #define I40E_FLAG_HW_ATR_EVICT_CAPABLE		BIT_ULL(32)
343 #define I40E_FLAG_OUTER_UDP_CSUM_CAPABLE	BIT_ULL(33)
344 #define I40E_FLAG_128_QP_RSS_CAPABLE		BIT_ULL(34)
345 #define I40E_FLAG_WB_ON_ITR_CAPABLE		BIT_ULL(35)
346 #define I40E_FLAG_VEB_STATS_ENABLED		BIT_ULL(37)
347 #define I40E_FLAG_MULTIPLE_TCP_UDP_RSS_PCTYPE	BIT_ULL(38)
348 #define I40E_FLAG_LINK_POLLING_ENABLED		BIT_ULL(39)
349 #define I40E_FLAG_VEB_MODE_ENABLED		BIT_ULL(40)
350 #define I40E_FLAG_GENEVE_OFFLOAD_CAPABLE	BIT_ULL(41)
351 #define I40E_FLAG_NO_PCI_LINK_CHECK		BIT_ULL(42)
352 #define I40E_FLAG_100M_SGMII_CAPABLE		BIT_ULL(43)
353 #define I40E_FLAG_RESTART_AUTONEG		BIT_ULL(44)
354 #define I40E_FLAG_NO_DCB_SUPPORT		BIT_ULL(45)
355 #define I40E_FLAG_USE_SET_LLDP_MIB		BIT_ULL(46)
356 #define I40E_FLAG_STOP_FW_LLDP			BIT_ULL(47)
357 #define I40E_FLAG_HAVE_10GBASET_PHY		BIT_ULL(48)
358 #define I40E_FLAG_PF_MAC			BIT_ULL(50)
359 #define I40E_FLAG_TRUE_PROMISC_SUPPORT		BIT_ULL(51)
360 
361 	/* tracks features that get auto disabled by errors */
362 	u64 auto_disable_flags;
363 
364 #ifdef I40E_FCOE
365 	struct i40e_fcoe fcoe;
366 
367 #endif /* I40E_FCOE */
368 	bool stat_offsets_loaded;
369 	struct i40e_hw_port_stats stats;
370 	struct i40e_hw_port_stats stats_offsets;
371 	u32 tx_timeout_count;
372 	u32 tx_timeout_recovery_level;
373 	unsigned long tx_timeout_last_recovery;
374 	u32 tx_sluggish_count;
375 	u32 hw_csum_rx_error;
376 	u32 led_status;
377 	u16 corer_count; /* Core reset count */
378 	u16 globr_count; /* Global reset count */
379 	u16 empr_count; /* EMP reset count */
380 	u16 pfr_count; /* PF reset count */
381 	u16 sw_int_count; /* SW interrupt count */
382 
383 	struct mutex switch_mutex;
384 	u16 lan_vsi;       /* our default LAN VSI */
385 	u16 lan_veb;       /* initial relay, if exists */
386 #define I40E_NO_VEB	0xffff
387 #define I40E_NO_VSI	0xffff
388 	u16 next_vsi;      /* Next unallocated VSI - 0-based! */
389 	struct i40e_vsi **vsi;
390 	struct i40e_veb *veb[I40E_MAX_VEB];
391 
392 	struct i40e_lump_tracking *qp_pile;
393 	struct i40e_lump_tracking *irq_pile;
394 
395 	/* switch config info */
396 	u16 pf_seid;
397 	u16 main_vsi_seid;
398 	u16 mac_seid;
399 	struct kobject *switch_kobj;
400 #ifdef CONFIG_DEBUG_FS
401 	struct dentry *i40e_dbg_pf;
402 #endif /* CONFIG_DEBUG_FS */
403 	bool cur_promisc;
404 
405 	u16 instance; /* A unique number per i40e_pf instance in the system */
406 
407 	/* sr-iov config info */
408 	struct i40e_vf *vf;
409 	int num_alloc_vfs;	/* actual number of VFs allocated */
410 	u32 vf_aq_requests;
411 	u32 arq_overflows;	/* Not fatal, possibly indicative of problems */
412 
413 	/* DCBx/DCBNL capability for PF that indicates
414 	 * whether DCBx is managed by firmware or host
415 	 * based agent (LLDPAD). Also, indicates what
416 	 * flavor of DCBx protocol (IEEE/CEE) is supported
417 	 * by the device. For now we're supporting IEEE
418 	 * mode only.
419 	 */
420 	u16 dcbx_cap;
421 
422 	u32 fcoe_hmc_filt_num;
423 	u32 fcoe_hmc_cntx_num;
424 	struct i40e_filter_control_settings filter_settings;
425 
426 	struct ptp_clock *ptp_clock;
427 	struct ptp_clock_info ptp_caps;
428 	struct sk_buff *ptp_tx_skb;
429 	struct hwtstamp_config tstamp_config;
430 	unsigned long last_rx_ptp_check;
431 	spinlock_t tmreg_lock; /* Used to protect the device time registers. */
432 	u64 ptp_base_adj;
433 	u32 tx_hwtstamp_timeouts;
434 	u32 rx_hwtstamp_cleared;
435 	bool ptp_tx;
436 	bool ptp_rx;
437 	u16 rss_table_size; /* HW RSS table size */
438 	/* These are only valid in NPAR modes */
439 	u32 npar_max_bw;
440 	u32 npar_min_bw;
441 
442 	u32 ioremap_len;
443 	u32 fd_inv;
444 	u16 phy_led_val;
445 };
446 
447 enum i40e_filter_state {
448 	I40E_FILTER_INVALID = 0,	/* Invalid state */
449 	I40E_FILTER_NEW,		/* New, not sent to FW yet */
450 	I40E_FILTER_ACTIVE,		/* Added to switch by FW */
451 	I40E_FILTER_FAILED,		/* Rejected by FW */
452 	I40E_FILTER_REMOVE,		/* To be removed */
453 /* There is no 'removed' state; the filter struct is freed */
454 };
455 struct i40e_mac_filter {
456 	struct list_head list;
457 	u8 macaddr[ETH_ALEN];
458 #define I40E_VLAN_ANY -1
459 	s16 vlan;
460 	u8 counter;		/* number of instances of this filter */
461 	bool is_vf;		/* filter belongs to a VF */
462 	bool is_netdev;		/* filter belongs to a netdev */
463 	enum i40e_filter_state state;
464 };
465 
466 struct i40e_veb {
467 	struct i40e_pf *pf;
468 	u16 idx;
469 	u16 veb_idx;		/* index of VEB parent */
470 	u16 seid;
471 	u16 uplink_seid;
472 	u16 stats_idx;		/* index of VEB parent */
473 	u8  enabled_tc;
474 	u16 bridge_mode;	/* Bridge Mode (VEB/VEPA) */
475 	u16 flags;
476 	u16 bw_limit;
477 	u8  bw_max_quanta;
478 	bool is_abs_credits;
479 	u8  bw_tc_share_credits[I40E_MAX_TRAFFIC_CLASS];
480 	u16 bw_tc_limit_credits[I40E_MAX_TRAFFIC_CLASS];
481 	u8  bw_tc_max_quanta[I40E_MAX_TRAFFIC_CLASS];
482 	struct kobject *kobj;
483 	bool stat_offsets_loaded;
484 	struct i40e_eth_stats stats;
485 	struct i40e_eth_stats stats_offsets;
486 	struct i40e_veb_tc_stats tc_stats;
487 	struct i40e_veb_tc_stats tc_stats_offsets;
488 };
489 
490 /* struct that defines a VSI, associated with a dev */
491 struct i40e_vsi {
492 	struct net_device *netdev;
493 	unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
494 	bool netdev_registered;
495 	bool stat_offsets_loaded;
496 
497 	u32 current_netdev_flags;
498 	unsigned long state;
499 #define I40E_VSI_FLAG_FILTER_CHANGED	BIT(0)
500 #define I40E_VSI_FLAG_VEB_OWNER		BIT(1)
501 	unsigned long flags;
502 
503 	/* Per VSI lock to protect elements/list (MAC filter) */
504 	spinlock_t mac_filter_list_lock;
505 	struct list_head mac_filter_list;
506 
507 	/* VSI stats */
508 	struct rtnl_link_stats64 net_stats;
509 	struct rtnl_link_stats64 net_stats_offsets;
510 	struct i40e_eth_stats eth_stats;
511 	struct i40e_eth_stats eth_stats_offsets;
512 #ifdef I40E_FCOE
513 	struct i40e_fcoe_stats fcoe_stats;
514 	struct i40e_fcoe_stats fcoe_stats_offsets;
515 	bool fcoe_stat_offsets_loaded;
516 #endif
517 	u32 tx_restart;
518 	u32 tx_busy;
519 	u64 tx_linearize;
520 	u64 tx_force_wb;
521 	u64 tx_lost_interrupt;
522 	u32 rx_buf_failed;
523 	u32 rx_page_failed;
524 
525 	/* These are containers of ring pointers, allocated at run-time */
526 	struct i40e_ring **rx_rings;
527 	struct i40e_ring **tx_rings;
528 
529 	u32  active_filters;
530 	u32  promisc_threshold;
531 
532 	u16 work_limit;
533 	u16 int_rate_limit;	/* value in usecs */
534 
535 	u16 rss_table_size;	/* HW RSS table size */
536 	u16 rss_size;		/* Allocated RSS queues */
537 	u8  *rss_hkey_user;	/* User configured hash keys */
538 	u8  *rss_lut_user;	/* User configured lookup table entries */
539 
540 
541 	u16 max_frame;
542 	u16 rx_buf_len;
543 
544 	/* List of q_vectors allocated to this VSI */
545 	struct i40e_q_vector **q_vectors;
546 	int num_q_vectors;
547 	int base_vector;
548 	bool irqs_ready;
549 
550 	u16 seid;		/* HW index of this VSI (absolute index) */
551 	u16 id;			/* VSI number */
552 	u16 uplink_seid;
553 
554 	u16 base_queue;		/* vsi's first queue in hw array */
555 	u16 alloc_queue_pairs;	/* Allocated Tx/Rx queues */
556 	u16 req_queue_pairs;	/* User requested queue pairs */
557 	u16 num_queue_pairs;	/* Used tx and rx pairs */
558 	u16 num_desc;
559 	enum i40e_vsi_type type;  /* VSI type, e.g., LAN, FCoE, etc */
560 	s16 vf_id;		/* Virtual function ID for SRIOV VSIs */
561 
562 	struct i40e_tc_configuration tc_config;
563 	struct i40e_aqc_vsi_properties_data info;
564 
565 	/* VSI BW limit (absolute across all TCs) */
566 	u16 bw_limit;		/* VSI BW Limit (0 = disabled) */
567 	u8  bw_max_quanta;	/* Max Quanta when BW limit is enabled */
568 
569 	/* Relative TC credits across VSIs */
570 	u8  bw_ets_share_credits[I40E_MAX_TRAFFIC_CLASS];
571 	/* TC BW limit credits within VSI */
572 	u16  bw_ets_limit_credits[I40E_MAX_TRAFFIC_CLASS];
573 	/* TC BW limit max quanta within VSI */
574 	u8  bw_ets_max_quanta[I40E_MAX_TRAFFIC_CLASS];
575 
576 	struct i40e_pf *back;	/* Backreference to associated PF */
577 	u16 idx;		/* index in pf->vsi[] */
578 	u16 veb_idx;		/* index of VEB parent */
579 	struct kobject *kobj;	/* sysfs object */
580 	bool current_isup;	/* Sync 'link up' logging */
581 
582 	void *priv;	/* client driver data reference. */
583 
584 	/* VSI specific handlers */
585 	irqreturn_t (*irq_handler)(int irq, void *data);
586 } ____cacheline_internodealigned_in_smp;
587 
588 struct i40e_netdev_priv {
589 	struct i40e_vsi *vsi;
590 };
591 
592 /* struct that defines an interrupt vector */
593 struct i40e_q_vector {
594 	struct i40e_vsi *vsi;
595 
596 	u16 v_idx;		/* index in the vsi->q_vector array. */
597 	u16 reg_idx;		/* register index of the interrupt */
598 
599 	struct napi_struct napi;
600 
601 	struct i40e_ring_container rx;
602 	struct i40e_ring_container tx;
603 
604 	u8 num_ringpairs;	/* total number of ring pairs in vector */
605 
606 #define I40E_Q_VECTOR_HUNG_DETECT 0 /* Bit Index for hung detection logic */
607 	unsigned long hung_detected; /* Set/Reset for hung_detection logic */
608 
609 	cpumask_t affinity_mask;
610 	struct rcu_head rcu;	/* to avoid race with update stats on free */
611 	char name[I40E_INT_NAME_STR_LEN];
612 	bool arm_wb_state;
613 #define ITR_COUNTDOWN_START 100
614 	u8 itr_countdown;	/* when 0 should adjust ITR */
615 } ____cacheline_internodealigned_in_smp;
616 
617 /* lan device */
618 struct i40e_device {
619 	struct list_head list;
620 	struct i40e_pf *pf;
621 };
622 
623 /**
624  * i40e_nvm_version_str - format the NVM version strings
625  * @hw: ptr to the hardware info
626  **/
627 static inline char *i40e_nvm_version_str(struct i40e_hw *hw)
628 {
629 	static char buf[32];
630 	u32 full_ver;
631 	u8 ver, patch;
632 	u16 build;
633 
634 	full_ver = hw->nvm.oem_ver;
635 	ver = (u8)(full_ver >> I40E_OEM_VER_SHIFT);
636 	build = (u16)((full_ver >> I40E_OEM_VER_BUILD_SHIFT) &
637 		 I40E_OEM_VER_BUILD_MASK);
638 	patch = (u8)(full_ver & I40E_OEM_VER_PATCH_MASK);
639 
640 	snprintf(buf, sizeof(buf),
641 		 "%x.%02x 0x%x %d.%d.%d",
642 		 (hw->nvm.version & I40E_NVM_VERSION_HI_MASK) >>
643 			I40E_NVM_VERSION_HI_SHIFT,
644 		 (hw->nvm.version & I40E_NVM_VERSION_LO_MASK) >>
645 			I40E_NVM_VERSION_LO_SHIFT,
646 		 hw->nvm.eetrack, ver, build, patch);
647 
648 	return buf;
649 }
650 
651 /**
652  * i40e_netdev_to_pf: Retrieve the PF struct for given netdev
653  * @netdev: the corresponding netdev
654  *
655  * Return the PF struct for the given netdev
656  **/
657 static inline struct i40e_pf *i40e_netdev_to_pf(struct net_device *netdev)
658 {
659 	struct i40e_netdev_priv *np = netdev_priv(netdev);
660 	struct i40e_vsi *vsi = np->vsi;
661 
662 	return vsi->back;
663 }
664 
665 static inline void i40e_vsi_setup_irqhandler(struct i40e_vsi *vsi,
666 				irqreturn_t (*irq_handler)(int, void *))
667 {
668 	vsi->irq_handler = irq_handler;
669 }
670 
671 /**
672  * i40e_rx_is_programming_status - check for programming status descriptor
673  * @qw: the first quad word of the program status descriptor
674  *
675  * The value of in the descriptor length field indicate if this
676  * is a programming status descriptor for flow director or FCoE
677  * by the value of I40E_RX_PROG_STATUS_DESC_LENGTH, otherwise
678  * it is a packet descriptor.
679  **/
680 static inline bool i40e_rx_is_programming_status(u64 qw)
681 {
682 	return I40E_RX_PROG_STATUS_DESC_LENGTH ==
683 		(qw >> I40E_RX_PROG_STATUS_DESC_LENGTH_SHIFT);
684 }
685 
686 /**
687  * i40e_get_fd_cnt_all - get the total FD filter space available
688  * @pf: pointer to the PF struct
689  **/
690 static inline int i40e_get_fd_cnt_all(struct i40e_pf *pf)
691 {
692 	return pf->hw.fdir_shared_filter_count + pf->fdir_pf_filter_count;
693 }
694 
695 /* needed by i40e_ethtool.c */
696 int i40e_up(struct i40e_vsi *vsi);
697 void i40e_down(struct i40e_vsi *vsi);
698 extern const char i40e_driver_name[];
699 extern const char i40e_driver_version_str[];
700 void i40e_do_reset_safe(struct i40e_pf *pf, u32 reset_flags);
701 void i40e_do_reset(struct i40e_pf *pf, u32 reset_flags);
702 int i40e_config_rss(struct i40e_vsi *vsi, u8 *seed, u8 *lut, u16 lut_size);
703 int i40e_get_rss(struct i40e_vsi *vsi, u8 *seed, u8 *lut, u16 lut_size);
704 void i40e_fill_rss_lut(struct i40e_pf *pf, u8 *lut,
705 		       u16 rss_table_size, u16 rss_size);
706 struct i40e_vsi *i40e_find_vsi_from_id(struct i40e_pf *pf, u16 id);
707 void i40e_update_stats(struct i40e_vsi *vsi);
708 void i40e_update_eth_stats(struct i40e_vsi *vsi);
709 struct rtnl_link_stats64 *i40e_get_vsi_stats_struct(struct i40e_vsi *vsi);
710 int i40e_fetch_switch_configuration(struct i40e_pf *pf,
711 				    bool printconfig);
712 
713 int i40e_add_del_fdir(struct i40e_vsi *vsi,
714 		      struct i40e_fdir_filter *input, bool add);
715 void i40e_fdir_check_and_reenable(struct i40e_pf *pf);
716 u32 i40e_get_current_fd_count(struct i40e_pf *pf);
717 u32 i40e_get_cur_guaranteed_fd_count(struct i40e_pf *pf);
718 u32 i40e_get_current_atr_cnt(struct i40e_pf *pf);
719 u32 i40e_get_global_fd_count(struct i40e_pf *pf);
720 bool i40e_set_ntuple(struct i40e_pf *pf, netdev_features_t features);
721 void i40e_set_ethtool_ops(struct net_device *netdev);
722 struct i40e_mac_filter *i40e_add_filter(struct i40e_vsi *vsi,
723 					u8 *macaddr, s16 vlan,
724 					bool is_vf, bool is_netdev);
725 void i40e_del_filter(struct i40e_vsi *vsi, u8 *macaddr, s16 vlan,
726 		     bool is_vf, bool is_netdev);
727 int i40e_sync_vsi_filters(struct i40e_vsi *vsi);
728 struct i40e_vsi *i40e_vsi_setup(struct i40e_pf *pf, u8 type,
729 				u16 uplink, u32 param1);
730 int i40e_vsi_release(struct i40e_vsi *vsi);
731 struct i40e_vsi *i40e_vsi_lookup(struct i40e_pf *pf, enum i40e_vsi_type type,
732 				 struct i40e_vsi *start_vsi);
733 #ifdef I40E_FCOE
734 void i40e_vsi_setup_queue_map(struct i40e_vsi *vsi,
735 			      struct i40e_vsi_context *ctxt,
736 			      u8 enabled_tc, bool is_add);
737 #endif
738 void i40e_service_event_schedule(struct i40e_pf *pf);
739 void i40e_notify_client_of_vf_msg(struct i40e_vsi *vsi, u32 vf_id,
740 				  u8 *msg, u16 len);
741 
742 int i40e_vsi_control_rings(struct i40e_vsi *vsi, bool enable);
743 int i40e_reconfig_rss_queues(struct i40e_pf *pf, int queue_count);
744 struct i40e_veb *i40e_veb_setup(struct i40e_pf *pf, u16 flags, u16 uplink_seid,
745 				u16 downlink_seid, u8 enabled_tc);
746 void i40e_veb_release(struct i40e_veb *veb);
747 
748 int i40e_veb_config_tc(struct i40e_veb *veb, u8 enabled_tc);
749 int i40e_vsi_add_pvid(struct i40e_vsi *vsi, u16 vid);
750 void i40e_vsi_remove_pvid(struct i40e_vsi *vsi);
751 void i40e_vsi_reset_stats(struct i40e_vsi *vsi);
752 void i40e_pf_reset_stats(struct i40e_pf *pf);
753 #ifdef CONFIG_DEBUG_FS
754 void i40e_dbg_pf_init(struct i40e_pf *pf);
755 void i40e_dbg_pf_exit(struct i40e_pf *pf);
756 void i40e_dbg_init(void);
757 void i40e_dbg_exit(void);
758 #else
759 static inline void i40e_dbg_pf_init(struct i40e_pf *pf) {}
760 static inline void i40e_dbg_pf_exit(struct i40e_pf *pf) {}
761 static inline void i40e_dbg_init(void) {}
762 static inline void i40e_dbg_exit(void) {}
763 #endif /* CONFIG_DEBUG_FS*/
764 /* needed by client drivers */
765 int i40e_lan_add_device(struct i40e_pf *pf);
766 int i40e_lan_del_device(struct i40e_pf *pf);
767 void i40e_client_subtask(struct i40e_pf *pf);
768 void i40e_notify_client_of_l2_param_changes(struct i40e_vsi *vsi);
769 void i40e_notify_client_of_netdev_open(struct i40e_vsi *vsi);
770 void i40e_notify_client_of_netdev_close(struct i40e_vsi *vsi, bool reset);
771 void i40e_notify_client_of_vf_enable(struct i40e_pf *pf, u32 num_vfs);
772 void i40e_notify_client_of_vf_reset(struct i40e_pf *pf, u32 vf_id);
773 int i40e_vf_client_capable(struct i40e_pf *pf, u32 vf_id,
774 			   enum i40e_client_type type);
775 /**
776  * i40e_irq_dynamic_enable - Enable default interrupt generation settings
777  * @vsi: pointer to a vsi
778  * @vector: enable a particular Hw Interrupt vector, without base_vector
779  **/
780 static inline void i40e_irq_dynamic_enable(struct i40e_vsi *vsi, int vector)
781 {
782 	struct i40e_pf *pf = vsi->back;
783 	struct i40e_hw *hw = &pf->hw;
784 	u32 val;
785 
786 	/* definitely clear the PBA here, as this function is meant to
787 	 * clean out all previous interrupts AND enable the interrupt
788 	 */
789 	val = I40E_PFINT_DYN_CTLN_INTENA_MASK |
790 	      I40E_PFINT_DYN_CTLN_CLEARPBA_MASK |
791 	      (I40E_ITR_NONE << I40E_PFINT_DYN_CTLN_ITR_INDX_SHIFT);
792 	wr32(hw, I40E_PFINT_DYN_CTLN(vector + vsi->base_vector - 1), val);
793 	/* skip the flush */
794 }
795 
796 void i40e_irq_dynamic_disable_icr0(struct i40e_pf *pf);
797 void i40e_irq_dynamic_enable_icr0(struct i40e_pf *pf, bool clearpba);
798 #ifdef I40E_FCOE
799 struct rtnl_link_stats64 *i40e_get_netdev_stats_struct(
800 					     struct net_device *netdev,
801 					     struct rtnl_link_stats64 *storage);
802 int i40e_set_mac(struct net_device *netdev, void *p);
803 void i40e_set_rx_mode(struct net_device *netdev);
804 #endif
805 int i40e_ioctl(struct net_device *netdev, struct ifreq *ifr, int cmd);
806 #ifdef I40E_FCOE
807 void i40e_tx_timeout(struct net_device *netdev);
808 int i40e_vlan_rx_add_vid(struct net_device *netdev,
809 			 __always_unused __be16 proto, u16 vid);
810 int i40e_vlan_rx_kill_vid(struct net_device *netdev,
811 			  __always_unused __be16 proto, u16 vid);
812 #endif
813 int i40e_open(struct net_device *netdev);
814 int i40e_close(struct net_device *netdev);
815 int i40e_vsi_open(struct i40e_vsi *vsi);
816 void i40e_vlan_stripping_disable(struct i40e_vsi *vsi);
817 int i40e_vsi_add_vlan(struct i40e_vsi *vsi, s16 vid);
818 int i40e_vsi_kill_vlan(struct i40e_vsi *vsi, s16 vid);
819 struct i40e_mac_filter *i40e_put_mac_in_vlan(struct i40e_vsi *vsi, u8 *macaddr,
820 					     bool is_vf, bool is_netdev);
821 int i40e_del_mac_all_vlan(struct i40e_vsi *vsi, u8 *macaddr,
822 			  bool is_vf, bool is_netdev);
823 bool i40e_is_vsi_in_vlan(struct i40e_vsi *vsi);
824 struct i40e_mac_filter *i40e_find_mac(struct i40e_vsi *vsi, u8 *macaddr,
825 				      bool is_vf, bool is_netdev);
826 #ifdef I40E_FCOE
827 int __i40e_setup_tc(struct net_device *netdev, u32 handle, __be16 proto,
828 		    struct tc_to_netdev *tc);
829 void i40e_netpoll(struct net_device *netdev);
830 int i40e_fcoe_enable(struct net_device *netdev);
831 int i40e_fcoe_disable(struct net_device *netdev);
832 int i40e_fcoe_vsi_init(struct i40e_vsi *vsi, struct i40e_vsi_context *ctxt);
833 u8 i40e_get_fcoe_tc_map(struct i40e_pf *pf);
834 void i40e_fcoe_config_netdev(struct net_device *netdev, struct i40e_vsi *vsi);
835 void i40e_fcoe_vsi_setup(struct i40e_pf *pf);
836 void i40e_init_pf_fcoe(struct i40e_pf *pf);
837 int i40e_fcoe_setup_ddp_resources(struct i40e_vsi *vsi);
838 void i40e_fcoe_free_ddp_resources(struct i40e_vsi *vsi);
839 int i40e_fcoe_handle_offload(struct i40e_ring *rx_ring,
840 			     union i40e_rx_desc *rx_desc,
841 			     struct sk_buff *skb);
842 void i40e_fcoe_handle_status(struct i40e_ring *rx_ring,
843 			     union i40e_rx_desc *rx_desc, u8 prog_id);
844 #endif /* I40E_FCOE */
845 void i40e_vlan_stripping_enable(struct i40e_vsi *vsi);
846 #ifdef CONFIG_I40E_DCB
847 void i40e_dcbnl_flush_apps(struct i40e_pf *pf,
848 			   struct i40e_dcbx_config *old_cfg,
849 			   struct i40e_dcbx_config *new_cfg);
850 void i40e_dcbnl_set_all(struct i40e_vsi *vsi);
851 void i40e_dcbnl_setup(struct i40e_vsi *vsi);
852 bool i40e_dcb_need_reconfig(struct i40e_pf *pf,
853 			    struct i40e_dcbx_config *old_cfg,
854 			    struct i40e_dcbx_config *new_cfg);
855 #endif /* CONFIG_I40E_DCB */
856 void i40e_ptp_rx_hang(struct i40e_vsi *vsi);
857 void i40e_ptp_tx_hwtstamp(struct i40e_pf *pf);
858 void i40e_ptp_rx_hwtstamp(struct i40e_pf *pf, struct sk_buff *skb, u8 index);
859 void i40e_ptp_set_increment(struct i40e_pf *pf);
860 int i40e_ptp_set_ts_config(struct i40e_pf *pf, struct ifreq *ifr);
861 int i40e_ptp_get_ts_config(struct i40e_pf *pf, struct ifreq *ifr);
862 void i40e_ptp_init(struct i40e_pf *pf);
863 void i40e_ptp_stop(struct i40e_pf *pf);
864 int i40e_is_vsi_uplink_mode_veb(struct i40e_vsi *vsi);
865 i40e_status i40e_get_npar_bw_setting(struct i40e_pf *pf);
866 i40e_status i40e_set_npar_bw_setting(struct i40e_pf *pf);
867 i40e_status i40e_commit_npar_bw_setting(struct i40e_pf *pf);
868 void i40e_print_link_message(struct i40e_vsi *vsi, bool isup);
869 #endif /* _I40E_H_ */
870