drivers/net/igb/e1000_hw.h

   1 /*******************************************************************************
   2
   3   Intel(R) Gigabit Ethernet Linux driver
   4   Copyright(c) 2007-2009 Intel Corporation.
   5
   6   This program is free software; you can redistribute it and/or modify it
   7   under the terms and conditions of the GNU General Public License,
   8   version 2, as published by the Free Software Foundation.
   9
  10   This program is distributed in the hope it will be useful, but WITHOUT
  11   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  13   more details.
  14
  15   You should have received a copy of the GNU General Public License along with
  16   this program; if not, write to the Free Software Foundation, Inc.,
  17   51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
  18
  19   The full GNU General Public License is included in this distribution in
  20   the file called "COPYING".
  21
  22   Contact Information:
  23   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
  24   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
  25
  26 *******************************************************************************/
  27
  28 #ifndef _E1000_HW_H_
  29 #define _E1000_HW_H_
  30
  31 #include <linux/types.h>
  32 #include <linux/delay.h>
  33 #include <linux/io.h>
  34
  35 #include "e1000_regs.h"
  36 #include "e1000_defines.h"
  37
  38 struct e1000_hw;
  39
  40 #define E1000_DEV_ID_82576                    0x10C9
  41 #define E1000_DEV_ID_82576_FIBER              0x10E6
  42 #define E1000_DEV_ID_82576_SERDES             0x10E7
  43 #define E1000_DEV_ID_82576_QUAD_COPPER        0x10E8
  44 #define E1000_DEV_ID_82576_NS                 0x150A
  45 #define E1000_DEV_ID_82575EB_COPPER           0x10A7
  46 #define E1000_DEV_ID_82575EB_FIBER_SERDES     0x10A9
  47 #define E1000_DEV_ID_82575GB_QUAD_COPPER      0x10D6
  48
  49 #define E1000_REVISION_2 2
  50 #define E1000_REVISION_4 4
  51
  52 #define E1000_FUNC_1     1
  53
  54 enum e1000_mac_type {
  55         e1000_undefined = 0,
  56         e1000_82575,
  57         e1000_82576,
  58         e1000_num_macs  /* List is 1-based, so subtract 1 for true count. */
  59 };
  60
  61 enum e1000_media_type {
  62         e1000_media_type_unknown = 0,
  63         e1000_media_type_copper = 1,
  64         e1000_media_type_internal_serdes = 2,
  65         e1000_num_media_types
  66 };
  67
  68 enum e1000_nvm_type {
  69         e1000_nvm_unknown = 0,
  70         e1000_nvm_none,
  71         e1000_nvm_eeprom_spi,
  72         e1000_nvm_eeprom_microwire,
  73         e1000_nvm_flash_hw,
  74         e1000_nvm_flash_sw
  75 };
  76
  77 enum e1000_nvm_override {
  78         e1000_nvm_override_none = 0,
  79         e1000_nvm_override_spi_small,
  80         e1000_nvm_override_spi_large,
  81         e1000_nvm_override_microwire_small,
  82         e1000_nvm_override_microwire_large
  83 };
  84
  85 enum e1000_phy_type {
  86         e1000_phy_unknown = 0,
  87         e1000_phy_none,
  88         e1000_phy_m88,
  89         e1000_phy_igp,
  90         e1000_phy_igp_2,
  91         e1000_phy_gg82563,
  92         e1000_phy_igp_3,
  93         e1000_phy_ife,
  94 };
  95
  96 enum e1000_bus_type {
  97         e1000_bus_type_unknown = 0,
  98         e1000_bus_type_pci,
  99         e1000_bus_type_pcix,
 100         e1000_bus_type_pci_express,
 101         e1000_bus_type_reserved
 102 };
 103
 104 enum e1000_bus_speed {
 105         e1000_bus_speed_unknown = 0,
 106         e1000_bus_speed_33,
 107         e1000_bus_speed_66,
 108         e1000_bus_speed_100,
 109         e1000_bus_speed_120,
 110         e1000_bus_speed_133,
 111         e1000_bus_speed_2500,
 112         e1000_bus_speed_5000,
 113         e1000_bus_speed_reserved
 114 };
 115
 116 enum e1000_bus_width {
 117         e1000_bus_width_unknown = 0,
 118         e1000_bus_width_pcie_x1,
 119         e1000_bus_width_pcie_x2,
 120         e1000_bus_width_pcie_x4 = 4,
 121         e1000_bus_width_pcie_x8 = 8,
 122         e1000_bus_width_32,
 123         e1000_bus_width_64,
 124         e1000_bus_width_reserved
 125 };
 126
 127 enum e1000_1000t_rx_status {
 128         e1000_1000t_rx_status_not_ok = 0,
 129         e1000_1000t_rx_status_ok,
 130         e1000_1000t_rx_status_undefined = 0xFF
 131 };
 132
 133 enum e1000_rev_polarity {
 134         e1000_rev_polarity_normal = 0,
 135         e1000_rev_polarity_reversed,
 136         e1000_rev_polarity_undefined = 0xFF
 137 };
 138
 139 enum e1000_fc_type {
 140         e1000_fc_none = 0,
 141         e1000_fc_rx_pause,
 142         e1000_fc_tx_pause,
 143         e1000_fc_full,
 144         e1000_fc_default = 0xFF
 145 };
 146
 147 /* Statistics counters collected by the MAC */
 148 struct e1000_hw_stats {
 149         u64 crcerrs;
 150         u64 algnerrc;
 151         u64 symerrs;
 152         u64 rxerrc;
 153         u64 mpc;
 154         u64 scc;
 155         u64 ecol;
 156         u64 mcc;
 157         u64 latecol;
 158         u64 colc;
 159         u64 dc;
 160         u64 tncrs;
 161         u64 sec;
 162         u64 cexterr;
 163         u64 rlec;
 164         u64 xonrxc;
 165         u64 xontxc;
 166         u64 xoffrxc;
 167         u64 xofftxc;
 168         u64 fcruc;
 169         u64 prc64;
 170         u64 prc127;
 171         u64 prc255;
 172         u64 prc511;
 173         u64 prc1023;
 174         u64 prc1522;
 175         u64 gprc;
 176         u64 bprc;
 177         u64 mprc;
 178         u64 gptc;
 179         u64 gorc;
 180         u64 gotc;
 181         u64 rnbc;
 182         u64 ruc;
 183         u64 rfc;
 184         u64 roc;
 185         u64 rjc;
 186         u64 mgprc;
 187         u64 mgpdc;
 188         u64 mgptc;
 189         u64 tor;
 190         u64 tot;
 191         u64 tpr;
 192         u64 tpt;
 193         u64 ptc64;
 194         u64 ptc127;
 195         u64 ptc255;
 196         u64 ptc511;
 197         u64 ptc1023;
 198         u64 ptc1522;
 199         u64 mptc;
 200         u64 bptc;
 201         u64 tsctc;
 202         u64 tsctfc;
 203         u64 iac;
 204         u64 icrxptc;
 205         u64 icrxatc;
 206         u64 ictxptc;
 207         u64 ictxatc;
 208         u64 ictxqec;
 209         u64 ictxqmtc;
 210         u64 icrxdmtc;
 211         u64 icrxoc;
 212         u64 cbtmpc;
 213         u64 htdpmc;
 214         u64 cbrdpc;
 215         u64 cbrmpc;
 216         u64 rpthc;
 217         u64 hgptc;
 218         u64 htcbdpc;
 219         u64 hgorc;
 220         u64 hgotc;
 221         u64 lenerrs;
 222         u64 scvpc;
 223         u64 hrmpc;
 224         u64 doosync;
 225 };
 226
 227 struct e1000_phy_stats {
 228         u32 idle_errors;
 229         u32 receive_errors;
 230 };
 231
 232 struct e1000_host_mng_dhcp_cookie {
 233         u32 signature;
 234         u8  status;
 235         u8  reserved0;
 236         u16 vlan_id;
 237         u32 reserved1;
 238         u16 reserved2;
 239         u8  reserved3;
 240         u8  checksum;
 241 };
 242
 243 /* Host Interface "Rev 1" */
 244 struct e1000_host_command_header {
 245         u8 command_id;
 246         u8 command_length;
 247         u8 command_options;
 248         u8 checksum;
 249 };
 250
 251 #define E1000_HI_MAX_DATA_LENGTH     252
 252 struct e1000_host_command_info {
 253         struct e1000_host_command_header command_header;
 254         u8 command_data[E1000_HI_MAX_DATA_LENGTH];
 255 };
 256
 257 /* Host Interface "Rev 2" */
 258 struct e1000_host_mng_command_header {
 259         u8  command_id;
 260         u8  checksum;
 261         u16 reserved1;
 262         u16 reserved2;
 263         u16 command_length;
 264 };
 265
 266 #define E1000_HI_MAX_MNG_DATA_LENGTH 0x6F8
 267 struct e1000_host_mng_command_info {
 268         struct e1000_host_mng_command_header command_header;
 269         u8 command_data[E1000_HI_MAX_MNG_DATA_LENGTH];
 270 };
 271
 272 #include "e1000_mac.h"
 273 #include "e1000_phy.h"
 274 #include "e1000_nvm.h"
 275 #include "e1000_mbx.h"
 276
 277 struct e1000_mac_operations {
 278         s32  (*check_for_link)(struct e1000_hw *);
 279         s32  (*reset_hw)(struct e1000_hw *);
 280         s32  (*init_hw)(struct e1000_hw *);
 281         bool (*check_mng_mode)(struct e1000_hw *);
 282         s32  (*setup_physical_interface)(struct e1000_hw *);
 283         void (*rar_set)(struct e1000_hw *, u8 *, u32);
 284         s32  (*read_mac_addr)(struct e1000_hw *);
 285         s32  (*get_speed_and_duplex)(struct e1000_hw *, u16 *, u16 *);
 286 };
 287
 288 struct e1000_phy_operations {
 289         s32  (*acquire)(struct e1000_hw *);
 290         s32  (*check_reset_block)(struct e1000_hw *);
 291         s32  (*force_speed_duplex)(struct e1000_hw *);
 292         s32  (*get_cfg_done)(struct e1000_hw *hw);
 293         s32  (*get_cable_length)(struct e1000_hw *);
 294         s32  (*get_phy_info)(struct e1000_hw *);
 295         s32  (*read_reg)(struct e1000_hw *, u32, u16 *);
 296         void (*release)(struct e1000_hw *);
 297         s32  (*reset)(struct e1000_hw *);
 298         s32  (*set_d0_lplu_state)(struct e1000_hw *, bool);
 299         s32  (*set_d3_lplu_state)(struct e1000_hw *, bool);
 300         s32  (*write_reg)(struct e1000_hw *, u32, u16);
 301 };
 302
 303 struct e1000_nvm_operations {
 304         s32  (*acquire)(struct e1000_hw *);
 305         s32  (*read)(struct e1000_hw *, u16, u16, u16 *);
 306         void (*release)(struct e1000_hw *);
 307         s32  (*write)(struct e1000_hw *, u16, u16, u16 *);
 308 };
 309
 310 struct e1000_info {
 311         s32 (*get_invariants)(struct e1000_hw *);
 312         struct e1000_mac_operations *mac_ops;
 313         struct e1000_phy_operations *phy_ops;
 314         struct e1000_nvm_operations *nvm_ops;
 315 };
 316
 317 extern const struct e1000_info e1000_82575_info;
 318
 319 struct e1000_mac_info {
 320         struct e1000_mac_operations ops;
 321
 322         u8 addr[6];
 323         u8 perm_addr[6];
 324
 325         enum e1000_mac_type type;
 326
 327         u32 collision_delta;
 328         u32 ledctl_default;
 329         u32 ledctl_mode1;
 330         u32 ledctl_mode2;
 331         u32 mc_filter_type;
 332         u32 tx_packet_delta;
 333         u32 txcw;
 334
 335         u16 current_ifs_val;
 336         u16 ifs_max_val;
 337         u16 ifs_min_val;
 338         u16 ifs_ratio;
 339         u16 ifs_step_size;
 340         u16 mta_reg_count;
 341
 342         /* Maximum size of the MTA register table in all supported adapters */
 343         #define MAX_MTA_REG 128
 344         u32 mta_shadow[MAX_MTA_REG];
 345         u16 rar_entry_count;
 346
 347         u8  forced_speed_duplex;
 348
 349         bool adaptive_ifs;
 350         bool arc_subsystem_valid;
 351         bool asf_firmware_present;
 352         bool autoneg;
 353         bool autoneg_failed;
 354         bool disable_hw_init_bits;
 355         bool get_link_status;
 356         bool ifs_params_forced;
 357         bool in_ifs_mode;
 358         bool report_tx_early;
 359         bool serdes_has_link;
 360         bool tx_pkt_filtering;
 361 };
 362
 363 struct e1000_phy_info {
 364         struct e1000_phy_operations ops;
 365
 366         enum e1000_phy_type type;
 367
 368         enum e1000_1000t_rx_status local_rx;
 369         enum e1000_1000t_rx_status remote_rx;
 370         enum e1000_ms_type ms_type;
 371         enum e1000_ms_type original_ms_type;
 372         enum e1000_rev_polarity cable_polarity;
 373         enum e1000_smart_speed smart_speed;
 374
 375         u32 addr;
 376         u32 id;
 377         u32 reset_delay_us; /* in usec */
 378         u32 revision;
 379
 380         enum e1000_media_type media_type;
 381
 382         u16 autoneg_advertised;
 383         u16 autoneg_mask;
 384         u16 cable_length;
 385         u16 max_cable_length;
 386         u16 min_cable_length;
 387
 388         u8 mdix;
 389
 390         bool disable_polarity_correction;
 391         bool is_mdix;
 392         bool polarity_correction;
 393         bool reset_disable;
 394         bool speed_downgraded;
 395         bool autoneg_wait_to_complete;
 396 };
 397
 398 struct e1000_nvm_info {
 399         struct e1000_nvm_operations ops;
 400
 401         enum e1000_nvm_type type;
 402         enum e1000_nvm_override override;
 403
 404         u32 flash_bank_size;
 405         u32 flash_base_addr;
 406
 407         u16 word_size;
 408         u16 delay_usec;
 409         u16 address_bits;
 410         u16 opcode_bits;
 411         u16 page_size;
 412 };
 413
 414 struct e1000_bus_info {
 415         enum e1000_bus_type type;
 416         enum e1000_bus_speed speed;
 417         enum e1000_bus_width width;
 418
 419         u32 snoop;
 420
 421         u16 func;
 422         u16 pci_cmd_word;
 423 };
 424
 425 struct e1000_fc_info {
 426         u32 high_water;     /* Flow control high-water mark */
 427         u32 low_water;      /* Flow control low-water mark */
 428         u16 pause_time;     /* Flow control pause timer */
 429         bool send_xon;      /* Flow control send XON */
 430         bool strict_ieee;   /* Strict IEEE mode */
 431         enum e1000_fc_type type; /* Type of flow control */
 432         enum e1000_fc_type original_type;
 433 };
 434
 435 struct e1000_mbx_operations {
 436         s32 (*init_params)(struct e1000_hw *hw);
 437         s32 (*read)(struct e1000_hw *, u32 *, u16,  u16);
 438         s32 (*write)(struct e1000_hw *, u32 *, u16, u16);
 439         s32 (*read_posted)(struct e1000_hw *, u32 *, u16,  u16);
 440         s32 (*write_posted)(struct e1000_hw *, u32 *, u16, u16);
 441         s32 (*check_for_msg)(struct e1000_hw *, u16);
 442         s32 (*check_for_ack)(struct e1000_hw *, u16);
 443         s32 (*check_for_rst)(struct e1000_hw *, u16);
 444 };
 445
 446 struct e1000_mbx_stats {
 447         u32 msgs_tx;
 448         u32 msgs_rx;
 449
 450         u32 acks;
 451         u32 reqs;
 452         u32 rsts;
 453 };
 454
 455 struct e1000_mbx_info {
 456         struct e1000_mbx_operations ops;
 457         struct e1000_mbx_stats stats;
 458         u32 timeout;
 459         u32 usec_delay;
 460         u16 size;
 461 };
 462
 463 struct e1000_dev_spec_82575 {
 464         bool sgmii_active;
 465 };
 466
 467 struct e1000_hw {
 468         void *back;
 469
 470         u8 __iomem *hw_addr;
 471         u8 __iomem *flash_address;
 472         unsigned long io_base;
 473
 474         struct e1000_mac_info  mac;
 475         struct e1000_fc_info   fc;
 476         struct e1000_phy_info  phy;
 477         struct e1000_nvm_info  nvm;
 478         struct e1000_bus_info  bus;
 479         struct e1000_mbx_info mbx;
 480         struct e1000_host_mng_dhcp_cookie mng_cookie;
 481
 482         union {
 483                 struct e1000_dev_spec_82575     _82575;
 484         } dev_spec;
 485
 486         u16 device_id;
 487         u16 subsystem_vendor_id;
 488         u16 subsystem_device_id;
 489         u16 vendor_id;
 490
 491         u8  revision_id;
 492 };
 493
 494 #ifdef DEBUG
 495 extern char *igb_get_hw_dev_name(struct e1000_hw *hw);
 496 #define hw_dbg(format, arg...) \
 497         printk(KERN_DEBUG "%s: " format, igb_get_hw_dev_name(hw), ##arg)
 498 #else
 499 #define hw_dbg(format, arg...)
 500 #endif
 501 #endif
 502 /* These functions must be implemented by drivers */
 503 s32  igb_read_pcie_cap_reg(struct e1000_hw *hw, u32 reg, u16 *value);
 504 s32  igb_write_pcie_cap_reg(struct e1000_hw *hw, u32 reg, u16 *value);