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