drivers/net/e1000/e1000_hw.h

   1 /*******************************************************************************
   2
   3
   4   Copyright(c) 1999 - 2005 Intel Corporation. All rights reserved.
   5
   6   This program is free software; you can redistribute it and/or modify it
   7   under the terms of the GNU General Public License as published by the Free
   8   Software Foundation; either version 2 of the License, or (at your option)
   9   any later version.
  10
  11   This program is distributed in the hope that it will be useful, but WITHOUT
  12   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  14   more details.
  15
  16   You should have received a copy of the GNU General Public License along with
  17   this program; if not, write to the Free Software Foundation, Inc., 59
  18   Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  19
  20   The full GNU General Public License is included in this distribution in the
  21   file called LICENSE.
  22
  23   Contact Information:
  24   Linux NICS <linux.nics@intel.com>
  25   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  26
  27 *******************************************************************************/
  28
  29 /* e1000_hw.h
  30  * Structures, enums, and macros for the MAC
  31  */
  32
  33 #ifndef _E1000_HW_H_
  34 #define _E1000_HW_H_
  35
  36 #include "e1000_osdep.h"
  37
  38
  39 /* Forward declarations of structures used by the shared code */
  40 struct e1000_hw;
  41 struct e1000_hw_stats;
  42
  43 /* Enumerated types specific to the e1000 hardware */
  44 /* Media Access Controlers */
  45 typedef enum {
  46     e1000_undefined = 0,
  47     e1000_82542_rev2_0,
  48     e1000_82542_rev2_1,
  49     e1000_82543,
  50     e1000_82544,
  51     e1000_82540,
  52     e1000_82545,
  53     e1000_82545_rev_3,
  54     e1000_82546,
  55     e1000_82546_rev_3,
  56     e1000_82541,
  57     e1000_82541_rev_2,
  58     e1000_82547,
  59     e1000_82547_rev_2,
  60     e1000_82573,
  61     e1000_num_macs
  62 } e1000_mac_type;
  63
  64 typedef enum {
  65     e1000_eeprom_uninitialized = 0,
  66     e1000_eeprom_spi,
  67     e1000_eeprom_microwire,
  68     e1000_eeprom_flash,
  69     e1000_num_eeprom_types
  70 } e1000_eeprom_type;
  71
  72 /* Media Types */
  73 typedef enum {
  74     e1000_media_type_copper = 0,
  75     e1000_media_type_fiber = 1,
  76     e1000_media_type_internal_serdes = 2,
  77     e1000_num_media_types
  78 } e1000_media_type;
  79
  80 typedef enum {
  81     e1000_10_half = 0,
  82     e1000_10_full = 1,
  83     e1000_100_half = 2,
  84     e1000_100_full = 3
  85 } e1000_speed_duplex_type;
  86
  87 /* Flow Control Settings */
  88 typedef enum {
  89     e1000_fc_none = 0,
  90     e1000_fc_rx_pause = 1,
  91     e1000_fc_tx_pause = 2,
  92     e1000_fc_full = 3,
  93     e1000_fc_default = 0xFF
  94 } e1000_fc_type;
  95
  96 /* PCI bus types */
  97 typedef enum {
  98     e1000_bus_type_unknown = 0,
  99     e1000_bus_type_pci,
 100     e1000_bus_type_pcix,
 101     e1000_bus_type_pci_express,
 102     e1000_bus_type_reserved
 103 } e1000_bus_type;
 104
 105 /* PCI bus speeds */
 106 typedef enum {
 107     e1000_bus_speed_unknown = 0,
 108     e1000_bus_speed_33,
 109     e1000_bus_speed_66,
 110     e1000_bus_speed_100,
 111     e1000_bus_speed_120,
 112     e1000_bus_speed_133,
 113     e1000_bus_speed_2500,
 114     e1000_bus_speed_reserved
 115 } e1000_bus_speed;
 116
 117 /* PCI bus widths */
 118 typedef enum {
 119     e1000_bus_width_unknown = 0,
 120     e1000_bus_width_32,
 121     e1000_bus_width_64,
 122     e1000_bus_width_pciex_1,
 123     e1000_bus_width_pciex_4,
 124     e1000_bus_width_reserved
 125 } e1000_bus_width;
 126
 127 /* PHY status info structure and supporting enums */
 128 typedef enum {
 129     e1000_cable_length_50 = 0,
 130     e1000_cable_length_50_80,
 131     e1000_cable_length_80_110,
 132     e1000_cable_length_110_140,
 133     e1000_cable_length_140,
 134     e1000_cable_length_undefined = 0xFF
 135 } e1000_cable_length;
 136
 137 typedef enum {
 138     e1000_igp_cable_length_10  = 10,
 139     e1000_igp_cable_length_20  = 20,
 140     e1000_igp_cable_length_30  = 30,
 141     e1000_igp_cable_length_40  = 40,
 142     e1000_igp_cable_length_50  = 50,
 143     e1000_igp_cable_length_60  = 60,
 144     e1000_igp_cable_length_70  = 70,
 145     e1000_igp_cable_length_80  = 80,
 146     e1000_igp_cable_length_90  = 90,
 147     e1000_igp_cable_length_100 = 100,
 148     e1000_igp_cable_length_110 = 110,
 149     e1000_igp_cable_length_120 = 120,
 150     e1000_igp_cable_length_130 = 130,
 151     e1000_igp_cable_length_140 = 140,
 152     e1000_igp_cable_length_150 = 150,
 153     e1000_igp_cable_length_160 = 160,
 154     e1000_igp_cable_length_170 = 170,
 155     e1000_igp_cable_length_180 = 180
 156 } e1000_igp_cable_length;
 157
 158 typedef enum {
 159     e1000_10bt_ext_dist_enable_normal = 0,
 160     e1000_10bt_ext_dist_enable_lower,
 161     e1000_10bt_ext_dist_enable_undefined = 0xFF
 162 } e1000_10bt_ext_dist_enable;
 163
 164 typedef enum {
 165     e1000_rev_polarity_normal = 0,
 166     e1000_rev_polarity_reversed,
 167     e1000_rev_polarity_undefined = 0xFF
 168 } e1000_rev_polarity;
 169
 170 typedef enum {
 171     e1000_downshift_normal = 0,
 172     e1000_downshift_activated,
 173     e1000_downshift_undefined = 0xFF
 174 } e1000_downshift;
 175
 176 typedef enum {
 177     e1000_smart_speed_default = 0,
 178     e1000_smart_speed_on,
 179     e1000_smart_speed_off
 180 } e1000_smart_speed;
 181
 182 typedef enum {
 183     e1000_polarity_reversal_enabled = 0,
 184     e1000_polarity_reversal_disabled,
 185     e1000_polarity_reversal_undefined = 0xFF
 186 } e1000_polarity_reversal;
 187
 188 typedef enum {
 189     e1000_auto_x_mode_manual_mdi = 0,
 190     e1000_auto_x_mode_manual_mdix,
 191     e1000_auto_x_mode_auto1,
 192     e1000_auto_x_mode_auto2,
 193     e1000_auto_x_mode_undefined = 0xFF
 194 } e1000_auto_x_mode;
 195
 196 typedef enum {
 197     e1000_1000t_rx_status_not_ok = 0,
 198     e1000_1000t_rx_status_ok,
 199     e1000_1000t_rx_status_undefined = 0xFF
 200 } e1000_1000t_rx_status;
 201
 202 typedef enum {
 203     e1000_phy_m88 = 0,
 204     e1000_phy_igp,
 205     e1000_phy_igp_2,
 206     e1000_phy_undefined = 0xFF
 207 } e1000_phy_type;
 208
 209 typedef enum {
 210     e1000_ms_hw_default = 0,
 211     e1000_ms_force_master,
 212     e1000_ms_force_slave,
 213     e1000_ms_auto
 214 } e1000_ms_type;
 215
 216 typedef enum {
 217     e1000_ffe_config_enabled = 0,
 218     e1000_ffe_config_active,
 219     e1000_ffe_config_blocked
 220 } e1000_ffe_config;
 221
 222 typedef enum {
 223     e1000_dsp_config_disabled = 0,
 224     e1000_dsp_config_enabled,
 225     e1000_dsp_config_activated,
 226     e1000_dsp_config_undefined = 0xFF
 227 } e1000_dsp_config;
 228
 229 struct e1000_phy_info {
 230     e1000_cable_length cable_length;
 231     e1000_10bt_ext_dist_enable extended_10bt_distance;
 232     e1000_rev_polarity cable_polarity;
 233     e1000_downshift downshift;
 234     e1000_polarity_reversal polarity_correction;
 235     e1000_auto_x_mode mdix_mode;
 236     e1000_1000t_rx_status local_rx;
 237     e1000_1000t_rx_status remote_rx;
 238 };
 239
 240 struct e1000_phy_stats {
 241     uint32_t idle_errors;
 242     uint32_t receive_errors;
 243 };
 244
 245 struct e1000_eeprom_info {
 246     e1000_eeprom_type type;
 247     uint16_t word_size;
 248     uint16_t opcode_bits;
 249     uint16_t address_bits;
 250     uint16_t delay_usec;
 251     uint16_t page_size;
 252     boolean_t use_eerd;
 253     boolean_t use_eewr;
 254 };
 255
 256 /* Flex ASF Information */
 257 #define E1000_HOST_IF_MAX_SIZE  2048
 258
 259 typedef enum {
 260     e1000_byte_align = 0,
 261     e1000_word_align = 1,
 262     e1000_dword_align = 2
 263 } e1000_align_type;
 264
 265
 266
 267 /* Error Codes */
 268 #define E1000_SUCCESS      0
 269 #define E1000_ERR_EEPROM   1
 270 #define E1000_ERR_PHY      2
 271 #define E1000_ERR_CONFIG   3
 272 #define E1000_ERR_PARAM    4
 273 #define E1000_ERR_MAC_TYPE 5
 274 #define E1000_ERR_PHY_TYPE 6
 275 #define E1000_ERR_RESET   9
 276 #define E1000_ERR_MASTER_REQUESTS_PENDING 10
 277 #define E1000_ERR_HOST_INTERFACE_COMMAND 11
 278 #define E1000_BLK_PHY_RESET   12
 279
 280 /* Function prototypes */
 281 /* Initialization */
 282 int32_t e1000_reset_hw(struct e1000_hw *hw);
 283 int32_t e1000_init_hw(struct e1000_hw *hw);
 284 int32_t e1000_id_led_init(struct e1000_hw * hw);
 285 int32_t e1000_set_mac_type(struct e1000_hw *hw);
 286 void e1000_set_media_type(struct e1000_hw *hw);
 287
 288 /* Link Configuration */
 289 int32_t e1000_setup_link(struct e1000_hw *hw);
 290 int32_t e1000_phy_setup_autoneg(struct e1000_hw *hw);
 291 void e1000_config_collision_dist(struct e1000_hw *hw);
 292 int32_t e1000_config_fc_after_link_up(struct e1000_hw *hw);
 293 int32_t e1000_check_for_link(struct e1000_hw *hw);
 294 int32_t e1000_get_speed_and_duplex(struct e1000_hw *hw, uint16_t * speed, uint16_t * duplex);
 295 int32_t e1000_wait_autoneg(struct e1000_hw *hw);
 296 int32_t e1000_force_mac_fc(struct e1000_hw *hw);
 297
 298 /* PHY */
 299 int32_t e1000_read_phy_reg(struct e1000_hw *hw, uint32_t reg_addr, uint16_t *phy_data);
 300 int32_t e1000_write_phy_reg(struct e1000_hw *hw, uint32_t reg_addr, uint16_t data);
 301 int32_t e1000_phy_hw_reset(struct e1000_hw *hw);
 302 int32_t e1000_phy_reset(struct e1000_hw *hw);
 303 int32_t e1000_detect_gig_phy(struct e1000_hw *hw);
 304 int32_t e1000_phy_get_info(struct e1000_hw *hw, struct e1000_phy_info *phy_info);
 305 int32_t e1000_phy_m88_get_info(struct e1000_hw *hw, struct e1000_phy_info *phy_info);
 306 int32_t e1000_phy_igp_get_info(struct e1000_hw *hw, struct e1000_phy_info *phy_info);
 307 int32_t e1000_get_cable_length(struct e1000_hw *hw, uint16_t *min_length, uint16_t *max_length);
 308 int32_t e1000_check_polarity(struct e1000_hw *hw, uint16_t *polarity);
 309 int32_t e1000_check_downshift(struct e1000_hw *hw);
 310 int32_t e1000_validate_mdi_setting(struct e1000_hw *hw);
 311
 312 /* EEPROM Functions */
 313 int32_t e1000_init_eeprom_params(struct e1000_hw *hw);
 314 boolean_t e1000_is_onboard_nvm_eeprom(struct e1000_hw *hw);
 315 int32_t e1000_read_eeprom_eerd(struct e1000_hw *hw, uint16_t offset, uint16_t words, uint16_t *data);
 316 int32_t e1000_write_eeprom_eewr(struct e1000_hw *hw, uint16_t offset, uint16_t words, uint16_t *data);
 317 int32_t e1000_poll_eerd_eewr_done(struct e1000_hw *hw, int eerd);
 318
 319 /* MNG HOST IF functions */
 320 uint32_t e1000_enable_mng_pass_thru(struct e1000_hw *hw);
 321
 322 #define E1000_MNG_DHCP_TX_PAYLOAD_CMD   64
 323 #define E1000_HI_MAX_MNG_DATA_LENGTH    0x6F8   /* Host Interface data length */
 324
 325 #define E1000_MNG_DHCP_COMMAND_TIMEOUT  10      /* Time in ms to process MNG command */
 326 #define E1000_MNG_DHCP_COOKIE_OFFSET    0x6F0   /* Cookie offset */
 327 #define E1000_MNG_DHCP_COOKIE_LENGTH    0x10    /* Cookie length */
 328 #define E1000_MNG_IAMT_MODE             0x3
 329 #define E1000_IAMT_SIGNATURE            0x544D4149 /* Intel(R) Active Management Technology signature */
 330
 331 #define E1000_MNG_DHCP_COOKIE_STATUS_PARSING_SUPPORT 0x1 /* DHCP parsing enabled */
 332 #define E1000_MNG_DHCP_COOKIE_STATUS_VLAN_SUPPORT    0x2 /* DHCP parsing enabled */
 333 #define E1000_VFTA_ENTRY_SHIFT                       0x5
 334 #define E1000_VFTA_ENTRY_MASK                        0x7F
 335 #define E1000_VFTA_ENTRY_BIT_SHIFT_MASK              0x1F
 336
 337 struct e1000_host_mng_command_header {
 338     uint8_t command_id;
 339     uint8_t checksum;
 340     uint16_t reserved1;
 341     uint16_t reserved2;
 342     uint16_t command_length;
 343 };
 344
 345 struct e1000_host_mng_command_info {
 346     struct e1000_host_mng_command_header command_header;  /* Command Head/Command Result Head has 4 bytes */
 347     uint8_t command_data[E1000_HI_MAX_MNG_DATA_LENGTH];   /* Command data can length 0..0x658*/
 348 };
 349 #ifdef __BIG_ENDIAN
 350 struct e1000_host_mng_dhcp_cookie{
 351     uint32_t signature;
 352     uint16_t vlan_id;
 353     uint8_t reserved0;
 354     uint8_t status;
 355     uint32_t reserved1;
 356     uint8_t checksum;
 357     uint8_t reserved3;
 358     uint16_t reserved2;
 359 };
 360 #else
 361 struct e1000_host_mng_dhcp_cookie{
 362     uint32_t signature;
 363     uint8_t status;
 364     uint8_t reserved0;
 365     uint16_t vlan_id;
 366     uint32_t reserved1;
 367     uint16_t reserved2;
 368     uint8_t reserved3;
 369     uint8_t checksum;
 370 };
 371 #endif
 372
 373 int32_t e1000_mng_write_dhcp_info(struct e1000_hw *hw, uint8_t *buffer,
 374                                                         uint16_t length);
 375 boolean_t e1000_check_mng_mode(struct e1000_hw *hw);
 376 boolean_t e1000_enable_tx_pkt_filtering(struct e1000_hw *hw);
 377 int32_t e1000_mng_enable_host_if(struct e1000_hw *hw);
 378 int32_t e1000_mng_host_if_write(struct e1000_hw *hw, uint8_t *buffer,
 379                             uint16_t length, uint16_t offset, uint8_t *sum);
 380 int32_t e1000_mng_write_cmd_header(struct e1000_hw* hw,
 381                                    struct e1000_host_mng_command_header* hdr);
 382
 383 int32_t e1000_mng_write_commit(struct e1000_hw *hw);
 384
 385 int32_t e1000_read_eeprom(struct e1000_hw *hw, uint16_t reg, uint16_t words, uint16_t *data);
 386 int32_t e1000_validate_eeprom_checksum(struct e1000_hw *hw);
 387 int32_t e1000_update_eeprom_checksum(struct e1000_hw *hw);
 388 int32_t e1000_write_eeprom(struct e1000_hw *hw, uint16_t reg, uint16_t words, uint16_t *data);
 389 int32_t e1000_read_part_num(struct e1000_hw *hw, uint32_t * part_num);
 390 int32_t e1000_read_mac_addr(struct e1000_hw * hw);
 391 int32_t e1000_swfw_sync_acquire(struct e1000_hw *hw, uint16_t mask);
 392 void e1000_swfw_sync_release(struct e1000_hw *hw, uint16_t mask);
 393
 394 /* Filters (multicast, vlan, receive) */
 395 void e1000_init_rx_addrs(struct e1000_hw *hw);
 396 void e1000_mc_addr_list_update(struct e1000_hw *hw, uint8_t * mc_addr_list, uint32_t mc_addr_count, uint32_t pad, uint32_t rar_used_count);
 397 uint32_t e1000_hash_mc_addr(struct e1000_hw *hw, uint8_t * mc_addr);
 398 void e1000_mta_set(struct e1000_hw *hw, uint32_t hash_value);
 399 void e1000_rar_set(struct e1000_hw *hw, uint8_t * mc_addr, uint32_t rar_index);
 400 void e1000_write_vfta(struct e1000_hw *hw, uint32_t offset, uint32_t value);
 401 void e1000_clear_vfta(struct e1000_hw *hw);
 402
 403 /* LED functions */
 404 int32_t e1000_setup_led(struct e1000_hw *hw);
 405 int32_t e1000_cleanup_led(struct e1000_hw *hw);
 406 int32_t e1000_led_on(struct e1000_hw *hw);
 407 int32_t e1000_led_off(struct e1000_hw *hw);
 408
 409 /* Adaptive IFS Functions */
 410
 411 /* Everything else */
 412 void e1000_clear_hw_cntrs(struct e1000_hw *hw);
 413 void e1000_reset_adaptive(struct e1000_hw *hw);
 414 void e1000_update_adaptive(struct e1000_hw *hw);
 415 void e1000_tbi_adjust_stats(struct e1000_hw *hw, struct e1000_hw_stats *stats, uint32_t frame_len, uint8_t * mac_addr);
 416 void e1000_get_bus_info(struct e1000_hw *hw);
 417 void e1000_pci_set_mwi(struct e1000_hw *hw);
 418 void e1000_pci_clear_mwi(struct e1000_hw *hw);
 419 void e1000_read_pci_cfg(struct e1000_hw *hw, uint32_t reg, uint16_t * value);
 420 void e1000_write_pci_cfg(struct e1000_hw *hw, uint32_t reg, uint16_t * value);
 421 /* Port I/O is only supported on 82544 and newer */
 422 uint32_t e1000_io_read(struct e1000_hw *hw, unsigned long port);
 423 uint32_t e1000_read_reg_io(struct e1000_hw *hw, uint32_t offset);
 424 void e1000_io_write(struct e1000_hw *hw, unsigned long port, uint32_t value);
 425 void e1000_write_reg_io(struct e1000_hw *hw, uint32_t offset, uint32_t value);
 426 int32_t e1000_config_dsp_after_link_change(struct e1000_hw *hw, boolean_t link_up);
 427 int32_t e1000_set_d3_lplu_state(struct e1000_hw *hw, boolean_t active);
 428 int32_t e1000_set_d0_lplu_state(struct e1000_hw *hw, boolean_t active);
 429 void e1000_set_pci_express_master_disable(struct e1000_hw *hw);
 430 void e1000_enable_pciex_master(struct e1000_hw *hw);
 431 int32_t e1000_disable_pciex_master(struct e1000_hw *hw);
 432 int32_t e1000_get_auto_rd_done(struct e1000_hw *hw);
 433 int32_t e1000_get_phy_cfg_done(struct e1000_hw *hw);
 434 int32_t e1000_get_software_semaphore(struct e1000_hw *hw);
 435 void e1000_release_software_semaphore(struct e1000_hw *hw);
 436 int32_t e1000_check_phy_reset_block(struct e1000_hw *hw);
 437 int32_t e1000_get_hw_eeprom_semaphore(struct e1000_hw *hw);
 438 void e1000_put_hw_eeprom_semaphore(struct e1000_hw *hw);
 439 int32_t e1000_commit_shadow_ram(struct e1000_hw *hw);
 440 uint8_t e1000_arc_subsystem_valid(struct e1000_hw *hw);
 441
 442 #define E1000_READ_REG_IO(a, reg) \
 443     e1000_read_reg_io((a), E1000_##reg)
 444 #define E1000_WRITE_REG_IO(a, reg, val) \
 445     e1000_write_reg_io((a), E1000_##reg, val)
 446
 447 /* PCI Device IDs */
 448 #define E1000_DEV_ID_82542               0x1000
 449 #define E1000_DEV_ID_82543GC_FIBER       0x1001
 450 #define E1000_DEV_ID_82543GC_COPPER      0x1004
 451 #define E1000_DEV_ID_82544EI_COPPER      0x1008
 452 #define E1000_DEV_ID_82544EI_FIBER       0x1009
 453 #define E1000_DEV_ID_82544GC_COPPER      0x100C
 454 #define E1000_DEV_ID_82544GC_LOM         0x100D
 455 #define E1000_DEV_ID_82540EM             0x100E
 456 #define E1000_DEV_ID_82540EM_LOM         0x1015
 457 #define E1000_DEV_ID_82540EP_LOM         0x1016
 458 #define E1000_DEV_ID_82540EP             0x1017
 459 #define E1000_DEV_ID_82540EP_LP          0x101E
 460 #define E1000_DEV_ID_82545EM_COPPER      0x100F
 461 #define E1000_DEV_ID_82545EM_FIBER       0x1011
 462 #define E1000_DEV_ID_82545GM_COPPER      0x1026
 463 #define E1000_DEV_ID_82545GM_FIBER       0x1027
 464 #define E1000_DEV_ID_82545GM_SERDES      0x1028
 465 #define E1000_DEV_ID_82546EB_COPPER      0x1010
 466 #define E1000_DEV_ID_82546EB_FIBER       0x1012
 467 #define E1000_DEV_ID_82546EB_QUAD_COPPER 0x101D
 468 #define E1000_DEV_ID_82541EI             0x1013
 469 #define E1000_DEV_ID_82541EI_MOBILE      0x1018
 470 #define E1000_DEV_ID_82541ER             0x1078
 471 #define E1000_DEV_ID_82547GI             0x1075
 472 #define E1000_DEV_ID_82541GI             0x1076
 473 #define E1000_DEV_ID_82541GI_MOBILE      0x1077
 474 #define E1000_DEV_ID_82541GI_LF          0x107C
 475 #define E1000_DEV_ID_82546GB_COPPER      0x1079
 476 #define E1000_DEV_ID_82546GB_FIBER       0x107A
 477 #define E1000_DEV_ID_82546GB_SERDES      0x107B
 478 #define E1000_DEV_ID_82546GB_PCIE        0x108A
 479 #define E1000_DEV_ID_82547EI             0x1019
 480 #define E1000_DEV_ID_82573E              0x108B
 481 #define E1000_DEV_ID_82573E_IAMT         0x108C
 482
 483 #define E1000_DEV_ID_82546GB_QUAD_COPPER 0x1099
 484
 485 #define NODE_ADDRESS_SIZE 6
 486 #define ETH_LENGTH_OF_ADDRESS 6
 487
 488 /* MAC decode size is 128K - This is the size of BAR0 */
 489 #define MAC_DECODE_SIZE (128 * 1024)
 490
 491 #define E1000_82542_2_0_REV_ID 2
 492 #define E1000_82542_2_1_REV_ID 3
 493 #define E1000_REVISION_0       0
 494 #define E1000_REVISION_1       1
 495 #define E1000_REVISION_2       2
 496 #define E1000_REVISION_3       3
 497
 498 #define SPEED_10    10
 499 #define SPEED_100   100
 500 #define SPEED_1000  1000
 501 #define HALF_DUPLEX 1
 502 #define FULL_DUPLEX 2
 503
 504 /* The sizes (in bytes) of a ethernet packet */
 505 #define ENET_HEADER_SIZE             14
 506 #define MAXIMUM_ETHERNET_FRAME_SIZE  1518 /* With FCS */
 507 #define MINIMUM_ETHERNET_FRAME_SIZE  64   /* With FCS */
 508 #define ETHERNET_FCS_SIZE            4
 509 #define MAXIMUM_ETHERNET_PACKET_SIZE \
 510     (MAXIMUM_ETHERNET_FRAME_SIZE - ETHERNET_FCS_SIZE)
 511 #define MINIMUM_ETHERNET_PACKET_SIZE \
 512     (MINIMUM_ETHERNET_FRAME_SIZE - ETHERNET_FCS_SIZE)
 513 #define CRC_LENGTH                   ETHERNET_FCS_SIZE
 514 #define MAX_JUMBO_FRAME_SIZE         0x3F00
 515
 516
 517 /* 802.1q VLAN Packet Sizes */
 518 #define VLAN_TAG_SIZE                     4     /* 802.3ac tag (not DMAed) */
 519
 520 /* Ethertype field values */
 521 #define ETHERNET_IEEE_VLAN_TYPE 0x8100  /* 802.3ac packet */
 522 #define ETHERNET_IP_TYPE        0x0800  /* IP packets */
 523 #define ETHERNET_ARP_TYPE       0x0806  /* Address Resolution Protocol (ARP) */
 524
 525 /* Packet Header defines */
 526 #define IP_PROTOCOL_TCP    6
 527 #define IP_PROTOCOL_UDP    0x11
 528
 529 /* This defines the bits that are set in the Interrupt Mask
 530  * Set/Read Register.  Each bit is documented below:
 531  *   o RXDMT0 = Receive Descriptor Minimum Threshold hit (ring 0)
 532  *   o RXSEQ  = Receive Sequence Error
 533  */
 534 #define POLL_IMS_ENABLE_MASK ( \
 535     E1000_IMS_RXDMT0 |         \
 536     E1000_IMS_RXSEQ)
 537
 538 /* This defines the bits that are set in the Interrupt Mask
 539  * Set/Read Register.  Each bit is documented below:
 540  *   o RXT0   = Receiver Timer Interrupt (ring 0)
 541  *   o TXDW   = Transmit Descriptor Written Back
 542  *   o RXDMT0 = Receive Descriptor Minimum Threshold hit (ring 0)
 543  *   o RXSEQ  = Receive Sequence Error
 544  *   o LSC    = Link Status Change
 545  */
 546 #define IMS_ENABLE_MASK ( \
 547     E1000_IMS_RXT0   |    \
 548     E1000_IMS_TXDW   |    \
 549     E1000_IMS_RXDMT0 |    \
 550     E1000_IMS_RXSEQ  |    \
 551     E1000_IMS_LSC)
 552
 553
 554 /* Number of high/low register pairs in the RAR. The RAR (Receive Address
 555  * Registers) holds the directed and multicast addresses that we monitor. We
 556  * reserve one of these spots for our directed address, allowing us room for
 557  * E1000_RAR_ENTRIES - 1 multicast addresses.
 558  */
 559 #define E1000_RAR_ENTRIES 15
 560
 561 #define MIN_NUMBER_OF_DESCRIPTORS 8
 562 #define MAX_NUMBER_OF_DESCRIPTORS 0xFFF8
 563
 564 /* Receive Descriptor */
 565 struct e1000_rx_desc {
 566     uint64_t buffer_addr; /* Address of the descriptor's data buffer */
 567     uint16_t length;     /* Length of data DMAed into data buffer */
 568     uint16_t csum;       /* Packet checksum */
 569     uint8_t status;      /* Descriptor status */
 570     uint8_t errors;      /* Descriptor Errors */
 571     uint16_t special;
 572 };
 573
 574 /* Receive Descriptor - Extended */
 575 union e1000_rx_desc_extended {
 576     struct {
 577         uint64_t buffer_addr;
 578         uint64_t reserved;
 579     } read;
 580     struct {
 581         struct {
 582             uint32_t mrq;              /* Multiple Rx Queues */
 583             union {
 584                 uint32_t rss;          /* RSS Hash */
 585                 struct {
 586                     uint16_t ip_id;    /* IP id */
 587                     uint16_t csum;     /* Packet Checksum */
 588                 } csum_ip;
 589             } hi_dword;
 590         } lower;
 591         struct {
 592             uint32_t status_error;     /* ext status/error */
 593             uint16_t length;
 594             uint16_t vlan;             /* VLAN tag */
 595         } upper;
 596     } wb;  /* writeback */
 597 };
 598
 599 #define MAX_PS_BUFFERS 4
 600 /* Receive Descriptor - Packet Split */
 601 union e1000_rx_desc_packet_split {
 602     struct {
 603         /* one buffer for protocol header(s), three data buffers */
 604         uint64_t buffer_addr[MAX_PS_BUFFERS];
 605     } read;
 606     struct {
 607         struct {
 608             uint32_t mrq;              /* Multiple Rx Queues */
 609             union {
 610                 uint32_t rss;          /* RSS Hash */
 611                 struct {
 612                     uint16_t ip_id;    /* IP id */
 613                     uint16_t csum;     /* Packet Checksum */
 614                 } csum_ip;
 615             } hi_dword;
 616         } lower;
 617         struct {
 618             uint32_t status_error;     /* ext status/error */
 619             uint16_t length0;          /* length of buffer 0 */
 620             uint16_t vlan;             /* VLAN tag */
 621         } middle;
 622         struct {
 623             uint16_t header_status;
 624             uint16_t length[3];        /* length of buffers 1-3 */
 625         } upper;
 626         uint64_t reserved;
 627     } wb; /* writeback */
 628 };
 629
 630 /* Receive Decriptor bit definitions */
 631 #define E1000_RXD_STAT_DD       0x01    /* Descriptor Done */
 632 #define E1000_RXD_STAT_EOP      0x02    /* End of Packet */
 633 #define E1000_RXD_STAT_IXSM     0x04    /* Ignore checksum */
 634 #define E1000_RXD_STAT_VP       0x08    /* IEEE VLAN Packet */
 635 #define E1000_RXD_STAT_UDPCS    0x10    /* UDP xsum caculated */
 636 #define E1000_RXD_STAT_TCPCS    0x20    /* TCP xsum calculated */
 637 #define E1000_RXD_STAT_IPCS     0x40    /* IP xsum calculated */
 638 #define E1000_RXD_STAT_PIF      0x80    /* passed in-exact filter */
 639 #define E1000_RXD_STAT_IPIDV    0x200   /* IP identification valid */
 640 #define E1000_RXD_STAT_UDPV     0x400   /* Valid UDP checksum */
 641 #define E1000_RXD_STAT_ACK      0x8000  /* ACK Packet indication */
 642 #define E1000_RXD_ERR_CE        0x01    /* CRC Error */
 643 #define E1000_RXD_ERR_SE        0x02    /* Symbol Error */
 644 #define E1000_RXD_ERR_SEQ       0x04    /* Sequence Error */
 645 #define E1000_RXD_ERR_CXE       0x10    /* Carrier Extension Error */
 646 #define E1000_RXD_ERR_TCPE      0x20    /* TCP/UDP Checksum Error */
 647 #define E1000_RXD_ERR_IPE       0x40    /* IP Checksum Error */
 648 #define E1000_RXD_ERR_RXE       0x80    /* Rx Data Error */
 649 #define E1000_RXD_SPC_VLAN_MASK 0x0FFF  /* VLAN ID is in lower 12 bits */
 650 #define E1000_RXD_SPC_PRI_MASK  0xE000  /* Priority is in upper 3 bits */
 651 #define E1000_RXD_SPC_PRI_SHIFT 13
 652 #define E1000_RXD_SPC_CFI_MASK  0x1000  /* CFI is bit 12 */
 653 #define E1000_RXD_SPC_CFI_SHIFT 12
 654
 655 #define E1000_RXDEXT_STATERR_CE    0x01000000
 656 #define E1000_RXDEXT_STATERR_SE    0x02000000
 657 #define E1000_RXDEXT_STATERR_SEQ   0x04000000
 658 #define E1000_RXDEXT_STATERR_CXE   0x10000000
 659 #define E1000_RXDEXT_STATERR_TCPE  0x20000000
 660 #define E1000_RXDEXT_STATERR_IPE   0x40000000
 661 #define E1000_RXDEXT_STATERR_RXE   0x80000000
 662
 663 #define E1000_RXDPS_HDRSTAT_HDRSP        0x00008000
 664 #define E1000_RXDPS_HDRSTAT_HDRLEN_MASK  0x000003FF
 665
 666 /* mask to determine if packets should be dropped due to frame errors */
 667 #define E1000_RXD_ERR_FRAME_ERR_MASK ( \
 668     E1000_RXD_ERR_CE  |                \
 669     E1000_RXD_ERR_SE  |                \
 670     E1000_RXD_ERR_SEQ |                \
 671     E1000_RXD_ERR_CXE |                \
 672     E1000_RXD_ERR_RXE)
 673
 674
 675 /* Same mask, but for extended and packet split descriptors */
 676 #define E1000_RXDEXT_ERR_FRAME_ERR_MASK ( \
 677     E1000_RXDEXT_STATERR_CE  |            \
 678     E1000_RXDEXT_STATERR_SE  |            \
 679     E1000_RXDEXT_STATERR_SEQ |            \
 680     E1000_RXDEXT_STATERR_CXE |            \
 681     E1000_RXDEXT_STATERR_RXE)
 682
 683 /* Transmit Descriptor */
 684 struct e1000_tx_desc {
 685     uint64_t buffer_addr;       /* Address of the descriptor's data buffer */
 686     union {
 687         uint32_t data;
 688         struct {
 689             uint16_t length;    /* Data buffer length */
 690             uint8_t cso;        /* Checksum offset */
 691             uint8_t cmd;        /* Descriptor control */
 692         } flags;
 693     } lower;
 694     union {
 695         uint32_t data;
 696         struct {
 697             uint8_t status;     /* Descriptor status */
 698             uint8_t css;        /* Checksum start */
 699             uint16_t special;
 700         } fields;
 701     } upper;
 702 };
 703
 704 /* Transmit Descriptor bit definitions */
 705 #define E1000_TXD_DTYP_D     0x00100000 /* Data Descriptor */
 706 #define E1000_TXD_DTYP_C     0x00000000 /* Context Descriptor */
 707 #define E1000_TXD_POPTS_IXSM 0x01       /* Insert IP checksum */
 708 #define E1000_TXD_POPTS_TXSM 0x02       /* Insert TCP/UDP checksum */
 709 #define E1000_TXD_CMD_EOP    0x01000000 /* End of Packet */
 710 #define E1000_TXD_CMD_IFCS   0x02000000 /* Insert FCS (Ethernet CRC) */
 711 #define E1000_TXD_CMD_IC     0x04000000 /* Insert Checksum */
 712 #define E1000_TXD_CMD_RS     0x08000000 /* Report Status */
 713 #define E1000_TXD_CMD_RPS    0x10000000 /* Report Packet Sent */
 714 #define E1000_TXD_CMD_DEXT   0x20000000 /* Descriptor extension (0 = legacy) */
 715 #define E1000_TXD_CMD_VLE    0x40000000 /* Add VLAN tag */
 716 #define E1000_TXD_CMD_IDE    0x80000000 /* Enable Tidv register */
 717 #define E1000_TXD_STAT_DD    0x00000001 /* Descriptor Done */
 718 #define E1000_TXD_STAT_EC    0x00000002 /* Excess Collisions */
 719 #define E1000_TXD_STAT_LC    0x00000004 /* Late Collisions */
 720 #define E1000_TXD_STAT_TU    0x00000008 /* Transmit underrun */
 721 #define E1000_TXD_CMD_TCP    0x01000000 /* TCP packet */
 722 #define E1000_TXD_CMD_IP     0x02000000 /* IP packet */
 723 #define E1000_TXD_CMD_TSE    0x04000000 /* TCP Seg enable */
 724 #define E1000_TXD_STAT_TC    0x00000004 /* Tx Underrun */
 725
 726 /* Offload Context Descriptor */
 727 struct e1000_context_desc {
 728     union {
 729         uint32_t ip_config;
 730         struct {
 731             uint8_t ipcss;      /* IP checksum start */
 732             uint8_t ipcso;      /* IP checksum offset */
 733             uint16_t ipcse;     /* IP checksum end */
 734         } ip_fields;
 735     } lower_setup;
 736     union {
 737         uint32_t tcp_config;
 738         struct {
 739             uint8_t tucss;      /* TCP checksum start */
 740             uint8_t tucso;      /* TCP checksum offset */
 741             uint16_t tucse;     /* TCP checksum end */
 742         } tcp_fields;
 743     } upper_setup;
 744     uint32_t cmd_and_length;    /* */
 745     union {
 746         uint32_t data;
 747         struct {
 748             uint8_t status;     /* Descriptor status */
 749             uint8_t hdr_len;    /* Header length */
 750             uint16_t mss;       /* Maximum segment size */
 751         } fields;
 752     } tcp_seg_setup;
 753 };
 754
 755 /* Offload data descriptor */
 756 struct e1000_data_desc {
 757     uint64_t buffer_addr;       /* Address of the descriptor's buffer address */
 758     union {
 759         uint32_t data;
 760         struct {
 761             uint16_t length;    /* Data buffer length */
 762             uint8_t typ_len_ext;        /* */
 763             uint8_t cmd;        /* */
 764         } flags;
 765     } lower;
 766     union {
 767         uint32_t data;
 768         struct {
 769             uint8_t status;     /* Descriptor status */
 770             uint8_t popts;      /* Packet Options */
 771             uint16_t special;   /* */
 772         } fields;
 773     } upper;
 774 };
 775
 776 /* Filters */
 777 #define E1000_NUM_UNICAST          16   /* Unicast filter entries */
 778 #define E1000_MC_TBL_SIZE          128  /* Multicast Filter Table (4096 bits) */
 779 #define E1000_VLAN_FILTER_TBL_SIZE 128  /* VLAN Filter Table (4096 bits) */
 780
 781
 782 /* Receive Address Register */
 783 struct e1000_rar {
 784     volatile uint32_t low;      /* receive address low */
 785     volatile uint32_t high;     /* receive address high */
 786 };
 787
 788 /* Number of entries in the Multicast Table Array (MTA). */
 789 #define E1000_NUM_MTA_REGISTERS 128
 790
 791 /* IPv4 Address Table Entry */
 792 struct e1000_ipv4_at_entry {
 793     volatile uint32_t ipv4_addr;        /* IP Address (RW) */
 794     volatile uint32_t reserved;
 795 };
 796
 797 /* Four wakeup IP addresses are supported */
 798 #define E1000_WAKEUP_IP_ADDRESS_COUNT_MAX 4
 799 #define E1000_IP4AT_SIZE                  E1000_WAKEUP_IP_ADDRESS_COUNT_MAX
 800 #define E1000_IP6AT_SIZE                  1
 801
 802 /* IPv6 Address Table Entry */
 803 struct e1000_ipv6_at_entry {
 804     volatile uint8_t ipv6_addr[16];
 805 };
 806
 807 /* Flexible Filter Length Table Entry */
 808 struct e1000_fflt_entry {
 809     volatile uint32_t length;   /* Flexible Filter Length (RW) */
 810     volatile uint32_t reserved;
 811 };
 812
 813 /* Flexible Filter Mask Table Entry */
 814 struct e1000_ffmt_entry {
 815     volatile uint32_t mask;     /* Flexible Filter Mask (RW) */
 816     volatile uint32_t reserved;
 817 };
 818
 819 /* Flexible Filter Value Table Entry */
 820 struct e1000_ffvt_entry {
 821     volatile uint32_t value;    /* Flexible Filter Value (RW) */
 822     volatile uint32_t reserved;
 823 };
 824
 825 /* Four Flexible Filters are supported */
 826 #define E1000_FLEXIBLE_FILTER_COUNT_MAX 4
 827
 828 /* Each Flexible Filter is at most 128 (0x80) bytes in length */
 829 #define E1000_FLEXIBLE_FILTER_SIZE_MAX  128
 830
 831 #define E1000_FFLT_SIZE E1000_FLEXIBLE_FILTER_COUNT_MAX
 832 #define E1000_FFMT_SIZE E1000_FLEXIBLE_FILTER_SIZE_MAX
 833 #define E1000_FFVT_SIZE E1000_FLEXIBLE_FILTER_SIZE_MAX
 834
 835 /* Register Set. (82543, 82544)
 836  *
 837  * Registers are defined to be 32 bits and  should be accessed as 32 bit values.
 838  * These registers are physically located on the NIC, but are mapped into the
 839  * host memory address space.
 840  *
 841  * RW - register is both readable and writable
 842  * RO - register is read only
 843  * WO - register is write only
 844  * R/clr - register is read only and is cleared when read
 845  * A - register array
 846  */
 847 #define E1000_CTRL     0x00000  /* Device Control - RW */
 848 #define E1000_CTRL_DUP 0x00004  /* Device Control Duplicate (Shadow) - RW */
 849 #define E1000_STATUS   0x00008  /* Device Status - RO */
 850 #define E1000_EECD     0x00010  /* EEPROM/Flash Control - RW */
 851 #define E1000_EERD     0x00014  /* EEPROM Read - RW */
 852 #define E1000_CTRL_EXT 0x00018  /* Extended Device Control - RW */
 853 #define E1000_FLA      0x0001C  /* Flash Access - RW */
 854 #define E1000_MDIC     0x00020  /* MDI Control - RW */
 855 #define E1000_FCAL     0x00028  /* Flow Control Address Low - RW */
 856 #define E1000_FCAH     0x0002C  /* Flow Control Address High -RW */
 857 #define E1000_FCT      0x00030  /* Flow Control Type - RW */
 858 #define E1000_VET      0x00038  /* VLAN Ether Type - RW */
 859 #define E1000_ICR      0x000C0  /* Interrupt Cause Read - R/clr */
 860 #define E1000_ITR      0x000C4  /* Interrupt Throttling Rate - RW */
 861 #define E1000_ICS      0x000C8  /* Interrupt Cause Set - WO */
 862 #define E1000_IMS      0x000D0  /* Interrupt Mask Set - RW */
 863 #define E1000_IMC      0x000D8  /* Interrupt Mask Clear - WO */
 864 #define E1000_IAM      0x000E0  /* Interrupt Acknowledge Auto Mask */
 865 #define E1000_RCTL     0x00100  /* RX Control - RW */
 866 #define E1000_FCTTV    0x00170  /* Flow Control Transmit Timer Value - RW */
 867 #define E1000_TXCW     0x00178  /* TX Configuration Word - RW */
 868 #define E1000_RXCW     0x00180  /* RX Configuration Word - RO */
 869 #define E1000_TCTL     0x00400  /* TX Control - RW */
 870 #define E1000_TIPG     0x00410  /* TX Inter-packet gap -RW */
 871 #define E1000_TBT      0x00448  /* TX Burst Timer - RW */
 872 #define E1000_AIT      0x00458  /* Adaptive Interframe Spacing Throttle - RW */
 873 #define E1000_LEDCTL   0x00E00  /* LED Control - RW */
 874 #define E1000_EXTCNF_CTRL  0x00F00  /* Extended Configuration Control */
 875 #define E1000_EXTCNF_SIZE  0x00F08  /* Extended Configuration Size */
 876 #define E1000_PBA      0x01000  /* Packet Buffer Allocation - RW */
 877 #define E1000_PBS      0x01008  /* Packet Buffer Size */
 878 #define E1000_EEMNGCTL 0x01010  /* MNG EEprom Control */
 879 #define E1000_FLASH_UPDATES 1000
 880 #define E1000_EEARBC   0x01024  /* EEPROM Auto Read Bus Control */
 881 #define E1000_FLASHT   0x01028  /* FLASH Timer Register */
 882 #define E1000_EEWR     0x0102C  /* EEPROM Write Register - RW */
 883 #define E1000_FLSWCTL  0x01030  /* FLASH control register */
 884 #define E1000_FLSWDATA 0x01034  /* FLASH data register */
 885 #define E1000_FLSWCNT  0x01038  /* FLASH Access Counter */
 886 #define E1000_FLOP     0x0103C  /* FLASH Opcode Register */
 887 #define E1000_ERT      0x02008  /* Early Rx Threshold - RW */
 888 #define E1000_FCRTL    0x02160  /* Flow Control Receive Threshold Low - RW */
 889 #define E1000_FCRTH    0x02168  /* Flow Control Receive Threshold High - RW */
 890 #define E1000_PSRCTL   0x02170  /* Packet Split Receive Control - RW */
 891 #define E1000_RDBAL    0x02800  /* RX Descriptor Base Address Low - RW */
 892 #define E1000_RDBAH    0x02804  /* RX Descriptor Base Address High - RW */
 893 #define E1000_RDLEN    0x02808  /* RX Descriptor Length - RW */
 894 #define E1000_RDH      0x02810  /* RX Descriptor Head - RW */
 895 #define E1000_RDT      0x02818  /* RX Descriptor Tail - RW */
 896 #define E1000_RDTR     0x02820  /* RX Delay Timer - RW */
 897 #define E1000_RXDCTL   0x02828  /* RX Descriptor Control - RW */
 898 #define E1000_RADV     0x0282C  /* RX Interrupt Absolute Delay Timer - RW */
 899 #define E1000_RSRPD    0x02C00  /* RX Small Packet Detect - RW */
 900 #define E1000_RAID     0x02C08  /* Receive Ack Interrupt Delay - RW */
 901 #define E1000_TXDMAC   0x03000  /* TX DMA Control - RW */
 902 #define E1000_TDFH     0x03410  /* TX Data FIFO Head - RW */
 903 #define E1000_TDFT     0x03418  /* TX Data FIFO Tail - RW */
 904 #define E1000_TDFHS    0x03420  /* TX Data FIFO Head Saved - RW */
 905 #define E1000_TDFTS    0x03428  /* TX Data FIFO Tail Saved - RW */
 906 #define E1000_TDFPC    0x03430  /* TX Data FIFO Packet Count - RW */
 907 #define E1000_TDBAL    0x03800  /* TX Descriptor Base Address Low - RW */
 908 #define E1000_TDBAH    0x03804  /* TX Descriptor Base Address High - RW */
 909 #define E1000_TDLEN    0x03808  /* TX Descriptor Length - RW */
 910 #define E1000_TDH      0x03810  /* TX Descriptor Head - RW */
 911 #define E1000_TDT      0x03818  /* TX Descripotr Tail - RW */
 912 #define E1000_TIDV     0x03820  /* TX Interrupt Delay Value - RW */
 913 #define E1000_TXDCTL   0x03828  /* TX Descriptor Control - RW */
 914 #define E1000_TADV     0x0382C  /* TX Interrupt Absolute Delay Val - RW */
 915 #define E1000_TSPMT    0x03830  /* TCP Segmentation PAD & Min Threshold - RW */
 916 #define E1000_TARC0    0x03840 /* TX Arbitration Count (0) */
 917 #define E1000_TDBAL1   0x03900 /* TX Desc Base Address Low (1) - RW */
 918 #define E1000_TDBAH1   0x03904 /* TX Desc Base Address High (1) - RW */
 919 #define E1000_TDLEN1   0x03908 /* TX Desc Length (1) - RW */
 920 #define E1000_TDH1     0x03910 /* TX Desc Head (1) - RW */
 921 #define E1000_TDT1     0x03918 /* TX Desc Tail (1) - RW */
 922 #define E1000_TXDCTL1  0x03928 /* TX Descriptor Control (1) - RW */
 923 #define E1000_TARC1    0x03940 /* TX Arbitration Count (1) */
 924 #define E1000_CRCERRS  0x04000  /* CRC Error Count - R/clr */
 925 #define E1000_ALGNERRC 0x04004  /* Alignment Error Count - R/clr */
 926 #define E1000_SYMERRS  0x04008  /* Symbol Error Count - R/clr */
 927 #define E1000_RXERRC   0x0400C  /* Receive Error Count - R/clr */
 928 #define E1000_MPC      0x04010  /* Missed Packet Count - R/clr */
 929 #define E1000_SCC      0x04014  /* Single Collision Count - R/clr */
 930 #define E1000_ECOL     0x04018  /* Excessive Collision Count - R/clr */
 931 #define E1000_MCC      0x0401C  /* Multiple Collision Count - R/clr */
 932 #define E1000_LATECOL  0x04020  /* Late Collision Count - R/clr */
 933 #define E1000_COLC     0x04028  /* Collision Count - R/clr */
 934 #define E1000_DC       0x04030  /* Defer Count - R/clr */
 935 #define E1000_TNCRS    0x04034  /* TX-No CRS - R/clr */
 936 #define E1000_SEC      0x04038  /* Sequence Error Count - R/clr */
 937 #define E1000_CEXTERR  0x0403C  /* Carrier Extension Error Count - R/clr */
 938 #define E1000_RLEC     0x04040  /* Receive Length Error Count - R/clr */
 939 #define E1000_XONRXC   0x04048  /* XON RX Count - R/clr */
 940 #define E1000_XONTXC   0x0404C  /* XON TX Count - R/clr */
 941 #define E1000_XOFFRXC  0x04050  /* XOFF RX Count - R/clr */
 942 #define E1000_XOFFTXC  0x04054  /* XOFF TX Count - R/clr */
 943 #define E1000_FCRUC    0x04058  /* Flow Control RX Unsupported Count- R/clr */
 944 #define E1000_PRC64    0x0405C  /* Packets RX (64 bytes) - R/clr */
 945 #define E1000_PRC127   0x04060  /* Packets RX (65-127 bytes) - R/clr */
 946 #define E1000_PRC255   0x04064  /* Packets RX (128-255 bytes) - R/clr */
 947 #define E1000_PRC511   0x04068  /* Packets RX (255-511 bytes) - R/clr */
 948 #define E1000_PRC1023  0x0406C  /* Packets RX (512-1023 bytes) - R/clr */
 949 #define E1000_PRC1522  0x04070  /* Packets RX (1024-1522 bytes) - R/clr */
 950 #define E1000_GPRC     0x04074  /* Good Packets RX Count - R/clr */
 951 #define E1000_BPRC     0x04078  /* Broadcast Packets RX Count - R/clr */
 952 #define E1000_MPRC     0x0407C  /* Multicast Packets RX Count - R/clr */
 953 #define E1000_GPTC     0x04080  /* Good Packets TX Count - R/clr */
 954 #define E1000_GORCL    0x04088  /* Good Octets RX Count Low - R/clr */
 955 #define E1000_GORCH    0x0408C  /* Good Octets RX Count High - R/clr */
 956 #define E1000_GOTCL    0x04090  /* Good Octets TX Count Low - R/clr */
 957 #define E1000_GOTCH    0x04094  /* Good Octets TX Count High - R/clr */
 958 #define E1000_RNBC     0x040A0  /* RX No Buffers Count - R/clr */
 959 #define E1000_RUC      0x040A4  /* RX Undersize Count - R/clr */
 960 #define E1000_RFC      0x040A8  /* RX Fragment Count - R/clr */
 961 #define E1000_ROC      0x040AC  /* RX Oversize Count - R/clr */
 962 #define E1000_RJC      0x040B0  /* RX Jabber Count - R/clr */
 963 #define E1000_MGTPRC   0x040B4  /* Management Packets RX Count - R/clr */
 964 #define E1000_MGTPDC   0x040B8  /* Management Packets Dropped Count - R/clr */
 965 #define E1000_MGTPTC   0x040BC  /* Management Packets TX Count - R/clr */
 966 #define E1000_TORL     0x040C0  /* Total Octets RX Low - R/clr */
 967 #define E1000_TORH     0x040C4  /* Total Octets RX High - R/clr */
 968 #define E1000_TOTL     0x040C8  /* Total Octets TX Low - R/clr */
 969 #define E1000_TOTH     0x040CC  /* Total Octets TX High - R/clr */
 970 #define E1000_TPR      0x040D0  /* Total Packets RX - R/clr */
 971 #define E1000_TPT      0x040D4  /* Total Packets TX - R/clr */
 972 #define E1000_PTC64    0x040D8  /* Packets TX (64 bytes) - R/clr */
 973 #define E1000_PTC127   0x040DC  /* Packets TX (65-127 bytes) - R/clr */
 974 #define E1000_PTC255   0x040E0  /* Packets TX (128-255 bytes) - R/clr */
 975 #define E1000_PTC511   0x040E4  /* Packets TX (256-511 bytes) - R/clr */
 976 #define E1000_PTC1023  0x040E8  /* Packets TX (512-1023 bytes) - R/clr */
 977 #define E1000_PTC1522  0x040EC  /* Packets TX (1024-1522 Bytes) - R/clr */
 978 #define E1000_MPTC     0x040F0  /* Multicast Packets TX Count - R/clr */
 979 #define E1000_BPTC     0x040F4  /* Broadcast Packets TX Count - R/clr */
 980 #define E1000_TSCTC    0x040F8  /* TCP Segmentation Context TX - R/clr */
 981 #define E1000_TSCTFC   0x040FC  /* TCP Segmentation Context TX Fail - R/clr */
 982 #define E1000_IAC       0x4100  /* Interrupt Assertion Count */
 983 #define E1000_ICRXPTC   0x4104  /* Interrupt Cause Rx Packet Timer Expire Count */
 984 #define E1000_ICRXATC   0x4108  /* Interrupt Cause Rx Absolute Timer Expire Count */
 985 #define E1000_ICTXPTC   0x410C  /* Interrupt Cause Tx Packet Timer Expire Count */
 986 #define E1000_ICTXATC   0x4110  /* Interrupt Cause Tx Absolute Timer Expire Count */
 987 #define E1000_ICTXQEC   0x4118  /* Interrupt Cause Tx Queue Empty Count */
 988 #define E1000_ICTXQMTC  0x411C  /* Interrupt Cause Tx Queue Minimum Threshold Count */
 989 #define E1000_ICRXDMTC  0x4120  /* Interrupt Cause Rx Descriptor Minimum Threshold Count */
 990 #define E1000_ICRXOC    0x4124  /* Interrupt Cause Receiver Overrun Count */
 991 #define E1000_RXCSUM   0x05000  /* RX Checksum Control - RW */
 992 #define E1000_RFCTL    0x05008  /* Receive Filter Control*/
 993 #define E1000_MTA      0x05200  /* Multicast Table Array - RW Array */
 994 #define E1000_RA       0x05400  /* Receive Address - RW Array */
 995 #define E1000_VFTA     0x05600  /* VLAN Filter Table Array - RW Array */
 996 #define E1000_WUC      0x05800  /* Wakeup Control - RW */
 997 #define E1000_WUFC     0x05808  /* Wakeup Filter Control - RW */
 998 #define E1000_WUS      0x05810  /* Wakeup Status - RO */
 999 #define E1000_MANC     0x05820  /* Management Control - RW */
