]> www.pilppa.org Git - linux-2.6-omap-h63xx.git/blob - drivers/net/e1000e/e1000.h
4a4f62e002b2e05e6c16e9346022106b31355fa5
[linux-2.6-omap-h63xx.git] / drivers / net / e1000e / e1000.h
1 /*******************************************************************************
2
3   Intel PRO/1000 Linux driver
4   Copyright(c) 1999 - 2008 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                   64
68
69 #define E1000_DEFAULT_RXD               256
70 #define E1000_MAX_RXD                   4096
71 #define E1000_MIN_RXD                   64
72
73 #define E1000_MIN_ITR_USECS             10 /* 100000 irq/sec */
74 #define E1000_MAX_ITR_USECS             10000 /* 100    irq/sec */
75
76 /* Early Receive defines */
77 #define E1000_ERT_2048                  0x100
78
79 #define E1000_FC_PAUSE_TIME             0x0680 /* 858 usec */
80
81 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
82 /* How many Rx Buffers do we bundle into one write to the hardware ? */
83 #define E1000_RX_BUFFER_WRITE           16 /* Must be power of 2 */
84
85 #define AUTO_ALL_MODES                  0
86 #define E1000_EEPROM_APME               0x0400
87
88 #define E1000_MNG_VLAN_NONE             (-1)
89
90 /* Number of packet split data buffers (not including the header buffer) */
91 #define PS_PAGE_BUFFERS                 (MAX_PS_BUFFERS - 1)
92
93 enum e1000_boards {
94         board_82571,
95         board_82572,
96         board_82573,
97         board_80003es2lan,
98         board_ich8lan,
99         board_ich9lan,
100 };
101
102 struct e1000_queue_stats {
103         u64 packets;
104         u64 bytes;
105 };
106
107 struct e1000_ps_page {
108         struct page *page;
109         u64 dma; /* must be u64 - written to hw */
110 };
111
112 /*
113  * wrappers around a pointer to a socket buffer,
114  * so a DMA handle can be stored along with the buffer
115  */
116 struct e1000_buffer {
117         dma_addr_t dma;
118         struct sk_buff *skb;
119         union {
120                 /* Tx */
121                 struct {
122                         unsigned long time_stamp;
123                         u16 length;
124                         u16 next_to_watch;
125                 };
126                 /* Rx */
127                 /* arrays of page information for packet split */
128                 struct e1000_ps_page *ps_pages;
129         };
130         struct page *page;
131 };
132
133 struct e1000_ring {
134         void *desc;                     /* pointer to ring memory  */
135         dma_addr_t dma;                 /* phys address of ring    */
136         unsigned int size;              /* length of ring in bytes */
137         unsigned int count;             /* number of desc. in ring */
138
139         u16 next_to_use;
140         u16 next_to_clean;
141
142         u16 head;
143         u16 tail;
144
145         /* array of buffer information structs */
146         struct e1000_buffer *buffer_info;
147
148         struct sk_buff *rx_skb_top;
149
150         struct e1000_queue_stats stats;
151 };
152
153 /* PHY register snapshot values */
154 struct e1000_phy_regs {
155         u16 bmcr;               /* basic mode control register    */
156         u16 bmsr;               /* basic mode status register     */
157         u16 advertise;          /* auto-negotiation advertisement */
158         u16 lpa;                /* link partner ability register  */
159         u16 expansion;          /* auto-negotiation expansion reg */
160         u16 ctrl1000;           /* 1000BASE-T control register    */
161         u16 stat1000;           /* 1000BASE-T status register     */
162         u16 estatus;            /* extended status register       */
163 };
164
165 /* board specific private data structure */
166 struct e1000_adapter {
167         struct timer_list watchdog_timer;
168         struct timer_list phy_info_timer;
169         struct timer_list blink_timer;
170
171         struct work_struct reset_task;
172         struct work_struct watchdog_task;
173
174         const struct e1000_info *ei;
175
176         struct vlan_group *vlgrp;
177         u32 bd_number;
178         u32 rx_buffer_len;
179         u16 mng_vlan_id;
180         u16 link_speed;
181         u16 link_duplex;
182
183         spinlock_t tx_queue_lock; /* prevent concurrent tail updates */
184
185         /* track device up/down/testing state */
186         unsigned long state;
187
188         /* Interrupt Throttle Rate */
189         u32 itr;
190         u32 itr_setting;
191         u16 tx_itr;
192         u16 rx_itr;
193
194         /*
195          * Tx
196          */
197         struct e1000_ring *tx_ring /* One per active queue */
198                                                 ____cacheline_aligned_in_smp;
199
200         struct napi_struct napi;
201
202         unsigned long tx_queue_len;
203         unsigned int restart_queue;
204         u32 txd_cmd;
205
206         bool detect_tx_hung;
207         u8 tx_timeout_factor;
208
209         u32 tx_int_delay;
210         u32 tx_abs_int_delay;
211
212         unsigned int total_tx_bytes;
213         unsigned int total_tx_packets;
214         unsigned int total_rx_bytes;
215         unsigned int total_rx_packets;
216
217         /* Tx stats */
218         u64 tpt_old;
219         u64 colc_old;
220         u32 gotc;
221         u64 gotc_old;
222         u32 tx_timeout_count;
223         u32 tx_fifo_head;
224         u32 tx_head_addr;
225         u32 tx_fifo_size;
226         u32 tx_dma_failed;
227
228         /*
229          * Rx
230          */
231         bool (*clean_rx) (struct e1000_adapter *adapter,
232                           int *work_done, int work_to_do)
233                                                 ____cacheline_aligned_in_smp;
234         void (*alloc_rx_buf) (struct e1000_adapter *adapter,
235                               int cleaned_count);
236         struct e1000_ring *rx_ring;
237
238         u32 rx_int_delay;
239         u32 rx_abs_int_delay;
240
241         /* Rx stats */
242         u64 hw_csum_err;
243         u64 hw_csum_good;
244         u64 rx_hdr_split;
245         u32 gorc;
246         u64 gorc_old;
247         u32 alloc_rx_buff_failed;
248         u32 rx_dma_failed;
249
250         unsigned int rx_ps_pages;
251         u16 rx_ps_bsize0;
252         u32 max_frame_size;
253         u32 min_frame_size;
254
255         /* OS defined structs */
256         struct net_device *netdev;
257         struct pci_dev *pdev;
258         struct net_device_stats net_stats;
259         spinlock_t stats_lock;      /* prevent concurrent stats updates */
260
261         /* structs defined in e1000_hw.h */
262         struct e1000_hw hw;
263
264         struct e1000_hw_stats stats;
265         struct e1000_phy_info phy_info;
266         struct e1000_phy_stats phy_stats;
267
268         /* Snapshot of PHY registers */
269         struct e1000_phy_regs phy_regs;
270
271         struct e1000_ring test_tx_ring;
272         struct e1000_ring test_rx_ring;
273         u32 test_icr;
274
275         u32 msg_enable;
276
277         u32 eeprom_wol;
278         u32 wol;
279         u32 pba;
280
281         bool fc_autoneg;
282
283         unsigned long led_status;
284
285         unsigned int flags;
286
287         /* for ioport free */
288         int bars;
289         int need_ioport;
290 };
291
292 struct e1000_info {
293         enum e1000_mac_type     mac;
294         unsigned int            flags;
295         u32                     pba;
296         s32                     (*get_variants)(struct e1000_adapter *);
297         struct e1000_mac_operations *mac_ops;
298         struct e1000_phy_operations *phy_ops;
299         struct e1000_nvm_operations *nvm_ops;
300 };
301
302 /* hardware capability, feature, and workaround flags */
303 #define FLAG_HAS_AMT                      (1 << 0)
304 #define FLAG_HAS_FLASH                    (1 << 1)
305 #define FLAG_HAS_HW_VLAN_FILTER           (1 << 2)
306 #define FLAG_HAS_WOL                      (1 << 3)
307 #define FLAG_HAS_ERT                      (1 << 4)
308 #define FLAG_HAS_CTRLEXT_ON_LOAD          (1 << 5)
309 #define FLAG_HAS_SWSM_ON_LOAD             (1 << 6)
310 #define FLAG_HAS_JUMBO_FRAMES             (1 << 7)
311 #define FLAG_IS_ICH                       (1 << 9)
312 #define FLAG_HAS_SMART_POWER_DOWN         (1 << 11)
313 #define FLAG_IS_QUAD_PORT_A               (1 << 12)
314 #define FLAG_IS_QUAD_PORT                 (1 << 13)
315 #define FLAG_TIPG_MEDIUM_FOR_80003ESLAN   (1 << 14)
316 #define FLAG_APME_IN_WUC                  (1 << 15)
317 #define FLAG_APME_IN_CTRL3                (1 << 16)
318 #define FLAG_APME_CHECK_PORT_B            (1 << 17)
319 #define FLAG_DISABLE_FC_PAUSE_TIME        (1 << 18)
320 #define FLAG_NO_WAKE_UCAST                (1 << 19)
321 #define FLAG_MNG_PT_ENABLED               (1 << 20)
322 #define FLAG_RESET_OVERWRITES_LAA         (1 << 21)
323 #define FLAG_TARC_SPEED_MODE_BIT          (1 << 22)
324 #define FLAG_TARC_SET_BIT_ZERO            (1 << 23)
325 #define FLAG_RX_NEEDS_RESTART             (1 << 24)
326 #define FLAG_LSC_GIG_SPEED_DROP           (1 << 25)
327 #define FLAG_SMART_POWER_DOWN             (1 << 26)
328 #define FLAG_MSI_ENABLED                  (1 << 27)
329 #define FLAG_RX_CSUM_ENABLED              (1 << 28)
330 #define FLAG_TSO_FORCE                    (1 << 29)
331 #define FLAG_RX_RESTART_NOW               (1 << 30)
332
333 #define E1000_RX_DESC_PS(R, i)      \
334         (&(((union e1000_rx_desc_packet_split *)((R).desc))[i]))
335 #define E1000_GET_DESC(R, i, type)      (&(((struct type *)((R).desc))[i]))
336 #define E1000_RX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_rx_desc)
337 #define E1000_TX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_tx_desc)
338 #define E1000_CONTEXT_DESC(R, i)        E1000_GET_DESC(R, i, e1000_context_desc)
339
340 enum e1000_state_t {
341         __E1000_TESTING,
342         __E1000_RESETTING,
343         __E1000_DOWN
344 };
345
346 enum latency_range {
347         lowest_latency = 0,
348         low_latency = 1,
349         bulk_latency = 2,
350         latency_invalid = 255
351 };
352
353 extern char e1000e_driver_name[];
354 extern const char e1000e_driver_version[];
355
356 extern void e1000e_check_options(struct e1000_adapter *adapter);
357 extern void e1000e_set_ethtool_ops(struct net_device *netdev);
358
359 extern int e1000e_up(struct e1000_adapter *adapter);
360 extern void e1000e_down(struct e1000_adapter *adapter);
361 extern void e1000e_reinit_locked(struct e1000_adapter *adapter);
362 extern void e1000e_reset(struct e1000_adapter *adapter);
363 extern void e1000e_power_up_phy(struct e1000_adapter *adapter);
364 extern int e1000e_setup_rx_resources(struct e1000_adapter *adapter);
365 extern int e1000e_setup_tx_resources(struct e1000_adapter *adapter);
366 extern void e1000e_free_rx_resources(struct e1000_adapter *adapter);
367 extern void e1000e_free_tx_resources(struct e1000_adapter *adapter);
368 extern void e1000e_update_stats(struct e1000_adapter *adapter);
369
370 extern unsigned int copybreak;
371
372 extern char *e1000e_get_hw_dev_name(struct e1000_hw *hw);
373
374 extern struct e1000_info e1000_82571_info;
375 extern struct e1000_info e1000_82572_info;
376 extern struct e1000_info e1000_82573_info;
377 extern struct e1000_info e1000_ich8_info;
378 extern struct e1000_info e1000_ich9_info;
379 extern struct e1000_info e1000_es2_info;
380
381 extern s32 e1000e_read_pba_num(struct e1000_hw *hw, u32 *pba_num);
382
383 extern s32  e1000e_commit_phy(struct e1000_hw *hw);
384
385 extern bool e1000e_enable_mng_pass_thru(struct e1000_hw *hw);
386
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);
389
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);
395
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);
432
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 enum e1000_phy_type e1000e_get_phy_type_from_id(u32 phy_id);
452 extern s32 e1000e_determine_phy_address(struct e1000_hw *hw);
453 extern s32 e1000e_write_phy_reg_bm(struct e1000_hw *hw, u32 offset, u16 data);
454 extern s32 e1000e_read_phy_reg_bm(struct e1000_hw *hw, u32 offset, u16 *data);
455 extern void e1000e_phy_force_speed_duplex_setup(struct e1000_hw *hw, u16 *phy_ctrl);
456 extern s32 e1000e_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data);
457 extern s32 e1000e_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data);
458 extern s32 e1000e_phy_has_link_generic(struct e1000_hw *hw, u32 iterations,
459                                u32 usec_interval, bool *success);
460 extern s32 e1000e_phy_reset_dsp(struct e1000_hw *hw);
461 extern s32 e1000e_read_phy_reg_mdic(struct e1000_hw *hw, u32 offset, u16 *data);
462 extern s32 e1000e_write_phy_reg_mdic(struct e1000_hw *hw, u32 offset, u16 data);
463 extern s32 e1000e_check_downshift(struct e1000_hw *hw);
464
465 static inline s32 e1000_phy_hw_reset(struct e1000_hw *hw)
466 {
467         return hw->phy.ops.reset_phy(hw);
468 }
469
470 static inline s32 e1000_check_reset_block(struct e1000_hw *hw)
471 {
472         return hw->phy.ops.check_reset_block(hw);
473 }
474
475 static inline s32 e1e_rphy(struct e1000_hw *hw, u32 offset, u16 *data)
476 {
477         return hw->phy.ops.read_phy_reg(hw, offset, data);
478 }
479
480 static inline s32 e1e_wphy(struct e1000_hw *hw, u32 offset, u16 data)
481 {
482         return hw->phy.ops.write_phy_reg(hw, offset, data);
483 }
484
485 static inline s32 e1000_get_cable_length(struct e1000_hw *hw)
486 {
487         return hw->phy.ops.get_cable_length(hw);
488 }
489
490 extern s32 e1000e_acquire_nvm(struct e1000_hw *hw);
491 extern s32 e1000e_write_nvm_spi(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
492 extern s32 e1000e_update_nvm_checksum_generic(struct e1000_hw *hw);
493 extern s32 e1000e_poll_eerd_eewr_done(struct e1000_hw *hw, int ee_reg);
494 extern s32 e1000e_read_nvm_eerd(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
495 extern s32 e1000e_validate_nvm_checksum_generic(struct e1000_hw *hw);
496 extern void e1000e_release_nvm(struct e1000_hw *hw);
497 extern void e1000e_reload_nvm(struct e1000_hw *hw);
498 extern s32 e1000e_read_mac_addr(struct e1000_hw *hw);
499
500 static inline s32 e1000_validate_nvm_checksum(struct e1000_hw *hw)
501 {
502         return hw->nvm.ops.validate_nvm(hw);
503 }
504
505 static inline s32 e1000e_update_nvm_checksum(struct e1000_hw *hw)
506 {
507         return hw->nvm.ops.update_nvm(hw);
508 }
509
510 static inline s32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
511 {
512         return hw->nvm.ops.read_nvm(hw, offset, words, data);
513 }
514
515 static inline s32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
516 {
517         return hw->nvm.ops.write_nvm(hw, offset, words, data);
518 }
519
520 static inline s32 e1000_get_phy_info(struct e1000_hw *hw)
521 {
522         return hw->phy.ops.get_phy_info(hw);
523 }
524
525 extern bool e1000e_check_mng_mode(struct e1000_hw *hw);
526 extern bool e1000e_enable_tx_pkt_filtering(struct e1000_hw *hw);
527 extern s32 e1000e_mng_write_dhcp_info(struct e1000_hw *hw, u8 *buffer, u16 length);
528
529 static inline u32 __er32(struct e1000_hw *hw, unsigned long reg)
530 {
531         return readl(hw->hw_addr + reg);
532 }
533
534 static inline void __ew32(struct e1000_hw *hw, unsigned long reg, u32 val)
535 {
536         writel(val, hw->hw_addr + reg);
537 }
538
539 #endif /* _E1000_H_ */