1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* Copyright(c) 1999 - 2018 Intel Corporation. */
12 #define E1000_DEV_ID_82571EB_COPPER 0x105E
13 #define E1000_DEV_ID_82571EB_FIBER 0x105F
14 #define E1000_DEV_ID_82571EB_SERDES 0x1060
15 #define E1000_DEV_ID_82571EB_QUAD_COPPER 0x10A4
16 #define E1000_DEV_ID_82571PT_QUAD_COPPER 0x10D5
17 #define E1000_DEV_ID_82571EB_QUAD_FIBER 0x10A5
18 #define E1000_DEV_ID_82571EB_QUAD_COPPER_LP 0x10BC
19 #define E1000_DEV_ID_82571EB_SERDES_DUAL 0x10D9
20 #define E1000_DEV_ID_82571EB_SERDES_QUAD 0x10DA
21 #define E1000_DEV_ID_82572EI_COPPER 0x107D
22 #define E1000_DEV_ID_82572EI_FIBER 0x107E
23 #define E1000_DEV_ID_82572EI_SERDES 0x107F
24 #define E1000_DEV_ID_82572EI 0x10B9
25 #define E1000_DEV_ID_82573E 0x108B
26 #define E1000_DEV_ID_82573E_IAMT 0x108C
27 #define E1000_DEV_ID_82573L 0x109A
28 #define E1000_DEV_ID_82574L 0x10D3
29 #define E1000_DEV_ID_82574LA 0x10F6
30 #define E1000_DEV_ID_82583V 0x150C
31 #define E1000_DEV_ID_80003ES2LAN_COPPER_DPT 0x1096
32 #define E1000_DEV_ID_80003ES2LAN_SERDES_DPT 0x1098
33 #define E1000_DEV_ID_80003ES2LAN_COPPER_SPT 0x10BA
34 #define E1000_DEV_ID_80003ES2LAN_SERDES_SPT 0x10BB
35 #define E1000_DEV_ID_ICH8_82567V_3 0x1501
36 #define E1000_DEV_ID_ICH8_IGP_M_AMT 0x1049
37 #define E1000_DEV_ID_ICH8_IGP_AMT 0x104A
38 #define E1000_DEV_ID_ICH8_IGP_C 0x104B
39 #define E1000_DEV_ID_ICH8_IFE 0x104C
40 #define E1000_DEV_ID_ICH8_IFE_GT 0x10C4
41 #define E1000_DEV_ID_ICH8_IFE_G 0x10C5
42 #define E1000_DEV_ID_ICH8_IGP_M 0x104D
43 #define E1000_DEV_ID_ICH9_IGP_AMT 0x10BD
44 #define E1000_DEV_ID_ICH9_BM 0x10E5
45 #define E1000_DEV_ID_ICH9_IGP_M_AMT 0x10F5
46 #define E1000_DEV_ID_ICH9_IGP_M 0x10BF
47 #define E1000_DEV_ID_ICH9_IGP_M_V 0x10CB
48 #define E1000_DEV_ID_ICH9_IGP_C 0x294C
49 #define E1000_DEV_ID_ICH9_IFE 0x10C0
50 #define E1000_DEV_ID_ICH9_IFE_GT 0x10C3
51 #define E1000_DEV_ID_ICH9_IFE_G 0x10C2
52 #define E1000_DEV_ID_ICH10_R_BM_LM 0x10CC
53 #define E1000_DEV_ID_ICH10_R_BM_LF 0x10CD
54 #define E1000_DEV_ID_ICH10_R_BM_V 0x10CE
55 #define E1000_DEV_ID_ICH10_D_BM_LM 0x10DE
56 #define E1000_DEV_ID_ICH10_D_BM_LF 0x10DF
57 #define E1000_DEV_ID_ICH10_D_BM_V 0x1525
58 #define E1000_DEV_ID_PCH_M_HV_LM 0x10EA
59 #define E1000_DEV_ID_PCH_M_HV_LC 0x10EB
60 #define E1000_DEV_ID_PCH_D_HV_DM 0x10EF
61 #define E1000_DEV_ID_PCH_D_HV_DC 0x10F0
62 #define E1000_DEV_ID_PCH2_LV_LM 0x1502
63 #define E1000_DEV_ID_PCH2_LV_V 0x1503
64 #define E1000_DEV_ID_PCH_LPT_I217_LM 0x153A
65 #define E1000_DEV_ID_PCH_LPT_I217_V 0x153B
66 #define E1000_DEV_ID_PCH_LPTLP_I218_LM 0x155A
67 #define E1000_DEV_ID_PCH_LPTLP_I218_V 0x1559
68 #define E1000_DEV_ID_PCH_I218_LM2 0x15A0
69 #define E1000_DEV_ID_PCH_I218_V2 0x15A1
70 #define E1000_DEV_ID_PCH_I218_LM3 0x15A2 /* Wildcat Point PCH */
71 #define E1000_DEV_ID_PCH_I218_V3 0x15A3 /* Wildcat Point PCH */
72 #define E1000_DEV_ID_PCH_SPT_I219_LM 0x156F /* SPT PCH */
73 #define E1000_DEV_ID_PCH_SPT_I219_V 0x1570 /* SPT PCH */
74 #define E1000_DEV_ID_PCH_SPT_I219_LM2 0x15B7 /* SPT-H PCH */
75 #define E1000_DEV_ID_PCH_SPT_I219_V2 0x15B8 /* SPT-H PCH */
76 #define E1000_DEV_ID_PCH_LBG_I219_LM3 0x15B9 /* LBG PCH */
77 #define E1000_DEV_ID_PCH_SPT_I219_LM4 0x15D7
78 #define E1000_DEV_ID_PCH_SPT_I219_V4 0x15D8
79 #define E1000_DEV_ID_PCH_SPT_I219_LM5 0x15E3
80 #define E1000_DEV_ID_PCH_SPT_I219_V5 0x15D6
81 #define E1000_DEV_ID_PCH_CNP_I219_LM6 0x15BD
82 #define E1000_DEV_ID_PCH_CNP_I219_V6 0x15BE
83 #define E1000_DEV_ID_PCH_CNP_I219_LM7 0x15BB
84 #define E1000_DEV_ID_PCH_CNP_I219_V7 0x15BC
85 #define E1000_DEV_ID_PCH_ICP_I219_LM8 0x15DF
86 #define E1000_DEV_ID_PCH_ICP_I219_V8 0x15E0
87 #define E1000_DEV_ID_PCH_ICP_I219_LM9 0x15E1
88 #define E1000_DEV_ID_PCH_ICP_I219_V9 0x15E2
90 #define E1000_REVISION_4 4
92 #define E1000_FUNC_1 1
94 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN0 0
95 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN1 3
114 enum e1000_media_type {
115 e1000_media_type_unknown = 0,
116 e1000_media_type_copper = 1,
117 e1000_media_type_fiber = 2,
118 e1000_media_type_internal_serdes = 3,
119 e1000_num_media_types
122 enum e1000_nvm_type {
123 e1000_nvm_unknown = 0,
125 e1000_nvm_eeprom_spi,
130 enum e1000_nvm_override {
131 e1000_nvm_override_none = 0,
132 e1000_nvm_override_spi_small,
133 e1000_nvm_override_spi_large
136 enum e1000_phy_type {
137 e1000_phy_unknown = 0,
152 enum e1000_bus_width {
153 e1000_bus_width_unknown = 0,
154 e1000_bus_width_pcie_x1,
155 e1000_bus_width_pcie_x2,
156 e1000_bus_width_pcie_x4 = 4,
157 e1000_bus_width_pcie_x8 = 8,
160 e1000_bus_width_reserved
163 enum e1000_1000t_rx_status {
164 e1000_1000t_rx_status_not_ok = 0,
165 e1000_1000t_rx_status_ok,
166 e1000_1000t_rx_status_undefined = 0xFF
169 enum e1000_rev_polarity {
170 e1000_rev_polarity_normal = 0,
171 e1000_rev_polarity_reversed,
172 e1000_rev_polarity_undefined = 0xFF
180 e1000_fc_default = 0xFF
184 e1000_ms_hw_default = 0,
185 e1000_ms_force_master,
186 e1000_ms_force_slave,
190 enum e1000_smart_speed {
191 e1000_smart_speed_default = 0,
192 e1000_smart_speed_on,
193 e1000_smart_speed_off
196 enum e1000_serdes_link_state {
197 e1000_serdes_link_down = 0,
198 e1000_serdes_link_autoneg_progress,
199 e1000_serdes_link_autoneg_complete,
200 e1000_serdes_link_forced_up
203 /* Receive Descriptor - Extended */
204 union e1000_rx_desc_extended {
211 __le32 mrq; /* Multiple Rx Queues */
213 __le32 rss; /* RSS Hash */
215 __le16 ip_id; /* IP id */
216 __le16 csum; /* Packet Checksum */
221 __le32 status_error; /* ext status/error */
223 __le16 vlan; /* VLAN tag */
225 } wb; /* writeback */
228 #define MAX_PS_BUFFERS 4
230 /* Number of packet split data buffers (not including the header buffer) */
231 #define PS_PAGE_BUFFERS (MAX_PS_BUFFERS - 1)
233 /* Receive Descriptor - Packet Split */
234 union e1000_rx_desc_packet_split {
236 /* one buffer for protocol header(s), three data buffers */
237 __le64 buffer_addr[MAX_PS_BUFFERS];
241 __le32 mrq; /* Multiple Rx Queues */
243 __le32 rss; /* RSS Hash */
245 __le16 ip_id; /* IP id */
246 __le16 csum; /* Packet Checksum */
251 __le32 status_error; /* ext status/error */
252 __le16 length0; /* length of buffer 0 */
253 __le16 vlan; /* VLAN tag */
256 __le16 header_status;
257 /* length of buffers 1-3 */
258 __le16 length[PS_PAGE_BUFFERS];
261 } wb; /* writeback */
264 /* Transmit Descriptor */
265 struct e1000_tx_desc {
266 __le64 buffer_addr; /* Address of the descriptor's data buffer */
270 __le16 length; /* Data buffer length */
271 u8 cso; /* Checksum offset */
272 u8 cmd; /* Descriptor control */
278 u8 status; /* Descriptor status */
279 u8 css; /* Checksum start */
285 /* Offload Context Descriptor */
286 struct e1000_context_desc {
290 u8 ipcss; /* IP checksum start */
291 u8 ipcso; /* IP checksum offset */
292 __le16 ipcse; /* IP checksum end */
298 u8 tucss; /* TCP checksum start */
299 u8 tucso; /* TCP checksum offset */
300 __le16 tucse; /* TCP checksum end */
303 __le32 cmd_and_length;
307 u8 status; /* Descriptor status */
308 u8 hdr_len; /* Header length */
309 __le16 mss; /* Maximum segment size */
314 /* Offload data descriptor */
315 struct e1000_data_desc {
316 __le64 buffer_addr; /* Address of the descriptor's buffer address */
320 __le16 length; /* Data buffer length */
328 u8 status; /* Descriptor status */
329 u8 popts; /* Packet Options */
335 /* Statistics counters collected by the MAC */
336 struct e1000_hw_stats {
402 struct e1000_phy_stats {
407 struct e1000_host_mng_dhcp_cookie {
418 /* Host Interface "Rev 1" */
419 struct e1000_host_command_header {
426 #define E1000_HI_MAX_DATA_LENGTH 252
427 struct e1000_host_command_info {
428 struct e1000_host_command_header command_header;
429 u8 command_data[E1000_HI_MAX_DATA_LENGTH];
432 /* Host Interface "Rev 2" */
433 struct e1000_host_mng_command_header {
441 #define E1000_HI_MAX_MNG_DATA_LENGTH 0x6F8
442 struct e1000_host_mng_command_info {
443 struct e1000_host_mng_command_header command_header;
444 u8 command_data[E1000_HI_MAX_MNG_DATA_LENGTH];
452 /* Function pointers for the MAC. */
453 struct e1000_mac_operations {
454 s32 (*id_led_init)(struct e1000_hw *);
455 s32 (*blink_led)(struct e1000_hw *);
456 bool (*check_mng_mode)(struct e1000_hw *);
457 s32 (*check_for_link)(struct e1000_hw *);
458 s32 (*cleanup_led)(struct e1000_hw *);
459 void (*clear_hw_cntrs)(struct e1000_hw *);
460 void (*clear_vfta)(struct e1000_hw *);
461 s32 (*get_bus_info)(struct e1000_hw *);
462 void (*set_lan_id)(struct e1000_hw *);
463 s32 (*get_link_up_info)(struct e1000_hw *, u16 *, u16 *);
464 s32 (*led_on)(struct e1000_hw *);
465 s32 (*led_off)(struct e1000_hw *);
466 void (*update_mc_addr_list)(struct e1000_hw *, u8 *, u32);
467 s32 (*reset_hw)(struct e1000_hw *);
468 s32 (*init_hw)(struct e1000_hw *);
469 s32 (*setup_link)(struct e1000_hw *);
470 s32 (*setup_physical_interface)(struct e1000_hw *);
471 s32 (*setup_led)(struct e1000_hw *);
472 void (*write_vfta)(struct e1000_hw *, u32, u32);
473 void (*config_collision_dist)(struct e1000_hw *);
474 int (*rar_set)(struct e1000_hw *, u8 *, u32);
475 s32 (*read_mac_addr)(struct e1000_hw *);
476 u32 (*rar_get_count)(struct e1000_hw *);
479 /* When to use various PHY register access functions:
482 * Function Does Does When to use
483 * ~~~~~~~~~~~~ ~~~~~ ~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
484 * X_reg L,P,A n/a for simple PHY reg accesses
485 * X_reg_locked P,A L for multiple accesses of different regs
487 * X_reg_page A L,P for multiple accesses of different regs
490 * Where X=[read|write], L=locking, P=sets page, A=register access
493 struct e1000_phy_operations {
494 s32 (*acquire)(struct e1000_hw *);
495 s32 (*cfg_on_link_up)(struct e1000_hw *);
496 s32 (*check_polarity)(struct e1000_hw *);
497 s32 (*check_reset_block)(struct e1000_hw *);
498 s32 (*commit)(struct e1000_hw *);
499 s32 (*force_speed_duplex)(struct e1000_hw *);
500 s32 (*get_cfg_done)(struct e1000_hw *hw);
501 s32 (*get_cable_length)(struct e1000_hw *);
502 s32 (*get_info)(struct e1000_hw *);
503 s32 (*set_page)(struct e1000_hw *, u16);
504 s32 (*read_reg)(struct e1000_hw *, u32, u16 *);
505 s32 (*read_reg_locked)(struct e1000_hw *, u32, u16 *);
506 s32 (*read_reg_page)(struct e1000_hw *, u32, u16 *);
507 void (*release)(struct e1000_hw *);
508 s32 (*reset)(struct e1000_hw *);
509 s32 (*set_d0_lplu_state)(struct e1000_hw *, bool);
510 s32 (*set_d3_lplu_state)(struct e1000_hw *, bool);
511 s32 (*write_reg)(struct e1000_hw *, u32, u16);
512 s32 (*write_reg_locked)(struct e1000_hw *, u32, u16);
513 s32 (*write_reg_page)(struct e1000_hw *, u32, u16);
514 void (*power_up)(struct e1000_hw *);
515 void (*power_down)(struct e1000_hw *);
518 /* Function pointers for the NVM. */
519 struct e1000_nvm_operations {
520 s32 (*acquire)(struct e1000_hw *);
521 s32 (*read)(struct e1000_hw *, u16, u16, u16 *);
522 void (*release)(struct e1000_hw *);
523 void (*reload)(struct e1000_hw *);
524 s32 (*update)(struct e1000_hw *);
525 s32 (*valid_led_default)(struct e1000_hw *, u16 *);
526 s32 (*validate)(struct e1000_hw *);
527 s32 (*write)(struct e1000_hw *, u16, u16, u16 *);
530 struct e1000_mac_info {
531 struct e1000_mac_operations ops;
533 u8 perm_addr[ETH_ALEN];
535 enum e1000_mac_type type;
552 /* Maximum size of the MTA register table in all supported adapters */
553 #define MAX_MTA_REG 128
554 u32 mta_shadow[MAX_MTA_REG];
557 u8 forced_speed_duplex;
561 bool arc_subsystem_valid;
564 bool get_link_status;
566 bool serdes_has_link;
567 bool tx_pkt_filtering;
568 enum e1000_serdes_link_state serdes_link_state;
571 struct e1000_phy_info {
572 struct e1000_phy_operations ops;
574 enum e1000_phy_type type;
576 enum e1000_1000t_rx_status local_rx;
577 enum e1000_1000t_rx_status remote_rx;
578 enum e1000_ms_type ms_type;
579 enum e1000_ms_type original_ms_type;
580 enum e1000_rev_polarity cable_polarity;
581 enum e1000_smart_speed smart_speed;
585 u32 reset_delay_us; /* in usec */
588 enum e1000_media_type media_type;
590 u16 autoneg_advertised;
593 u16 max_cable_length;
594 u16 min_cable_length;
598 bool disable_polarity_correction;
600 bool polarity_correction;
601 bool speed_downgraded;
602 bool autoneg_wait_to_complete;
605 struct e1000_nvm_info {
606 struct e1000_nvm_operations ops;
608 enum e1000_nvm_type type;
609 enum e1000_nvm_override override;
621 struct e1000_bus_info {
622 enum e1000_bus_width width;
627 struct e1000_fc_info {
628 u32 high_water; /* Flow control high-water mark */
629 u32 low_water; /* Flow control low-water mark */
630 u16 pause_time; /* Flow control pause timer */
631 u16 refresh_time; /* Flow control refresh timer */
632 bool send_xon; /* Flow control send XON */
633 bool strict_ieee; /* Strict IEEE mode */
634 enum e1000_fc_mode current_mode; /* FC mode in effect */
635 enum e1000_fc_mode requested_mode; /* FC mode requested by caller */
638 struct e1000_dev_spec_82571 {
643 struct e1000_dev_spec_80003es2lan {
647 struct e1000_shadow_ram {
652 #define E1000_ICH8_SHADOW_RAM_WORDS 2048
654 /* I218 PHY Ultra Low Power (ULP) states */
655 enum e1000_ulp_state {
656 e1000_ulp_state_unknown,
661 struct e1000_dev_spec_ich8lan {
662 bool kmrn_lock_loss_workaround_enabled;
663 struct e1000_shadow_ram shadow_ram[E1000_ICH8_SHADOW_RAM_WORDS];
667 enum e1000_ulp_state ulp_state;
671 struct e1000_adapter *adapter;
673 void __iomem *hw_addr;
674 void __iomem *flash_address;
676 struct e1000_mac_info mac;
677 struct e1000_fc_info fc;
678 struct e1000_phy_info phy;
679 struct e1000_nvm_info nvm;
680 struct e1000_bus_info bus;
681 struct e1000_host_mng_dhcp_cookie mng_cookie;
684 struct e1000_dev_spec_82571 e82571;
685 struct e1000_dev_spec_80003es2lan e80003es2lan;
686 struct e1000_dev_spec_ich8lan ich8lan;
691 #include "80003es2lan.h"