1000 #define E1000_IPAV     0x05838  /* IP Address Valid - RW */
1001 #define E1000_IP4AT    0x05840  /* IPv4 Address Table - RW Array */
1002 #define E1000_IP6AT    0x05880  /* IPv6 Address Table - RW Array */
1003 #define E1000_WUPL     0x05900  /* Wakeup Packet Length - RW */
1004 #define E1000_WUPM     0x05A00  /* Wakeup Packet Memory - RO A */
1005 #define E1000_FFLT     0x05F00  /* Flexible Filter Length Table - RW Array */
1006 #define E1000_HOST_IF  0x08800  /* Host Interface */
1007 #define E1000_FFMT     0x09000  /* Flexible Filter Mask Table - RW Array */
1008 #define E1000_FFVT     0x09800  /* Flexible Filter Value Table - RW Array */
1009
1010 #define E1000_GCR       0x05B00 /* PCI-Ex Control */
1011 #define E1000_GSCL_1    0x05B10 /* PCI-Ex Statistic Control #1 */
1012 #define E1000_GSCL_2    0x05B14 /* PCI-Ex Statistic Control #2 */
1013 #define E1000_GSCL_3    0x05B18 /* PCI-Ex Statistic Control #3 */
1014 #define E1000_GSCL_4    0x05B1C /* PCI-Ex Statistic Control #4 */
1015 #define E1000_FACTPS    0x05B30 /* Function Active and Power State to MNG */
1016 #define E1000_SWSM      0x05B50 /* SW Semaphore */
1017 #define E1000_FWSM      0x05B54 /* FW Semaphore */
1018 #define E1000_FFLT_DBG  0x05F04 /* Debug Register */
1019 #define E1000_HICR      0x08F00 /* Host Inteface Control */
1020 /* Register Set (82542)
1021  *
1022  * Some of the 82542 registers are located at different offsets than they are
1023  * in more current versions of the 8254x. Despite the difference in location,
1024  * the registers function in the same manner.
1025  */
1026 #define E1000_82542_CTRL     E1000_CTRL
1027 #define E1000_82542_CTRL_DUP E1000_CTRL_DUP
1028 #define E1000_82542_STATUS   E1000_STATUS
1029 #define E1000_82542_EECD     E1000_EECD
1030 #define E1000_82542_EERD     E1000_EERD
1031 #define E1000_82542_CTRL_EXT E1000_CTRL_EXT
1032 #define E1000_82542_FLA      E1000_FLA
1033 #define E1000_82542_MDIC     E1000_MDIC
1034 #define E1000_82542_FCAL     E1000_FCAL
1035 #define E1000_82542_FCAH     E1000_FCAH
1036 #define E1000_82542_FCT      E1000_FCT
1037 #define E1000_82542_VET      E1000_VET
1038 #define E1000_82542_RA       0x00040
1039 #define E1000_82542_ICR      E1000_ICR
1040 #define E1000_82542_ITR      E1000_ITR
1041 #define E1000_82542_ICS      E1000_ICS
1042 #define E1000_82542_IMS      E1000_IMS
1043 #define E1000_82542_IMC      E1000_IMC
1044 #define E1000_82542_RCTL     E1000_RCTL
1045 #define E1000_82542_RDTR     0x00108
1046 #define E1000_82542_RDBAL    0x00110
1047 #define E1000_82542_RDBAH    0x00114
1048 #define E1000_82542_RDLEN    0x00118
1049 #define E1000_82542_RDH      0x00120
1050 #define E1000_82542_RDT      0x00128
1051 #define E1000_82542_FCRTH    0x00160
1052 #define E1000_82542_FCRTL    0x00168
1053 #define E1000_82542_FCTTV    E1000_FCTTV
1054 #define E1000_82542_TXCW     E1000_TXCW
1055 #define E1000_82542_RXCW     E1000_RXCW
1056 #define E1000_82542_MTA      0x00200
1057 #define E1000_82542_TCTL     E1000_TCTL
1058 #define E1000_82542_TIPG     E1000_TIPG
1059 #define E1000_82542_TDBAL    0x00420
1060 #define E1000_82542_TDBAH    0x00424
1061 #define E1000_82542_TDLEN    0x00428
1062 #define E1000_82542_TDH      0x00430
1063 #define E1000_82542_TDT      0x00438
1064 #define E1000_82542_TIDV     0x00440
1065 #define E1000_82542_TBT      E1000_TBT
1066 #define E1000_82542_AIT      E1000_AIT
1067 #define E1000_82542_VFTA     0x00600
1068 #define E1000_82542_LEDCTL   E1000_LEDCTL
1069 #define E1000_82542_PBA      E1000_PBA
1070 #define E1000_82542_PBS      E1000_PBS
1071 #define E1000_82542_EEMNGCTL E1000_EEMNGCTL
1072 #define E1000_82542_EEARBC   E1000_EEARBC
1073 #define E1000_82542_FLASHT   E1000_FLASHT
1074 #define E1000_82542_EEWR     E1000_EEWR
1075 #define E1000_82542_FLSWCTL  E1000_FLSWCTL
1076 #define E1000_82542_FLSWDATA E1000_FLSWDATA
1077 #define E1000_82542_FLSWCNT  E1000_FLSWCNT
1078 #define E1000_82542_FLOP     E1000_FLOP
1079 #define E1000_82542_EXTCNF_CTRL  E1000_EXTCNF_CTRL
1080 #define E1000_82542_EXTCNF_SIZE  E1000_EXTCNF_SIZE
1081 #define E1000_82542_ERT      E1000_ERT
1082 #define E1000_82542_RXDCTL   E1000_RXDCTL
1083 #define E1000_82542_RADV     E1000_RADV
1084 #define E1000_82542_RSRPD    E1000_RSRPD
1085 #define E1000_82542_TXDMAC   E1000_TXDMAC
1086 #define E1000_82542_TDFHS    E1000_TDFHS
1087 #define E1000_82542_TDFTS    E1000_TDFTS
1088 #define E1000_82542_TDFPC    E1000_TDFPC
1089 #define E1000_82542_TXDCTL   E1000_TXDCTL
1090 #define E1000_82542_TADV     E1000_TADV
1091 #define E1000_82542_TSPMT    E1000_TSPMT
1092 #define E1000_82542_CRCERRS  E1000_CRCERRS
1093 #define E1000_82542_ALGNERRC E1000_ALGNERRC
1094 #define E1000_82542_SYMERRS  E1000_SYMERRS
1095 #define E1000_82542_RXERRC   E1000_RXERRC
1096 #define E1000_82542_MPC      E1000_MPC
1097 #define E1000_82542_SCC      E1000_SCC
1098 #define E1000_82542_ECOL     E1000_ECOL
1099 #define E1000_82542_MCC      E1000_MCC
1100 #define E1000_82542_LATECOL  E1000_LATECOL
1101 #define E1000_82542_COLC     E1000_COLC
1102 #define E1000_82542_DC       E1000_DC
1103 #define E1000_82542_TNCRS    E1000_TNCRS
1104 #define E1000_82542_SEC      E1000_SEC
1105 #define E1000_82542_CEXTERR  E1000_CEXTERR
1106 #define E1000_82542_RLEC     E1000_RLEC
1107 #define E1000_82542_XONRXC   E1000_XONRXC
1108 #define E1000_82542_XONTXC   E1000_XONTXC
1109 #define E1000_82542_XOFFRXC  E1000_XOFFRXC
1110 #define E1000_82542_XOFFTXC  E1000_XOFFTXC
1111 #define E1000_82542_FCRUC    E1000_FCRUC
1112 #define E1000_82542_PRC64    E1000_PRC64
1113 #define E1000_82542_PRC127   E1000_PRC127
1114 #define E1000_82542_PRC255   E1000_PRC255
1115 #define E1000_82542_PRC511   E1000_PRC511
1116 #define E1000_82542_PRC1023  E1000_PRC1023
1117 #define E1000_82542_PRC1522  E1000_PRC1522
1118 #define E1000_82542_GPRC     E1000_GPRC
1119 #define E1000_82542_BPRC     E1000_BPRC
1120 #define E1000_82542_MPRC     E1000_MPRC
1121 #define E1000_82542_GPTC     E1000_GPTC
1122 #define E1000_82542_GORCL    E1000_GORCL
1123 #define E1000_82542_GORCH    E1000_GORCH
1124 #define E1000_82542_GOTCL    E1000_GOTCL
1125 #define E1000_82542_GOTCH    E1000_GOTCH
1126 #define E1000_82542_RNBC     E1000_RNBC
1127 #define E1000_82542_RUC      E1000_RUC
1128 #define E1000_82542_RFC      E1000_RFC
1129 #define E1000_82542_ROC      E1000_ROC
1130 #define E1000_82542_RJC      E1000_RJC
1131 #define E1000_82542_MGTPRC   E1000_MGTPRC
1132 #define E1000_82542_MGTPDC   E1000_MGTPDC
1133 #define E1000_82542_MGTPTC   E1000_MGTPTC
1134 #define E1000_82542_TORL     E1000_TORL
1135 #define E1000_82542_TORH     E1000_TORH
1136 #define E1000_82542_TOTL     E1000_TOTL
1137 #define E1000_82542_TOTH     E1000_TOTH
1138 #define E1000_82542_TPR      E1000_TPR
1139 #define E1000_82542_TPT      E1000_TPT
1140 #define E1000_82542_PTC64    E1000_PTC64
1141 #define E1000_82542_PTC127   E1000_PTC127
1142 #define E1000_82542_PTC255   E1000_PTC255
1143 #define E1000_82542_PTC511   E1000_PTC511
1144 #define E1000_82542_PTC1023  E1000_PTC1023
1145 #define E1000_82542_PTC1522  E1000_PTC1522
1146 #define E1000_82542_MPTC     E1000_MPTC
1147 #define E1000_82542_BPTC     E1000_BPTC
1148 #define E1000_82542_TSCTC    E1000_TSCTC
1149 #define E1000_82542_TSCTFC   E1000_TSCTFC
1150 #define E1000_82542_RXCSUM   E1000_RXCSUM
1151 #define E1000_82542_WUC      E1000_WUC
1152 #define E1000_82542_WUFC     E1000_WUFC
1153 #define E1000_82542_WUS      E1000_WUS
1154 #define E1000_82542_MANC     E1000_MANC
1155 #define E1000_82542_IPAV     E1000_IPAV
1156 #define E1000_82542_IP4AT    E1000_IP4AT
1157 #define E1000_82542_IP6AT    E1000_IP6AT
1158 #define E1000_82542_WUPL     E1000_WUPL
1159 #define E1000_82542_WUPM     E1000_WUPM
1160 #define E1000_82542_FFLT     E1000_FFLT
1161 #define E1000_82542_TDFH     0x08010
1162 #define E1000_82542_TDFT     0x08018
1163 #define E1000_82542_FFMT     E1000_FFMT
1164 #define E1000_82542_FFVT     E1000_FFVT
1165 #define E1000_82542_HOST_IF  E1000_HOST_IF
1166 #define E1000_82542_IAM         E1000_IAM
1167 #define E1000_82542_EEMNGCTL    E1000_EEMNGCTL
1168 #define E1000_82542_PSRCTL      E1000_PSRCTL
1169 #define E1000_82542_RAID        E1000_RAID
1170 #define E1000_82542_TARC0       E1000_TARC0
1171 #define E1000_82542_TDBAL1      E1000_TDBAL1
1172 #define E1000_82542_TDBAH1      E1000_TDBAH1
1173 #define E1000_82542_TDLEN1      E1000_TDLEN1
1174 #define E1000_82542_TDH1        E1000_TDH1
1175 #define E1000_82542_TDT1        E1000_TDT1
1176 #define E1000_82542_TXDCTL1     E1000_TXDCTL1
1177 #define E1000_82542_TARC1       E1000_TARC1
1178 #define E1000_82542_RFCTL       E1000_RFCTL
1179 #define E1000_82542_GCR         E1000_GCR
1180 #define E1000_82542_GSCL_1      E1000_GSCL_1
1181 #define E1000_82542_GSCL_2      E1000_GSCL_2
1182 #define E1000_82542_GSCL_3      E1000_GSCL_3
1183 #define E1000_82542_GSCL_4      E1000_GSCL_4
1184 #define E1000_82542_FACTPS      E1000_FACTPS
1185 #define E1000_82542_SWSM        E1000_SWSM
1186 #define E1000_82542_FWSM        E1000_FWSM
1187 #define E1000_82542_FFLT_DBG    E1000_FFLT_DBG
1188 #define E1000_82542_IAC         E1000_IAC
1189 #define E1000_82542_ICRXPTC     E1000_ICRXPTC
1190 #define E1000_82542_ICRXATC     E1000_ICRXATC
1191 #define E1000_82542_ICTXPTC     E1000_ICTXPTC
1192 #define E1000_82542_ICTXATC     E1000_ICTXATC
1193 #define E1000_82542_ICTXQEC     E1000_ICTXQEC
1194 #define E1000_82542_ICTXQMTC    E1000_ICTXQMTC
1195 #define E1000_82542_ICRXDMTC    E1000_ICRXDMTC
1196 #define E1000_82542_ICRXOC      E1000_ICRXOC
1197 #define E1000_82542_HICR        E1000_HICR
1198
1199 /* Statistics counters collected by the MAC */
1200 struct e1000_hw_stats {
1201     uint64_t crcerrs;
1202     uint64_t algnerrc;
1203     uint64_t symerrs;
1204     uint64_t rxerrc;
1205     uint64_t mpc;
1206     uint64_t scc;
1207     uint64_t ecol;
1208     uint64_t mcc;
1209     uint64_t latecol;
1210     uint64_t colc;
1211     uint64_t dc;
1212     uint64_t tncrs;
1213     uint64_t sec;
1214     uint64_t cexterr;
1215     uint64_t rlec;
1216     uint64_t xonrxc;
1217     uint64_t xontxc;
1218     uint64_t xoffrxc;
1219     uint64_t xofftxc;
1220     uint64_t fcruc;
1221     uint64_t prc64;
1222     uint64_t prc127;
1223     uint64_t prc255;
1224     uint64_t prc511;
1225     uint64_t prc1023;
1226     uint64_t prc1522;
1227     uint64_t gprc;
1228     uint64_t bprc;
1229     uint64_t mprc;
1230     uint64_t gptc;
1231     uint64_t gorcl;
1232     uint64_t gorch;
1233     uint64_t gotcl;
1234     uint64_t gotch;
1235     uint64_t rnbc;
1236     uint64_t ruc;
1237     uint64_t rfc;
1238     uint64_t roc;
1239     uint64_t rjc;
1240     uint64_t mgprc;
1241     uint64_t mgpdc;
1242     uint64_t mgptc;
1243     uint64_t torl;
1244     uint64_t torh;
1245     uint64_t totl;
1246     uint64_t toth;
1247     uint64_t tpr;
1248     uint64_t tpt;
1249     uint64_t ptc64;
1250     uint64_t ptc127;
1251     uint64_t ptc255;
1252     uint64_t ptc511;
1253     uint64_t ptc1023;
1254     uint64_t ptc1522;
1255     uint64_t mptc;
1256     uint64_t bptc;
1257     uint64_t tsctc;
1258     uint64_t tsctfc;
1259     uint64_t iac;
1260     uint64_t icrxptc;
1261     uint64_t icrxatc;
1262     uint64_t ictxptc;
1263     uint64_t ictxatc;
1264     uint64_t ictxqec;
1265     uint64_t ictxqmtc;
1266     uint64_t icrxdmtc;
1267     uint64_t icrxoc;
1268 };
1269
1270 /* Structure containing variables used by the shared code (e1000_hw.c) */
1271 struct e1000_hw {
1272     uint8_t *hw_addr;
1273     uint8_t *flash_address;
1274     e1000_mac_type mac_type;
1275     e1000_phy_type phy_type;
1276     uint32_t phy_init_script;
1277     e1000_media_type media_type;
1278     void *back;
1279     e1000_fc_type fc;
1280     e1000_bus_speed bus_speed;
1281     e1000_bus_width bus_width;
1282     e1000_bus_type bus_type;
1283     struct e1000_eeprom_info eeprom;
1284     e1000_ms_type master_slave;
1285     e1000_ms_type original_master_slave;
1286     e1000_ffe_config ffe_config_state;
1287     uint32_t asf_firmware_present;
1288     uint32_t eeprom_semaphore_present;
1289     unsigned long io_base;
1290     uint32_t phy_id;
1291     uint32_t phy_revision;
1292     uint32_t phy_addr;
1293     uint32_t original_fc;
1294     uint32_t txcw;
1295     uint32_t autoneg_failed;
1296     uint32_t max_frame_size;
1297     uint32_t min_frame_size;
1298     uint32_t mc_filter_type;
1299     uint32_t num_mc_addrs;
1300     uint32_t collision_delta;
1301     uint32_t tx_packet_delta;
1302     uint32_t ledctl_default;
1303     uint32_t ledctl_mode1;
1304     uint32_t ledctl_mode2;
1305     boolean_t tx_pkt_filtering;
1306     struct e1000_host_mng_dhcp_cookie mng_cookie;
1307     uint16_t phy_spd_default;
1308     uint16_t autoneg_advertised;
1309     uint16_t pci_cmd_word;
1310     uint16_t fc_high_water;
1311     uint16_t fc_low_water;
1312     uint16_t fc_pause_time;
1313     uint16_t current_ifs_val;
1314     uint16_t ifs_min_val;
1315     uint16_t ifs_max_val;
1316     uint16_t ifs_step_size;
1317     uint16_t ifs_ratio;
1318     uint16_t device_id;
1319     uint16_t vendor_id;
1320     uint16_t subsystem_id;
1321     uint16_t subsystem_vendor_id;
1322     uint8_t revision_id;
1323     uint8_t autoneg;
1324     uint8_t mdix;
1325     uint8_t forced_speed_duplex;
1326     uint8_t wait_autoneg_complete;
1327     uint8_t dma_fairness;
1328     uint8_t mac_addr[NODE_ADDRESS_SIZE];
1329     uint8_t perm_mac_addr[NODE_ADDRESS_SIZE];
1330     boolean_t disable_polarity_correction;
1331     boolean_t speed_downgraded;
1332     e1000_smart_speed smart_speed;
1333     e1000_dsp_config dsp_config_state;
1334     boolean_t get_link_status;
1335     boolean_t serdes_link_down;
1336     boolean_t tbi_compatibility_en;
1337     boolean_t tbi_compatibility_on;
1338     boolean_t phy_reset_disable;
1339     boolean_t fc_send_xon;
1340     boolean_t fc_strict_ieee;
1341     boolean_t report_tx_early;
1342     boolean_t adaptive_ifs;
1343     boolean_t ifs_params_forced;
1344     boolean_t in_ifs_mode;
1345     boolean_t mng_reg_access_disabled;
1346 };
1347
1348
1349 #define E1000_EEPROM_SWDPIN0   0x0001   /* SWDPIN 0 EEPROM Value */
1350 #define E1000_EEPROM_LED_LOGIC 0x0020   /* Led Logic Word */
1351 #define E1000_EEPROM_RW_REG_DATA   16   /* Offset to data in EEPROM read/write registers */
1352 #define E1000_EEPROM_RW_REG_DONE   2    /* Offset to READ/WRITE done bit */
1353 #define E1000_EEPROM_RW_REG_START  1    /* First bit for telling part to start operation */
1354 #define E1000_EEPROM_RW_ADDR_SHIFT 2    /* Shift to the address bits */
1355 #define E1000_EEPROM_POLL_WRITE    1    /* Flag for polling for write complete */
1356 #define E1000_EEPROM_POLL_READ     0    /* Flag for polling for read complete */
1357 /* Register Bit Masks */
1358 /* Device Control */
1359 #define E1000_CTRL_FD       0x00000001  /* Full duplex.0=half; 1=full */
1360 #define E1000_CTRL_BEM      0x00000002  /* Endian Mode.0=little,1=big */
1361 #define E1000_CTRL_PRIOR    0x00000004  /* Priority on PCI. 0=rx,1=fair */
1362 #define E1000_CTRL_GIO_MASTER_DISABLE 0x00000004 /*Blocks new Master requests */
1363 #define E1000_CTRL_LRST     0x00000008  /* Link reset. 0=normal,1=reset */
1364 #define E1000_CTRL_TME      0x00000010  /* Test mode. 0=normal,1=test */
1365 #define E1000_CTRL_SLE      0x00000020  /* Serial Link on 0=dis,1=en */
1366 #define E1000_CTRL_ASDE     0x00000020  /* Auto-speed detect enable */
1367 #define E1000_CTRL_SLU      0x00000040  /* Set link up (Force Link) */
1368 #define E1000_CTRL_ILOS     0x00000080  /* Invert Loss-Of Signal */
1369 #define E1000_CTRL_SPD_SEL  0x00000300  /* Speed Select Mask */
1370 #define E1000_CTRL_SPD_10   0x00000000  /* Force 10Mb */
1371 #define E1000_CTRL_SPD_100  0x00000100  /* Force 100Mb */
1372 #define E1000_CTRL_SPD_1000 0x00000200  /* Force 1Gb */
1373 #define E1000_CTRL_BEM32    0x00000400  /* Big Endian 32 mode */
1374 #define E1000_CTRL_FRCSPD   0x00000800  /* Force Speed */
1375 #define E1000_CTRL_FRCDPX   0x00001000  /* Force Duplex */
1376 #define E1000_CTRL_D_UD_POLARITY 0x00004000 /* Defined polarity of Dock/Undock indication in SDP[0] */
1377 #define E1000_CTRL_SWDPIN0  0x00040000  /* SWDPIN 0 value */
1378 #define E1000_CTRL_SWDPIN1  0x00080000  /* SWDPIN 1 value */
1379 #define E1000_CTRL_SWDPIN2  0x00100000  /* SWDPIN 2 value */
1380 #define E1000_CTRL_SWDPIN3  0x00200000  /* SWDPIN 3 value */
1381 #define E1000_CTRL_SWDPIO0  0x00400000  /* SWDPIN 0 Input or output */
1382 #define E1000_CTRL_SWDPIO1  0x00800000  /* SWDPIN 1 input or output */
1383 #define E1000_CTRL_SWDPIO2  0x01000000  /* SWDPIN 2 input or output */
1384 #define E1000_CTRL_SWDPIO3  0x02000000  /* SWDPIN 3 input or output */
1385 #define E1000_CTRL_RST      0x04000000  /* Global reset */
1386 #define E1000_CTRL_RFCE     0x08000000  /* Receive Flow Control enable */
1387 #define E1000_CTRL_TFCE     0x10000000  /* Transmit flow control enable */
1388 #define E1000_CTRL_RTE      0x20000000  /* Routing tag enable */
1389 #define E1000_CTRL_VME      0x40000000  /* IEEE VLAN mode enable */
1390 #define E1000_CTRL_PHY_RST  0x80000000  /* PHY Reset */
1391
1392 /* Device Status */
1393 #define E1000_STATUS_FD         0x00000001      /* Full duplex.0=half,1=full */
1394 #define E1000_STATUS_LU         0x00000002      /* Link up.0=no,1=link */
1395 #define E1000_STATUS_FUNC_MASK  0x0000000C      /* PCI Function Mask */
1396 #define E1000_STATUS_FUNC_SHIFT 2
1397 #define E1000_STATUS_FUNC_0     0x00000000      /* Function 0 */
1398 #define E1000_STATUS_FUNC_1     0x00000004      /* Function 1 */
1399 #define E1000_STATUS_TXOFF      0x00000010      /* transmission paused */
1400 #define E1000_STATUS_TBIMODE    0x00000020      /* TBI mode */
1401 #define E1000_STATUS_SPEED_MASK 0x000000C0
1402 #define E1000_STATUS_SPEED_10   0x00000000      /* Speed 10Mb/s */
1403 #define E1000_STATUS_SPEED_100  0x00000040      /* Speed 100Mb/s */
1404 #define E1000_STATUS_SPEED_1000 0x00000080      /* Speed 1000Mb/s */
1405 #define E1000_STATUS_ASDV       0x00000300      /* Auto speed detect value */
1406 #define E1000_STATUS_DOCK_CI    0x00000800      /* Change in Dock/Undock state. Clear on write '0'. */
1407 #define E1000_STATUS_GIO_MASTER_ENABLE 0x00080000 /* Status of Master requests. */
1408 #define E1000_STATUS_MTXCKOK    0x00000400      /* MTX clock running OK */
1409 #define E1000_STATUS_PCI66      0x00000800      /* In 66Mhz slot */
1410 #define E1000_STATUS_BUS64      0x00001000      /* In 64 bit slot */
1411 #define E1000_STATUS_PCIX_MODE  0x00002000      /* PCI-X mode */
1412 #define E1000_STATUS_PCIX_SPEED 0x0000C000      /* PCI-X bus speed */
1413
1414 /* Constants used to intrepret the masked PCI-X bus speed. */
1415 #define E1000_STATUS_PCIX_SPEED_66  0x00000000 /* PCI-X bus speed  50-66 MHz */
1416 #define E1000_STATUS_PCIX_SPEED_100 0x00004000 /* PCI-X bus speed  66-100 MHz */
1417 #define E1000_STATUS_PCIX_SPEED_133 0x00008000 /* PCI-X bus speed 100-133 MHz */
1418
1419 /* EEPROM/Flash Control */
1420 #define E1000_EECD_SK        0x00000001 /* EEPROM Clock */
1421 #define E1000_EECD_CS        0x00000002 /* EEPROM Chip Select */
1422 #define E1000_EECD_DI        0x00000004 /* EEPROM Data In */
1423 #define E1000_EECD_DO        0x00000008 /* EEPROM Data Out */
1424 #define E1000_EECD_FWE_MASK  0x00000030
1425 #define E1000_EECD_FWE_DIS   0x00000010 /* Disable FLASH writes */
1426 #define E1000_EECD_FWE_EN    0x00000020 /* Enable FLASH writes */
1427 #define E1000_EECD_FWE_SHIFT 4
1428 #define E1000_EECD_REQ       0x00000040 /* EEPROM Access Request */
1429 #define E1000_EECD_GNT       0x00000080 /* EEPROM Access Grant */
1430 #define E1000_EECD_PRES      0x00000100 /* EEPROM Present */
1431 #define E1000_EECD_SIZE      0x00000200 /* EEPROM Size (0=64 word 1=256 word) */
1432 #define E1000_EECD_ADDR_BITS 0x00000400 /* EEPROM Addressing bits based on type
1433                                          * (0-small, 1-large) */
1434 #define E1000_EECD_TYPE      0x00002000 /* EEPROM Type (1-SPI, 0-Microwire) */
1435 #ifndef E1000_EEPROM_GRANT_ATTEMPTS
1436 #define E1000_EEPROM_GRANT_ATTEMPTS 1000 /* EEPROM # attempts to gain grant */
1437 #endif
1438 #define E1000_EECD_AUTO_RD          0x00000200  /* EEPROM Auto Read done */
1439 #define E1000_EECD_SIZE_EX_MASK     0x00007800  /* EEprom Size */
1440 #define E1000_EECD_SIZE_EX_SHIFT    11
1441 #define E1000_EECD_NVADDS    0x00018000 /* NVM Address Size */
1442 #define E1000_EECD_SELSHAD   0x00020000 /* Select Shadow RAM */
1443 #define E1000_EECD_INITSRAM  0x00040000 /* Initialize Shadow RAM */
1444 #define E1000_EECD_FLUPD     0x00080000 /* Update FLASH */
1445 #define E1000_EECD_AUPDEN    0x00100000 /* Enable Autonomous FLASH update */
1446 #define E1000_EECD_SHADV     0x00200000 /* Shadow RAM Data Valid */
1447 #define E1000_EECD_SEC1VAL   0x00400000 /* Sector One Valid */
1448 #define E1000_STM_OPCODE     0xDB00
1449 #define E1000_HICR_FW_RESET  0xC0
1450
1451 /* EEPROM Read */
1452 #define E1000_EERD_START      0x00000001 /* Start Read */
1453 #define E1000_EERD_DONE       0x00000010 /* Read Done */
1454 #define E1000_EERD_ADDR_SHIFT 8
1455 #define E1000_EERD_ADDR_MASK  0x0000FF00 /* Read Address */
1456 #define E1000_EERD_DATA_SHIFT 16
1457 #define E1000_EERD_DATA_MASK  0xFFFF0000 /* Read Data */
1458
1459 /* SPI EEPROM Status Register */
1460 #define EEPROM_STATUS_RDY_SPI  0x01
1461 #define EEPROM_STATUS_WEN_SPI  0x02
1462 #define EEPROM_STATUS_BP0_SPI  0x04
1463 #define EEPROM_STATUS_BP1_SPI  0x08
1464 #define EEPROM_STATUS_WPEN_SPI 0x80
1465
1466 /* Extended Device Control */
1467 #define E1000_CTRL_EXT_GPI0_EN   0x00000001 /* Maps SDP4 to GPI0 */
1468 #define E1000_CTRL_EXT_GPI1_EN   0x00000002 /* Maps SDP5 to GPI1 */
1469 #define E1000_CTRL_EXT_PHYINT_EN E1000_CTRL_EXT_GPI1_EN
1470 #define E1000_CTRL_EXT_GPI2_EN   0x00000004 /* Maps SDP6 to GPI2 */
1471 #define E1000_CTRL_EXT_GPI3_EN   0x00000008 /* Maps SDP7 to GPI3 */
1472 #define E1000_CTRL_EXT_SDP4_DATA 0x00000010 /* Value of SW Defineable Pin 4 */
1473 #define E1000_CTRL_EXT_SDP5_DATA 0x00000020 /* Value of SW Defineable Pin 5 */
1474 #define E1000_CTRL_EXT_PHY_INT   E1000_CTRL_EXT_SDP5_DATA
1475 #define E1000_CTRL_EXT_SDP6_DATA 0x00000040 /* Value of SW Defineable Pin 6 */
1476 #define E1000_CTRL_EXT_SDP7_DATA 0x00000080 /* Value of SW Defineable Pin 7 */
1477 #define E1000_CTRL_EXT_SDP4_DIR  0x00000100 /* Direction of SDP4 0=in 1=out */
1478 #define E1000_CTRL_EXT_SDP5_DIR  0x00000200 /* Direction of SDP5 0=in 1=out */
1479 #define E1000_CTRL_EXT_SDP6_DIR  0x00000400 /* Direction of SDP6 0=in 1=out */
1480 #define E1000_CTRL_EXT_SDP7_DIR  0x00000800 /* Direction of SDP7 0=in 1=out */
1481 #define E1000_CTRL_EXT_ASDCHK    0x00001000 /* Initiate an ASD sequence */
1482 #define E1000_CTRL_EXT_EE_RST    0x00002000 /* Reinitialize from EEPROM */
1483 #define E1000_CTRL_EXT_IPS       0x00004000 /* Invert Power State */
1484 #define E1000_CTRL_EXT_SPD_BYPS  0x00008000 /* Speed Select Bypass */
1485 #define E1000_CTRL_EXT_LINK_MODE_MASK 0x00C00000
1486 #define E1000_CTRL_EXT_LINK_MODE_GMII 0x00000000
1487 #define E1000_CTRL_EXT_LINK_MODE_TBI  0x00C00000
1488 #define E1000_CTRL_EXT_WR_WMARK_MASK  0x03000000
1489 #define E1000_CTRL_EXT_WR_WMARK_256   0x00000000
1490 #define E1000_CTRL_EXT_WR_WMARK_320   0x01000000
1491 #define E1000_CTRL_EXT_WR_WMARK_384   0x02000000
1492 #define E1000_CTRL_EXT_WR_WMARK_448   0x03000000
1493 #define E1000_CTRL_EXT_IAME           0x08000000  /* Interrupt acknowledge Auto-mask */
1494 #define E1000_CTRL_EXT_INT_TIMER_CLR  0x20000000  /* Clear Interrupt timers after IMS clear */
1495
1496 /* MDI Control */
1497 #define E1000_MDIC_DATA_MASK 0x0000FFFF
1498 #define E1000_MDIC_REG_MASK  0x001F0000
1499 #define E1000_MDIC_REG_SHIFT 16
1500 #define E1000_MDIC_PHY_MASK  0x03E00000
1501 #define E1000_MDIC_PHY_SHIFT 21
1502 #define E1000_MDIC_OP_WRITE  0x04000000
1503 #define E1000_MDIC_OP_READ   0x08000000
1504 #define E1000_MDIC_READY     0x10000000
1505 #define E1000_MDIC_INT_EN    0x20000000
1506 #define E1000_MDIC_ERROR     0x40000000
1507
1508 /* LED Control */
1509 #define E1000_LEDCTL_LED0_MODE_MASK       0x0000000F
1510 #define E1000_LEDCTL_LED0_MODE_SHIFT      0
1511 #define E1000_LEDCTL_LED0_BLINK_RATE      0x0000020
1512 #define E1000_LEDCTL_LED0_IVRT            0x00000040
1513 #define E1000_LEDCTL_LED0_BLINK           0x00000080
1514 #define E1000_LEDCTL_LED1_MODE_MASK       0x00000F00
1515 #define E1000_LEDCTL_LED1_MODE_SHIFT      8
1516 #define E1000_LEDCTL_LED1_BLINK_RATE      0x0002000
1517 #define E1000_LEDCTL_LED1_IVRT            0x00004000
1518 #define E1000_LEDCTL_LED1_BLINK           0x00008000
1519 #define E1000_LEDCTL_LED2_MODE_MASK       0x000F0000
1520 #define E1000_LEDCTL_LED2_MODE_SHIFT      16
1521 #define E1000_LEDCTL_LED2_BLINK_RATE      0x00200000
1522 #define E1000_LEDCTL_LED2_IVRT            0x00400000
1523 #define E1000_LEDCTL_LED2_BLINK           0x00800000
1524 #define E1000_LEDCTL_LED3_MODE_MASK       0x0F000000
1525 #define E1000_LEDCTL_LED3_MODE_SHIFT      24
1526 #define E1000_LEDCTL_LED3_IVRT            0x40000000
1527 #define E1000_LEDCTL_LED3_BLINK           0x80000000
1528
1529 #define E1000_LEDCTL_MODE_LINK_10_1000  0x0
1530 #define E1000_LEDCTL_MODE_LINK_100_1000 0x1
1531 #define E1000_LEDCTL_MODE_LINK_UP       0x2
1532 #define E1000_LEDCTL_MODE_ACTIVITY      0x3
1533 #define E1000_LEDCTL_MODE_LINK_ACTIVITY 0x4
1534 #define E1000_LEDCTL_MODE_LINK_10       0x5
1535 #define E1000_LEDCTL_MODE_LINK_100      0x6
1536 #define E1000_LEDCTL_MODE_LINK_1000     0x7
1537 #define E1000_LEDCTL_MODE_PCIX_MODE     0x8
1538 #define E1000_LEDCTL_MODE_FULL_DUPLEX   0x9
1539 #define E1000_LEDCTL_MODE_COLLISION     0xA
1540 #define E1000_LEDCTL_MODE_BUS_SPEED     0xB
1541 #define E1000_LEDCTL_MODE_BUS_SIZE      0xC
1542 #define E1000_LEDCTL_MODE_PAUSED        0xD
1543 #define E1000_LEDCTL_MODE_LED_ON        0xE
1544 #define E1000_LEDCTL_MODE_LED_OFF       0xF
1545
1546 /* Receive Address */
1547 #define E1000_RAH_AV  0x80000000        /* Receive descriptor valid */
1548
1549 /* Interrupt Cause Read */
1550 #define E1000_ICR_TXDW          0x00000001 /* Transmit desc written back */
1551 #define E1000_ICR_TXQE          0x00000002 /* Transmit Queue empty */
1552 #define E1000_ICR_LSC           0x00000004 /* Link Status Change */
1553 #define E1000_ICR_RXSEQ         0x00000008 /* rx sequence error */
1554 #define E1000_ICR_RXDMT0        0x00000010 /* rx desc min. threshold (0) */
1555 #define E1000_ICR_RXO           0x00000040 /* rx overrun */
1556 #define E1000_ICR_RXT0          0x00000080 /* rx timer intr (ring 0) */
1557 #define E1000_ICR_MDAC          0x00000200 /* MDIO access complete */
1558 #define E1000_ICR_RXCFG         0x00000400 /* RX /c/ ordered set */
1559 #define E1000_ICR_GPI_EN0       0x00000800 /* GP Int 0 */
1560 #define E1000_ICR_GPI_EN1       0x00001000 /* GP Int 1 */
1561 #define E1000_ICR_GPI_EN2       0x00002000 /* GP Int 2 */
1562 #define E1000_ICR_GPI_EN3       0x00004000 /* GP Int 3 */
1563 #define E1000_ICR_TXD_LOW       0x00008000
1564 #define E1000_ICR_SRPD          0x00010000
1565 #define E1000_ICR_ACK           0x00020000 /* Receive Ack frame */
1566 #define E1000_ICR_MNG           0x00040000 /* Manageability event */
1567 #define E1000_ICR_DOCK          0x00080000 /* Dock/Undock */
1568 #define E1000_ICR_INT_ASSERTED  0x80000000 /* If this bit asserted, the driver should claim the interrupt */
1569
1570 /* Interrupt Cause Set */
1571 #define E1000_ICS_TXDW      E1000_ICR_TXDW      /* Transmit desc written back */
1572 #define E1000_ICS_TXQE      E1000_ICR_TXQE      /* Transmit Queue empty */
1573 #define E1000_ICS_LSC       E1000_ICR_LSC       /* Link Status Change */
1574 #define E1000_ICS_RXSEQ     E1000_ICR_RXSEQ     /* rx sequence error */
1575 #define E1000_ICS_RXDMT0    E1000_ICR_RXDMT0    /* rx desc min. threshold */
1576 #define E1000_ICS_RXO       E1000_ICR_RXO       /* rx overrun */
1577 #define E1000_ICS_RXT0      E1000_ICR_RXT0      /* rx timer intr */
1578 #define E1000_ICS_MDAC      E1000_ICR_MDAC      /* MDIO access complete */
1579 #define E1000_ICS_RXCFG     E1000_ICR_RXCFG     /* RX /c/ ordered set */
1580 #define E1000_ICS_GPI_EN0   E1000_ICR_GPI_EN0   /* GP Int 0 */
1581 #define E1000_ICS_GPI_EN1   E1000_ICR_GPI_EN1   /* GP Int 1 */
1582 #define E1000_ICS_GPI_EN2   E1000_ICR_GPI_EN2   /* GP Int 2 */
1583 #define E1000_ICS_GPI_EN3   E1000_ICR_GPI_EN3   /* GP Int 3 */
1584 #define E1000_ICS_TXD_LOW   E1000_ICR_TXD_LOW
1585 #define E1000_ICS_SRPD      E1000_ICR_SRPD
1586 #define E1000_ICS_ACK       E1000_ICR_ACK       /* Receive Ack frame */
1587 #define E1000_ICS_MNG       E1000_ICR_MNG       /* Manageability event */
1588 #define E1000_ICS_DOCK      E1000_ICR_DOCK      /* Dock/Undock */
1589
1590 /* Interrupt Mask Set */
1591 #define E1000_IMS_TXDW      E1000_ICR_TXDW      /* Transmit desc written back */
1592 #define E1000_IMS_TXQE      E1000_ICR_TXQE      /* Transmit Queue empty */
1593 #define E1000_IMS_LSC       E1000_ICR_LSC       /* Link Status Change */
1594 #define E1000_IMS_RXSEQ     E1000_ICR_RXSEQ     /* rx sequence error */
1595 #define E1000_IMS_RXDMT0    E1000_ICR_RXDMT0    /* rx desc min. threshold */
1596 #define E1000_IMS_RXO       E1000_ICR_RXO       /* rx overrun */
1597 #define E1000_IMS_RXT0      E1000_ICR_RXT0      /* rx timer intr */
1598 #define E1000_IMS_MDAC      E1000_ICR_MDAC      /* MDIO access complete */
1599 #define E1000_IMS_RXCFG     E1000_ICR_RXCFG     /* RX /c/ ordered set */
1600 #define E1000_IMS_GPI_EN0   E1000_ICR_GPI_EN0   /* GP Int 0 */
1601 #define E1000_IMS_GPI_EN1   E1000_ICR_GPI_EN1   /* GP Int 1 */
1602 #define E1000_IMS_GPI_EN2   E1000_ICR_GPI_EN2   /* GP Int 2 */
1603 #define E1000_IMS_GPI_EN3   E1000_ICR_GPI_EN3   /* GP Int 3 */
1604 #define E1000_IMS_TXD_LOW   E1000_ICR_TXD_LOW
1605 #define E1000_IMS_SRPD      E1000_ICR_SRPD
1606 #define E1000_IMS_ACK       E1000_ICR_ACK       /* Receive Ack frame */
1607 #define E1000_IMS_MNG       E1000_ICR_MNG       /* Manageability event */
1608 #define E1000_IMS_DOCK      E1000_ICR_DOCK      /* Dock/Undock */
1609
1610 /* Interrupt Mask Clear */
1611 #define E1000_IMC_TXDW      E1000_ICR_TXDW      /* Transmit desc written back */
1612 #define E1000_IMC_TXQE      E1000_ICR_TXQE      /* Transmit Queue empty */
1613 #define E1000_IMC_LSC       E1000_ICR_LSC       /* Link Status Change */
1614 #define E1000_IMC_RXSEQ     E1000_ICR_RXSEQ     /* rx sequence error */
1615 #define E1000_IMC_RXDMT0    E1000_ICR_RXDMT0    /* rx desc min. threshold */
1616 #define E1000_IMC_RXO       E1000_ICR_RXO       /* rx overrun */
1617 #define E1000_IMC_RXT0      E1000_ICR_RXT0      /* rx timer intr */
1618 #define E1000_IMC_MDAC      E1000_ICR_MDAC      /* MDIO access complete */
1619 #define E1000_IMC_RXCFG     E1000_ICR_RXCFG     /* RX /c/ ordered set */
1620 #define E1000_IMC_GPI_EN0   E1000_ICR_GPI_EN0   /* GP Int 0 */
1621 #define E1000_IMC_GPI_EN1   E1000_ICR_GPI_EN1   /* GP Int 1 */
1622 #define E1000_IMC_GPI_EN2   E1000_ICR_GPI_EN2   /* GP Int 2 */
1623 #define E1000_IMC_GPI_EN3   E1000_ICR_GPI_EN3   /* GP Int 3 */
1624 #define E1000_IMC_TXD_LOW   E1000_ICR_TXD_LOW
1625 #define E1000_IMC_SRPD      E1000_ICR_SRPD
1626 #define E1000_IMC_ACK       E1000_ICR_ACK       /* Receive Ack frame */
1627 #define E1000_IMC_MNG       E1000_ICR_MNG       /* Manageability event */
1628 #define E1000_IMC_DOCK      E1000_ICR_DOCK      /* Dock/Undock */
1629
1630 /* Receive Control */
1631 #define E1000_RCTL_RST            0x00000001    /* Software reset */
1632 #define E1000_RCTL_EN             0x00000002    /* enable */
1633 #define E1000_RCTL_SBP            0x00000004    /* store bad packet */
1634 #define E1000_RCTL_UPE            0x00000008    /* unicast promiscuous enable */
1635 #define E1000_RCTL_MPE            0x00000010    /* multicast promiscuous enab */
1636 #define E1000_RCTL_LPE            0x00000020    /* long packet enable */
1637 #define E1000_RCTL_LBM_NO         0x00000000    /* no loopback mode */
1638 #define E1000_RCTL_LBM_MAC        0x00000040    /* MAC loopback mode */
1639 #define E1000_RCTL_LBM_SLP        0x00000080    /* serial link loopback mode */
1640 #define E1000_RCTL_LBM_TCVR       0x000000C0    /* tcvr loopback mode */
1641 #define E1000_RCTL_DTYP_MASK      0x00000C00    /* Descriptor type mask */
1642 #define E1000_RCTL_DTYP_PS        0x00000400    /* Packet Split descriptor */
1643 #define E1000_RCTL_RDMTS_HALF     0x00000000    /* rx desc min threshold size */
1644 #define E1000_RCTL_RDMTS_QUAT     0x00000100    /* rx desc min threshold size */
1645 #define E1000_RCTL_RDMTS_EIGTH    0x00000200    /* rx desc min threshold size */
1646 #define E1000_RCTL_MO_SHIFT       12            /* multicast offset shift */
1647 #define E1000_RCTL_MO_0           0x00000000    /* multicast offset 11:0 */
1648 #define E1000_RCTL_MO_1           0x00001000    /* multicast offset 12:1 */
1649 #define E1000_RCTL_MO_2           0x00002000    /* multicast offset 13:2 */
1650 #define E1000_RCTL_MO_3           0x00003000    /* multicast offset 15:4 */
1651 #define E1000_RCTL_MDR            0x00004000    /* multicast desc ring 0 */
1652 #define E1000_RCTL_BAM            0x00008000    /* broadcast enable */
1653 /* these buffer sizes are valid if E1000_RCTL_BSEX is 0 */
1654 #define E1000_RCTL_SZ_2048        0x00000000    /* rx buffer size 2048 */
1655 #define E1000_RCTL_SZ_1024        0x00010000    /* rx buffer size 1024 */
1656 #define E1000_RCTL_SZ_512         0x00020000    /* rx buffer size 512 */
1657 #define E1000_RCTL_SZ_256         0x00030000    /* rx buffer size 256 */
1658 /* these buffer sizes are valid if E1000_RCTL_BSEX is 1 */
1659 #define E1000_RCTL_SZ_16384       0x00010000    /* rx buffer size 16384 */
1660 #define E1000_RCTL_SZ_8192        0x00020000    /* rx buffer size 8192 */
1661 #define E1000_RCTL_SZ_4096        0x00030000    /* rx buffer size 4096 */
1662 #define E1000_RCTL_VFE            0x00040000    /* vlan filter enable */
1663 #define E1000_RCTL_CFIEN          0x00080000    /* canonical form enable */
1664 #define E1000_RCTL_CFI            0x00100000    /* canonical form indicator */
1665 #define E1000_RCTL_DPF            0x00400000    /* discard pause frames */
1666 #define E1000_RCTL_PMCF           0x00800000    /* pass MAC control frames */
1667 #define E1000_RCTL_BSEX           0x02000000    /* Buffer size extension */
1668 #define E1000_RCTL_SECRC          0x04000000    /* Strip Ethernet CRC */
1669 #define E1000_RCTL_FLXBUF_MASK    0x78000000    /* Flexible buffer size */
1670 #define E1000_RCTL_FLXBUF_SHIFT   27            /* Flexible buffer shift */
1671
1672 /* Use byte values for the following shift parameters
1673  * Usage:
1674  *     psrctl |= (((ROUNDUP(value0, 128) >> E1000_PSRCTL_BSIZE0_SHIFT) &
1675  *                  E1000_PSRCTL_BSIZE0_MASK) |
1676  *                ((ROUNDUP(value1, 1024) >> E1000_PSRCTL_BSIZE1_SHIFT) &
1677  *                  E1000_PSRCTL_BSIZE1_MASK) |
1678  *                ((ROUNDUP(value2, 1024) << E1000_PSRCTL_BSIZE2_SHIFT) &
1679  *                  E1000_PSRCTL_BSIZE2_MASK) |
1680  *                ((ROUNDUP(value3, 1024) << E1000_PSRCTL_BSIZE3_SHIFT) |;
1681  *                  E1000_PSRCTL_BSIZE3_MASK))
1682  * where value0 = [128..16256],  default=256
1683  *       value1 = [1024..64512], default=4096
1684  *       value2 = [0..64512],    default=4096
1685  *       value3 = [0..64512],    default=0
1686  */
1687
1688 #define E1000_PSRCTL_BSIZE0_MASK   0x0000007F
1689 #define E1000_PSRCTL_BSIZE1_MASK   0x00003F00
1690 #define E1000_PSRCTL_BSIZE2_MASK   0x003F0000
1691 #define E1000_PSRCTL_BSIZE3_MASK   0x3F000000
1692
1693 #define E1000_PSRCTL_BSIZE0_SHIFT  7            /* Shift _right_ 7 */
1694 #define E1000_PSRCTL_BSIZE1_SHIFT  2            /* Shift _right_ 2 */
1695 #define E1000_PSRCTL_BSIZE2_SHIFT  6            /* Shift _left_ 6 */
1696 #define E1000_PSRCTL_BSIZE3_SHIFT 14            /* Shift _left_ 14 */
1697
1698 /* Receive Descriptor */
1699 #define E1000_RDT_DELAY 0x0000ffff      /* Delay timer (1=1024us) */
1700 #define E1000_RDT_FPDB  0x80000000      /* Flush descriptor block */
1701 #define E1000_RDLEN_LEN 0x0007ff80      /* descriptor length */
1702 #define E1000_RDH_RDH   0x0000ffff      /* receive descriptor head */
1703 #define E1000_RDT_RDT   0x0000ffff      /* receive descriptor tail */
1704
1705 /* Flow Control */
1706 #define E1000_FCRTH_RTH  0x0000FFF8     /* Mask Bits[15:3] for RTH */
1707 #define E1000_FCRTH_XFCE 0x80000000     /* External Flow Control Enable */
1708 #define E1000_FCRTL_RTL  0x0000FFF8     /* Mask Bits[15:3] for RTL */
1709 #define E1000_FCRTL_XONE 0x80000000     /* Enable XON frame transmission */
1710
1711 /* Header split receive */
1712 #define E1000_RFCTL_ISCSI_DIS           0x00000001
1713 #define E1000_RFCTL_ISCSI_DWC_MASK      0x0000003E
1714 #define E1000_RFCTL_ISCSI_DWC_SHIFT     1
1715 #define E1000_RFCTL_NFSW_DIS            0x00000040
1716 #define E1000_RFCTL_NFSR_DIS            0x00000080
1717 #define E1000_RFCTL_NFS_VER_MASK        0x00000300
1718 #define E1000_RFCTL_NFS_VER_SHIFT       8
1719 #define E1000_RFCTL_IPV6_DIS            0x00000400
1720 #define E1000_RFCTL_IPV6_XSUM_DIS       0x00000800
1721 #define E1000_RFCTL_ACK_DIS             0x00001000
1722 #define E1000_RFCTL_ACKD_DIS            0x00002000
1723 #define E1000_RFCTL_IPFRSP_DIS          0x00004000
1724 #define E1000_RFCTL_EXTEN               0x00008000
1725 #define E1000_RFCTL_IPV6_EX_DIS         0x00010000
1726 #define E1000_RFCTL_NEW_IPV6_EXT_DIS    0x00020000
1727
1728 /* Receive Descriptor Control */
1729 #define E1000_RXDCTL_PTHRESH 0x0000003F /* RXDCTL Prefetch Threshold */
1730 #define E1000_RXDCTL_HTHRESH 0x00003F00 /* RXDCTL Host Threshold */
1731 #define E1000_RXDCTL_WTHRESH 0x003F0000 /* RXDCTL Writeback Threshold */
1732 #define E1000_RXDCTL_GRAN    0x01000000 /* RXDCTL Granularity */
1733
1734 /* Transmit Descriptor Control */
1735 #define E1000_TXDCTL_PTHRESH 0x000000FF /* TXDCTL Prefetch Threshold */
1736 #define E1000_TXDCTL_HTHRESH 0x0000FF00 /* TXDCTL Host Threshold */
1737 #define E1000_TXDCTL_WTHRESH 0x00FF0000 /* TXDCTL Writeback Threshold */
1738 #define E1000_TXDCTL_GRAN    0x01000000 /* TXDCTL Granularity */
1739 #define E1000_TXDCTL_LWTHRESH 0xFE000000 /* TXDCTL Low Threshold */
1740 #define E1000_TXDCTL_FULL_TX_DESC_WB 0x01010000 /* GRAN=1, WTHRESH=1 */
1741 #define E1000_TXDCTL_COUNT_DESC 0x00400000 /* Enable the counting of desc.
1742                                               still to be processed. */
1743
1744 /* Transmit Configuration Word */
1745 #define E1000_TXCW_FD         0x00000020        /* TXCW full duplex */
1746 #define E1000_TXCW_HD         0x00000040        /* TXCW half duplex */
1747 #define E1000_TXCW_PAUSE      0x00000080        /* TXCW sym pause request */
1748 #define E1000_TXCW_ASM_DIR    0x00000100        /* TXCW astm pause direction */
1749 #define E1000_TXCW_PAUSE_MASK 0x00000180        /* TXCW pause request mask */
1750 #define E1000_TXCW_RF         0x00003000        /* TXCW remote fault */
1751 #define E1000_TXCW_NP         0x00008000        /* TXCW next page */
1752 #define E1000_TXCW_CW         0x0000ffff        /* TxConfigWord mask */
1753 #define E1000_TXCW_TXC        0x40000000        /* Transmit Config control */
1754 #define E1000_TXCW_ANE        0x80000000        /* Auto-neg enable */
1755
1756 /* Receive Configuration Word */
1757 #define E1000_RXCW_CW    0x0000ffff     /* RxConfigWord mask */
1758 #define E1000_RXCW_NC    0x04000000     /* Receive config no carrier */
1759 #define E1000_RXCW_IV    0x08000000     /* Receive config invalid */
1760 #define E1000_RXCW_CC    0x10000000     /* Receive config change */
1761 #define E1000_RXCW_C     0x20000000     /* Receive config */
1762 #define E1000_RXCW_SYNCH 0x40000000     /* Receive config synch */
1763 #define E1000_RXCW_ANC   0x80000000     /* Auto-neg complete */
1764
1765 /* Transmit Control */
1766 #define E1000_TCTL_RST    0x00000001    /* software reset */
1767 #define E1000_TCTL_EN     0x00000002    /* enable tx */
1768 #define E1000_TCTL_BCE    0x00000004    /* busy check enable */
1769 #define E1000_TCTL_PSP    0x00000008    /* pad short packets */
1770 #define E1000_TCTL_CT     0x00000ff0    /* collision threshold */
1771 #define E1000_TCTL_COLD   0x003ff000    /* collision distance */
1772 #define E1000_TCTL_SWXOFF 0x00400000    /* SW Xoff transmission */
1773 #define E1000_TCTL_PBE    0x00800000    /* Packet Burst Enable */
1774 #define E1000_TCTL_RTLC   0x01000000    /* Re-transmit on late collision */
1775 #define E1000_TCTL_NRTU   0x02000000    /* No Re-transmit on underrun */
1776 #define E1000_TCTL_MULR   0x10000000    /* Multiple request support */
1777
1778 /* Receive Checksum Control */
1779 #define E1000_RXCSUM_PCSS_MASK 0x000000FF   /* Packet Checksum Start */
1780 #define E1000_RXCSUM_IPOFL     0x00000100   /* IPv4 checksum offload */
1781 #define E1000_RXCSUM_TUOFL     0x00000200   /* TCP / UDP checksum offload */
1782 #define E1000_RXCSUM_IPV6OFL   0x00000400   /* IPv6 checksum offload */
1783 #define E1000_RXCSUM_IPPCSE    0x00001000   /* IP payload checksum enable */
1784 #define E1000_RXCSUM_PCSD      0x00002000   /* packet checksum disabled */
1785
1786
1787 /* Definitions for power management and wakeup registers */
1788 /* Wake Up Control */
1789 #define E1000_WUC_APME       0x00000001 /* APM Enable */
1790 #define E1000_WUC_PME_EN     0x00000002 /* PME Enable */
1791 #define E1000_WUC_PME_STATUS 0x00000004 /* PME Status */
1792 #define E1000_WUC_APMPME     0x00000008 /* Assert PME on APM Wakeup */
1793 #define E1000_WUC_SPM        0x80000000 /* Enable SPM */
1794
1795 /* Wake Up Filter Control */
1796 #define E1000_WUFC_LNKC 0x00000001 /* Link Status Change Wakeup Enable */
1797 #define E1000_WUFC_MAG  0x00000002 /* Magic Packet Wakeup Enable */
1798 #define E1000_WUFC_EX   0x00000004 /* Directed Exact Wakeup Enable */
1799 #define E1000_WUFC_MC   0x00000008 /* Directed Multicast Wakeup Enable */
1800 #define E1000_WUFC_BC   0x00000010 /* Broadcast Wakeup Enable */
1801 #define E1000_WUFC_ARP  0x00000020 /* ARP Request Packet Wakeup Enable */
1802 #define E1000_WUFC_IPV4 0x00000040 /* Directed IPv4 Packet Wakeup Enable */
1803 #define E1000_WUFC_IPV6 0x00000080 /* Directed IPv6 Packet Wakeup Enable */
1804 #define E1000_WUFC_IGNORE_TCO      0x00008000 /* Ignore WakeOn TCO packets */
1805 #define E1000_WUFC_FLX0 0x00010000 /* Flexible Filter 0 Enable */
1806 #define E1000_WUFC_FLX1 0x00020000 /* Flexible Filter 1 Enable */
1807 #define E1000_WUFC_FLX2 0x00040000 /* Flexible Filter 2 Enable */
1808 #define E1000_WUFC_FLX3 0x00080000 /* Flexible Filter 3 Enable */
1809 #define E1000_WUFC_ALL_FILTERS 0x000F00FF /* Mask for all wakeup filters */
1810 #define E1000_WUFC_FLX_OFFSET 16       /* Offset to the Flexible Filters bits */
1811 #define E1000_WUFC_FLX_FILTERS 0x000F0000 /* Mask for the 4 flexible filters */
1812
1813 /* Wake Up Status */
1814 #define E1000_WUS_LNKC 0x00000001 /* Link Status Changed */
1815 #define E1000_WUS_MAG  0x00000002 /* Magic Packet Received */
1816 #define E1000_WUS_EX   0x00000004 /* Directed Exact Received */
1817 #define E1000_WUS_MC   0x00000008 /* Directed Multicast Received */
1818 #define E1000_WUS_BC   0x00000010 /* Broadcast Received */
1819 #define E1000_WUS_ARP  0x00000020 /* ARP Request Packet Received */
1820 #define E1000_WUS_IPV4 0x00000040 /* Directed IPv4 Packet Wakeup Received */
1821 #define E1000_WUS_IPV6 0x00000080 /* Directed IPv6 Packet Wakeup Received */
1822 #define E1000_WUS_FLX0 0x00010000 /* Flexible Filter 0 Match */
1823 #define E1000_WUS_FLX1 0x00020000 /* Flexible Filter 1 Match */
1824 #define E1000_WUS_FLX2 0x00040000 /* Flexible Filter 2 Match */
1825 #define E1000_WUS_FLX3 0x00080000 /* Flexible Filter 3 Match */
1826 #define E1000_WUS_FLX_FILTERS 0x000F0000 /* Mask for the 4 flexible filters */
1827
1828 /* Management Control */
1829 #define E1000_MANC_SMBUS_EN      0x00000001 /* SMBus Enabled - RO */
1830 #define E1000_MANC_ASF_EN        0x00000002 /* ASF Enabled - RO */
1831 #define E1000_MANC_R_ON_FORCE    0x00000004 /* Reset on Force TCO - RO */
1832 #define E1000_MANC_RMCP_EN       0x00000100 /* Enable RCMP 026Fh Filtering */
1833 #define E1000_MANC_0298_EN       0x00000200 /* Enable RCMP 0298h Filtering */
1834 #define E1000_MANC_IPV4_EN       0x00000400 /* Enable IPv4 */
1835 #define E1000_MANC_IPV6_EN       0x00000800 /* Enable IPv6 */
1836 #define E1000_MANC_SNAP_EN       0x00001000 /* Accept LLC/SNAP */
1837 #define E1000_MANC_ARP_EN        0x00002000 /* Enable ARP Request Filtering */
1838 #define E1000_MANC_NEIGHBOR_EN   0x00004000 /* Enable Neighbor Discovery
1839                                              * Filtering */
1840 #define E1000_MANC_ARP_RES_EN    0x00008000 /* Enable ARP response Filtering */
1841 #define E1000_MANC_TCO_RESET     0x00010000 /* TCO Reset Occurred */
1842 #define E1000_MANC_RCV_TCO_EN    0x00020000 /* Receive TCO Packets Enabled */
1843 #define E1000_MANC_REPORT_STATUS 0x00040000 /* Status Reporting Enabled */
1844 #define E1000_MANC_BLK_PHY_RST_ON_IDE   0x00040000 /* Block phy resets */
1845 #define E1000_MANC_EN_MAC_ADDR_FILTER   0x00100000 /* Enable MAC address
1846                                                     * filtering */
1847 #define E1000_MANC_EN_MNG2HOST   0x00200000 /* Enable MNG packets to host
1848                                              * memory */
1849 #define E1000_MANC_EN_IP_ADDR_FILTER    0x00400000 /* Enable IP address
1850                                                     * filtering */
1851 #define E1000_MANC_EN_XSUM_FILTER   0x00800000 /* Enable checksum filtering */
1852 #define E1000_MANC_BR_EN            0x01000000 /* Enable broadcast filtering */
1853 #define E1000_MANC_SMB_REQ       0x01000000 /* SMBus Request */
1854 #define E1000_MANC_SMB_GNT       0x02000000 /* SMBus Grant */
1855 #define E1000_MANC_SMB_CLK_IN    0x04000000 /* SMBus Clock In */
1856 #define E1000_MANC_SMB_DATA_IN   0x08000000 /* SMBus Data In */
1857 #define E1000_MANC_SMB_DATA_OUT  0x10000000 /* SMBus Data Out */
1858 #define E1000_MANC_SMB_CLK_OUT   0x20000000 /* SMBus Clock Out */
1859
1860 #define E1000_MANC_SMB_DATA_OUT_SHIFT  28 /* SMBus Data Out Shift */
1861 #define E1000_MANC_SMB_CLK_OUT_SHIFT   29 /* SMBus Clock Out Shift */
1862
1863 /* SW Semaphore Register */
1864 #define E1000_SWSM_SMBI         0x00000001 /* Driver Semaphore bit */
1865 #define E1000_SWSM_SWESMBI      0x00000002 /* FW Semaphore bit */
1866 #define E1000_SWSM_WMNG         0x00000004 /* Wake MNG Clock */
1867 #define E1000_SWSM_DRV_LOAD     0x00000008 /* Driver Loaded Bit */
1868
1869 /* FW Semaphore Register */
1870 #define E1000_FWSM_MODE_MASK    0x0000000E /* FW mode */
1871 #define E1000_FWSM_MODE_SHIFT            1
1872 #define E1000_FWSM_FW_VALID     0x00008000 /* FW established a valid mode */
1873
1874 /* FFLT Debug Register */
1875 #define E1000_FFLT_DBG_INVC     0x00100000 /* Invalid /C/ code handling */
1876
1877 typedef enum {
1878     e1000_mng_mode_none     = 0,
1879     e1000_mng_mode_asf,
1880     e1000_mng_mode_pt,
1881     e1000_mng_mode_ipmi,
1882     e1000_mng_mode_host_interface_only
1883 } e1000_mng_mode;
1884
1885 /* Host Inteface Control Register */
1886 #define E1000_HICR_EN           0x00000001  /* Enable Bit - RO */
1887 #define E1000_HICR_C            0x00000002  /* Driver sets this bit when done
1888                                              * to put command in RAM */
1889 #define E1000_HICR_SV           0x00000004  /* Status Validity */
1890 #define E1000_HICR_FWR          0x00000080  /* FW reset. Set by the Host */
1891
1892 /* Host Interface Command Interface - Address range 0x8800-0x8EFF */
1893 #define E1000_HI_MAX_DATA_LENGTH         252 /* Host Interface data length */
1894 #define E1000_HI_MAX_BLOCK_BYTE_LENGTH  1792 /* Number of bytes in range */
1895 #define E1000_HI_MAX_BLOCK_DWORD_LENGTH  448 /* Number of dwords in range */
1896 #define E1000_HI_COMMAND_TIMEOUT         500 /* Time in ms to process HI command */
1897
1898 struct e1000_host_command_header {
1899     uint8_t command_id;
1900     uint8_t command_length;
1901     uint8_t command_options;   /* I/F bits for command, status for return */
1902     uint8_t checksum;
1903 };
1904 struct e1000_host_command_info {
1905     struct e1000_host_command_header command_header;  /* Command Head/Command Result Head has 4 bytes */
1906     uint8_t command_data[E1000_HI_MAX_DATA_LENGTH];   /* Command data can length 0..252 */
1907 };
1908
1909 /* Host SMB register #0 */
1910 #define E1000_HSMC0R_CLKIN      0x00000001  /* SMB Clock in */
1911 #define E1000_HSMC0R_DATAIN     0x00000002  /* SMB Data in */
1912 #define E1000_HSMC0R_DATAOUT    0x00000004  /* SMB Data out */
1913 #define E1000_HSMC0R_CLKOUT     0x00000008  /* SMB Clock out */
1914
1915 /* Host SMB register #1 */
1916 #define E1000_HSMC1R_CLKIN      E1000_HSMC0R_CLKIN
1917 #define E1000_HSMC1R_DATAIN     E1000_HSMC0R_DATAIN
1918 #define E1000_HSMC1R_DATAOUT    E1000_HSMC0R_DATAOUT
1919 #define E1000_HSMC1R_CLKOUT     E1000_HSMC0R_CLKOUT
1920
1921 /* FW Status Register */
1922 #define E1000_FWSTS_FWS_MASK    0x000000FF  /* FW Status */
1923
1924 /* Wake Up Packet Length */
1925 #define E1000_WUPL_LENGTH_MASK 0x0FFF   /* Only the lower 12 bits are valid */
1926
1927 #define E1000_MDALIGN          4096
1928
1929 #define E1000_GCR_BEM32                 0x00400000
1930 /* Function Active and Power State to MNG */
1931 #define E1000_FACTPS_FUNC0_POWER_STATE_MASK         0x00000003
1932 #define E1000_FACTPS_LAN0_VALID                     0x00000004
1933 #define E1000_FACTPS_FUNC0_AUX_EN                   0x00000008
1934 #define E1000_FACTPS_FUNC1_POWER_STATE_MASK         0x000000C0
1935 #define E1000_FACTPS_FUNC1_POWER_STATE_SHIFT        6
1936 #define E1000_FACTPS_LAN1_VALID                     0x00000100
1937 #define E1000_FACTPS_FUNC1_AUX_EN                   0x00000200
1938 #define E1000_FACTPS_FUNC2_POWER_STATE_MASK         0x00003000
1939 #define E1000_FACTPS_FUNC2_POWER_STATE_SHIFT        12
1940 #define E1000_FACTPS_IDE_ENABLE                     0x00004000
1941 #define E1000_FACTPS_FUNC2_AUX_EN                   0x00008000
1942 #define E1000_FACTPS_FUNC3_POWER_STATE_MASK         0x000C0000
1943 #define E1000_FACTPS_FUNC3_POWER_STATE_SHIFT        18
1944 #define E1000_FACTPS_SP_ENABLE                      0x00100000
1945 #define E1000_FACTPS_FUNC3_AUX_EN                   0x00200000
1946 #define E1000_FACTPS_FUNC4_POWER_STATE_MASK         0x03000000
1947 #define E1000_FACTPS_FUNC4_POWER_STATE_SHIFT        24
1948 #define E1000_FACTPS_IPMI_ENABLE                    0x04000000
1949 #define E1000_FACTPS_FUNC4_AUX_EN                   0x08000000
1950 #define E1000_FACTPS_MNGCG                          0x20000000
1951 #define E1000_FACTPS_LAN_FUNC_SEL                   0x40000000
1952 #define E1000_FACTPS_PM_STATE_CHANGED               0x80000000
1953
1954 /* EEPROM Commands - Microwire */
1955 #define EEPROM_READ_OPCODE_MICROWIRE  0x6  /* EEPROM read opcode */
1956 #define EEPROM_WRITE_OPCODE_MICROWIRE 0x5  /* EEPROM write opcode */
1957 #define EEPROM_ERASE_OPCODE_MICROWIRE 0x7  /* EEPROM erase opcode */
1958 #define EEPROM_EWEN_OPCODE_MICROWIRE  0x13 /* EEPROM erase/write enable */
1959 #define EEPROM_EWDS_OPCODE_MICROWIRE  0x10 /* EEPROM erast/write disable */
1960
1961 /* EEPROM Commands - SPI */
1962 #define EEPROM_MAX_RETRY_SPI    5000 /* Max wait of 5ms, for RDY signal */
1963 #define EEPROM_READ_OPCODE_SPI      0x03  /* EEPROM read opcode */
1964 #define EEPROM_WRITE_OPCODE_SPI     0x02  /* EEPROM write opcode */
1965 #define EEPROM_A8_OPCODE_SPI        0x08  /* opcode bit-3 = address bit-8 */
1966 #define EEPROM_WREN_OPCODE_SPI      0x06  /* EEPROM set Write Enable latch */
1967 #define EEPROM_WRDI_OPCODE_SPI      0x04  /* EEPROM reset Write Enable latch */
1968 #define EEPROM_RDSR_OPCODE_SPI      0x05  /* EEPROM read Status register */
1969 #define EEPROM_WRSR_OPCODE_SPI      0x01  /* EEPROM write Status register */
1970 #define EEPROM_ERASE4K_OPCODE_SPI   0x20  /* EEPROM ERASE 4KB */
1971 #define EEPROM_ERASE64K_OPCODE_SPI  0xD8  /* EEPROM ERASE 64KB */
1972 #define EEPROM_ERASE256_OPCODE_SPI  0xDB  /* EEPROM ERASE 256B */
1973
1974 /* EEPROM Size definitions */
1975 #define EEPROM_WORD_SIZE_SHIFT  6
1976 #define EEPROM_SIZE_SHIFT       10
1977 #define EEPROM_SIZE_MASK        0x1C00
1978
1979 /* EEPROM Word Offsets */
1980 #define EEPROM_COMPAT                 0x0003
1981 #define EEPROM_ID_LED_SETTINGS        0x0004
1982 #define EEPROM_SERDES_AMPLITUDE       0x0006 /* For SERDES output amplitude adjustment. */
1983 #define EEPROM_PHY_CLASS_WORD         0x0007
1984 #define EEPROM_INIT_CONTROL1_REG      0x000A
1985 #define EEPROM_INIT_CONTROL2_REG      0x000F
1986 #define EEPROM_INIT_CONTROL3_PORT_B   0x0014
1987 #define EEPROM_INIT_CONTROL3_PORT_A   0x0024
1988 #define EEPROM_CFG                    0x0012
1989 #define EEPROM_FLASH_VERSION          0x0032
1990 #define EEPROM_CHECKSUM_REG           0x003F
1991
1992 /* Word definitions for ID LED Settings */
1993 #define ID_LED_RESERVED_0000 0x0000
1994 #define ID_LED_RESERVED_FFFF 0xFFFF
1995 #define ID_LED_DEFAULT       ((ID_LED_OFF1_ON2 << 12) | \
1996                               (ID_LED_OFF1_OFF2 << 8) | \
1997                               (ID_LED_DEF1_DEF2 << 4) | \
1998                               (ID_LED_DEF1_DEF2))
1999 #define ID_LED_DEF1_DEF2     0x1
2000 #define ID_LED_DEF1_ON2      0x2
2001 #define ID_LED_DEF1_OFF2     0x3
2002 #define ID_LED_ON1_DEF2      0x4
2003 #define ID_LED_ON1_ON2       0x5
2004 #define ID_LED_ON1_OFF2      0x6
2005 #define ID_LED_OFF1_DEF2     0x7
2006 #define ID_LED_OFF1_ON2      0x8
2007 #define ID_LED_OFF1_OFF2     0x9
2008
2009 #define IGP_ACTIVITY_LED_MASK   0xFFFFF0FF
2010 #define IGP_ACTIVITY_LED_ENABLE 0x0300
2011 #define IGP_LED3_MODE           0x07000000
2012
2013
2014 /* Mask bits for SERDES amplitude adjustment in Word 6 of the EEPROM */
2015 #define EEPROM_SERDES_AMPLITUDE_MASK  0x000F
2016
2017 /* Mask bit for PHY class in Word 7 of the EEPROM */
2018 #define EEPROM_PHY_CLASS_A   0x8000
2019
2020 /* Mask bits for fields in Word 0x0a of the EEPROM */
2021 #define EEPROM_WORD0A_ILOS   0x0010
2022 #define EEPROM_WORD0A_SWDPIO 0x01E0
2023 #define EEPROM_WORD0A_LRST   0x0200
2024 #define EEPROM_WORD0A_FD     0x0400
2025 #define EEPROM_WORD0A_66MHZ  0x0800
2026
2027 /* Mask bits for fields in Word 0x0f of the EEPROM */
2028 #define EEPROM_WORD0F_PAUSE_MASK 0x3000
2029 #define EEPROM_WORD0F_PAUSE      0x1000
2030 #define EEPROM_WORD0F_ASM_DIR    0x2000
2031 #define EEPROM_WORD0F_ANE        0x0800
2032 #define EEPROM_WORD0F_SWPDIO_EXT 0x00F0
2033
2034 /* For checksumming, the sum of all words in the EEPROM should equal 0xBABA. */
2035 #define EEPROM_SUM 0xBABA
2036
2037 /* EEPROM Map defines (WORD OFFSETS)*/
2038 #define EEPROM_NODE_ADDRESS_BYTE_0 0
2039 #define EEPROM_PBA_BYTE_1          8
2040
2041 #define EEPROM_RESERVED_WORD          0xFFFF
2042
2043 /* EEPROM Map Sizes (Byte Counts) */
2044 #define PBA_SIZE 4
2045
2046 /* Collision related configuration parameters */
2047 #define E1000_COLLISION_THRESHOLD       15
2048 #define E1000_CT_SHIFT                  4
2049 #define E1000_COLLISION_DISTANCE        64
2050 #define E1000_FDX_COLLISION_DISTANCE    E1000_COLLISION_DISTANCE
2051 #define E1000_HDX_COLLISION_DISTANCE    E1000_COLLISION_DISTANCE
2052 #define E1000_COLD_SHIFT                12
2053
2054 /* Number of Transmit and Receive Descriptors must be a multiple of 8 */
2055 #define REQ_TX_DESCRIPTOR_MULTIPLE  8
2056 #define REQ_RX_DESCRIPTOR_MULTIPLE  8
2057
2058 /* Default values for the transmit IPG register */
2059 #define DEFAULT_82542_TIPG_IPGT        10
2060 #define DEFAULT_82543_TIPG_IPGT_FIBER  9
2061 #define DEFAULT_82543_TIPG_IPGT_COPPER 8
2062
2063 #define E1000_TIPG_IPGT_MASK  0x000003FF
2064 #define E1000_TIPG_IPGR1_MASK 0x000FFC00
2065 #define E1000_TIPG_IPGR2_MASK 0x3FF00000
2066
2067 #define DEFAULT_82542_TIPG_IPGR1 2
2068 #define DEFAULT_82543_TIPG_IPGR1 8
2069 #define E1000_TIPG_IPGR1_SHIFT  10
2070
2071 #define DEFAULT_82542_TIPG_IPGR2 10
2072 #define DEFAULT_82543_TIPG_IPGR2 6
2073 #define E1000_TIPG_IPGR2_SHIFT  20
2074
2075 #define E1000_TXDMAC_DPP 0x00000001
2076
2077 /* Adaptive IFS defines */
2078 #define TX_THRESHOLD_START     8
2079 #define TX_THRESHOLD_INCREMENT 10
2080 #define TX_THRESHOLD_DECREMENT 1
2081 #define TX_THRESHOLD_STOP      190
2082 #define TX_THRESHOLD_DISABLE   0
2083 #define TX_THRESHOLD_TIMER_MS  10000
2084 #define MIN_NUM_XMITS          1000
2085 #define IFS_MAX                80
2086 #define IFS_STEP               10
2087 #define IFS_MIN                40
2088 #define IFS_RATIO              4
2089
2090 /* Extended Configuration Control and Size */
2091 #define E1000_EXTCNF_CTRL_PCIE_WRITE_ENABLE 0x00000001
2092 #define E1000_EXTCNF_CTRL_PHY_WRITE_ENABLE  0x00000002
2093 #define E1000_EXTCNF_CTRL_D_UD_ENABLE       0x00000004
2094 #define E1000_EXTCNF_CTRL_D_UD_LATENCY      0x00000008
2095 #define E1000_EXTCNF_CTRL_D_UD_OWNER        0x00000010
2096 #define E1000_EXTCNF_CTRL_MDIO_SW_OWNERSHIP 0x00000020
2097 #define E1000_EXTCNF_CTRL_MDIO_HW_OWNERSHIP 0x00000040
2098 #define E1000_EXTCNF_CTRL_EXT_CNF_POINTER   0x1FFF0000
2099
2100 #define E1000_EXTCNF_SIZE_EXT_PHY_LENGTH    0x000000FF
2101 #define E1000_EXTCNF_SIZE_EXT_DOCK_LENGTH   0x0000FF00
2102 #define E1000_EXTCNF_SIZE_EXT_PCIE_LENGTH   0x00FF0000
2103
2104 /* PBA constants */
2105 #define E1000_PBA_12K 0x000C    /* 12KB, default Rx allocation */
2106 #define E1000_PBA_16K 0x0010    /* 16KB, default TX allocation */
2107 #define E1000_PBA_22K 0x0016
2108 #define E1000_PBA_24K 0x0018
2109 #define E1000_PBA_30K 0x001E
2110 #define E1000_PBA_40K 0x0028
2111 #define E1000_PBA_48K 0x0030    /* 48KB, default RX allocation */
2112
2113 /* Flow Control Constants */
2114 #define FLOW_CONTROL_ADDRESS_LOW  0x00C28001
2115 #define FLOW_CONTROL_ADDRESS_HIGH 0x00000100
2116 #define FLOW_CONTROL_TYPE         0x8808
2117
2118 /* The historical defaults for the flow control values are given below. */
2119 #define FC_DEFAULT_HI_THRESH        (0x8000)    /* 32KB */
2120 #define FC_DEFAULT_LO_THRESH        (0x4000)    /* 16KB */
2121 #define FC_DEFAULT_TX_TIMER         (0x100)     /* ~130 us */
2122
2123 /* PCIX Config space */
2124 #define PCIX_COMMAND_REGISTER    0xE6
2125 #define PCIX_STATUS_REGISTER_LO  0xE8
2126 #define PCIX_STATUS_REGISTER_HI  0xEA
2127
2128 #define PCIX_COMMAND_MMRBC_MASK      0x000C
2129 #define PCIX_COMMAND_MMRBC_SHIFT     0x2
2130 #define PCIX_STATUS_HI_MMRBC_MASK    0x0060
2131 #define PCIX_STATUS_HI_MMRBC_SHIFT   0x5
2132 #define PCIX_STATUS_HI_MMRBC_4K      0x3
2133 #define PCIX_STATUS_HI_MMRBC_2K      0x2
2134
2135
2136 /* Number of bits required to shift right the "pause" bits from the
2137  * EEPROM (bits 13:12) to the "pause" (bits 8:7) field in the TXCW register.
2138  */
2139 #define PAUSE_SHIFT 5
2140
2141 /* Number of bits required to shift left the "SWDPIO" bits from the
2142  * EEPROM (bits 8:5) to the "SWDPIO" (bits 25:22) field in the CTRL register.
2143  */
2144 #define SWDPIO_SHIFT 17
2145
2146 /* Number of bits required to shift left the "SWDPIO_EXT" bits from the
2147  * EEPROM word F (bits 7:4) to the bits 11:8 of The Extended CTRL register.
2148  */
2149 #define SWDPIO__EXT_SHIFT 4
2150
2151 /* Number of bits required to shift left the "ILOS" bit from the EEPROM
2152  * (bit 4) to the "ILOS" (bit 7) field in the CTRL register.
2153  */
2154 #define ILOS_SHIFT  3
2155
2156
2157 #define RECEIVE_BUFFER_ALIGN_SIZE  (256)
2158
2159 /* Number of milliseconds we wait for auto-negotiation to complete */
2160 #define LINK_UP_TIMEOUT             500
2161
2162 /* Number of 100 microseconds we wait for PCI Express master disable */
2163 #define MASTER_DISABLE_TIMEOUT      800
2164 /* Number of milliseconds we wait for Eeprom auto read bit done after MAC reset */
2165 #define AUTO_READ_DONE_TIMEOUT      10
2166 /* Number of milliseconds we wait for PHY configuration done after MAC reset */
2167 #define PHY_CFG_TIMEOUT             40
2168
2169 #define E1000_TX_BUFFER_SIZE ((uint32_t)1514)
2170
2171 /* The carrier extension symbol, as received by the NIC. */
2172 #define CARRIER_EXTENSION   0x0F
2173
2174 /* TBI_ACCEPT macro definition:
2175  *
2176  * This macro requires:
2177  *      adapter = a pointer to struct e1000_hw
2178  *      status = the 8 bit status field of the RX descriptor with EOP set
2179  *      error = the 8 bit error field of the RX descriptor with EOP set
2180  *      length = the sum of all the length fields of the RX descriptors that
2181  *               make up the current frame
2182  *      last_byte = the last byte of the frame DMAed by the hardware
2183  *      max_frame_length = the maximum frame length we want to accept.
2184  *      min_frame_length = the minimum frame length we want to accept.
2185  *
2186  * This macro is a conditional that should be used in the interrupt
2187  * handler's Rx processing routine when RxErrors have been detected.
2188  *
2189  * Typical use:
2190  *  ...
2191  *  if (TBI_ACCEPT) {
2192  *      accept_frame = TRUE;
2193  *      e1000_tbi_adjust_stats(adapter, MacAddress);
2194  *      frame_length--;
2195  *  } else {
2196  *      accept_frame = FALSE;
2197  *  }
2198  *  ...
2199  */
2200
2201 #define TBI_ACCEPT(adapter, status, errors, length, last_byte) \
2202     ((adapter)->tbi_compatibility_on && \
2203      (((errors) & E1000_RXD_ERR_FRAME_ERR_MASK) == E1000_RXD_ERR_CE) && \
2204      ((last_byte) == CARRIER_EXTENSION) && \
2205      (((status) & E1000_RXD_STAT_VP) ? \
2206           (((length) > ((adapter)->min_frame_size - VLAN_TAG_SIZE)) && \
2207            ((length) <= ((adapter)->max_frame_size + 1))) : \
2208           (((length) > (adapter)->min_frame_size) && \
2209            ((length) <= ((adapter)->max_frame_size + VLAN_TAG_SIZE + 1)))))
2210
2211
2212 /* Structures, enums, and macros for the PHY */
2213
2214 /* Bit definitions for the Management Data IO (MDIO) and Management Data
2215  * Clock (MDC) pins in the Device Control Register.
2216  */
2217 #define E1000_CTRL_PHY_RESET_DIR  E1000_CTRL_SWDPIO0
2218 #define E1000_CTRL_PHY_RESET      E1000_CTRL_SWDPIN0
2219 #define E1000_CTRL_MDIO_DIR       E1000_CTRL_SWDPIO2
2220 #define E1000_CTRL_MDIO           E1000_CTRL_SWDPIN2
2221 #define E1000_CTRL_MDC_DIR        E1000_CTRL_SWDPIO3
2222 #define E1000_CTRL_MDC            E1000_CTRL_SWDPIN3
2223 #define E1000_CTRL_PHY_RESET_DIR4 E1000_CTRL_EXT_SDP4_DIR
2224 #define E1000_CTRL_PHY_RESET4     E1000_CTRL_EXT_SDP4_DATA
2225
2226 /* PHY 1000 MII Register/Bit Definitions */
2227 /* PHY Registers defined by IEEE */
2228 #define PHY_CTRL         0x00 /* Control Register */
2229 #define PHY_STATUS       0x01 /* Status Regiser */
2230 #define PHY_ID1          0x02 /* Phy Id Reg (word 1) */
2231 #define PHY_ID2          0x03 /* Phy Id Reg (word 2) */
2232 #define PHY_AUTONEG_ADV  0x04 /* Autoneg Advertisement */
2233 #define PHY_LP_ABILITY   0x05 /* Link Partner Ability (Base Page) */
2234 #define PHY_AUTONEG_EXP  0x06 /* Autoneg Expansion Reg */
2235 #define PHY_NEXT_PAGE_TX 0x07 /* Next Page TX */
2236 #define PHY_LP_NEXT_PAGE 0x08 /* Link Partner Next Page */
2237 #define PHY_1000T_CTRL   0x09 /* 1000Base-T Control Reg */
2238 #define PHY_1000T_STATUS 0x0A /* 1000Base-T Status Reg */
2239 #define PHY_EXT_STATUS   0x0F /* Extended Status Reg */
2240
2241 #define MAX_PHY_REG_ADDRESS        0x1F  /* 5 bit address bus (0-0x1F) */
2242 #define MAX_PHY_MULTI_PAGE_REG     0xF   /* Registers equal on all pages */
2243
2244 /* M88E1000 Specific Registers */
2245 #define M88E1000_PHY_SPEC_CTRL     0x10  /* PHY Specific Control Register */
2246 #define M88E1000_PHY_SPEC_STATUS   0x11  /* PHY Specific Status Register */
2247 #define M88E1000_INT_ENABLE        0x12  /* Interrupt Enable Register */
2248 #define M88E1000_INT_STATUS        0x13  /* Interrupt Status Register */
2249 #define M88E1000_EXT_PHY_SPEC_CTRL 0x14  /* Extended PHY Specific Control */
2250 #define M88E1000_RX_ERR_CNTR       0x15  /* Receive Error Counter */
2251
2252 #define M88E1000_PHY_EXT_CTRL      0x1A  /* PHY extend control register */
2253 #define M88E1000_PHY_PAGE_SELECT   0x1D  /* Reg 29 for page number setting */
2254 #define M88E1000_PHY_GEN_CONTROL   0x1E  /* Its meaning depends on reg 29 */
2255 #define M88E1000_PHY_VCO_REG_BIT8  0x100 /* Bits 8 & 11 are adjusted for */
2256 #define M88E1000_PHY_VCO_REG_BIT11 0x800    /* improved BER performance */
2257
2258 #define IGP01E1000_IEEE_REGS_PAGE  0x0000
2259 #define IGP01E1000_IEEE_RESTART_AUTONEG 0x3300
2260 #define IGP01E1000_IEEE_FORCE_GIGA      0x0140
2261
2262 /* IGP01E1000 Specific Registers */
2263 #define IGP01E1000_PHY_PORT_CONFIG 0x10 /* PHY Specific Port Config Register */
2264 #define IGP01E1000_PHY_PORT_STATUS 0x11 /* PHY Specific Status Register */
2265 #define IGP01E1000_PHY_PORT_CTRL   0x12 /* PHY Specific Control Register */
2266 #define IGP01E1000_PHY_LINK_HEALTH 0x13 /* PHY Link Health Register */
2267 #define IGP01E1000_GMII_FIFO       0x14 /* GMII FIFO Register */
2268 #define IGP01E1000_PHY_CHANNEL_QUALITY 0x15 /* PHY Channel Quality Register */
2269 #define IGP02E1000_PHY_POWER_MGMT      0x19
2270 #define IGP01E1000_PHY_PAGE_SELECT     0x1F /* PHY Page Select Core Register */
2271
2272 /* IGP01E1000 AGC Registers - stores the cable length values*/
2273 #define IGP01E1000_PHY_AGC_A        0x1172
2274 #define IGP01E1000_PHY_AGC_B        0x1272
2275 #define IGP01E1000_PHY_AGC_C        0x1472
2276 #define IGP01E1000_PHY_AGC_D        0x1872
2277
2278 /* IGP02E1000 AGC Registers for cable length values */
2279 #define IGP02E1000_PHY_AGC_A        0x11B1
2280 #define IGP02E1000_PHY_AGC_B        0x12B1
2281 #define IGP02E1000_PHY_AGC_C        0x14B1
2282 #define IGP02E1000_PHY_AGC_D        0x18B1
2283
2284 /* IGP01E1000 DSP Reset Register */
2285 #define IGP01E1000_PHY_DSP_RESET   0x1F33
2286 #define IGP01E1000_PHY_DSP_SET     0x1F71
2287 #define IGP01E1000_PHY_DSP_FFE     0x1F35
2288
2289 #define IGP01E1000_PHY_CHANNEL_NUM    4
2290 #define IGP02E1000_PHY_CHANNEL_NUM    4
2291
2292 #define IGP01E1000_PHY_AGC_PARAM_A    0x1171
2293 #define IGP01E1000_PHY_AGC_PARAM_B    0x1271
2294 #define IGP01E1000_PHY_AGC_PARAM_C    0x1471
2295 #define IGP01E1000_PHY_AGC_PARAM_D    0x1871
2296
2297 #define IGP01E1000_PHY_EDAC_MU_INDEX        0xC000
2298 #define IGP01E1000_PHY_EDAC_SIGN_EXT_9_BITS 0x8000
2299
2300 #define IGP01E1000_PHY_ANALOG_TX_STATE      0x2890
2301 #define IGP01E1000_PHY_ANALOG_CLASS_A       0x2000
2302 #define IGP01E1000_PHY_FORCE_ANALOG_ENABLE  0x0004
2303 #define IGP01E1000_PHY_DSP_FFE_CM_CP        0x0069
2304
2305 #define IGP01E1000_PHY_DSP_FFE_DEFAULT      0x002A
2306 /* IGP01E1000 PCS Initialization register - stores the polarity status when
2307  * speed = 1000 Mbps. */
2308 #define IGP01E1000_PHY_PCS_INIT_REG  0x00B4
2309 #define IGP01E1000_PHY_PCS_CTRL_REG  0x00B5
2310
2311 #define IGP01E1000_ANALOG_REGS_PAGE  0x20C0
2312
2313
2314 /* PHY Control Register */
2315 #define MII_CR_SPEED_SELECT_MSB 0x0040  /* bits 6,13: 10=1000, 01=100, 00=10 */
2316 #define MII_CR_COLL_TEST_ENABLE 0x0080  /* Collision test enable */
2317 #define MII_CR_FULL_DUPLEX      0x0100  /* FDX =1, half duplex =0 */
2318 #define MII_CR_RESTART_AUTO_NEG 0x0200  /* Restart auto negotiation */
2319 #define MII_CR_ISOLATE          0x0400  /* Isolate PHY from MII */
2320 #define MII_CR_POWER_DOWN       0x0800  /* Power down */
2321 #define MII_CR_AUTO_NEG_EN      0x1000  /* Auto Neg Enable */
2322 #define MII_CR_SPEED_SELECT_LSB 0x2000  /* bits 6,13: 10=1000, 01=100, 00=10 */
2323 #define MII_CR_LOOPBACK         0x4000  /* 0 = normal, 1 = loopback */
2324 #define MII_CR_RESET            0x8000  /* 0 = normal, 1 = PHY reset */
2325
2326 /* PHY Status Register */
2327 #define MII_SR_EXTENDED_CAPS     0x0001 /* Extended register capabilities */
2328 #define MII_SR_JABBER_DETECT     0x0002 /* Jabber Detected */
2329 #define MII_SR_LINK_STATUS       0x0004 /* Link Status 1 = link */
2330 #define MII_SR_AUTONEG_CAPS      0x0008 /* Auto Neg Capable */
2331 #define MII_SR_REMOTE_FAULT      0x0010 /* Remote Fault Detect */
2332 #define MII_SR_AUTONEG_COMPLETE  0x0020 /* Auto Neg Complete */
2333 #define MII_SR_PREAMBLE_SUPPRESS 0x0040 /* Preamble may be suppressed */
2334 #define MII_SR_EXTENDED_STATUS   0x0100 /* Ext. status info in Reg 0x0F */
2335 #define MII_SR_100T2_HD_CAPS     0x0200 /* 100T2 Half Duplex Capable */
2336 #define MII_SR_100T2_FD_CAPS     0x0400 /* 100T2 Full Duplex Capable */
2337 #define MII_SR_10T_HD_CAPS       0x0800 /* 10T   Half Duplex Capable */
2338 #define MII_SR_10T_FD_CAPS       0x1000 /* 10T   Full Duplex Capable */
2339 #define MII_SR_100X_HD_CAPS      0x2000 /* 100X  Half Duplex Capable */
2340 #define MII_SR_100X_FD_CAPS      0x4000 /* 100X  Full Duplex Capable */
2341 #define MII_SR_100T4_CAPS        0x8000 /* 100T4 Capable */
2342
2343 /* Autoneg Advertisement Register */
2344 #define NWAY_AR_SELECTOR_FIELD 0x0001   /* indicates IEEE 802.3 CSMA/CD */
2345 #define NWAY_AR_10T_HD_CAPS    0x0020   /* 10T   Half Duplex Capable */
2346 #define NWAY_AR_10T_FD_CAPS    0x0040   /* 10T   Full Duplex Capable */
2347 #define NWAY_AR_100TX_HD_CAPS  0x0080   /* 100TX Half Duplex Capable */
2348 #define NWAY_AR_100TX_FD_CAPS  0x0100   /* 100TX Full Duplex Capable */
2349 #define NWAY_AR_100T4_CAPS     0x0200   /* 100T4 Capable */
2350 #define NWAY_AR_PAUSE          0x0400   /* Pause operation desired */
2351 #define NWAY_AR_ASM_DIR        0x0800   /* Asymmetric Pause Direction bit */
2352 #define NWAY_AR_REMOTE_FAULT   0x2000   /* Remote Fault detected */
2353 #define NWAY_AR_NEXT_PAGE      0x8000   /* Next Page ability supported */
2354
2355 /* Link Partner Ability Register (Base Page) */
2356 #define NWAY_LPAR_SELECTOR_FIELD 0x0000 /* LP protocol selector field */
2357 #define NWAY_LPAR_10T_HD_CAPS    0x0020 /* LP is 10T   Half Duplex Capable */
2358 #define NWAY_LPAR_10T_FD_CAPS    0x0040 /* LP is 10T   Full Duplex Capable */
2359 #define NWAY_LPAR_100TX_HD_CAPS  0x0080 /* LP is 100TX Half Duplex Capable */
2360 #define NWAY_LPAR_100TX_FD_CAPS  0x0100 /* LP is 100TX Full Duplex Capable */
2361 #define NWAY_LPAR_100T4_CAPS     0x0200 /* LP is 100T4 Capable */
2362 #define NWAY_LPAR_PAUSE          0x0400 /* LP Pause operation desired */
2363 #define NWAY_LPAR_ASM_DIR        0x0800 /* LP Asymmetric Pause Direction bit */
2364 #define NWAY_LPAR_REMOTE_FAULT   0x2000 /* LP has detected Remote Fault */
2365 #define NWAY_LPAR_ACKNOWLEDGE    0x4000 /* LP has rx'd link code word */
2366 #define NWAY_LPAR_NEXT_PAGE      0x8000 /* Next Page ability supported */
2367
2368 /* Autoneg Expansion Register */
2369 #define NWAY_ER_LP_NWAY_CAPS      0x0001 /* LP has Auto Neg Capability */
2370 #define NWAY_ER_PAGE_RXD          0x0002 /* LP is 10T   Half Duplex Capable */
2371 #define NWAY_ER_NEXT_PAGE_CAPS    0x0004 /* LP is 10T   Full Duplex Capable */
2372 #define NWAY_ER_LP_NEXT_PAGE_CAPS 0x0008 /* LP is 100TX Half Duplex Capable */
2373 #define NWAY_ER_PAR_DETECT_FAULT  0x0010 /* LP is 100TX Full Duplex Capable */
2374
2375 /* Next Page TX Register */
2376 #define NPTX_MSG_CODE_FIELD 0x0001 /* NP msg code or unformatted data */
2377 #define NPTX_TOGGLE         0x0800 /* Toggles between exchanges
2378                                     * of different NP
2379                                     */
2380 #define NPTX_ACKNOWLDGE2    0x1000 /* 1 = will comply with msg
2381                                     * 0 = cannot comply with msg
2382                                     */
2383 #define NPTX_MSG_PAGE       0x2000 /* formatted(1)/unformatted(0) pg */
2384 #define NPTX_NEXT_PAGE      0x8000 /* 1 = addition NP will follow
2385                                     * 0 = sending last NP
2386                                     */
2387
2388 /* Link Partner Next Page Register */
2389 #define LP_RNPR_MSG_CODE_FIELD 0x0001 /* NP msg code or unformatted data */
2390 #define LP_RNPR_TOGGLE         0x0800 /* Toggles between exchanges
2391                                        * of different NP
2392                                        */
2393 #define LP_RNPR_ACKNOWLDGE2    0x1000 /* 1 = will comply with msg
2394                                        * 0 = cannot comply with msg
2395                                        */
2396 #define LP_RNPR_MSG_PAGE       0x2000  /* formatted(1)/unformatted(0) pg */
2397 #define LP_RNPR_ACKNOWLDGE     0x4000  /* 1 = ACK / 0 = NO ACK */
2398 #define LP_RNPR_NEXT_PAGE      0x8000  /* 1 = addition NP will follow
2399                                         * 0 = sending last NP
2400                                         */
2401
2402 /* 1000BASE-T Control Register */
2403 #define CR_1000T_ASYM_PAUSE      0x0080 /* Advertise asymmetric pause bit */
2404 #define CR_1000T_HD_CAPS         0x0100 /* Advertise 1000T HD capability */
2405 #define CR_1000T_FD_CAPS         0x0200 /* Advertise 1000T FD capability  */
2406 #define CR_1000T_REPEATER_DTE    0x0400 /* 1=Repeater/switch device port */
2407                                         /* 0=DTE device */
2408 #define CR_1000T_MS_VALUE        0x0800 /* 1=Configure PHY as Master */
2409                                         /* 0=Configure PHY as Slave */
2410 #define CR_1000T_MS_ENABLE       0x1000 /* 1=Master/Slave manual config value */
2411                                         /* 0=Automatic Master/Slave config */
2412 #define CR_1000T_TEST_MODE_NORMAL 0x0000 /* Normal Operation */
2413 #define CR_1000T_TEST_MODE_1     0x2000 /* Transmit Waveform test */
2414 #define CR_1000T_TEST_MODE_2     0x4000 /* Master Transmit Jitter test */
2415 #define CR_1000T_TEST_MODE_3     0x6000 /* Slave Transmit Jitter test */
2416 #define CR_1000T_TEST_MODE_4     0x8000 /* Transmitter Distortion test */
2417
2418 /* 1000BASE-T Status Register */
2419 #define SR_1000T_IDLE_ERROR_CNT   0x00FF /* Num idle errors since last read */
2420 #define SR_1000T_ASYM_PAUSE_DIR   0x0100 /* LP asymmetric pause direction bit */
2421 #define SR_1000T_LP_HD_CAPS       0x0400 /* LP is 1000T HD capable */
2422 #define SR_1000T_LP_FD_CAPS       0x0800 /* LP is 1000T FD capable */
2423 #define SR_1000T_REMOTE_RX_STATUS 0x1000 /* Remote receiver OK */
2424 #define SR_1000T_LOCAL_RX_STATUS  0x2000 /* Local receiver OK */
2425 #define SR_1000T_MS_CONFIG_RES    0x4000 /* 1=Local TX is Master, 0=Slave */
2426 #define SR_1000T_MS_CONFIG_FAULT  0x8000 /* Master/Slave config fault */
2427 #define SR_1000T_REMOTE_RX_STATUS_SHIFT          12
2428 #define SR_1000T_LOCAL_RX_STATUS_SHIFT           13
2429 #define SR_1000T_PHY_EXCESSIVE_IDLE_ERR_COUNT    5
2430 #define FFE_IDLE_ERR_COUNT_TIMEOUT_20            20
2431 #define FFE_IDLE_ERR_COUNT_TIMEOUT_100           100
2432
2433 /* Extended Status Register */
2434 #define IEEE_ESR_1000T_HD_CAPS 0x1000 /* 1000T HD capable */
2435 #define IEEE_ESR_1000T_FD_CAPS 0x2000 /* 1000T FD capable */
2436 #define IEEE_ESR_1000X_HD_CAPS 0x4000 /* 1000X HD capable */
2437 #define IEEE_ESR_1000X_FD_CAPS 0x8000 /* 1000X FD capable */
2438
2439 #define PHY_TX_POLARITY_MASK   0x0100 /* register 10h bit 8 (polarity bit) */
2440 #define PHY_TX_NORMAL_POLARITY 0      /* register 10h bit 8 (normal polarity) */
2441
2442 #define AUTO_POLARITY_DISABLE  0x0010 /* register 11h bit 4 */
2443                                       /* (0=enable, 1=disable) */
2444
2445 /* M88E1000 PHY Specific Control Register */
2446 #define M88E1000_PSCR_JABBER_DISABLE    0x0001 /* 1=Jabber Function disabled */
2447 #define M88E1000_PSCR_POLARITY_REVERSAL 0x0002 /* 1=Polarity Reversal enabled */
2448 #define M88E1000_PSCR_SQE_TEST          0x0004 /* 1=SQE Test enabled */
2449 #define M88E1000_PSCR_CLK125_DISABLE    0x0010 /* 1=CLK125 low,
2450                                                 * 0=CLK125 toggling
2451                                                 */
2452 #define M88E1000_PSCR_MDI_MANUAL_MODE  0x0000  /* MDI Crossover Mode bits 6:5 */
2453                                                /* Manual MDI configuration */
2454 #define M88E1000_PSCR_MDIX_MANUAL_MODE 0x0020  /* Manual MDIX configuration */
2455 #define M88E1000_PSCR_AUTO_X_1000T     0x0040  /* 1000BASE-T: Auto crossover,
2456                                                 *  100BASE-TX/10BASE-T:
2457                                                 *  MDI Mode
2458                                                 */
2459 #define M88E1000_PSCR_AUTO_X_MODE      0x0060  /* Auto crossover enabled
2460                                                 * all speeds.
2461                                                 */
2462 #define M88E1000_PSCR_10BT_EXT_DIST_ENABLE 0x0080
2463                                         /* 1=Enable Extended 10BASE-T distance
2464                                          * (Lower 10BASE-T RX Threshold)
2465                                          * 0=Normal 10BASE-T RX Threshold */
2466 #define M88E1000_PSCR_MII_5BIT_ENABLE      0x0100
2467                                         /* 1=5-Bit interface in 100BASE-TX
2468                                          * 0=MII interface in 100BASE-TX */
2469 #define M88E1000_PSCR_SCRAMBLER_DISABLE    0x0200 /* 1=Scrambler disable */
2470 #define M88E1000_PSCR_FORCE_LINK_GOOD      0x0400 /* 1=Force link good */
2471 #define M88E1000_PSCR_ASSERT_CRS_ON_TX     0x0800 /* 1=Assert CRS on Transmit */
2472
2473 #define M88E1000_PSCR_POLARITY_REVERSAL_SHIFT    1
2474 #define M88E1000_PSCR_AUTO_X_MODE_SHIFT          5
2475 #define M88E1000_PSCR_10BT_EXT_DIST_ENABLE_SHIFT 7
2476
2477 /* M88E1000 PHY Specific Status Register */
2478 #define M88E1000_PSSR_JABBER             0x0001 /* 1=Jabber */
2479 #define M88E1000_PSSR_REV_POLARITY       0x0002 /* 1=Polarity reversed */
2480 #define M88E1000_PSSR_DOWNSHIFT          0x0020 /* 1=Downshifted */
2481 #define M88E1000_PSSR_MDIX               0x0040 /* 1=MDIX; 0=MDI */
2482 #define M88E1000_PSSR_CABLE_LENGTH       0x0380 /* 0=<50M;1=50-80M;2=80-110M;
2483                                             * 3=110-140M;4=>140M */
2484 #define M88E1000_PSSR_LINK               0x0400 /* 1=Link up, 0=Link down */
2485 #define M88E1000_PSSR_SPD_DPLX_RESOLVED  0x0800 /* 1=Speed & Duplex resolved */
2486 #define M88E1000_PSSR_PAGE_RCVD          0x1000 /* 1=Page received */
2487 #define M88E1000_PSSR_DPLX               0x2000 /* 1=Duplex 0=Half Duplex */
2488 #define M88E1000_PSSR_SPEED              0xC000 /* Speed, bits 14:15 */
2489 #define M88E1000_PSSR_10MBS              0x0000 /* 00=10Mbs */
2490 #define M88E1000_PSSR_100MBS             0x4000 /* 01=100Mbs */
2491 #define M88E1000_PSSR_1000MBS            0x8000 /* 10=1000Mbs */
2492
2493 #define M88E1000_PSSR_REV_POLARITY_SHIFT 1
2494 #define M88E1000_PSSR_DOWNSHIFT_SHIFT    5
2495 #define M88E1000_PSSR_MDIX_SHIFT         6
2496 #define M88E1000_PSSR_CABLE_LENGTH_SHIFT 7
2497
2498 /* M88E1000 Extended PHY Specific Control Register */
2499 #define M88E1000_EPSCR_FIBER_LOOPBACK 0x4000 /* 1=Fiber loopback */
2500 #define M88E1000_EPSCR_DOWN_NO_IDLE   0x8000 /* 1=Lost lock detect enabled.
2501                                               * Will assert lost lock and bring
2502                                               * link down if idle not seen
2503                                               * within 1ms in 1000BASE-T
2504                                               */
2505 /* Number of times we will attempt to autonegotiate before downshifting if we
2506  * are the master */
2507 #define M88E1000_EPSCR_MASTER_DOWNSHIFT_MASK 0x0C00
2508 #define M88E1000_EPSCR_MASTER_DOWNSHIFT_1X   0x0000
2509 #define M88E1000_EPSCR_MASTER_DOWNSHIFT_2X   0x0400
2510 #define M88E1000_EPSCR_MASTER_DOWNSHIFT_3X   0x0800
2511 #define M88E1000_EPSCR_MASTER_DOWNSHIFT_4X   0x0C00
2512 /* Number of times we will attempt to autonegotiate before downshifting if we
2513  * are the slave */
2514 #define M88E1000_EPSCR_SLAVE_DOWNSHIFT_MASK  0x0300
2515 #define M88E1000_EPSCR_SLAVE_DOWNSHIFT_DIS   0x0000
2516 #define M88E1000_EPSCR_SLAVE_DOWNSHIFT_1X    0x0100
2517 #define M88E1000_EPSCR_SLAVE_DOWNSHIFT_2X    0x0200
2518 #define M88E1000_EPSCR_SLAVE_DOWNSHIFT_3X    0x0300
2519 #define M88E1000_EPSCR_TX_CLK_2_5     0x0060 /* 2.5 MHz TX_CLK */
2520 #define M88E1000_EPSCR_TX_CLK_25      0x0070 /* 25  MHz TX_CLK */
2521 #define M88E1000_EPSCR_TX_CLK_0       0x0000 /* NO  TX_CLK */
2522
2523 /* IGP01E1000 Specific Port Config Register - R/W */
2524 #define IGP01E1000_PSCFR_AUTO_MDIX_PAR_DETECT  0x0010
2525 #define IGP01E1000_PSCFR_PRE_EN                0x0020
2526 #define IGP01E1000_PSCFR_SMART_SPEED           0x0080
2527 #define IGP01E1000_PSCFR_DISABLE_TPLOOPBACK    0x0100
2528 #define IGP01E1000_PSCFR_DISABLE_JABBER        0x0400
2529 #define IGP01E1000_PSCFR_DISABLE_TRANSMIT      0x2000
2530
2531 /* IGP01E1000 Specific Port Status Register - R/O */
2532 #define IGP01E1000_PSSR_AUTONEG_FAILED         0x0001 /* RO LH SC */
2533 #define IGP01E1000_PSSR_POLARITY_REVERSED      0x0002
2534 #define IGP01E1000_PSSR_CABLE_LENGTH           0x007C
2535 #define IGP01E1000_PSSR_FULL_DUPLEX            0x0200
2536 #define IGP01E1000_PSSR_LINK_UP                0x0400
2537 #define IGP01E1000_PSSR_MDIX                   0x0800
2538 #define IGP01E1000_PSSR_SPEED_MASK             0xC000 /* speed bits mask */
2539 #define IGP01E1000_PSSR_SPEED_10MBPS           0x4000
2540 #define IGP01E1000_PSSR_SPEED_100MBPS          0x8000
2541 #define IGP01E1000_PSSR_SPEED_1000MBPS         0xC000
2542 #define IGP01E1000_PSSR_CABLE_LENGTH_SHIFT     0x0002 /* shift right 2 */
2543 #define IGP01E1000_PSSR_MDIX_SHIFT             0x000B /* shift right 11 */
2544
2545 /* IGP01E1000 Specific Port Control Register - R/W */
2546 #define IGP01E1000_PSCR_TP_LOOPBACK            0x0010
2547 #define IGP01E1000_PSCR_CORRECT_NC_SCMBLR      0x0200
2548 #define IGP01E1000_PSCR_TEN_CRS_SELECT         0x0400
2549 #define IGP01E1000_PSCR_FLIP_CHIP              0x0800
2550 #define IGP01E1000_PSCR_AUTO_MDIX              0x1000
2551 #define IGP01E1000_PSCR_FORCE_MDI_MDIX         0x2000 /* 0-MDI, 1-MDIX */
2552
2553 /* IGP01E1000 Specific Port Link Health Register */
2554 #define IGP01E1000_PLHR_SS_DOWNGRADE           0x8000
2555 #define IGP01E1000_PLHR_GIG_SCRAMBLER_ERROR    0x4000
2556 #define IGP01E1000_PLHR_MASTER_FAULT           0x2000
2557 #define IGP01E1000_PLHR_MASTER_RESOLUTION      0x1000
2558 #define IGP01E1000_PLHR_GIG_REM_RCVR_NOK       0x0800 /* LH */
2559 #define IGP01E1000_PLHR_IDLE_ERROR_CNT_OFLOW   0x0400 /* LH */
2560 #define IGP01E1000_PLHR_DATA_ERR_1             0x0200 /* LH */
2561 #define IGP01E1000_PLHR_DATA_ERR_0             0x0100
2562 #define IGP01E1000_PLHR_AUTONEG_FAULT          0x0040
2563 #define IGP01E1000_PLHR_AUTONEG_ACTIVE         0x0010
2564 #define IGP01E1000_PLHR_VALID_CHANNEL_D        0x0008
2565 #define IGP01E1000_PLHR_VALID_CHANNEL_C        0x0004
2566 #define IGP01E1000_PLHR_VALID_CHANNEL_B        0x0002
2567 #define IGP01E1000_PLHR_VALID_CHANNEL_A        0x0001
2568
2569 /* IGP01E1000 Channel Quality Register */
2570 #define IGP01E1000_MSE_CHANNEL_D        0x000F
2571 #define IGP01E1000_MSE_CHANNEL_C        0x00F0
2572 #define IGP01E1000_MSE_CHANNEL_B        0x0F00
2573 #define IGP01E1000_MSE_CHANNEL_A        0xF000
2574
2575 #define IGP02E1000_PM_SPD                         0x0001  /* Smart Power Down */
2576 #define IGP02E1000_PM_D3_LPLU                     0x0004  /* Enable LPLU in non-D0a modes */
2577 #define IGP02E1000_PM_D0_LPLU                     0x0002  /* Enable LPLU in D0a mode */
2578
2579 /* IGP01E1000 DSP reset macros */
2580 #define DSP_RESET_ENABLE     0x0
2581 #define DSP_RESET_DISABLE    0x2
2582 #define E1000_MAX_DSP_RESETS 10
2583
2584 /* IGP01E1000 & IGP02E1000 AGC Registers */
2585
2586 #define IGP01E1000_AGC_LENGTH_SHIFT 7         /* Coarse - 13:11, Fine - 10:7 */
2587 #define IGP02E1000_AGC_LENGTH_SHIFT 9         /* Coarse - 15:13, Fine - 12:9 */
2588
2589 /* IGP02E1000 AGC Register Length 9-bit mask */
2590 #define IGP02E1000_AGC_LENGTH_MASK  0x7F
2591
2592 /* 7 bits (3 Coarse + 4 Fine) --> 128 optional values */
2593 #define IGP01E1000_AGC_LENGTH_TABLE_SIZE 128
2594 #define IGP02E1000_AGC_LENGTH_TABLE_SIZE 128
2595
2596 /* The precision error of the cable length is +/- 10 meters */
2597 #define IGP01E1000_AGC_RANGE    10
2598 #define IGP02E1000_AGC_RANGE    10
2599
2600 /* IGP01E1000 PCS Initialization register */
2601 /* bits 3:6 in the PCS registers stores the channels polarity */
2602 #define IGP01E1000_PHY_POLARITY_MASK    0x0078
2603
2604 /* IGP01E1000 GMII FIFO Register */
2605 #define IGP01E1000_GMII_FLEX_SPD               0x10 /* Enable flexible speed
2606                                                      * on Link-Up */
2607 #define IGP01E1000_GMII_SPD                    0x20 /* Enable SPD */
2608
2609 /* IGP01E1000 Analog Register */
2610 #define IGP01E1000_ANALOG_SPARE_FUSE_STATUS       0x20D1
2611 #define IGP01E1000_ANALOG_FUSE_STATUS             0x20D0
2612 #define IGP01E1000_ANALOG_FUSE_CONTROL            0x20DC
2613 #define IGP01E1000_ANALOG_FUSE_BYPASS             0x20DE
2614
2615 #define IGP01E1000_ANALOG_FUSE_POLY_MASK            0xF000
2616 #define IGP01E1000_ANALOG_FUSE_FINE_MASK            0x0F80
2617 #define IGP01E1000_ANALOG_FUSE_COARSE_MASK          0x0070
2618 #define IGP01E1000_ANALOG_SPARE_FUSE_ENABLED        0x0100
2619 #define IGP01E1000_ANALOG_FUSE_ENABLE_SW_CONTROL    0x0002
2620
2621 #define IGP01E1000_ANALOG_FUSE_COARSE_THRESH        0x0040
2622 #define IGP01E1000_ANALOG_FUSE_COARSE_10            0x0010
2623 #define IGP01E1000_ANALOG_FUSE_FINE_1               0x0080
2624 #define IGP01E1000_ANALOG_FUSE_FINE_10              0x0500
2625
2626
2627 /* Bit definitions for valid PHY IDs. */
2628 /* I = Integrated
2629  * E = External
2630  */
2631 #define M88E1000_E_PHY_ID  0x01410C50
2632 #define M88E1000_I_PHY_ID  0x01410C30
2633 #define M88E1011_I_PHY_ID  0x01410C20
2634 #define IGP01E1000_I_PHY_ID  0x02A80380
2635 #define M88E1000_12_PHY_ID M88E1000_E_PHY_ID
2636 #define M88E1000_14_PHY_ID M88E1000_E_PHY_ID
2637 #define M88E1011_I_REV_4   0x04
2638 #define M88E1111_I_PHY_ID  0x01410CC0
2639 #define L1LXT971A_PHY_ID   0x001378E0
2640
2641 /* Miscellaneous PHY bit definitions. */
2642 #define PHY_PREAMBLE        0xFFFFFFFF
2643 #define PHY_SOF             0x01
2644 #define PHY_OP_READ         0x02
2645 #define PHY_OP_WRITE        0x01
2646 #define PHY_TURNAROUND      0x02
2647 #define PHY_PREAMBLE_SIZE   32
2648 #define MII_CR_SPEED_1000   0x0040
2649 #define MII_CR_SPEED_100    0x2000
2650 #define MII_CR_SPEED_10     0x0000
2651 #define E1000_PHY_ADDRESS   0x01
2652 #define PHY_AUTO_NEG_TIME   45  /* 4.5 Seconds */
2653 #define PHY_FORCE_TIME      20  /* 2.0 Seconds */
2654 #define PHY_REVISION_MASK   0xFFFFFFF0
2655 #define DEVICE_SPEED_MASK   0x00000300  /* Device Ctrl Reg Speed Mask */
2656 #define REG4_SPEED_MASK     0x01E0
2657 #define REG9_SPEED_MASK     0x0300
2658 #define ADVERTISE_10_HALF   0x0001
2659 #define ADVERTISE_10_FULL   0x0002
2660 #define ADVERTISE_100_HALF  0x0004
2661 #define ADVERTISE_100_FULL  0x0008
2662 #define ADVERTISE_1000_HALF 0x0010
2663 #define ADVERTISE_1000_FULL 0x0020
2664 #define AUTONEG_ADVERTISE_SPEED_DEFAULT 0x002F  /* Everything but 1000-Half */
2665 #define AUTONEG_ADVERTISE_10_100_ALL    0x000F /* All 10/100 speeds*/
2666 #define AUTONEG_ADVERTISE_10_ALL        0x0003 /* 10Mbps Full & Half speeds*/
2667
2668 #endif /* _E1000_HW_H_ */