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 *******************************************************************************/
32 #include "e1000_osdep.h"
33 #include "e1000_regs.h"
34 #include "e1000_defines.h"
38 #define E1000_DEV_ID_82542 0x1000
39 #define E1000_DEV_ID_82543GC_FIBER 0x1001
40 #define E1000_DEV_ID_82543GC_COPPER 0x1004
41 #define E1000_DEV_ID_82544EI_COPPER 0x1008
42 #define E1000_DEV_ID_82544EI_FIBER 0x1009
43 #define E1000_DEV_ID_82544GC_COPPER 0x100C
44 #define E1000_DEV_ID_82544GC_LOM 0x100D
45 #define E1000_DEV_ID_82540EM 0x100E
46 #define E1000_DEV_ID_82540EM_LOM 0x1015
47 #define E1000_DEV_ID_82540EP_LOM 0x1016
48 #define E1000_DEV_ID_82540EP 0x1017
49 #define E1000_DEV_ID_82540EP_LP 0x101E
50 #define E1000_DEV_ID_82545EM_COPPER 0x100F
51 #define E1000_DEV_ID_82545EM_FIBER 0x1011
52 #define E1000_DEV_ID_82545GM_COPPER 0x1026
53 #define E1000_DEV_ID_82545GM_FIBER 0x1027
54 #define E1000_DEV_ID_82545GM_SERDES 0x1028
55 #define E1000_DEV_ID_82546EB_COPPER 0x1010
56 #define E1000_DEV_ID_82546EB_FIBER 0x1012
57 #define E1000_DEV_ID_82546EB_QUAD_COPPER 0x101D
58 #define E1000_DEV_ID_82546GB_COPPER 0x1079
59 #define E1000_DEV_ID_82546GB_FIBER 0x107A
60 #define E1000_DEV_ID_82546GB_SERDES 0x107B
61 #define E1000_DEV_ID_82546GB_PCIE 0x108A
62 #define E1000_DEV_ID_82546GB_QUAD_COPPER 0x1099
63 #define E1000_DEV_ID_82546GB_QUAD_COPPER_KSP3 0x10B5
64 #define E1000_DEV_ID_82541EI 0x1013
65 #define E1000_DEV_ID_82541EI_MOBILE 0x1018
66 #define E1000_DEV_ID_82541ER_LOM 0x1014
67 #define E1000_DEV_ID_82541ER 0x1078
68 #define E1000_DEV_ID_82541GI 0x1076
69 #define E1000_DEV_ID_82541GI_LF 0x107C
70 #define E1000_DEV_ID_82541GI_MOBILE 0x1077
71 #define E1000_DEV_ID_82547EI 0x1019
72 #define E1000_DEV_ID_82547EI_MOBILE 0x101A
73 #define E1000_DEV_ID_82547GI 0x1075
75 #define E1000_REVISION_0 0
76 #define E1000_REVISION_1 1
77 #define E1000_REVISION_2 2
78 #define E1000_REVISION_3 3
79 #define E1000_REVISION_4 4
81 #define E1000_FUNC_0 0
82 #define E1000_FUNC_1 1
98 e1000_num_macs
/* List is 1-based, so subtract 1 for true count. */
102 e1000_media_type_unknown
= 0,
103 e1000_media_type_copper
= 1,
104 e1000_media_type_fiber
= 2,
105 e1000_media_type_internal_serdes
= 3,
106 e1000_num_media_types
110 e1000_nvm_unknown
= 0,
112 e1000_nvm_eeprom_spi
,
113 e1000_nvm_eeprom_microwire
,
119 e1000_nvm_override_none
= 0,
120 e1000_nvm_override_spi_small
,
121 e1000_nvm_override_spi_large
,
122 e1000_nvm_override_microwire_small
,
123 e1000_nvm_override_microwire_large
124 } e1000_nvm_override
;
127 e1000_phy_unknown
= 0,
138 e1000_bus_type_unknown
= 0,
141 e1000_bus_type_pci_express
,
142 e1000_bus_type_reserved
146 e1000_bus_speed_unknown
= 0,
152 e1000_bus_speed_2500
,
153 e1000_bus_speed_5000
,
154 e1000_bus_speed_reserved
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
169 e1000_1000t_rx_status_not_ok
= 0,
170 e1000_1000t_rx_status_ok
,
171 e1000_1000t_rx_status_undefined
= 0xFF
172 } e1000_1000t_rx_status
;
175 e1000_rev_polarity_normal
= 0,
176 e1000_rev_polarity_reversed
,
177 e1000_rev_polarity_undefined
= 0xFF
178 } e1000_rev_polarity
;
185 e1000_fc_default
= 0xFF
189 e1000_ffe_config_enabled
= 0,
190 e1000_ffe_config_active
,
191 e1000_ffe_config_blocked
195 e1000_dsp_config_disabled
= 0,
196 e1000_dsp_config_enabled
,
197 e1000_dsp_config_activated
,
198 e1000_dsp_config_undefined
= 0xFF
201 /* Receive Descriptor */
202 struct e1000_rx_desc
{
203 u64 buffer_addr
; /* Address of the descriptor's data buffer */
204 u16 length
; /* Length of data DMAed into data buffer */
205 u16 csum
; /* Packet checksum */
206 u8 status
; /* Descriptor status */
207 u8 errors
; /* Descriptor Errors */
211 /* Receive Descriptor - Extended */
212 union e1000_rx_desc_extended
{
219 u32 mrq
; /* Multiple Rx Queues */
221 u32 rss
; /* RSS Hash */
223 u16 ip_id
; /* IP id */
224 u16 csum
; /* Packet Checksum */
229 u32 status_error
; /* ext status/error */
231 u16 vlan
; /* VLAN tag */
233 } wb
; /* writeback */
236 #define MAX_PS_BUFFERS 4
237 /* Receive Descriptor - Packet Split */
238 union e1000_rx_desc_packet_split
{
240 /* one buffer for protocol header(s), three data buffers */
241 u64 buffer_addr
[MAX_PS_BUFFERS
];
245 u32 mrq
; /* Multiple Rx Queues */
247 u32 rss
; /* RSS Hash */
249 u16 ip_id
; /* IP id */
250 u16 csum
; /* Packet Checksum */
255 u32 status_error
; /* ext status/error */
256 u16 length0
; /* length of buffer 0 */
257 u16 vlan
; /* VLAN tag */
261 u16 length
[3]; /* length of buffers 1-3 */
264 } wb
; /* writeback */
267 /* Transmit Descriptor */
268 struct e1000_tx_desc
{
269 u64 buffer_addr
; /* Address of the descriptor's data buffer */
273 u16 length
; /* Data buffer length */
274 u8 cso
; /* Checksum offset */
275 u8 cmd
; /* Descriptor control */
281 u8 status
; /* Descriptor status */
282 u8 css
; /* Checksum start */
288 /* Offload Context Descriptor */
289 struct e1000_context_desc
{
293 u8 ipcss
; /* IP checksum start */
294 u8 ipcso
; /* IP checksum offset */
295 u16 ipcse
; /* IP checksum end */
301 u8 tucss
; /* TCP checksum start */
302 u8 tucso
; /* TCP checksum offset */
303 u16 tucse
; /* TCP checksum end */
310 u8 status
; /* Descriptor status */
311 u8 hdr_len
; /* Header length */
312 u16 mss
; /* Maximum segment size */
317 /* Offload data descriptor */
318 struct e1000_data_desc
{
319 u64 buffer_addr
; /* Address of the descriptor's buffer address */
323 u16 length
; /* Data buffer length */
331 u8 status
; /* Descriptor status */
332 u8 popts
; /* Packet Options */
338 /* Statistics counters collected by the MAC */
339 struct e1000_hw_stats
{
417 struct e1000_phy_stats
{
422 struct e1000_host_mng_dhcp_cookie
{
433 /* Host Interface "Rev 1" */
434 struct e1000_host_command_header
{
441 #define E1000_HI_MAX_DATA_LENGTH 252
442 struct e1000_host_command_info
{
443 struct e1000_host_command_header command_header
;
444 u8 command_data
[E1000_HI_MAX_DATA_LENGTH
];
447 /* Host Interface "Rev 2" */
448 struct e1000_host_mng_command_header
{
456 #define E1000_HI_MAX_MNG_DATA_LENGTH 0x6F8
457 struct e1000_host_mng_command_info
{
458 struct e1000_host_mng_command_header command_header
;
459 u8 command_data
[E1000_HI_MAX_MNG_DATA_LENGTH
];
462 #include "e1000_mac.h"
463 #include "e1000_phy.h"
464 #include "e1000_nvm.h"
465 #include "e1000_manage.h"
467 struct e1000_mac_operations
{
468 /* Function pointers for the MAC. */
469 s32 (*init_params
)(struct e1000_hw
*);
470 s32 (*blink_led
)(struct e1000_hw
*);
471 s32 (*check_for_link
)(struct e1000_hw
*);
472 bool (*check_mng_mode
)(struct e1000_hw
*hw
);
473 s32 (*cleanup_led
)(struct e1000_hw
*);
474 void (*clear_hw_cntrs
)(struct e1000_hw
*);
475 void (*clear_vfta
)(struct e1000_hw
*);
476 s32 (*get_bus_info
)(struct e1000_hw
*);
477 s32 (*get_link_up_info
)(struct e1000_hw
*, u16
*, u16
*);
478 s32 (*led_on
)(struct e1000_hw
*);
479 s32 (*led_off
)(struct e1000_hw
*);
480 void (*update_mc_addr_list
)(struct e1000_hw
*, u8
*, u32
, u32
,
482 void (*remove_device
)(struct e1000_hw
*);
483 s32 (*reset_hw
)(struct e1000_hw
*);
484 s32 (*init_hw
)(struct e1000_hw
*);
485 s32 (*setup_link
)(struct e1000_hw
*);
486 s32 (*setup_physical_interface
)(struct e1000_hw
*);
487 s32 (*setup_led
)(struct e1000_hw
*);
488 void (*write_vfta
)(struct e1000_hw
*, u32
, u32
);
489 void (*mta_set
)(struct e1000_hw
*, u32
);
490 void (*config_collision_dist
)(struct e1000_hw
*);
491 void (*rar_set
)(struct e1000_hw
*, u8
*, u32
);
492 s32 (*read_mac_addr
)(struct e1000_hw
*);
493 s32 (*validate_mdi_setting
)(struct e1000_hw
*);
494 s32 (*mng_host_if_write
)(struct e1000_hw
*, u8
*, u16
, u16
, u8
*);
495 s32 (*mng_write_cmd_header
)(struct e1000_hw
*hw
,
496 struct e1000_host_mng_command_header
*);
497 s32 (*mng_enable_host_if
)(struct e1000_hw
*);
498 s32 (*wait_autoneg
)(struct e1000_hw
*);
501 struct e1000_phy_operations
{
502 s32 (*init_params
)(struct e1000_hw
*);
503 s32 (*acquire
)(struct e1000_hw
*);
504 s32 (*check_polarity
)(struct e1000_hw
*);
505 s32 (*check_reset_block
)(struct e1000_hw
*);
506 s32 (*commit
)(struct e1000_hw
*);
507 s32 (*force_speed_duplex
)(struct e1000_hw
*);
508 s32 (*get_cfg_done
)(struct e1000_hw
*hw
);
509 s32 (*get_cable_length
)(struct e1000_hw
*);
510 s32 (*get_info
)(struct e1000_hw
*);
511 s32 (*read_reg
)(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 void (*power_up
)(struct e1000_hw
*);
518 void (*power_down
)(struct e1000_hw
*);
521 struct e1000_nvm_operations
{
522 s32 (*init_params
)(struct e1000_hw
*);
523 s32 (*acquire
)(struct e1000_hw
*);
524 s32 (*read
)(struct e1000_hw
*, u16
, u16
, u16
*);
525 void (*release
)(struct e1000_hw
*);
526 void (*reload
)(struct e1000_hw
*);
527 s32 (*update
)(struct e1000_hw
*);
528 s32 (*valid_led_default
)(struct e1000_hw
*, u16
*);
529 s32 (*validate
)(struct e1000_hw
*);
530 s32 (*write
)(struct e1000_hw
*, u16
, u16
, u16
*);
533 struct e1000_mac_info
{
534 struct e1000_mac_operations ops
;
556 u8 forced_speed_duplex
;
559 bool arc_subsystem_valid
;
560 bool asf_firmware_present
;
564 bool disable_hw_init_bits
;
565 bool get_link_status
;
566 bool ifs_params_forced
;
568 bool report_tx_early
;
569 bool serdes_has_link
;
570 bool tx_pkt_filtering
;
573 struct e1000_phy_info
{
574 struct e1000_phy_operations ops
;
577 e1000_1000t_rx_status local_rx
;
578 e1000_1000t_rx_status remote_rx
;
579 e1000_ms_type ms_type
;
580 e1000_ms_type original_ms_type
;
581 e1000_rev_polarity cable_polarity
;
582 e1000_smart_speed smart_speed
;
586 u32 reset_delay_us
; /* in usec */
589 e1000_media_type media_type
;
591 u16 autoneg_advertised
;
594 u16 max_cable_length
;
595 u16 min_cable_length
;
599 bool disable_polarity_correction
;
601 bool polarity_correction
;
603 bool speed_downgraded
;
604 bool autoneg_wait_to_complete
;
607 struct e1000_nvm_info
{
608 struct e1000_nvm_operations ops
;
610 e1000_nvm_override override
;
622 struct e1000_bus_info
{
624 e1000_bus_speed speed
;
625 e1000_bus_width width
;
633 struct e1000_fc_info
{
634 u32 high_water
; /* Flow control high-water mark */
635 u32 low_water
; /* Flow control low-water mark */
636 u16 pause_time
; /* Flow control pause timer */
637 bool send_xon
; /* Flow control send XON */
638 bool strict_ieee
; /* Strict IEEE mode */
639 e1000_fc_type type
; /* Type of flow control */
640 e1000_fc_type original_type
;
648 u8 __iomem
*flash_address
;
649 unsigned long io_base
;
651 struct e1000_mac_info mac
;
652 struct e1000_fc_info fc
;
653 struct e1000_phy_info phy
;
654 struct e1000_nvm_info nvm
;
655 struct e1000_bus_info bus
;
656 struct e1000_host_mng_dhcp_cookie mng_cookie
;
661 u16 subsystem_vendor_id
;
662 u16 subsystem_device_id
;
668 /* These functions must be implemented by drivers */
669 void e1000_pci_clear_mwi(struct e1000_hw
*hw
);
670 void e1000_pci_set_mwi(struct e1000_hw
*hw
);
671 s32
e1000_alloc_zeroed_dev_spec_struct(struct e1000_hw
*hw
, u32 size
);
672 s32
e1000_read_pcie_cap_reg(struct e1000_hw
*hw
, u32 reg
, u16
*value
);
673 void e1000_free_dev_spec_struct(struct e1000_hw
*hw
);
674 void e1000_read_pci_cfg(struct e1000_hw
*hw
, u32 reg
, u16
*value
);
675 void e1000_write_pci_cfg(struct e1000_hw
*hw
, u32 reg
, u16
*value
);