drivers/net/ethernet/intel/igb/e1000_hw.h

   1 /*******************************************************************************
   2
   3   Intel(R) Gigabit Ethernet Linux driver
   4   Copyright(c) 2007-2013 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 #include <linux/netdevice.h>
  35
  36 #include "e1000_regs.h"
  37 #include "e1000_defines.h"
  38
  39 struct e1000_hw;
  40
  41 #define E1000_DEV_ID_82576                      0x10C9
  42 #define E1000_DEV_ID_82576_FIBER                0x10E6
  43 #define E1000_DEV_ID_82576_SERDES               0x10E7
  44 #define E1000_DEV_ID_82576_QUAD_COPPER          0x10E8
  45 #define E1000_DEV_ID_82576_QUAD_COPPER_ET2      0x1526
  46 #define E1000_DEV_ID_82576_NS                   0x150A
  47 #define E1000_DEV_ID_82576_NS_SERDES            0x1518
  48 #define E1000_DEV_ID_82576_SERDES_QUAD          0x150D
  49 #define E1000_DEV_ID_82575EB_COPPER             0x10A7
  50 #define E1000_DEV_ID_82575EB_FIBER_SERDES       0x10A9
  51 #define E1000_DEV_ID_82575GB_QUAD_COPPER        0x10D6
  52 #define E1000_DEV_ID_82580_COPPER               0x150E
  53 #define E1000_DEV_ID_82580_FIBER                0x150F
  54 #define E1000_DEV_ID_82580_SERDES               0x1510
  55 #define E1000_DEV_ID_82580_SGMII                0x1511
  56 #define E1000_DEV_ID_82580_COPPER_DUAL          0x1516
  57 #define E1000_DEV_ID_82580_QUAD_FIBER           0x1527
  58 #define E1000_DEV_ID_DH89XXCC_SGMII             0x0438
  59 #define E1000_DEV_ID_DH89XXCC_SERDES            0x043A
  60 #define E1000_DEV_ID_DH89XXCC_BACKPLANE         0x043C
  61 #define E1000_DEV_ID_DH89XXCC_SFP               0x0440
  62 #define E1000_DEV_ID_I350_COPPER                0x1521
  63 #define E1000_DEV_ID_I350_FIBER                 0x1522
  64 #define E1000_DEV_ID_I350_SERDES                0x1523
  65 #define E1000_DEV_ID_I350_SGMII                 0x1524
  66 #define E1000_DEV_ID_I210_COPPER                0x1533
  67 #define E1000_DEV_ID_I210_FIBER                 0x1536
  68 #define E1000_DEV_ID_I210_SERDES                0x1537
  69 #define E1000_DEV_ID_I210_SGMII                 0x1538
  70 #define E1000_DEV_ID_I211_COPPER                0x1539
  71 #define E1000_DEV_ID_I354_BACKPLANE_1GBPS       0x1F40
  72 #define E1000_DEV_ID_I354_SGMII                 0x1F41
  73 #define E1000_DEV_ID_I354_BACKPLANE_2_5GBPS     0x1F45
  74
  75 #define E1000_REVISION_2 2
  76 #define E1000_REVISION_4 4
  77
  78 #define E1000_FUNC_0     0
  79 #define E1000_FUNC_1     1
  80 #define E1000_FUNC_2     2
  81 #define E1000_FUNC_3     3
  82
  83 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN0   0
  84 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN1   3
  85 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN2   6
  86 #define E1000_ALT_MAC_ADDRESS_OFFSET_LAN3   9
  87
  88 enum e1000_mac_type {
  89         e1000_undefined = 0,
  90         e1000_82575,
  91         e1000_82576,
  92         e1000_82580,
  93         e1000_i350,
  94         e1000_i354,
  95         e1000_i210,
  96         e1000_i211,
  97         e1000_num_macs  /* List is 1-based, so subtract 1 for true count. */
  98 };
  99
 100 enum e1000_media_type {
 101         e1000_media_type_unknown = 0,
 102         e1000_media_type_copper = 1,
 103         e1000_media_type_fiber = 2,
 104         e1000_media_type_internal_serdes = 3,
 105         e1000_num_media_types
 106 };
 107
 108 enum e1000_nvm_type {
 109         e1000_nvm_unknown = 0,
 110         e1000_nvm_none,
 111         e1000_nvm_eeprom_spi,
 112         e1000_nvm_flash_hw,
 113         e1000_nvm_invm,
 114         e1000_nvm_flash_sw
 115 };
 116
 117 enum e1000_nvm_override {
 118         e1000_nvm_override_none = 0,
 119         e1000_nvm_override_spi_small,
 120         e1000_nvm_override_spi_large,
 121 };
 122
 123 enum e1000_phy_type {
 124         e1000_phy_unknown = 0,
 125         e1000_phy_none,
 126         e1000_phy_m88,
 127         e1000_phy_igp,
 128         e1000_phy_igp_2,
 129         e1000_phy_gg82563,
 130         e1000_phy_igp_3,
 131         e1000_phy_ife,
 132         e1000_phy_82580,
 133         e1000_phy_i210,
 134 };
 135
 136 enum e1000_bus_type {
 137         e1000_bus_type_unknown = 0,
 138         e1000_bus_type_pci,
 139         e1000_bus_type_pcix,
 140         e1000_bus_type_pci_express,
 141         e1000_bus_type_reserved
 142 };
 143
 144 enum e1000_bus_speed {
 145         e1000_bus_speed_unknown = 0,
 146         e1000_bus_speed_33,
 147         e1000_bus_speed_66,
 148         e1000_bus_speed_100,
 149         e1000_bus_speed_120,
 150         e1000_bus_speed_133,
 151         e1000_bus_speed_2500,
 152         e1000_bus_speed_5000,
 153         e1000_bus_speed_reserved
 154 };
 155
 156 enum e1000_bus_width {
 157         e1000_bus_width_unknown = 0,
 158         e1000_bus_width_pcie_x1,
 159         e1000_bus_width_pcie_x2,
 160         e1000_bus_width_pcie_x4 = 4,
 161         e1000_bus_width_pcie_x8 = 8,
 162         e1000_bus_width_32,
 163         e1000_bus_width_64,
 164         e1000_bus_width_reserved
 165 };
 166
 167 enum e1000_1000t_rx_status {
 168         e1000_1000t_rx_status_not_ok = 0,
 169         e1000_1000t_rx_status_ok,
 170         e1000_1000t_rx_status_undefined = 0xFF
 171 };
 172
 173 enum e1000_rev_polarity {
 174         e1000_rev_polarity_normal = 0,
 175         e1000_rev_polarity_reversed,
 176         e1000_rev_polarity_undefined = 0xFF
 177 };
 178
 179 enum e1000_fc_mode {
 180         e1000_fc_none = 0,
 181         e1000_fc_rx_pause,
 182         e1000_fc_tx_pause,
 183         e1000_fc_full,
 184         e1000_fc_default = 0xFF
 185 };
 186
 187 /* Statistics counters collected by the MAC */
 188 struct e1000_hw_stats {
 189         u64 crcerrs;
 190         u64 algnerrc;
 191         u64 symerrs;
 192         u64 rxerrc;
 193         u64 mpc;
 194         u64 scc;
 195         u64 ecol;
 196         u64 mcc;
 197         u64 latecol;
 198         u64 colc;
 199         u64 dc;
 200         u64 tncrs;
 201         u64 sec;
 202         u64 cexterr;
 203         u64 rlec;
 204         u64 xonrxc;
 205         u64 xontxc;
 206         u64 xoffrxc;
 207         u64 xofftxc;
 208         u64 fcruc;
 209         u64 prc64;
 210         u64 prc127;
 211         u64 prc255;
 212         u64 prc511;
 213         u64 prc1023;
 214         u64 prc1522;
 215         u64 gprc;
 216         u64 bprc;
 217         u64 mprc;
 218         u64 gptc;
 219         u64 gorc;
 220         u64 gotc;
 221         u64 rnbc;
 222         u64 ruc;
 223         u64 rfc;
 224         u64 roc;
 225         u64 rjc;
 226         u64 mgprc;
 227         u64 mgpdc;
 228         u64 mgptc;
 229         u64 tor;
 230         u64 tot;
 231         u64 tpr;
 232         u64 tpt;
 233         u64 ptc64;
 234         u64 ptc127;
 235         u64 ptc255;
 236         u64 ptc511;
 237         u64 ptc1023;
 238         u64 ptc1522;
 239         u64 mptc;
 240         u64 bptc;
 241         u64 tsctc;
 242         u64 tsctfc;
 243         u64 iac;
 244         u64 icrxptc;
 245         u64 icrxatc;
 246         u64 ictxptc;
 247         u64 ictxatc;
 248         u64 ictxqec;
 249         u64 ictxqmtc;
 250         u64 icrxdmtc;
 251         u64 icrxoc;
 252         u64 cbtmpc;
 253         u64 htdpmc;
 254         u64 cbrdpc;
 255         u64 cbrmpc;
 256         u64 rpthc;
 257         u64 hgptc;
 258         u64 htcbdpc;
 259         u64 hgorc;
 260         u64 hgotc;
 261         u64 lenerrs;
 262         u64 scvpc;
 263         u64 hrmpc;
 264         u64 doosync;
 265         u64 o2bgptc;
 266         u64 o2bspc;
 267         u64 b2ospc;
 268         u64 b2ogprc;
 269 };
 270
 271 struct e1000_phy_stats {
 272         u32 idle_errors;
 273         u32 receive_errors;
 274 };
 275
 276 struct e1000_host_mng_dhcp_cookie {
 277         u32 signature;
 278         u8  status;
 279         u8  reserved0;
 280         u16 vlan_id;
 281         u32 reserved1;
 282         u16 reserved2;
 283         u8  reserved3;
 284         u8  checksum;
 285 };
 286
 287 /* Host Interface "Rev 1" */
 288 struct e1000_host_command_header {
 289         u8 command_id;
 290         u8 command_length;
 291         u8 command_options;
 292         u8 checksum;
 293 };
 294
 295 #define E1000_HI_MAX_DATA_LENGTH     252
 296 struct e1000_host_command_info {
 297         struct e1000_host_command_header command_header;
 298         u8 command_data[E1000_HI_MAX_DATA_LENGTH];
 299 };
 300
 301 /* Host Interface "Rev 2" */
 302 struct e1000_host_mng_command_header {
 303         u8  command_id;
 304         u8  checksum;
 305         u16 reserved1;
 306         u16 reserved2;
 307         u16 command_length;
 308 };
 309
 310 #define E1000_HI_MAX_MNG_DATA_LENGTH 0x6F8
 311 struct e1000_host_mng_command_info {
 312         struct e1000_host_mng_command_header command_header;
 313         u8 command_data[E1000_HI_MAX_MNG_DATA_LENGTH];
 314 };
 315
 316 #include "e1000_mac.h"
 317 #include "e1000_phy.h"
 318 #include "e1000_nvm.h"
 319 #include "e1000_mbx.h"
 320
 321 struct e1000_mac_operations {
 322         s32  (*check_for_link)(struct e1000_hw *);
 323         s32  (*reset_hw)(struct e1000_hw *);
 324         s32  (*init_hw)(struct e1000_hw *);
 325         bool (*check_mng_mode)(struct e1000_hw *);
 326         s32  (*setup_physical_interface)(struct e1000_hw *);
 327         void (*rar_set)(struct e1000_hw *, u8 *, u32);
 328         s32  (*read_mac_addr)(struct e1000_hw *);
 329         s32  (*get_speed_and_duplex)(struct e1000_hw *, u16 *, u16 *);
 330         s32  (*acquire_swfw_sync)(struct e1000_hw *, u16);
 331         void (*release_swfw_sync)(struct e1000_hw *, u16);
 332 #ifdef CONFIG_IGB_HWMON
 333         s32 (*get_thermal_sensor_data)(struct e1000_hw *);
 334         s32 (*init_thermal_sensor_thresh)(struct e1000_hw *);
 335 #endif
 336
 337 };
 338
 339 struct e1000_phy_operations {
 340         s32  (*acquire)(struct e1000_hw *);
 341         s32  (*check_polarity)(struct e1000_hw *);
 342         s32  (*check_reset_block)(struct e1000_hw *);
 343         s32  (*force_speed_duplex)(struct e1000_hw *);
 344         s32  (*get_cfg_done)(struct e1000_hw *hw);
 345         s32  (*get_cable_length)(struct e1000_hw *);
 346         s32  (*get_phy_info)(struct e1000_hw *);
 347         s32  (*read_reg)(struct e1000_hw *, u32, u16 *);
 348         void (*release)(struct e1000_hw *);
 349         s32  (*reset)(struct e1000_hw *);
 350         s32  (*set_d0_lplu_state)(struct e1000_hw *, bool);
 351         s32  (*set_d3_lplu_state)(struct e1000_hw *, bool);
 352         s32  (*write_reg)(struct e1000_hw *, u32, u16);
 353         s32 (*read_i2c_byte)(struct e1000_hw *, u8, u8, u8 *);
 354         s32 (*write_i2c_byte)(struct e1000_hw *, u8, u8, u8);
 355 };
 356
 357 struct e1000_nvm_operations {
 358         s32  (*acquire)(struct e1000_hw *);
 359         s32  (*read)(struct e1000_hw *, u16, u16, u16 *);
 360         void (*release)(struct e1000_hw *);
 361         s32  (*write)(struct e1000_hw *, u16, u16, u16 *);
 362         s32  (*update)(struct e1000_hw *);
 363         s32  (*validate)(struct e1000_hw *);
 364         s32  (*valid_led_default)(struct e1000_hw *, u16 *);
 365 };
 366
 367 #define E1000_MAX_SENSORS               3
 368
 369 struct e1000_thermal_diode_data {
 370         u8 location;
 371         u8 temp;
 372         u8 caution_thresh;
 373         u8 max_op_thresh;
 374 };
 375
 376 struct e1000_thermal_sensor_data {
 377         struct e1000_thermal_diode_data sensor[E1000_MAX_SENSORS];
 378 };
 379
 380 struct e1000_info {
 381         s32 (*get_invariants)(struct e1000_hw *);
 382         struct e1000_mac_operations *mac_ops;
 383         struct e1000_phy_operations *phy_ops;
 384         struct e1000_nvm_operations *nvm_ops;
 385 };
 386
 387 extern const struct e1000_info e1000_82575_info;
 388
 389 struct e1000_mac_info {
 390         struct e1000_mac_operations ops;
 391
 392         u8 addr[6];
 393         u8 perm_addr[6];
 394
 395         enum e1000_mac_type type;
 396
 397         u32 ledctl_default;
 398         u32 ledctl_mode1;
 399         u32 ledctl_mode2;
 400         u32 mc_filter_type;
 401         u32 txcw;
 402
 403         u16 mta_reg_count;
 404         u16 uta_reg_count;
 405
 406         /* Maximum size of the MTA register table in all supported adapters */
 407         #define MAX_MTA_REG 128
 408         u32 mta_shadow[MAX_MTA_REG];
 409         u16 rar_entry_count;
 410
 411         u8  forced_speed_duplex;
 412
 413         bool adaptive_ifs;
 414         bool arc_subsystem_valid;
 415         bool asf_firmware_present;
 416         bool autoneg;
 417         bool autoneg_failed;
 418         bool disable_hw_init_bits;
 419         bool get_link_status;
 420         bool ifs_params_forced;
 421         bool in_ifs_mode;
 422         bool report_tx_early;
 423         bool serdes_has_link;
 424         bool tx_pkt_filtering;
 425         struct e1000_thermal_sensor_data thermal_sensor_data;
 426 };
 427
 428 struct e1000_phy_info {
 429         struct e1000_phy_operations ops;
 430
 431         enum e1000_phy_type type;
 432
 433         enum e1000_1000t_rx_status local_rx;
 434         enum e1000_1000t_rx_status remote_rx;
 435         enum e1000_ms_type ms_type;
 436         enum e1000_ms_type original_ms_type;
 437         enum e1000_rev_polarity cable_polarity;
 438         enum e1000_smart_speed smart_speed;
 439
 440         u32 addr;
 441         u32 id;
 442         u32 reset_delay_us; /* in usec */
 443         u32 revision;
 444
 445         enum e1000_media_type media_type;
 446
 447         u16 autoneg_advertised;
 448         u16 autoneg_mask;
 449         u16 cable_length;
 450         u16 max_cable_length;
 451         u16 min_cable_length;
 452
 453         u8 mdix;
 454
 455         bool disable_polarity_correction;
 456         bool is_mdix;
 457         bool polarity_correction;
 458         bool reset_disable;
 459         bool speed_downgraded;
 460         bool autoneg_wait_to_complete;
 461 };
 462
 463 struct e1000_nvm_info {
 464         struct e1000_nvm_operations ops;
 465         enum e1000_nvm_type type;
 466         enum e1000_nvm_override override;
 467
 468         u32 flash_bank_size;
 469         u32 flash_base_addr;
 470
 471         u16 word_size;
 472         u16 delay_usec;
 473         u16 address_bits;
 474         u16 opcode_bits;
 475         u16 page_size;
 476 };
 477
 478 struct e1000_bus_info {
 479         enum e1000_bus_type type;
 480         enum e1000_bus_speed speed;
 481         enum e1000_bus_width width;
 482
 483         u32 snoop;
 484
 485         u16 func;
 486         u16 pci_cmd_word;
 487 };
 488
 489 struct e1000_fc_info {
 490         u32 high_water;     /* Flow control high-water mark */
 491         u32 low_water;      /* Flow control low-water mark */
 492         u16 pause_time;     /* Flow control pause timer */
 493         bool send_xon;      /* Flow control send XON */
 494         bool strict_ieee;   /* Strict IEEE mode */
 495         enum e1000_fc_mode current_mode; /* Type of flow control */
 496         enum e1000_fc_mode requested_mode;
 497 };
 498
 499 struct e1000_mbx_operations {
 500         s32 (*init_params)(struct e1000_hw *hw);
 501         s32 (*read)(struct e1000_hw *, u32 *, u16,  u16);
 502         s32 (*write)(struct e1000_hw *, u32 *, u16, u16);
 503         s32 (*read_posted)(struct e1000_hw *, u32 *, u16,  u16);
 504         s32 (*write_posted)(struct e1000_hw *, u32 *, u16, u16);
 505         s32 (*check_for_msg)(struct e1000_hw *, u16);
 506         s32 (*check_for_ack)(struct e1000_hw *, u16);
 507         s32 (*check_for_rst)(struct e1000_hw *, u16);
 508 };
 509
 510 struct e1000_mbx_stats {
 511         u32 msgs_tx;
 512         u32 msgs_rx;
 513
 514         u32 acks;
 515         u32 reqs;
 516         u32 rsts;
 517 };
 518
 519 struct e1000_mbx_info {
 520         struct e1000_mbx_operations ops;
 521         struct e1000_mbx_stats stats;
 522         u32 timeout;
 523         u32 usec_delay;
 524         u16 size;
 525 };
 526
 527 struct e1000_dev_spec_82575 {
 528         bool sgmii_active;
 529         bool global_device_reset;
 530         bool eee_disable;
 531         bool clear_semaphore_once;
 532         struct e1000_sfp_flags eth_flags;
 533         bool module_plugged;
 534 };
 535
 536 struct e1000_hw {
 537         void *back;
 538
 539         u8 __iomem *hw_addr;
 540         u8 __iomem *flash_address;
 541         unsigned long io_base;
 542
 543         struct e1000_mac_info  mac;
 544         struct e1000_fc_info   fc;
 545         struct e1000_phy_info  phy;
 546         struct e1000_nvm_info  nvm;
 547         struct e1000_bus_info  bus;
 548         struct e1000_mbx_info mbx;
 549         struct e1000_host_mng_dhcp_cookie mng_cookie;
 550
 551         union {
 552                 struct e1000_dev_spec_82575     _82575;
 553         } dev_spec;
 554
 555         u16 device_id;
 556         u16 subsystem_vendor_id;
 557         u16 subsystem_device_id;
 558         u16 vendor_id;
 559
 560         u8  revision_id;
 561 };
 562
 563 extern struct net_device *igb_get_hw_dev(struct e1000_hw *hw);
 564 #define hw_dbg(format, arg...) \
 565         netdev_dbg(igb_get_hw_dev(hw), format, ##arg)
 566
 567 /* These functions must be implemented by drivers */
 568 s32  igb_read_pcie_cap_reg(struct e1000_hw *hw, u32 reg, u16 *value);
 569 s32  igb_write_pcie_cap_reg(struct e1000_hw *hw, u32 reg, u16 *value);
 570 #endif /* _E1000_HW_H_ */