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