1 /*******************************************************************************
3 Intel(R) Gigabit Ethernet Linux driver
4 Copyright(c) 2007-2009 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 e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
24 Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
26 *******************************************************************************/
31 #include <linux/types.h>
32 #include <linux/delay.h>
35 #include "e1000_regs.h"
36 #include "e1000_defines.h"
40 #define E1000_DEV_ID_82576 0x10C9
41 #define E1000_DEV_ID_82576_FIBER 0x10E6
42 #define E1000_DEV_ID_82576_SERDES 0x10E7
43 #define E1000_DEV_ID_82576_QUAD_COPPER 0x10E8
44 #define E1000_DEV_ID_82576_NS 0x150A
45 #define E1000_DEV_ID_82576_NS_SERDES 0x1518
46 #define E1000_DEV_ID_82576_SERDES_QUAD 0x150D
47 #define E1000_DEV_ID_82575EB_COPPER 0x10A7
48 #define E1000_DEV_ID_82575EB_FIBER_SERDES 0x10A9
49 #define E1000_DEV_ID_82575GB_QUAD_COPPER 0x10D6
50 #define E1000_DEV_ID_82580_COPPER 0x150E
51 #define E1000_DEV_ID_82580_FIBER 0x150F
52 #define E1000_DEV_ID_82580_SERDES 0x1510
53 #define E1000_DEV_ID_82580_SGMII 0x1511
54 #define E1000_DEV_ID_82580_COPPER_DUAL 0x1516
56 #define E1000_REVISION_2 2
57 #define E1000_REVISION_4 4
59 #define E1000_FUNC_0 0
60 #define E1000_FUNC_1 1
61 #define E1000_FUNC_2 2
62 #define E1000_FUNC_3 3
64 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN0 0
65 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN1 3
66 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN2 6
67 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN3 9
74 e1000_num_macs /* List is 1-based, so subtract 1 for true count. */
77 enum e1000_media_type {
78 e1000_media_type_unknown = 0,
79 e1000_media_type_copper = 1,
80 e1000_media_type_internal_serdes = 2,
85 e1000_nvm_unknown = 0,
92 enum e1000_nvm_override {
93 e1000_nvm_override_none = 0,
94 e1000_nvm_override_spi_small,
95 e1000_nvm_override_spi_large,
99 e1000_phy_unknown = 0,
110 enum e1000_bus_type {
111 e1000_bus_type_unknown = 0,
114 e1000_bus_type_pci_express,
115 e1000_bus_type_reserved
118 enum e1000_bus_speed {
119 e1000_bus_speed_unknown = 0,
125 e1000_bus_speed_2500,
126 e1000_bus_speed_5000,
127 e1000_bus_speed_reserved
130 enum e1000_bus_width {
131 e1000_bus_width_unknown = 0,
132 e1000_bus_width_pcie_x1,
133 e1000_bus_width_pcie_x2,
134 e1000_bus_width_pcie_x4 = 4,
135 e1000_bus_width_pcie_x8 = 8,
138 e1000_bus_width_reserved
141 enum e1000_1000t_rx_status {
142 e1000_1000t_rx_status_not_ok = 0,
143 e1000_1000t_rx_status_ok,
144 e1000_1000t_rx_status_undefined = 0xFF
147 enum e1000_rev_polarity {
148 e1000_rev_polarity_normal = 0,
149 e1000_rev_polarity_reversed,
150 e1000_rev_polarity_undefined = 0xFF
158 e1000_fc_default = 0xFF
161 /* Statistics counters collected by the MAC */
162 struct e1000_hw_stats {
241 struct e1000_phy_stats {
246 struct e1000_host_mng_dhcp_cookie {
257 /* Host Interface "Rev 1" */
258 struct e1000_host_command_header {
265 #define E1000_HI_MAX_DATA_LENGTH 252
266 struct e1000_host_command_info {
267 struct e1000_host_command_header command_header;
268 u8 command_data[E1000_HI_MAX_DATA_LENGTH];
271 /* Host Interface "Rev 2" */
272 struct e1000_host_mng_command_header {
280 #define E1000_HI_MAX_MNG_DATA_LENGTH 0x6F8
281 struct e1000_host_mng_command_info {
282 struct e1000_host_mng_command_header command_header;
283 u8 command_data[E1000_HI_MAX_MNG_DATA_LENGTH];
286 #include "e1000_mac.h"
287 #include "e1000_phy.h"
288 #include "e1000_nvm.h"
289 #include "e1000_mbx.h"
291 struct e1000_mac_operations {
292 s32 (*check_for_link)(struct e1000_hw *);
293 s32 (*reset_hw)(struct e1000_hw *);
294 s32 (*init_hw)(struct e1000_hw *);
295 bool (*check_mng_mode)(struct e1000_hw *);
296 s32 (*setup_physical_interface)(struct e1000_hw *);
297 void (*rar_set)(struct e1000_hw *, u8 *, u32);
298 s32 (*read_mac_addr)(struct e1000_hw *);
299 s32 (*get_speed_and_duplex)(struct e1000_hw *, u16 *, u16 *);
302 struct e1000_phy_operations {
303 s32 (*acquire)(struct e1000_hw *);
304 s32 (*check_polarity)(struct e1000_hw *);
305 s32 (*check_reset_block)(struct e1000_hw *);
306 s32 (*force_speed_duplex)(struct e1000_hw *);
307 s32 (*get_cfg_done)(struct e1000_hw *hw);
308 s32 (*get_cable_length)(struct e1000_hw *);
309 s32 (*get_phy_info)(struct e1000_hw *);
310 s32 (*read_reg)(struct e1000_hw *, u32, u16 *);
311 void (*release)(struct e1000_hw *);
312 s32 (*reset)(struct e1000_hw *);
313 s32 (*set_d0_lplu_state)(struct e1000_hw *, bool);
314 s32 (*set_d3_lplu_state)(struct e1000_hw *, bool);
315 s32 (*write_reg)(struct e1000_hw *, u32, u16);
318 struct e1000_nvm_operations {
319 s32 (*acquire)(struct e1000_hw *);
320 s32 (*read)(struct e1000_hw *, u16, u16, u16 *);
321 void (*release)(struct e1000_hw *);
322 s32 (*write)(struct e1000_hw *, u16, u16, u16 *);
326 s32 (*get_invariants)(struct e1000_hw *);
327 struct e1000_mac_operations *mac_ops;
328 struct e1000_phy_operations *phy_ops;
329 struct e1000_nvm_operations *nvm_ops;
332 extern const struct e1000_info e1000_82575_info;
334 struct e1000_mac_info {
335 struct e1000_mac_operations ops;
340 enum e1000_mac_type type;
358 /* Maximum size of the MTA register table in all supported adapters */
359 #define MAX_MTA_REG 128
360 u32 mta_shadow[MAX_MTA_REG];
363 u8 forced_speed_duplex;
366 bool arc_subsystem_valid;
367 bool asf_firmware_present;
370 bool disable_hw_init_bits;
371 bool get_link_status;
372 bool ifs_params_forced;
374 bool report_tx_early;
375 bool serdes_has_link;
376 bool tx_pkt_filtering;
379 struct e1000_phy_info {
380 struct e1000_phy_operations ops;
382 enum e1000_phy_type type;
384 enum e1000_1000t_rx_status local_rx;
385 enum e1000_1000t_rx_status remote_rx;
386 enum e1000_ms_type ms_type;
387 enum e1000_ms_type original_ms_type;
388 enum e1000_rev_polarity cable_polarity;
389 enum e1000_smart_speed smart_speed;
393 u32 reset_delay_us; /* in usec */
396 enum e1000_media_type media_type;
398 u16 autoneg_advertised;
401 u16 max_cable_length;
402 u16 min_cable_length;
406 bool disable_polarity_correction;
408 bool polarity_correction;
410 bool speed_downgraded;
411 bool autoneg_wait_to_complete;
414 struct e1000_nvm_info {
415 struct e1000_nvm_operations ops;
417 enum e1000_nvm_type type;
418 enum e1000_nvm_override override;
430 struct e1000_bus_info {
431 enum e1000_bus_type type;
432 enum e1000_bus_speed speed;
433 enum e1000_bus_width width;
441 struct e1000_fc_info {
442 u32 high_water; /* Flow control high-water mark */
443 u32 low_water; /* Flow control low-water mark */
444 u16 pause_time; /* Flow control pause timer */
445 bool send_xon; /* Flow control send XON */
446 bool strict_ieee; /* Strict IEEE mode */
447 enum e1000_fc_mode current_mode; /* Type of flow control */
448 enum e1000_fc_mode requested_mode;
451 struct e1000_mbx_operations {
452 s32 (*init_params)(struct e1000_hw *hw);
453 s32 (*read)(struct e1000_hw *, u32 *, u16, u16);
454 s32 (*write)(struct e1000_hw *, u32 *, u16, u16);
455 s32 (*read_posted)(struct e1000_hw *, u32 *, u16, u16);
456 s32 (*write_posted)(struct e1000_hw *, u32 *, u16, u16);
457 s32 (*check_for_msg)(struct e1000_hw *, u16);
458 s32 (*check_for_ack)(struct e1000_hw *, u16);
459 s32 (*check_for_rst)(struct e1000_hw *, u16);
462 struct e1000_mbx_stats {
471 struct e1000_mbx_info {
472 struct e1000_mbx_operations ops;
473 struct e1000_mbx_stats stats;
479 struct e1000_dev_spec_82575 {
481 bool global_device_reset;
488 u8 __iomem *flash_address;
489 unsigned long io_base;
491 struct e1000_mac_info mac;
492 struct e1000_fc_info fc;
493 struct e1000_phy_info phy;
494 struct e1000_nvm_info nvm;
495 struct e1000_bus_info bus;
496 struct e1000_mbx_info mbx;
497 struct e1000_host_mng_dhcp_cookie mng_cookie;
500 struct e1000_dev_spec_82575 _82575;
504 u16 subsystem_vendor_id;
505 u16 subsystem_device_id;
512 extern char *igb_get_hw_dev_name(struct e1000_hw *hw);
513 #define hw_dbg(format, arg...) \
514 printk(KERN_DEBUG "%s: " format, igb_get_hw_dev_name(hw), ##arg)
516 #define hw_dbg(format, arg...)
519 /* These functions must be implemented by drivers */
520 s32 igb_read_pcie_cap_reg(struct e1000_hw *hw, u32 reg, u16 *value);
521 s32 igb_write_pcie_cap_reg(struct e1000_hw *hw, u32 reg, u16 *value);