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;
197 spinlock_t tx_queue_lock; /* prevent concurrent tail updates */
199 /* track device up/down/testing state */
202 /* Interrupt Throttle Rate */
211 struct e1000_ring *tx_ring /* One per active queue */
212 ____cacheline_aligned_in_smp;
214 struct napi_struct napi;
216 unsigned long tx_queue_len;
217 unsigned int restart_queue;
221 u8 tx_timeout_factor;
224 u32 tx_abs_int_delay;
226 unsigned int total_tx_bytes;
227 unsigned int total_tx_packets;
228 unsigned int total_rx_bytes;
229 unsigned int total_rx_packets;
236 u32 tx_timeout_count;
245 bool (*clean_rx) (struct e1000_adapter *adapter,
246 int *work_done, int work_to_do)
247 ____cacheline_aligned_in_smp;
248 void (*alloc_rx_buf) (struct e1000_adapter *adapter,
250 struct e1000_ring *rx_ring;
253 u32 rx_abs_int_delay;
261 u32 alloc_rx_buff_failed;
264 unsigned int rx_ps_pages;
269 /* OS defined structs */
270 struct net_device *netdev;
271 struct pci_dev *pdev;
272 struct net_device_stats net_stats;
273 spinlock_t stats_lock; /* prevent concurrent stats updates */
275 /* structs defined in e1000_hw.h */
278 struct e1000_hw_stats stats;
279 struct e1000_phy_info phy_info;
280 struct e1000_phy_stats phy_stats;
282 /* Snapshot of PHY registers */
283 struct e1000_phy_regs phy_regs;
285 struct e1000_ring test_tx_ring;
286 struct e1000_ring test_rx_ring;
290 struct msix_entry *msix_entries;
300 unsigned long led_status;
306 enum e1000_mac_type mac;
309 s32 (*get_variants)(struct e1000_adapter *);
310 struct e1000_mac_operations *mac_ops;
311 struct e1000_phy_operations *phy_ops;
312 struct e1000_nvm_operations *nvm_ops;
315 /* hardware capability, feature, and workaround flags */
316 #define FLAG_HAS_AMT (1 << 0)
317 #define FLAG_HAS_FLASH (1 << 1)
318 #define FLAG_HAS_HW_VLAN_FILTER (1 << 2)
319 #define FLAG_HAS_WOL (1 << 3)
320 #define FLAG_HAS_ERT (1 << 4)
321 #define FLAG_HAS_CTRLEXT_ON_LOAD (1 << 5)
322 #define FLAG_HAS_SWSM_ON_LOAD (1 << 6)
323 #define FLAG_HAS_JUMBO_FRAMES (1 << 7)
324 #define FLAG_IS_ICH (1 << 9)
325 #define FLAG_HAS_MSIX (1 << 10)
326 #define FLAG_HAS_SMART_POWER_DOWN (1 << 11)
327 #define FLAG_IS_QUAD_PORT_A (1 << 12)
328 #define FLAG_IS_QUAD_PORT (1 << 13)
329 #define FLAG_TIPG_MEDIUM_FOR_80003ESLAN (1 << 14)
330 #define FLAG_APME_IN_WUC (1 << 15)
331 #define FLAG_APME_IN_CTRL3 (1 << 16)
332 #define FLAG_APME_CHECK_PORT_B (1 << 17)
333 #define FLAG_DISABLE_FC_PAUSE_TIME (1 << 18)
334 #define FLAG_NO_WAKE_UCAST (1 << 19)
335 #define FLAG_MNG_PT_ENABLED (1 << 20)
336 #define FLAG_RESET_OVERWRITES_LAA (1 << 21)
337 #define FLAG_TARC_SPEED_MODE_BIT (1 << 22)
338 #define FLAG_TARC_SET_BIT_ZERO (1 << 23)
339 #define FLAG_RX_NEEDS_RESTART (1 << 24)
340 #define FLAG_LSC_GIG_SPEED_DROP (1 << 25)
341 #define FLAG_SMART_POWER_DOWN (1 << 26)
342 #define FLAG_MSI_ENABLED (1 << 27)
343 #define FLAG_RX_CSUM_ENABLED (1 << 28)
344 #define FLAG_TSO_FORCE (1 << 29)
345 #define FLAG_RX_RESTART_NOW (1 << 30)
346 #define FLAG_MSI_TEST_FAILED (1 << 31)
348 #define E1000_RX_DESC_PS(R, i) \
349 (&(((union e1000_rx_desc_packet_split *)((R).desc))[i]))
350 #define E1000_GET_DESC(R, i, type) (&(((struct type *)((R).desc))[i]))
351 #define E1000_RX_DESC(R, i) E1000_GET_DESC(R, i, e1000_rx_desc)
352 #define E1000_TX_DESC(R, i) E1000_GET_DESC(R, i, e1000_tx_desc)
353 #define E1000_CONTEXT_DESC(R, i) E1000_GET_DESC(R, i, e1000_context_desc)
365 latency_invalid = 255
368 extern char e1000e_driver_name[];
369 extern const char e1000e_driver_version[];
371 extern void e1000e_check_options(struct e1000_adapter *adapter);
372 extern void e1000e_set_ethtool_ops(struct net_device *netdev);
374 extern int e1000e_up(struct e1000_adapter *adapter);
375 extern void e1000e_down(struct e1000_adapter *adapter);
376 extern void e1000e_reinit_locked(struct e1000_adapter *adapter);
377 extern void e1000e_reset(struct e1000_adapter *adapter);
378 extern void e1000e_power_up_phy(struct e1000_adapter *adapter);
379 extern int e1000e_setup_rx_resources(struct e1000_adapter *adapter);
380 extern int e1000e_setup_tx_resources(struct e1000_adapter *adapter);
381 extern void e1000e_free_rx_resources(struct e1000_adapter *adapter);
382 extern void e1000e_free_tx_resources(struct e1000_adapter *adapter);
383 extern void e1000e_update_stats(struct e1000_adapter *adapter);
384 extern void e1000e_set_interrupt_capability(struct e1000_adapter *adapter);
385 extern void e1000e_reset_interrupt_capability(struct e1000_adapter *adapter);
387 extern unsigned int copybreak;
389 extern char *e1000e_get_hw_dev_name(struct e1000_hw *hw);
391 extern struct e1000_info e1000_82571_info;
392 extern struct e1000_info e1000_82572_info;
393 extern struct e1000_info e1000_82573_info;
394 extern struct e1000_info e1000_82574_info;
395 extern struct e1000_info e1000_ich8_info;
396 extern struct e1000_info e1000_ich9_info;
397 extern struct e1000_info e1000_ich10_info;
398 extern struct e1000_info e1000_es2_info;
400 extern s32 e1000e_read_pba_num(struct e1000_hw *hw, u32 *pba_num);
402 extern s32 e1000e_commit_phy(struct e1000_hw *hw);
404 extern bool e1000e_enable_mng_pass_thru(struct e1000_hw *hw);
406 extern bool e1000e_get_laa_state_82571(struct e1000_hw *hw);
407 extern void e1000e_set_laa_state_82571(struct e1000_hw *hw, bool state);
409 extern void e1000e_set_kmrn_lock_loss_workaround_ich8lan(struct e1000_hw *hw,
411 extern void e1000e_igp3_phy_powerdown_workaround_ich8lan(struct e1000_hw *hw);
412 extern void e1000e_gig_downshift_workaround_ich8lan(struct e1000_hw *hw);
413 extern void e1000e_disable_gig_wol_ich8lan(struct e1000_hw *hw);
415 extern s32 e1000e_check_for_copper_link(struct e1000_hw *hw);
416 extern s32 e1000e_check_for_fiber_link(struct e1000_hw *hw);
417 extern s32 e1000e_check_for_serdes_link(struct e1000_hw *hw);
418 extern s32 e1000e_cleanup_led_generic(struct e1000_hw *hw);
419 extern s32 e1000e_led_on_generic(struct e1000_hw *hw);
420 extern s32 e1000e_led_off_generic(struct e1000_hw *hw);
421 extern s32 e1000e_get_bus_info_pcie(struct e1000_hw *hw);
422 extern s32 e1000e_get_speed_and_duplex_copper(struct e1000_hw *hw, u16 *speed, u16 *duplex);
423 extern s32 e1000e_get_speed_and_duplex_fiber_serdes(struct e1000_hw *hw, u16 *speed, u16 *duplex);
424 extern s32 e1000e_disable_pcie_master(struct e1000_hw *hw);
425 extern s32 e1000e_get_auto_rd_done(struct e1000_hw *hw);
426 extern s32 e1000e_id_led_init(struct e1000_hw *hw);
427 extern void e1000e_clear_hw_cntrs_base(struct e1000_hw *hw);
428 extern s32 e1000e_setup_fiber_serdes_link(struct e1000_hw *hw);
429 extern s32 e1000e_copper_link_setup_m88(struct e1000_hw *hw);
430 extern s32 e1000e_copper_link_setup_igp(struct e1000_hw *hw);
431 extern s32 e1000e_setup_link(struct e1000_hw *hw);
432 extern void e1000e_clear_vfta(struct e1000_hw *hw);
433 extern void e1000e_init_rx_addrs(struct e1000_hw *hw, u16 rar_count);
434 extern void e1000e_update_mc_addr_list_generic(struct e1000_hw *hw,
439 extern void e1000e_rar_set(struct e1000_hw *hw, u8 *addr, u32 index);
440 extern s32 e1000e_set_fc_watermarks(struct e1000_hw *hw);
441 extern void e1000e_set_pcie_no_snoop(struct e1000_hw *hw, u32 no_snoop);
442 extern s32 e1000e_get_hw_semaphore(struct e1000_hw *hw);
443 extern s32 e1000e_valid_led_default(struct e1000_hw *hw, u16 *data);
444 extern void e1000e_config_collision_dist(struct e1000_hw *hw);
445 extern s32 e1000e_config_fc_after_link_up(struct e1000_hw *hw);
446 extern s32 e1000e_force_mac_fc(struct e1000_hw *hw);
447 extern s32 e1000e_blink_led(struct e1000_hw *hw);
448 extern void e1000e_write_vfta(struct e1000_hw *hw, u32 offset, u32 value);
449 extern void e1000e_reset_adaptive(struct e1000_hw *hw);
450 extern void e1000e_update_adaptive(struct e1000_hw *hw);
452 extern s32 e1000e_setup_copper_link(struct e1000_hw *hw);
453 extern s32 e1000e_get_phy_id(struct e1000_hw *hw);
454 extern void e1000e_put_hw_semaphore(struct e1000_hw *hw);
455 extern s32 e1000e_check_reset_block_generic(struct e1000_hw *hw);
456 extern s32 e1000e_phy_force_speed_duplex_igp(struct e1000_hw *hw);
457 extern s32 e1000e_get_cable_length_igp_2(struct e1000_hw *hw);
458 extern s32 e1000e_get_phy_info_igp(struct e1000_hw *hw);
459 extern s32 e1000e_read_phy_reg_igp(struct e1000_hw *hw, u32 offset, u16 *data);
460 extern s32 e1000e_phy_hw_reset_generic(struct e1000_hw *hw);
461 extern s32 e1000e_set_d3_lplu_state(struct e1000_hw *hw, bool active);
462 extern s32 e1000e_write_phy_reg_igp(struct e1000_hw *hw, u32 offset, u16 data);
463 extern s32 e1000e_phy_sw_reset(struct e1000_hw *hw);
464 extern s32 e1000e_phy_force_speed_duplex_m88(struct e1000_hw *hw);
465 extern s32 e1000e_get_cfg_done(struct e1000_hw *hw);
466 extern s32 e1000e_get_cable_length_m88(struct e1000_hw *hw);
467 extern s32 e1000e_get_phy_info_m88(struct e1000_hw *hw);
468 extern s32 e1000e_read_phy_reg_m88(struct e1000_hw *hw, u32 offset, u16 *data);
469 extern s32 e1000e_write_phy_reg_m88(struct e1000_hw *hw, u32 offset, u16 data);
470 extern s32 e1000e_phy_init_script_igp3(struct e1000_hw *hw);
471 extern enum e1000_phy_type e1000e_get_phy_type_from_id(u32 phy_id);
472 extern s32 e1000e_determine_phy_address(struct e1000_hw *hw);
473 extern s32 e1000e_write_phy_reg_bm(struct e1000_hw *hw, u32 offset, u16 data);
474 extern s32 e1000e_read_phy_reg_bm(struct e1000_hw *hw, u32 offset, u16 *data);
475 extern s32 e1000e_read_phy_reg_bm2(struct e1000_hw *hw, u32 offset, u16 *data);
476 extern s32 e1000e_write_phy_reg_bm2(struct e1000_hw *hw, u32 offset, u16 data);
477 extern void e1000e_phy_force_speed_duplex_setup(struct e1000_hw *hw, u16 *phy_ctrl);
478 extern s32 e1000e_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data);
479 extern s32 e1000e_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data);
480 extern s32 e1000e_phy_has_link_generic(struct e1000_hw *hw, u32 iterations,
481 u32 usec_interval, bool *success);
482 extern s32 e1000e_phy_reset_dsp(struct e1000_hw *hw);
483 extern s32 e1000e_read_phy_reg_mdic(struct e1000_hw *hw, u32 offset, u16 *data);
484 extern s32 e1000e_write_phy_reg_mdic(struct e1000_hw *hw, u32 offset, u16 data);
485 extern s32 e1000e_check_downshift(struct e1000_hw *hw);
487 static inline s32 e1000_phy_hw_reset(struct e1000_hw *hw)
489 return hw->phy.ops.reset_phy(hw);
492 static inline s32 e1000_check_reset_block(struct e1000_hw *hw)
494 return hw->phy.ops.check_reset_block(hw);
497 static inline s32 e1e_rphy(struct e1000_hw *hw, u32 offset, u16 *data)
499 return hw->phy.ops.read_phy_reg(hw, offset, data);
502 static inline s32 e1e_wphy(struct e1000_hw *hw, u32 offset, u16 data)
504 return hw->phy.ops.write_phy_reg(hw, offset, data);
507 static inline s32 e1000_get_cable_length(struct e1000_hw *hw)
509 return hw->phy.ops.get_cable_length(hw);
512 extern s32 e1000e_acquire_nvm(struct e1000_hw *hw);
513 extern s32 e1000e_write_nvm_spi(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
514 extern s32 e1000e_update_nvm_checksum_generic(struct e1000_hw *hw);
515 extern s32 e1000e_poll_eerd_eewr_done(struct e1000_hw *hw, int ee_reg);
516 extern s32 e1000e_read_nvm_eerd(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
517 extern s32 e1000e_validate_nvm_checksum_generic(struct e1000_hw *hw);
518 extern void e1000e_release_nvm(struct e1000_hw *hw);
519 extern void e1000e_reload_nvm(struct e1000_hw *hw);
520 extern s32 e1000e_read_mac_addr(struct e1000_hw *hw);
522 static inline s32 e1000_validate_nvm_checksum(struct e1000_hw *hw)
524 return hw->nvm.ops.validate_nvm(hw);
527 static inline s32 e1000e_update_nvm_checksum(struct e1000_hw *hw)
529 return hw->nvm.ops.update_nvm(hw);
532 static inline s32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
534 return hw->nvm.ops.read_nvm(hw, offset, words, data);
537 static inline s32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
539 return hw->nvm.ops.write_nvm(hw, offset, words, data);
542 static inline s32 e1000_get_phy_info(struct e1000_hw *hw)
544 return hw->phy.ops.get_phy_info(hw);
547 static inline s32 e1000e_check_mng_mode(struct e1000_hw *hw)
549 return hw->mac.ops.check_mng_mode(hw);
552 extern bool e1000e_check_mng_mode_generic(struct e1000_hw *hw);
553 extern bool e1000e_enable_tx_pkt_filtering(struct e1000_hw *hw);
554 extern s32 e1000e_mng_write_dhcp_info(struct e1000_hw *hw, u8 *buffer, u16 length);
556 static inline u32 __er32(struct e1000_hw *hw, unsigned long reg)
558 return readl(hw->hw_addr + reg);
561 static inline void __ew32(struct e1000_hw *hw, unsigned long reg, u32 val)
563 writel(val, hw->hw_addr + reg);
566 #endif /* _E1000_H_ */