]> git.karo-electronics.de Git - karo-tx-linux.git/blob - drivers/net/ethernet/intel/i40e/i40e.h
i40e: add parsing of flexible filter fields from userdef
[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 - 2016 Intel Corporation.
5  *
6  * This program is free software; you can redistribute it and/or modify it
7  * under the terms and conditions of the GNU General Public License,
8  * version 2, as published by the Free Software Foundation.
9  *
10  * This program is distributed in the hope it will be useful, but WITHOUT
11  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
13  * more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program.  If not, see <http://www.gnu.org/licenses/>.
17  *
18  * The full GNU General Public License is included in this distribution in
19  * the file called "COPYING".
20  *
21  * Contact Information:
22  * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
23  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
24  *
25  ******************************************************************************/
26
27 #ifndef _I40E_H_
28 #define _I40E_H_
29
30 #include <net/tcp.h>
31 #include <net/udp.h>
32 #include <linux/types.h>
33 #include <linux/errno.h>
34 #include <linux/module.h>
35 #include <linux/pci.h>
36 #include <linux/aer.h>
37 #include <linux/netdevice.h>
38 #include <linux/ioport.h>
39 #include <linux/iommu.h>
40 #include <linux/slab.h>
41 #include <linux/list.h>
42 #include <linux/hashtable.h>
43 #include <linux/string.h>
44 #include <linux/in.h>
45 #include <linux/ip.h>
46 #include <linux/sctp.h>
47 #include <linux/pkt_sched.h>
48 #include <linux/ipv6.h>
49 #include <net/checksum.h>
50 #include <net/ip6_checksum.h>
51 #include <linux/ethtool.h>
52 #include <linux/if_vlan.h>
53 #include <linux/if_bridge.h>
54 #include <linux/clocksource.h>
55 #include <linux/net_tstamp.h>
56 #include <linux/ptp_clock_kernel.h>
57 #include "i40e_type.h"
58 #include "i40e_prototype.h"
59 #ifdef I40E_FCOE
60 #include "i40e_fcoe.h"
61 #endif
62 #include "i40e_client.h"
63 #include "i40e_virtchnl.h"
64 #include "i40e_virtchnl_pf.h"
65 #include "i40e_txrx.h"
66 #include "i40e_dcb.h"
67
68 /* Useful i40e defaults */
69 #define I40E_MAX_VEB                    16
70
71 #define I40E_MAX_NUM_DESCRIPTORS        4096
72 #define I40E_MAX_CSR_SPACE              (4 * 1024 * 1024 - 64 * 1024)
73 #define I40E_DEFAULT_NUM_DESCRIPTORS    512
74 #define I40E_REQ_DESCRIPTOR_MULTIPLE    32
75 #define I40E_MIN_NUM_DESCRIPTORS        64
76 #define I40E_MIN_MSIX                   2
77 #define I40E_DEFAULT_NUM_VMDQ_VSI       8 /* max 256 VSIs */
78 #define I40E_MIN_VSI_ALLOC              83 /* LAN, ATR, FCOE, 64 VF */
79 /* max 16 qps */
80 #define i40e_default_queues_per_vmdq(pf) \
81                 (((pf)->flags & I40E_FLAG_RSS_AQ_CAPABLE) ? 4 : 1)
82 #define I40E_DEFAULT_QUEUES_PER_VF      4
83 #define I40E_DEFAULT_QUEUES_PER_TC      1 /* should be a power of 2 */
84 #define i40e_pf_get_max_q_per_tc(pf) \
85                 (((pf)->flags & I40E_FLAG_128_QP_RSS_CAPABLE) ? 128 : 64)
86 #define I40E_FDIR_RING                  0
87 #define I40E_FDIR_RING_COUNT            32
88 #ifdef I40E_FCOE
89 #define I40E_DEFAULT_FCOE               8 /* default number of QPs for FCoE */
90 #define I40E_MINIMUM_FCOE               1 /* minimum number of QPs for FCoE */
91 #endif /* I40E_FCOE */
92 #define I40E_MAX_AQ_BUF_SIZE            4096
93 #define I40E_AQ_LEN                     256
94 #define I40E_AQ_WORK_LIMIT              66 /* max number of VFs + a little */
95 #define I40E_MAX_USER_PRIORITY          8
96 #define I40E_DEFAULT_TRAFFIC_CLASS      BIT(0)
97 #define I40E_DEFAULT_MSG_ENABLE         4
98 #define I40E_QUEUE_WAIT_RETRY_LIMIT     10
99 #define I40E_INT_NAME_STR_LEN           (IFNAMSIZ + 16)
100
101 /* Ethtool Private Flags */
102 #define I40E_PRIV_FLAGS_MFP_FLAG                BIT(0)
103 #define I40E_PRIV_FLAGS_LINKPOLL_FLAG           BIT(1)
104 #define I40E_PRIV_FLAGS_FD_ATR                  BIT(2)
105 #define I40E_PRIV_FLAGS_VEB_STATS               BIT(3)
106 #define I40E_PRIV_FLAGS_HW_ATR_EVICT            BIT(4)
107 #define I40E_PRIV_FLAGS_TRUE_PROMISC_SUPPORT    BIT(5)
108
109 #define I40E_NVM_VERSION_LO_SHIFT       0
110 #define I40E_NVM_VERSION_LO_MASK        (0xff << I40E_NVM_VERSION_LO_SHIFT)
111 #define I40E_NVM_VERSION_HI_SHIFT       12
112 #define I40E_NVM_VERSION_HI_MASK        (0xf << I40E_NVM_VERSION_HI_SHIFT)
113 #define I40E_OEM_VER_BUILD_MASK         0xffff
114 #define I40E_OEM_VER_PATCH_MASK         0xff
115 #define I40E_OEM_VER_BUILD_SHIFT        8
116 #define I40E_OEM_VER_SHIFT              24
117 #define I40E_PHY_DEBUG_ALL \
118         (I40E_AQ_PHY_DEBUG_DISABLE_LINK_FW | \
119         I40E_AQ_PHY_DEBUG_DISABLE_ALL_LINK_FW)
120
121 /* The values in here are decimal coded as hex as is the case in the NVM map*/
122 #define I40E_CURRENT_NVM_VERSION_HI     0x2
123 #define I40E_CURRENT_NVM_VERSION_LO     0x40
124
125 #define I40E_RX_DESC(R, i)      \
126         (&(((union i40e_32byte_rx_desc *)((R)->desc))[i]))
127 #define I40E_TX_DESC(R, i)      \
128         (&(((struct i40e_tx_desc *)((R)->desc))[i]))
129 #define I40E_TX_CTXTDESC(R, i)  \
130         (&(((struct i40e_tx_context_desc *)((R)->desc))[i]))
131 #define I40E_TX_FDIRDESC(R, i)  \
132         (&(((struct i40e_filter_program_desc *)((R)->desc))[i]))
133
134 /* default to trying for four seconds */
135 #define I40E_TRY_LINK_TIMEOUT   (4 * HZ)
136
137 /* driver state flags */
138 enum i40e_state_t {
139         __I40E_TESTING,
140         __I40E_CONFIG_BUSY,
141         __I40E_CONFIG_DONE,
142         __I40E_DOWN,
143         __I40E_NEEDS_RESTART,
144         __I40E_SERVICE_SCHED,
145         __I40E_ADMINQ_EVENT_PENDING,
146         __I40E_MDD_EVENT_PENDING,
147         __I40E_VFLR_EVENT_PENDING,
148         __I40E_RESET_RECOVERY_PENDING,
149         __I40E_RESET_INTR_RECEIVED,
150         __I40E_REINIT_REQUESTED,
151         __I40E_PF_RESET_REQUESTED,
152         __I40E_CORE_RESET_REQUESTED,
153         __I40E_GLOBAL_RESET_REQUESTED,
154         __I40E_EMP_RESET_REQUESTED,
155         __I40E_EMP_RESET_INTR_RECEIVED,
156         __I40E_FILTER_OVERFLOW_PROMISC,
157         __I40E_SUSPENDED,
158         __I40E_PTP_TX_IN_PROGRESS,
159         __I40E_BAD_EEPROM,
160         __I40E_DOWN_REQUESTED,
161         __I40E_FD_FLUSH_REQUESTED,
162         __I40E_RESET_FAILED,
163         __I40E_PORT_TX_SUSPENDED,
164         __I40E_VF_DISABLE,
165 };
166
167 enum i40e_interrupt_policy {
168         I40E_INTERRUPT_BEST_CASE,
169         I40E_INTERRUPT_MEDIUM,
170         I40E_INTERRUPT_LOWEST
171 };
172
173 struct i40e_lump_tracking {
174         u16 num_entries;
175         u16 search_hint;
176         u16 list[0];
177 #define I40E_PILE_VALID_BIT  0x8000
178 #define I40E_IWARP_IRQ_PILE_ID  (I40E_PILE_VALID_BIT - 2)
179 };
180
181 #define I40E_DEFAULT_ATR_SAMPLE_RATE    20
182 #define I40E_FDIR_MAX_RAW_PACKET_SIZE   512
183 #define I40E_FDIR_BUFFER_FULL_MARGIN    10
184 #define I40E_FDIR_BUFFER_HEAD_ROOM      32
185 #define I40E_FDIR_BUFFER_HEAD_ROOM_FOR_ATR (I40E_FDIR_BUFFER_HEAD_ROOM * 4)
186
187 #define I40E_HKEY_ARRAY_SIZE    ((I40E_PFQF_HKEY_MAX_INDEX + 1) * 4)
188 #define I40E_HLUT_ARRAY_SIZE    ((I40E_PFQF_HLUT_MAX_INDEX + 1) * 4)
189 #define I40E_VF_HLUT_ARRAY_SIZE ((I40E_VFQF_HLUT1_MAX_INDEX + 1) * 4)
190
191 enum i40e_fd_stat_idx {
192         I40E_FD_STAT_ATR,
193         I40E_FD_STAT_SB,
194         I40E_FD_STAT_ATR_TUNNEL,
195         I40E_FD_STAT_PF_COUNT
196 };
197 #define I40E_FD_STAT_PF_IDX(pf_id) ((pf_id) * I40E_FD_STAT_PF_COUNT)
198 #define I40E_FD_ATR_STAT_IDX(pf_id) \
199                         (I40E_FD_STAT_PF_IDX(pf_id) + I40E_FD_STAT_ATR)
200 #define I40E_FD_SB_STAT_IDX(pf_id)  \
201                         (I40E_FD_STAT_PF_IDX(pf_id) + I40E_FD_STAT_SB)
202 #define I40E_FD_ATR_TUNNEL_STAT_IDX(pf_id) \
203                         (I40E_FD_STAT_PF_IDX(pf_id) + I40E_FD_STAT_ATR_TUNNEL)
204
205 /* The following structure contains the data parsed from the user-defined
206  * field of the ethtool_rx_flow_spec structure.
207  */
208 struct i40e_rx_flow_userdef {
209         bool flex_filter;
210         u16 flex_word;
211         u16 flex_offset;
212 };
213
214 struct i40e_fdir_filter {
215         struct hlist_node fdir_node;
216         /* filter ipnut set */
217         u8 flow_type;
218         u8 ip4_proto;
219         /* TX packet view of src and dst */
220         __be32 dst_ip;
221         __be32 src_ip;
222         __be16 src_port;
223         __be16 dst_port;
224         __be32 sctp_v_tag;
225         /* filter control */
226         u16 q_index;
227         u8  flex_off;
228         u8  pctype;
229         u16 dest_vsi;
230         u8  dest_ctl;
231         u8  fd_status;
232         u16 cnt_index;
233         u32 fd_id;
234 };
235
236 #define I40E_ETH_P_LLDP                 0x88cc
237
238 #define I40E_DCB_PRIO_TYPE_STRICT       0
239 #define I40E_DCB_PRIO_TYPE_ETS          1
240 #define I40E_DCB_STRICT_PRIO_CREDITS    127
241 /* DCB per TC information data structure */
242 struct i40e_tc_info {
243         u16     qoffset;        /* Queue offset from base queue */
244         u16     qcount;         /* Total Queues */
245         u8      netdev_tc;      /* Netdev TC index if netdev associated */
246 };
247
248 /* TC configuration data structure */
249 struct i40e_tc_configuration {
250         u8      numtc;          /* Total number of enabled TCs */
251         u8      enabled_tc;     /* TC map */
252         struct i40e_tc_info tc_info[I40E_MAX_TRAFFIC_CLASS];
253 };
254
255 struct i40e_udp_port_config {
256         /* AdminQ command interface expects port number in Host byte order */
257         u16 index;
258         u8 type;
259 };
260
261 /* struct that defines the Ethernet device */
262 struct i40e_pf {
263         struct pci_dev *pdev;
264         struct i40e_hw hw;
265         unsigned long state;
266         struct msix_entry *msix_entries;
267         bool fc_autoneg_status;
268
269         u16 eeprom_version;
270         u16 num_vmdq_vsis;         /* num vmdq vsis this PF has set up */
271         u16 num_vmdq_qps;          /* num queue pairs per vmdq pool */
272         u16 num_vmdq_msix;         /* num queue vectors per vmdq pool */
273         u16 num_req_vfs;           /* num VFs requested for this VF */
274         u16 num_vf_qps;            /* num queue pairs per VF */
275 #ifdef I40E_FCOE
276         u16 num_fcoe_qps;          /* num fcoe queues this PF has set up */
277         u16 num_fcoe_msix;         /* num queue vectors per fcoe pool */
278 #endif /* I40E_FCOE */
279         u16 num_lan_qps;           /* num lan queues this PF has set up */
280         u16 num_lan_msix;          /* num queue vectors for the base PF vsi */
281         u16 num_fdsb_msix;         /* num queue vectors for sideband Fdir */
282         u16 num_iwarp_msix;        /* num of iwarp vectors for this PF */
283         int iwarp_base_vector;
284         int queues_left;           /* queues left unclaimed */
285         u16 alloc_rss_size;        /* allocated RSS queues */
286         u16 rss_size_max;          /* HW defined max RSS queues */
287         u16 fdir_pf_filter_count;  /* num of guaranteed filters for this PF */
288         u16 num_alloc_vsi;         /* num VSIs this driver supports */
289         u8 atr_sample_rate;
290         bool wol_en;
291
292         struct hlist_head fdir_filter_list;
293         u16 fdir_pf_active_filters;
294         unsigned long fd_flush_timestamp;
295         u32 fd_flush_cnt;
296         u32 fd_add_err;
297         u32 fd_atr_cnt;
298
299         /* Book-keeping of side-band filter count per flow-type.
300          * This is used to detect and handle input set changes for
301          * respective flow-type.
302          */
303         u16 fd_tcp4_filter_cnt;
304         u16 fd_udp4_filter_cnt;
305         u16 fd_ip4_filter_cnt;
306
307         struct i40e_udp_port_config udp_ports[I40E_MAX_PF_UDP_OFFLOAD_PORTS];
308         u16 pending_udp_bitmap;
309
310         enum i40e_interrupt_policy int_policy;
311         u16 rx_itr_default;
312         u16 tx_itr_default;
313         u32 msg_enable;
314         char int_name[I40E_INT_NAME_STR_LEN];
315         u16 adminq_work_limit; /* num of admin receive queue desc to process */
316         unsigned long service_timer_period;
317         unsigned long service_timer_previous;
318         struct timer_list service_timer;
319         struct work_struct service_task;
320
321         u64 flags;
322 #define I40E_FLAG_RX_CSUM_ENABLED               BIT_ULL(1)
323 #define I40E_FLAG_MSI_ENABLED                   BIT_ULL(2)
324 #define I40E_FLAG_MSIX_ENABLED                  BIT_ULL(3)
325 #define I40E_FLAG_RSS_ENABLED                   BIT_ULL(6)
326 #define I40E_FLAG_VMDQ_ENABLED                  BIT_ULL(7)
327 #define I40E_FLAG_FDIR_REQUIRES_REINIT          BIT_ULL(8)
328 #define I40E_FLAG_NEED_LINK_UPDATE              BIT_ULL(9)
329 #define I40E_FLAG_IWARP_ENABLED                 BIT_ULL(10)
330 #ifdef I40E_FCOE
331 #define I40E_FLAG_FCOE_ENABLED                  BIT_ULL(11)
332 #endif /* I40E_FCOE */
333 #define I40E_FLAG_CLEAN_ADMINQ                  BIT_ULL(14)
334 #define I40E_FLAG_FILTER_SYNC                   BIT_ULL(15)
335 #define I40E_FLAG_SERVICE_CLIENT_REQUESTED      BIT_ULL(16)
336 #define I40E_FLAG_PROCESS_MDD_EVENT             BIT_ULL(17)
337 #define I40E_FLAG_PROCESS_VFLR_EVENT            BIT_ULL(18)
338 #define I40E_FLAG_SRIOV_ENABLED                 BIT_ULL(19)
339 #define I40E_FLAG_DCB_ENABLED                   BIT_ULL(20)
340 #define I40E_FLAG_FD_SB_ENABLED                 BIT_ULL(21)
341 #define I40E_FLAG_FD_ATR_ENABLED                BIT_ULL(22)
342 #define I40E_FLAG_PTP                           BIT_ULL(25)
343 #define I40E_FLAG_MFP_ENABLED                   BIT_ULL(26)
344 #define I40E_FLAG_UDP_FILTER_SYNC               BIT_ULL(27)
345 #define I40E_FLAG_PORT_ID_VALID                 BIT_ULL(28)
346 #define I40E_FLAG_DCB_CAPABLE                   BIT_ULL(29)
347 #define I40E_FLAG_RSS_AQ_CAPABLE                BIT_ULL(31)
348 #define I40E_FLAG_HW_ATR_EVICT_CAPABLE          BIT_ULL(32)
349 #define I40E_FLAG_OUTER_UDP_CSUM_CAPABLE        BIT_ULL(33)
350 #define I40E_FLAG_128_QP_RSS_CAPABLE            BIT_ULL(34)
351 #define I40E_FLAG_WB_ON_ITR_CAPABLE             BIT_ULL(35)
352 #define I40E_FLAG_VEB_STATS_ENABLED             BIT_ULL(37)
353 #define I40E_FLAG_MULTIPLE_TCP_UDP_RSS_PCTYPE   BIT_ULL(38)
354 #define I40E_FLAG_LINK_POLLING_ENABLED          BIT_ULL(39)
355 #define I40E_FLAG_VEB_MODE_ENABLED              BIT_ULL(40)
356 #define I40E_FLAG_GENEVE_OFFLOAD_CAPABLE        BIT_ULL(41)
357 #define I40E_FLAG_NO_PCI_LINK_CHECK             BIT_ULL(42)
358 #define I40E_FLAG_100M_SGMII_CAPABLE            BIT_ULL(43)
359 #define I40E_FLAG_RESTART_AUTONEG               BIT_ULL(44)
360 #define I40E_FLAG_NO_DCB_SUPPORT                BIT_ULL(45)
361 #define I40E_FLAG_USE_SET_LLDP_MIB              BIT_ULL(46)
362 #define I40E_FLAG_STOP_FW_LLDP                  BIT_ULL(47)
363 #define I40E_FLAG_PHY_CONTROLS_LEDS             BIT_ULL(48)
364 #define I40E_FLAG_PF_MAC                        BIT_ULL(50)
365 #define I40E_FLAG_TRUE_PROMISC_SUPPORT          BIT_ULL(51)
366 #define I40E_FLAG_HAVE_CRT_RETIMER              BIT_ULL(52)
367 #define I40E_FLAG_PTP_L4_CAPABLE                BIT_ULL(53)
368 #define I40E_FLAG_CLIENT_RESET                  BIT_ULL(54)
369 #define I40E_FLAG_TEMP_LINK_POLLING             BIT_ULL(55)
370 #define I40E_FLAG_CLIENT_L2_CHANGE              BIT_ULL(56)
371 #define I40E_FLAG_WOL_MC_MAGIC_PKT_WAKE         BIT_ULL(57)
372
373         /* Tracks features that are disabled due to hw limitations.
374          * If a bit is set here, it means that the corresponding
375          * bit in the 'flags' field is cleared i.e that feature
376          * is disabled
377          */
378         u64 hw_disabled_flags;
379
380 #ifdef I40E_FCOE
381         struct i40e_fcoe fcoe;
382
383 #endif /* I40E_FCOE */
384         struct i40e_client_instance *cinst;
385         bool stat_offsets_loaded;
386         struct i40e_hw_port_stats stats;
387         struct i40e_hw_port_stats stats_offsets;
388         u32 tx_timeout_count;
389         u32 tx_timeout_recovery_level;
390         unsigned long tx_timeout_last_recovery;
391         u32 tx_sluggish_count;
392         u32 hw_csum_rx_error;
393         u32 led_status;
394         u16 corer_count; /* Core reset count */
395         u16 globr_count; /* Global reset count */
396         u16 empr_count; /* EMP reset count */
397         u16 pfr_count; /* PF reset count */
398         u16 sw_int_count; /* SW interrupt count */
399
400         struct mutex switch_mutex;
401         u16 lan_vsi;       /* our default LAN VSI */
402         u16 lan_veb;       /* initial relay, if exists */
403 #define I40E_NO_VEB     0xffff
404 #define I40E_NO_VSI     0xffff
405         u16 next_vsi;      /* Next unallocated VSI - 0-based! */
406         struct i40e_vsi **vsi;
407         struct i40e_veb *veb[I40E_MAX_VEB];
408
409         struct i40e_lump_tracking *qp_pile;
410         struct i40e_lump_tracking *irq_pile;
411
412         /* switch config info */
413         u16 pf_seid;
414         u16 main_vsi_seid;
415         u16 mac_seid;
416         struct kobject *switch_kobj;
417 #ifdef CONFIG_DEBUG_FS
418         struct dentry *i40e_dbg_pf;
419 #endif /* CONFIG_DEBUG_FS */
420         bool cur_promisc;
421
422         u16 instance; /* A unique number per i40e_pf instance in the system */
423
424         /* sr-iov config info */
425         struct i40e_vf *vf;
426         int num_alloc_vfs;      /* actual number of VFs allocated */
427         u32 vf_aq_requests;
428         u32 arq_overflows;      /* Not fatal, possibly indicative of problems */
429
430         /* DCBx/DCBNL capability for PF that indicates
431          * whether DCBx is managed by firmware or host
432          * based agent (LLDPAD). Also, indicates what
433          * flavor of DCBx protocol (IEEE/CEE) is supported
434          * by the device. For now we're supporting IEEE
435          * mode only.
436          */
437         u16 dcbx_cap;
438
439         u32 fcoe_hmc_filt_num;
440         u32 fcoe_hmc_cntx_num;
441         struct i40e_filter_control_settings filter_settings;
442
443         struct ptp_clock *ptp_clock;
444         struct ptp_clock_info ptp_caps;
445         struct sk_buff *ptp_tx_skb;
446         struct hwtstamp_config tstamp_config;
447         struct mutex tmreg_lock; /* Used to protect the SYSTIME registers. */
448         u64 ptp_base_adj;
449         u32 tx_hwtstamp_timeouts;
450         u32 rx_hwtstamp_cleared;
451         u32 latch_event_flags;
452         spinlock_t ptp_rx_lock; /* Used to protect Rx timestamp registers. */
453         unsigned long latch_events[4];
454         bool ptp_tx;
455         bool ptp_rx;
456         u16 rss_table_size; /* HW RSS table size */
457         /* These are only valid in NPAR modes */
458         u32 npar_max_bw;
459         u32 npar_min_bw;
460
461         u32 ioremap_len;
462         u32 fd_inv;
463         u16 phy_led_val;
464 };
465
466 /**
467  * i40e_mac_to_hkey - Convert a 6-byte MAC Address to a u64 hash key
468  * @macaddr: the MAC Address as the base key
469  *
470  * Simply copies the address and returns it as a u64 for hashing
471  **/
472 static inline u64 i40e_addr_to_hkey(const u8 *macaddr)
473 {
474         u64 key = 0;
475
476         ether_addr_copy((u8 *)&key, macaddr);
477         return key;
478 }
479
480 enum i40e_filter_state {
481         I40E_FILTER_INVALID = 0,        /* Invalid state */
482         I40E_FILTER_NEW,                /* New, not sent to FW yet */
483         I40E_FILTER_ACTIVE,             /* Added to switch by FW */
484         I40E_FILTER_FAILED,             /* Rejected by FW */
485         I40E_FILTER_REMOVE,             /* To be removed */
486 /* There is no 'removed' state; the filter struct is freed */
487 };
488 struct i40e_mac_filter {
489         struct hlist_node hlist;
490         u8 macaddr[ETH_ALEN];
491 #define I40E_VLAN_ANY -1
492         s16 vlan;
493         enum i40e_filter_state state;
494 };
495
496 /* Wrapper structure to keep track of filters while we are preparing to send
497  * firmware commands. We cannot send firmware commands while holding a
498  * spinlock, since it might sleep. To avoid this, we wrap the added filters in
499  * a separate structure, which will track the state change and update the real
500  * filter while under lock. We can't simply hold the filters in a separate
501  * list, as this opens a window for a race condition when adding new MAC
502  * addresses to all VLANs, or when adding new VLANs to all MAC addresses.
503  */
504 struct i40e_new_mac_filter {
505         struct hlist_node hlist;
506         struct i40e_mac_filter *f;
507
508         /* Track future changes to state separately */
509         enum i40e_filter_state state;
510 };
511
512 struct i40e_veb {
513         struct i40e_pf *pf;
514         u16 idx;
515         u16 veb_idx;            /* index of VEB parent */
516         u16 seid;
517         u16 uplink_seid;
518         u16 stats_idx;          /* index of VEB parent */
519         u8  enabled_tc;
520         u16 bridge_mode;        /* Bridge Mode (VEB/VEPA) */
521         u16 flags;
522         u16 bw_limit;
523         u8  bw_max_quanta;
524         bool is_abs_credits;
525         u8  bw_tc_share_credits[I40E_MAX_TRAFFIC_CLASS];
526         u16 bw_tc_limit_credits[I40E_MAX_TRAFFIC_CLASS];
527         u8  bw_tc_max_quanta[I40E_MAX_TRAFFIC_CLASS];
528         struct kobject *kobj;
529         bool stat_offsets_loaded;
530         struct i40e_eth_stats stats;
531         struct i40e_eth_stats stats_offsets;
532         struct i40e_veb_tc_stats tc_stats;
533         struct i40e_veb_tc_stats tc_stats_offsets;
534 };
535
536 /* struct that defines a VSI, associated with a dev */
537 struct i40e_vsi {
538         struct net_device *netdev;
539         unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
540         bool netdev_registered;
541         bool stat_offsets_loaded;
542
543         u32 current_netdev_flags;
544         unsigned long state;
545 #define I40E_VSI_FLAG_FILTER_CHANGED    BIT(0)
546 #define I40E_VSI_FLAG_VEB_OWNER         BIT(1)
547         unsigned long flags;
548
549         /* Per VSI lock to protect elements/hash (MAC filter) */
550         spinlock_t mac_filter_hash_lock;
551         /* Fixed size hash table with 2^8 buckets for MAC filters */
552         DECLARE_HASHTABLE(mac_filter_hash, 8);
553         bool has_vlan_filter;
554
555         /* VSI stats */
556         struct rtnl_link_stats64 net_stats;
557         struct rtnl_link_stats64 net_stats_offsets;
558         struct i40e_eth_stats eth_stats;
559         struct i40e_eth_stats eth_stats_offsets;
560 #ifdef I40E_FCOE
561         struct i40e_fcoe_stats fcoe_stats;
562         struct i40e_fcoe_stats fcoe_stats_offsets;
563         bool fcoe_stat_offsets_loaded;
564 #endif
565         u32 tx_restart;
566         u32 tx_busy;
567         u64 tx_linearize;
568         u64 tx_force_wb;
569         u64 tx_lost_interrupt;
570         u32 rx_buf_failed;
571         u32 rx_page_failed;
572
573         /* These are containers of ring pointers, allocated at run-time */
574         struct i40e_ring **rx_rings;
575         struct i40e_ring **tx_rings;
576
577         u32  active_filters;
578         u32  promisc_threshold;
579
580         u16 work_limit;
581         u16 int_rate_limit;     /* value in usecs */
582
583         u16 rss_table_size;     /* HW RSS table size */
584         u16 rss_size;           /* Allocated RSS queues */
585         u8  *rss_hkey_user;     /* User configured hash keys */
586         u8  *rss_lut_user;      /* User configured lookup table entries */
587
588
589         u16 max_frame;
590         u16 rx_buf_len;
591
592         /* List of q_vectors allocated to this VSI */
593         struct i40e_q_vector **q_vectors;
594         int num_q_vectors;
595         int base_vector;
596         bool irqs_ready;
597
598         u16 seid;               /* HW index of this VSI (absolute index) */
599         u16 id;                 /* VSI number */
600         u16 uplink_seid;
601
602         u16 base_queue;         /* vsi's first queue in hw array */
603         u16 alloc_queue_pairs;  /* Allocated Tx/Rx queues */
604         u16 req_queue_pairs;    /* User requested queue pairs */
605         u16 num_queue_pairs;    /* Used tx and rx pairs */
606         u16 num_desc;
607         enum i40e_vsi_type type;  /* VSI type, e.g., LAN, FCoE, etc */
608         s16 vf_id;              /* Virtual function ID for SRIOV VSIs */
609
610         struct i40e_tc_configuration tc_config;
611         struct i40e_aqc_vsi_properties_data info;
612
613         /* VSI BW limit (absolute across all TCs) */
614         u16 bw_limit;           /* VSI BW Limit (0 = disabled) */
615         u8  bw_max_quanta;      /* Max Quanta when BW limit is enabled */
616
617         /* Relative TC credits across VSIs */
618         u8  bw_ets_share_credits[I40E_MAX_TRAFFIC_CLASS];
619         /* TC BW limit credits within VSI */
620         u16  bw_ets_limit_credits[I40E_MAX_TRAFFIC_CLASS];
621         /* TC BW limit max quanta within VSI */
622         u8  bw_ets_max_quanta[I40E_MAX_TRAFFIC_CLASS];
623
624         struct i40e_pf *back;   /* Backreference to associated PF */
625         u16 idx;                /* index in pf->vsi[] */
626         u16 veb_idx;            /* index of VEB parent */
627         struct kobject *kobj;   /* sysfs object */
628         bool current_isup;      /* Sync 'link up' logging */
629         enum i40e_aq_link_speed current_speed;  /* Sync link speed logging */
630
631         void *priv;     /* client driver data reference. */
632
633         /* VSI specific handlers */
634         irqreturn_t (*irq_handler)(int irq, void *data);
635 } ____cacheline_internodealigned_in_smp;
636
637 struct i40e_netdev_priv {
638         struct i40e_vsi *vsi;
639 };
640
641 /* struct that defines an interrupt vector */
642 struct i40e_q_vector {
643         struct i40e_vsi *vsi;
644
645         u16 v_idx;              /* index in the vsi->q_vector array. */
646         u16 reg_idx;            /* register index of the interrupt */
647
648         struct napi_struct napi;
649
650         struct i40e_ring_container rx;
651         struct i40e_ring_container tx;
652
653         u8 num_ringpairs;       /* total number of ring pairs in vector */
654
655 #define I40E_Q_VECTOR_HUNG_DETECT 0 /* Bit Index for hung detection logic */
656         unsigned long hung_detected; /* Set/Reset for hung_detection logic */
657
658         cpumask_t affinity_mask;
659         struct irq_affinity_notify affinity_notify;
660
661         struct rcu_head rcu;    /* to avoid race with update stats on free */
662         char name[I40E_INT_NAME_STR_LEN];
663         bool arm_wb_state;
664 #define ITR_COUNTDOWN_START 100
665         u8 itr_countdown;       /* when 0 should adjust ITR */
666 } ____cacheline_internodealigned_in_smp;
667
668 /* lan device */
669 struct i40e_device {
670         struct list_head list;
671         struct i40e_pf *pf;
672 };
673
674 /**
675  * i40e_nvm_version_str - format the NVM version strings
676  * @hw: ptr to the hardware info
677  **/
678 static inline char *i40e_nvm_version_str(struct i40e_hw *hw)
679 {
680         static char buf[32];
681         u32 full_ver;
682         u8 ver, patch;
683         u16 build;
684
685         full_ver = hw->nvm.oem_ver;
686         ver = (u8)(full_ver >> I40E_OEM_VER_SHIFT);
687         build = (u16)((full_ver >> I40E_OEM_VER_BUILD_SHIFT) &
688                  I40E_OEM_VER_BUILD_MASK);
689         patch = (u8)(full_ver & I40E_OEM_VER_PATCH_MASK);
690
691         snprintf(buf, sizeof(buf),
692                  "%x.%02x 0x%x %d.%d.%d",
693                  (hw->nvm.version & I40E_NVM_VERSION_HI_MASK) >>
694                         I40E_NVM_VERSION_HI_SHIFT,
695                  (hw->nvm.version & I40E_NVM_VERSION_LO_MASK) >>
696                         I40E_NVM_VERSION_LO_SHIFT,
697                  hw->nvm.eetrack, ver, build, patch);
698
699         return buf;
700 }
701
702 /**
703  * i40e_netdev_to_pf: Retrieve the PF struct for given netdev
704  * @netdev: the corresponding netdev
705  *
706  * Return the PF struct for the given netdev
707  **/
708 static inline struct i40e_pf *i40e_netdev_to_pf(struct net_device *netdev)
709 {
710         struct i40e_netdev_priv *np = netdev_priv(netdev);
711         struct i40e_vsi *vsi = np->vsi;
712
713         return vsi->back;
714 }
715
716 static inline void i40e_vsi_setup_irqhandler(struct i40e_vsi *vsi,
717                                 irqreturn_t (*irq_handler)(int, void *))
718 {
719         vsi->irq_handler = irq_handler;
720 }
721
722 /**
723  * i40e_rx_is_programming_status - check for programming status descriptor
724  * @qw: the first quad word of the program status descriptor
725  *
726  * The value of in the descriptor length field indicate if this
727  * is a programming status descriptor for flow director or FCoE
728  * by the value of I40E_RX_PROG_STATUS_DESC_LENGTH, otherwise
729  * it is a packet descriptor.
730  **/
731 static inline bool i40e_rx_is_programming_status(u64 qw)
732 {
733         return I40E_RX_PROG_STATUS_DESC_LENGTH ==
734                 (qw >> I40E_RX_PROG_STATUS_DESC_LENGTH_SHIFT);
735 }
736
737 /**
738  * i40e_get_fd_cnt_all - get the total FD filter space available
739  * @pf: pointer to the PF struct
740  **/
741 static inline int i40e_get_fd_cnt_all(struct i40e_pf *pf)
742 {
743         return pf->hw.fdir_shared_filter_count + pf->fdir_pf_filter_count;
744 }
745
746 /**
747  * i40e_read_fd_input_set - reads value of flow director input set register
748  * @pf: pointer to the PF struct
749  * @addr: register addr
750  *
751  * This function reads value of flow director input set register
752  * specified by 'addr' (which is specific to flow-type)
753  **/
754 static inline u64 i40e_read_fd_input_set(struct i40e_pf *pf, u16 addr)
755 {
756         u64 val;
757
758         val = i40e_read_rx_ctl(&pf->hw, I40E_PRTQF_FD_INSET(addr, 1));
759         val <<= 32;
760         val += i40e_read_rx_ctl(&pf->hw, I40E_PRTQF_FD_INSET(addr, 0));
761
762         return val;
763 }
764
765 /**
766  * i40e_write_fd_input_set - writes value into flow director input set register
767  * @pf: pointer to the PF struct
768  * @addr: register addr
769  * @val: value to be written
770  *
771  * This function writes specified value to the register specified by 'addr'.
772  * This register is input set register based on flow-type.
773  **/
774 static inline void i40e_write_fd_input_set(struct i40e_pf *pf,
775                                            u16 addr, u64 val)
776 {
777         i40e_write_rx_ctl(&pf->hw, I40E_PRTQF_FD_INSET(addr, 1),
778                           (u32)(val >> 32));
779         i40e_write_rx_ctl(&pf->hw, I40E_PRTQF_FD_INSET(addr, 0),
780                           (u32)(val & 0xFFFFFFFFULL));
781 }
782
783 /* needed by i40e_ethtool.c */
784 int i40e_up(struct i40e_vsi *vsi);
785 void i40e_down(struct i40e_vsi *vsi);
786 extern const char i40e_driver_name[];
787 extern const char i40e_driver_version_str[];
788 void i40e_do_reset_safe(struct i40e_pf *pf, u32 reset_flags);
789 void i40e_do_reset(struct i40e_pf *pf, u32 reset_flags);
790 int i40e_config_rss(struct i40e_vsi *vsi, u8 *seed, u8 *lut, u16 lut_size);
791 int i40e_get_rss(struct i40e_vsi *vsi, u8 *seed, u8 *lut, u16 lut_size);
792 void i40e_fill_rss_lut(struct i40e_pf *pf, u8 *lut,
793                        u16 rss_table_size, u16 rss_size);
794 struct i40e_vsi *i40e_find_vsi_from_id(struct i40e_pf *pf, u16 id);
795 /**
796  * i40e_find_vsi_by_type - Find and return Flow Director VSI
797  * @pf: PF to search for VSI
798  * @type: Value indicating type of VSI we are looking for
799  **/
800 static inline struct i40e_vsi *
801 i40e_find_vsi_by_type(struct i40e_pf *pf, u16 type)
802 {
803         int i;
804
805         for (i = 0; i < pf->num_alloc_vsi; i++) {
806                 struct i40e_vsi *vsi = pf->vsi[i];
807
808                 if (vsi && vsi->type == type)
809                         return vsi;
810         }
811
812         return NULL;
813 }
814 void i40e_update_stats(struct i40e_vsi *vsi);
815 void i40e_update_eth_stats(struct i40e_vsi *vsi);
816 struct rtnl_link_stats64 *i40e_get_vsi_stats_struct(struct i40e_vsi *vsi);
817 int i40e_fetch_switch_configuration(struct i40e_pf *pf,
818                                     bool printconfig);
819
820 int i40e_add_del_fdir(struct i40e_vsi *vsi,
821                       struct i40e_fdir_filter *input, bool add);
822 void i40e_fdir_check_and_reenable(struct i40e_pf *pf);
823 u32 i40e_get_current_fd_count(struct i40e_pf *pf);
824 u32 i40e_get_cur_guaranteed_fd_count(struct i40e_pf *pf);
825 u32 i40e_get_current_atr_cnt(struct i40e_pf *pf);
826 u32 i40e_get_global_fd_count(struct i40e_pf *pf);
827 bool i40e_set_ntuple(struct i40e_pf *pf, netdev_features_t features);
828 void i40e_set_ethtool_ops(struct net_device *netdev);
829 struct i40e_mac_filter *i40e_add_filter(struct i40e_vsi *vsi,
830                                         const u8 *macaddr, s16 vlan);
831 void __i40e_del_filter(struct i40e_vsi *vsi, struct i40e_mac_filter *f);
832 void i40e_del_filter(struct i40e_vsi *vsi, const u8 *macaddr, s16 vlan);
833 int i40e_sync_vsi_filters(struct i40e_vsi *vsi);
834 struct i40e_vsi *i40e_vsi_setup(struct i40e_pf *pf, u8 type,
835                                 u16 uplink, u32 param1);
836 int i40e_vsi_release(struct i40e_vsi *vsi);
837 #ifdef I40E_FCOE
838 void i40e_vsi_setup_queue_map(struct i40e_vsi *vsi,
839                               struct i40e_vsi_context *ctxt,
840                               u8 enabled_tc, bool is_add);
841 #endif
842 void i40e_service_event_schedule(struct i40e_pf *pf);
843 void i40e_notify_client_of_vf_msg(struct i40e_vsi *vsi, u32 vf_id,
844                                   u8 *msg, u16 len);
845
846 int i40e_vsi_start_rings(struct i40e_vsi *vsi);
847 void i40e_vsi_stop_rings(struct i40e_vsi *vsi);
848 int i40e_reconfig_rss_queues(struct i40e_pf *pf, int queue_count);
849 struct i40e_veb *i40e_veb_setup(struct i40e_pf *pf, u16 flags, u16 uplink_seid,
850                                 u16 downlink_seid, u8 enabled_tc);
851 void i40e_veb_release(struct i40e_veb *veb);
852
853 int i40e_veb_config_tc(struct i40e_veb *veb, u8 enabled_tc);
854 int i40e_vsi_add_pvid(struct i40e_vsi *vsi, u16 vid);
855 void i40e_vsi_remove_pvid(struct i40e_vsi *vsi);
856 void i40e_vsi_reset_stats(struct i40e_vsi *vsi);
857 void i40e_pf_reset_stats(struct i40e_pf *pf);
858 #ifdef CONFIG_DEBUG_FS
859 void i40e_dbg_pf_init(struct i40e_pf *pf);
860 void i40e_dbg_pf_exit(struct i40e_pf *pf);
861 void i40e_dbg_init(void);
862 void i40e_dbg_exit(void);
863 #else
864 static inline void i40e_dbg_pf_init(struct i40e_pf *pf) {}
865 static inline void i40e_dbg_pf_exit(struct i40e_pf *pf) {}
866 static inline void i40e_dbg_init(void) {}
867 static inline void i40e_dbg_exit(void) {}
868 #endif /* CONFIG_DEBUG_FS*/
869 /* needed by client drivers */
870 int i40e_lan_add_device(struct i40e_pf *pf);
871 int i40e_lan_del_device(struct i40e_pf *pf);
872 void i40e_client_subtask(struct i40e_pf *pf);
873 void i40e_notify_client_of_l2_param_changes(struct i40e_vsi *vsi);
874 void i40e_notify_client_of_netdev_close(struct i40e_vsi *vsi, bool reset);
875 void i40e_notify_client_of_vf_enable(struct i40e_pf *pf, u32 num_vfs);
876 void i40e_notify_client_of_vf_reset(struct i40e_pf *pf, u32 vf_id);
877 int i40e_vf_client_capable(struct i40e_pf *pf, u32 vf_id);
878 /**
879  * i40e_irq_dynamic_enable - Enable default interrupt generation settings
880  * @vsi: pointer to a vsi
881  * @vector: enable a particular Hw Interrupt vector, without base_vector
882  **/
883 static inline void i40e_irq_dynamic_enable(struct i40e_vsi *vsi, int vector)
884 {
885         struct i40e_pf *pf = vsi->back;
886         struct i40e_hw *hw = &pf->hw;
887         u32 val;
888
889         /* definitely clear the PBA here, as this function is meant to
890          * clean out all previous interrupts AND enable the interrupt
891          */
892         val = I40E_PFINT_DYN_CTLN_INTENA_MASK |
893               I40E_PFINT_DYN_CTLN_CLEARPBA_MASK |
894               (I40E_ITR_NONE << I40E_PFINT_DYN_CTLN_ITR_INDX_SHIFT);
895         wr32(hw, I40E_PFINT_DYN_CTLN(vector + vsi->base_vector - 1), val);
896         /* skip the flush */
897 }
898
899 void i40e_irq_dynamic_disable_icr0(struct i40e_pf *pf);
900 void i40e_irq_dynamic_enable_icr0(struct i40e_pf *pf, bool clearpba);
901 #ifdef I40E_FCOE
902 void i40e_get_netdev_stats_struct(struct net_device *netdev,
903                                   struct rtnl_link_stats64 *storage);
904 int i40e_set_mac(struct net_device *netdev, void *p);
905 void i40e_set_rx_mode(struct net_device *netdev);
906 #endif
907 int i40e_ioctl(struct net_device *netdev, struct ifreq *ifr, int cmd);
908 #ifdef I40E_FCOE
909 void i40e_tx_timeout(struct net_device *netdev);
910 int i40e_vlan_rx_add_vid(struct net_device *netdev,
911                          __always_unused __be16 proto, u16 vid);
912 int i40e_vlan_rx_kill_vid(struct net_device *netdev,
913                           __always_unused __be16 proto, u16 vid);
914 #endif
915 int i40e_open(struct net_device *netdev);
916 int i40e_close(struct net_device *netdev);
917 int i40e_vsi_open(struct i40e_vsi *vsi);
918 void i40e_vlan_stripping_disable(struct i40e_vsi *vsi);
919 int i40e_add_vlan_all_mac(struct i40e_vsi *vsi, s16 vid);
920 int i40e_vsi_add_vlan(struct i40e_vsi *vsi, u16 vid);
921 void i40e_rm_vlan_all_mac(struct i40e_vsi *vsi, s16 vid);
922 void i40e_vsi_kill_vlan(struct i40e_vsi *vsi, u16 vid);
923 struct i40e_mac_filter *i40e_add_mac_filter(struct i40e_vsi *vsi,
924                                             const u8 *macaddr);
925 int i40e_del_mac_filter(struct i40e_vsi *vsi, const u8 *macaddr);
926 bool i40e_is_vsi_in_vlan(struct i40e_vsi *vsi);
927 struct i40e_mac_filter *i40e_find_mac(struct i40e_vsi *vsi, const u8 *macaddr);
928 #ifdef I40E_FCOE
929 int __i40e_setup_tc(struct net_device *netdev, u32 handle, __be16 proto,
930                     struct tc_to_netdev *tc);
931 void i40e_netpoll(struct net_device *netdev);
932 int i40e_fcoe_enable(struct net_device *netdev);
933 int i40e_fcoe_disable(struct net_device *netdev);
934 int i40e_fcoe_vsi_init(struct i40e_vsi *vsi, struct i40e_vsi_context *ctxt);
935 u8 i40e_get_fcoe_tc_map(struct i40e_pf *pf);
936 void i40e_fcoe_config_netdev(struct net_device *netdev, struct i40e_vsi *vsi);
937 void i40e_fcoe_vsi_setup(struct i40e_pf *pf);
938 void i40e_init_pf_fcoe(struct i40e_pf *pf);
939 int i40e_fcoe_setup_ddp_resources(struct i40e_vsi *vsi);
940 void i40e_fcoe_free_ddp_resources(struct i40e_vsi *vsi);
941 int i40e_fcoe_handle_offload(struct i40e_ring *rx_ring,
942                              union i40e_rx_desc *rx_desc,
943                              struct sk_buff *skb);
944 void i40e_fcoe_handle_status(struct i40e_ring *rx_ring,
945                              union i40e_rx_desc *rx_desc, u8 prog_id);
946 #endif /* I40E_FCOE */
947 void i40e_vlan_stripping_enable(struct i40e_vsi *vsi);
948 #ifdef CONFIG_I40E_DCB
949 void i40e_dcbnl_flush_apps(struct i40e_pf *pf,
950                            struct i40e_dcbx_config *old_cfg,
951                            struct i40e_dcbx_config *new_cfg);
952 void i40e_dcbnl_set_all(struct i40e_vsi *vsi);
953 void i40e_dcbnl_setup(struct i40e_vsi *vsi);
954 bool i40e_dcb_need_reconfig(struct i40e_pf *pf,
955                             struct i40e_dcbx_config *old_cfg,
956                             struct i40e_dcbx_config *new_cfg);
957 #endif /* CONFIG_I40E_DCB */
958 void i40e_ptp_rx_hang(struct i40e_vsi *vsi);
959 void i40e_ptp_tx_hwtstamp(struct i40e_pf *pf);
960 void i40e_ptp_rx_hwtstamp(struct i40e_pf *pf, struct sk_buff *skb, u8 index);
961 void i40e_ptp_set_increment(struct i40e_pf *pf);
962 int i40e_ptp_set_ts_config(struct i40e_pf *pf, struct ifreq *ifr);
963 int i40e_ptp_get_ts_config(struct i40e_pf *pf, struct ifreq *ifr);
964 void i40e_ptp_init(struct i40e_pf *pf);
965 void i40e_ptp_stop(struct i40e_pf *pf);
966 int i40e_is_vsi_uplink_mode_veb(struct i40e_vsi *vsi);
967 i40e_status i40e_get_npar_bw_setting(struct i40e_pf *pf);
968 i40e_status i40e_set_npar_bw_setting(struct i40e_pf *pf);
969 i40e_status i40e_commit_npar_bw_setting(struct i40e_pf *pf);
970 void i40e_print_link_message(struct i40e_vsi *vsi, bool isup);
971 #endif /* _I40E_H_ */