e1000e / PCI / PM: Add basic runtime PM support (rev. 4)
[linux-2.6-block.git] / drivers / net / e1000e / e1000.h
1 /*******************************************************************************
2
3   Intel PRO/1000 Linux driver
4   Copyright(c) 1999 - 2009 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 #include <linux/pci.h>
40
41 #include "hw.h"
42
43 struct e1000_info;
44
45 #define e_printk(level, adapter, format, arg...) \
46         printk(level "%s: %s: " format, pci_name(adapter->pdev), \
47                adapter->netdev->name, ## arg)
48
49 #ifdef DEBUG
50 #define e_dbg(format, arg...) \
51         e_printk(KERN_DEBUG , hw->adapter, format, ## arg)
52 #else
53 #define e_dbg(format, arg...) do { (void)(hw); } while (0)
54 #endif
55
56 #define e_err(format, arg...) \
57         e_printk(KERN_ERR, adapter, format, ## arg)
58 #define e_info(format, arg...) \
59         e_printk(KERN_INFO, adapter, format, ## arg)
60 #define e_warn(format, arg...) \
61         e_printk(KERN_WARNING, adapter, format, ## arg)
62 #define e_notice(format, arg...) \
63         e_printk(KERN_NOTICE, adapter, format, ## arg)
64
65
66 /* Interrupt modes, as used by the IntMode parameter */
67 #define E1000E_INT_MODE_LEGACY          0
68 #define E1000E_INT_MODE_MSI             1
69 #define E1000E_INT_MODE_MSIX            2
70
71 /* Tx/Rx descriptor defines */
72 #define E1000_DEFAULT_TXD               256
73 #define E1000_MAX_TXD                   4096
74 #define E1000_MIN_TXD                   64
75
76 #define E1000_DEFAULT_RXD               256
77 #define E1000_MAX_RXD                   4096
78 #define E1000_MIN_RXD                   64
79
80 #define E1000_MIN_ITR_USECS             10 /* 100000 irq/sec */
81 #define E1000_MAX_ITR_USECS             10000 /* 100    irq/sec */
82
83 /* Early Receive defines */
84 #define E1000_ERT_2048                  0x100
85
86 #define E1000_FC_PAUSE_TIME             0x0680 /* 858 usec */
87
88 /* How many Tx Descriptors do we need to call netif_wake_queue ? */
89 /* How many Rx Buffers do we bundle into one write to the hardware ? */
90 #define E1000_RX_BUFFER_WRITE           16 /* Must be power of 2 */
91
92 #define AUTO_ALL_MODES                  0
93 #define E1000_EEPROM_APME               0x0400
94
95 #define E1000_MNG_VLAN_NONE             (-1)
96
97 /* Number of packet split data buffers (not including the header buffer) */
98 #define PS_PAGE_BUFFERS                 (MAX_PS_BUFFERS - 1)
99
100 #define DEFAULT_JUMBO                   9234
101
102 /* BM/HV Specific Registers */
103 #define BM_PORT_CTRL_PAGE                 769
104
105 #define PHY_UPPER_SHIFT                   21
106 #define BM_PHY_REG(page, reg) \
107         (((reg) & MAX_PHY_REG_ADDRESS) |\
108          (((page) & 0xFFFF) << PHY_PAGE_SHIFT) |\
109          (((reg) & ~MAX_PHY_REG_ADDRESS) << (PHY_UPPER_SHIFT - PHY_PAGE_SHIFT)))
110
111 /* PHY Wakeup Registers and defines */
112 #define BM_RCTL         PHY_REG(BM_WUC_PAGE, 0)
113 #define BM_WUC          PHY_REG(BM_WUC_PAGE, 1)
114 #define BM_WUFC         PHY_REG(BM_WUC_PAGE, 2)
115 #define BM_WUS          PHY_REG(BM_WUC_PAGE, 3)
116 #define BM_RAR_L(_i)    (BM_PHY_REG(BM_WUC_PAGE, 16 + ((_i) << 2)))
117 #define BM_RAR_M(_i)    (BM_PHY_REG(BM_WUC_PAGE, 17 + ((_i) << 2)))
118 #define BM_RAR_H(_i)    (BM_PHY_REG(BM_WUC_PAGE, 18 + ((_i) << 2)))
119 #define BM_RAR_CTRL(_i) (BM_PHY_REG(BM_WUC_PAGE, 19 + ((_i) << 2)))
120 #define BM_MTA(_i)      (BM_PHY_REG(BM_WUC_PAGE, 128 + ((_i) << 1)))
121
122 #define BM_RCTL_UPE           0x0001          /* Unicast Promiscuous Mode */
123 #define BM_RCTL_MPE           0x0002          /* Multicast Promiscuous Mode */
124 #define BM_RCTL_MO_SHIFT      3               /* Multicast Offset Shift */
125 #define BM_RCTL_MO_MASK       (3 << 3)        /* Multicast Offset Mask */
126 #define BM_RCTL_BAM           0x0020          /* Broadcast Accept Mode */
127 #define BM_RCTL_PMCF          0x0040          /* Pass MAC Control Frames */
128 #define BM_RCTL_RFCE          0x0080          /* Rx Flow Control Enable */
129
130 #define HV_SCC_UPPER            PHY_REG(778, 16) /* Single Collision Count */
131 #define HV_SCC_LOWER            PHY_REG(778, 17)
132 #define HV_ECOL_UPPER           PHY_REG(778, 18) /* Excessive Collision Count */
133 #define HV_ECOL_LOWER           PHY_REG(778, 19)
134 #define HV_MCC_UPPER            PHY_REG(778, 20) /* Multiple Collision Count */
135 #define HV_MCC_LOWER            PHY_REG(778, 21)
136 #define HV_LATECOL_UPPER        PHY_REG(778, 23) /* Late Collision Count */
137 #define HV_LATECOL_LOWER        PHY_REG(778, 24)
138 #define HV_COLC_UPPER           PHY_REG(778, 25) /* Collision Count */
139 #define HV_COLC_LOWER           PHY_REG(778, 26)
140 #define HV_DC_UPPER             PHY_REG(778, 27) /* Defer Count */
141 #define HV_DC_LOWER             PHY_REG(778, 28)
142 #define HV_TNCRS_UPPER          PHY_REG(778, 29) /* Transmit with no CRS */
143 #define HV_TNCRS_LOWER          PHY_REG(778, 30)
144
145 #define E1000_FCRTV_PCH     0x05F40 /* PCH Flow Control Refresh Timer Value */
146
147 /* BM PHY Copper Specific Status */
148 #define BM_CS_STATUS                      17
149 #define BM_CS_STATUS_LINK_UP              0x0400
150 #define BM_CS_STATUS_RESOLVED             0x0800
151 #define BM_CS_STATUS_SPEED_MASK           0xC000
152 #define BM_CS_STATUS_SPEED_1000           0x8000
153
154 /* 82577 Mobile Phy Status Register */
155 #define HV_M_STATUS                       26
156 #define HV_M_STATUS_AUTONEG_COMPLETE      0x1000
157 #define HV_M_STATUS_SPEED_MASK            0x0300
158 #define HV_M_STATUS_SPEED_1000            0x0200
159 #define HV_M_STATUS_LINK_UP               0x0040
160
161 /* Time to wait before putting the device into D3 if there's no link (in ms). */
162 #define LINK_TIMEOUT            100
163
164 enum e1000_boards {
165         board_82571,
166         board_82572,
167         board_82573,
168         board_82574,
169         board_82583,
170         board_80003es2lan,
171         board_ich8lan,
172         board_ich9lan,
173         board_ich10lan,
174         board_pchlan,
175 };
176
177 struct e1000_queue_stats {
178         u64 packets;
179         u64 bytes;
180 };
181
182 struct e1000_ps_page {
183         struct page *page;
184         u64 dma; /* must be u64 - written to hw */
185 };
186
187 /*
188  * wrappers around a pointer to a socket buffer,
189  * so a DMA handle can be stored along with the buffer
190  */
191 struct e1000_buffer {
192         dma_addr_t dma;
193         struct sk_buff *skb;
194         union {
195                 /* Tx */
196                 struct {
197                         unsigned long time_stamp;
198                         u16 length;
199                         u16 next_to_watch;
200                         u16 mapped_as_page;
201                 };
202                 /* Rx */
203                 struct {
204                         /* arrays of page information for packet split */
205                         struct e1000_ps_page *ps_pages;
206                         struct page *page;
207                 };
208         };
209 };
210
211 struct e1000_ring {
212         void *desc;                     /* pointer to ring memory  */
213         dma_addr_t dma;                 /* phys address of ring    */
214         unsigned int size;              /* length of ring in bytes */
215         unsigned int count;             /* number of desc. in ring */
216
217         u16 next_to_use;
218         u16 next_to_clean;
219
220         u16 head;
221         u16 tail;
222
223         /* array of buffer information structs */
224         struct e1000_buffer *buffer_info;
225
226         char name[IFNAMSIZ + 5];
227         u32 ims_val;
228         u32 itr_val;
229         u16 itr_register;
230         int set_itr;
231
232         struct sk_buff *rx_skb_top;
233
234         struct e1000_queue_stats stats;
235 };
236
237 /* PHY register snapshot values */
238 struct e1000_phy_regs {
239         u16 bmcr;               /* basic mode control register    */
240         u16 bmsr;               /* basic mode status register     */
241         u16 advertise;          /* auto-negotiation advertisement */
242         u16 lpa;                /* link partner ability register  */
243         u16 expansion;          /* auto-negotiation expansion reg */
244         u16 ctrl1000;           /* 1000BASE-T control register    */
245         u16 stat1000;           /* 1000BASE-T status register     */
246         u16 estatus;            /* extended status register       */
247 };
248
249 /* board specific private data structure */
250 struct e1000_adapter {
251         struct timer_list watchdog_timer;
252         struct timer_list phy_info_timer;
253         struct timer_list blink_timer;
254
255         struct work_struct reset_task;
256         struct work_struct watchdog_task;
257
258         const struct e1000_info *ei;
259
260         struct vlan_group *vlgrp;
261         u32 bd_number;
262         u32 rx_buffer_len;
263         u16 mng_vlan_id;
264         u16 link_speed;
265         u16 link_duplex;
266         u16 eeprom_vers;
267
268         /* track device up/down/testing state */
269         unsigned long state;
270
271         /* Interrupt Throttle Rate */
272         u32 itr;
273         u32 itr_setting;
274         u16 tx_itr;
275         u16 rx_itr;
276
277         /*
278          * Tx
279          */
280         struct e1000_ring *tx_ring /* One per active queue */
281                                                 ____cacheline_aligned_in_smp;
282
283         struct napi_struct napi;
284
285         unsigned long tx_queue_len;
286         unsigned int restart_queue;
287         u32 txd_cmd;
288
289         bool detect_tx_hung;
290         u8 tx_timeout_factor;
291
292         u32 tx_int_delay;
293         u32 tx_abs_int_delay;
294
295         unsigned int total_tx_bytes;
296         unsigned int total_tx_packets;
297         unsigned int total_rx_bytes;
298         unsigned int total_rx_packets;
299
300         /* Tx stats */
301         u64 tpt_old;
302         u64 colc_old;
303         u32 gotc;
304         u64 gotc_old;
305         u32 tx_timeout_count;
306         u32 tx_fifo_head;
307         u32 tx_head_addr;
308         u32 tx_fifo_size;
309         u32 tx_dma_failed;
310
311         /*
312          * Rx
313          */
314         bool (*clean_rx) (struct e1000_adapter *adapter,
315                           int *work_done, int work_to_do)
316                                                 ____cacheline_aligned_in_smp;
317         void (*alloc_rx_buf) (struct e1000_adapter *adapter,
318                               int cleaned_count);
319         struct e1000_ring *rx_ring;
320
321         u32 rx_int_delay;
322         u32 rx_abs_int_delay;
323
324         /* Rx stats */
325         u64 hw_csum_err;
326         u64 hw_csum_good;
327         u64 rx_hdr_split;
328         u32 gorc;
329         u64 gorc_old;
330         u32 alloc_rx_buff_failed;
331         u32 rx_dma_failed;
332
333         unsigned int rx_ps_pages;
334         u16 rx_ps_bsize0;
335         u32 max_frame_size;
336         u32 min_frame_size;
337
338         /* OS defined structs */
339         struct net_device *netdev;
340         struct pci_dev *pdev;
341
342         /* structs defined in e1000_hw.h */
343         struct e1000_hw hw;
344
345         struct e1000_hw_stats stats;
346         struct e1000_phy_info phy_info;
347         struct e1000_phy_stats phy_stats;
348
349         /* Snapshot of PHY registers */
350         struct e1000_phy_regs phy_regs;
351
352         struct e1000_ring test_tx_ring;
353         struct e1000_ring test_rx_ring;
354         u32 test_icr;
355
356         u32 msg_enable;
357         struct msix_entry *msix_entries;
358         int int_mode;
359         u32 eiac_mask;
360
361         u32 eeprom_wol;
362         u32 wol;
363         u32 pba;
364         u32 max_hw_frame_size;
365
366         bool fc_autoneg;
367
368         unsigned long led_status;
369
370         unsigned int flags;
371         unsigned int flags2;
372         struct work_struct downshift_task;
373         struct work_struct update_phy_task;
374         struct work_struct led_blink_task;
375         struct work_struct print_hang_task;
376
377         bool idle_check;
378 };
379
380 struct e1000_info {
381         enum e1000_mac_type     mac;
382         unsigned int            flags;
383         unsigned int            flags2;
384         u32                     pba;
385         u32                     max_hw_frame_size;
386         s32                     (*get_variants)(struct e1000_adapter *);
387         struct e1000_mac_operations *mac_ops;
388         struct e1000_phy_operations *phy_ops;
389         struct e1000_nvm_operations *nvm_ops;
390 };
391
392 /* hardware capability, feature, and workaround flags */
393 #define FLAG_HAS_AMT                      (1 << 0)
394 #define FLAG_HAS_FLASH                    (1 << 1)
395 #define FLAG_HAS_HW_VLAN_FILTER           (1 << 2)
396 #define FLAG_HAS_WOL                      (1 << 3)
397 #define FLAG_HAS_ERT                      (1 << 4)
398 #define FLAG_HAS_CTRLEXT_ON_LOAD          (1 << 5)
399 #define FLAG_HAS_SWSM_ON_LOAD             (1 << 6)
400 #define FLAG_HAS_JUMBO_FRAMES             (1 << 7)
401 #define FLAG_READ_ONLY_NVM                (1 << 8)
402 #define FLAG_IS_ICH                       (1 << 9)
403 #define FLAG_HAS_MSIX                     (1 << 10)
404 #define FLAG_HAS_SMART_POWER_DOWN         (1 << 11)
405 #define FLAG_IS_QUAD_PORT_A               (1 << 12)
406 #define FLAG_IS_QUAD_PORT                 (1 << 13)
407 #define FLAG_TIPG_MEDIUM_FOR_80003ESLAN   (1 << 14)
408 #define FLAG_APME_IN_WUC                  (1 << 15)
409 #define FLAG_APME_IN_CTRL3                (1 << 16)
410 #define FLAG_APME_CHECK_PORT_B            (1 << 17)
411 #define FLAG_DISABLE_FC_PAUSE_TIME        (1 << 18)
412 #define FLAG_NO_WAKE_UCAST                (1 << 19)
413 #define FLAG_MNG_PT_ENABLED               (1 << 20)
414 #define FLAG_RESET_OVERWRITES_LAA         (1 << 21)
415 #define FLAG_TARC_SPEED_MODE_BIT          (1 << 22)
416 #define FLAG_TARC_SET_BIT_ZERO            (1 << 23)
417 #define FLAG_RX_NEEDS_RESTART             (1 << 24)
418 #define FLAG_LSC_GIG_SPEED_DROP           (1 << 25)
419 #define FLAG_SMART_POWER_DOWN             (1 << 26)
420 #define FLAG_MSI_ENABLED                  (1 << 27)
421 #define FLAG_RX_CSUM_ENABLED              (1 << 28)
422 #define FLAG_TSO_FORCE                    (1 << 29)
423 #define FLAG_RX_RESTART_NOW               (1 << 30)
424 #define FLAG_MSI_TEST_FAILED              (1 << 31)
425
426 /* CRC Stripping defines */
427 #define FLAG2_CRC_STRIPPING               (1 << 0)
428 #define FLAG2_HAS_PHY_WAKEUP              (1 << 1)
429 #define FLAG2_IS_DISCARDING               (1 << 2)
430
431 #define E1000_RX_DESC_PS(R, i)      \
432         (&(((union e1000_rx_desc_packet_split *)((R).desc))[i]))
433 #define E1000_GET_DESC(R, i, type)      (&(((struct type *)((R).desc))[i]))
434 #define E1000_RX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_rx_desc)
435 #define E1000_TX_DESC(R, i)             E1000_GET_DESC(R, i, e1000_tx_desc)
436 #define E1000_CONTEXT_DESC(R, i)        E1000_GET_DESC(R, i, e1000_context_desc)
437
438 enum e1000_state_t {
439         __E1000_TESTING,
440         __E1000_RESETTING,
441         __E1000_DOWN
442 };
443
444 enum latency_range {
445         lowest_latency = 0,
446         low_latency = 1,
447         bulk_latency = 2,
448         latency_invalid = 255
449 };
450
451 extern char e1000e_driver_name[];
452 extern const char e1000e_driver_version[];
453
454 extern void e1000e_check_options(struct e1000_adapter *adapter);
455 extern void e1000e_set_ethtool_ops(struct net_device *netdev);
456
457 extern int e1000e_up(struct e1000_adapter *adapter);
458 extern void e1000e_down(struct e1000_adapter *adapter);
459 extern void e1000e_reinit_locked(struct e1000_adapter *adapter);
460 extern void e1000e_reset(struct e1000_adapter *adapter);
461 extern void e1000e_power_up_phy(struct e1000_adapter *adapter);
462 extern int e1000e_setup_rx_resources(struct e1000_adapter *adapter);
463 extern int e1000e_setup_tx_resources(struct e1000_adapter *adapter);
464 extern void e1000e_free_rx_resources(struct e1000_adapter *adapter);
465 extern void e1000e_free_tx_resources(struct e1000_adapter *adapter);
466 extern void e1000e_update_stats(struct e1000_adapter *adapter);
467 extern bool e1000e_has_link(struct e1000_adapter *adapter);
468 extern void e1000e_set_interrupt_capability(struct e1000_adapter *adapter);
469 extern void e1000e_reset_interrupt_capability(struct e1000_adapter *adapter);
470
471 extern unsigned int copybreak;
472
473 extern char *e1000e_get_hw_dev_name(struct e1000_hw *hw);
474
475 extern struct e1000_info e1000_82571_info;
476 extern struct e1000_info e1000_82572_info;
477 extern struct e1000_info e1000_82573_info;
478 extern struct e1000_info e1000_82574_info;
479 extern struct e1000_info e1000_82583_info;
480 extern struct e1000_info e1000_ich8_info;
481 extern struct e1000_info e1000_ich9_info;
482 extern struct e1000_info e1000_ich10_info;
483 extern struct e1000_info e1000_pch_info;
484 extern struct e1000_info e1000_es2_info;
485
486 extern s32 e1000e_read_pba_num(struct e1000_hw *hw, u32 *pba_num);
487
488 extern s32  e1000e_commit_phy(struct e1000_hw *hw);
489
490 extern bool e1000e_enable_mng_pass_thru(struct e1000_hw *hw);
491
492 extern bool e1000e_get_laa_state_82571(struct e1000_hw *hw);
493 extern void e1000e_set_laa_state_82571(struct e1000_hw *hw, bool state);
494
495 extern void e1000e_write_protect_nvm_ich8lan(struct e1000_hw *hw);
496 extern void e1000e_set_kmrn_lock_loss_workaround_ich8lan(struct e1000_hw *hw,
497                                                  bool state);
498 extern void e1000e_igp3_phy_powerdown_workaround_ich8lan(struct e1000_hw *hw);
499 extern void e1000e_gig_downshift_workaround_ich8lan(struct e1000_hw *hw);
500 extern void e1000e_disable_gig_wol_ich8lan(struct e1000_hw *hw);
501 extern s32 e1000_configure_k1_ich8lan(struct e1000_hw *hw, bool k1_enable);
502
503 extern s32 e1000e_check_for_copper_link(struct e1000_hw *hw);
504 extern s32 e1000e_check_for_fiber_link(struct e1000_hw *hw);
505 extern s32 e1000e_check_for_serdes_link(struct e1000_hw *hw);
506 extern s32 e1000e_setup_led_generic(struct e1000_hw *hw);
507 extern s32 e1000e_cleanup_led_generic(struct e1000_hw *hw);
508 extern s32 e1000e_led_on_generic(struct e1000_hw *hw);
509 extern s32 e1000e_led_off_generic(struct e1000_hw *hw);
510 extern s32 e1000e_get_bus_info_pcie(struct e1000_hw *hw);
511 extern void e1000_set_lan_id_multi_port_pcie(struct e1000_hw *hw);
512 extern void e1000_set_lan_id_single_port(struct e1000_hw *hw);
513 extern s32 e1000e_get_speed_and_duplex_copper(struct e1000_hw *hw, u16 *speed, u16 *duplex);
514 extern s32 e1000e_get_speed_and_duplex_fiber_serdes(struct e1000_hw *hw, u16 *speed, u16 *duplex);
515 extern s32 e1000e_disable_pcie_master(struct e1000_hw *hw);
516 extern s32 e1000e_get_auto_rd_done(struct e1000_hw *hw);
517 extern s32 e1000e_id_led_init(struct e1000_hw *hw);
518 extern void e1000e_clear_hw_cntrs_base(struct e1000_hw *hw);
519 extern s32 e1000e_setup_fiber_serdes_link(struct e1000_hw *hw);
520 extern s32 e1000e_copper_link_setup_m88(struct e1000_hw *hw);
521 extern s32 e1000e_copper_link_setup_igp(struct e1000_hw *hw);
522 extern s32 e1000e_setup_link(struct e1000_hw *hw);
523 extern void e1000_clear_vfta_generic(struct e1000_hw *hw);
524 extern void e1000e_init_rx_addrs(struct e1000_hw *hw, u16 rar_count);
525 extern void e1000e_update_mc_addr_list_generic(struct e1000_hw *hw,
526                                                u8 *mc_addr_list,
527                                                u32 mc_addr_count);
528 extern void e1000e_rar_set(struct e1000_hw *hw, u8 *addr, u32 index);
529 extern s32 e1000e_set_fc_watermarks(struct e1000_hw *hw);
530 extern void e1000e_set_pcie_no_snoop(struct e1000_hw *hw, u32 no_snoop);
531 extern s32 e1000e_get_hw_semaphore(struct e1000_hw *hw);
532 extern s32 e1000e_valid_led_default(struct e1000_hw *hw, u16 *data);
533 extern void e1000e_config_collision_dist(struct e1000_hw *hw);
534 extern s32 e1000e_config_fc_after_link_up(struct e1000_hw *hw);
535 extern s32 e1000e_force_mac_fc(struct e1000_hw *hw);
536 extern s32 e1000e_blink_led(struct e1000_hw *hw);
537 extern void e1000_write_vfta_generic(struct e1000_hw *hw, u32 offset, u32 value);
538 extern s32 e1000_check_alt_mac_addr_generic(struct e1000_hw *hw);
539 extern void e1000e_reset_adaptive(struct e1000_hw *hw);
540 extern void e1000e_update_adaptive(struct e1000_hw *hw);
541
542 extern s32 e1000e_setup_copper_link(struct e1000_hw *hw);
543 extern s32 e1000e_get_phy_id(struct e1000_hw *hw);
544 extern void e1000e_put_hw_semaphore(struct e1000_hw *hw);
545 extern s32 e1000e_check_reset_block_generic(struct e1000_hw *hw);
546 extern s32 e1000e_phy_force_speed_duplex_igp(struct e1000_hw *hw);
547 extern s32 e1000e_get_cable_length_igp_2(struct e1000_hw *hw);
548 extern s32 e1000e_get_phy_info_igp(struct e1000_hw *hw);
549 extern s32 e1000e_read_phy_reg_igp(struct e1000_hw *hw, u32 offset, u16 *data);
550 extern s32 e1000e_read_phy_reg_igp_locked(struct e1000_hw *hw, u32 offset,
551                                           u16 *data);
552 extern s32 e1000e_phy_hw_reset_generic(struct e1000_hw *hw);
553 extern s32 e1000e_set_d3_lplu_state(struct e1000_hw *hw, bool active);
554 extern s32 e1000e_write_phy_reg_igp(struct e1000_hw *hw, u32 offset, u16 data);
555 extern s32 e1000e_write_phy_reg_igp_locked(struct e1000_hw *hw, u32 offset,
556                                            u16 data);
557 extern s32 e1000e_phy_sw_reset(struct e1000_hw *hw);
558 extern s32 e1000e_phy_force_speed_duplex_m88(struct e1000_hw *hw);
559 extern s32 e1000e_get_cfg_done(struct e1000_hw *hw);
560 extern s32 e1000e_get_cable_length_m88(struct e1000_hw *hw);
561 extern s32 e1000e_get_phy_info_m88(struct e1000_hw *hw);
562 extern s32 e1000e_read_phy_reg_m88(struct e1000_hw *hw, u32 offset, u16 *data);
563 extern s32 e1000e_write_phy_reg_m88(struct e1000_hw *hw, u32 offset, u16 data);
564 extern s32 e1000e_phy_init_script_igp3(struct e1000_hw *hw);
565 extern enum e1000_phy_type e1000e_get_phy_type_from_id(u32 phy_id);
566 extern s32 e1000e_determine_phy_address(struct e1000_hw *hw);
567 extern s32 e1000e_write_phy_reg_bm(struct e1000_hw *hw, u32 offset, u16 data);
568 extern s32 e1000e_read_phy_reg_bm(struct e1000_hw *hw, u32 offset, u16 *data);
569 extern s32 e1000e_read_phy_reg_bm2(struct e1000_hw *hw, u32 offset, u16 *data);
570 extern s32 e1000e_write_phy_reg_bm2(struct e1000_hw *hw, u32 offset, u16 data);
571 extern void e1000e_phy_force_speed_duplex_setup(struct e1000_hw *hw, u16 *phy_ctrl);
572 extern s32 e1000e_write_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 data);
573 extern s32 e1000e_write_kmrn_reg_locked(struct e1000_hw *hw, u32 offset,
574                                         u16 data);
575 extern s32 e1000e_read_kmrn_reg(struct e1000_hw *hw, u32 offset, u16 *data);
576 extern s32 e1000e_read_kmrn_reg_locked(struct e1000_hw *hw, u32 offset,
577                                        u16 *data);
578 extern s32 e1000e_phy_has_link_generic(struct e1000_hw *hw, u32 iterations,
579                                u32 usec_interval, bool *success);
580 extern s32 e1000e_phy_reset_dsp(struct e1000_hw *hw);
581 extern void e1000_power_up_phy_copper(struct e1000_hw *hw);
582 extern void e1000_power_down_phy_copper(struct e1000_hw *hw);
583 extern s32 e1000e_read_phy_reg_mdic(struct e1000_hw *hw, u32 offset, u16 *data);
584 extern s32 e1000e_write_phy_reg_mdic(struct e1000_hw *hw, u32 offset, u16 data);
585 extern s32 e1000e_check_downshift(struct e1000_hw *hw);
586 extern s32 e1000_read_phy_reg_hv(struct e1000_hw *hw, u32 offset, u16 *data);
587 extern s32 e1000_read_phy_reg_hv_locked(struct e1000_hw *hw, u32 offset,
588                                         u16 *data);
589 extern s32 e1000_write_phy_reg_hv(struct e1000_hw *hw, u32 offset, u16 data);
590 extern s32 e1000_write_phy_reg_hv_locked(struct e1000_hw *hw, u32 offset,
591                                          u16 data);
592 extern s32 e1000_link_stall_workaround_hv(struct e1000_hw *hw);
593 extern s32 e1000_copper_link_setup_82577(struct e1000_hw *hw);
594 extern s32 e1000_check_polarity_82577(struct e1000_hw *hw);
595 extern s32 e1000_get_phy_info_82577(struct e1000_hw *hw);
596 extern s32 e1000_phy_force_speed_duplex_82577(struct e1000_hw *hw);
597 extern s32 e1000_get_cable_length_82577(struct e1000_hw *hw);
598
599 extern s32 e1000_check_polarity_m88(struct e1000_hw *hw);
600 extern s32 e1000_get_phy_info_ife(struct e1000_hw *hw);
601 extern s32 e1000_check_polarity_ife(struct e1000_hw *hw);
602 extern s32 e1000_phy_force_speed_duplex_ife(struct e1000_hw *hw);
603 extern s32 e1000_check_polarity_igp(struct e1000_hw *hw);
604
605 static inline s32 e1000_phy_hw_reset(struct e1000_hw *hw)
606 {
607         return hw->phy.ops.reset(hw);
608 }
609
610 static inline s32 e1000_check_reset_block(struct e1000_hw *hw)
611 {
612         return hw->phy.ops.check_reset_block(hw);
613 }
614
615 static inline s32 e1e_rphy(struct e1000_hw *hw, u32 offset, u16 *data)
616 {
617         return hw->phy.ops.read_reg(hw, offset, data);
618 }
619
620 static inline s32 e1e_wphy(struct e1000_hw *hw, u32 offset, u16 data)
621 {
622         return hw->phy.ops.write_reg(hw, offset, data);
623 }
624
625 static inline s32 e1000_get_cable_length(struct e1000_hw *hw)
626 {
627         return hw->phy.ops.get_cable_length(hw);
628 }
629
630 extern s32 e1000e_acquire_nvm(struct e1000_hw *hw);
631 extern s32 e1000e_write_nvm_spi(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
632 extern s32 e1000e_update_nvm_checksum_generic(struct e1000_hw *hw);
633 extern s32 e1000e_poll_eerd_eewr_done(struct e1000_hw *hw, int ee_reg);
634 extern s32 e1000e_read_nvm_eerd(struct e1000_hw *hw, u16 offset, u16 words, u16 *data);
635 extern s32 e1000e_validate_nvm_checksum_generic(struct e1000_hw *hw);
636 extern void e1000e_release_nvm(struct e1000_hw *hw);
637 extern void e1000e_reload_nvm(struct e1000_hw *hw);
638 extern s32 e1000_read_mac_addr_generic(struct e1000_hw *hw);
639
640 static inline s32 e1000e_read_mac_addr(struct e1000_hw *hw)
641 {
642         if (hw->mac.ops.read_mac_addr)
643                 return hw->mac.ops.read_mac_addr(hw);
644
645         return e1000_read_mac_addr_generic(hw);
646 }
647
648 static inline s32 e1000_validate_nvm_checksum(struct e1000_hw *hw)
649 {
650         return hw->nvm.ops.validate(hw);
651 }
652
653 static inline s32 e1000e_update_nvm_checksum(struct e1000_hw *hw)
654 {
655         return hw->nvm.ops.update(hw);
656 }
657
658 static inline s32 e1000_read_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
659 {
660         return hw->nvm.ops.read(hw, offset, words, data);
661 }
662
663 static inline s32 e1000_write_nvm(struct e1000_hw *hw, u16 offset, u16 words, u16 *data)
664 {
665         return hw->nvm.ops.write(hw, offset, words, data);
666 }
667
668 static inline s32 e1000_get_phy_info(struct e1000_hw *hw)
669 {
670         return hw->phy.ops.get_info(hw);
671 }
672
673 static inline s32 e1000e_check_mng_mode(struct e1000_hw *hw)
674 {
675         return hw->mac.ops.check_mng_mode(hw);
676 }
677
678 extern bool e1000e_check_mng_mode_generic(struct e1000_hw *hw);
679 extern bool e1000e_enable_tx_pkt_filtering(struct e1000_hw *hw);
680 extern s32 e1000e_mng_write_dhcp_info(struct e1000_hw *hw, u8 *buffer, u16 length);
681
682 static inline u32 __er32(struct e1000_hw *hw, unsigned long reg)
683 {
684         return readl(hw->hw_addr + reg);
685 }
686
687 static inline void __ew32(struct e1000_hw *hw, unsigned long reg, u32 val)
688 {
689         writel(val, hw->hw_addr + reg);
690 }
691
692 #endif /* _E1000_H_ */