e1000e: add support for 82567LM-3 and 82567LF-3 (ICH10D) parts
[linux-2.6/mini2440.git] / drivers / net / e1000e / e1000.h
blobef66dc44fae62e42a11adb169d8bccefd8377738
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
13 more details.
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".
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
27 *******************************************************************************/
29 /* Linux PRO/1000 Ethernet Driver main header file */
31 #ifndef _E1000_H_
32 #define _E1000_H_
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>
40 #include "hw.h"
42 struct e1000_info;
44 #define e_printk(level, adapter, format, arg...) \
45 printk(level "%s: %s: " format, pci_name(adapter->pdev), \
46 adapter->netdev->name, ## arg)
48 #ifdef DEBUG
49 #define e_dbg(format, arg...) \
50 e_printk(KERN_DEBUG , adapter, format, ## arg)
51 #else
52 #define e_dbg(format, arg...) do { (void)(adapter); } while (0)
53 #endif
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 /* Tx/Rx descriptor defines */
66 #define E1000_DEFAULT_TXD 256
67 #define E1000_MAX_TXD 4096
68 #define E1000_MIN_TXD 64
70 #define E1000_DEFAULT_RXD 256
71 #define E1000_MAX_RXD 4096
72 #define E1000_MIN_RXD 64
74 #define E1000_MIN_ITR_USECS 10 /* 100000 irq/sec */
75 #define E1000_MAX_ITR_USECS 10000 /* 100 irq/sec */
77 /* Early Receive defines */
78 #define E1000_ERT_2048 0x100
80 #define E1000_FC_PAUSE_TIME 0x0680 /* 858 usec */
82 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
83 /* How many Rx Buffers do we bundle into one write to the hardware ? */
84 #define E1000_RX_BUFFER_WRITE 16 /* Must be power of 2 */
86 #define AUTO_ALL_MODES 0
87 #define E1000_EEPROM_APME 0x0400
89 #define E1000_MNG_VLAN_NONE (-1)
91 /* Number of packet split data buffers (not including the header buffer) */
92 #define PS_PAGE_BUFFERS (MAX_PS_BUFFERS - 1)
94 enum e1000_boards {
95 board_82571,
96 board_82572,
97 board_82573,
98 board_80003es2lan,
99 board_ich8lan,
100 board_ich9lan,
101 board_ich10lan,
104 struct e1000_queue_stats {
105 u64 packets;
106 u64 bytes;
109 struct e1000_ps_page {
110 struct page *page;
111 u64 dma; /* must be u64 - written to hw */
115 * wrappers around a pointer to a socket buffer,
116 * so a DMA handle can be stored along with the buffer
118 struct e1000_buffer {
119 dma_addr_t dma;
120 struct sk_buff *skb;
121 union {
122 /* Tx */
123 struct {
124 unsigned long time_stamp;
125 u16 length;
126 u16 next_to_watch;
128 /* Rx */
129 /* arrays of page information for packet split */
130 struct e1000_ps_page *ps_pages;
132 struct page *page;
135 struct e1000_ring {
136 void *desc; /* pointer to ring memory */
137 dma_addr_t dma; /* phys address of ring */
138 unsigned int size; /* length of ring in bytes */
139 unsigned int count; /* number of desc. in ring */
141 u16 next_to_use;
142 u16 next_to_clean;
144 u16 head;
145 u16 tail;
147 /* array of buffer information structs */
148 struct e1000_buffer *buffer_info;
150 struct sk_buff *rx_skb_top;
152 struct e1000_queue_stats stats;
155 /* PHY register snapshot values */
156 struct e1000_phy_regs {
157 u16 bmcr; /* basic mode control register */
158 u16 bmsr; /* basic mode status register */
159 u16 advertise; /* auto-negotiation advertisement */
160 u16 lpa; /* link partner ability register */
161 u16 expansion; /* auto-negotiation expansion reg */
162 u16 ctrl1000; /* 1000BASE-T control register */
163 u16 stat1000; /* 1000BASE-T status register */
164 u16 estatus; /* extended status register */
167 /* board specific private data structure */
168 struct e1000_adapter {
169 struct timer_list watchdog_timer;
170 struct timer_list phy_info_timer;
171 struct timer_list blink_timer;
173 struct work_struct reset_task;
174 struct work_struct watchdog_task;
176 const struct e1000_info *ei;
178 struct vlan_group *vlgrp;
179 u32 bd_number;
180 u32 rx_buffer_len;
181 u16 mng_vlan_id;
182 u16 link_speed;
183 u16 link_duplex;
185 spinlock_t tx_queue_lock; /* prevent concurrent tail updates */
187 /* track device up/down/testing state */
188 unsigned long state;
190 /* Interrupt Throttle Rate */
191 u32 itr;
192 u32 itr_setting;
193 u16 tx_itr;
194 u16 rx_itr;
197 * Tx
199 struct e1000_ring *tx_ring /* One per active queue */
200 ____cacheline_aligned_in_smp;
202 struct napi_struct napi;
204 unsigned long tx_queue_len;
205 unsigned int restart_queue;
206 u32 txd_cmd;
208 bool detect_tx_hung;
209 u8 tx_timeout_factor;
211 u32 tx_int_delay;
212 u32 tx_abs_int_delay;
214 unsigned int total_tx_bytes;
215 unsigned int total_tx_packets;
216 unsigned int total_rx_bytes;
217 unsigned int total_rx_packets;
219 /* Tx stats */
220 u64 tpt_old;
221 u64 colc_old;
222 u32 gotc;
223 u64 gotc_old;
224 u32 tx_timeout_count;
225 u32 tx_fifo_head;
226 u32 tx_head_addr;
227 u32 tx_fifo_size;
228 u32 tx_dma_failed;
231 * Rx
233 bool (*clean_rx) (struct e1000_adapter *adapter,
234 int *work_done, int work_to_do)
235 ____cacheline_aligned_in_smp;
236 void (*alloc_rx_buf) (struct e1000_adapter *adapter,
237 int cleaned_count);
238 struct e1000_ring *rx_ring;
240 u32 rx_int_delay;
241 u32 rx_abs_int_delay;
243 /* Rx stats */
244 u64 hw_csum_err;
245 u64 hw_csum_good;
246 u64 rx_hdr_split;
247 u32 gorc;
248 u64 gorc_old;
249 u32 alloc_rx_buff_failed;
250 u32 rx_dma_failed;
252 unsigned int rx_ps_pages;
253 u16 rx_ps_bsize0;
254 u32 max_frame_size;
255 u32 min_frame_size;
257 /* OS defined structs */
258 struct net_device *netdev;
259 struct pci_dev *pdev;
260 struct net_device_stats net_stats;
261 spinlock_t stats_lock; /* prevent concurrent stats updates */
263 /* structs defined in e1000_hw.h */
264 struct e1000_hw hw;
266 struct e1000_hw_stats stats;
267 struct e1000_phy_info phy_info;
268 struct e1000_phy_stats phy_stats;
270 /* Snapshot of PHY registers */
271 struct e1000_phy_regs phy_regs;
273 struct e1000_ring test_tx_ring;
274 struct e1000_ring test_rx_ring;
275 u32 test_icr;
277 u32 msg_enable;
279 u32 eeprom_wol;
280 u32 wol;
281 u32 pba;
283 bool fc_autoneg;
285 unsigned long led_status;
287 unsigned int flags;
290 struct e1000_info {
291 enum e1000_mac_type mac;
292 unsigned int flags;
293 u32 pba;
294 s32 (*get_variants)(struct e1000_adapter *);
295 struct e1000_mac_operations *mac_ops;
296 struct e1000_phy_operations *phy_ops;
297 struct e1000_nvm_operations *nvm_ops;
300 /* hardware capability, feature, and workaround flags */
301 #define FLAG_HAS_AMT (1 << 0)
302 #define FLAG_HAS_FLASH (1 << 1)
303 #define FLAG_HAS_HW_VLAN_FILTER (1 << 2)
304 #define FLAG_HAS_WOL (1 << 3)
305 #define FLAG_HAS_ERT (1 << 4)
306 #define FLAG_HAS_CTRLEXT_ON_LOAD (1 << 5)
307 #define FLAG_HAS_SWSM_ON_LOAD (1 << 6)
308 #define FLAG_HAS_JUMBO_FRAMES (1 << 7)
309 #define FLAG_IS_ICH (1 << 9)
310 #define FLAG_HAS_SMART_POWER_DOWN (1 << 11)
311 #define FLAG_IS_QUAD_PORT_A (1 << 12)
312 #define FLAG_IS_QUAD_PORT (1 << 13)
313 #define FLAG_TIPG_MEDIUM_FOR_80003ESLAN (1 << 14)
314 #define FLAG_APME_IN_WUC (1 << 15)
315 #define FLAG_APME_IN_CTRL3 (1 << 16)
316 #define FLAG_APME_CHECK_PORT_B (1 << 17)
317 #define FLAG_DISABLE_FC_PAUSE_TIME (1 << 18)
318 #define FLAG_NO_WAKE_UCAST (1 << 19)
319 #define FLAG_MNG_PT_ENABLED (1 << 20)
320 #define FLAG_RESET_OVERWRITES_LAA (1 << 21)
321 #define FLAG_TARC_SPEED_MODE_BIT (1 << 22)
322 #define FLAG_TARC_SET_BIT_ZERO (1 << 23)
323 #define FLAG_RX_NEEDS_RESTART (1 << 24)
324 #define FLAG_LSC_GIG_SPEED_DROP (1 << 25)
325 #define FLAG_SMART_POWER_DOWN (1 << 26)
326 #define FLAG_MSI_ENABLED (1 << 27)
327 #define FLAG_RX_CSUM_ENABLED (1 << 28)
328 #define FLAG_TSO_FORCE (1 << 29)
329 #define FLAG_RX_RESTART_NOW (1 << 30)
330 #define FLAG_MSI_TEST_FAILED (1 << 31)
332 #define E1000_RX_DESC_PS(R, i) \
333 (&(((union e1000_rx_desc_packet_split *)((R).desc))[i]))
334 #define E1000_GET_DESC(R, i, type) (&(((struct type *)((R).desc))[i]))
335 #define E1000_RX_DESC(R, i) E1000_GET_DESC(R, i, e1000_rx_desc)
336 #define E1000_TX_DESC(R, i) E1000_GET_DESC(R, i, e1000_tx_desc)
337 #define E1000_CONTEXT_DESC(R, i) E1000_GET_DESC(R, i, e1000_context_desc)
339 enum e1000_state_t {
340 __E1000_TESTING,
341 __E1000_RESETTING,
342 __E1000_DOWN
345 enum latency_range {
346 lowest_latency = 0,
347 low_latency = 1,
348 bulk_latency = 2,
349 latency_invalid = 255
352 extern char e1000e_driver_name[];
353 extern const char e1000e_driver_version[];
355 extern void e1000e_check_options(struct e1000_adapter *adapter);
356 extern void e1000e_set_ethtool_ops(struct net_device *netdev);
358 extern int e1000e_up(struct e1000_adapter *adapter);
359 extern void e1000e_down(struct e1000_adapter *adapter);
360 extern void e1000e_reinit_locked(struct e1000_adapter *adapter);
361 extern void e1000e_reset(struct e1000_adapter *adapter);
362 extern void e1000e_power_up_phy(struct e1000_adapter *adapter);
363 extern int e1000e_setup_rx_resources(struct e1000_adapter *adapter);
364 extern int e1000e_setup_tx_resources(struct e1000_adapter *adapter);
365 extern void e1000e_free_rx_resources(struct e1000_adapter *adapter);
366 extern void e1000e_free_tx_resources(struct e1000_adapter *adapter);
367 extern void e1000e_update_stats(struct e1000_adapter *adapter);
369 extern unsigned int copybreak;
371 extern char *e1000e_get_hw_dev_name(struct e1000_hw *hw);
373 extern struct e1000_info e1000_82571_info;
374 extern struct e1000_info e1000_82572_info;
375 extern struct e1000_info e1000_82573_info;
376 extern struct e1000_info e1000_ich8_info;
377 extern struct e1000_info e1000_ich9_info;
378 extern struct e1000_info e1000_ich10_info;
379 extern struct e1000_info e1000_es2_info;
381 extern s32 e1000e_read_pba_num(struct e1000_hw *hw, u32 *pba_num);
383 extern s32 e1000e_commit_phy(struct e1000_hw *hw);
385 extern bool e1000e_enable_mng_pass_thru(struct e1000_hw *hw);
387 extern bool e1000e_get_laa_state_82571(struct e1000_hw *hw);
388 extern void e1000e_set_laa_state_82571(struct e1000_hw *hw, bool state);
390 extern void e1000e_set_kmrn_lock_loss_workaround_ich8lan(struct e1000_hw *hw,
391 bool state);
392 extern void e1000e_igp3_phy_powerdown_workaround_ich8lan(struct e1000_hw *hw);
393 extern void e1000e_gig_downshift_workaround_ich8lan(struct e1000_hw *hw);
394 extern void e1000e_disable_gig_wol_ich8lan(struct e1000_hw *hw);
396 extern s32 e1000e_check_for_copper_link(struct e1000_hw *hw);
397 extern s32 e1000e_check_for_fiber_link(struct e1000_hw *hw);
398 extern s32 e1000e_check_for_serdes_link(struct e1000_hw *hw);
399 extern s32 e1000e_cleanup_led_generic(struct e1000_hw *hw);
400 extern s32 e1000e_led_on_generic(struct e1000_hw *hw);
401 extern s32 e1000e_led_off_generic(struct e1000_hw *hw);
402 extern s32 e1000e_get_bus_info_pcie(struct e1000_hw *hw);
403 extern s32 e1000e_get_speed_and_duplex_copper(struct e1000_hw *hw, u16 *speed, u16 *duplex);
404 extern s32 e1000e_get_speed_and_duplex_fiber_serdes(struct e1000_hw *hw, u16 *speed, u16 *duplex);
405 extern s32 e1000e_disable_pcie_master(struct e1000_hw *hw);
406 extern s32 e1000e_get_auto_rd_done(struct e1000_hw *hw);
407 extern s32 e1000e_id_led_init(struct e1000_hw *hw);
408 extern void e1000e_clear_hw_cntrs_base(struct e1000_hw *hw);
409 extern s32 e1000e_setup_fiber_serdes_link(struct e1000_hw *hw);
410 extern s32 e1000e_copper_link_setup_m88(struct e1000_hw *hw);
411 extern s32 e1000e_copper_link_setup_igp(struct e1000_hw *hw);
412 extern s32 e1000e_setup_link(struct e1000_hw *hw);
413 extern void e1000e_clear_vfta(struct e1000_hw *hw);
414 extern void e1000e_init_rx_addrs(struct e1000_hw *hw, u16 rar_count);
415 extern void e1000e_update_mc_addr_list_generic(struct e1000_hw *hw,
416 u8 *mc_addr_list,
417 u32 mc_addr_count,
418 u32 rar_used_count,
419 u32 rar_count);
420 extern void e1000e_rar_set(struct e1000_hw *hw, u8 *addr, u32 index);
421 extern s32 e1000e_set_fc_watermarks(struct e1000_hw *hw);
422 extern void e1000e_set_pcie_no_snoop(struct e1000_hw *hw, u32 no_snoop);
423 extern s32 e1000e_get_hw_semaphore(struct e1000_hw *hw);
424 extern s32 e1000e_valid_led_default(struct e1000_hw *hw, u16 *data);
425 extern void e1000e_config_collision_dist(struct e1000_hw *hw);
426 extern s32 e1000e_config_fc_after_link_up(struct e1000_hw *hw);
427 extern s32 e1000e_force_mac_fc(struct e1000_hw *hw);
428 extern s32 e1000e_blink_led(struct e1000_hw *hw);
429 extern void e1000e_write_vfta(struct e1000_hw *hw, u32 offset, u32 value);
430 extern void e1000e_reset_adaptive(struct e1000_hw *hw);
431 extern void e1000e_update_adaptive(struct e1000_hw *hw);
433 extern s32 e1000e_setup_copper_link(struct e1000_hw *hw);
434 extern s32 e1000e_get_phy_id(struct e1000_hw *hw);
435 extern void e1000e_put_hw_semaphore(struct e1000_hw *hw);
436 extern s32 e1000e_check_reset_block_generic(struct e1000_hw *hw);
437 extern s32 e1000e_phy_force_speed_duplex_igp(struct e1000_hw *hw);
438 extern s32 e1000e_get_cable_length_igp_2(struct e1000_hw *hw);
439 extern s32 e1000e_get_phy_info_igp(struct e1000_hw *hw);
440 extern s32 e1000e_read_phy_reg_igp(struct e1000_hw *hw, u32 offset, u16 *data);
441 extern s32 e1000e_phy_hw_reset_generic(struct e1000_hw *hw);
442 extern s32 e1000e_set_d3_lplu_state(struct e1000_hw *hw, bool active);
443 extern s32 e1000e_write_phy_reg_igp(struct e1000_hw *hw, u32 offset, u16 data);
444 extern s32 e1000e_phy_sw_reset(struct e1000_hw *hw);
445 extern s32 e1000e_phy_force_speed_duplex_m88(struct e1000_hw *hw);
446 extern s32 e1000e_get_cfg_done(struct e1000_hw *hw);
447 extern s32 e1000e_get_cable_length_m88(struct e1000_hw *hw);
448 extern s32 e1000e_get_phy_info_m88(struct e1000_hw *hw);
449 extern s32 e1000e_read_phy_reg_m88(struct e1000_hw *hw, u32 offset, u16 *data);
450 extern s32 e1000e_write_phy_reg_m88(struct e1000_hw *hw, u32 offset, u16 data);
451 extern s32 e1000e_phy_init_script_igp3(struct e1000_hw *hw);
452 extern enum e1000_phy_type e1000e_get_phy_type_from_id(u32 phy_id);
453 extern s32 e1000e_determine_phy_address(struct e1000_hw *hw);
454 extern s32 e1000e_write_phy_reg_bm(struct e1000_hw *hw, u32 offset, u16 data);
455 extern s32 e1000e_read_phy_reg_bm(struct e1000_hw *hw, u32 offset, u16 *data);
456 extern void e1000e_phy_force_speed_duplex_setup(struct e1000_hw *hw, u16 *phy_ctrl);
457 extern s32 e1000e_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data);
458 extern s32 e1000e_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data);
459 extern s32 e1000e_phy_has_link_generic(struct e1000_hw *hw, u32 iterations,
460 u32 usec_interval, bool *success);
461 extern s32 e1000e_phy_reset_dsp(struct e1000_hw *hw);
462 extern s32 e1000e_read_phy_reg_mdic(struct e1000_hw *hw, u32 offset, u16 *data);
463 extern s32 e1000e_write_phy_reg_mdic(struct e1000_hw *hw, u32 offset, u16 data);
464 extern s32 e1000e_check_downshift(struct e1000_hw *hw);
466 static inline s32 e1000_phy_hw_reset(struct e1000_hw *hw)
468 return hw->phy.ops.reset_phy(hw);
471 static inline s32 e1000_check_reset_block(struct e1000_hw *hw)
473 return hw->phy.ops.check_reset_block(hw);
476 static inline s32 e1e_rphy(struct e1000_hw *hw, u32 offset, u16 *data)
478 return hw->phy.ops.read_phy_reg(hw, offset, data);
481 static inline s32 e1e_wphy(struct e1000_hw *hw, u32 offset, u16 data)
483 return hw->phy.ops.write_phy_reg(hw, offset, data);
486 static inline s32 e1000_get_cable_length(struct e1000_hw *hw)
488 return hw->phy.ops.get_cable_length(hw);
491 extern s32 e1000e_acquire_nvm(struct e1000_hw *hw);
492 extern s32 e1000e_write_nvm_spi(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
493 extern s32 e1000e_update_nvm_checksum_generic(struct e1000_hw *hw);
494 extern s32 e1000e_poll_eerd_eewr_done(struct e1000_hw *hw, int ee_reg);
495 extern s32 e1000e_read_nvm_eerd(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
496 extern s32 e1000e_validate_nvm_checksum_generic(struct e1000_hw *hw);
497 extern void e1000e_release_nvm(struct e1000_hw *hw);
498 extern void e1000e_reload_nvm(struct e1000_hw *hw);
499 extern s32 e1000e_read_mac_addr(struct e1000_hw *hw);
501 static inline s32 e1000_validate_nvm_checksum(struct e1000_hw *hw)
503 return hw->nvm.ops.validate_nvm(hw);
506 static inline s32 e1000e_update_nvm_checksum(struct e1000_hw *hw)
508 return hw->nvm.ops.update_nvm(hw);
511 static inline s32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
513 return hw->nvm.ops.read_nvm(hw, offset, words, data);
516 static inline s32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
518 return hw->nvm.ops.write_nvm(hw, offset, words, data);
521 static inline s32 e1000_get_phy_info(struct e1000_hw *hw)
523 return hw->phy.ops.get_phy_info(hw);
526 extern bool e1000e_check_mng_mode(struct e1000_hw *hw);
527 extern bool e1000e_enable_tx_pkt_filtering(struct e1000_hw *hw);
528 extern s32 e1000e_mng_write_dhcp_info(struct e1000_hw *hw, u8 *buffer, u16 length);
530 static inline u32 __er32(struct e1000_hw *hw, unsigned long reg)
532 return readl(hw->hw_addr + reg);
535 static inline void __ew32(struct e1000_hw *hw, unsigned long reg, u32 val)
537 writel(val, hw->hw_addr + reg);
540 #endif /* _E1000_H_ */