blob: 0b748d1959d93162b79dea9f38bc2335bf666b92 [file] [log] [blame]
David Ertmane78b80b2014-02-04 01:56:06 +00001/* Intel PRO/1000 Linux driver
Yanir Lubetkin529498c2015-06-02 17:05:50 +03002 * Copyright(c) 1999 - 2015 Intel Corporation.
David Ertmane78b80b2014-02-04 01:56:06 +00003 *
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 * The full GNU General Public License is included in this distribution in
14 * the file called "COPYING".
15 *
16 * Contact Information:
17 * Linux NICS <linux.nics@intel.com>
18 * e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
19 * Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
20 */
Auke Kokbc7f75f2007-09-17 12:30:59 -070021
22/* Linux PRO/1000 Ethernet Driver main header file */
23
24#ifndef _E1000_H_
25#define _E1000_H_
26
Jeff Kirsher86d70e52011-03-25 16:01:01 +000027#include <linux/bitops.h>
Auke Kokbc7f75f2007-09-17 12:30:59 -070028#include <linux/types.h>
29#include <linux/timer.h>
30#include <linux/workqueue.h>
31#include <linux/io.h>
32#include <linux/netdevice.h>
Bruce Alland8014db2009-11-20 23:24:48 +000033#include <linux/pci.h>
Bruce Allan6f461f62010-04-27 03:33:04 +000034#include <linux/pci-aspm.h>
Bruce Allanfe46f582011-01-06 14:29:51 +000035#include <linux/crc32.h>
Jeff Kirsher86d70e52011-03-25 16:01:01 +000036#include <linux/if_vlan.h>
Richard Cochran74d23cc2014-12-21 19:46:56 +010037#include <linux/timecounter.h>
Bruce Allanb67e1912012-12-27 08:32:33 +000038#include <linux/net_tstamp.h>
Bruce Alland89777b2013-01-19 01:09:58 +000039#include <linux/ptp_clock_kernel.h>
40#include <linux/ptp_classify.h>
Bruce Allanc2ade1a2013-01-16 08:54:35 +000041#include <linux/mii.h>
Bruce Alland495bcb2013-03-20 07:23:11 +000042#include <linux/mdio.h>
David Ahern56840442015-05-12 09:36:59 -060043#include <linux/pm_qos.h>
Auke Kokbc7f75f2007-09-17 12:30:59 -070044#include "hw.h"
45
46struct e1000_info;
47
Jeff Kirsher44defeb2008-08-04 17:20:41 -070048#define e_dbg(format, arg...) \
Bruce Allan8544b9f2010-03-24 12:55:30 +000049 netdev_dbg(hw->adapter->netdev, format, ## arg)
Jeff Kirsher44defeb2008-08-04 17:20:41 -070050#define e_err(format, arg...) \
Bruce Allan8544b9f2010-03-24 12:55:30 +000051 netdev_err(adapter->netdev, format, ## arg)
Jeff Kirsher44defeb2008-08-04 17:20:41 -070052#define e_info(format, arg...) \
Bruce Allan8544b9f2010-03-24 12:55:30 +000053 netdev_info(adapter->netdev, format, ## arg)
Jeff Kirsher44defeb2008-08-04 17:20:41 -070054#define e_warn(format, arg...) \
Bruce Allan8544b9f2010-03-24 12:55:30 +000055 netdev_warn(adapter->netdev, format, ## arg)
Jeff Kirsher44defeb2008-08-04 17:20:41 -070056#define e_notice(format, arg...) \
Bruce Allan8544b9f2010-03-24 12:55:30 +000057 netdev_notice(adapter->netdev, format, ## arg)
Auke Kokbc7f75f2007-09-17 12:30:59 -070058
Martin Olsson98a17082009-04-22 18:21:29 +020059/* Interrupt modes, as used by the IntMode parameter */
Bruce Allan4662e822008-08-26 18:37:06 -070060#define E1000E_INT_MODE_LEGACY 0
61#define E1000E_INT_MODE_MSI 1
62#define E1000E_INT_MODE_MSIX 2
63
Bruce Allanad680762008-03-28 09:15:03 -070064/* Tx/Rx descriptor defines */
Auke Kokbc7f75f2007-09-17 12:30:59 -070065#define E1000_DEFAULT_TXD 256
66#define E1000_MAX_TXD 4096
Auke Kok7b1be192008-04-23 11:09:19 -070067#define E1000_MIN_TXD 64
Auke Kokbc7f75f2007-09-17 12:30:59 -070068
69#define E1000_DEFAULT_RXD 256
70#define E1000_MAX_RXD 4096
Auke Kok7b1be192008-04-23 11:09:19 -070071#define E1000_MIN_RXD 64
Auke Kokbc7f75f2007-09-17 12:30:59 -070072
Auke Kokde5b3072008-04-23 11:09:08 -070073#define E1000_MIN_ITR_USECS 10 /* 100000 irq/sec */
74#define E1000_MAX_ITR_USECS 10000 /* 100 irq/sec */
75
Auke Kokbc7f75f2007-09-17 12:30:59 -070076#define E1000_FC_PAUSE_TIME 0x0680 /* 858 usec */
77
78/* How many Tx Descriptors do we need to call netif_wake_queue ? */
79/* How many Rx Buffers do we bundle into one write to the hardware ? */
80#define E1000_RX_BUFFER_WRITE 16 /* Must be power of 2 */
81
82#define AUTO_ALL_MODES 0
83#define E1000_EEPROM_APME 0x0400
84
85#define E1000_MNG_VLAN_NONE (-1)
86
Bruce Allan2adc55c2009-06-02 11:28:58 +000087#define DEFAULT_JUMBO 9234
88
Rafael J. Wysocki23606cf2010-03-14 14:35:17 +000089/* Time to wait before putting the device into D3 if there's no link (in ms). */
90#define LINK_TIMEOUT 100
91
Bruce Allane921eb12012-11-28 09:28:37 +000092/* Count for polling __E1000_RESET condition every 10-20msec.
Bruce Allanbb9e44d2012-03-21 00:39:12 +000093 * Experimentation has shown the reset can take approximately 210msec.
94 */
95#define E1000_CHECK_RESET_COUNT 25
96
Jesse Brandeburg3a3b7582010-09-29 21:38:49 +000097#define DEFAULT_RDTR 0
98#define DEFAULT_RADV 8
99#define BURST_RDTR 0x20
100#define BURST_RADV 0x20
Yanir Lubetkinff917422015-06-02 17:05:38 +0300101#define PCICFG_DESC_RING_STATUS 0xe4
102#define FLUSH_DESC_REQUIRED 0x100
Jesse Brandeburg3a3b7582010-09-29 21:38:49 +0000103
Bruce Allane921eb12012-11-28 09:28:37 +0000104/* in the case of WTHRESH, it appears at least the 82571/2 hardware
Jesse Brandeburg3a3b7582010-09-29 21:38:49 +0000105 * writes back 4 descriptors when WTHRESH=5, and 3 descriptors when
Hiroaki SHIMODA8edc0e62012-10-10 15:34:20 +0000106 * WTHRESH=4, so a setting of 5 gives the most efficient bus
107 * utilization but to avoid possible Tx stalls, set it to 1
Jesse Brandeburg3a3b7582010-09-29 21:38:49 +0000108 */
109#define E1000_TXDCTL_DMA_BURST_ENABLE \
110 (E1000_TXDCTL_GRAN | /* set descriptor granularity */ \
111 E1000_TXDCTL_COUNT_DESC | \
Hiroaki SHIMODA8edc0e62012-10-10 15:34:20 +0000112 (1 << 16) | /* wthresh must be +1 more than desired */\
Jesse Brandeburg3a3b7582010-09-29 21:38:49 +0000113 (1 << 8) | /* hthresh */ \
114 0x1f) /* pthresh */
115
116#define E1000_RXDCTL_DMA_BURST_ENABLE \
117 (0x01000000 | /* set descriptor granularity */ \
118 (4 << 16) | /* set writeback threshold */ \
119 (4 << 8) | /* set prefetch threshold */ \
120 0x20) /* set hthresh */
121
122#define E1000_TIDV_FPD (1 << 31)
123#define E1000_RDTR_FPD (1 << 31)
124
Auke Kokbc7f75f2007-09-17 12:30:59 -0700125enum e1000_boards {
126 board_82571,
127 board_82572,
128 board_82573,
Bruce Allan4662e822008-08-26 18:37:06 -0700129 board_82574,
Alexander Duyck8c81c9c2009-03-19 01:12:27 +0000130 board_82583,
Auke Kokbc7f75f2007-09-17 12:30:59 -0700131 board_80003es2lan,
132 board_ich8lan,
133 board_ich9lan,
Bruce Allanf4187b52008-08-26 18:36:50 -0700134 board_ich10lan,
Bruce Allana4f58f52009-06-02 11:29:18 +0000135 board_pchlan,
Bruce Alland3738bb2010-06-16 13:27:28 +0000136 board_pch2lan,
Bruce Allan2fbe4522012-04-19 03:21:47 +0000137 board_pch_lpt,
David Ertman79849eb2015-02-10 09:10:43 +0000138 board_pch_spt
Auke Kokbc7f75f2007-09-17 12:30:59 -0700139};
140
Auke Kokbc7f75f2007-09-17 12:30:59 -0700141struct e1000_ps_page {
142 struct page *page;
143 u64 dma; /* must be u64 - written to hw */
144};
145
Bruce Allane921eb12012-11-28 09:28:37 +0000146/* wrappers around a pointer to a socket buffer,
Auke Kokbc7f75f2007-09-17 12:30:59 -0700147 * so a DMA handle can be stored along with the buffer
148 */
149struct e1000_buffer {
150 dma_addr_t dma;
151 struct sk_buff *skb;
152 union {
Bruce Allanad680762008-03-28 09:15:03 -0700153 /* Tx */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700154 struct {
155 unsigned long time_stamp;
156 u16 length;
157 u16 next_to_watch;
Tom Herbert9ed318d2010-05-05 14:02:27 +0000158 unsigned int segs;
159 unsigned int bytecount;
Alexander Duyck03b13202009-12-02 16:45:31 +0000160 u16 mapped_as_page;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700161 };
Bruce Allanad680762008-03-28 09:15:03 -0700162 /* Rx */
Alexander Duyck03b13202009-12-02 16:45:31 +0000163 struct {
164 /* arrays of page information for packet split */
165 struct e1000_ps_page *ps_pages;
166 struct page *page;
167 };
Auke Kokbc7f75f2007-09-17 12:30:59 -0700168 };
Auke Kokbc7f75f2007-09-17 12:30:59 -0700169};
170
171struct e1000_ring {
Bruce Allan55aa6982011-12-16 00:45:45 +0000172 struct e1000_adapter *adapter; /* back pointer to adapter */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700173 void *desc; /* pointer to ring memory */
174 dma_addr_t dma; /* phys address of ring */
175 unsigned int size; /* length of ring in bytes */
176 unsigned int count; /* number of desc. in ring */
177
178 u16 next_to_use;
179 u16 next_to_clean;
180
Bruce Allanc5083cf2011-12-16 00:45:40 +0000181 void __iomem *head;
182 void __iomem *tail;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700183
184 /* array of buffer information structs */
185 struct e1000_buffer *buffer_info;
186
Bruce Allan4662e822008-08-26 18:37:06 -0700187 char name[IFNAMSIZ + 5];
188 u32 ims_val;
189 u32 itr_val;
Bruce Allanc5083cf2011-12-16 00:45:40 +0000190 void __iomem *itr_register;
Bruce Allan4662e822008-08-26 18:37:06 -0700191 int set_itr;
192
Auke Kokbc7f75f2007-09-17 12:30:59 -0700193 struct sk_buff *rx_skb_top;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700194};
195
Bruce Allan7c257692008-04-23 11:09:00 -0700196/* PHY register snapshot values */
197struct e1000_phy_regs {
198 u16 bmcr; /* basic mode control register */
199 u16 bmsr; /* basic mode status register */
200 u16 advertise; /* auto-negotiation advertisement */
201 u16 lpa; /* link partner ability register */
202 u16 expansion; /* auto-negotiation expansion reg */
203 u16 ctrl1000; /* 1000BASE-T control register */
204 u16 stat1000; /* 1000BASE-T status register */
205 u16 estatus; /* extended status register */
206};
207
Auke Kokbc7f75f2007-09-17 12:30:59 -0700208/* board specific private data structure */
209struct e1000_adapter {
210 struct timer_list watchdog_timer;
211 struct timer_list phy_info_timer;
212 struct timer_list blink_timer;
213
214 struct work_struct reset_task;
215 struct work_struct watchdog_task;
216
217 const struct e1000_info *ei;
218
Jeff Kirsher86d70e52011-03-25 16:01:01 +0000219 unsigned long active_vlans[BITS_TO_LONGS(VLAN_N_VID)];
Auke Kokbc7f75f2007-09-17 12:30:59 -0700220 u32 bd_number;
221 u32 rx_buffer_len;
222 u16 mng_vlan_id;
223 u16 link_speed;
224 u16 link_duplex;
Bruce Allan84527592008-11-21 17:00:22 -0800225 u16 eeprom_vers;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700226
Auke Kokbc7f75f2007-09-17 12:30:59 -0700227 /* track device up/down/testing state */
228 unsigned long state;
229
230 /* Interrupt Throttle Rate */
231 u32 itr;
232 u32 itr_setting;
233 u16 tx_itr;
234 u16 rx_itr;
235
Bruce Allan33550ce2013-02-20 04:06:16 +0000236 /* Tx - one ring per active queue */
237 struct e1000_ring *tx_ring ____cacheline_aligned_in_smp;
Bruce Alland821a4c2012-08-24 20:38:11 +0000238 u32 tx_fifo_limit;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700239
240 struct napi_struct napi;
241
Bruce Allan94fb8482013-01-23 09:00:03 +0000242 unsigned int uncorr_errors; /* uncorrectable ECC errors */
243 unsigned int corr_errors; /* correctable ECC errors */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700244 unsigned int restart_queue;
245 u32 txd_cmd;
246
247 bool detect_tx_hung;
Jeff Kirsher09357b02011-11-18 14:25:00 +0000248 bool tx_hang_recheck;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700249 u8 tx_timeout_factor;
250
251 u32 tx_int_delay;
252 u32 tx_abs_int_delay;
253
254 unsigned int total_tx_bytes;
255 unsigned int total_tx_packets;
256 unsigned int total_rx_bytes;
257 unsigned int total_rx_packets;
258
Bruce Allanad680762008-03-28 09:15:03 -0700259 /* Tx stats */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700260 u64 tpt_old;
261 u64 colc_old;
Bruce Allan7c257692008-04-23 11:09:00 -0700262 u32 gotc;
263 u64 gotc_old;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700264 u32 tx_timeout_count;
265 u32 tx_fifo_head;
266 u32 tx_head_addr;
267 u32 tx_fifo_size;
268 u32 tx_dma_failed;
Jakub Kicinski59c871c2014-03-15 14:55:00 +0000269 u32 tx_hwtstamp_timeouts;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700270
Bruce Allane921eb12012-11-28 09:28:37 +0000271 /* Rx */
David Ertmanb56083e2014-04-07 23:11:09 +0000272 bool (*clean_rx)(struct e1000_ring *ring, int *work_done,
273 int work_to_do) ____cacheline_aligned_in_smp;
274 void (*alloc_rx_buf)(struct e1000_ring *ring, int cleaned_count,
275 gfp_t gfp);
Auke Kokbc7f75f2007-09-17 12:30:59 -0700276 struct e1000_ring *rx_ring;
277
278 u32 rx_int_delay;
279 u32 rx_abs_int_delay;
280
Bruce Allanad680762008-03-28 09:15:03 -0700281 /* Rx stats */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700282 u64 hw_csum_err;
283 u64 hw_csum_good;
284 u64 rx_hdr_split;
Bruce Allan7c257692008-04-23 11:09:00 -0700285 u32 gorc;
286 u64 gorc_old;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700287 u32 alloc_rx_buff_failed;
288 u32 rx_dma_failed;
Bruce Allanb67e1912012-12-27 08:32:33 +0000289 u32 rx_hwtstamp_cleared;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700290
291 unsigned int rx_ps_pages;
292 u16 rx_ps_bsize0;
Jeff Kirsher318a94d2008-03-28 09:15:16 -0700293 u32 max_frame_size;
294 u32 min_frame_size;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700295
296 /* OS defined structs */
297 struct net_device *netdev;
298 struct pci_dev *pdev;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700299
300 /* structs defined in e1000_hw.h */
301 struct e1000_hw hw;
302
Bruce Allan9d570882013-01-04 10:06:03 +0000303 spinlock_t stats64_lock; /* protects statistics counters */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700304 struct e1000_hw_stats stats;
305 struct e1000_phy_info phy_info;
306 struct e1000_phy_stats phy_stats;
307
Bruce Allan7c257692008-04-23 11:09:00 -0700308 /* Snapshot of PHY registers */
309 struct e1000_phy_regs phy_regs;
310
Auke Kokbc7f75f2007-09-17 12:30:59 -0700311 struct e1000_ring test_tx_ring;
312 struct e1000_ring test_rx_ring;
313 u32 test_icr;
314
315 u32 msg_enable;
Jeff Kirsher8e86acd2010-08-02 14:27:23 +0000316 unsigned int num_vectors;
Bruce Allan4662e822008-08-26 18:37:06 -0700317 struct msix_entry *msix_entries;
318 int int_mode;
319 u32 eiac_mask;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700320
321 u32 eeprom_wol;
322 u32 wol;
323 u32 pba;
Bruce Allan2adc55c2009-06-02 11:28:58 +0000324 u32 max_hw_frame_size;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700325
Jeff Kirsher318a94d2008-03-28 09:15:16 -0700326 bool fc_autoneg;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700327
Auke Kokbc7f75f2007-09-17 12:30:59 -0700328 unsigned int flags;
Jeff Kirshereb7c3ad2008-11-14 06:45:23 +0000329 unsigned int flags2;
Jesse Brandeburga8f88ff2008-10-02 16:33:25 -0700330 struct work_struct downshift_task;
331 struct work_struct update_phy_task;
Bruce Allan41cec6f2009-11-20 23:28:56 +0000332 struct work_struct print_hang_task;
Rafael J. Wysocki23606cf2010-03-14 14:35:17 +0000333
Carolyn Wybornyff10e132010-10-28 00:59:53 +0000334 int phy_hang_count;
Bruce Allan55aa6982011-12-16 00:45:45 +0000335
336 u16 tx_ring_count;
337 u16 rx_ring_count;
Bruce Allanb67e1912012-12-27 08:32:33 +0000338
339 struct hwtstamp_config hwtstamp_config;
340 struct delayed_work systim_overflow_work;
341 struct sk_buff *tx_hwtstamp_skb;
Jakub Kicinski59c871c2014-03-15 14:55:00 +0000342 unsigned long tx_hwtstamp_start;
Bruce Allanb67e1912012-12-27 08:32:33 +0000343 struct work_struct tx_hwtstamp_work;
344 spinlock_t systim_lock; /* protects SYSTIML/H regsters */
345 struct cyclecounter cc;
346 struct timecounter tc;
Bruce Alland89777b2013-01-19 01:09:58 +0000347 struct ptp_clock *ptp_clock;
348 struct ptp_clock_info ptp_clock_info;
Thomas Grafe2c65442015-04-10 15:52:37 +0200349 struct pm_qos_request pm_qos_req;
Bruce Alland495bcb2013-03-20 07:23:11 +0000350
351 u16 eee_advert;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700352};
353
354struct e1000_info {
355 enum e1000_mac_type mac;
356 unsigned int flags;
Bruce Allan6f461f62010-04-27 03:33:04 +0000357 unsigned int flags2;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700358 u32 pba;
Bruce Allan2adc55c2009-06-02 11:28:58 +0000359 u32 max_hw_frame_size;
Jeff Kirsher69e3fd82008-04-02 13:48:18 -0700360 s32 (*get_variants)(struct e1000_adapter *);
Jeff Kirsher8ce9d6c2011-09-24 13:23:52 +0000361 const struct e1000_mac_operations *mac_ops;
362 const struct e1000_phy_operations *phy_ops;
363 const struct e1000_nvm_operations *nvm_ops;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700364};
365
Bruce Alland89777b2013-01-19 01:09:58 +0000366s32 e1000e_get_base_timinca(struct e1000_adapter *adapter, u32 *timinca);
367
Bruce Allanb67e1912012-12-27 08:32:33 +0000368/* The system time is maintained by a 64-bit counter comprised of the 32-bit
369 * SYSTIMH and SYSTIML registers. How the counter increments (and therefore
370 * its resolution) is based on the contents of the TIMINCA register - it
371 * increments every incperiod (bits 31:24) clock ticks by incvalue (bits 23:0).
372 * For the best accuracy, the incperiod should be as small as possible. The
373 * incvalue is scaled by a factor as large as possible (while still fitting
374 * in bits 23:0) so that relatively small clock corrections can be made.
375 *
376 * As a result, a shift of INCVALUE_SHIFT_n is used to fit a value of
377 * INCVALUE_n into the TIMINCA register allowing 32+8+(24-INCVALUE_SHIFT_n)
378 * bits to count nanoseconds leaving the rest for fractional nonseconds.
379 */
380#define INCVALUE_96MHz 125
381#define INCVALUE_SHIFT_96MHz 17
382#define INCPERIOD_SHIFT_96MHz 2
383#define INCPERIOD_96MHz (12 >> INCPERIOD_SHIFT_96MHz)
384
385#define INCVALUE_25MHz 40
386#define INCVALUE_SHIFT_25MHz 18
387#define INCPERIOD_25MHz 1
388
Yanir Lubetkin83129b32015-06-02 17:05:45 +0300389#define INCVALUE_24MHz 125
390#define INCVALUE_SHIFT_24MHz 14
391#define INCPERIOD_24MHz 3
392
Bruce Allanb67e1912012-12-27 08:32:33 +0000393/* Another drawback of scaling the incvalue by a large factor is the
394 * 64-bit SYSTIM register overflows more quickly. This is dealt with
395 * by simply reading the clock before it overflows.
396 *
397 * Clock ns bits Overflows after
398 * ~~~~~~ ~~~~~~~ ~~~~~~~~~~~~~~~
399 * 96MHz 47-bit 2^(47-INCPERIOD_SHIFT_96MHz) / 10^9 / 3600 = 9.77 hrs
400 * 25MHz 46-bit 2^46 / 10^9 / 3600 = 19.55 hours
401 */
402#define E1000_SYSTIM_OVERFLOW_PERIOD (HZ * 60 * 60 * 4)
Todd Fujinaka5e7ff972014-05-03 06:41:37 +0000403#define E1000_MAX_82574_SYSTIM_REREADS 50
404#define E1000_82574_SYSTIM_EPSILON (1ULL << 35ULL)
Bruce Allanb67e1912012-12-27 08:32:33 +0000405
Auke Kokbc7f75f2007-09-17 12:30:59 -0700406/* hardware capability, feature, and workaround flags */
407#define FLAG_HAS_AMT (1 << 0)
408#define FLAG_HAS_FLASH (1 << 1)
409#define FLAG_HAS_HW_VLAN_FILTER (1 << 2)
410#define FLAG_HAS_WOL (1 << 3)
Bruce Allan79d4e902011-12-16 00:46:27 +0000411/* reserved bit4 */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700412#define FLAG_HAS_CTRLEXT_ON_LOAD (1 << 5)
413#define FLAG_HAS_SWSM_ON_LOAD (1 << 6)
414#define FLAG_HAS_JUMBO_FRAMES (1 << 7)
Bruce Allan4a770352008-10-01 17:18:35 -0700415#define FLAG_READ_ONLY_NVM (1 << 8)
Bruce Allan97ac8ca2008-04-29 09:16:05 -0700416#define FLAG_IS_ICH (1 << 9)
Bruce Allan4662e822008-08-26 18:37:06 -0700417#define FLAG_HAS_MSIX (1 << 10)
Auke Kokbc7f75f2007-09-17 12:30:59 -0700418#define FLAG_HAS_SMART_POWER_DOWN (1 << 11)
419#define FLAG_IS_QUAD_PORT_A (1 << 12)
420#define FLAG_IS_QUAD_PORT (1 << 13)
Bruce Allanb67e1912012-12-27 08:32:33 +0000421#define FLAG_HAS_HW_TIMESTAMP (1 << 14)
Auke Kokbc7f75f2007-09-17 12:30:59 -0700422#define FLAG_APME_IN_WUC (1 << 15)
423#define FLAG_APME_IN_CTRL3 (1 << 16)
424#define FLAG_APME_CHECK_PORT_B (1 << 17)
425#define FLAG_DISABLE_FC_PAUSE_TIME (1 << 18)
426#define FLAG_NO_WAKE_UCAST (1 << 19)
427#define FLAG_MNG_PT_ENABLED (1 << 20)
428#define FLAG_RESET_OVERWRITES_LAA (1 << 21)
429#define FLAG_TARC_SPEED_MODE_BIT (1 << 22)
430#define FLAG_TARC_SET_BIT_ZERO (1 << 23)
431#define FLAG_RX_NEEDS_RESTART (1 << 24)
432#define FLAG_LSC_GIG_SPEED_DROP (1 << 25)
433#define FLAG_SMART_POWER_DOWN (1 << 26)
434#define FLAG_MSI_ENABLED (1 << 27)
Bruce Allandc221292011-08-19 03:23:48 +0000435/* reserved (1 << 28) */
Auke Kokbc7f75f2007-09-17 12:30:59 -0700436#define FLAG_TSO_FORCE (1 << 29)
Bruce Allan12d43f72012-12-05 06:26:14 +0000437#define FLAG_RESTART_NOW (1 << 30)
Bruce Allanf8d59f72008-08-08 18:36:11 -0700438#define FLAG_MSI_TEST_FAILED (1 << 31)
Auke Kokbc7f75f2007-09-17 12:30:59 -0700439
Jeff Kirshereb7c3ad2008-11-14 06:45:23 +0000440#define FLAG2_CRC_STRIPPING (1 << 0)
Bruce Allana4f58f52009-06-02 11:29:18 +0000441#define FLAG2_HAS_PHY_WAKEUP (1 << 1)
Jesse Brandeburgb94b5022010-01-19 14:15:59 +0000442#define FLAG2_IS_DISCARDING (1 << 2)
Bruce Allan6f461f62010-04-27 03:33:04 +0000443#define FLAG2_DISABLE_ASPM_L1 (1 << 3)
Bruce Allan8c7bbb92010-06-16 13:26:41 +0000444#define FLAG2_HAS_PHY_STATS (1 << 4)
Bruce Allane52997f2010-06-16 13:27:49 +0000445#define FLAG2_HAS_EEE (1 << 5)
Jesse Brandeburg3a3b7582010-09-29 21:38:49 +0000446#define FLAG2_DMA_BURST (1 << 6)
Bruce Allan78cd29d2011-03-24 03:09:03 +0000447#define FLAG2_DISABLE_ASPM_L0S (1 << 7)
Bruce Allan828bac82010-09-29 21:39:37 +0000448#define FLAG2_DISABLE_AIM (1 << 8)
Carolyn Wybornyff10e132010-10-28 00:59:53 +0000449#define FLAG2_CHECK_PHY_HANG (1 << 9)
Bruce Allan7f99ae62011-07-22 06:21:35 +0000450#define FLAG2_NO_DISABLE_RX (1 << 10)
Bruce Allanc6e7f512011-07-29 05:53:02 +0000451#define FLAG2_PCIM2PCI_ARBITER_WA (1 << 11)
Ben Greear01840392012-02-11 15:39:25 +0000452#define FLAG2_DFLT_CRC_STRIPPING (1 << 12)
Bruce Allanb67e1912012-12-27 08:32:33 +0000453#define FLAG2_CHECK_RX_HWTSTAMP (1 << 13)
Jeff Kirshereb7c3ad2008-11-14 06:45:23 +0000454
Auke Kokbc7f75f2007-09-17 12:30:59 -0700455#define E1000_RX_DESC_PS(R, i) \
456 (&(((union e1000_rx_desc_packet_split *)((R).desc))[i]))
Bruce Allan5f450212011-07-22 06:21:46 +0000457#define E1000_RX_DESC_EXT(R, i) \
458 (&(((union e1000_rx_desc_extended *)((R).desc))[i]))
Auke Kokbc7f75f2007-09-17 12:30:59 -0700459#define E1000_GET_DESC(R, i, type) (&(((struct type *)((R).desc))[i]))
Auke Kokbc7f75f2007-09-17 12:30:59 -0700460#define E1000_TX_DESC(R, i) E1000_GET_DESC(R, i, e1000_tx_desc)
461#define E1000_CONTEXT_DESC(R, i) E1000_GET_DESC(R, i, e1000_context_desc)
462
463enum e1000_state_t {
464 __E1000_TESTING,
465 __E1000_RESETTING,
Bruce Allana90b4122011-10-07 03:50:38 +0000466 __E1000_ACCESS_SHARED_RESOURCE,
Auke Kokbc7f75f2007-09-17 12:30:59 -0700467 __E1000_DOWN
468};
469
470enum latency_range {
471 lowest_latency = 0,
472 low_latency = 1,
473 bulk_latency = 2,
474 latency_invalid = 255
475};
476
477extern char e1000e_driver_name[];
478extern const char e1000e_driver_version[];
479
Joe Perches5ccc9212013-09-23 11:37:59 -0700480void e1000e_check_options(struct e1000_adapter *adapter);
481void e1000e_set_ethtool_ops(struct net_device *netdev);
Auke Kokbc7f75f2007-09-17 12:30:59 -0700482
Joe Perches5ccc9212013-09-23 11:37:59 -0700483int e1000e_up(struct e1000_adapter *adapter);
David Ertman28002092014-02-14 07:16:41 +0000484void e1000e_down(struct e1000_adapter *adapter, bool reset);
Joe Perches5ccc9212013-09-23 11:37:59 -0700485void e1000e_reinit_locked(struct e1000_adapter *adapter);
486void e1000e_reset(struct e1000_adapter *adapter);
487void e1000e_power_up_phy(struct e1000_adapter *adapter);
488int e1000e_setup_rx_resources(struct e1000_ring *ring);
489int e1000e_setup_tx_resources(struct e1000_ring *ring);
490void e1000e_free_rx_resources(struct e1000_ring *ring);
491void e1000e_free_tx_resources(struct e1000_ring *ring);
492struct rtnl_link_stats64 *e1000e_get_stats64(struct net_device *netdev,
493 struct rtnl_link_stats64 *stats);
494void e1000e_set_interrupt_capability(struct e1000_adapter *adapter);
495void e1000e_reset_interrupt_capability(struct e1000_adapter *adapter);
496void e1000e_get_hw_control(struct e1000_adapter *adapter);
497void e1000e_release_hw_control(struct e1000_adapter *adapter);
498void e1000e_write_itr(struct e1000_adapter *adapter, u32 itr);
Auke Kokbc7f75f2007-09-17 12:30:59 -0700499
500extern unsigned int copybreak;
501
Jeff Kirsher8ce9d6c2011-09-24 13:23:52 +0000502extern const struct e1000_info e1000_82571_info;
503extern const struct e1000_info e1000_82572_info;
504extern const struct e1000_info e1000_82573_info;
505extern const struct e1000_info e1000_82574_info;
506extern const struct e1000_info e1000_82583_info;
507extern const struct e1000_info e1000_ich8_info;
508extern const struct e1000_info e1000_ich9_info;
509extern const struct e1000_info e1000_ich10_info;
510extern const struct e1000_info e1000_pch_info;
511extern const struct e1000_info e1000_pch2_info;
Bruce Allan2fbe4522012-04-19 03:21:47 +0000512extern const struct e1000_info e1000_pch_lpt_info;
David Ertman79849eb2015-02-10 09:10:43 +0000513extern const struct e1000_info e1000_pch_spt_info;
Jeff Kirsher8ce9d6c2011-09-24 13:23:52 +0000514extern const struct e1000_info e1000_es2_info;
Auke Kokbc7f75f2007-09-17 12:30:59 -0700515
Joe Perches5ccc9212013-09-23 11:37:59 -0700516void e1000e_ptp_init(struct e1000_adapter *adapter);
517void e1000e_ptp_remove(struct e1000_adapter *adapter);
Bruce Allan0be84012009-12-02 17:03:18 +0000518
Auke Kokbc7f75f2007-09-17 12:30:59 -0700519static inline s32 e1000_phy_hw_reset(struct e1000_hw *hw)
520{
Bruce Allan94d81862009-11-20 23:25:26 +0000521 return hw->phy.ops.reset(hw);
Auke Kokbc7f75f2007-09-17 12:30:59 -0700522}
523
Auke Kokbc7f75f2007-09-17 12:30:59 -0700524static inline s32 e1e_rphy(struct e1000_hw *hw, u32 offset, u16 *data)
525{
Bruce Allan94d81862009-11-20 23:25:26 +0000526 return hw->phy.ops.read_reg(hw, offset, data);
Auke Kokbc7f75f2007-09-17 12:30:59 -0700527}
528
Bruce Allanf1430d62012-04-14 04:21:52 +0000529static inline s32 e1e_rphy_locked(struct e1000_hw *hw, u32 offset, u16 *data)
530{
531 return hw->phy.ops.read_reg_locked(hw, offset, data);
532}
533
Auke Kokbc7f75f2007-09-17 12:30:59 -0700534static inline s32 e1e_wphy(struct e1000_hw *hw, u32 offset, u16 data)
535{
Bruce Allan94d81862009-11-20 23:25:26 +0000536 return hw->phy.ops.write_reg(hw, offset, data);
Auke Kokbc7f75f2007-09-17 12:30:59 -0700537}
538
Bruce Allanf1430d62012-04-14 04:21:52 +0000539static inline s32 e1e_wphy_locked(struct e1000_hw *hw, u32 offset, u16 data)
540{
541 return hw->phy.ops.write_reg_locked(hw, offset, data);
542}
543
Joe Perches5ccc9212013-09-23 11:37:59 -0700544void e1000e_reload_nvm_generic(struct e1000_hw *hw);
Bruce Allan608f8a02010-01-13 02:04:58 +0000545
546static inline s32 e1000e_read_mac_addr(struct e1000_hw *hw)
547{
548 if (hw->mac.ops.read_mac_addr)
549 return hw->mac.ops.read_mac_addr(hw);
550
551 return e1000_read_mac_addr_generic(hw);
552}
Auke Kokbc7f75f2007-09-17 12:30:59 -0700553
554static inline s32 e1000_validate_nvm_checksum(struct e1000_hw *hw)
555{
Bruce Allan94d81862009-11-20 23:25:26 +0000556 return hw->nvm.ops.validate(hw);
Auke Kokbc7f75f2007-09-17 12:30:59 -0700557}
558
559static inline s32 e1000e_update_nvm_checksum(struct e1000_hw *hw)
560{
Bruce Allan94d81862009-11-20 23:25:26 +0000561 return hw->nvm.ops.update(hw);
Auke Kokbc7f75f2007-09-17 12:30:59 -0700562}
563
Bruce Allanc29c3ba2013-02-20 04:05:50 +0000564static inline s32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words,
565 u16 *data)
Auke Kokbc7f75f2007-09-17 12:30:59 -0700566{
Bruce Allan94d81862009-11-20 23:25:26 +0000567 return hw->nvm.ops.read(hw, offset, words, data);
Auke Kokbc7f75f2007-09-17 12:30:59 -0700568}
569
Bruce Allanc29c3ba2013-02-20 04:05:50 +0000570static inline s32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words,
571 u16 *data)
Auke Kokbc7f75f2007-09-17 12:30:59 -0700572{
Bruce Allan94d81862009-11-20 23:25:26 +0000573 return hw->nvm.ops.write(hw, offset, words, data);
Auke Kokbc7f75f2007-09-17 12:30:59 -0700574}
575
576static inline s32 e1000_get_phy_info(struct e1000_hw *hw)
577{
Bruce Allan94d81862009-11-20 23:25:26 +0000578 return hw->phy.ops.get_info(hw);
Auke Kokbc7f75f2007-09-17 12:30:59 -0700579}
580
Auke Kokbc7f75f2007-09-17 12:30:59 -0700581static inline u32 __er32(struct e1000_hw *hw, unsigned long reg)
582{
583 return readl(hw->hw_addr + reg);
584}
585
Bruce Allanbdc125f2012-03-20 03:47:52 +0000586#define er32(reg) __er32(hw, E1000_##reg)
587
Andi Kleenc6f31482014-05-20 08:22:45 +0000588s32 __ew32_prepare(struct e1000_hw *hw);
589void __ew32(struct e1000_hw *hw, unsigned long reg, u32 val);
Auke Kokbc7f75f2007-09-17 12:30:59 -0700590
Bruce Allanbdc125f2012-03-20 03:47:52 +0000591#define ew32(reg, val) __ew32(hw, E1000_##reg, (val))
592
593#define e1e_flush() er32(STATUS)
594
595#define E1000_WRITE_REG_ARRAY(a, reg, offset, value) \
596 (__ew32((a), (reg + ((offset) << 2)), (value)))
597
598#define E1000_READ_REG_ARRAY(a, reg, offset) \
599 (readl((a)->hw_addr + reg + ((offset) << 2)))
600
Auke Kokbc7f75f2007-09-17 12:30:59 -0700601#endif /* _E1000_H_ */