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