1 /* Intel PRO/1000 Linux driver
2 * Copyright(c) 1999 - 2015 Intel Corporation.
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.
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
13 * The full GNU General Public License is included in this distribution in
14 * the file called "COPYING".
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
30 #define E1000_DEV_ID_82571EB_COPPER 0x105E
31 #define E1000_DEV_ID_82571EB_FIBER 0x105F
32 #define E1000_DEV_ID_82571EB_SERDES 0x1060
33 #define E1000_DEV_ID_82571EB_QUAD_COPPER 0x10A4
34 #define E1000_DEV_ID_82571PT_QUAD_COPPER 0x10D5
35 #define E1000_DEV_ID_82571EB_QUAD_FIBER 0x10A5
36 #define E1000_DEV_ID_82571EB_QUAD_COPPER_LP 0x10BC
37 #define E1000_DEV_ID_82571EB_SERDES_DUAL 0x10D9
38 #define E1000_DEV_ID_82571EB_SERDES_QUAD 0x10DA
39 #define E1000_DEV_ID_82572EI_COPPER 0x107D
40 #define E1000_DEV_ID_82572EI_FIBER 0x107E
41 #define E1000_DEV_ID_82572EI_SERDES 0x107F
42 #define E1000_DEV_ID_82572EI 0x10B9
43 #define E1000_DEV_ID_82573E 0x108B
44 #define E1000_DEV_ID_82573E_IAMT 0x108C
45 #define E1000_DEV_ID_82573L 0x109A
46 #define E1000_DEV_ID_82574L 0x10D3
47 #define E1000_DEV_ID_82574LA 0x10F6
48 #define E1000_DEV_ID_82583V 0x150C
49 #define E1000_DEV_ID_80003ES2LAN_COPPER_DPT 0x1096
50 #define E1000_DEV_ID_80003ES2LAN_SERDES_DPT 0x1098
51 #define E1000_DEV_ID_80003ES2LAN_COPPER_SPT 0x10BA
52 #define E1000_DEV_ID_80003ES2LAN_SERDES_SPT 0x10BB
53 #define E1000_DEV_ID_ICH8_82567V_3 0x1501
54 #define E1000_DEV_ID_ICH8_IGP_M_AMT 0x1049
55 #define E1000_DEV_ID_ICH8_IGP_AMT 0x104A
56 #define E1000_DEV_ID_ICH8_IGP_C 0x104B
57 #define E1000_DEV_ID_ICH8_IFE 0x104C
58 #define E1000_DEV_ID_ICH8_IFE_GT 0x10C4
59 #define E1000_DEV_ID_ICH8_IFE_G 0x10C5
60 #define E1000_DEV_ID_ICH8_IGP_M 0x104D
61 #define E1000_DEV_ID_ICH9_IGP_AMT 0x10BD
62 #define E1000_DEV_ID_ICH9_BM 0x10E5
63 #define E1000_DEV_ID_ICH9_IGP_M_AMT 0x10F5
64 #define E1000_DEV_ID_ICH9_IGP_M 0x10BF
65 #define E1000_DEV_ID_ICH9_IGP_M_V 0x10CB
66 #define E1000_DEV_ID_ICH9_IGP_C 0x294C
67 #define E1000_DEV_ID_ICH9_IFE 0x10C0
68 #define E1000_DEV_ID_ICH9_IFE_GT 0x10C3
69 #define E1000_DEV_ID_ICH9_IFE_G 0x10C2
70 #define E1000_DEV_ID_ICH10_R_BM_LM 0x10CC
71 #define E1000_DEV_ID_ICH10_R_BM_LF 0x10CD
72 #define E1000_DEV_ID_ICH10_R_BM_V 0x10CE
73 #define E1000_DEV_ID_ICH10_D_BM_LM 0x10DE
74 #define E1000_DEV_ID_ICH10_D_BM_LF 0x10DF
75 #define E1000_DEV_ID_ICH10_D_BM_V 0x1525
76 #define E1000_DEV_ID_PCH_M_HV_LM 0x10EA
77 #define E1000_DEV_ID_PCH_M_HV_LC 0x10EB
78 #define E1000_DEV_ID_PCH_D_HV_DM 0x10EF
79 #define E1000_DEV_ID_PCH_D_HV_DC 0x10F0
80 #define E1000_DEV_ID_PCH2_LV_LM 0x1502
81 #define E1000_DEV_ID_PCH2_LV_V 0x1503
82 #define E1000_DEV_ID_PCH_LPT_I217_LM 0x153A
83 #define E1000_DEV_ID_PCH_LPT_I217_V 0x153B
84 #define E1000_DEV_ID_PCH_LPTLP_I218_LM 0x155A
85 #define E1000_DEV_ID_PCH_LPTLP_I218_V 0x1559
86 #define E1000_DEV_ID_PCH_I218_LM2 0x15A0
87 #define E1000_DEV_ID_PCH_I218_V2 0x15A1
88 #define E1000_DEV_ID_PCH_I218_LM3 0x15A2 /* Wildcat Point PCH */
89 #define E1000_DEV_ID_PCH_I218_V3 0x15A3 /* Wildcat Point PCH */
90 #define E1000_DEV_ID_PCH_SPT_I219_LM 0x156F /* SPT PCH */
91 #define E1000_DEV_ID_PCH_SPT_I219_V 0x1570 /* SPT PCH */
92 #define E1000_DEV_ID_PCH_SPT_I219_LM2 0x15B7 /* SPT-H PCH */
93 #define E1000_DEV_ID_PCH_SPT_I219_V2 0x15B8 /* SPT-H PCH */
94 #define E1000_DEV_ID_PCH_LBG_I219_LM3 0x15B9 /* LBG PCH */
96 #define E1000_REVISION_4 4
98 #define E1000_FUNC_1 1
100 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN0 0
101 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN1 3
103 enum e1000_mac_type {
119 enum e1000_media_type {
120 e1000_media_type_unknown = 0,
121 e1000_media_type_copper = 1,
122 e1000_media_type_fiber = 2,
123 e1000_media_type_internal_serdes = 3,
124 e1000_num_media_types
127 enum e1000_nvm_type {
128 e1000_nvm_unknown = 0,
130 e1000_nvm_eeprom_spi,
135 enum e1000_nvm_override {
136 e1000_nvm_override_none = 0,
137 e1000_nvm_override_spi_small,
138 e1000_nvm_override_spi_large
141 enum e1000_phy_type {
142 e1000_phy_unknown = 0,
157 enum e1000_bus_width {
158 e1000_bus_width_unknown = 0,
159 e1000_bus_width_pcie_x1,
160 e1000_bus_width_pcie_x2,
161 e1000_bus_width_pcie_x4 = 4,
162 e1000_bus_width_pcie_x8 = 8,
165 e1000_bus_width_reserved
168 enum e1000_1000t_rx_status {
169 e1000_1000t_rx_status_not_ok = 0,
170 e1000_1000t_rx_status_ok,
171 e1000_1000t_rx_status_undefined = 0xFF
174 enum e1000_rev_polarity {
175 e1000_rev_polarity_normal = 0,
176 e1000_rev_polarity_reversed,
177 e1000_rev_polarity_undefined = 0xFF
185 e1000_fc_default = 0xFF
189 e1000_ms_hw_default = 0,
190 e1000_ms_force_master,
191 e1000_ms_force_slave,
195 enum e1000_smart_speed {
196 e1000_smart_speed_default = 0,
197 e1000_smart_speed_on,
198 e1000_smart_speed_off
201 enum e1000_serdes_link_state {
202 e1000_serdes_link_down = 0,
203 e1000_serdes_link_autoneg_progress,
204 e1000_serdes_link_autoneg_complete,
205 e1000_serdes_link_forced_up
208 /* Receive Descriptor - Extended */
209 union e1000_rx_desc_extended {
216 __le32 mrq; /* Multiple Rx Queues */
218 __le32 rss; /* RSS Hash */
220 __le16 ip_id; /* IP id */
221 __le16 csum; /* Packet Checksum */
226 __le32 status_error; /* ext status/error */
228 __le16 vlan; /* VLAN tag */
230 } wb; /* writeback */
233 #define MAX_PS_BUFFERS 4
235 /* Number of packet split data buffers (not including the header buffer) */
236 #define PS_PAGE_BUFFERS (MAX_PS_BUFFERS - 1)
238 /* Receive Descriptor - Packet Split */
239 union e1000_rx_desc_packet_split {
241 /* one buffer for protocol header(s), three data buffers */
242 __le64 buffer_addr[MAX_PS_BUFFERS];
246 __le32 mrq; /* Multiple Rx Queues */
248 __le32 rss; /* RSS Hash */
250 __le16 ip_id; /* IP id */
251 __le16 csum; /* Packet Checksum */
256 __le32 status_error; /* ext status/error */
257 __le16 length0; /* length of buffer 0 */
258 __le16 vlan; /* VLAN tag */
261 __le16 header_status;
262 /* length of buffers 1-3 */
263 __le16 length[PS_PAGE_BUFFERS];
266 } wb; /* writeback */
269 /* Transmit Descriptor */
270 struct e1000_tx_desc {
271 __le64 buffer_addr; /* Address of the descriptor's data buffer */
275 __le16 length; /* Data buffer length */
276 u8 cso; /* Checksum offset */
277 u8 cmd; /* Descriptor control */
283 u8 status; /* Descriptor status */
284 u8 css; /* Checksum start */
290 /* Offload Context Descriptor */
291 struct e1000_context_desc {
295 u8 ipcss; /* IP checksum start */
296 u8 ipcso; /* IP checksum offset */
297 __le16 ipcse; /* IP checksum end */
303 u8 tucss; /* TCP checksum start */
304 u8 tucso; /* TCP checksum offset */
305 __le16 tucse; /* TCP checksum end */
308 __le32 cmd_and_length;
312 u8 status; /* Descriptor status */
313 u8 hdr_len; /* Header length */
314 __le16 mss; /* Maximum segment size */
319 /* Offload data descriptor */
320 struct e1000_data_desc {
321 __le64 buffer_addr; /* Address of the descriptor's buffer address */
325 __le16 length; /* Data buffer length */
333 u8 status; /* Descriptor status */
334 u8 popts; /* Packet Options */
340 /* Statistics counters collected by the MAC */
341 struct e1000_hw_stats {
407 struct e1000_phy_stats {
412 struct e1000_host_mng_dhcp_cookie {
423 /* Host Interface "Rev 1" */
424 struct e1000_host_command_header {
431 #define E1000_HI_MAX_DATA_LENGTH 252
432 struct e1000_host_command_info {
433 struct e1000_host_command_header command_header;
434 u8 command_data[E1000_HI_MAX_DATA_LENGTH];
437 /* Host Interface "Rev 2" */
438 struct e1000_host_mng_command_header {
446 #define E1000_HI_MAX_MNG_DATA_LENGTH 0x6F8
447 struct e1000_host_mng_command_info {
448 struct e1000_host_mng_command_header command_header;
449 u8 command_data[E1000_HI_MAX_MNG_DATA_LENGTH];
457 /* Function pointers for the MAC. */
458 struct e1000_mac_operations {
459 s32 (*id_led_init)(struct e1000_hw *);
460 s32 (*blink_led)(struct e1000_hw *);
461 bool (*check_mng_mode)(struct e1000_hw *);
462 s32 (*check_for_link)(struct e1000_hw *);
463 s32 (*cleanup_led)(struct e1000_hw *);
464 void (*clear_hw_cntrs)(struct e1000_hw *);
465 void (*clear_vfta)(struct e1000_hw *);
466 s32 (*get_bus_info)(struct e1000_hw *);
467 void (*set_lan_id)(struct e1000_hw *);
468 s32 (*get_link_up_info)(struct e1000_hw *, u16 *, u16 *);
469 s32 (*led_on)(struct e1000_hw *);
470 s32 (*led_off)(struct e1000_hw *);
471 void (*update_mc_addr_list)(struct e1000_hw *, u8 *, u32);
472 s32 (*reset_hw)(struct e1000_hw *);
473 s32 (*init_hw)(struct e1000_hw *);
474 s32 (*setup_link)(struct e1000_hw *);
475 s32 (*setup_physical_interface)(struct e1000_hw *);
476 s32 (*setup_led)(struct e1000_hw *);
477 void (*write_vfta)(struct e1000_hw *, u32, u32);
478 void (*config_collision_dist)(struct e1000_hw *);
479 int (*rar_set)(struct e1000_hw *, u8 *, u32);
480 s32 (*read_mac_addr)(struct e1000_hw *);
481 u32 (*rar_get_count)(struct e1000_hw *);
484 /* When to use various PHY register access functions:
487 * Function Does Does When to use
488 * ~~~~~~~~~~~~ ~~~~~ ~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
489 * X_reg L,P,A n/a for simple PHY reg accesses
490 * X_reg_locked P,A L for multiple accesses of different regs
492 * X_reg_page A L,P for multiple accesses of different regs
495 * Where X=[read|write], L=locking, P=sets page, A=register access
498 struct e1000_phy_operations {
499 s32 (*acquire)(struct e1000_hw *);
500 s32 (*cfg_on_link_up)(struct e1000_hw *);
501 s32 (*check_polarity)(struct e1000_hw *);
502 s32 (*check_reset_block)(struct e1000_hw *);
503 s32 (*commit)(struct e1000_hw *);
504 s32 (*force_speed_duplex)(struct e1000_hw *);
505 s32 (*get_cfg_done)(struct e1000_hw *hw);
506 s32 (*get_cable_length)(struct e1000_hw *);
507 s32 (*get_info)(struct e1000_hw *);
508 s32 (*set_page)(struct e1000_hw *, u16);
509 s32 (*read_reg)(struct e1000_hw *, u32, u16 *);
510 s32 (*read_reg_locked)(struct e1000_hw *, u32, u16 *);
511 s32 (*read_reg_page)(struct e1000_hw *, u32, u16 *);
512 void (*release)(struct e1000_hw *);
513 s32 (*reset)(struct e1000_hw *);
514 s32 (*set_d0_lplu_state)(struct e1000_hw *, bool);
515 s32 (*set_d3_lplu_state)(struct e1000_hw *, bool);
516 s32 (*write_reg)(struct e1000_hw *, u32, u16);
517 s32 (*write_reg_locked)(struct e1000_hw *, u32, u16);
518 s32 (*write_reg_page)(struct e1000_hw *, u32, u16);
519 void (*power_up)(struct e1000_hw *);
520 void (*power_down)(struct e1000_hw *);
523 /* Function pointers for the NVM. */
524 struct e1000_nvm_operations {
525 s32 (*acquire)(struct e1000_hw *);
526 s32 (*read)(struct e1000_hw *, u16, u16, u16 *);
527 void (*release)(struct e1000_hw *);
528 void (*reload)(struct e1000_hw *);
529 s32 (*update)(struct e1000_hw *);
530 s32 (*valid_led_default)(struct e1000_hw *, u16 *);
531 s32 (*validate)(struct e1000_hw *);
532 s32 (*write)(struct e1000_hw *, u16, u16, u16 *);
535 struct e1000_mac_info {
536 struct e1000_mac_operations ops;
538 u8 perm_addr[ETH_ALEN];
540 enum e1000_mac_type type;
557 /* Maximum size of the MTA register table in all supported adapters */
558 #define MAX_MTA_REG 128
559 u32 mta_shadow[MAX_MTA_REG];
562 u8 forced_speed_duplex;
566 bool arc_subsystem_valid;
569 bool get_link_status;
571 bool serdes_has_link;
572 bool tx_pkt_filtering;
573 enum e1000_serdes_link_state serdes_link_state;
576 struct e1000_phy_info {
577 struct e1000_phy_operations ops;
579 enum e1000_phy_type type;
581 enum e1000_1000t_rx_status local_rx;
582 enum e1000_1000t_rx_status remote_rx;
583 enum e1000_ms_type ms_type;
584 enum e1000_ms_type original_ms_type;
585 enum e1000_rev_polarity cable_polarity;
586 enum e1000_smart_speed smart_speed;
590 u32 reset_delay_us; /* in usec */
593 enum e1000_media_type media_type;
595 u16 autoneg_advertised;
598 u16 max_cable_length;
599 u16 min_cable_length;
603 bool disable_polarity_correction;
605 bool polarity_correction;
606 bool speed_downgraded;
607 bool autoneg_wait_to_complete;
610 struct e1000_nvm_info {
611 struct e1000_nvm_operations ops;
613 enum e1000_nvm_type type;
614 enum e1000_nvm_override override;
626 struct e1000_bus_info {
627 enum e1000_bus_width width;
632 struct e1000_fc_info {
633 u32 high_water; /* Flow control high-water mark */
634 u32 low_water; /* Flow control low-water mark */
635 u16 pause_time; /* Flow control pause timer */
636 u16 refresh_time; /* Flow control refresh timer */
637 bool send_xon; /* Flow control send XON */
638 bool strict_ieee; /* Strict IEEE mode */
639 enum e1000_fc_mode current_mode; /* FC mode in effect */
640 enum e1000_fc_mode requested_mode; /* FC mode requested by caller */
643 struct e1000_dev_spec_82571 {
648 struct e1000_dev_spec_80003es2lan {
652 struct e1000_shadow_ram {
657 #define E1000_ICH8_SHADOW_RAM_WORDS 2048
659 /* I218 PHY Ultra Low Power (ULP) states */
660 enum e1000_ulp_state {
661 e1000_ulp_state_unknown,
666 struct e1000_dev_spec_ich8lan {
667 bool kmrn_lock_loss_workaround_enabled;
668 struct e1000_shadow_ram shadow_ram[E1000_ICH8_SHADOW_RAM_WORDS];
672 enum e1000_ulp_state ulp_state;
676 struct e1000_adapter *adapter;
678 void __iomem *hw_addr;
679 void __iomem *flash_address;
681 struct e1000_mac_info mac;
682 struct e1000_fc_info fc;
683 struct e1000_phy_info phy;
684 struct e1000_nvm_info nvm;
685 struct e1000_bus_info bus;
686 struct e1000_host_mng_dhcp_cookie mng_cookie;
689 struct e1000_dev_spec_82571 e82571;
690 struct e1000_dev_spec_80003es2lan e80003es2lan;
691 struct e1000_dev_spec_ich8lan ich8lan;
696 #include "80003es2lan.h"