1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright(c) 1999 - 2018 Intel Corporation. */
4 /* Linux PRO/1000 Ethernet Driver main header file */
9 #include <linux/bitops.h>
10 #include <linux/types.h>
11 #include <linux/timer.h>
12 #include <linux/workqueue.h>
14 #include <linux/netdevice.h>
15 #include <linux/pci.h>
16 #include <linux/pci-aspm.h>
17 #include <linux/crc32.h>
18 #include <linux/if_vlan.h>
19 #include <linux/timecounter.h>
20 #include <linux/net_tstamp.h>
21 #include <linux/ptp_clock_kernel.h>
22 #include <linux/ptp_classify.h>
23 #include <linux/mii.h>
24 #include <linux/mdio.h>
25 #include <linux/pm_qos.h>
30 #define e_dbg(format, arg...) \
31 netdev_dbg(hw->adapter->netdev, format, ## arg)
32 #define e_err(format, arg...) \
33 netdev_err(adapter->netdev, format, ## arg)
34 #define e_info(format, arg...) \
35 netdev_info(adapter->netdev, format, ## arg)
36 #define e_warn(format, arg...) \
37 netdev_warn(adapter->netdev, format, ## arg)
38 #define e_notice(format, arg...) \
39 netdev_notice(adapter->netdev, format, ## arg)
41 /* Interrupt modes, as used by the IntMode parameter */
42 #define E1000E_INT_MODE_LEGACY 0
43 #define E1000E_INT_MODE_MSI 1
44 #define E1000E_INT_MODE_MSIX 2
46 /* Tx/Rx descriptor defines */
47 #define E1000_DEFAULT_TXD 256
48 #define E1000_MAX_TXD 4096
49 #define E1000_MIN_TXD 64
51 #define E1000_DEFAULT_RXD 256
52 #define E1000_MAX_RXD 4096
53 #define E1000_MIN_RXD 64
55 #define E1000_MIN_ITR_USECS 10 /* 100000 irq/sec */
56 #define E1000_MAX_ITR_USECS 10000 /* 100 irq/sec */
58 #define E1000_FC_PAUSE_TIME 0x0680 /* 858 usec */
60 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
61 /* How many Rx Buffers do we bundle into one write to the hardware ? */
62 #define E1000_RX_BUFFER_WRITE 16 /* Must be power of 2 */
64 #define AUTO_ALL_MODES 0
65 #define E1000_EEPROM_APME 0x0400
67 #define E1000_MNG_VLAN_NONE (-1)
69 #define DEFAULT_JUMBO 9234
71 /* Time to wait before putting the device into D3 if there's no link (in ms). */
72 #define LINK_TIMEOUT 100
74 /* Count for polling __E1000_RESET condition every 10-20msec.
75 * Experimentation has shown the reset can take approximately 210msec.
77 #define E1000_CHECK_RESET_COUNT 25
79 #define PCICFG_DESC_RING_STATUS 0xe4
80 #define FLUSH_DESC_REQUIRED 0x100
82 /* in the case of WTHRESH, it appears at least the 82571/2 hardware
83 * writes back 4 descriptors when WTHRESH=5, and 3 descriptors when
84 * WTHRESH=4, so a setting of 5 gives the most efficient bus
85 * utilization but to avoid possible Tx stalls, set it to 1
87 #define E1000_TXDCTL_DMA_BURST_ENABLE \
88 (E1000_TXDCTL_GRAN | /* set descriptor granularity */ \
89 E1000_TXDCTL_COUNT_DESC | \
90 (1u << 16) | /* wthresh must be +1 more than desired */\
91 (1u << 8) | /* hthresh */ \
94 #define E1000_RXDCTL_DMA_BURST_ENABLE \
95 (0x01000000 | /* set descriptor granularity */ \
96 (4u << 16) | /* set writeback threshold */ \
97 (4u << 8) | /* set prefetch threshold */ \
98 0x20) /* set hthresh */
100 #define E1000_TIDV_FPD BIT(31)
101 #define E1000_RDTR_FPD BIT(31)
120 struct e1000_ps_page
{
122 u64 dma
; /* must be u64 - written to hw */
125 /* wrappers around a pointer to a socket buffer,
126 * so a DMA handle can be stored along with the buffer
128 struct e1000_buffer
{
134 unsigned long time_stamp
;
138 unsigned int bytecount
;
143 /* arrays of page information for packet split */
144 struct e1000_ps_page
*ps_pages
;
151 struct e1000_adapter
*adapter
; /* back pointer to adapter */
152 void *desc
; /* pointer to ring memory */
153 dma_addr_t dma
; /* phys address of ring */
154 unsigned int size
; /* length of ring in bytes */
155 unsigned int count
; /* number of desc. in ring */
163 /* array of buffer information structs */
164 struct e1000_buffer
*buffer_info
;
166 char name
[IFNAMSIZ
+ 5];
169 void __iomem
*itr_register
;
172 struct sk_buff
*rx_skb_top
;
175 /* PHY register snapshot values */
176 struct e1000_phy_regs
{
177 u16 bmcr
; /* basic mode control register */
178 u16 bmsr
; /* basic mode status register */
179 u16 advertise
; /* auto-negotiation advertisement */
180 u16 lpa
; /* link partner ability register */
181 u16 expansion
; /* auto-negotiation expansion reg */
182 u16 ctrl1000
; /* 1000BASE-T control register */
183 u16 stat1000
; /* 1000BASE-T status register */
184 u16 estatus
; /* extended status register */
187 /* board specific private data structure */
188 struct e1000_adapter
{
189 struct timer_list watchdog_timer
;
190 struct timer_list phy_info_timer
;
191 struct timer_list blink_timer
;
193 struct work_struct reset_task
;
194 struct work_struct watchdog_task
;
196 const struct e1000_info
*ei
;
198 unsigned long active_vlans
[BITS_TO_LONGS(VLAN_N_VID
)];
206 /* track device up/down/testing state */
209 /* Interrupt Throttle Rate */
215 /* Tx - one ring per active queue */
216 struct e1000_ring
*tx_ring ____cacheline_aligned_in_smp
;
219 struct napi_struct napi
;
221 unsigned int uncorr_errors
; /* uncorrectable ECC errors */
222 unsigned int corr_errors
; /* correctable ECC errors */
223 unsigned int restart_queue
;
227 bool tx_hang_recheck
;
228 u8 tx_timeout_factor
;
231 u32 tx_abs_int_delay
;
233 unsigned int total_tx_bytes
;
234 unsigned int total_tx_packets
;
235 unsigned int total_rx_bytes
;
236 unsigned int total_rx_packets
;
243 u32 tx_timeout_count
;
248 u32 tx_hwtstamp_timeouts
;
249 u32 tx_hwtstamp_skipped
;
252 bool (*clean_rx
)(struct e1000_ring
*ring
, int *work_done
,
253 int work_to_do
) ____cacheline_aligned_in_smp
;
254 void (*alloc_rx_buf
)(struct e1000_ring
*ring
, int cleaned_count
,
256 struct e1000_ring
*rx_ring
;
259 u32 rx_abs_int_delay
;
267 u32 alloc_rx_buff_failed
;
269 u32 rx_hwtstamp_cleared
;
271 unsigned int rx_ps_pages
;
276 /* OS defined structs */
277 struct net_device
*netdev
;
278 struct pci_dev
*pdev
;
280 /* structs defined in e1000_hw.h */
283 spinlock_t stats64_lock
; /* protects statistics counters */
284 struct e1000_hw_stats stats
;
285 struct e1000_phy_info phy_info
;
286 struct e1000_phy_stats phy_stats
;
288 /* Snapshot of PHY registers */
289 struct e1000_phy_regs phy_regs
;
291 struct e1000_ring test_tx_ring
;
292 struct e1000_ring test_rx_ring
;
296 unsigned int num_vectors
;
297 struct msix_entry
*msix_entries
;
304 u32 max_hw_frame_size
;
310 struct work_struct downshift_task
;
311 struct work_struct update_phy_task
;
312 struct work_struct print_hang_task
;
319 struct hwtstamp_config hwtstamp_config
;
320 struct delayed_work systim_overflow_work
;
321 struct sk_buff
*tx_hwtstamp_skb
;
322 unsigned long tx_hwtstamp_start
;
323 struct work_struct tx_hwtstamp_work
;
324 spinlock_t systim_lock
; /* protects SYSTIML/H regsters */
325 struct cyclecounter cc
;
326 struct timecounter tc
;
327 struct ptp_clock
*ptp_clock
;
328 struct ptp_clock_info ptp_clock_info
;
329 struct pm_qos_request pm_qos_req
;
336 enum e1000_mac_type mac
;
340 u32 max_hw_frame_size
;
341 s32 (*get_variants
)(struct e1000_adapter
*);
342 const struct e1000_mac_operations
*mac_ops
;
343 const struct e1000_phy_operations
*phy_ops
;
344 const struct e1000_nvm_operations
*nvm_ops
;
347 s32
e1000e_get_base_timinca(struct e1000_adapter
*adapter
, u32
*timinca
);
349 /* The system time is maintained by a 64-bit counter comprised of the 32-bit
350 * SYSTIMH and SYSTIML registers. How the counter increments (and therefore
351 * its resolution) is based on the contents of the TIMINCA register - it
352 * increments every incperiod (bits 31:24) clock ticks by incvalue (bits 23:0).
353 * For the best accuracy, the incperiod should be as small as possible. The
354 * incvalue is scaled by a factor as large as possible (while still fitting
355 * in bits 23:0) so that relatively small clock corrections can be made.
357 * As a result, a shift of INCVALUE_SHIFT_n is used to fit a value of
358 * INCVALUE_n into the TIMINCA register allowing 32+8+(24-INCVALUE_SHIFT_n)
359 * bits to count nanoseconds leaving the rest for fractional nonseconds.
361 #define INCVALUE_96MHZ 125
362 #define INCVALUE_SHIFT_96MHZ 17
363 #define INCPERIOD_SHIFT_96MHZ 2
364 #define INCPERIOD_96MHZ (12 >> INCPERIOD_SHIFT_96MHZ)
366 #define INCVALUE_25MHZ 40
367 #define INCVALUE_SHIFT_25MHZ 18
368 #define INCPERIOD_25MHZ 1
370 #define INCVALUE_24MHZ 125
371 #define INCVALUE_SHIFT_24MHZ 14
372 #define INCPERIOD_24MHZ 3
374 #define INCVALUE_38400KHZ 26
375 #define INCVALUE_SHIFT_38400KHZ 19
376 #define INCPERIOD_38400KHZ 1
378 /* Another drawback of scaling the incvalue by a large factor is the
379 * 64-bit SYSTIM register overflows more quickly. This is dealt with
380 * by simply reading the clock before it overflows.
382 * Clock ns bits Overflows after
383 * ~~~~~~ ~~~~~~~ ~~~~~~~~~~~~~~~
384 * 96MHz 47-bit 2^(47-INCPERIOD_SHIFT_96MHz) / 10^9 / 3600 = 9.77 hrs
385 * 25MHz 46-bit 2^46 / 10^9 / 3600 = 19.55 hours
387 #define E1000_SYSTIM_OVERFLOW_PERIOD (HZ * 60 * 60 * 4)
388 #define E1000_MAX_82574_SYSTIM_REREADS 50
389 #define E1000_82574_SYSTIM_EPSILON (1ULL << 35ULL)
391 /* hardware capability, feature, and workaround flags */
392 #define FLAG_HAS_AMT BIT(0)
393 #define FLAG_HAS_FLASH BIT(1)
394 #define FLAG_HAS_HW_VLAN_FILTER BIT(2)
395 #define FLAG_HAS_WOL BIT(3)
396 /* reserved BIT(4) */
397 #define FLAG_HAS_CTRLEXT_ON_LOAD BIT(5)
398 #define FLAG_HAS_SWSM_ON_LOAD BIT(6)
399 #define FLAG_HAS_JUMBO_FRAMES BIT(7)
400 #define FLAG_READ_ONLY_NVM BIT(8)
401 #define FLAG_IS_ICH BIT(9)
402 #define FLAG_HAS_MSIX BIT(10)
403 #define FLAG_HAS_SMART_POWER_DOWN BIT(11)
404 #define FLAG_IS_QUAD_PORT_A BIT(12)
405 #define FLAG_IS_QUAD_PORT BIT(13)
406 #define FLAG_HAS_HW_TIMESTAMP BIT(14)
407 #define FLAG_APME_IN_WUC BIT(15)
408 #define FLAG_APME_IN_CTRL3 BIT(16)
409 #define FLAG_APME_CHECK_PORT_B BIT(17)
410 #define FLAG_DISABLE_FC_PAUSE_TIME BIT(18)
411 #define FLAG_NO_WAKE_UCAST BIT(19)
412 #define FLAG_MNG_PT_ENABLED BIT(20)
413 #define FLAG_RESET_OVERWRITES_LAA BIT(21)
414 #define FLAG_TARC_SPEED_MODE_BIT BIT(22)
415 #define FLAG_TARC_SET_BIT_ZERO BIT(23)
416 #define FLAG_RX_NEEDS_RESTART BIT(24)
417 #define FLAG_LSC_GIG_SPEED_DROP BIT(25)
418 #define FLAG_SMART_POWER_DOWN BIT(26)
419 #define FLAG_MSI_ENABLED BIT(27)
420 /* reserved BIT(28) */
421 #define FLAG_TSO_FORCE BIT(29)
422 #define FLAG_RESTART_NOW BIT(30)
423 #define FLAG_MSI_TEST_FAILED BIT(31)
425 #define FLAG2_CRC_STRIPPING BIT(0)
426 #define FLAG2_HAS_PHY_WAKEUP BIT(1)
427 #define FLAG2_IS_DISCARDING BIT(2)
428 #define FLAG2_DISABLE_ASPM_L1 BIT(3)
429 #define FLAG2_HAS_PHY_STATS BIT(4)
430 #define FLAG2_HAS_EEE BIT(5)
431 #define FLAG2_DMA_BURST BIT(6)
432 #define FLAG2_DISABLE_ASPM_L0S BIT(7)
433 #define FLAG2_DISABLE_AIM BIT(8)
434 #define FLAG2_CHECK_PHY_HANG BIT(9)
435 #define FLAG2_NO_DISABLE_RX BIT(10)
436 #define FLAG2_PCIM2PCI_ARBITER_WA BIT(11)
437 #define FLAG2_DFLT_CRC_STRIPPING BIT(12)
438 #define FLAG2_CHECK_RX_HWTSTAMP BIT(13)
439 #define FLAG2_CHECK_SYSTIM_OVERFLOW BIT(14)
441 #define E1000_RX_DESC_PS(R, i) \
442 (&(((union e1000_rx_desc_packet_split *)((R).desc))[i]))
443 #define E1000_RX_DESC_EXT(R, i) \
444 (&(((union e1000_rx_desc_extended *)((R).desc))[i]))
445 #define E1000_GET_DESC(R, i, type) (&(((struct type *)((R).desc))[i]))
446 #define E1000_TX_DESC(R, i) E1000_GET_DESC(R, i, e1000_tx_desc)
447 #define E1000_CONTEXT_DESC(R, i) E1000_GET_DESC(R, i, e1000_context_desc)
452 __E1000_ACCESS_SHARED_RESOURCE
,
460 latency_invalid
= 255
463 extern char e1000e_driver_name
[];
464 extern const char e1000e_driver_version
[];
466 void e1000e_check_options(struct e1000_adapter
*adapter
);
467 void e1000e_set_ethtool_ops(struct net_device
*netdev
);
469 int e1000e_open(struct net_device
*netdev
);
470 int e1000e_close(struct net_device
*netdev
);
471 void e1000e_up(struct e1000_adapter
*adapter
);
472 void e1000e_down(struct e1000_adapter
*adapter
, bool reset
);
473 void e1000e_reinit_locked(struct e1000_adapter
*adapter
);
474 void e1000e_reset(struct e1000_adapter
*adapter
);
475 void e1000e_power_up_phy(struct e1000_adapter
*adapter
);
476 int e1000e_setup_rx_resources(struct e1000_ring
*ring
);
477 int e1000e_setup_tx_resources(struct e1000_ring
*ring
);
478 void e1000e_free_rx_resources(struct e1000_ring
*ring
);
479 void e1000e_free_tx_resources(struct e1000_ring
*ring
);
480 void e1000e_get_stats64(struct net_device
*netdev
,
481 struct rtnl_link_stats64
*stats
);
482 void e1000e_set_interrupt_capability(struct e1000_adapter
*adapter
);
483 void e1000e_reset_interrupt_capability(struct e1000_adapter
*adapter
);
484 void e1000e_get_hw_control(struct e1000_adapter
*adapter
);
485 void e1000e_release_hw_control(struct e1000_adapter
*adapter
);
486 void e1000e_write_itr(struct e1000_adapter
*adapter
, u32 itr
);
488 extern unsigned int copybreak
;
490 extern const struct e1000_info e1000_82571_info
;
491 extern const struct e1000_info e1000_82572_info
;
492 extern const struct e1000_info e1000_82573_info
;
493 extern const struct e1000_info e1000_82574_info
;
494 extern const struct e1000_info e1000_82583_info
;
495 extern const struct e1000_info e1000_ich8_info
;
496 extern const struct e1000_info e1000_ich9_info
;
497 extern const struct e1000_info e1000_ich10_info
;
498 extern const struct e1000_info e1000_pch_info
;
499 extern const struct e1000_info e1000_pch2_info
;
500 extern const struct e1000_info e1000_pch_lpt_info
;
501 extern const struct e1000_info e1000_pch_spt_info
;
502 extern const struct e1000_info e1000_pch_cnp_info
;
503 extern const struct e1000_info e1000_es2_info
;
505 void e1000e_ptp_init(struct e1000_adapter
*adapter
);
506 void e1000e_ptp_remove(struct e1000_adapter
*adapter
);
508 static inline s32
e1000_phy_hw_reset(struct e1000_hw
*hw
)
510 return hw
->phy
.ops
.reset(hw
);
513 static inline s32
e1e_rphy(struct e1000_hw
*hw
, u32 offset
, u16
*data
)
515 return hw
->phy
.ops
.read_reg(hw
, offset
, data
);
518 static inline s32
e1e_rphy_locked(struct e1000_hw
*hw
, u32 offset
, u16
*data
)
520 return hw
->phy
.ops
.read_reg_locked(hw
, offset
, data
);
523 static inline s32
e1e_wphy(struct e1000_hw
*hw
, u32 offset
, u16 data
)
525 return hw
->phy
.ops
.write_reg(hw
, offset
, data
);
528 static inline s32
e1e_wphy_locked(struct e1000_hw
*hw
, u32 offset
, u16 data
)
530 return hw
->phy
.ops
.write_reg_locked(hw
, offset
, data
);
533 void e1000e_reload_nvm_generic(struct e1000_hw
*hw
);
535 static inline s32
e1000e_read_mac_addr(struct e1000_hw
*hw
)
537 if (hw
->mac
.ops
.read_mac_addr
)
538 return hw
->mac
.ops
.read_mac_addr(hw
);
540 return e1000_read_mac_addr_generic(hw
);
543 static inline s32
e1000_validate_nvm_checksum(struct e1000_hw
*hw
)
545 return hw
->nvm
.ops
.validate(hw
);
548 static inline s32
e1000e_update_nvm_checksum(struct e1000_hw
*hw
)
550 return hw
->nvm
.ops
.update(hw
);
553 static inline s32
e1000_read_nvm(struct e1000_hw
*hw
, u16 offset
, u16 words
,
556 return hw
->nvm
.ops
.read(hw
, offset
, words
, data
);
559 static inline s32
e1000_write_nvm(struct e1000_hw
*hw
, u16 offset
, u16 words
,
562 return hw
->nvm
.ops
.write(hw
, offset
, words
, data
);
565 static inline s32
e1000_get_phy_info(struct e1000_hw
*hw
)
567 return hw
->phy
.ops
.get_info(hw
);
570 static inline u32
__er32(struct e1000_hw
*hw
, unsigned long reg
)
572 return readl(hw
->hw_addr
+ reg
);
575 #define er32(reg) __er32(hw, E1000_##reg)
577 s32
__ew32_prepare(struct e1000_hw
*hw
);
578 void __ew32(struct e1000_hw
*hw
, unsigned long reg
, u32 val
);
580 #define ew32(reg, val) __ew32(hw, E1000_##reg, (val))
582 #define e1e_flush() er32(STATUS)
584 #define E1000_WRITE_REG_ARRAY(a, reg, offset, value) \
585 (__ew32((a), (reg + ((offset) << 2)), (value)))
587 #define E1000_READ_REG_ARRAY(a, reg, offset) \
588 (readl((a)->hw_addr + reg + ((offset) << 2)))
590 #endif /* _E1000_H_ */