GNU Linux-libre 4.14.290-gnu1
[releases.git] / drivers / net / ethernet / intel / ixgbe / ixgbe.h
1 /*******************************************************************************
2
3   Intel 10 Gigabit PCI Express Linux driver
4   Copyright(c) 1999 - 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 with
16   this program; if not, write to the Free Software Foundation, Inc.,
17   51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
18
19   The full GNU General Public License is included in this distribution in
20   the file called "COPYING".
21
22   Contact Information:
23   Linux NICS <linux.nics@intel.com>
24   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
25   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
26
27 *******************************************************************************/
28
29 #ifndef _IXGBE_H_
30 #define _IXGBE_H_
31
32 #include <linux/bitops.h>
33 #include <linux/types.h>
34 #include <linux/pci.h>
35 #include <linux/netdevice.h>
36 #include <linux/cpumask.h>
37 #include <linux/aer.h>
38 #include <linux/if_vlan.h>
39 #include <linux/jiffies.h>
40
41 #include <linux/timecounter.h>
42 #include <linux/net_tstamp.h>
43 #include <linux/ptp_clock_kernel.h>
44
45 #include "ixgbe_type.h"
46 #include "ixgbe_common.h"
47 #include "ixgbe_dcb.h"
48 #if IS_ENABLED(CONFIG_FCOE)
49 #define IXGBE_FCOE
50 #include "ixgbe_fcoe.h"
51 #endif /* IS_ENABLED(CONFIG_FCOE) */
52 #ifdef CONFIG_IXGBE_DCA
53 #include <linux/dca.h>
54 #endif
55
56 #include <net/busy_poll.h>
57
58 /* common prefix used by pr_<> macros */
59 #undef pr_fmt
60 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
61
62 /* TX/RX descriptor defines */
63 #define IXGBE_DEFAULT_TXD                   512
64 #define IXGBE_DEFAULT_TX_WORK               256
65 #define IXGBE_MAX_TXD                      4096
66 #define IXGBE_MIN_TXD                        64
67
68 #if (PAGE_SIZE < 8192)
69 #define IXGBE_DEFAULT_RXD                   512
70 #else
71 #define IXGBE_DEFAULT_RXD                   128
72 #endif
73 #define IXGBE_MAX_RXD                      4096
74 #define IXGBE_MIN_RXD                        64
75
76 #define IXGBE_ETH_P_LLDP                 0x88CC
77
78 /* flow control */
79 #define IXGBE_MIN_FCRTL                    0x40
80 #define IXGBE_MAX_FCRTL                 0x7FF80
81 #define IXGBE_MIN_FCRTH                   0x600
82 #define IXGBE_MAX_FCRTH                 0x7FFF0
83 #define IXGBE_DEFAULT_FCPAUSE            0xFFFF
84 #define IXGBE_MIN_FCPAUSE                     0
85 #define IXGBE_MAX_FCPAUSE                0xFFFF
86
87 /* Supported Rx Buffer Sizes */
88 #define IXGBE_RXBUFFER_256    256  /* Used for skb receive header */
89 #define IXGBE_RXBUFFER_1536  1536
90 #define IXGBE_RXBUFFER_2K    2048
91 #define IXGBE_RXBUFFER_3K    3072
92 #define IXGBE_RXBUFFER_4K    4096
93 #define IXGBE_MAX_RXBUFFER  16384  /* largest size for a single descriptor */
94
95 /* Attempt to maximize the headroom available for incoming frames.  We
96  * use a 2K buffer for receives and need 1536/1534 to store the data for
97  * the frame.  This leaves us with 512 bytes of room.  From that we need
98  * to deduct the space needed for the shared info and the padding needed
99  * to IP align the frame.
100  *
101  * Note: For cache line sizes 256 or larger this value is going to end
102  *       up negative.  In these cases we should fall back to the 3K
103  *       buffers.
104  */
105 #if (PAGE_SIZE < 8192)
106 #define IXGBE_MAX_2K_FRAME_BUILD_SKB (IXGBE_RXBUFFER_1536 - NET_IP_ALIGN)
107 #define IXGBE_2K_TOO_SMALL_WITH_PADDING \
108 ((NET_SKB_PAD + IXGBE_RXBUFFER_1536) > SKB_WITH_OVERHEAD(IXGBE_RXBUFFER_2K))
109
110 static inline int ixgbe_compute_pad(int rx_buf_len)
111 {
112         int page_size, pad_size;
113
114         page_size = ALIGN(rx_buf_len, PAGE_SIZE / 2);
115         pad_size = SKB_WITH_OVERHEAD(page_size) - rx_buf_len;
116
117         return pad_size;
118 }
119
120 static inline int ixgbe_skb_pad(void)
121 {
122         int rx_buf_len;
123
124         /* If a 2K buffer cannot handle a standard Ethernet frame then
125          * optimize padding for a 3K buffer instead of a 1.5K buffer.
126          *
127          * For a 3K buffer we need to add enough padding to allow for
128          * tailroom due to NET_IP_ALIGN possibly shifting us out of
129          * cache-line alignment.
130          */
131         if (IXGBE_2K_TOO_SMALL_WITH_PADDING)
132                 rx_buf_len = IXGBE_RXBUFFER_3K + SKB_DATA_ALIGN(NET_IP_ALIGN);
133         else
134                 rx_buf_len = IXGBE_RXBUFFER_1536;
135
136         /* if needed make room for NET_IP_ALIGN */
137         rx_buf_len -= NET_IP_ALIGN;
138
139         return ixgbe_compute_pad(rx_buf_len);
140 }
141
142 #define IXGBE_SKB_PAD   ixgbe_skb_pad()
143 #else
144 #define IXGBE_SKB_PAD   (NET_SKB_PAD + NET_IP_ALIGN)
145 #endif
146
147 /*
148  * NOTE: netdev_alloc_skb reserves up to 64 bytes, NET_IP_ALIGN means we
149  * reserve 64 more, and skb_shared_info adds an additional 320 bytes more,
150  * this adds up to 448 bytes of extra data.
151  *
152  * Since netdev_alloc_skb now allocates a page fragment we can use a value
153  * of 256 and the resultant skb will have a truesize of 960 or less.
154  */
155 #define IXGBE_RX_HDR_SIZE IXGBE_RXBUFFER_256
156
157 /* How many Rx Buffers do we bundle into one write to the hardware ? */
158 #define IXGBE_RX_BUFFER_WRITE   16      /* Must be power of 2 */
159
160 #define IXGBE_RX_DMA_ATTR \
161         (DMA_ATTR_SKIP_CPU_SYNC | DMA_ATTR_WEAK_ORDERING)
162
163 enum ixgbe_tx_flags {
164         /* cmd_type flags */
165         IXGBE_TX_FLAGS_HW_VLAN  = 0x01,
166         IXGBE_TX_FLAGS_TSO      = 0x02,
167         IXGBE_TX_FLAGS_TSTAMP   = 0x04,
168
169         /* olinfo flags */
170         IXGBE_TX_FLAGS_CC       = 0x08,
171         IXGBE_TX_FLAGS_IPV4     = 0x10,
172         IXGBE_TX_FLAGS_CSUM     = 0x20,
173
174         /* software defined flags */
175         IXGBE_TX_FLAGS_SW_VLAN  = 0x40,
176         IXGBE_TX_FLAGS_FCOE     = 0x80,
177 };
178
179 /* VLAN info */
180 #define IXGBE_TX_FLAGS_VLAN_MASK        0xffff0000
181 #define IXGBE_TX_FLAGS_VLAN_PRIO_MASK   0xe0000000
182 #define IXGBE_TX_FLAGS_VLAN_PRIO_SHIFT  29
183 #define IXGBE_TX_FLAGS_VLAN_SHIFT       16
184
185 #define IXGBE_MAX_VF_MC_ENTRIES         30
186 #define IXGBE_MAX_VF_FUNCTIONS          64
187 #define IXGBE_MAX_VFTA_ENTRIES          128
188 #define MAX_EMULATION_MAC_ADDRS         16
189 #define IXGBE_MAX_PF_MACVLANS           15
190 #define VMDQ_P(p)   ((p) + adapter->ring_feature[RING_F_VMDQ].offset)
191 #define IXGBE_82599_VF_DEVICE_ID        0x10ED
192 #define IXGBE_X540_VF_DEVICE_ID         0x1515
193
194 struct vf_data_storage {
195         struct pci_dev *vfdev;
196         unsigned char vf_mac_addresses[ETH_ALEN];
197         u16 vf_mc_hashes[IXGBE_MAX_VF_MC_ENTRIES];
198         u16 num_vf_mc_hashes;
199         bool clear_to_send;
200         bool pf_set_mac;
201         u16 pf_vlan; /* When set, guest VLAN config not allowed. */
202         u16 pf_qos;
203         u16 tx_rate;
204         u8 spoofchk_enabled;
205         bool rss_query_enabled;
206         u8 trusted;
207         int xcast_mode;
208         unsigned int vf_api;
209 };
210
211 enum ixgbevf_xcast_modes {
212         IXGBEVF_XCAST_MODE_NONE = 0,
213         IXGBEVF_XCAST_MODE_MULTI,
214         IXGBEVF_XCAST_MODE_ALLMULTI,
215         IXGBEVF_XCAST_MODE_PROMISC,
216 };
217
218 struct vf_macvlans {
219         struct list_head l;
220         int vf;
221         bool free;
222         bool is_macvlan;
223         u8 vf_macvlan[ETH_ALEN];
224 };
225
226 #define IXGBE_MAX_TXD_PWR       14
227 #define IXGBE_MAX_DATA_PER_TXD  (1u << IXGBE_MAX_TXD_PWR)
228
229 /* Tx Descriptors needed, worst case */
230 #define TXD_USE_COUNT(S) DIV_ROUND_UP((S), IXGBE_MAX_DATA_PER_TXD)
231 #define DESC_NEEDED (MAX_SKB_FRAGS + 4)
232
233 /* wrapper around a pointer to a socket buffer,
234  * so a DMA handle can be stored along with the buffer */
235 struct ixgbe_tx_buffer {
236         union ixgbe_adv_tx_desc *next_to_watch;
237         unsigned long time_stamp;
238         union {
239                 struct sk_buff *skb;
240                 /* XDP uses address ptr on irq_clean */
241                 void *data;
242         };
243         unsigned int bytecount;
244         unsigned short gso_segs;
245         __be16 protocol;
246         DEFINE_DMA_UNMAP_ADDR(dma);
247         DEFINE_DMA_UNMAP_LEN(len);
248         u32 tx_flags;
249 };
250
251 struct ixgbe_rx_buffer {
252         struct sk_buff *skb;
253         dma_addr_t dma;
254         struct page *page;
255 #if (BITS_PER_LONG > 32) || (PAGE_SIZE >= 65536)
256         __u32 page_offset;
257 #else
258         __u16 page_offset;
259 #endif
260         __u16 pagecnt_bias;
261 };
262
263 struct ixgbe_queue_stats {
264         u64 packets;
265         u64 bytes;
266 };
267
268 struct ixgbe_tx_queue_stats {
269         u64 restart_queue;
270         u64 tx_busy;
271         u64 tx_done_old;
272 };
273
274 struct ixgbe_rx_queue_stats {
275         u64 rsc_count;
276         u64 rsc_flush;
277         u64 non_eop_descs;
278         u64 alloc_rx_page_failed;
279         u64 alloc_rx_buff_failed;
280         u64 csum_err;
281 };
282
283 #define IXGBE_TS_HDR_LEN 8
284
285 enum ixgbe_ring_state_t {
286         __IXGBE_RX_3K_BUFFER,
287         __IXGBE_RX_BUILD_SKB_ENABLED,
288         __IXGBE_RX_RSC_ENABLED,
289         __IXGBE_RX_CSUM_UDP_ZERO_ERR,
290         __IXGBE_RX_FCOE,
291         __IXGBE_TX_FDIR_INIT_DONE,
292         __IXGBE_TX_XPS_INIT_DONE,
293         __IXGBE_TX_DETECT_HANG,
294         __IXGBE_HANG_CHECK_ARMED,
295         __IXGBE_TX_XDP_RING,
296 };
297
298 #define ring_uses_build_skb(ring) \
299         test_bit(__IXGBE_RX_BUILD_SKB_ENABLED, &(ring)->state)
300
301 struct ixgbe_fwd_adapter {
302         unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
303         struct net_device *netdev;
304         struct ixgbe_adapter *real_adapter;
305         unsigned int tx_base_queue;
306         unsigned int rx_base_queue;
307         int pool;
308 };
309
310 #define check_for_tx_hang(ring) \
311         test_bit(__IXGBE_TX_DETECT_HANG, &(ring)->state)
312 #define set_check_for_tx_hang(ring) \
313         set_bit(__IXGBE_TX_DETECT_HANG, &(ring)->state)
314 #define clear_check_for_tx_hang(ring) \
315         clear_bit(__IXGBE_TX_DETECT_HANG, &(ring)->state)
316 #define ring_is_rsc_enabled(ring) \
317         test_bit(__IXGBE_RX_RSC_ENABLED, &(ring)->state)
318 #define set_ring_rsc_enabled(ring) \
319         set_bit(__IXGBE_RX_RSC_ENABLED, &(ring)->state)
320 #define clear_ring_rsc_enabled(ring) \
321         clear_bit(__IXGBE_RX_RSC_ENABLED, &(ring)->state)
322 #define ring_is_xdp(ring) \
323         test_bit(__IXGBE_TX_XDP_RING, &(ring)->state)
324 #define set_ring_xdp(ring) \
325         set_bit(__IXGBE_TX_XDP_RING, &(ring)->state)
326 #define clear_ring_xdp(ring) \
327         clear_bit(__IXGBE_TX_XDP_RING, &(ring)->state)
328 struct ixgbe_ring {
329         struct ixgbe_ring *next;        /* pointer to next ring in q_vector */
330         struct ixgbe_q_vector *q_vector; /* backpointer to host q_vector */
331         struct net_device *netdev;      /* netdev ring belongs to */
332         struct bpf_prog *xdp_prog;
333         struct device *dev;             /* device for DMA mapping */
334         struct ixgbe_fwd_adapter *l2_accel_priv;
335         void *desc;                     /* descriptor ring memory */
336         union {
337                 struct ixgbe_tx_buffer *tx_buffer_info;
338                 struct ixgbe_rx_buffer *rx_buffer_info;
339         };
340         unsigned long state;
341         u8 __iomem *tail;
342         dma_addr_t dma;                 /* phys. address of descriptor ring */
343         unsigned int size;              /* length in bytes */
344
345         u16 count;                      /* amount of descriptors */
346
347         u8 queue_index; /* needed for multiqueue queue management */
348         u8 reg_idx;                     /* holds the special value that gets
349                                          * the hardware register offset
350                                          * associated with this ring, which is
351                                          * different for DCB and RSS modes
352                                          */
353         u16 next_to_use;
354         u16 next_to_clean;
355
356         unsigned long last_rx_timestamp;
357
358         union {
359                 u16 next_to_alloc;
360                 struct {
361                         u8 atr_sample_rate;
362                         u8 atr_count;
363                 };
364         };
365
366         u8 dcb_tc;
367         struct ixgbe_queue_stats stats;
368         struct u64_stats_sync syncp;
369         union {
370                 struct ixgbe_tx_queue_stats tx_stats;
371                 struct ixgbe_rx_queue_stats rx_stats;
372         };
373 } ____cacheline_internodealigned_in_smp;
374
375 enum ixgbe_ring_f_enum {
376         RING_F_NONE = 0,
377         RING_F_VMDQ,  /* SR-IOV uses the same ring feature */
378         RING_F_RSS,
379         RING_F_FDIR,
380 #ifdef IXGBE_FCOE
381         RING_F_FCOE,
382 #endif /* IXGBE_FCOE */
383
384         RING_F_ARRAY_SIZE      /* must be last in enum set */
385 };
386
387 #define IXGBE_MAX_RSS_INDICES           16
388 #define IXGBE_MAX_RSS_INDICES_X550      63
389 #define IXGBE_MAX_VMDQ_INDICES          64
390 #define IXGBE_MAX_FDIR_INDICES          63      /* based on q_vector limit */
391 #define IXGBE_MAX_FCOE_INDICES          8
392 #define MAX_RX_QUEUES                   (IXGBE_MAX_FDIR_INDICES + 1)
393 #define MAX_TX_QUEUES                   (IXGBE_MAX_FDIR_INDICES + 1)
394 #define MAX_XDP_QUEUES                  (IXGBE_MAX_FDIR_INDICES + 1)
395 #define IXGBE_MAX_L2A_QUEUES            4
396 #define IXGBE_BAD_L2A_QUEUE             3
397 #define IXGBE_MAX_MACVLANS              31
398 #define IXGBE_MAX_DCBMACVLANS           8
399
400 struct ixgbe_ring_feature {
401         u16 limit;      /* upper limit on feature indices */
402         u16 indices;    /* current value of indices */
403         u16 mask;       /* Mask used for feature to ring mapping */
404         u16 offset;     /* offset to start of feature */
405 } ____cacheline_internodealigned_in_smp;
406
407 #define IXGBE_82599_VMDQ_8Q_MASK 0x78
408 #define IXGBE_82599_VMDQ_4Q_MASK 0x7C
409 #define IXGBE_82599_VMDQ_2Q_MASK 0x7E
410
411 /*
412  * FCoE requires that all Rx buffers be over 2200 bytes in length.  Since
413  * this is twice the size of a half page we need to double the page order
414  * for FCoE enabled Rx queues.
415  */
416 static inline unsigned int ixgbe_rx_bufsz(struct ixgbe_ring *ring)
417 {
418         if (test_bit(__IXGBE_RX_3K_BUFFER, &ring->state))
419                 return IXGBE_RXBUFFER_3K;
420 #if (PAGE_SIZE < 8192)
421         if (ring_uses_build_skb(ring))
422                 return IXGBE_MAX_2K_FRAME_BUILD_SKB;
423 #endif
424         return IXGBE_RXBUFFER_2K;
425 }
426
427 static inline unsigned int ixgbe_rx_pg_order(struct ixgbe_ring *ring)
428 {
429 #if (PAGE_SIZE < 8192)
430         if (test_bit(__IXGBE_RX_3K_BUFFER, &ring->state))
431                 return 1;
432 #endif
433         return 0;
434 }
435 #define ixgbe_rx_pg_size(_ring) (PAGE_SIZE << ixgbe_rx_pg_order(_ring))
436
437 struct ixgbe_ring_container {
438         struct ixgbe_ring *ring;        /* pointer to linked list of rings */
439         unsigned int total_bytes;       /* total bytes processed this int */
440         unsigned int total_packets;     /* total packets processed this int */
441         u16 work_limit;                 /* total work allowed per interrupt */
442         u8 count;                       /* total number of rings in vector */
443         u8 itr;                         /* current ITR setting for ring */
444 };
445
446 /* iterator for handling rings in ring container */
447 #define ixgbe_for_each_ring(pos, head) \
448         for (pos = (head).ring; pos != NULL; pos = pos->next)
449
450 #define MAX_RX_PACKET_BUFFERS ((adapter->flags & IXGBE_FLAG_DCB_ENABLED) \
451                               ? 8 : 1)
452 #define MAX_TX_PACKET_BUFFERS MAX_RX_PACKET_BUFFERS
453
454 /* MAX_Q_VECTORS of these are allocated,
455  * but we only use one per queue-specific vector.
456  */
457 struct ixgbe_q_vector {
458         struct ixgbe_adapter *adapter;
459 #ifdef CONFIG_IXGBE_DCA
460         int cpu;            /* CPU for DCA */
461 #endif
462         u16 v_idx;              /* index of q_vector within array, also used for
463                                  * finding the bit in EICR and friends that
464                                  * represents the vector for this ring */
465         u16 itr;                /* Interrupt throttle rate written to EITR */
466         struct ixgbe_ring_container rx, tx;
467
468         struct napi_struct napi;
469         cpumask_t affinity_mask;
470         int numa_node;
471         struct rcu_head rcu;    /* to avoid race with update stats on free */
472         char name[IFNAMSIZ + 9];
473
474         /* for dynamic allocation of rings associated with this q_vector */
475         struct ixgbe_ring ring[0] ____cacheline_internodealigned_in_smp;
476 };
477
478 #ifdef CONFIG_IXGBE_HWMON
479
480 #define IXGBE_HWMON_TYPE_LOC            0
481 #define IXGBE_HWMON_TYPE_TEMP           1
482 #define IXGBE_HWMON_TYPE_CAUTION        2
483 #define IXGBE_HWMON_TYPE_MAX            3
484
485 struct hwmon_attr {
486         struct device_attribute dev_attr;
487         struct ixgbe_hw *hw;
488         struct ixgbe_thermal_diode_data *sensor;
489         char name[12];
490 };
491
492 struct hwmon_buff {
493         struct attribute_group group;
494         const struct attribute_group *groups[2];
495         struct attribute *attrs[IXGBE_MAX_SENSORS * 4 + 1];
496         struct hwmon_attr hwmon_list[IXGBE_MAX_SENSORS * 4];
497         unsigned int n_hwmon;
498 };
499 #endif /* CONFIG_IXGBE_HWMON */
500
501 /*
502  * microsecond values for various ITR rates shifted by 2 to fit itr register
503  * with the first 3 bits reserved 0
504  */
505 #define IXGBE_MIN_RSC_ITR       24
506 #define IXGBE_100K_ITR          40
507 #define IXGBE_20K_ITR           200
508 #define IXGBE_12K_ITR           336
509
510 /* ixgbe_test_staterr - tests bits in Rx descriptor status and error fields */
511 static inline __le32 ixgbe_test_staterr(union ixgbe_adv_rx_desc *rx_desc,
512                                         const u32 stat_err_bits)
513 {
514         return rx_desc->wb.upper.status_error & cpu_to_le32(stat_err_bits);
515 }
516
517 static inline u16 ixgbe_desc_unused(struct ixgbe_ring *ring)
518 {
519         u16 ntc = ring->next_to_clean;
520         u16 ntu = ring->next_to_use;
521
522         return ((ntc > ntu) ? 0 : ring->count) + ntc - ntu - 1;
523 }
524
525 #define IXGBE_RX_DESC(R, i)         \
526         (&(((union ixgbe_adv_rx_desc *)((R)->desc))[i]))
527 #define IXGBE_TX_DESC(R, i)         \
528         (&(((union ixgbe_adv_tx_desc *)((R)->desc))[i]))
529 #define IXGBE_TX_CTXTDESC(R, i)     \
530         (&(((struct ixgbe_adv_tx_context_desc *)((R)->desc))[i]))
531
532 #define IXGBE_MAX_JUMBO_FRAME_SIZE      9728 /* Maximum Supported Size 9.5KB */
533 #ifdef IXGBE_FCOE
534 /* Use 3K as the baby jumbo frame size for FCoE */
535 #define IXGBE_FCOE_JUMBO_FRAME_SIZE       3072
536 #endif /* IXGBE_FCOE */
537
538 #define OTHER_VECTOR 1
539 #define NON_Q_VECTORS (OTHER_VECTOR)
540
541 #define MAX_MSIX_VECTORS_82599 64
542 #define MAX_Q_VECTORS_82599 64
543 #define MAX_MSIX_VECTORS_82598 18
544 #define MAX_Q_VECTORS_82598 16
545
546 struct ixgbe_mac_addr {
547         u8 addr[ETH_ALEN];
548         u16 pool;
549         u16 state; /* bitmask */
550 };
551
552 #define IXGBE_MAC_STATE_DEFAULT         0x1
553 #define IXGBE_MAC_STATE_MODIFIED        0x2
554 #define IXGBE_MAC_STATE_IN_USE          0x4
555
556 #define MAX_Q_VECTORS MAX_Q_VECTORS_82599
557 #define MAX_MSIX_COUNT MAX_MSIX_VECTORS_82599
558
559 #define MIN_MSIX_Q_VECTORS 1
560 #define MIN_MSIX_COUNT (MIN_MSIX_Q_VECTORS + NON_Q_VECTORS)
561
562 /* default to trying for four seconds */
563 #define IXGBE_TRY_LINK_TIMEOUT (4 * HZ)
564 #define IXGBE_SFP_POLL_JIFFIES (2 * HZ) /* SFP poll every 2 seconds */
565
566 /* board specific private data structure */
567 struct ixgbe_adapter {
568         unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
569         /* OS defined structs */
570         struct net_device *netdev;
571         struct bpf_prog *xdp_prog;
572         struct pci_dev *pdev;
573
574         unsigned long state;
575
576         /* Some features need tri-state capability,
577          * thus the additional *_CAPABLE flags.
578          */
579         u32 flags;
580 #define IXGBE_FLAG_MSI_ENABLED                  BIT(1)
581 #define IXGBE_FLAG_MSIX_ENABLED                 BIT(3)
582 #define IXGBE_FLAG_RX_1BUF_CAPABLE              BIT(4)
583 #define IXGBE_FLAG_RX_PS_CAPABLE                BIT(5)
584 #define IXGBE_FLAG_RX_PS_ENABLED                BIT(6)
585 #define IXGBE_FLAG_DCA_ENABLED                  BIT(8)
586 #define IXGBE_FLAG_DCA_CAPABLE                  BIT(9)
587 #define IXGBE_FLAG_IMIR_ENABLED                 BIT(10)
588 #define IXGBE_FLAG_MQ_CAPABLE                   BIT(11)
589 #define IXGBE_FLAG_DCB_ENABLED                  BIT(12)
590 #define IXGBE_FLAG_VMDQ_CAPABLE                 BIT(13)
591 #define IXGBE_FLAG_VMDQ_ENABLED                 BIT(14)
592 #define IXGBE_FLAG_FAN_FAIL_CAPABLE             BIT(15)
593 #define IXGBE_FLAG_NEED_LINK_UPDATE             BIT(16)
594 #define IXGBE_FLAG_NEED_LINK_CONFIG             BIT(17)
595 #define IXGBE_FLAG_FDIR_HASH_CAPABLE            BIT(18)
596 #define IXGBE_FLAG_FDIR_PERFECT_CAPABLE         BIT(19)
597 #define IXGBE_FLAG_FCOE_CAPABLE                 BIT(20)
598 #define IXGBE_FLAG_FCOE_ENABLED                 BIT(21)
599 #define IXGBE_FLAG_SRIOV_CAPABLE                BIT(22)
600 #define IXGBE_FLAG_SRIOV_ENABLED                BIT(23)
601 #define IXGBE_FLAG_VXLAN_OFFLOAD_CAPABLE        BIT(24)
602 #define IXGBE_FLAG_RX_HWTSTAMP_ENABLED          BIT(25)
603 #define IXGBE_FLAG_RX_HWTSTAMP_IN_REGISTER      BIT(26)
604 #define IXGBE_FLAG_DCB_CAPABLE                  BIT(27)
605 #define IXGBE_FLAG_GENEVE_OFFLOAD_CAPABLE       BIT(28)
606
607         u32 flags2;
608 #define IXGBE_FLAG2_RSC_CAPABLE                 BIT(0)
609 #define IXGBE_FLAG2_RSC_ENABLED                 BIT(1)
610 #define IXGBE_FLAG2_TEMP_SENSOR_CAPABLE         BIT(2)
611 #define IXGBE_FLAG2_TEMP_SENSOR_EVENT           BIT(3)
612 #define IXGBE_FLAG2_SEARCH_FOR_SFP              BIT(4)
613 #define IXGBE_FLAG2_SFP_NEEDS_RESET             BIT(5)
614 #define IXGBE_FLAG2_FDIR_REQUIRES_REINIT        BIT(7)
615 #define IXGBE_FLAG2_RSS_FIELD_IPV4_UDP          BIT(8)
616 #define IXGBE_FLAG2_RSS_FIELD_IPV6_UDP          BIT(9)
617 #define IXGBE_FLAG2_PTP_PPS_ENABLED             BIT(10)
618 #define IXGBE_FLAG2_PHY_INTERRUPT               BIT(11)
619 #define IXGBE_FLAG2_UDP_TUN_REREG_NEEDED        BIT(12)
620 #define IXGBE_FLAG2_VLAN_PROMISC                BIT(13)
621 #define IXGBE_FLAG2_EEE_CAPABLE                 BIT(14)
622 #define IXGBE_FLAG2_EEE_ENABLED                 BIT(15)
623 #define IXGBE_FLAG2_RX_LEGACY                   BIT(16)
624
625         /* Tx fast path data */
626         int num_tx_queues;
627         u16 tx_itr_setting;
628         u16 tx_work_limit;
629
630         /* Rx fast path data */
631         int num_rx_queues;
632         u16 rx_itr_setting;
633
634         /* Port number used to identify VXLAN traffic */
635         __be16 vxlan_port;
636         __be16 geneve_port;
637
638         /* XDP */
639         int num_xdp_queues;
640         struct ixgbe_ring *xdp_ring[MAX_XDP_QUEUES];
641
642         /* TX */
643         struct ixgbe_ring *tx_ring[MAX_TX_QUEUES] ____cacheline_aligned_in_smp;
644
645         u64 restart_queue;
646         u64 lsc_int;
647         u32 tx_timeout_count;
648
649         /* RX */
650         struct ixgbe_ring *rx_ring[MAX_RX_QUEUES];
651         int num_rx_pools;               /* == num_rx_queues in 82598 */
652         int num_rx_queues_per_pool;     /* 1 if 82598, can be many if 82599 */
653         u64 hw_csum_rx_error;
654         u64 hw_rx_no_dma_resources;
655         u64 rsc_total_count;
656         u64 rsc_total_flush;
657         u64 non_eop_descs;
658         u32 alloc_rx_page_failed;
659         u32 alloc_rx_buff_failed;
660
661         struct ixgbe_q_vector *q_vector[MAX_Q_VECTORS];
662
663         /* DCB parameters */
664         struct ieee_pfc *ixgbe_ieee_pfc;
665         struct ieee_ets *ixgbe_ieee_ets;
666         struct ixgbe_dcb_config dcb_cfg;
667         struct ixgbe_dcb_config temp_dcb_cfg;
668         u8 dcb_set_bitmap;
669         u8 dcbx_cap;
670         enum ixgbe_fc_mode last_lfc_mode;
671
672         int num_q_vectors;      /* current number of q_vectors for device */
673         int max_q_vectors;      /* true count of q_vectors for device */
674         struct ixgbe_ring_feature ring_feature[RING_F_ARRAY_SIZE];
675         struct msix_entry *msix_entries;
676
677         u32 test_icr;
678         struct ixgbe_ring test_tx_ring;
679         struct ixgbe_ring test_rx_ring;
680
681         /* structs defined in ixgbe_hw.h */
682         struct ixgbe_hw hw;
683         u16 msg_enable;
684         struct ixgbe_hw_stats stats;
685
686         u64 tx_busy;
687         unsigned int tx_ring_count;
688         unsigned int xdp_ring_count;
689         unsigned int rx_ring_count;
690
691         u32 link_speed;
692         bool link_up;
693         unsigned long sfp_poll_time;
694         unsigned long link_check_timeout;
695
696         struct timer_list service_timer;
697         struct work_struct service_task;
698
699         struct hlist_head fdir_filter_list;
700         unsigned long fdir_overflow; /* number of times ATR was backed off */
701         union ixgbe_atr_input fdir_mask;
702         int fdir_filter_count;
703         u32 fdir_pballoc;
704         u32 atr_sample_rate;
705         spinlock_t fdir_perfect_lock;
706
707 #ifdef IXGBE_FCOE
708         struct ixgbe_fcoe fcoe;
709 #endif /* IXGBE_FCOE */
710         u8 __iomem *io_addr; /* Mainly for iounmap use */
711         u32 wol;
712
713         u16 bridge_mode;
714
715         u16 eeprom_verh;
716         u16 eeprom_verl;
717         u16 eeprom_cap;
718
719         u32 interrupt_event;
720         u32 led_reg;
721
722         struct ptp_clock *ptp_clock;
723         struct ptp_clock_info ptp_caps;
724         struct work_struct ptp_tx_work;
725         struct sk_buff *ptp_tx_skb;
726         struct hwtstamp_config tstamp_config;
727         unsigned long ptp_tx_start;
728         unsigned long last_overflow_check;
729         unsigned long last_rx_ptp_check;
730         unsigned long last_rx_timestamp;
731         spinlock_t tmreg_lock;
732         struct cyclecounter hw_cc;
733         struct timecounter hw_tc;
734         u32 base_incval;
735         u32 tx_hwtstamp_timeouts;
736         u32 tx_hwtstamp_skipped;
737         u32 rx_hwtstamp_cleared;
738         void (*ptp_setup_sdp)(struct ixgbe_adapter *);
739
740         /* SR-IOV */
741         DECLARE_BITMAP(active_vfs, IXGBE_MAX_VF_FUNCTIONS);
742         unsigned int num_vfs;
743         struct vf_data_storage *vfinfo;
744         int vf_rate_link_speed;
745         struct vf_macvlans vf_mvs;
746         struct vf_macvlans *mv_list;
747
748         u32 timer_event_accumulator;
749         u32 vferr_refcount;
750         struct ixgbe_mac_addr *mac_table;
751         struct kobject *info_kobj;
752 #ifdef CONFIG_IXGBE_HWMON
753         struct hwmon_buff *ixgbe_hwmon_buff;
754 #endif /* CONFIG_IXGBE_HWMON */
755 #ifdef CONFIG_DEBUG_FS
756         struct dentry *ixgbe_dbg_adapter;
757 #endif /*CONFIG_DEBUG_FS*/
758
759         u8 default_up;
760         unsigned long fwd_bitmask; /* Bitmask indicating in use pools */
761
762 #define IXGBE_MAX_LINK_HANDLE 10
763         struct ixgbe_jump_table *jump_tables[IXGBE_MAX_LINK_HANDLE];
764         unsigned long tables;
765
766 /* maximum number of RETA entries among all devices supported by ixgbe
767  * driver: currently it's x550 device in non-SRIOV mode
768  */
769 #define IXGBE_MAX_RETA_ENTRIES 512
770         u8 rss_indir_tbl[IXGBE_MAX_RETA_ENTRIES];
771
772 #define IXGBE_RSS_KEY_SIZE     40  /* size of RSS Hash Key in bytes */
773         u32 *rss_key;
774 };
775
776 static inline u8 ixgbe_max_rss_indices(struct ixgbe_adapter *adapter)
777 {
778         switch (adapter->hw.mac.type) {
779         case ixgbe_mac_82598EB:
780         case ixgbe_mac_82599EB:
781         case ixgbe_mac_X540:
782                 return IXGBE_MAX_RSS_INDICES;
783         case ixgbe_mac_X550:
784         case ixgbe_mac_X550EM_x:
785         case ixgbe_mac_x550em_a:
786                 return IXGBE_MAX_RSS_INDICES_X550;
787         default:
788                 return 0;
789         }
790 }
791
792 struct ixgbe_fdir_filter {
793         struct hlist_node fdir_node;
794         union ixgbe_atr_input filter;
795         u16 sw_idx;
796         u64 action;
797 };
798
799 enum ixgbe_state_t {
800         __IXGBE_TESTING,
801         __IXGBE_RESETTING,
802         __IXGBE_DOWN,
803         __IXGBE_DISABLED,
804         __IXGBE_REMOVING,
805         __IXGBE_SERVICE_SCHED,
806         __IXGBE_SERVICE_INITED,
807         __IXGBE_IN_SFP_INIT,
808         __IXGBE_PTP_RUNNING,
809         __IXGBE_PTP_TX_IN_PROGRESS,
810         __IXGBE_RESET_REQUESTED,
811 };
812
813 struct ixgbe_cb {
814         union {                         /* Union defining head/tail partner */
815                 struct sk_buff *head;
816                 struct sk_buff *tail;
817         };
818         dma_addr_t dma;
819         u16 append_cnt;
820         bool page_released;
821 };
822 #define IXGBE_CB(skb) ((struct ixgbe_cb *)(skb)->cb)
823
824 enum ixgbe_boards {
825         board_82598,
826         board_82599,
827         board_X540,
828         board_X550,
829         board_X550EM_x,
830         board_x550em_x_fw,
831         board_x550em_a,
832         board_x550em_a_fw,
833 };
834
835 extern const struct ixgbe_info ixgbe_82598_info;
836 extern const struct ixgbe_info ixgbe_82599_info;
837 extern const struct ixgbe_info ixgbe_X540_info;
838 extern const struct ixgbe_info ixgbe_X550_info;
839 extern const struct ixgbe_info ixgbe_X550EM_x_info;
840 extern const struct ixgbe_info ixgbe_x550em_x_fw_info;
841 extern const struct ixgbe_info ixgbe_x550em_a_info;
842 extern const struct ixgbe_info ixgbe_x550em_a_fw_info;
843 #ifdef CONFIG_IXGBE_DCB
844 extern const struct dcbnl_rtnl_ops ixgbe_dcbnl_ops;
845 #endif
846
847 extern char ixgbe_driver_name[];
848 extern const char ixgbe_driver_version[];
849 #ifdef IXGBE_FCOE
850 extern char ixgbe_default_device_descr[];
851 #endif /* IXGBE_FCOE */
852
853 int ixgbe_open(struct net_device *netdev);
854 int ixgbe_close(struct net_device *netdev);
855 void ixgbe_up(struct ixgbe_adapter *adapter);
856 void ixgbe_down(struct ixgbe_adapter *adapter);
857 void ixgbe_reinit_locked(struct ixgbe_adapter *adapter);
858 void ixgbe_reset(struct ixgbe_adapter *adapter);
859 void ixgbe_set_ethtool_ops(struct net_device *netdev);
860 int ixgbe_setup_rx_resources(struct ixgbe_adapter *, struct ixgbe_ring *);
861 int ixgbe_setup_tx_resources(struct ixgbe_ring *);
862 void ixgbe_free_rx_resources(struct ixgbe_ring *);
863 void ixgbe_free_tx_resources(struct ixgbe_ring *);
864 void ixgbe_configure_rx_ring(struct ixgbe_adapter *, struct ixgbe_ring *);
865 void ixgbe_configure_tx_ring(struct ixgbe_adapter *, struct ixgbe_ring *);
866 void ixgbe_disable_rx_queue(struct ixgbe_adapter *adapter, struct ixgbe_ring *);
867 void ixgbe_update_stats(struct ixgbe_adapter *adapter);
868 int ixgbe_init_interrupt_scheme(struct ixgbe_adapter *adapter);
869 bool ixgbe_wol_supported(struct ixgbe_adapter *adapter, u16 device_id,
870                          u16 subdevice_id);
871 #ifdef CONFIG_PCI_IOV
872 void ixgbe_full_sync_mac_table(struct ixgbe_adapter *adapter);
873 #endif
874 int ixgbe_add_mac_filter(struct ixgbe_adapter *adapter,
875                          const u8 *addr, u16 queue);
876 int ixgbe_del_mac_filter(struct ixgbe_adapter *adapter,
877                          const u8 *addr, u16 queue);
878 void ixgbe_update_pf_promisc_vlvf(struct ixgbe_adapter *adapter, u32 vid);
879 void ixgbe_clear_interrupt_scheme(struct ixgbe_adapter *adapter);
880 netdev_tx_t ixgbe_xmit_frame_ring(struct sk_buff *, struct ixgbe_adapter *,
881                                   struct ixgbe_ring *);
882 void ixgbe_unmap_and_free_tx_resource(struct ixgbe_ring *,
883                                       struct ixgbe_tx_buffer *);
884 void ixgbe_alloc_rx_buffers(struct ixgbe_ring *, u16);
885 void ixgbe_write_eitr(struct ixgbe_q_vector *);
886 int ixgbe_poll(struct napi_struct *napi, int budget);
887 int ethtool_ioctl(struct ifreq *ifr);
888 s32 ixgbe_reinit_fdir_tables_82599(struct ixgbe_hw *hw);
889 s32 ixgbe_init_fdir_signature_82599(struct ixgbe_hw *hw, u32 fdirctrl);
890 s32 ixgbe_init_fdir_perfect_82599(struct ixgbe_hw *hw, u32 fdirctrl);
891 s32 ixgbe_fdir_add_signature_filter_82599(struct ixgbe_hw *hw,
892                                           union ixgbe_atr_hash_dword input,
893                                           union ixgbe_atr_hash_dword common,
894                                           u8 queue);
895 s32 ixgbe_fdir_set_input_mask_82599(struct ixgbe_hw *hw,
896                                     union ixgbe_atr_input *input_mask);
897 s32 ixgbe_fdir_write_perfect_filter_82599(struct ixgbe_hw *hw,
898                                           union ixgbe_atr_input *input,
899                                           u16 soft_id, u8 queue);
900 s32 ixgbe_fdir_erase_perfect_filter_82599(struct ixgbe_hw *hw,
901                                           union ixgbe_atr_input *input,
902                                           u16 soft_id);
903 void ixgbe_atr_compute_perfect_hash_82599(union ixgbe_atr_input *input,
904                                           union ixgbe_atr_input *mask);
905 int ixgbe_update_ethtool_fdir_entry(struct ixgbe_adapter *adapter,
906                                     struct ixgbe_fdir_filter *input,
907                                     u16 sw_idx);
908 void ixgbe_set_rx_mode(struct net_device *netdev);
909 #ifdef CONFIG_IXGBE_DCB
910 void ixgbe_set_rx_drop_en(struct ixgbe_adapter *adapter);
911 #endif
912 int ixgbe_setup_tc(struct net_device *dev, u8 tc);
913 void ixgbe_tx_ctxtdesc(struct ixgbe_ring *, u32, u32, u32, u32);
914 void ixgbe_do_reset(struct net_device *netdev);
915 #ifdef CONFIG_IXGBE_HWMON
916 void ixgbe_sysfs_exit(struct ixgbe_adapter *adapter);
917 int ixgbe_sysfs_init(struct ixgbe_adapter *adapter);
918 #endif /* CONFIG_IXGBE_HWMON */
919 #ifdef IXGBE_FCOE
920 void ixgbe_configure_fcoe(struct ixgbe_adapter *adapter);
921 int ixgbe_fso(struct ixgbe_ring *tx_ring, struct ixgbe_tx_buffer *first,
922               u8 *hdr_len);
923 int ixgbe_fcoe_ddp(struct ixgbe_adapter *adapter,
924                    union ixgbe_adv_rx_desc *rx_desc, struct sk_buff *skb);
925 int ixgbe_fcoe_ddp_get(struct net_device *netdev, u16 xid,
926                        struct scatterlist *sgl, unsigned int sgc);
927 int ixgbe_fcoe_ddp_target(struct net_device *netdev, u16 xid,
928                           struct scatterlist *sgl, unsigned int sgc);
929 int ixgbe_fcoe_ddp_put(struct net_device *netdev, u16 xid);
930 int ixgbe_setup_fcoe_ddp_resources(struct ixgbe_adapter *adapter);
931 void ixgbe_free_fcoe_ddp_resources(struct ixgbe_adapter *adapter);
932 int ixgbe_fcoe_enable(struct net_device *netdev);
933 int ixgbe_fcoe_disable(struct net_device *netdev);
934 #ifdef CONFIG_IXGBE_DCB
935 u8 ixgbe_fcoe_getapp(struct ixgbe_adapter *adapter);
936 u8 ixgbe_fcoe_setapp(struct ixgbe_adapter *adapter, u8 up);
937 #endif /* CONFIG_IXGBE_DCB */
938 int ixgbe_fcoe_get_wwn(struct net_device *netdev, u64 *wwn, int type);
939 int ixgbe_fcoe_get_hbainfo(struct net_device *netdev,
940                            struct netdev_fcoe_hbainfo *info);
941 u8 ixgbe_fcoe_get_tc(struct ixgbe_adapter *adapter);
942 #endif /* IXGBE_FCOE */
943 #ifdef CONFIG_DEBUG_FS
944 void ixgbe_dbg_adapter_init(struct ixgbe_adapter *adapter);
945 void ixgbe_dbg_adapter_exit(struct ixgbe_adapter *adapter);
946 void ixgbe_dbg_init(void);
947 void ixgbe_dbg_exit(void);
948 #else
949 static inline void ixgbe_dbg_adapter_init(struct ixgbe_adapter *adapter) {}
950 static inline void ixgbe_dbg_adapter_exit(struct ixgbe_adapter *adapter) {}
951 static inline void ixgbe_dbg_init(void) {}
952 static inline void ixgbe_dbg_exit(void) {}
953 #endif /* CONFIG_DEBUG_FS */
954 static inline struct netdev_queue *txring_txq(const struct ixgbe_ring *ring)
955 {
956         return netdev_get_tx_queue(ring->netdev, ring->queue_index);
957 }
958
959 void ixgbe_ptp_init(struct ixgbe_adapter *adapter);
960 void ixgbe_ptp_suspend(struct ixgbe_adapter *adapter);
961 void ixgbe_ptp_stop(struct ixgbe_adapter *adapter);
962 void ixgbe_ptp_overflow_check(struct ixgbe_adapter *adapter);
963 void ixgbe_ptp_rx_hang(struct ixgbe_adapter *adapter);
964 void ixgbe_ptp_tx_hang(struct ixgbe_adapter *adapter);
965 void ixgbe_ptp_rx_pktstamp(struct ixgbe_q_vector *, struct sk_buff *);
966 void ixgbe_ptp_rx_rgtstamp(struct ixgbe_q_vector *, struct sk_buff *skb);
967 static inline void ixgbe_ptp_rx_hwtstamp(struct ixgbe_ring *rx_ring,
968                                          union ixgbe_adv_rx_desc *rx_desc,
969                                          struct sk_buff *skb)
970 {
971         if (unlikely(ixgbe_test_staterr(rx_desc, IXGBE_RXD_STAT_TSIP))) {
972                 ixgbe_ptp_rx_pktstamp(rx_ring->q_vector, skb);
973                 return;
974         }
975
976         if (unlikely(!ixgbe_test_staterr(rx_desc, IXGBE_RXDADV_STAT_TS)))
977                 return;
978
979         ixgbe_ptp_rx_rgtstamp(rx_ring->q_vector, skb);
980
981         /* Update the last_rx_timestamp timer in order to enable watchdog check
982          * for error case of latched timestamp on a dropped packet.
983          */
984         rx_ring->last_rx_timestamp = jiffies;
985 }
986
987 int ixgbe_ptp_set_ts_config(struct ixgbe_adapter *adapter, struct ifreq *ifr);
988 int ixgbe_ptp_get_ts_config(struct ixgbe_adapter *adapter, struct ifreq *ifr);
989 void ixgbe_ptp_start_cyclecounter(struct ixgbe_adapter *adapter);
990 void ixgbe_ptp_reset(struct ixgbe_adapter *adapter);
991 void ixgbe_ptp_check_pps_event(struct ixgbe_adapter *adapter);
992 #ifdef CONFIG_PCI_IOV
993 void ixgbe_sriov_reinit(struct ixgbe_adapter *adapter);
994 #endif
995
996 netdev_tx_t ixgbe_xmit_frame_ring(struct sk_buff *skb,
997                                   struct ixgbe_adapter *adapter,
998                                   struct ixgbe_ring *tx_ring);
999 u32 ixgbe_rss_indir_tbl_entries(struct ixgbe_adapter *adapter);
1000 void ixgbe_store_key(struct ixgbe_adapter *adapter);
1001 void ixgbe_store_reta(struct ixgbe_adapter *adapter);
1002 s32 ixgbe_negotiate_fc(struct ixgbe_hw *hw, u32 adv_reg, u32 lp_reg,
1003                        u32 adv_sym, u32 adv_asm, u32 lp_sym, u32 lp_asm);
1004 #endif /* _IXGBE_H_ */