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