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