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