1 /*******************************************************************************
 
   3   Intel PRO/1000 Linux driver
 
   4   Copyright(c) 1999 - 2008 Intel Corporation.
 
   6   This program is free software; you can redistribute it and/or modify it
 
   7   under the terms and conditions of the GNU General Public License,
 
   8   version 2, as published by the Free Software Foundation.
 
  10   This program is distributed in the hope it will be useful, but WITHOUT
 
  11   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 
  12   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 
  15   You should have received a copy of the GNU General Public License along with
 
  16   this program; if not, write to the Free Software Foundation, Inc.,
 
  17   51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
 
  19   The full GNU General Public License is included in this distribution in
 
  20   the file called "COPYING".
 
  23   Linux NICS <linux.nics@intel.com>
 
  24   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
 
  25   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
 
  27 *******************************************************************************/
 
  29 /* Linux PRO/1000 Ethernet Driver main header file */
 
  34 #include <linux/types.h>
 
  35 #include <linux/timer.h>
 
  36 #include <linux/workqueue.h>
 
  38 #include <linux/netdevice.h>
 
  44 #define e_printk(level, adapter, format, arg...) \
 
  45         printk(level "%s: %s: " format, pci_name(adapter->pdev), \
 
  46                adapter->netdev->name, ## arg)
 
  49 #define e_dbg(format, arg...) \
 
  50         e_printk(KERN_DEBUG , adapter, format, ## arg)
 
  52 #define e_dbg(format, arg...) do { (void)(adapter); } while (0)
 
  55 #define e_err(format, arg...) \
 
  56         e_printk(KERN_ERR, adapter, format, ## arg)
 
  57 #define e_info(format, arg...) \
 
  58         e_printk(KERN_INFO, adapter, format, ## arg)
 
  59 #define e_warn(format, arg...) \
 
  60         e_printk(KERN_WARNING, adapter, format, ## arg)
 
  61 #define e_notice(format, arg...) \
 
  62         e_printk(KERN_NOTICE, adapter, format, ## arg)
 
  65 /* Interrupt modes, as used by the IntMode paramter */
 
  66 #define E1000E_INT_MODE_LEGACY          0
 
  67 #define E1000E_INT_MODE_MSI             1
 
  68 #define E1000E_INT_MODE_MSIX            2
 
  70 /* Tx/Rx descriptor defines */
 
  71 #define E1000_DEFAULT_TXD               256
 
  72 #define E1000_MAX_TXD                   4096
 
  73 #define E1000_MIN_TXD                   64
 
  75 #define E1000_DEFAULT_RXD               256
 
  76 #define E1000_MAX_RXD                   4096
 
  77 #define E1000_MIN_RXD                   64
 
  79 #define E1000_MIN_ITR_USECS             10 /* 100000 irq/sec */
 
  80 #define E1000_MAX_ITR_USECS             10000 /* 100    irq/sec */
 
  82 /* Early Receive defines */
 
  83 #define E1000_ERT_2048                  0x100
 
  85 #define E1000_FC_PAUSE_TIME             0x0680 /* 858 usec */
 
  87 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
 
  88 /* How many Rx Buffers do we bundle into one write to the hardware ? */
 
  89 #define E1000_RX_BUFFER_WRITE           16 /* Must be power of 2 */
 
  91 #define AUTO_ALL_MODES                  0
 
  92 #define E1000_EEPROM_APME               0x0400
 
  94 #define E1000_MNG_VLAN_NONE             (-1)
 
  96 /* Number of packet split data buffers (not including the header buffer) */
 
  97 #define PS_PAGE_BUFFERS                 (MAX_PS_BUFFERS - 1)
 
 110 struct e1000_queue_stats {
 
 115 struct e1000_ps_page {
 
 117         u64 dma; /* must be u64 - written to hw */
 
 121  * wrappers around a pointer to a socket buffer,
 
 122  * so a DMA handle can be stored along with the buffer
 
 124 struct e1000_buffer {
 
 130                         unsigned long time_stamp;
 
 135                 /* arrays of page information for packet split */
 
 136                 struct e1000_ps_page *ps_pages;
 
 142         void *desc;                     /* pointer to ring memory  */
 
 143         dma_addr_t dma;                 /* phys address of ring    */
 
 144         unsigned int size;              /* length of ring in bytes */
 
 145         unsigned int count;             /* number of desc. in ring */
 
 153         /* array of buffer information structs */
 
 154         struct e1000_buffer *buffer_info;
 
 156         char name[IFNAMSIZ + 5];
 
 162         struct sk_buff *rx_skb_top;
 
 164         struct e1000_queue_stats stats;
 
 167 /* PHY register snapshot values */
 
 168 struct e1000_phy_regs {
 
 169         u16 bmcr;               /* basic mode control register    */
 
 170         u16 bmsr;               /* basic mode status register     */
 
 171         u16 advertise;          /* auto-negotiation advertisement */
 
 172         u16 lpa;                /* link partner ability register  */
 
 173         u16 expansion;          /* auto-negotiation expansion reg */
 
 174         u16 ctrl1000;           /* 1000BASE-T control register    */
 
 175         u16 stat1000;           /* 1000BASE-T status register     */
 
 176         u16 estatus;            /* extended status register       */
 
 179 /* board specific private data structure */
 
 180 struct e1000_adapter {
 
 181         struct timer_list watchdog_timer;
 
 182         struct timer_list phy_info_timer;
 
 183         struct timer_list blink_timer;
 
 185         struct work_struct reset_task;
 
 186         struct work_struct watchdog_task;
 
 188         const struct e1000_info *ei;
 
 190         struct vlan_group *vlgrp;
 
 198         /* track device up/down/testing state */
 
 201         /* Interrupt Throttle Rate */
 
 210         struct e1000_ring *tx_ring /* One per active queue */
 
 211                                                 ____cacheline_aligned_in_smp;
 
 213         struct napi_struct napi;
 
 215         unsigned long tx_queue_len;
 
 216         unsigned int restart_queue;
 
 220         u8 tx_timeout_factor;
 
 223         u32 tx_abs_int_delay;
 
 225         unsigned int total_tx_bytes;
 
 226         unsigned int total_tx_packets;
 
 227         unsigned int total_rx_bytes;
 
 228         unsigned int total_rx_packets;
 
 235         u32 tx_timeout_count;
 
 244         bool (*clean_rx) (struct e1000_adapter *adapter,
 
 245                           int *work_done, int work_to_do)
 
 246                                                 ____cacheline_aligned_in_smp;
 
 247         void (*alloc_rx_buf) (struct e1000_adapter *adapter,
 
 249         struct e1000_ring *rx_ring;
 
 252         u32 rx_abs_int_delay;
 
 260         u32 alloc_rx_buff_failed;
 
 263         unsigned int rx_ps_pages;
 
 268         /* OS defined structs */
 
 269         struct net_device *netdev;
 
 270         struct pci_dev *pdev;
 
 271         struct net_device_stats net_stats;
 
 273         /* structs defined in e1000_hw.h */
 
 276         struct e1000_hw_stats stats;
 
 277         struct e1000_phy_info phy_info;
 
 278         struct e1000_phy_stats phy_stats;
 
 280         /* Snapshot of PHY registers */
 
 281         struct e1000_phy_regs phy_regs;
 
 283         struct e1000_ring test_tx_ring;
 
 284         struct e1000_ring test_rx_ring;
 
 288         struct msix_entry *msix_entries;
 
 298         unsigned long led_status;
 
 302         struct work_struct downshift_task;
 
 303         struct work_struct update_phy_task;
 
 307         enum e1000_mac_type     mac;
 
 311         s32                     (*get_variants)(struct e1000_adapter *);
 
 312         struct e1000_mac_operations *mac_ops;
 
 313         struct e1000_phy_operations *phy_ops;
 
 314         struct e1000_nvm_operations *nvm_ops;
 
 317 /* hardware capability, feature, and workaround flags */
 
 318 #define FLAG_HAS_AMT                      (1 << 0)
 
 319 #define FLAG_HAS_FLASH                    (1 << 1)
 
 320 #define FLAG_HAS_HW_VLAN_FILTER           (1 << 2)
 
 321 #define FLAG_HAS_WOL                      (1 << 3)
 
 322 #define FLAG_HAS_ERT                      (1 << 4)
 
 323 #define FLAG_HAS_CTRLEXT_ON_LOAD          (1 << 5)
 
 324 #define FLAG_HAS_SWSM_ON_LOAD             (1 << 6)
 
 325 #define FLAG_HAS_JUMBO_FRAMES             (1 << 7)
 
 326 #define FLAG_READ_ONLY_NVM                (1 << 8)
 
 327 #define FLAG_IS_ICH                       (1 << 9)
 
 328 #define FLAG_HAS_MSIX                     (1 << 10)
 
 329 #define FLAG_HAS_SMART_POWER_DOWN         (1 << 11)
 
 330 #define FLAG_IS_QUAD_PORT_A               (1 << 12)
 
 331 #define FLAG_IS_QUAD_PORT                 (1 << 13)
 
 332 #define FLAG_TIPG_MEDIUM_FOR_80003ESLAN   (1 << 14)
 
 333 #define FLAG_APME_IN_WUC                  (1 << 15)
 
 334 #define FLAG_APME_IN_CTRL3                (1 << 16)
 
 335 #define FLAG_APME_CHECK_PORT_B            (1 << 17)
 
 336 #define FLAG_DISABLE_FC_PAUSE_TIME        (1 << 18)
 
 337 #define FLAG_NO_WAKE_UCAST                (1 << 19)
 
 338 #define FLAG_MNG_PT_ENABLED               (1 << 20)
 
 339 #define FLAG_RESET_OVERWRITES_LAA         (1 << 21)
 
 340 #define FLAG_TARC_SPEED_MODE_BIT          (1 << 22)
 
 341 #define FLAG_TARC_SET_BIT_ZERO            (1 << 23)
 
 342 #define FLAG_RX_NEEDS_RESTART             (1 << 24)
 
 343 #define FLAG_LSC_GIG_SPEED_DROP           (1 << 25)
 
 344 #define FLAG_SMART_POWER_DOWN             (1 << 26)
 
 345 #define FLAG_MSI_ENABLED                  (1 << 27)
 
 346 #define FLAG_RX_CSUM_ENABLED              (1 << 28)
 
 347 #define FLAG_TSO_FORCE                    (1 << 29)
 
 348 #define FLAG_RX_RESTART_NOW               (1 << 30)
 
 349 #define FLAG_MSI_TEST_FAILED              (1 << 31)
 
 351 /* CRC Stripping defines */
 
 352 #define FLAG2_CRC_STRIPPING               (1 << 0)
 
 354 #define E1000_RX_DESC_PS(R, i)      \
 
 355         (&(((union e1000_rx_desc_packet_split *)((R).desc))[i]))
 
 356 #define E1000_GET_DESC(R, i, type)      (&(((struct type *)((R).desc))[i]))
 
 357 #define E1000_RX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_rx_desc)
 
 358 #define E1000_TX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_tx_desc)
 
 359 #define E1000_CONTEXT_DESC(R, i)        E1000_GET_DESC(R, i, e1000_context_desc)
 
 371         latency_invalid = 255
 
 374 extern char e1000e_driver_name[];
 
 375 extern const char e1000e_driver_version[];
 
 377 extern void e1000e_check_options(struct e1000_adapter *adapter);
 
 378 extern void e1000e_set_ethtool_ops(struct net_device *netdev);
 
 380 extern int e1000e_up(struct e1000_adapter *adapter);
 
 381 extern void e1000e_down(struct e1000_adapter *adapter);
 
 382 extern void e1000e_reinit_locked(struct e1000_adapter *adapter);
 
 383 extern void e1000e_reset(struct e1000_adapter *adapter);
 
 384 extern void e1000e_power_up_phy(struct e1000_adapter *adapter);
 
 385 extern int e1000e_setup_rx_resources(struct e1000_adapter *adapter);
 
 386 extern int e1000e_setup_tx_resources(struct e1000_adapter *adapter);
 
 387 extern void e1000e_free_rx_resources(struct e1000_adapter *adapter);
 
 388 extern void e1000e_free_tx_resources(struct e1000_adapter *adapter);
 
 389 extern void e1000e_update_stats(struct e1000_adapter *adapter);
 
 390 extern bool e1000_has_link(struct e1000_adapter *adapter);
 
 391 extern void e1000e_set_interrupt_capability(struct e1000_adapter *adapter);
 
 392 extern void e1000e_reset_interrupt_capability(struct e1000_adapter *adapter);
 
 394 extern unsigned int copybreak;
 
 396 extern char *e1000e_get_hw_dev_name(struct e1000_hw *hw);
 
 398 extern struct e1000_info e1000_82571_info;
 
 399 extern struct e1000_info e1000_82572_info;
 
 400 extern struct e1000_info e1000_82573_info;
 
 401 extern struct e1000_info e1000_82574_info;
 
 402 extern struct e1000_info e1000_ich8_info;
 
 403 extern struct e1000_info e1000_ich9_info;
 
 404 extern struct e1000_info e1000_ich10_info;
 
 405 extern struct e1000_info e1000_es2_info;
 
 407 extern s32 e1000e_read_pba_num(struct e1000_hw *hw, u32 *pba_num);
 
 409 extern s32  e1000e_commit_phy(struct e1000_hw *hw);
 
 411 extern bool e1000e_enable_mng_pass_thru(struct e1000_hw *hw);
 
 413 extern bool e1000e_get_laa_state_82571(struct e1000_hw *hw);
 
 414 extern void e1000e_set_laa_state_82571(struct e1000_hw *hw, bool state);
 
 416 extern void e1000e_write_protect_nvm_ich8lan(struct e1000_hw *hw);
 
 417 extern void e1000e_set_kmrn_lock_loss_workaround_ich8lan(struct e1000_hw *hw,
 
 419 extern void e1000e_igp3_phy_powerdown_workaround_ich8lan(struct e1000_hw *hw);
 
 420 extern void e1000e_gig_downshift_workaround_ich8lan(struct e1000_hw *hw);
 
 421 extern void e1000e_disable_gig_wol_ich8lan(struct e1000_hw *hw);
 
 423 extern s32 e1000e_check_for_copper_link(struct e1000_hw *hw);
 
 424 extern s32 e1000e_check_for_fiber_link(struct e1000_hw *hw);
 
 425 extern s32 e1000e_check_for_serdes_link(struct e1000_hw *hw);
 
 426 extern s32 e1000e_cleanup_led_generic(struct e1000_hw *hw);
 
 427 extern s32 e1000e_led_on_generic(struct e1000_hw *hw);
 
 428 extern s32 e1000e_led_off_generic(struct e1000_hw *hw);
 
 429 extern s32 e1000e_get_bus_info_pcie(struct e1000_hw *hw);
 
 430 extern s32 e1000e_get_speed_and_duplex_copper(struct e1000_hw *hw, u16 *speed, u16 *duplex);
 
 431 extern s32 e1000e_get_speed_and_duplex_fiber_serdes(struct e1000_hw *hw, u16 *speed, u16 *duplex);
 
 432 extern s32 e1000e_disable_pcie_master(struct e1000_hw *hw);
 
 433 extern s32 e1000e_get_auto_rd_done(struct e1000_hw *hw);
 
 434 extern s32 e1000e_id_led_init(struct e1000_hw *hw);
 
 435 extern void e1000e_clear_hw_cntrs_base(struct e1000_hw *hw);
 
 436 extern s32 e1000e_setup_fiber_serdes_link(struct e1000_hw *hw);
 
 437 extern s32 e1000e_copper_link_setup_m88(struct e1000_hw *hw);
 
 438 extern s32 e1000e_copper_link_setup_igp(struct e1000_hw *hw);
 
 439 extern s32 e1000e_setup_link(struct e1000_hw *hw);
 
 440 extern void e1000e_clear_vfta(struct e1000_hw *hw);
 
 441 extern void e1000e_init_rx_addrs(struct e1000_hw *hw, u16 rar_count);
 
 442 extern void e1000e_update_mc_addr_list_generic(struct e1000_hw *hw,
 
 447 extern void e1000e_rar_set(struct e1000_hw *hw, u8 *addr, u32 index);
 
 448 extern s32 e1000e_set_fc_watermarks(struct e1000_hw *hw);
 
 449 extern void e1000e_set_pcie_no_snoop(struct e1000_hw *hw, u32 no_snoop);
 
 450 extern s32 e1000e_get_hw_semaphore(struct e1000_hw *hw);
 
 451 extern s32 e1000e_valid_led_default(struct e1000_hw *hw, u16 *data);
 
 452 extern void e1000e_config_collision_dist(struct e1000_hw *hw);
 
 453 extern s32 e1000e_config_fc_after_link_up(struct e1000_hw *hw);
 
 454 extern s32 e1000e_force_mac_fc(struct e1000_hw *hw);
 
 455 extern s32 e1000e_blink_led(struct e1000_hw *hw);
 
 456 extern void e1000e_write_vfta(struct e1000_hw *hw, u32 offset, u32 value);
 
 457 extern void e1000e_reset_adaptive(struct e1000_hw *hw);
 
 458 extern void e1000e_update_adaptive(struct e1000_hw *hw);
 
 460 extern s32 e1000e_setup_copper_link(struct e1000_hw *hw);
 
 461 extern s32 e1000e_get_phy_id(struct e1000_hw *hw);
 
 462 extern void e1000e_put_hw_semaphore(struct e1000_hw *hw);
 
 463 extern s32 e1000e_check_reset_block_generic(struct e1000_hw *hw);
 
 464 extern s32 e1000e_phy_force_speed_duplex_igp(struct e1000_hw *hw);
 
 465 extern s32 e1000e_get_cable_length_igp_2(struct e1000_hw *hw);
 
 466 extern s32 e1000e_get_phy_info_igp(struct e1000_hw *hw);
 
 467 extern s32 e1000e_read_phy_reg_igp(struct e1000_hw *hw, u32 offset, u16 *data);
 
 468 extern s32 e1000e_phy_hw_reset_generic(struct e1000_hw *hw);
 
 469 extern s32 e1000e_set_d3_lplu_state(struct e1000_hw *hw, bool active);
 
 470 extern s32 e1000e_write_phy_reg_igp(struct e1000_hw *hw, u32 offset, u16 data);
 
 471 extern s32 e1000e_phy_sw_reset(struct e1000_hw *hw);
 
 472 extern s32 e1000e_phy_force_speed_duplex_m88(struct e1000_hw *hw);
 
 473 extern s32 e1000e_get_cfg_done(struct e1000_hw *hw);
 
 474 extern s32 e1000e_get_cable_length_m88(struct e1000_hw *hw);
 
 475 extern s32 e1000e_get_phy_info_m88(struct e1000_hw *hw);
 
 476 extern s32 e1000e_read_phy_reg_m88(struct e1000_hw *hw, u32 offset, u16 *data);
 
 477 extern s32 e1000e_write_phy_reg_m88(struct e1000_hw *hw, u32 offset, u16 data);
 
 478 extern s32 e1000e_phy_init_script_igp3(struct e1000_hw *hw);
 
 479 extern enum e1000_phy_type e1000e_get_phy_type_from_id(u32 phy_id);
 
 480 extern s32 e1000e_determine_phy_address(struct e1000_hw *hw);
 
 481 extern s32 e1000e_write_phy_reg_bm(struct e1000_hw *hw, u32 offset, u16 data);
 
 482 extern s32 e1000e_read_phy_reg_bm(struct e1000_hw *hw, u32 offset, u16 *data);
 
 483 extern s32 e1000e_read_phy_reg_bm2(struct e1000_hw *hw, u32 offset, u16 *data);
 
 484 extern s32 e1000e_write_phy_reg_bm2(struct e1000_hw *hw, u32 offset, u16 data);
 
 485 extern void e1000e_phy_force_speed_duplex_setup(struct e1000_hw *hw, u16 *phy_ctrl);
 
 486 extern s32 e1000e_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data);
 
 487 extern s32 e1000e_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data);
 
 488 extern s32 e1000e_phy_has_link_generic(struct e1000_hw *hw, u32 iterations,
 
 489                                u32 usec_interval, bool *success);
 
 490 extern s32 e1000e_phy_reset_dsp(struct e1000_hw *hw);
 
 491 extern s32 e1000e_read_phy_reg_mdic(struct e1000_hw *hw, u32 offset, u16 *data);
 
 492 extern s32 e1000e_write_phy_reg_mdic(struct e1000_hw *hw, u32 offset, u16 data);
 
 493 extern s32 e1000e_check_downshift(struct e1000_hw *hw);
 
 495 static inline s32 e1000_phy_hw_reset(struct e1000_hw *hw)
 
 497         return hw->phy.ops.reset_phy(hw);
 
 500 static inline s32 e1000_check_reset_block(struct e1000_hw *hw)
 
 502         return hw->phy.ops.check_reset_block(hw);
 
 505 static inline s32 e1e_rphy(struct e1000_hw *hw, u32 offset, u16 *data)
 
 507         return hw->phy.ops.read_phy_reg(hw, offset, data);
 
 510 static inline s32 e1e_wphy(struct e1000_hw *hw, u32 offset, u16 data)
 
 512         return hw->phy.ops.write_phy_reg(hw, offset, data);
 
 515 static inline s32 e1000_get_cable_length(struct e1000_hw *hw)
 
 517         return hw->phy.ops.get_cable_length(hw);
 
 520 extern s32 e1000e_acquire_nvm(struct e1000_hw *hw);
 
 521 extern s32 e1000e_write_nvm_spi(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
 
 522 extern s32 e1000e_update_nvm_checksum_generic(struct e1000_hw *hw);
 
 523 extern s32 e1000e_poll_eerd_eewr_done(struct e1000_hw *hw, int ee_reg);
 
 524 extern s32 e1000e_read_nvm_eerd(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
 
 525 extern s32 e1000e_validate_nvm_checksum_generic(struct e1000_hw *hw);
 
 526 extern void e1000e_release_nvm(struct e1000_hw *hw);
 
 527 extern void e1000e_reload_nvm(struct e1000_hw *hw);
 
 528 extern s32 e1000e_read_mac_addr(struct e1000_hw *hw);
 
 530 static inline s32 e1000_validate_nvm_checksum(struct e1000_hw *hw)
 
 532         return hw->nvm.ops.validate_nvm(hw);
 
 535 static inline s32 e1000e_update_nvm_checksum(struct e1000_hw *hw)
 
 537         return hw->nvm.ops.update_nvm(hw);
 
 540 static inline s32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
 
 542         return hw->nvm.ops.read_nvm(hw, offset, words, data);
 
 545 static inline s32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
 
 547         return hw->nvm.ops.write_nvm(hw, offset, words, data);
 
 550 static inline s32 e1000_get_phy_info(struct e1000_hw *hw)
 
 552         return hw->phy.ops.get_phy_info(hw);
 
 555 static inline s32 e1000e_check_mng_mode(struct e1000_hw *hw)
 
 557         return hw->mac.ops.check_mng_mode(hw);
 
 560 extern bool e1000e_check_mng_mode_generic(struct e1000_hw *hw);
 
 561 extern bool e1000e_enable_tx_pkt_filtering(struct e1000_hw *hw);
 
 562 extern s32 e1000e_mng_write_dhcp_info(struct e1000_hw *hw, u8 *buffer, u16 length);
 
 564 static inline u32 __er32(struct e1000_hw *hw, unsigned long reg)
 
 566         return readl(hw->hw_addr + reg);
 
 569 static inline void __ew32(struct e1000_hw *hw, unsigned long reg, u32 val)
 
 571         writel(val, hw->hw_addr + reg);
 
 574 #endif /* _E1000_H_ */