GNU Linux-libre 4.14.332-gnu1
[releases.git] / drivers / net / ethernet / intel / igb / igb.h
1 /* Intel(R) Gigabit Ethernet Linux driver
2  * Copyright(c) 2007-2014 Intel Corporation.
3  *
4  * This program is free software; you can redistribute it and/or modify it
5  * under the terms and conditions of the GNU General Public License,
6  * version 2, as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope it will be useful, but WITHOUT
9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
10  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
11  * more details.
12  *
13  * You should have received a copy of the GNU General Public License along with
14  * this program; if not, see <http://www.gnu.org/licenses/>.
15  *
16  * The full GNU General Public License is included in this distribution in
17  * the file called "COPYING".
18  *
19  * Contact Information:
20  * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
21  * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
22  */
23
24 /* Linux PRO/1000 Ethernet Driver main header file */
25
26 #ifndef _IGB_H_
27 #define _IGB_H_
28
29 #include "e1000_mac.h"
30 #include "e1000_82575.h"
31
32 #include <linux/timecounter.h>
33 #include <linux/net_tstamp.h>
34 #include <linux/ptp_clock_kernel.h>
35 #include <linux/bitops.h>
36 #include <linux/if_vlan.h>
37 #include <linux/i2c.h>
38 #include <linux/i2c-algo-bit.h>
39 #include <linux/pci.h>
40 #include <linux/mdio.h>
41
42 struct igb_adapter;
43
44 #define E1000_PCS_CFG_IGN_SD    1
45
46 /* Interrupt defines */
47 #define IGB_START_ITR           648 /* ~6000 ints/sec */
48 #define IGB_4K_ITR              980
49 #define IGB_20K_ITR             196
50 #define IGB_70K_ITR             56
51
52 /* TX/RX descriptor defines */
53 #define IGB_DEFAULT_TXD         256
54 #define IGB_DEFAULT_TX_WORK     128
55 #define IGB_MIN_TXD             64
56 #define IGB_MAX_TXD             4096
57
58 #define IGB_DEFAULT_RXD         256
59 #define IGB_MIN_RXD             64
60 #define IGB_MAX_RXD             4096
61
62 #define IGB_DEFAULT_ITR         3 /* dynamic */
63 #define IGB_MAX_ITR_USECS       10000
64 #define IGB_MIN_ITR_USECS       10
65 #define NON_Q_VECTORS           1
66 #define MAX_Q_VECTORS           8
67 #define MAX_MSIX_ENTRIES        10
68
69 /* Transmit and receive queues */
70 #define IGB_MAX_RX_QUEUES       8
71 #define IGB_MAX_RX_QUEUES_82575 4
72 #define IGB_MAX_RX_QUEUES_I211  2
73 #define IGB_MAX_TX_QUEUES       8
74 #define IGB_MAX_VF_MC_ENTRIES   30
75 #define IGB_MAX_VF_FUNCTIONS    8
76 #define IGB_MAX_VFTA_ENTRIES    128
77 #define IGB_82576_VF_DEV_ID     0x10CA
78 #define IGB_I350_VF_DEV_ID      0x1520
79
80 /* NVM version defines */
81 #define IGB_MAJOR_MASK          0xF000
82 #define IGB_MINOR_MASK          0x0FF0
83 #define IGB_BUILD_MASK          0x000F
84 #define IGB_COMB_VER_MASK       0x00FF
85 #define IGB_MAJOR_SHIFT         12
86 #define IGB_MINOR_SHIFT         4
87 #define IGB_COMB_VER_SHFT       8
88 #define IGB_NVM_VER_INVALID     0xFFFF
89 #define IGB_ETRACK_SHIFT        16
90 #define NVM_ETRACK_WORD         0x0042
91 #define NVM_COMB_VER_OFF        0x0083
92 #define NVM_COMB_VER_PTR        0x003d
93
94 /* Transmit and receive latency (for PTP timestamps) */
95 #define IGB_I210_TX_LATENCY_10          9542
96 #define IGB_I210_TX_LATENCY_100         1024
97 #define IGB_I210_TX_LATENCY_1000        178
98 #define IGB_I210_RX_LATENCY_10          20662
99 #define IGB_I210_RX_LATENCY_100         2213
100 #define IGB_I210_RX_LATENCY_1000        448
101
102 struct vf_data_storage {
103         unsigned char vf_mac_addresses[ETH_ALEN];
104         u16 vf_mc_hashes[IGB_MAX_VF_MC_ENTRIES];
105         u16 num_vf_mc_hashes;
106         u32 flags;
107         unsigned long last_nack;
108         u16 pf_vlan; /* When set, guest VLAN config not allowed. */
109         u16 pf_qos;
110         u16 tx_rate;
111         bool spoofchk_enabled;
112 };
113
114 /* Number of unicast MAC filters reserved for the PF in the RAR registers */
115 #define IGB_PF_MAC_FILTERS_RESERVED     3
116
117 struct vf_mac_filter {
118         struct list_head l;
119         int vf;
120         bool free;
121         u8 vf_mac[ETH_ALEN];
122 };
123
124 #define IGB_VF_FLAG_CTS            0x00000001 /* VF is clear to send data */
125 #define IGB_VF_FLAG_UNI_PROMISC    0x00000002 /* VF has unicast promisc */
126 #define IGB_VF_FLAG_MULTI_PROMISC  0x00000004 /* VF has multicast promisc */
127 #define IGB_VF_FLAG_PF_SET_MAC     0x00000008 /* PF has set MAC address */
128
129 /* RX descriptor control thresholds.
130  * PTHRESH - MAC will consider prefetch if it has fewer than this number of
131  *           descriptors available in its onboard memory.
132  *           Setting this to 0 disables RX descriptor prefetch.
133  * HTHRESH - MAC will only prefetch if there are at least this many descriptors
134  *           available in host memory.
135  *           If PTHRESH is 0, this should also be 0.
136  * WTHRESH - RX descriptor writeback threshold - MAC will delay writing back
137  *           descriptors until either it has this many to write back, or the
138  *           ITR timer expires.
139  */
140 #define IGB_RX_PTHRESH  ((hw->mac.type == e1000_i354) ? 12 : 8)
141 #define IGB_RX_HTHRESH  8
142 #define IGB_TX_PTHRESH  ((hw->mac.type == e1000_i354) ? 20 : 8)
143 #define IGB_TX_HTHRESH  1
144 #define IGB_RX_WTHRESH  ((hw->mac.type == e1000_82576 && \
145                           (adapter->flags & IGB_FLAG_HAS_MSIX)) ? 1 : 4)
146 #define IGB_TX_WTHRESH  ((hw->mac.type == e1000_82576 && \
147                           (adapter->flags & IGB_FLAG_HAS_MSIX)) ? 1 : 16)
148
149 /* this is the size past which hardware will drop packets when setting LPE=0 */
150 #define MAXIMUM_ETHERNET_VLAN_SIZE 1522
151
152 /* Supported Rx Buffer Sizes */
153 #define IGB_RXBUFFER_256        256
154 #define IGB_RXBUFFER_2048       2048
155 #define IGB_RXBUFFER_3072       3072
156 #define IGB_RX_HDR_LEN          IGB_RXBUFFER_256
157 #define IGB_TS_HDR_LEN          16
158
159 #define IGB_SKB_PAD             (NET_SKB_PAD + NET_IP_ALIGN)
160 #if (PAGE_SIZE < 8192)
161 #define IGB_MAX_FRAME_BUILD_SKB \
162         (SKB_WITH_OVERHEAD(IGB_RXBUFFER_2048) - IGB_SKB_PAD - IGB_TS_HDR_LEN)
163 #else
164 #define IGB_MAX_FRAME_BUILD_SKB (IGB_RXBUFFER_2048 - IGB_TS_HDR_LEN)
165 #endif
166
167 /* How many Rx Buffers do we bundle into one write to the hardware ? */
168 #define IGB_RX_BUFFER_WRITE     16 /* Must be power of 2 */
169
170 #define IGB_RX_DMA_ATTR \
171         (DMA_ATTR_SKIP_CPU_SYNC | DMA_ATTR_WEAK_ORDERING)
172
173 #define AUTO_ALL_MODES          0
174 #define IGB_EEPROM_APME         0x0400
175
176 #ifndef IGB_MASTER_SLAVE
177 /* Switch to override PHY master/slave setting */
178 #define IGB_MASTER_SLAVE        e1000_ms_hw_default
179 #endif
180
181 #define IGB_MNG_VLAN_NONE       -1
182
183 enum igb_tx_flags {
184         /* cmd_type flags */
185         IGB_TX_FLAGS_VLAN       = 0x01,
186         IGB_TX_FLAGS_TSO        = 0x02,
187         IGB_TX_FLAGS_TSTAMP     = 0x04,
188
189         /* olinfo flags */
190         IGB_TX_FLAGS_IPV4       = 0x10,
191         IGB_TX_FLAGS_CSUM       = 0x20,
192 };
193
194 /* VLAN info */
195 #define IGB_TX_FLAGS_VLAN_MASK  0xffff0000
196 #define IGB_TX_FLAGS_VLAN_SHIFT 16
197
198 /* The largest size we can write to the descriptor is 65535.  In order to
199  * maintain a power of two alignment we have to limit ourselves to 32K.
200  */
201 #define IGB_MAX_TXD_PWR 15
202 #define IGB_MAX_DATA_PER_TXD    (1u << IGB_MAX_TXD_PWR)
203
204 /* Tx Descriptors needed, worst case */
205 #define TXD_USE_COUNT(S) DIV_ROUND_UP((S), IGB_MAX_DATA_PER_TXD)
206 #define DESC_NEEDED (MAX_SKB_FRAGS + 4)
207
208 /* EEPROM byte offsets */
209 #define IGB_SFF_8472_SWAP               0x5C
210 #define IGB_SFF_8472_COMP               0x5E
211
212 /* Bitmasks */
213 #define IGB_SFF_ADDRESSING_MODE         0x4
214 #define IGB_SFF_8472_UNSUP              0x00
215
216 /* wrapper around a pointer to a socket buffer,
217  * so a DMA handle can be stored along with the buffer
218  */
219 struct igb_tx_buffer {
220         union e1000_adv_tx_desc *next_to_watch;
221         unsigned long time_stamp;
222         struct sk_buff *skb;
223         unsigned int bytecount;
224         u16 gso_segs;
225         __be16 protocol;
226
227         DEFINE_DMA_UNMAP_ADDR(dma);
228         DEFINE_DMA_UNMAP_LEN(len);
229         u32 tx_flags;
230 };
231
232 struct igb_rx_buffer {
233         dma_addr_t dma;
234         struct page *page;
235 #if (BITS_PER_LONG > 32) || (PAGE_SIZE >= 65536)
236         __u32 page_offset;
237 #else
238         __u16 page_offset;
239 #endif
240         __u16 pagecnt_bias;
241 };
242
243 struct igb_tx_queue_stats {
244         u64 packets;
245         u64 bytes;
246         u64 restart_queue;
247         u64 restart_queue2;
248 };
249
250 struct igb_rx_queue_stats {
251         u64 packets;
252         u64 bytes;
253         u64 drops;
254         u64 csum_err;
255         u64 alloc_failed;
256 };
257
258 struct igb_ring_container {
259         struct igb_ring *ring;          /* pointer to linked list of rings */
260         unsigned int total_bytes;       /* total bytes processed this int */
261         unsigned int total_packets;     /* total packets processed this int */
262         u16 work_limit;                 /* total work allowed per interrupt */
263         u8 count;                       /* total number of rings in vector */
264         u8 itr;                         /* current ITR setting for ring */
265 };
266
267 struct igb_ring {
268         struct igb_q_vector *q_vector;  /* backlink to q_vector */
269         struct net_device *netdev;      /* back pointer to net_device */
270         struct device *dev;             /* device pointer for dma mapping */
271         union {                         /* array of buffer info structs */
272                 struct igb_tx_buffer *tx_buffer_info;
273                 struct igb_rx_buffer *rx_buffer_info;
274         };
275         void *desc;                     /* descriptor ring memory */
276         unsigned long flags;            /* ring specific flags */
277         void __iomem *tail;             /* pointer to ring tail register */
278         dma_addr_t dma;                 /* phys address of the ring */
279         unsigned int  size;             /* length of desc. ring in bytes */
280
281         u16 count;                      /* number of desc. in the ring */
282         u8 queue_index;                 /* logical index of the ring*/
283         u8 reg_idx;                     /* physical index of the ring */
284
285         /* everything past this point are written often */
286         u16 next_to_clean;
287         u16 next_to_use;
288         u16 next_to_alloc;
289
290         union {
291                 /* TX */
292                 struct {
293                         struct igb_tx_queue_stats tx_stats;
294                         struct u64_stats_sync tx_syncp;
295                         struct u64_stats_sync tx_syncp2;
296                 };
297                 /* RX */
298                 struct {
299                         struct sk_buff *skb;
300                         struct igb_rx_queue_stats rx_stats;
301                         struct u64_stats_sync rx_syncp;
302                 };
303         };
304 } ____cacheline_internodealigned_in_smp;
305
306 struct igb_q_vector {
307         struct igb_adapter *adapter;    /* backlink */
308         int cpu;                        /* CPU for DCA */
309         u32 eims_value;                 /* EIMS mask value */
310
311         u16 itr_val;
312         u8 set_itr;
313         void __iomem *itr_register;
314
315         struct igb_ring_container rx, tx;
316
317         struct napi_struct napi;
318         struct rcu_head rcu;    /* to avoid race with update stats on free */
319         char name[IFNAMSIZ + 9];
320
321         /* for dynamic allocation of rings associated with this q_vector */
322         struct igb_ring ring[0] ____cacheline_internodealigned_in_smp;
323 };
324
325 enum e1000_ring_flags_t {
326         IGB_RING_FLAG_RX_3K_BUFFER,
327         IGB_RING_FLAG_RX_BUILD_SKB_ENABLED,
328         IGB_RING_FLAG_RX_SCTP_CSUM,
329         IGB_RING_FLAG_RX_LB_VLAN_BSWAP,
330         IGB_RING_FLAG_TX_CTX_IDX,
331         IGB_RING_FLAG_TX_DETECT_HANG
332 };
333
334 #define ring_uses_large_buffer(ring) \
335         test_bit(IGB_RING_FLAG_RX_3K_BUFFER, &(ring)->flags)
336 #define set_ring_uses_large_buffer(ring) \
337         set_bit(IGB_RING_FLAG_RX_3K_BUFFER, &(ring)->flags)
338 #define clear_ring_uses_large_buffer(ring) \
339         clear_bit(IGB_RING_FLAG_RX_3K_BUFFER, &(ring)->flags)
340
341 #define ring_uses_build_skb(ring) \
342         test_bit(IGB_RING_FLAG_RX_BUILD_SKB_ENABLED, &(ring)->flags)
343 #define set_ring_build_skb_enabled(ring) \
344         set_bit(IGB_RING_FLAG_RX_BUILD_SKB_ENABLED, &(ring)->flags)
345 #define clear_ring_build_skb_enabled(ring) \
346         clear_bit(IGB_RING_FLAG_RX_BUILD_SKB_ENABLED, &(ring)->flags)
347
348 static inline unsigned int igb_rx_bufsz(struct igb_ring *ring)
349 {
350 #if (PAGE_SIZE < 8192)
351         if (ring_uses_large_buffer(ring))
352                 return IGB_RXBUFFER_3072;
353
354         if (ring_uses_build_skb(ring))
355                 return IGB_MAX_FRAME_BUILD_SKB + IGB_TS_HDR_LEN;
356 #endif
357         return IGB_RXBUFFER_2048;
358 }
359
360 static inline unsigned int igb_rx_pg_order(struct igb_ring *ring)
361 {
362 #if (PAGE_SIZE < 8192)
363         if (ring_uses_large_buffer(ring))
364                 return 1;
365 #endif
366         return 0;
367 }
368
369 #define igb_rx_pg_size(_ring) (PAGE_SIZE << igb_rx_pg_order(_ring))
370
371 #define IGB_TXD_DCMD (E1000_ADVTXD_DCMD_EOP | E1000_ADVTXD_DCMD_RS)
372
373 #define IGB_RX_DESC(R, i)       \
374         (&(((union e1000_adv_rx_desc *)((R)->desc))[i]))
375 #define IGB_TX_DESC(R, i)       \
376         (&(((union e1000_adv_tx_desc *)((R)->desc))[i]))
377 #define IGB_TX_CTXTDESC(R, i)   \
378         (&(((struct e1000_adv_tx_context_desc *)((R)->desc))[i]))
379
380 /* igb_test_staterr - tests bits within Rx descriptor status and error fields */
381 static inline __le32 igb_test_staterr(union e1000_adv_rx_desc *rx_desc,
382                                       const u32 stat_err_bits)
383 {
384         return rx_desc->wb.upper.status_error & cpu_to_le32(stat_err_bits);
385 }
386
387 /* igb_desc_unused - calculate if we have unused descriptors */
388 static inline int igb_desc_unused(struct igb_ring *ring)
389 {
390         if (ring->next_to_clean > ring->next_to_use)
391                 return ring->next_to_clean - ring->next_to_use - 1;
392
393         return ring->count + ring->next_to_clean - ring->next_to_use - 1;
394 }
395
396 #ifdef CONFIG_IGB_HWMON
397
398 #define IGB_HWMON_TYPE_LOC      0
399 #define IGB_HWMON_TYPE_TEMP     1
400 #define IGB_HWMON_TYPE_CAUTION  2
401 #define IGB_HWMON_TYPE_MAX      3
402
403 struct hwmon_attr {
404         struct device_attribute dev_attr;
405         struct e1000_hw *hw;
406         struct e1000_thermal_diode_data *sensor;
407         char name[12];
408         };
409
410 struct hwmon_buff {
411         struct attribute_group group;
412         const struct attribute_group *groups[2];
413         struct attribute *attrs[E1000_MAX_SENSORS * 4 + 1];
414         struct hwmon_attr hwmon_list[E1000_MAX_SENSORS * 4];
415         unsigned int n_hwmon;
416         };
417 #endif
418
419 /* The number of L2 ether-type filter registers, Index 3 is reserved
420  * for PTP 1588 timestamp
421  */
422 #define MAX_ETYPE_FILTER        (4 - 1)
423 /* ETQF filter list: one static filter per filter consumer. This is
424  * to avoid filter collisions later. Add new filters here!!
425  *
426  * Current filters:             Filter 3
427  */
428 #define IGB_ETQF_FILTER_1588    3
429
430 #define IGB_N_EXTTS     2
431 #define IGB_N_PEROUT    2
432 #define IGB_N_SDP       4
433 #define IGB_RETA_SIZE   128
434
435 enum igb_filter_match_flags {
436         IGB_FILTER_FLAG_ETHER_TYPE = 0x1,
437         IGB_FILTER_FLAG_VLAN_TCI   = 0x2,
438 };
439
440 #define IGB_MAX_RXNFC_FILTERS 16
441
442 /* RX network flow classification data structure */
443 struct igb_nfc_input {
444         /* Byte layout in order, all values with MSB first:
445          * match_flags - 1 byte
446          * etype - 2 bytes
447          * vlan_tci - 2 bytes
448          */
449         u8 match_flags;
450         __be16 etype;
451         __be16 vlan_tci;
452 };
453
454 struct igb_nfc_filter {
455         struct hlist_node nfc_node;
456         struct igb_nfc_input filter;
457         u16 etype_reg_index;
458         u16 sw_idx;
459         u16 action;
460 };
461
462 struct igb_mac_addr {
463         u8 addr[ETH_ALEN];
464         u8 queue;
465         u8 state; /* bitmask */
466 };
467
468 #define IGB_MAC_STATE_DEFAULT   0x1
469 #define IGB_MAC_STATE_IN_USE    0x2
470
471 /* board specific private data structure */
472 struct igb_adapter {
473         unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
474
475         struct net_device *netdev;
476
477         unsigned long state;
478         unsigned int flags;
479
480         unsigned int num_q_vectors;
481         struct msix_entry msix_entries[MAX_MSIX_ENTRIES];
482
483         /* Interrupt Throttle Rate */
484         u32 rx_itr_setting;
485         u32 tx_itr_setting;
486         u16 tx_itr;
487         u16 rx_itr;
488
489         /* TX */
490         u16 tx_work_limit;
491         u32 tx_timeout_count;
492         int num_tx_queues;
493         struct igb_ring *tx_ring[16];
494
495         /* RX */
496         int num_rx_queues;
497         struct igb_ring *rx_ring[16];
498
499         u32 max_frame_size;
500         u32 min_frame_size;
501
502         struct timer_list watchdog_timer;
503         struct timer_list phy_info_timer;
504
505         u16 mng_vlan_id;
506         u32 bd_number;
507         u32 wol;
508         u32 en_mng_pt;
509         u16 link_speed;
510         u16 link_duplex;
511
512         u8 __iomem *io_addr; /* Mainly for iounmap use */
513
514         struct work_struct reset_task;
515         struct work_struct watchdog_task;
516         bool fc_autoneg;
517         u8  tx_timeout_factor;
518         struct timer_list blink_timer;
519         unsigned long led_status;
520
521         /* OS defined structs */
522         struct pci_dev *pdev;
523
524         spinlock_t stats64_lock;
525         struct rtnl_link_stats64 stats64;
526
527         /* structs defined in e1000_hw.h */
528         struct e1000_hw hw;
529         struct e1000_hw_stats stats;
530         struct e1000_phy_info phy_info;
531
532         u32 test_icr;
533         struct igb_ring test_tx_ring;
534         struct igb_ring test_rx_ring;
535
536         int msg_enable;
537
538         struct igb_q_vector *q_vector[MAX_Q_VECTORS];
539         u32 eims_enable_mask;
540         u32 eims_other;
541
542         /* to not mess up cache alignment, always add to the bottom */
543         u16 tx_ring_count;
544         u16 rx_ring_count;
545         unsigned int vfs_allocated_count;
546         struct vf_data_storage *vf_data;
547         int vf_rate_link_speed;
548         u32 rss_queues;
549         u32 wvbr;
550         u32 *shadow_vfta;
551
552         struct ptp_clock *ptp_clock;
553         struct ptp_clock_info ptp_caps;
554         struct delayed_work ptp_overflow_work;
555         struct work_struct ptp_tx_work;
556         struct sk_buff *ptp_tx_skb;
557         struct hwtstamp_config tstamp_config;
558         unsigned long ptp_tx_start;
559         unsigned long last_rx_ptp_check;
560         unsigned long last_rx_timestamp;
561         unsigned int ptp_flags;
562         spinlock_t tmreg_lock;
563         struct cyclecounter cc;
564         struct timecounter tc;
565         u32 tx_hwtstamp_timeouts;
566         u32 tx_hwtstamp_skipped;
567         u32 rx_hwtstamp_cleared;
568         bool pps_sys_wrap_on;
569
570         struct ptp_pin_desc sdp_config[IGB_N_SDP];
571         struct {
572                 struct timespec64 start;
573                 struct timespec64 period;
574         } perout[IGB_N_PEROUT];
575
576         char fw_version[32];
577 #ifdef CONFIG_IGB_HWMON
578         struct hwmon_buff *igb_hwmon_buff;
579         bool ets;
580 #endif
581         struct i2c_algo_bit_data i2c_algo;
582         struct i2c_adapter i2c_adap;
583         struct i2c_client *i2c_client;
584         u32 rss_indir_tbl_init;
585         u8 rss_indir_tbl[IGB_RETA_SIZE];
586
587         unsigned long link_check_timeout;
588         int copper_tries;
589         struct e1000_info ei;
590         u16 eee_advert;
591
592         /* RX network flow classification support */
593         struct hlist_head nfc_filter_list;
594         unsigned int nfc_filter_count;
595         /* lock for RX network flow classification filter */
596         spinlock_t nfc_lock;
597         bool etype_bitmap[MAX_ETYPE_FILTER];
598
599         struct igb_mac_addr *mac_table;
600         struct vf_mac_filter vf_macs;
601         struct vf_mac_filter *vf_mac_list;
602         /* lock for VF resources */
603         spinlock_t vfs_lock;
604 };
605
606 /* flags controlling PTP/1588 function */
607 #define IGB_PTP_ENABLED         BIT(0)
608 #define IGB_PTP_OVERFLOW_CHECK  BIT(1)
609
610 #define IGB_FLAG_HAS_MSI                BIT(0)
611 #define IGB_FLAG_DCA_ENABLED            BIT(1)
612 #define IGB_FLAG_QUAD_PORT_A            BIT(2)
613 #define IGB_FLAG_QUEUE_PAIRS            BIT(3)
614 #define IGB_FLAG_DMAC                   BIT(4)
615 #define IGB_FLAG_RSS_FIELD_IPV4_UDP     BIT(6)
616 #define IGB_FLAG_RSS_FIELD_IPV6_UDP     BIT(7)
617 #define IGB_FLAG_WOL_SUPPORTED          BIT(8)
618 #define IGB_FLAG_NEED_LINK_UPDATE       BIT(9)
619 #define IGB_FLAG_MEDIA_RESET            BIT(10)
620 #define IGB_FLAG_MAS_CAPABLE            BIT(11)
621 #define IGB_FLAG_MAS_ENABLE             BIT(12)
622 #define IGB_FLAG_HAS_MSIX               BIT(13)
623 #define IGB_FLAG_EEE                    BIT(14)
624 #define IGB_FLAG_VLAN_PROMISC           BIT(15)
625 #define IGB_FLAG_RX_LEGACY              BIT(16)
626
627 /* Media Auto Sense */
628 #define IGB_MAS_ENABLE_0                0X0001
629 #define IGB_MAS_ENABLE_1                0X0002
630 #define IGB_MAS_ENABLE_2                0X0004
631 #define IGB_MAS_ENABLE_3                0X0008
632
633 /* DMA Coalescing defines */
634 #define IGB_MIN_TXPBSIZE        20408
635 #define IGB_TX_BUF_4096         4096
636 #define IGB_DMCTLX_DCFLUSH_DIS  0x80000000  /* Disable DMA Coal Flush */
637
638 #define IGB_82576_TSYNC_SHIFT   19
639 enum e1000_state_t {
640         __IGB_TESTING,
641         __IGB_RESETTING,
642         __IGB_DOWN,
643         __IGB_PTP_TX_IN_PROGRESS,
644 };
645
646 enum igb_boards {
647         board_82575,
648 };
649
650 extern char igb_driver_name[];
651 extern char igb_driver_version[];
652
653 int igb_open(struct net_device *netdev);
654 int igb_close(struct net_device *netdev);
655 int igb_up(struct igb_adapter *);
656 void igb_down(struct igb_adapter *);
657 void igb_reinit_locked(struct igb_adapter *);
658 void igb_reset(struct igb_adapter *);
659 int igb_reinit_queues(struct igb_adapter *);
660 void igb_write_rss_indir_tbl(struct igb_adapter *);
661 int igb_set_spd_dplx(struct igb_adapter *, u32, u8);
662 int igb_setup_tx_resources(struct igb_ring *);
663 int igb_setup_rx_resources(struct igb_ring *);
664 void igb_free_tx_resources(struct igb_ring *);
665 void igb_free_rx_resources(struct igb_ring *);
666 void igb_configure_tx_ring(struct igb_adapter *, struct igb_ring *);
667 void igb_configure_rx_ring(struct igb_adapter *, struct igb_ring *);
668 void igb_setup_tctl(struct igb_adapter *);
669 void igb_setup_rctl(struct igb_adapter *);
670 netdev_tx_t igb_xmit_frame_ring(struct sk_buff *, struct igb_ring *);
671 void igb_alloc_rx_buffers(struct igb_ring *, u16);
672 void igb_update_stats(struct igb_adapter *);
673 bool igb_has_link(struct igb_adapter *adapter);
674 void igb_set_ethtool_ops(struct net_device *);
675 void igb_power_up_link(struct igb_adapter *);
676 void igb_set_fw_version(struct igb_adapter *);
677 void igb_ptp_init(struct igb_adapter *adapter);
678 void igb_ptp_stop(struct igb_adapter *adapter);
679 void igb_ptp_reset(struct igb_adapter *adapter);
680 void igb_ptp_suspend(struct igb_adapter *adapter);
681 void igb_ptp_rx_hang(struct igb_adapter *adapter);
682 void igb_ptp_tx_hang(struct igb_adapter *adapter);
683 void igb_ptp_rx_rgtstamp(struct igb_q_vector *q_vector, struct sk_buff *skb);
684 void igb_ptp_rx_pktstamp(struct igb_q_vector *q_vector, void *va,
685                          struct sk_buff *skb);
686 int igb_ptp_set_ts_config(struct net_device *netdev, struct ifreq *ifr);
687 int igb_ptp_get_ts_config(struct net_device *netdev, struct ifreq *ifr);
688 void igb_set_flag_queue_pairs(struct igb_adapter *, const u32);
689 #ifdef CONFIG_IGB_HWMON
690 void igb_sysfs_exit(struct igb_adapter *adapter);
691 int igb_sysfs_init(struct igb_adapter *adapter);
692 #endif
693 static inline s32 igb_reset_phy(struct e1000_hw *hw)
694 {
695         if (hw->phy.ops.reset)
696                 return hw->phy.ops.reset(hw);
697
698         return 0;
699 }
700
701 static inline s32 igb_read_phy_reg(struct e1000_hw *hw, u32 offset, u16 *data)
702 {
703         if (hw->phy.ops.read_reg)
704                 return hw->phy.ops.read_reg(hw, offset, data);
705
706         return 0;
707 }
708
709 static inline s32 igb_write_phy_reg(struct e1000_hw *hw, u32 offset, u16 data)
710 {
711         if (hw->phy.ops.write_reg)
712                 return hw->phy.ops.write_reg(hw, offset, data);
713
714         return 0;
715 }
716
717 static inline s32 igb_get_phy_info(struct e1000_hw *hw)
718 {
719         if (hw->phy.ops.get_phy_info)
720                 return hw->phy.ops.get_phy_info(hw);
721
722         return 0;
723 }
724
725 static inline struct netdev_queue *txring_txq(const struct igb_ring *tx_ring)
726 {
727         return netdev_get_tx_queue(tx_ring->netdev, tx_ring->queue_index);
728 }
729
730 int igb_add_filter(struct igb_adapter *adapter,
731                    struct igb_nfc_filter *input);
732 int igb_erase_filter(struct igb_adapter *adapter,
733                      struct igb_nfc_filter *input);
734
735 #endif /* _IGB_H_ */