drivers/net/e1000e/e1000.h

   1 /*******************************************************************************
   2
   3   Intel PRO/1000 Linux driver
   4   Copyright(c) 1999 - 2007 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   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
  26
  27 *******************************************************************************/
  28
  29 /* Linux PRO/1000 Ethernet Driver main header file */
  30
  31 #ifndef _E1000_H_
  32 #define _E1000_H_
  33
  34 #include <linux/types.h>
  35 #include <linux/timer.h>
  36 #include <linux/workqueue.h>
  37 #include <linux/io.h>
  38 #include <linux/netdevice.h>
  39
  40 #include "hw.h"
  41
  42 struct e1000_info;
  43
  44 #define ndev_printk(level, netdev, format, arg...) \
  45         printk(level "%s: " format, (netdev)->name, ## arg)
  46
  47 #ifdef DEBUG
  48 #define ndev_dbg(netdev, format, arg...) \
  49         ndev_printk(KERN_DEBUG , netdev, format, ## arg)
  50 #else
  51 #define ndev_dbg(netdev, format, arg...) do { (void)(netdev); } while (0)
  52 #endif
  53
  54 #define ndev_err(netdev, format, arg...) \
  55         ndev_printk(KERN_ERR , netdev, format, ## arg)
  56 #define ndev_info(netdev, format, arg...) \
  57         ndev_printk(KERN_INFO , netdev, format, ## arg)
  58 #define ndev_warn(netdev, format, arg...) \
  59         ndev_printk(KERN_WARNING , netdev, format, ## arg)
  60 #define ndev_notice(netdev, format, arg...) \
  61         ndev_printk(KERN_NOTICE , netdev, format, ## arg)
  62
  63
  64 /* TX/RX descriptor defines */
  65 #define E1000_DEFAULT_TXD               256
  66 #define E1000_MAX_TXD                   4096
  67 #define E1000_MIN_TXD                   80
  68
  69 #define E1000_DEFAULT_RXD               256
  70 #define E1000_MAX_RXD                   4096
  71 #define E1000_MIN_RXD                   80
  72
  73 /* Early Receive defines */
  74 #define E1000_ERT_2048                  0x100
  75
  76 #define E1000_FC_PAUSE_TIME             0x0680 /* 858 usec */
  77
  78 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
  79 /* How many Rx Buffers do we bundle into one write to the hardware ? */
  80 #define E1000_RX_BUFFER_WRITE           16 /* Must be power of 2 */
  81
  82 #define AUTO_ALL_MODES                  0
  83 #define E1000_EEPROM_APME               0x0400
  84
  85 #define E1000_MNG_VLAN_NONE             (-1)
  86
  87 /* Number of packet split data buffers (not including the header buffer) */
  88 #define PS_PAGE_BUFFERS                 (MAX_PS_BUFFERS - 1)
  89
  90 enum e1000_boards {
  91         board_82571,
  92         board_82572,
  93         board_82573,
  94         board_80003es2lan,
  95         board_ich8lan,
  96         board_ich9lan,
  97 };
  98
  99 struct e1000_queue_stats {
 100         u64 packets;
 101         u64 bytes;
 102 };
 103
 104 struct e1000_ps_page {
 105         struct page *page;
 106         u64 dma; /* must be u64 - written to hw */
 107 };
 108
 109 /*
 110  * wrappers around a pointer to a socket buffer,
 111  * so a DMA handle can be stored along with the buffer
 112  */
 113 struct e1000_buffer {
 114         dma_addr_t dma;
 115         struct sk_buff *skb;
 116         union {
 117                 /* TX */
 118                 struct {
 119                         unsigned long time_stamp;
 120                         u16 length;
 121                         u16 next_to_watch;
 122                 };
 123                 /* RX */
 124                 /* arrays of page information for packet split */
 125                 struct e1000_ps_page *ps_pages;
 126         };
 127
 128 };
 129
 130 struct e1000_ring {
 131         void *desc;                     /* pointer to ring memory  */
 132         dma_addr_t dma;                 /* phys address of ring    */
 133         unsigned int size;              /* length of ring in bytes */
 134         unsigned int count;             /* number of desc. in ring */
 135
 136         u16 next_to_use;
 137         u16 next_to_clean;
 138
 139         u16 head;
 140         u16 tail;
 141
 142         /* array of buffer information structs */
 143         struct e1000_buffer *buffer_info;
 144
 145         struct sk_buff *rx_skb_top;
 146
 147         struct e1000_queue_stats stats;
 148 };
 149
 150 /* board specific private data structure */
 151 struct e1000_adapter {
 152         struct timer_list watchdog_timer;
 153         struct timer_list phy_info_timer;
 154         struct timer_list blink_timer;
 155
 156         struct work_struct reset_task;
 157         struct work_struct watchdog_task;
 158
 159         const struct e1000_info *ei;
 160
 161         struct vlan_group *vlgrp;
 162         u32 bd_number;
 163         u32 rx_buffer_len;
 164         u16 mng_vlan_id;
 165         u16 link_speed;
 166         u16 link_duplex;
 167
 168         spinlock_t tx_queue_lock; /* prevent concurrent tail updates */
 169
 170         /* this is still needed for 82571 and above */
 171         atomic_t irq_sem;
 172
 173         /* track device up/down/testing state */
 174         unsigned long state;
 175
 176         /* Interrupt Throttle Rate */
 177         u32 itr;
 178         u32 itr_setting;
 179         u16 tx_itr;
 180         u16 rx_itr;
 181
 182         /*
 183          * TX
 184          */
 185         struct e1000_ring *tx_ring /* One per active queue */
 186                                                 ____cacheline_aligned_in_smp;
 187
 188         struct napi_struct napi;
 189
 190         unsigned long tx_queue_len;
 191         unsigned int restart_queue;
 192         u32 txd_cmd;
 193
 194         bool detect_tx_hung;
 195         u8 tx_timeout_factor;
 196
 197         u32 tx_int_delay;
 198         u32 tx_abs_int_delay;
 199
 200         unsigned int total_tx_bytes;
 201         unsigned int total_tx_packets;
 202         unsigned int total_rx_bytes;
 203         unsigned int total_rx_packets;
 204
 205         /* TX stats */
 206         u64 tpt_old;
 207         u64 colc_old;
 208         u64 gotcl_old;
 209         u32 gotcl;
 210         u32 tx_timeout_count;
 211         u32 tx_fifo_head;
 212         u32 tx_head_addr;
 213         u32 tx_fifo_size;
 214         u32 tx_dma_failed;
 215
 216         /*
 217          * RX
 218          */
 219         bool (*clean_rx) (struct e1000_adapter *adapter,
 220                           int *work_done, int work_to_do)
 221                                                 ____cacheline_aligned_in_smp;
 222         void (*alloc_rx_buf) (struct e1000_adapter *adapter,
 223                               int cleaned_count);
 224         struct e1000_ring *rx_ring;
 225
 226         u32 rx_int_delay;
 227         u32 rx_abs_int_delay;
 228
 229         /* RX stats */
 230         u64 hw_csum_err;
 231         u64 hw_csum_good;
 232         u64 rx_hdr_split;
 233         u64 gorcl_old;
 234         u32 gorcl;
 235         u32 alloc_rx_buff_failed;
 236         u32 rx_dma_failed;
 237
 238         unsigned int rx_ps_pages;
 239         u16 rx_ps_bsize0;
 240
 241         /* OS defined structs */
 242         struct net_device *netdev;
 243         struct pci_dev *pdev;
 244         struct net_device_stats net_stats;
 245         spinlock_t stats_lock;      /* prevent concurrent stats updates */
 246
 247         /* structs defined in e1000_hw.h */
 248         struct e1000_hw hw;
 249
 250         struct e1000_hw_stats stats;
 251         struct e1000_phy_info phy_info;
 252         struct e1000_phy_stats phy_stats;
 253
 254         struct e1000_ring test_tx_ring;
 255         struct e1000_ring test_rx_ring;
 256         u32 test_icr;
 257
 258         u32 msg_enable;
 259
 260         u32 eeprom_wol;
 261         u32 wol;
 262         u32 pba;
 263
 264         u8 fc_autoneg;
 265
 266         unsigned long led_status;
 267
 268         unsigned int flags;
 269 };
 270
 271 struct e1000_info {
 272         enum e1000_mac_type     mac;
 273         unsigned int            flags;
 274         u32                     pba;
 275         s32                     (*get_invariants)(struct e1000_adapter *);
 276         struct e1000_mac_operations *mac_ops;
 277         struct e1000_phy_operations *phy_ops;
 278         struct e1000_nvm_operations *nvm_ops;
 279 };
 280
 281 /* hardware capability, feature, and workaround flags */
 282 #define FLAG_HAS_AMT                      (1 << 0)
 283 #define FLAG_HAS_FLASH                    (1 << 1)
 284 #define FLAG_HAS_HW_VLAN_FILTER           (1 << 2)
 285 #define FLAG_HAS_WOL                      (1 << 3)
 286 #define FLAG_HAS_ERT                      (1 << 4)
 287 #define FLAG_HAS_CTRLEXT_ON_LOAD          (1 << 5)
 288 #define FLAG_HAS_SWSM_ON_LOAD             (1 << 6)
 289 #define FLAG_HAS_JUMBO_FRAMES             (1 << 7)
 290 #define FLAG_HAS_STATS_ICR_ICT            (1 << 9)
 291 #define FLAG_HAS_STATS_PTC_PRC            (1 << 10)
 292 #define FLAG_HAS_SMART_POWER_DOWN         (1 << 11)
 293 #define FLAG_IS_QUAD_PORT_A               (1 << 12)
 294 #define FLAG_IS_QUAD_PORT                 (1 << 13)
 295 #define FLAG_TIPG_MEDIUM_FOR_80003ESLAN   (1 << 14)
 296 #define FLAG_APME_IN_WUC                  (1 << 15)
 297 #define FLAG_APME_IN_CTRL3                (1 << 16)
 298 #define FLAG_APME_CHECK_PORT_B            (1 << 17)
 299 #define FLAG_DISABLE_FC_PAUSE_TIME        (1 << 18)
 300 #define FLAG_NO_WAKE_UCAST                (1 << 19)
 301 #define FLAG_MNG_PT_ENABLED               (1 << 20)
 302 #define FLAG_RESET_OVERWRITES_LAA         (1 << 21)
 303 #define FLAG_TARC_SPEED_MODE_BIT          (1 << 22)
 304 #define FLAG_TARC_SET_BIT_ZERO            (1 << 23)
 305 #define FLAG_RX_NEEDS_RESTART             (1 << 24)
 306 #define FLAG_LSC_GIG_SPEED_DROP           (1 << 25)
 307 #define FLAG_SMART_POWER_DOWN             (1 << 26)
 308 #define FLAG_MSI_ENABLED                  (1 << 27)
 309 #define FLAG_RX_CSUM_ENABLED              (1 << 28)
 310 #define FLAG_TSO_FORCE                    (1 << 29)
 311
 312 #define E1000_RX_DESC_PS(R, i)      \
 313         (&(((union e1000_rx_desc_packet_split *)((R).desc))[i]))
 314 #define E1000_GET_DESC(R, i, type)      (&(((struct type *)((R).desc))[i]))
 315 #define E1000_RX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_rx_desc)
 316 #define E1000_TX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_tx_desc)
 317 #define E1000_CONTEXT_DESC(R, i)        E1000_GET_DESC(R, i, e1000_context_desc)
 318
 319 enum e1000_state_t {
 320         __E1000_TESTING,
 321         __E1000_RESETTING,
 322         __E1000_DOWN
 323 };
 324
 325 enum latency_range {
 326         lowest_latency = 0,
 327         low_latency = 1,
 328         bulk_latency = 2,
 329         latency_invalid = 255
 330 };
 331
 332 extern char e1000e_driver_name[];
 333 extern const char e1000e_driver_version[];
 334
 335 extern void e1000e_check_options(struct e1000_adapter *adapter);
 336 extern void e1000e_set_ethtool_ops(struct net_device *netdev);
 337
 338 extern int e1000e_up(struct e1000_adapter *adapter);
 339 extern void e1000e_down(struct e1000_adapter *adapter);
 340 extern void e1000e_reinit_locked(struct e1000_adapter *adapter);
 341 extern void e1000e_reset(struct e1000_adapter *adapter);
 342 extern void e1000e_power_up_phy(struct e1000_adapter *adapter);
 343 extern int e1000e_setup_rx_resources(struct e1000_adapter *adapter);
 344 extern int e1000e_setup_tx_resources(struct e1000_adapter *adapter);
 345 extern void e1000e_free_rx_resources(struct e1000_adapter *adapter);
 346 extern void e1000e_free_tx_resources(struct e1000_adapter *adapter);
 347 extern void e1000e_update_stats(struct e1000_adapter *adapter);
 348
 349 extern unsigned int copybreak;
 350
 351 extern char *e1000e_get_hw_dev_name(struct e1000_hw *hw);
 352
 353 extern struct e1000_info e1000_82571_info;
 354 extern struct e1000_info e1000_82572_info;
 355 extern struct e1000_info e1000_82573_info;
 356 extern struct e1000_info e1000_ich8_info;
 357 extern struct e1000_info e1000_ich9_info;
 358 extern struct e1000_info e1000_es2_info;
 359
 360 extern s32 e1000e_read_part_num(struct e1000_hw *hw, u32 *part_num);
 361
 362 extern s32  e1000e_commit_phy(struct e1000_hw *hw);
 363
 364 extern bool e1000e_enable_mng_pass_thru(struct e1000_hw *hw);
 365
 366 extern bool e1000e_get_laa_state_82571(struct e1000_hw *hw);
 367 extern void e1000e_set_laa_state_82571(struct e1000_hw *hw, bool state);
 368
 369 extern void e1000e_set_kmrn_lock_loss_workaround_ich8lan(struct e1000_hw *hw,
 370                                                  bool state);
 371 extern void e1000e_igp3_phy_powerdown_workaround_ich8lan(struct e1000_hw *hw);
 372 extern void e1000e_gig_downshift_workaround_ich8lan(struct e1000_hw *hw);
 373
 374 extern s32 e1000e_check_for_copper_link(struct e1000_hw *hw);
 375 extern s32 e1000e_check_for_fiber_link(struct e1000_hw *hw);
 376 extern s32 e1000e_check_for_serdes_link(struct e1000_hw *hw);
 377 extern s32 e1000e_cleanup_led_generic(struct e1000_hw *hw);
 378 extern s32 e1000e_led_on_generic(struct e1000_hw *hw);
 379 extern s32 e1000e_led_off_generic(struct e1000_hw *hw);
 380 extern s32 e1000e_get_bus_info_pcie(struct e1000_hw *hw);
 381 extern s32 e1000e_get_speed_and_duplex_copper(struct e1000_hw *hw, u16 *speed, u16 *duplex);
 382 extern s32 e1000e_get_speed_and_duplex_fiber_serdes(struct e1000_hw *hw, u16 *speed, u16 *duplex);
 383 extern s32 e1000e_disable_pcie_master(struct e1000_hw *hw);
 384 extern s32 e1000e_get_auto_rd_done(struct e1000_hw *hw);
 385 extern s32 e1000e_id_led_init(struct e1000_hw *hw);
 386 extern void e1000e_clear_hw_cntrs_base(struct e1000_hw *hw);
 387 extern s32 e1000e_setup_fiber_serdes_link(struct e1000_hw *hw);
 388 extern s32 e1000e_copper_link_setup_m88(struct e1000_hw *hw);
 389 extern s32 e1000e_copper_link_setup_igp(struct e1000_hw *hw);
 390 extern s32 e1000e_setup_link(struct e1000_hw *hw);
 391 extern void e1000e_clear_vfta(struct e1000_hw *hw);
 392 extern void e1000e_init_rx_addrs(struct e1000_hw *hw, u16 rar_count);
 393 extern void e1000e_mc_addr_list_update_generic(struct e1000_hw *hw,
 394                                        u8 *mc_addr_list, u32 mc_addr_count,
 395                                        u32 rar_used_count, u32 rar_count);
 396 extern void e1000e_rar_set(struct e1000_hw *hw, u8 *addr, u32 index);
 397 extern s32 e1000e_set_fc_watermarks(struct e1000_hw *hw);
 398 extern void e1000e_set_pcie_no_snoop(struct e1000_hw *hw, u32 no_snoop);
 399 extern s32 e1000e_get_hw_semaphore(struct e1000_hw *hw);
 400 extern s32 e1000e_valid_led_default(struct e1000_hw *hw, u16 *data);
 401 extern void e1000e_config_collision_dist(struct e1000_hw *hw);
 402 extern s32 e1000e_config_fc_after_link_up(struct e1000_hw *hw);
 403 extern s32 e1000e_force_mac_fc(struct e1000_hw *hw);
 404 extern s32 e1000e_blink_led(struct e1000_hw *hw);
 405 extern void e1000e_write_vfta(struct e1000_hw *hw, u32 offset, u32 value);
 406 extern void e1000e_reset_adaptive(struct e1000_hw *hw);
 407 extern void e1000e_update_adaptive(struct e1000_hw *hw);
 408
 409 extern s32 e1000e_setup_copper_link(struct e1000_hw *hw);
 410 extern s32 e1000e_get_phy_id(struct e1000_hw *hw);
 411 extern void e1000e_put_hw_semaphore(struct e1000_hw *hw);
 412 extern s32 e1000e_check_reset_block_generic(struct e1000_hw *hw);
 413 extern s32 e1000e_phy_force_speed_duplex_igp(struct e1000_hw *hw);
 414 extern s32 e1000e_get_cable_length_igp_2(struct e1000_hw *hw);
 415 extern s32 e1000e_get_phy_info_igp(struct e1000_hw *hw);
 416 extern s32 e1000e_read_phy_reg_igp(struct e1000_hw *hw, u32 offset, u16 *data);
 417 extern s32 e1000e_phy_hw_reset_generic(struct e1000_hw *hw);
 418 extern s32 e1000e_set_d3_lplu_state(struct e1000_hw *hw, bool active);
 419 extern s32 e1000e_write_phy_reg_igp(struct e1000_hw *hw, u32 offset, u16 data);
 420 extern s32 e1000e_phy_sw_reset(struct e1000_hw *hw);
 421 extern s32 e1000e_phy_force_speed_duplex_m88(struct e1000_hw *hw);
 422 extern s32 e1000e_get_cfg_done(struct e1000_hw *hw);
 423 extern s32 e1000e_get_cable_length_m88(struct e1000_hw *hw);
 424 extern s32 e1000e_get_phy_info_m88(struct e1000_hw *hw);
 425 extern s32 e1000e_read_phy_reg_m88(struct e1000_hw *hw, u32 offset, u16 *data);
 426 extern s32 e1000e_write_phy_reg_m88(struct e1000_hw *hw, u32 offset, u16 data);
 427 extern enum e1000_phy_type e1000e_get_phy_type_from_id(u32 phy_id);
 428 extern void e1000e_phy_force_speed_duplex_setup(struct e1000_hw *hw, u16 *phy_ctrl);
 429 extern s32 e1000e_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data);
 430 extern s32 e1000e_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data);
 431 extern s32 e1000e_phy_has_link_generic(struct e1000_hw *hw, u32 iterations,
 432                                u32 usec_interval, bool *success);
 433 extern s32 e1000e_phy_reset_dsp(struct e1000_hw *hw);
 434 extern s32 e1000e_check_downshift(struct e1000_hw *hw);
 435
 436 static inline s32 e1000_phy_hw_reset(struct e1000_hw *hw)
 437 {
 438         return hw->phy.ops.reset_phy(hw);
 439 }
 440
 441 static inline s32 e1000_check_reset_block(struct e1000_hw *hw)
 442 {
 443         return hw->phy.ops.check_reset_block(hw);
 444 }
 445
 446 static inline s32 e1e_rphy(struct e1000_hw *hw, u32 offset, u16 *data)
 447 {
 448         return hw->phy.ops.read_phy_reg(hw, offset, data);
 449 }
 450
 451 static inline s32 e1e_wphy(struct e1000_hw *hw, u32 offset, u16 data)
 452 {
 453         return hw->phy.ops.write_phy_reg(hw, offset, data);
 454 }
 455
 456 static inline s32 e1000_get_cable_length(struct e1000_hw *hw)
 457 {
 458         return hw->phy.ops.get_cable_length(hw);
 459 }
 460
 461 extern s32 e1000e_acquire_nvm(struct e1000_hw *hw);
 462 extern s32 e1000e_write_nvm_spi(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
 463 extern s32 e1000e_update_nvm_checksum_generic(struct e1000_hw *hw);
 464 extern s32 e1000e_poll_eerd_eewr_done(struct e1000_hw *hw, int ee_reg);
 465 extern s32 e1000e_read_nvm_spi(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
 466 extern s32 e1000e_read_nvm_eerd(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
 467 extern s32 e1000e_validate_nvm_checksum_generic(struct e1000_hw *hw);
 468 extern void e1000e_release_nvm(struct e1000_hw *hw);
 469 extern void e1000e_reload_nvm(struct e1000_hw *hw);
 470 extern s32 e1000e_read_mac_addr(struct e1000_hw *hw);
 471
 472 static inline s32 e1000_validate_nvm_checksum(struct e1000_hw *hw)
 473 {
 474         return hw->nvm.ops.validate_nvm(hw);
 475 }
 476
 477 static inline s32 e1000e_update_nvm_checksum(struct e1000_hw *hw)
 478 {
 479         return hw->nvm.ops.update_nvm(hw);
 480 }
 481
 482 static inline s32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
 483 {
 484         return hw->nvm.ops.read_nvm(hw, offset, words, data);
 485 }
 486
 487 static inline s32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
 488 {
 489         return hw->nvm.ops.write_nvm(hw, offset, words, data);
 490 }
 491
 492 static inline s32 e1000_get_phy_info(struct e1000_hw *hw)
 493 {
 494         return hw->phy.ops.get_phy_info(hw);
 495 }
 496
 497 extern bool e1000e_check_mng_mode(struct e1000_hw *hw);
 498 extern bool e1000e_enable_tx_pkt_filtering(struct e1000_hw *hw);
 499 extern s32 e1000e_mng_write_dhcp_info(struct e1000_hw *hw, u8 *buffer, u16 length);
 500
 501 static inline u32 __er32(struct e1000_hw *hw, unsigned long reg)
 502 {
 503         return readl(hw->hw_addr + reg);
 504 }
 505
 506 static inline void __ew32(struct e1000_hw *hw, unsigned long reg, u32 val)
 507 {
 508         writel(val, hw->hw_addr + reg);
 509 }
 510
 511 #endif /* _E1000_H_ */