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