1 /*******************************************************************************
3 Intel PRO/1000 Linux driver
4 Copyright(c) 1999 - 2008 Intel Corporation.
6 This program is free software; you can redistribute it and/or modify it
7 under the terms and conditions of the GNU General Public License,
8 version 2, as published by the Free Software Foundation.
10 This program is distributed in the hope it will be useful, but WITHOUT
11 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 You should have received a copy of the GNU General Public License along with
16 this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
19 The full GNU General Public License is included in this distribution in
20 the file called "COPYING".
23 Linux NICS <linux.nics@intel.com>
24 e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
25 Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
27 *******************************************************************************/
29 FILE_LICENCE ( GPL2_OR_LATER
);
34 #include "e1000_osdep.h"
35 #include "e1000_regs.h"
36 #include "e1000_defines.h"
40 #define E1000_DEV_ID_82542 0x1000
41 #define E1000_DEV_ID_82543GC_FIBER 0x1001
42 #define E1000_DEV_ID_82543GC_COPPER 0x1004
43 #define E1000_DEV_ID_82544EI_COPPER 0x1008
44 #define E1000_DEV_ID_82544EI_FIBER 0x1009
45 #define E1000_DEV_ID_82544GC_COPPER 0x100C
46 #define E1000_DEV_ID_82544GC_LOM 0x100D
47 #define E1000_DEV_ID_82540EM 0x100E
48 #define E1000_DEV_ID_82540EM_LOM 0x1015
49 #define E1000_DEV_ID_82540EP_LOM 0x1016
50 #define E1000_DEV_ID_82540EP 0x1017
51 #define E1000_DEV_ID_82540EP_LP 0x101E
52 #define E1000_DEV_ID_82545EM_COPPER 0x100F
53 #define E1000_DEV_ID_82545EM_FIBER 0x1011
54 #define E1000_DEV_ID_82545GM_COPPER 0x1026
55 #define E1000_DEV_ID_82545GM_FIBER 0x1027
56 #define E1000_DEV_ID_82545GM_SERDES 0x1028
57 #define E1000_DEV_ID_82546EB_COPPER 0x1010
58 #define E1000_DEV_ID_82546EB_FIBER 0x1012
59 #define E1000_DEV_ID_82546EB_QUAD_COPPER 0x101D
60 #define E1000_DEV_ID_82546GB_COPPER 0x1079
61 #define E1000_DEV_ID_82546GB_FIBER 0x107A
62 #define E1000_DEV_ID_82546GB_SERDES 0x107B
63 #define E1000_DEV_ID_82546GB_PCIE 0x108A
64 #define E1000_DEV_ID_82546GB_QUAD_COPPER 0x1099
65 #define E1000_DEV_ID_82546GB_QUAD_COPPER_KSP3 0x10B5
66 #define E1000_DEV_ID_82541EI 0x1013
67 #define E1000_DEV_ID_82541EI_MOBILE 0x1018
68 #define E1000_DEV_ID_82541ER_LOM 0x1014
69 #define E1000_DEV_ID_82541ER 0x1078
70 #define E1000_DEV_ID_82541GI 0x1076
71 #define E1000_DEV_ID_82541GI_LF 0x107C
72 #define E1000_DEV_ID_82541GI_MOBILE 0x1077
73 #define E1000_DEV_ID_82547EI 0x1019
74 #define E1000_DEV_ID_82547EI_MOBILE 0x101A
75 #define E1000_DEV_ID_82547GI 0x1075
76 #define E1000_REVISION_0 0
77 #define E1000_REVISION_1 1
78 #define E1000_REVISION_2 2
79 #define E1000_REVISION_3 3
80 #define E1000_REVISION_4 4
82 #define E1000_FUNC_0 0
83 #define E1000_FUNC_1 1
85 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN0 0
86 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN1 3
102 e1000_num_macs
/* List is 1-based, so subtract 1 for true count. */
105 enum e1000_media_type
{
106 e1000_media_type_unknown
= 0,
107 e1000_media_type_copper
= 1,
108 e1000_media_type_fiber
= 2,
109 e1000_media_type_internal_serdes
= 3,
110 e1000_num_media_types
113 enum e1000_nvm_type
{
114 e1000_nvm_unknown
= 0,
116 e1000_nvm_eeprom_spi
,
117 e1000_nvm_eeprom_microwire
,
122 enum e1000_nvm_override
{
123 e1000_nvm_override_none
= 0,
124 e1000_nvm_override_spi_small
,
125 e1000_nvm_override_spi_large
,
126 e1000_nvm_override_microwire_small
,
127 e1000_nvm_override_microwire_large
130 enum e1000_phy_type
{
131 e1000_phy_unknown
= 0,
141 enum e1000_bus_type
{
142 e1000_bus_type_unknown
= 0,
145 e1000_bus_type_pci_express
,
146 e1000_bus_type_reserved
149 enum e1000_bus_speed
{
150 e1000_bus_speed_unknown
= 0,
156 e1000_bus_speed_2500
,
157 e1000_bus_speed_5000
,
158 e1000_bus_speed_reserved
161 enum e1000_bus_width
{
162 e1000_bus_width_unknown
= 0,
163 e1000_bus_width_pcie_x1
,
164 e1000_bus_width_pcie_x2
,
165 e1000_bus_width_pcie_x4
= 4,
166 e1000_bus_width_pcie_x8
= 8,
169 e1000_bus_width_reserved
172 enum e1000_1000t_rx_status
{
173 e1000_1000t_rx_status_not_ok
= 0,
174 e1000_1000t_rx_status_ok
,
175 e1000_1000t_rx_status_undefined
= 0xFF
178 enum e1000_rev_polarity
{
179 e1000_rev_polarity_normal
= 0,
180 e1000_rev_polarity_reversed
,
181 e1000_rev_polarity_undefined
= 0xFF
189 e1000_fc_default
= 0xFF
192 enum e1000_ffe_config
{
193 e1000_ffe_config_enabled
= 0,
194 e1000_ffe_config_active
,
195 e1000_ffe_config_blocked
198 enum e1000_dsp_config
{
199 e1000_dsp_config_disabled
= 0,
200 e1000_dsp_config_enabled
,
201 e1000_dsp_config_activated
,
202 e1000_dsp_config_undefined
= 0xFF
206 e1000_ms_hw_default
= 0,
207 e1000_ms_force_master
,
208 e1000_ms_force_slave
,
212 enum e1000_smart_speed
{
213 e1000_smart_speed_default
= 0,
214 e1000_smart_speed_on
,
215 e1000_smart_speed_off
218 enum e1000_serdes_link_state
{
219 e1000_serdes_link_down
= 0,
220 e1000_serdes_link_autoneg_progress
,
221 e1000_serdes_link_autoneg_complete
,
222 e1000_serdes_link_forced_up
225 /* Receive Descriptor */
226 struct e1000_rx_desc
{
227 __le64 buffer_addr
; /* Address of the descriptor's data buffer */
228 __le16 length
; /* Length of data DMAed into data buffer */
229 __le16 csum
; /* Packet checksum */
230 u8 status
; /* Descriptor status */
231 u8 errors
; /* Descriptor Errors */
235 /* Receive Descriptor - Extended */
236 union e1000_rx_desc_extended
{
243 __le32 mrq
; /* Multiple Rx Queues */
245 __le32 rss
; /* RSS Hash */
247 __le16 ip_id
; /* IP id */
248 __le16 csum
; /* Packet Checksum */
253 __le32 status_error
; /* ext status/error */
255 __le16 vlan
; /* VLAN tag */
257 } wb
; /* writeback */
260 #define MAX_PS_BUFFERS 4
261 /* Receive Descriptor - Packet Split */
262 union e1000_rx_desc_packet_split
{
264 /* one buffer for protocol header(s), three data buffers */
265 __le64 buffer_addr
[MAX_PS_BUFFERS
];
269 __le32 mrq
; /* Multiple Rx Queues */
271 __le32 rss
; /* RSS Hash */
273 __le16 ip_id
; /* IP id */
274 __le16 csum
; /* Packet Checksum */
279 __le32 status_error
; /* ext status/error */
280 __le16 length0
; /* length of buffer 0 */
281 __le16 vlan
; /* VLAN tag */
284 __le16 header_status
;
285 __le16 length
[3]; /* length of buffers 1-3 */
288 } wb
; /* writeback */
291 /* Transmit Descriptor */
292 struct e1000_tx_desc
{
293 __le64 buffer_addr
; /* Address of the descriptor's data buffer */
297 __le16 length
; /* Data buffer length */
298 u8 cso
; /* Checksum offset */
299 u8 cmd
; /* Descriptor control */
305 u8 status
; /* Descriptor status */
306 u8 css
; /* Checksum start */
312 /* Offload Context Descriptor */
313 struct e1000_context_desc
{
317 u8 ipcss
; /* IP checksum start */
318 u8 ipcso
; /* IP checksum offset */
319 __le16 ipcse
; /* IP checksum end */
325 u8 tucss
; /* TCP checksum start */
326 u8 tucso
; /* TCP checksum offset */
327 __le16 tucse
; /* TCP checksum end */
330 __le32 cmd_and_length
;
334 u8 status
; /* Descriptor status */
335 u8 hdr_len
; /* Header length */
336 __le16 mss
; /* Maximum segment size */
341 /* Offload data descriptor */
342 struct e1000_data_desc
{
343 __le64 buffer_addr
; /* Address of the descriptor's buffer address */
347 __le16 length
; /* Data buffer length */
355 u8 status
; /* Descriptor status */
356 u8 popts
; /* Packet Options */
362 /* Statistics counters collected by the MAC */
363 struct e1000_hw_stats
{
443 struct e1000_phy_stats
{
448 struct e1000_host_mng_dhcp_cookie
{
459 /* Host Interface "Rev 1" */
460 struct e1000_host_command_header
{
467 #define E1000_HI_MAX_DATA_LENGTH 252
468 struct e1000_host_command_info
{
469 struct e1000_host_command_header command_header
;
470 u8 command_data
[E1000_HI_MAX_DATA_LENGTH
];
473 /* Host Interface "Rev 2" */
474 struct e1000_host_mng_command_header
{
482 #define E1000_HI_MAX_MNG_DATA_LENGTH 0x6F8
483 struct e1000_host_mng_command_info
{
484 struct e1000_host_mng_command_header command_header
;
485 u8 command_data
[E1000_HI_MAX_MNG_DATA_LENGTH
];
488 #include "e1000_mac.h"
489 #include "e1000_phy.h"
490 #include "e1000_nvm.h"
491 #include "e1000_manage.h"
493 struct e1000_mac_operations
{
494 /* Function pointers for the MAC. */
495 s32 (*init_params
)(struct e1000_hw
*);
496 s32 (*id_led_init
)(struct e1000_hw
*);
497 s32 (*blink_led
)(struct e1000_hw
*);
498 s32 (*check_for_link
)(struct e1000_hw
*);
499 bool (*check_mng_mode
)(struct e1000_hw
*hw
);
500 s32 (*cleanup_led
)(struct e1000_hw
*);
501 void (*clear_hw_cntrs
)(struct e1000_hw
*);
502 void (*clear_vfta
)(struct e1000_hw
*);
503 s32 (*get_bus_info
)(struct e1000_hw
*);
504 void (*set_lan_id
)(struct e1000_hw
*);
505 s32 (*get_link_up_info
)(struct e1000_hw
*, u16
*, u16
*);
506 s32 (*led_on
)(struct e1000_hw
*);
507 s32 (*led_off
)(struct e1000_hw
*);
508 void (*update_mc_addr_list
)(struct e1000_hw
*, u8
*, u32
);
509 s32 (*reset_hw
)(struct e1000_hw
*);
510 s32 (*init_hw
)(struct e1000_hw
*);
511 s32 (*setup_link
)(struct e1000_hw
*);
512 s32 (*setup_physical_interface
)(struct e1000_hw
*);
513 s32 (*setup_led
)(struct e1000_hw
*);
514 void (*write_vfta
)(struct e1000_hw
*, u32
, u32
);
515 void (*mta_set
)(struct e1000_hw
*, u32
);
516 void (*config_collision_dist
)(struct e1000_hw
*);
517 void (*rar_set
)(struct e1000_hw
*, u8
*, u32
);
518 s32 (*read_mac_addr
)(struct e1000_hw
*);
519 s32 (*validate_mdi_setting
)(struct e1000_hw
*);
520 s32 (*mng_host_if_write
)(struct e1000_hw
*, u8
*, u16
, u16
, u8
*);
521 s32 (*mng_write_cmd_header
)(struct e1000_hw
*hw
,
522 struct e1000_host_mng_command_header
*);
523 s32 (*mng_enable_host_if
)(struct e1000_hw
*);
524 s32 (*wait_autoneg
)(struct e1000_hw
*);
527 struct e1000_phy_operations
{
528 s32 (*init_params
)(struct e1000_hw
*);
529 s32 (*acquire
)(struct e1000_hw
*);
530 s32 (*check_polarity
)(struct e1000_hw
*);
531 s32 (*check_reset_block
)(struct e1000_hw
*);
532 s32 (*commit
)(struct e1000_hw
*);
534 s32 (*force_speed_duplex
)(struct e1000_hw
*);
536 s32 (*get_cfg_done
)(struct e1000_hw
*hw
);
538 s32 (*get_cable_length
)(struct e1000_hw
*);
540 s32 (*get_info
)(struct e1000_hw
*);
541 s32 (*read_reg
)(struct e1000_hw
*, u32
, u16
*);
542 void (*release
)(struct e1000_hw
*);
543 s32 (*reset
)(struct e1000_hw
*);
544 s32 (*set_d0_lplu_state
)(struct e1000_hw
*, bool);
545 s32 (*set_d3_lplu_state
)(struct e1000_hw
*, bool);
546 s32 (*write_reg
)(struct e1000_hw
*, u32
, u16
);
547 void (*power_up
)(struct e1000_hw
*);
548 void (*power_down
)(struct e1000_hw
*);
551 struct e1000_nvm_operations
{
552 s32 (*init_params
)(struct e1000_hw
*);
553 s32 (*acquire
)(struct e1000_hw
*);
554 s32 (*read
)(struct e1000_hw
*, u16
, u16
, u16
*);
555 void (*release
)(struct e1000_hw
*);
556 void (*reload
)(struct e1000_hw
*);
557 s32 (*update
)(struct e1000_hw
*);
558 s32 (*valid_led_default
)(struct e1000_hw
*, u16
*);
559 s32 (*validate
)(struct e1000_hw
*);
560 s32 (*write
)(struct e1000_hw
*, u16
, u16
, u16
*);
563 struct e1000_mac_info
{
564 struct e1000_mac_operations ops
;
568 enum e1000_mac_type type
;
585 /* Maximum size of the MTA register table in all supported adapters */
586 #define MAX_MTA_REG 128
587 u32 mta_shadow
[MAX_MTA_REG
];
590 u8 forced_speed_duplex
;
593 bool arc_subsystem_valid
;
594 bool asf_firmware_present
;
597 bool get_link_status
;
599 bool report_tx_early
;
600 enum e1000_serdes_link_state serdes_link_state
;
601 bool serdes_has_link
;
602 bool tx_pkt_filtering
;
605 struct e1000_phy_info
{
606 struct e1000_phy_operations ops
;
607 enum e1000_phy_type type
;
609 enum e1000_1000t_rx_status local_rx
;
610 enum e1000_1000t_rx_status remote_rx
;
611 enum e1000_ms_type ms_type
;
612 enum e1000_ms_type original_ms_type
;
613 enum e1000_rev_polarity cable_polarity
;
614 enum e1000_smart_speed smart_speed
;
618 u32 reset_delay_us
; /* in usec */
621 enum e1000_media_type media_type
;
623 u16 autoneg_advertised
;
626 u16 max_cable_length
;
627 u16 min_cable_length
;
631 bool disable_polarity_correction
;
633 bool polarity_correction
;
635 bool speed_downgraded
;
636 bool autoneg_wait_to_complete
;
639 struct e1000_nvm_info
{
640 struct e1000_nvm_operations ops
;
641 enum e1000_nvm_type type
;
642 enum e1000_nvm_override override
;
654 struct e1000_bus_info
{
655 enum e1000_bus_type type
;
656 enum e1000_bus_speed speed
;
657 enum e1000_bus_width width
;
663 struct e1000_fc_info
{
664 u32 high_water
; /* Flow control high-water mark */
665 u32 low_water
; /* Flow control low-water mark */
666 u16 pause_time
; /* Flow control pause timer */
667 bool send_xon
; /* Flow control send XON */
668 bool strict_ieee
; /* Strict IEEE mode */
669 enum e1000_fc_mode current_mode
; /* FC mode in effect */
670 enum e1000_fc_mode requested_mode
; /* FC mode requested by caller */
673 struct e1000_dev_spec_82541
{
674 enum e1000_dsp_config dsp_config
;
675 enum e1000_ffe_config ffe_config
;
677 bool phy_init_script
;
680 struct e1000_dev_spec_82542
{
684 struct e1000_dev_spec_82543
{
685 u32 tbi_compatibility
;
687 bool init_phy_disabled
;
694 u8 __iomem
*flash_address
;
695 unsigned long io_base
;
697 struct e1000_mac_info mac
;
698 struct e1000_fc_info fc
;
699 struct e1000_phy_info phy
;
700 struct e1000_nvm_info nvm
;
701 struct e1000_bus_info bus
;
702 struct e1000_host_mng_dhcp_cookie mng_cookie
;
705 struct e1000_dev_spec_82541 _82541
;
706 struct e1000_dev_spec_82542 _82542
;
707 struct e1000_dev_spec_82543 _82543
;
711 u16 subsystem_vendor_id
;
712 u16 subsystem_device_id
;
718 #include "e1000_82541.h"
719 #include "e1000_82543.h"
721 /* These functions must be implemented by drivers */
722 void e1000_pci_clear_mwi(struct e1000_hw
*hw
);
723 void e1000_pci_set_mwi(struct e1000_hw
*hw
);
724 s32
e1000_read_pcie_cap_reg(struct e1000_hw
*hw
, u32 reg
, u16
*value
);
725 void e1000_read_pci_cfg(struct e1000_hw
*hw
, u32 reg
, u16
*value
);
726 void e1000_write_pci_cfg(struct e1000_hw
*hw
, u32 reg
, u16
*value
);