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