]> git.karo-electronics.de Git - karo-tx-linux.git/blob - drivers/net/ethernet/intel/i40e/i40e.h
Merge branch '40GbE' of git://git.kernel.org/pub/scm/linux/kernel/git/jkirsher/next...
[karo-tx-linux.git] / drivers / net / ethernet / intel / i40e / i40e.h
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_CSR_SPACE (4 * 1024 * 1024 - 64 * 1024)
75 #define I40E_DEFAULT_NUM_DESCRIPTORS  512
76 #define I40E_REQ_DESCRIPTOR_MULTIPLE  32
77 #define I40E_MIN_NUM_DESCRIPTORS      64
78 #define I40E_MIN_MSIX                 2
79 #define I40E_DEFAULT_NUM_VMDQ_VSI     8 /* max 256 VSIs */
80 #define I40E_MIN_VSI_ALLOC            51 /* LAN, ATR, FCOE, 32 VF, 16 VMDQ */
81 /* max 16 qps */
82 #define i40e_default_queues_per_vmdq(pf) \
83                 (((pf)->flags & I40E_FLAG_RSS_AQ_CAPABLE) ? 4 : 1)
84 #define I40E_DEFAULT_QUEUES_PER_VF    4
85 #define I40E_DEFAULT_QUEUES_PER_TC    1 /* should be a power of 2 */
86 #define i40e_pf_get_max_q_per_tc(pf) \
87                 (((pf)->flags & I40E_FLAG_128_QP_RSS_CAPABLE) ? 128 : 64)
88 #define I40E_FDIR_RING                0
89 #define I40E_FDIR_RING_COUNT          32
90 #ifdef I40E_FCOE
91 #define I40E_DEFAULT_FCOE             8 /* default number of QPs for FCoE */
92 #define I40E_MINIMUM_FCOE             1 /* minimum number of QPs for FCoE */
93 #endif /* I40E_FCOE */
94 #define I40E_MAX_AQ_BUF_SIZE          4096
95 #define I40E_AQ_LEN                   256
96 #define I40E_AQ_WORK_LIMIT            66 /* max number of VFs + a little */
97 #define I40E_MAX_USER_PRIORITY        8
98 #define I40E_DEFAULT_MSG_ENABLE       4
99 #define I40E_QUEUE_WAIT_RETRY_LIMIT   10
100 #define I40E_INT_NAME_STR_LEN        (IFNAMSIZ + 16)
101
102 /* Ethtool Private Flags */
103 #define I40E_PRIV_FLAGS_NPAR_FLAG       BIT(0)
104 #define I40E_PRIV_FLAGS_LINKPOLL_FLAG   BIT(1)
105 #define I40E_PRIV_FLAGS_FD_ATR          BIT(2)
106 #define I40E_PRIV_FLAGS_VEB_STATS       BIT(3)
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 that defines the Ethernet device */
249 struct i40e_pf {
250         struct pci_dev *pdev;
251         struct i40e_hw hw;
252         unsigned long state;
253         struct msix_entry *msix_entries;
254         bool fc_autoneg_status;
255
256         u16 eeprom_version;
257         u16 num_vmdq_vsis;         /* num vmdq vsis this PF has set up */
258         u16 num_vmdq_qps;          /* num queue pairs per vmdq pool */
259         u16 num_vmdq_msix;         /* num queue vectors per vmdq pool */
260         u16 num_req_vfs;           /* num VFs requested for this VF */
261         u16 num_vf_qps;            /* num queue pairs per VF */
262 #ifdef I40E_FCOE
263         u16 num_fcoe_qps;          /* num fcoe queues this PF has set up */
264         u16 num_fcoe_msix;         /* num queue vectors per fcoe pool */
265 #endif /* I40E_FCOE */
266         u16 num_lan_qps;           /* num lan queues this PF has set up */
267         u16 num_lan_msix;          /* num queue vectors for the base PF vsi */
268         int queues_left;           /* queues left unclaimed */
269         u16 alloc_rss_size;        /* allocated RSS queues */
270         u16 rss_size_max;          /* HW defined max RSS queues */
271         u16 fdir_pf_filter_count;  /* num of guaranteed filters for this PF */
272         u16 num_alloc_vsi;         /* num VSIs this driver supports */
273         u8 atr_sample_rate;
274         bool wol_en;
275
276         struct hlist_head fdir_filter_list;
277         u16 fdir_pf_active_filters;
278         unsigned long fd_flush_timestamp;
279         u32 fd_flush_cnt;
280         u32 fd_add_err;
281         u32 fd_atr_cnt;
282         u32 fd_tcp_rule;
283
284 #ifdef CONFIG_I40E_VXLAN
285         __be16  vxlan_ports[I40E_MAX_PF_UDP_OFFLOAD_PORTS];
286         u16 pending_vxlan_bitmap;
287
288 #endif
289         enum i40e_interrupt_policy int_policy;
290         u16 rx_itr_default;
291         u16 tx_itr_default;
292         u32 msg_enable;
293         char int_name[I40E_INT_NAME_STR_LEN];
294         u16 adminq_work_limit; /* num of admin receive queue desc to process */
295         unsigned long service_timer_period;
296         unsigned long service_timer_previous;
297         struct timer_list service_timer;
298         struct work_struct service_task;
299
300         u64 flags;
301 #define I40E_FLAG_RX_CSUM_ENABLED               BIT_ULL(1)
302 #define I40E_FLAG_MSI_ENABLED                   BIT_ULL(2)
303 #define I40E_FLAG_MSIX_ENABLED                  BIT_ULL(3)
304 #define I40E_FLAG_RX_1BUF_ENABLED               BIT_ULL(4)
305 #define I40E_FLAG_RX_PS_ENABLED                 BIT_ULL(5)
306 #define I40E_FLAG_RSS_ENABLED                   BIT_ULL(6)
307 #define I40E_FLAG_VMDQ_ENABLED                  BIT_ULL(7)
308 #define I40E_FLAG_FDIR_REQUIRES_REINIT          BIT_ULL(8)
309 #define I40E_FLAG_NEED_LINK_UPDATE              BIT_ULL(9)
310 #define I40E_FLAG_IWARP_ENABLED                 BIT_ULL(10)
311 #ifdef I40E_FCOE
312 #define I40E_FLAG_FCOE_ENABLED                  BIT_ULL(11)
313 #endif /* I40E_FCOE */
314 #define I40E_FLAG_16BYTE_RX_DESC_ENABLED        BIT_ULL(13)
315 #define I40E_FLAG_CLEAN_ADMINQ                  BIT_ULL(14)
316 #define I40E_FLAG_FILTER_SYNC                   BIT_ULL(15)
317 #define I40E_FLAG_PROCESS_MDD_EVENT             BIT_ULL(17)
318 #define I40E_FLAG_PROCESS_VFLR_EVENT            BIT_ULL(18)
319 #define I40E_FLAG_SRIOV_ENABLED                 BIT_ULL(19)
320 #define I40E_FLAG_DCB_ENABLED                   BIT_ULL(20)
321 #define I40E_FLAG_FD_SB_ENABLED                 BIT_ULL(21)
322 #define I40E_FLAG_FD_ATR_ENABLED                BIT_ULL(22)
323 #define I40E_FLAG_PTP                           BIT_ULL(25)
324 #define I40E_FLAG_MFP_ENABLED                   BIT_ULL(26)
325 #ifdef CONFIG_I40E_VXLAN
326 #define I40E_FLAG_VXLAN_FILTER_SYNC             BIT_ULL(27)
327 #endif
328 #define I40E_FLAG_PORT_ID_VALID                 BIT_ULL(28)
329 #define I40E_FLAG_DCB_CAPABLE                   BIT_ULL(29)
330 #define I40E_FLAG_RSS_AQ_CAPABLE                BIT_ULL(31)
331 #define I40E_FLAG_HW_ATR_EVICT_CAPABLE          BIT_ULL(32)
332 #define I40E_FLAG_OUTER_UDP_CSUM_CAPABLE        BIT_ULL(33)
333 #define I40E_FLAG_128_QP_RSS_CAPABLE            BIT_ULL(34)
334 #define I40E_FLAG_WB_ON_ITR_CAPABLE             BIT_ULL(35)
335 #define I40E_FLAG_VEB_STATS_ENABLED             BIT_ULL(37)
336 #define I40E_FLAG_MULTIPLE_TCP_UDP_RSS_PCTYPE   BIT_ULL(38)
337 #define I40E_FLAG_LINK_POLLING_ENABLED          BIT_ULL(39)
338 #define I40E_FLAG_VEB_MODE_ENABLED              BIT_ULL(40)
339 #define I40E_FLAG_NO_PCI_LINK_CHECK             BIT_ULL(42)
340
341         /* tracks features that get auto disabled by errors */
342         u64 auto_disable_flags;
343
344 #ifdef I40E_FCOE
345         struct i40e_fcoe fcoe;
346
347 #endif /* I40E_FCOE */
348         bool stat_offsets_loaded;
349         struct i40e_hw_port_stats stats;
350         struct i40e_hw_port_stats stats_offsets;
351         u32 tx_timeout_count;
352         u32 tx_timeout_recovery_level;
353         unsigned long tx_timeout_last_recovery;
354         u32 tx_sluggish_count;
355         u32 hw_csum_rx_error;
356         u32 led_status;
357         u16 corer_count; /* Core reset count */
358         u16 globr_count; /* Global reset count */
359         u16 empr_count; /* EMP reset count */
360         u16 pfr_count; /* PF reset count */
361         u16 sw_int_count; /* SW interrupt count */
362
363         struct mutex switch_mutex;
364         u16 lan_vsi;       /* our default LAN VSI */
365         u16 lan_veb;       /* initial relay, if exists */
366 #define I40E_NO_VEB   0xffff
367 #define I40E_NO_VSI   0xffff
368         u16 next_vsi;      /* Next unallocated VSI - 0-based! */
369         struct i40e_vsi **vsi;
370         struct i40e_veb *veb[I40E_MAX_VEB];
371
372         struct i40e_lump_tracking *qp_pile;
373         struct i40e_lump_tracking *irq_pile;
374
375         /* switch config info */
376         u16 pf_seid;
377         u16 main_vsi_seid;
378         u16 mac_seid;
379         struct kobject *switch_kobj;
380 #ifdef CONFIG_DEBUG_FS
381         struct dentry *i40e_dbg_pf;
382 #endif /* CONFIG_DEBUG_FS */
383         bool cur_promisc;
384
385         u16 instance; /* A unique number per i40e_pf instance in the system */
386
387         /* sr-iov config info */
388         struct i40e_vf *vf;
389         int num_alloc_vfs;      /* actual number of VFs allocated */
390         u32 vf_aq_requests;
391
392         /* DCBx/DCBNL capability for PF that indicates
393          * whether DCBx is managed by firmware or host
394          * based agent (LLDPAD). Also, indicates what
395          * flavor of DCBx protocol (IEEE/CEE) is supported
396          * by the device. For now we're supporting IEEE
397          * mode only.
398          */
399         u16 dcbx_cap;
400
401         u32     fcoe_hmc_filt_num;
402         u32     fcoe_hmc_cntx_num;
403         struct i40e_filter_control_settings filter_settings;
404
405         struct ptp_clock *ptp_clock;
406         struct ptp_clock_info ptp_caps;
407         struct sk_buff *ptp_tx_skb;
408         struct hwtstamp_config tstamp_config;
409         unsigned long last_rx_ptp_check;
410         spinlock_t tmreg_lock; /* Used to protect the device time registers. */
411         u64 ptp_base_adj;
412         u32 tx_hwtstamp_timeouts;
413         u32 rx_hwtstamp_cleared;
414         bool ptp_tx;
415         bool ptp_rx;
416         u16 rss_table_size; /* HW RSS table size */
417         /* These are only valid in NPAR modes */
418         u32 npar_max_bw;
419         u32 npar_min_bw;
420
421         u32 ioremap_len;
422         u32 fd_inv;
423 };
424
425 struct i40e_mac_filter {
426         struct list_head list;
427         u8 macaddr[ETH_ALEN];
428 #define I40E_VLAN_ANY -1
429         s16 vlan;
430         u8 counter;             /* number of instances of this filter */
431         bool is_vf;             /* filter belongs to a VF */
432         bool is_netdev;         /* filter belongs to a netdev */
433         bool changed;           /* filter needs to be sync'd to the HW */
434         bool is_laa;            /* filter is a Locally Administered Address */
435 };
436
437 struct i40e_veb {
438         struct i40e_pf *pf;
439         u16 idx;
440         u16 veb_idx;           /* index of VEB parent */
441         u16 seid;
442         u16 uplink_seid;
443         u16 stats_idx;           /* index of VEB parent */
444         u8  enabled_tc;
445         u16 bridge_mode;        /* Bridge Mode (VEB/VEPA) */
446         u16 flags;
447         u16 bw_limit;
448         u8  bw_max_quanta;
449         bool is_abs_credits;
450         u8  bw_tc_share_credits[I40E_MAX_TRAFFIC_CLASS];
451         u16 bw_tc_limit_credits[I40E_MAX_TRAFFIC_CLASS];
452         u8  bw_tc_max_quanta[I40E_MAX_TRAFFIC_CLASS];
453         struct kobject *kobj;
454         bool stat_offsets_loaded;
455         struct i40e_eth_stats stats;
456         struct i40e_eth_stats stats_offsets;
457         struct i40e_veb_tc_stats tc_stats;
458         struct i40e_veb_tc_stats tc_stats_offsets;
459 };
460
461 /* struct that defines a VSI, associated with a dev */
462 struct i40e_vsi {
463         struct net_device *netdev;
464         unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
465         bool netdev_registered;
466         bool stat_offsets_loaded;
467
468         u32 current_netdev_flags;
469         unsigned long state;
470 #define I40E_VSI_FLAG_FILTER_CHANGED    BIT(0)
471 #define I40E_VSI_FLAG_VEB_OWNER         BIT(1)
472         unsigned long flags;
473
474         /* Per VSI lock to protect elements/list (MAC filter) */
475         spinlock_t mac_filter_list_lock;
476         struct list_head mac_filter_list;
477
478         /* VSI stats */
479         struct rtnl_link_stats64 net_stats;
480         struct rtnl_link_stats64 net_stats_offsets;
481         struct i40e_eth_stats eth_stats;
482         struct i40e_eth_stats eth_stats_offsets;
483 #ifdef I40E_FCOE
484         struct i40e_fcoe_stats fcoe_stats;
485         struct i40e_fcoe_stats fcoe_stats_offsets;
486         bool fcoe_stat_offsets_loaded;
487 #endif
488         u32 tx_restart;
489         u32 tx_busy;
490         u64 tx_linearize;
491         u64 tx_force_wb;
492         u32 rx_buf_failed;
493         u32 rx_page_failed;
494
495         /* These are containers of ring pointers, allocated at run-time */
496         struct i40e_ring **rx_rings;
497         struct i40e_ring **tx_rings;
498
499         u16 work_limit;
500         /* high bit set means dynamic, use accessor routines to read/write.
501          * hardware only supports 2us resolution for the ITR registers.
502          * these values always store the USER setting, and must be converted
503          * before programming to a register.
504          */
505         u16 rx_itr_setting;
506         u16 tx_itr_setting;
507         u16 int_rate_limit;  /* value in usecs */
508
509         u16 rss_table_size; /* HW RSS table size */
510         u16 rss_size;       /* Allocated RSS queues */
511         u8  *rss_hkey_user; /* User configured hash keys */
512         u8  *rss_lut_user;  /* User configured lookup table entries */
513
514         u16 max_frame;
515         u16 rx_hdr_len;
516         u16 rx_buf_len;
517         u8  dtype;
518
519         /* List of q_vectors allocated to this VSI */
520         struct i40e_q_vector **q_vectors;
521         int num_q_vectors;
522         int base_vector;
523         bool irqs_ready;
524
525         u16 seid;            /* HW index of this VSI (absolute index) */
526         u16 id;              /* VSI number */
527         u16 uplink_seid;
528
529         u16 base_queue;      /* vsi's first queue in hw array */
530         u16 alloc_queue_pairs; /* Allocated Tx/Rx queues */
531         u16 req_queue_pairs; /* User requested queue pairs */
532         u16 num_queue_pairs; /* Used tx and rx pairs */
533         u16 num_desc;
534         enum i40e_vsi_type type;  /* VSI type, e.g., LAN, FCoE, etc */
535         u16 vf_id;              /* Virtual function ID for SRIOV VSIs */
536
537         struct i40e_tc_configuration tc_config;
538         struct i40e_aqc_vsi_properties_data info;
539
540         /* VSI BW limit (absolute across all TCs) */
541         u16 bw_limit;           /* VSI BW Limit (0 = disabled) */
542         u8  bw_max_quanta;      /* Max Quanta when BW limit is enabled */
543
544         /* Relative TC credits across VSIs */
545         u8  bw_ets_share_credits[I40E_MAX_TRAFFIC_CLASS];
546         /* TC BW limit credits within VSI */
547         u16  bw_ets_limit_credits[I40E_MAX_TRAFFIC_CLASS];
548         /* TC BW limit max quanta within VSI */
549         u8  bw_ets_max_quanta[I40E_MAX_TRAFFIC_CLASS];
550
551         struct i40e_pf *back;  /* Backreference to associated PF */
552         u16 idx;               /* index in pf->vsi[] */
553         u16 veb_idx;           /* index of VEB parent */
554         struct kobject *kobj;  /* sysfs object */
555         bool current_isup;     /* Sync 'link up' logging */
556
557         /* VSI specific handlers */
558         irqreturn_t (*irq_handler)(int irq, void *data);
559
560         /* current rxnfc data */
561         struct ethtool_rxnfc rxnfc; /* current rss hash opts */
562 } ____cacheline_internodealigned_in_smp;
563
564 struct i40e_netdev_priv {
565         struct i40e_vsi *vsi;
566 };
567
568 /* struct that defines an interrupt vector */
569 struct i40e_q_vector {
570         struct i40e_vsi *vsi;
571
572         u16 v_idx;              /* index in the vsi->q_vector array. */
573         u16 reg_idx;            /* register index of the interrupt */
574
575         struct napi_struct napi;
576
577         struct i40e_ring_container rx;
578         struct i40e_ring_container tx;
579
580         u8 num_ringpairs;       /* total number of ring pairs in vector */
581
582         cpumask_t affinity_mask;
583         struct rcu_head rcu;    /* to avoid race with update stats on free */
584         char name[I40E_INT_NAME_STR_LEN];
585         bool arm_wb_state;
586 #define ITR_COUNTDOWN_START 100
587         u8 itr_countdown;       /* when 0 should adjust ITR */
588 } ____cacheline_internodealigned_in_smp;
589
590 /* lan device */
591 struct i40e_device {
592         struct list_head list;
593         struct i40e_pf *pf;
594 };
595
596 /**
597  * i40e_nvm_version_str - format the NVM version strings
598  * @hw: ptr to the hardware info
599  **/
600 static inline char *i40e_nvm_version_str(struct i40e_hw *hw)
601 {
602         static char buf[32];
603         u32 full_ver;
604         u8 ver, patch;
605         u16 build;
606
607         full_ver = hw->nvm.oem_ver;
608         ver = (u8)(full_ver >> I40E_OEM_VER_SHIFT);
609         build = (u16)((full_ver >> I40E_OEM_VER_BUILD_SHIFT)
610                  & I40E_OEM_VER_BUILD_MASK);
611         patch = (u8)(full_ver & I40E_OEM_VER_PATCH_MASK);
612
613         snprintf(buf, sizeof(buf),
614                  "%x.%02x 0x%x %d.%d.%d",
615                  (hw->nvm.version & I40E_NVM_VERSION_HI_MASK) >>
616                         I40E_NVM_VERSION_HI_SHIFT,
617                  (hw->nvm.version & I40E_NVM_VERSION_LO_MASK) >>
618                         I40E_NVM_VERSION_LO_SHIFT,
619                  hw->nvm.eetrack, ver, build, patch);
620
621         return buf;
622 }
623
624 /**
625  * i40e_netdev_to_pf: Retrieve the PF struct for given netdev
626  * @netdev: the corresponding netdev
627  *
628  * Return the PF struct for the given netdev
629  **/
630 static inline struct i40e_pf *i40e_netdev_to_pf(struct net_device *netdev)
631 {
632         struct i40e_netdev_priv *np = netdev_priv(netdev);
633         struct i40e_vsi *vsi = np->vsi;
634
635         return vsi->back;
636 }
637
638 static inline void i40e_vsi_setup_irqhandler(struct i40e_vsi *vsi,
639                                 irqreturn_t (*irq_handler)(int, void *))
640 {
641         vsi->irq_handler = irq_handler;
642 }
643
644 /**
645  * i40e_rx_is_programming_status - check for programming status descriptor
646  * @qw: the first quad word of the program status descriptor
647  *
648  * The value of in the descriptor length field indicate if this
649  * is a programming status descriptor for flow director or FCoE
650  * by the value of I40E_RX_PROG_STATUS_DESC_LENGTH, otherwise
651  * it is a packet descriptor.
652  **/
653 static inline bool i40e_rx_is_programming_status(u64 qw)
654 {
655         return I40E_RX_PROG_STATUS_DESC_LENGTH ==
656                 (qw >> I40E_RX_PROG_STATUS_DESC_LENGTH_SHIFT);
657 }
658
659 /**
660  * i40e_get_fd_cnt_all - get the total FD filter space available
661  * @pf: pointer to the PF struct
662  **/
663 static inline int i40e_get_fd_cnt_all(struct i40e_pf *pf)
664 {
665         return pf->hw.fdir_shared_filter_count + pf->fdir_pf_filter_count;
666 }
667
668 /* needed by i40e_ethtool.c */
669 int i40e_up(struct i40e_vsi *vsi);
670 void i40e_down(struct i40e_vsi *vsi);
671 extern const char i40e_driver_name[];
672 extern const char i40e_driver_version_str[];
673 void i40e_do_reset_safe(struct i40e_pf *pf, u32 reset_flags);
674 void i40e_do_reset(struct i40e_pf *pf, u32 reset_flags);
675 int i40e_config_rss(struct i40e_vsi *vsi, u8 *seed, u8 *lut, u16 lut_size);
676 int i40e_get_rss(struct i40e_vsi *vsi, u8 *seed, u8 *lut, u16 lut_size);
677 struct i40e_vsi *i40e_find_vsi_from_id(struct i40e_pf *pf, u16 id);
678 void i40e_update_stats(struct i40e_vsi *vsi);
679 void i40e_update_eth_stats(struct i40e_vsi *vsi);
680 struct rtnl_link_stats64 *i40e_get_vsi_stats_struct(struct i40e_vsi *vsi);
681 int i40e_fetch_switch_configuration(struct i40e_pf *pf,
682                                     bool printconfig);
683
684 int i40e_program_fdir_filter(struct i40e_fdir_filter *fdir_data, u8 *raw_packet,
685                              struct i40e_pf *pf, bool add);
686 int i40e_add_del_fdir(struct i40e_vsi *vsi,
687                       struct i40e_fdir_filter *input, bool add);
688 void i40e_fdir_check_and_reenable(struct i40e_pf *pf);
689 u32 i40e_get_current_fd_count(struct i40e_pf *pf);
690 u32 i40e_get_cur_guaranteed_fd_count(struct i40e_pf *pf);
691 u32 i40e_get_current_atr_cnt(struct i40e_pf *pf);
692 u32 i40e_get_global_fd_count(struct i40e_pf *pf);
693 bool i40e_set_ntuple(struct i40e_pf *pf, netdev_features_t features);
694 void i40e_set_ethtool_ops(struct net_device *netdev);
695 struct i40e_mac_filter *i40e_add_filter(struct i40e_vsi *vsi,
696                                         u8 *macaddr, s16 vlan,
697                                         bool is_vf, bool is_netdev);
698 void i40e_del_filter(struct i40e_vsi *vsi, u8 *macaddr, s16 vlan,
699                      bool is_vf, bool is_netdev);
700 int i40e_sync_vsi_filters(struct i40e_vsi *vsi);
701 struct i40e_vsi *i40e_vsi_setup(struct i40e_pf *pf, u8 type,
702                                 u16 uplink, u32 param1);
703 int i40e_vsi_release(struct i40e_vsi *vsi);
704 struct i40e_vsi *i40e_vsi_lookup(struct i40e_pf *pf, enum i40e_vsi_type type,
705                                  struct i40e_vsi *start_vsi);
706 #ifdef I40E_FCOE
707 void i40e_vsi_setup_queue_map(struct i40e_vsi *vsi,
708                               struct i40e_vsi_context *ctxt,
709                               u8 enabled_tc, bool is_add);
710 #endif
711 int i40e_vsi_control_rings(struct i40e_vsi *vsi, bool enable);
712 int i40e_reconfig_rss_queues(struct i40e_pf *pf, int queue_count);
713 struct i40e_veb *i40e_veb_setup(struct i40e_pf *pf, u16 flags, u16 uplink_seid,
714                                 u16 downlink_seid, u8 enabled_tc);
715 void i40e_veb_release(struct i40e_veb *veb);
716
717 int i40e_veb_config_tc(struct i40e_veb *veb, u8 enabled_tc);
718 i40e_status i40e_vsi_add_pvid(struct i40e_vsi *vsi, u16 vid);
719 void i40e_vsi_remove_pvid(struct i40e_vsi *vsi);
720 void i40e_vsi_reset_stats(struct i40e_vsi *vsi);
721 void i40e_pf_reset_stats(struct i40e_pf *pf);
722 #ifdef CONFIG_DEBUG_FS
723 void i40e_dbg_pf_init(struct i40e_pf *pf);
724 void i40e_dbg_pf_exit(struct i40e_pf *pf);
725 void i40e_dbg_init(void);
726 void i40e_dbg_exit(void);
727 #else
728 static inline void i40e_dbg_pf_init(struct i40e_pf *pf) {}
729 static inline void i40e_dbg_pf_exit(struct i40e_pf *pf) {}
730 static inline void i40e_dbg_init(void) {}
731 static inline void i40e_dbg_exit(void) {}
732 #endif /* CONFIG_DEBUG_FS*/
733 /**
734  * i40e_irq_dynamic_enable - Enable default interrupt generation settings
735  * @vsi: pointer to a vsi
736  * @vector: enable a particular Hw Interrupt vector, without base_vector
737  **/
738 static inline void i40e_irq_dynamic_enable(struct i40e_vsi *vsi, int vector)
739 {
740         struct i40e_pf *pf = vsi->back;
741         struct i40e_hw *hw = &pf->hw;
742         u32 val;
743
744         val = I40E_PFINT_DYN_CTLN_INTENA_MASK |
745               I40E_PFINT_DYN_CTLN_CLEARPBA_MASK |
746               (I40E_ITR_NONE << I40E_PFINT_DYN_CTLN_ITR_INDX_SHIFT);
747         wr32(hw, I40E_PFINT_DYN_CTLN(vector + vsi->base_vector - 1), val);
748         /* skip the flush */
749 }
750
751 void i40e_irq_dynamic_disable(struct i40e_vsi *vsi, int vector);
752 void i40e_irq_dynamic_disable_icr0(struct i40e_pf *pf);
753 void i40e_irq_dynamic_enable_icr0(struct i40e_pf *pf);
754 #ifdef I40E_FCOE
755 struct rtnl_link_stats64 *i40e_get_netdev_stats_struct(
756                                              struct net_device *netdev,
757                                              struct rtnl_link_stats64 *storage);
758 int i40e_set_mac(struct net_device *netdev, void *p);
759 void i40e_set_rx_mode(struct net_device *netdev);
760 #endif
761 int i40e_ioctl(struct net_device *netdev, struct ifreq *ifr, int cmd);
762 #ifdef I40E_FCOE
763 void i40e_tx_timeout(struct net_device *netdev);
764 int i40e_vlan_rx_add_vid(struct net_device *netdev,
765                          __always_unused __be16 proto, u16 vid);
766 int i40e_vlan_rx_kill_vid(struct net_device *netdev,
767                           __always_unused __be16 proto, u16 vid);
768 #endif
769 int i40e_open(struct net_device *netdev);
770 int i40e_vsi_open(struct i40e_vsi *vsi);
771 void i40e_vlan_stripping_disable(struct i40e_vsi *vsi);
772 int i40e_vsi_add_vlan(struct i40e_vsi *vsi, s16 vid);
773 int i40e_vsi_kill_vlan(struct i40e_vsi *vsi, s16 vid);
774 struct i40e_mac_filter *i40e_put_mac_in_vlan(struct i40e_vsi *vsi, u8 *macaddr,
775                                              bool is_vf, bool is_netdev);
776 bool i40e_is_vsi_in_vlan(struct i40e_vsi *vsi);
777 struct i40e_mac_filter *i40e_find_mac(struct i40e_vsi *vsi, u8 *macaddr,
778                                       bool is_vf, bool is_netdev);
779 #ifdef I40E_FCOE
780 int i40e_close(struct net_device *netdev);
781 int i40e_setup_tc(struct net_device *netdev, u8 tc);
782 void i40e_netpoll(struct net_device *netdev);
783 int i40e_fcoe_enable(struct net_device *netdev);
784 int i40e_fcoe_disable(struct net_device *netdev);
785 int i40e_fcoe_vsi_init(struct i40e_vsi *vsi, struct i40e_vsi_context *ctxt);
786 u8 i40e_get_fcoe_tc_map(struct i40e_pf *pf);
787 void i40e_fcoe_config_netdev(struct net_device *netdev, struct i40e_vsi *vsi);
788 void i40e_fcoe_vsi_setup(struct i40e_pf *pf);
789 void i40e_init_pf_fcoe(struct i40e_pf *pf);
790 int i40e_fcoe_setup_ddp_resources(struct i40e_vsi *vsi);
791 void i40e_fcoe_free_ddp_resources(struct i40e_vsi *vsi);
792 int i40e_fcoe_handle_offload(struct i40e_ring *rx_ring,
793                              union i40e_rx_desc *rx_desc,
794                              struct sk_buff *skb);
795 void i40e_fcoe_handle_status(struct i40e_ring *rx_ring,
796                              union i40e_rx_desc *rx_desc, u8 prog_id);
797 #endif /* I40E_FCOE */
798 void i40e_vlan_stripping_enable(struct i40e_vsi *vsi);
799 #ifdef CONFIG_I40E_DCB
800 void i40e_dcbnl_flush_apps(struct i40e_pf *pf,
801                            struct i40e_dcbx_config *old_cfg,
802                            struct i40e_dcbx_config *new_cfg);
803 void i40e_dcbnl_set_all(struct i40e_vsi *vsi);
804 void i40e_dcbnl_setup(struct i40e_vsi *vsi);
805 bool i40e_dcb_need_reconfig(struct i40e_pf *pf,
806                             struct i40e_dcbx_config *old_cfg,
807                             struct i40e_dcbx_config *new_cfg);
808 #endif /* CONFIG_I40E_DCB */
809 void i40e_ptp_rx_hang(struct i40e_vsi *vsi);
810 void i40e_ptp_tx_hwtstamp(struct i40e_pf *pf);
811 void i40e_ptp_rx_hwtstamp(struct i40e_pf *pf, struct sk_buff *skb, u8 index);
812 void i40e_ptp_set_increment(struct i40e_pf *pf);
813 int i40e_ptp_set_ts_config(struct i40e_pf *pf, struct ifreq *ifr);
814 int i40e_ptp_get_ts_config(struct i40e_pf *pf, struct ifreq *ifr);
815 void i40e_ptp_init(struct i40e_pf *pf);
816 void i40e_ptp_stop(struct i40e_pf *pf);
817 int i40e_is_vsi_uplink_mode_veb(struct i40e_vsi *vsi);
818 i40e_status i40e_get_npar_bw_setting(struct i40e_pf *pf);
819 i40e_status i40e_set_npar_bw_setting(struct i40e_pf *pf);
820 i40e_status i40e_commit_npar_bw_setting(struct i40e_pf *pf);
821 void i40e_print_link_message(struct i40e_vsi *vsi, bool isup);
822 #endif /* _I40E_H_ */