Merge branch 'docs-next' of git://git.lwn.net/linux-2.6
[pandora-kernel.git] / drivers / net / e1000e / hw.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 #ifndef _E1000_HW_H_
30 #define _E1000_HW_H_
31
32 #include <linux/types.h>
33
34 struct e1000_hw;
35 struct e1000_adapter;
36
37 #include "defines.h"
38
39 #define er32(reg)       __er32(hw, E1000_##reg)
40 #define ew32(reg,val)   __ew32(hw, E1000_##reg, (val))
41 #define e1e_flush()     er32(STATUS)
42
43 #define E1000_WRITE_REG_ARRAY(a, reg, offset, value) \
44         (writel((value), ((a)->hw_addr + reg + ((offset) << 2))))
45
46 #define E1000_READ_REG_ARRAY(a, reg, offset) \
47         (readl((a)->hw_addr + reg + ((offset) << 2)))
48
49 enum e1e_registers {
50         E1000_CTRL     = 0x00000, /* Device Control - RW */
51         E1000_STATUS   = 0x00008, /* Device Status - RO */
52         E1000_EECD     = 0x00010, /* EEPROM/Flash Control - RW */
53         E1000_EERD     = 0x00014, /* EEPROM Read - RW */
54         E1000_CTRL_EXT = 0x00018, /* Extended Device Control - RW */
55         E1000_FLA      = 0x0001C, /* Flash Access - RW */
56         E1000_MDIC     = 0x00020, /* MDI Control - RW */
57         E1000_SCTL     = 0x00024, /* SerDes Control - RW */
58         E1000_FCAL     = 0x00028, /* Flow Control Address Low - RW */
59         E1000_FCAH     = 0x0002C, /* Flow Control Address High -RW */
60         E1000_FEXTNVM  = 0x00028, /* Future Extended NVM - RW */
61         E1000_FCT      = 0x00030, /* Flow Control Type - RW */
62         E1000_VET      = 0x00038, /* VLAN Ether Type - RW */
63         E1000_ICR      = 0x000C0, /* Interrupt Cause Read - R/clr */
64         E1000_ITR      = 0x000C4, /* Interrupt Throttling Rate - RW */
65         E1000_ICS      = 0x000C8, /* Interrupt Cause Set - WO */
66         E1000_IMS      = 0x000D0, /* Interrupt Mask Set - RW */
67         E1000_IMC      = 0x000D8, /* Interrupt Mask Clear - WO */
68         E1000_EIAC_82574 = 0x000DC, /* Ext. Interrupt Auto Clear - RW */
69         E1000_IAM      = 0x000E0, /* Interrupt Acknowledge Auto Mask */
70         E1000_IVAR     = 0x000E4, /* Interrupt Vector Allocation - RW */
71         E1000_EITR_82574_BASE = 0x000E8, /* Interrupt Throttling - RW */
72 #define E1000_EITR_82574(_n) (E1000_EITR_82574_BASE + (_n << 2))
73         E1000_RCTL     = 0x00100, /* Rx Control - RW */
74         E1000_FCTTV    = 0x00170, /* Flow Control Transmit Timer Value - RW */
75         E1000_TXCW     = 0x00178, /* Tx Configuration Word - RW */
76         E1000_RXCW     = 0x00180, /* Rx Configuration Word - RO */
77         E1000_TCTL     = 0x00400, /* Tx Control - RW */
78         E1000_TCTL_EXT = 0x00404, /* Extended Tx Control - RW */
79         E1000_TIPG     = 0x00410, /* Tx Inter-packet gap -RW */
80         E1000_AIT      = 0x00458, /* Adaptive Interframe Spacing Throttle -RW */
81         E1000_LEDCTL   = 0x00E00, /* LED Control - RW */
82         E1000_EXTCNF_CTRL  = 0x00F00, /* Extended Configuration Control */
83         E1000_EXTCNF_SIZE  = 0x00F08, /* Extended Configuration Size */
84         E1000_PHY_CTRL     = 0x00F10, /* PHY Control Register in CSR */
85         E1000_PBA      = 0x01000, /* Packet Buffer Allocation - RW */
86         E1000_PBS      = 0x01008, /* Packet Buffer Size */
87         E1000_EEMNGCTL = 0x01010, /* MNG EEprom Control */
88         E1000_EEWR     = 0x0102C, /* EEPROM Write Register - RW */
89         E1000_FLOP     = 0x0103C, /* FLASH Opcode Register */
90         E1000_PBA_ECC  = 0x01100, /* PBA ECC Register */
91         E1000_ERT      = 0x02008, /* Early Rx Threshold - RW */
92         E1000_FCRTL    = 0x02160, /* Flow Control Receive Threshold Low - RW */
93         E1000_FCRTH    = 0x02168, /* Flow Control Receive Threshold High - RW */
94         E1000_PSRCTL   = 0x02170, /* Packet Split Receive Control - RW */
95         E1000_RDBAL    = 0x02800, /* Rx Descriptor Base Address Low - RW */
96         E1000_RDBAH    = 0x02804, /* Rx Descriptor Base Address High - RW */
97         E1000_RDLEN    = 0x02808, /* Rx Descriptor Length - RW */
98         E1000_RDH      = 0x02810, /* Rx Descriptor Head - RW */
99         E1000_RDT      = 0x02818, /* Rx Descriptor Tail - RW */
100         E1000_RDTR     = 0x02820, /* Rx Delay Timer - RW */
101         E1000_RXDCTL_BASE = 0x02828, /* Rx Descriptor Control - RW */
102 #define E1000_RXDCTL(_n)   (E1000_RXDCTL_BASE + (_n << 8))
103         E1000_RADV     = 0x0282C, /* RX Interrupt Absolute Delay Timer - RW */
104
105 /* Convenience macros
106  *
107  * Note: "_n" is the queue number of the register to be written to.
108  *
109  * Example usage:
110  * E1000_RDBAL_REG(current_rx_queue)
111  *
112  */
113 #define E1000_RDBAL_REG(_n)   (E1000_RDBAL + (_n << 8))
114         E1000_KABGTXD  = 0x03004, /* AFE Band Gap Transmit Ref Data */
115         E1000_TDBAL    = 0x03800, /* Tx Descriptor Base Address Low - RW */
116         E1000_TDBAH    = 0x03804, /* Tx Descriptor Base Address High - RW */
117         E1000_TDLEN    = 0x03808, /* Tx Descriptor Length - RW */
118         E1000_TDH      = 0x03810, /* Tx Descriptor Head - RW */
119         E1000_TDT      = 0x03818, /* Tx Descriptor Tail - RW */
120         E1000_TIDV     = 0x03820, /* Tx Interrupt Delay Value - RW */
121         E1000_TXDCTL_BASE = 0x03828, /* Tx Descriptor Control - RW */
122 #define E1000_TXDCTL(_n)   (E1000_TXDCTL_BASE + (_n << 8))
123         E1000_TADV     = 0x0382C, /* Tx Interrupt Absolute Delay Val - RW */
124         E1000_TARC_BASE = 0x03840, /* Tx Arbitration Count (0) */
125 #define E1000_TARC(_n)   (E1000_TARC_BASE + (_n << 8))
126         E1000_CRCERRS  = 0x04000, /* CRC Error Count - R/clr */
127         E1000_ALGNERRC = 0x04004, /* Alignment Error Count - R/clr */
128         E1000_SYMERRS  = 0x04008, /* Symbol Error Count - R/clr */
129         E1000_RXERRC   = 0x0400C, /* Receive Error Count - R/clr */
130         E1000_MPC      = 0x04010, /* Missed Packet Count - R/clr */
131         E1000_SCC      = 0x04014, /* Single Collision Count - R/clr */
132         E1000_ECOL     = 0x04018, /* Excessive Collision Count - R/clr */
133         E1000_MCC      = 0x0401C, /* Multiple Collision Count - R/clr */
134         E1000_LATECOL  = 0x04020, /* Late Collision Count - R/clr */
135         E1000_COLC     = 0x04028, /* Collision Count - R/clr */
136         E1000_DC       = 0x04030, /* Defer Count - R/clr */
137         E1000_TNCRS    = 0x04034, /* Tx-No CRS - R/clr */
138         E1000_SEC      = 0x04038, /* Sequence Error Count - R/clr */
139         E1000_CEXTERR  = 0x0403C, /* Carrier Extension Error Count - R/clr */
140         E1000_RLEC     = 0x04040, /* Receive Length Error Count - R/clr */
141         E1000_XONRXC   = 0x04048, /* XON Rx Count - R/clr */
142         E1000_XONTXC   = 0x0404C, /* XON Tx Count - R/clr */
143         E1000_XOFFRXC  = 0x04050, /* XOFF Rx Count - R/clr */
144         E1000_XOFFTXC  = 0x04054, /* XOFF Tx Count - R/clr */
145         E1000_FCRUC    = 0x04058, /* Flow Control Rx Unsupported Count- R/clr */
146         E1000_PRC64    = 0x0405C, /* Packets Rx (64 bytes) - R/clr */
147         E1000_PRC127   = 0x04060, /* Packets Rx (65-127 bytes) - R/clr */
148         E1000_PRC255   = 0x04064, /* Packets Rx (128-255 bytes) - R/clr */
149         E1000_PRC511   = 0x04068, /* Packets Rx (255-511 bytes) - R/clr */
150         E1000_PRC1023  = 0x0406C, /* Packets Rx (512-1023 bytes) - R/clr */
151         E1000_PRC1522  = 0x04070, /* Packets Rx (1024-1522 bytes) - R/clr */
152         E1000_GPRC     = 0x04074, /* Good Packets Rx Count - R/clr */
153         E1000_BPRC     = 0x04078, /* Broadcast Packets Rx Count - R/clr */
154         E1000_MPRC     = 0x0407C, /* Multicast Packets Rx Count - R/clr */
155         E1000_GPTC     = 0x04080, /* Good Packets Tx Count - R/clr */
156         E1000_GORCL    = 0x04088, /* Good Octets Rx Count Low - R/clr */
157         E1000_GORCH    = 0x0408C, /* Good Octets Rx Count High - R/clr */
158         E1000_GOTCL    = 0x04090, /* Good Octets Tx Count Low - R/clr */
159         E1000_GOTCH    = 0x04094, /* Good Octets Tx Count High - R/clr */
160         E1000_RNBC     = 0x040A0, /* Rx No Buffers Count - R/clr */
161         E1000_RUC      = 0x040A4, /* Rx Undersize Count - R/clr */
162         E1000_RFC      = 0x040A8, /* Rx Fragment Count - R/clr */
163         E1000_ROC      = 0x040AC, /* Rx Oversize Count - R/clr */
164         E1000_RJC      = 0x040B0, /* Rx Jabber Count - R/clr */
165         E1000_MGTPRC   = 0x040B4, /* Management Packets Rx Count - R/clr */
166         E1000_MGTPDC   = 0x040B8, /* Management Packets Dropped Count - R/clr */
167         E1000_MGTPTC   = 0x040BC, /* Management Packets Tx Count - R/clr */
168         E1000_TORL     = 0x040C0, /* Total Octets Rx Low - R/clr */
169         E1000_TORH     = 0x040C4, /* Total Octets Rx High - R/clr */
170         E1000_TOTL     = 0x040C8, /* Total Octets Tx Low - R/clr */
171         E1000_TOTH     = 0x040CC, /* Total Octets Tx High - R/clr */
172         E1000_TPR      = 0x040D0, /* Total Packets Rx - R/clr */
173         E1000_TPT      = 0x040D4, /* Total Packets Tx - R/clr */
174         E1000_PTC64    = 0x040D8, /* Packets Tx (64 bytes) - R/clr */
175         E1000_PTC127   = 0x040DC, /* Packets Tx (65-127 bytes) - R/clr */
176         E1000_PTC255   = 0x040E0, /* Packets Tx (128-255 bytes) - R/clr */
177         E1000_PTC511   = 0x040E4, /* Packets Tx (256-511 bytes) - R/clr */
178         E1000_PTC1023  = 0x040E8, /* Packets Tx (512-1023 bytes) - R/clr */
179         E1000_PTC1522  = 0x040EC, /* Packets Tx (1024-1522 Bytes) - R/clr */
180         E1000_MPTC     = 0x040F0, /* Multicast Packets Tx Count - R/clr */
181         E1000_BPTC     = 0x040F4, /* Broadcast Packets Tx Count - R/clr */
182         E1000_TSCTC    = 0x040F8, /* TCP Segmentation Context Tx - R/clr */
183         E1000_TSCTFC   = 0x040FC, /* TCP Segmentation Context Tx Fail - R/clr */
184         E1000_IAC      = 0x04100, /* Interrupt Assertion Count */
185         E1000_ICRXPTC  = 0x04104, /* Irq Cause Rx Packet Timer Expire Count */
186         E1000_ICRXATC  = 0x04108, /* Irq Cause Rx Abs Timer Expire Count */
187         E1000_ICTXPTC  = 0x0410C, /* Irq Cause Tx Packet Timer Expire Count */
188         E1000_ICTXATC  = 0x04110, /* Irq Cause Tx Abs Timer Expire Count */
189         E1000_ICTXQEC  = 0x04118, /* Irq Cause Tx Queue Empty Count */
190         E1000_ICTXQMTC = 0x0411C, /* Irq Cause Tx Queue MinThreshold Count */
191         E1000_ICRXDMTC = 0x04120, /* Irq Cause Rx Desc MinThreshold Count */
192         E1000_ICRXOC   = 0x04124, /* Irq Cause Receiver Overrun Count */
193         E1000_RXCSUM   = 0x05000, /* Rx Checksum Control - RW */
194         E1000_RFCTL    = 0x05008, /* Receive Filter Control */
195         E1000_MTA      = 0x05200, /* Multicast Table Array - RW Array */
196         E1000_RA       = 0x05400, /* Receive Address - RW Array */
197         E1000_VFTA     = 0x05600, /* VLAN Filter Table Array - RW Array */
198         E1000_WUC      = 0x05800, /* Wakeup Control - RW */
199         E1000_WUFC     = 0x05808, /* Wakeup Filter Control - RW */
200         E1000_WUS      = 0x05810, /* Wakeup Status - RO */
201         E1000_MANC     = 0x05820, /* Management Control - RW */
202         E1000_FFLT     = 0x05F00, /* Flexible Filter Length Table - RW Array */
203         E1000_HOST_IF  = 0x08800, /* Host Interface */
204
205         E1000_KMRNCTRLSTA = 0x00034, /* MAC-PHY interface - RW */
206         E1000_MANC2H    = 0x05860, /* Management Control To Host - RW */
207         E1000_SW_FW_SYNC = 0x05B5C, /* Software-Firmware Synchronization - RW */
208         E1000_GCR       = 0x05B00, /* PCI-Ex Control */
209         E1000_FACTPS    = 0x05B30, /* Function Active and Power State to MNG */
210         E1000_SWSM      = 0x05B50, /* SW Semaphore */
211         E1000_FWSM      = 0x05B54, /* FW Semaphore */
212         E1000_HICR      = 0x08F00, /* Host Interface Control */
213 };
214
215 /* RSS registers */
216
217 /* IGP01E1000 Specific Registers */
218 #define IGP01E1000_PHY_PORT_CONFIG      0x10 /* Port Config */
219 #define IGP01E1000_PHY_PORT_STATUS      0x11 /* Status */
220 #define IGP01E1000_PHY_PORT_CTRL        0x12 /* Control */
221 #define IGP01E1000_PHY_LINK_HEALTH      0x13 /* PHY Link Health */
222 #define IGP02E1000_PHY_POWER_MGMT       0x19 /* Power Management */
223 #define IGP01E1000_PHY_PAGE_SELECT      0x1F /* Page Select */
224 #define BM_PHY_PAGE_SELECT              22   /* Page Select for BM */
225 #define IGP_PAGE_SHIFT                  5
226 #define PHY_REG_MASK                    0x1F
227
228 #define BM_WUC_PAGE                     800
229 #define BM_WUC_ADDRESS_OPCODE           0x11
230 #define BM_WUC_DATA_OPCODE              0x12
231 #define BM_WUC_ENABLE_PAGE              769
232 #define BM_WUC_ENABLE_REG               17
233 #define BM_WUC_ENABLE_BIT               (1 << 2)
234 #define BM_WUC_HOST_WU_BIT              (1 << 4)
235
236 #define BM_WUC  PHY_REG(BM_WUC_PAGE, 1)
237 #define BM_WUFC PHY_REG(BM_WUC_PAGE, 2)
238 #define BM_WUS  PHY_REG(BM_WUC_PAGE, 3)
239
240 #define IGP01E1000_PHY_PCS_INIT_REG     0x00B4
241 #define IGP01E1000_PHY_POLARITY_MASK    0x0078
242
243 #define IGP01E1000_PSCR_AUTO_MDIX       0x1000
244 #define IGP01E1000_PSCR_FORCE_MDI_MDIX  0x2000 /* 0=MDI, 1=MDIX */
245
246 #define IGP01E1000_PSCFR_SMART_SPEED    0x0080
247
248 #define IGP02E1000_PM_SPD               0x0001 /* Smart Power Down */
249 #define IGP02E1000_PM_D0_LPLU           0x0002 /* For D0a states */
250 #define IGP02E1000_PM_D3_LPLU           0x0004 /* For all other states */
251
252 #define IGP01E1000_PLHR_SS_DOWNGRADE    0x8000
253
254 #define IGP01E1000_PSSR_POLARITY_REVERSED       0x0002
255 #define IGP01E1000_PSSR_MDIX                    0x0008
256 #define IGP01E1000_PSSR_SPEED_MASK              0xC000
257 #define IGP01E1000_PSSR_SPEED_1000MBPS          0xC000
258
259 #define IGP02E1000_PHY_CHANNEL_NUM              4
260 #define IGP02E1000_PHY_AGC_A                    0x11B1
261 #define IGP02E1000_PHY_AGC_B                    0x12B1
262 #define IGP02E1000_PHY_AGC_C                    0x14B1
263 #define IGP02E1000_PHY_AGC_D                    0x18B1
264
265 #define IGP02E1000_AGC_LENGTH_SHIFT     9 /* Course - 15:13, Fine - 12:9 */
266 #define IGP02E1000_AGC_LENGTH_MASK      0x7F
267 #define IGP02E1000_AGC_RANGE            15
268
269 /* manage.c */
270 #define E1000_VFTA_ENTRY_SHIFT          5
271 #define E1000_VFTA_ENTRY_MASK           0x7F
272 #define E1000_VFTA_ENTRY_BIT_SHIFT_MASK 0x1F
273
274 #define E1000_HICR_EN                   0x01  /* Enable bit - RO */
275 /* Driver sets this bit when done to put command in RAM */
276 #define E1000_HICR_C                    0x02
277 #define E1000_HICR_FW_RESET_ENABLE      0x40
278 #define E1000_HICR_FW_RESET             0x80
279
280 #define E1000_FWSM_MODE_MASK            0xE
281 #define E1000_FWSM_MODE_SHIFT           1
282
283 #define E1000_MNG_IAMT_MODE             0x3
284 #define E1000_MNG_DHCP_COOKIE_LENGTH    0x10
285 #define E1000_MNG_DHCP_COOKIE_OFFSET    0x6F0
286 #define E1000_MNG_DHCP_COMMAND_TIMEOUT  10
287 #define E1000_MNG_DHCP_TX_PAYLOAD_CMD   64
288 #define E1000_MNG_DHCP_COOKIE_STATUS_PARSING    0x1
289 #define E1000_MNG_DHCP_COOKIE_STATUS_VLAN       0x2
290
291 /* nvm.c */
292 #define E1000_STM_OPCODE  0xDB00
293
294 #define E1000_KMRNCTRLSTA_OFFSET        0x001F0000
295 #define E1000_KMRNCTRLSTA_OFFSET_SHIFT  16
296 #define E1000_KMRNCTRLSTA_REN           0x00200000
297 #define E1000_KMRNCTRLSTA_DIAG_OFFSET   0x3    /* Kumeran Diagnostic */
298 #define E1000_KMRNCTRLSTA_DIAG_NELPBK   0x1000 /* Nearend Loopback mode */
299
300 #define IFE_PHY_EXTENDED_STATUS_CONTROL 0x10
301 #define IFE_PHY_SPECIAL_CONTROL         0x11 /* 100BaseTx PHY Special Control */
302 #define IFE_PHY_SPECIAL_CONTROL_LED     0x1B /* PHY Special and LED Control */
303 #define IFE_PHY_MDIX_CONTROL            0x1C /* MDI/MDI-X Control */
304
305 /* IFE PHY Extended Status Control */
306 #define IFE_PESC_POLARITY_REVERSED      0x0100
307
308 /* IFE PHY Special Control */
309 #define IFE_PSC_AUTO_POLARITY_DISABLE           0x0010
310 #define IFE_PSC_FORCE_POLARITY                  0x0020
311
312 /* IFE PHY Special Control and LED Control */
313 #define IFE_PSCL_PROBE_MODE             0x0020
314 #define IFE_PSCL_PROBE_LEDS_OFF         0x0006 /* Force LEDs 0 and 2 off */
315 #define IFE_PSCL_PROBE_LEDS_ON          0x0007 /* Force LEDs 0 and 2 on */
316
317 /* IFE PHY MDIX Control */
318 #define IFE_PMC_MDIX_STATUS     0x0020 /* 1=MDI-X, 0=MDI */
319 #define IFE_PMC_FORCE_MDIX      0x0040 /* 1=force MDI-X, 0=force MDI */
320 #define IFE_PMC_AUTO_MDIX       0x0080 /* 1=enable auto MDI/MDI-X, 0=disable */
321
322 #define E1000_CABLE_LENGTH_UNDEFINED    0xFF
323
324 #define E1000_DEV_ID_82571EB_COPPER             0x105E
325 #define E1000_DEV_ID_82571EB_FIBER              0x105F
326 #define E1000_DEV_ID_82571EB_SERDES             0x1060
327 #define E1000_DEV_ID_82571EB_QUAD_COPPER        0x10A4
328 #define E1000_DEV_ID_82571PT_QUAD_COPPER        0x10D5
329 #define E1000_DEV_ID_82571EB_QUAD_FIBER         0x10A5
330 #define E1000_DEV_ID_82571EB_QUAD_COPPER_LP     0x10BC
331 #define E1000_DEV_ID_82571EB_SERDES_DUAL        0x10D9
332 #define E1000_DEV_ID_82571EB_SERDES_QUAD        0x10DA
333 #define E1000_DEV_ID_82572EI_COPPER             0x107D
334 #define E1000_DEV_ID_82572EI_FIBER              0x107E
335 #define E1000_DEV_ID_82572EI_SERDES             0x107F
336 #define E1000_DEV_ID_82572EI                    0x10B9
337 #define E1000_DEV_ID_82573E                     0x108B
338 #define E1000_DEV_ID_82573E_IAMT                0x108C
339 #define E1000_DEV_ID_82573L                     0x109A
340 #define E1000_DEV_ID_82574L                     0x10D3
341
342 #define E1000_DEV_ID_80003ES2LAN_COPPER_DPT     0x1096
343 #define E1000_DEV_ID_80003ES2LAN_SERDES_DPT     0x1098
344 #define E1000_DEV_ID_80003ES2LAN_COPPER_SPT     0x10BA
345 #define E1000_DEV_ID_80003ES2LAN_SERDES_SPT     0x10BB
346
347 #define E1000_DEV_ID_ICH8_IGP_M_AMT             0x1049
348 #define E1000_DEV_ID_ICH8_IGP_AMT               0x104A
349 #define E1000_DEV_ID_ICH8_IGP_C                 0x104B
350 #define E1000_DEV_ID_ICH8_IFE                   0x104C
351 #define E1000_DEV_ID_ICH8_IFE_GT                0x10C4
352 #define E1000_DEV_ID_ICH8_IFE_G                 0x10C5
353 #define E1000_DEV_ID_ICH8_IGP_M                 0x104D
354 #define E1000_DEV_ID_ICH9_IGP_AMT               0x10BD
355 #define E1000_DEV_ID_ICH9_BM                    0x10E5
356 #define E1000_DEV_ID_ICH9_IGP_M_AMT             0x10F5
357 #define E1000_DEV_ID_ICH9_IGP_M                 0x10BF
358 #define E1000_DEV_ID_ICH9_IGP_M_V               0x10CB
359 #define E1000_DEV_ID_ICH9_IGP_C                 0x294C
360 #define E1000_DEV_ID_ICH9_IFE                   0x10C0
361 #define E1000_DEV_ID_ICH9_IFE_GT                0x10C3
362 #define E1000_DEV_ID_ICH9_IFE_G                 0x10C2
363 #define E1000_DEV_ID_ICH10_R_BM_LM              0x10CC
364 #define E1000_DEV_ID_ICH10_R_BM_LF              0x10CD
365 #define E1000_DEV_ID_ICH10_R_BM_V               0x10CE
366 #define E1000_DEV_ID_ICH10_D_BM_LM              0x10DE
367 #define E1000_DEV_ID_ICH10_D_BM_LF              0x10DF
368
369 #define E1000_REVISION_4 4
370
371 #define E1000_FUNC_1 1
372
373 enum e1000_mac_type {
374         e1000_82571,
375         e1000_82572,
376         e1000_82573,
377         e1000_82574,
378         e1000_80003es2lan,
379         e1000_ich8lan,
380         e1000_ich9lan,
381         e1000_ich10lan,
382 };
383
384 enum e1000_media_type {
385         e1000_media_type_unknown = 0,
386         e1000_media_type_copper = 1,
387         e1000_media_type_fiber = 2,
388         e1000_media_type_internal_serdes = 3,
389         e1000_num_media_types
390 };
391
392 enum e1000_nvm_type {
393         e1000_nvm_unknown = 0,
394         e1000_nvm_none,
395         e1000_nvm_eeprom_spi,
396         e1000_nvm_flash_hw,
397         e1000_nvm_flash_sw
398 };
399
400 enum e1000_nvm_override {
401         e1000_nvm_override_none = 0,
402         e1000_nvm_override_spi_small,
403         e1000_nvm_override_spi_large
404 };
405
406 enum e1000_phy_type {
407         e1000_phy_unknown = 0,
408         e1000_phy_none,
409         e1000_phy_m88,
410         e1000_phy_igp,
411         e1000_phy_igp_2,
412         e1000_phy_gg82563,
413         e1000_phy_igp_3,
414         e1000_phy_ife,
415         e1000_phy_bm,
416 };
417
418 enum e1000_bus_width {
419         e1000_bus_width_unknown = 0,
420         e1000_bus_width_pcie_x1,
421         e1000_bus_width_pcie_x2,
422         e1000_bus_width_pcie_x4 = 4,
423         e1000_bus_width_32,
424         e1000_bus_width_64,
425         e1000_bus_width_reserved
426 };
427
428 enum e1000_1000t_rx_status {
429         e1000_1000t_rx_status_not_ok = 0,
430         e1000_1000t_rx_status_ok,
431         e1000_1000t_rx_status_undefined = 0xFF
432 };
433
434 enum e1000_rev_polarity{
435         e1000_rev_polarity_normal = 0,
436         e1000_rev_polarity_reversed,
437         e1000_rev_polarity_undefined = 0xFF
438 };
439
440 enum e1000_fc_mode {
441         e1000_fc_none = 0,
442         e1000_fc_rx_pause,
443         e1000_fc_tx_pause,
444         e1000_fc_full,
445         e1000_fc_default = 0xFF
446 };
447
448 enum e1000_ms_type {
449         e1000_ms_hw_default = 0,
450         e1000_ms_force_master,
451         e1000_ms_force_slave,
452         e1000_ms_auto
453 };
454
455 enum e1000_smart_speed {
456         e1000_smart_speed_default = 0,
457         e1000_smart_speed_on,
458         e1000_smart_speed_off
459 };
460
461 /* Receive Descriptor */
462 struct e1000_rx_desc {
463         __le64 buffer_addr; /* Address of the descriptor's data buffer */
464         __le16 length;      /* Length of data DMAed into data buffer */
465         __le16 csum;    /* Packet checksum */
466         u8  status;      /* Descriptor status */
467         u8  errors;      /* Descriptor Errors */
468         __le16 special;
469 };
470
471 /* Receive Descriptor - Extended */
472 union e1000_rx_desc_extended {
473         struct {
474                 __le64 buffer_addr;
475                 __le64 reserved;
476         } read;
477         struct {
478                 struct {
479                         __le32 mrq;           /* Multiple Rx Queues */
480                         union {
481                                 __le32 rss;         /* RSS Hash */
482                                 struct {
483                                         __le16 ip_id;  /* IP id */
484                                         __le16 csum;   /* Packet Checksum */
485                                 } csum_ip;
486                         } hi_dword;
487                 } lower;
488                 struct {
489                         __le32 status_error;     /* ext status/error */
490                         __le16 length;
491                         __le16 vlan;         /* VLAN tag */
492                 } upper;
493         } wb;  /* writeback */
494 };
495
496 #define MAX_PS_BUFFERS 4
497 /* Receive Descriptor - Packet Split */
498 union e1000_rx_desc_packet_split {
499         struct {
500                 /* one buffer for protocol header(s), three data buffers */
501                 __le64 buffer_addr[MAX_PS_BUFFERS];
502         } read;
503         struct {
504                 struct {
505                         __le32 mrq;           /* Multiple Rx Queues */
506                         union {
507                                 __le32 rss;           /* RSS Hash */
508                                 struct {
509                                         __le16 ip_id;    /* IP id */
510                                         __le16 csum;     /* Packet Checksum */
511                                 } csum_ip;
512                         } hi_dword;
513                 } lower;
514                 struct {
515                         __le32 status_error;     /* ext status/error */
516                         __le16 length0;   /* length of buffer 0 */
517                         __le16 vlan;         /* VLAN tag */
518                 } middle;
519                 struct {
520                         __le16 header_status;
521                         __le16 length[3];       /* length of buffers 1-3 */
522                 } upper;
523                 __le64 reserved;
524         } wb; /* writeback */
525 };
526
527 /* Transmit Descriptor */
528 struct e1000_tx_desc {
529         __le64 buffer_addr;      /* Address of the descriptor's data buffer */
530         union {
531                 __le32 data;
532                 struct {
533                         __le16 length;    /* Data buffer length */
534                         u8 cso; /* Checksum offset */
535                         u8 cmd; /* Descriptor control */
536                 } flags;
537         } lower;
538         union {
539                 __le32 data;
540                 struct {
541                         u8 status;     /* Descriptor status */
542                         u8 css; /* Checksum start */
543                         __le16 special;
544                 } fields;
545         } upper;
546 };
547
548 /* Offload Context Descriptor */
549 struct e1000_context_desc {
550         union {
551                 __le32 ip_config;
552                 struct {
553                         u8 ipcss;      /* IP checksum start */
554                         u8 ipcso;      /* IP checksum offset */
555                         __le16 ipcse;     /* IP checksum end */
556                 } ip_fields;
557         } lower_setup;
558         union {
559                 __le32 tcp_config;
560                 struct {
561                         u8 tucss;      /* TCP checksum start */
562                         u8 tucso;      /* TCP checksum offset */
563                         __le16 tucse;     /* TCP checksum end */
564                 } tcp_fields;
565         } upper_setup;
566         __le32 cmd_and_length;
567         union {
568                 __le32 data;
569                 struct {
570                         u8 status;     /* Descriptor status */
571                         u8 hdr_len;    /* Header length */
572                         __le16 mss;       /* Maximum segment size */
573                 } fields;
574         } tcp_seg_setup;
575 };
576
577 /* Offload data descriptor */
578 struct e1000_data_desc {
579         __le64 buffer_addr;   /* Address of the descriptor's buffer address */
580         union {
581                 __le32 data;
582                 struct {
583                         __le16 length;    /* Data buffer length */
584                         u8 typ_len_ext;
585                         u8 cmd;
586                 } flags;
587         } lower;
588         union {
589                 __le32 data;
590                 struct {
591                         u8 status;     /* Descriptor status */
592                         u8 popts;      /* Packet Options */
593                         __le16 special;   /* */
594                 } fields;
595         } upper;
596 };
597
598 /* Statistics counters collected by the MAC */
599 struct e1000_hw_stats {
600         u64 crcerrs;
601         u64 algnerrc;
602         u64 symerrs;
603         u64 rxerrc;
604         u64 mpc;
605         u64 scc;
606         u64 ecol;
607         u64 mcc;
608         u64 latecol;
609         u64 colc;
610         u64 dc;
611         u64 tncrs;
612         u64 sec;
613         u64 cexterr;
614         u64 rlec;
615         u64 xonrxc;
616         u64 xontxc;
617         u64 xoffrxc;
618         u64 xofftxc;
619         u64 fcruc;
620         u64 prc64;
621         u64 prc127;
622         u64 prc255;
623         u64 prc511;
624         u64 prc1023;
625         u64 prc1522;
626         u64 gprc;
627         u64 bprc;
628         u64 mprc;
629         u64 gptc;
630         u64 gorc;
631         u64 gotc;
632         u64 rnbc;
633         u64 ruc;
634         u64 rfc;
635         u64 roc;
636         u64 rjc;
637         u64 mgprc;
638         u64 mgpdc;
639         u64 mgptc;
640         u64 tor;
641         u64 tot;
642         u64 tpr;
643         u64 tpt;
644         u64 ptc64;
645         u64 ptc127;
646         u64 ptc255;
647         u64 ptc511;
648         u64 ptc1023;
649         u64 ptc1522;
650         u64 mptc;
651         u64 bptc;
652         u64 tsctc;
653         u64 tsctfc;
654         u64 iac;
655         u64 icrxptc;
656         u64 icrxatc;
657         u64 ictxptc;
658         u64 ictxatc;
659         u64 ictxqec;
660         u64 ictxqmtc;
661         u64 icrxdmtc;
662         u64 icrxoc;
663 };
664
665 struct e1000_phy_stats {
666         u32 idle_errors;
667         u32 receive_errors;
668 };
669
670 struct e1000_host_mng_dhcp_cookie {
671         u32 signature;
672         u8  status;
673         u8  reserved0;
674         u16 vlan_id;
675         u32 reserved1;
676         u16 reserved2;
677         u8  reserved3;
678         u8  checksum;
679 };
680
681 /* Host Interface "Rev 1" */
682 struct e1000_host_command_header {
683         u8 command_id;
684         u8 command_length;
685         u8 command_options;
686         u8 checksum;
687 };
688
689 #define E1000_HI_MAX_DATA_LENGTH     252
690 struct e1000_host_command_info {
691         struct e1000_host_command_header command_header;
692         u8 command_data[E1000_HI_MAX_DATA_LENGTH];
693 };
694
695 /* Host Interface "Rev 2" */
696 struct e1000_host_mng_command_header {
697         u8  command_id;
698         u8  checksum;
699         u16 reserved1;
700         u16 reserved2;
701         u16 command_length;
702 };
703
704 #define E1000_HI_MAX_MNG_DATA_LENGTH 0x6F8
705 struct e1000_host_mng_command_info {
706         struct e1000_host_mng_command_header command_header;
707         u8 command_data[E1000_HI_MAX_MNG_DATA_LENGTH];
708 };
709
710 /* Function pointers and static data for the MAC. */
711 struct e1000_mac_operations {
712         bool (*check_mng_mode)(struct e1000_hw *);
713         s32  (*check_for_link)(struct e1000_hw *);
714         s32  (*cleanup_led)(struct e1000_hw *);
715         void (*clear_hw_cntrs)(struct e1000_hw *);
716         s32  (*get_bus_info)(struct e1000_hw *);
717         s32  (*get_link_up_info)(struct e1000_hw *, u16 *, u16 *);
718         s32  (*led_on)(struct e1000_hw *);
719         s32  (*led_off)(struct e1000_hw *);
720         void (*update_mc_addr_list)(struct e1000_hw *, u8 *, u32, u32, u32);
721         s32  (*reset_hw)(struct e1000_hw *);
722         s32  (*init_hw)(struct e1000_hw *);
723         s32  (*setup_link)(struct e1000_hw *);
724         s32  (*setup_physical_interface)(struct e1000_hw *);
725 };
726
727 /* Function pointers for the PHY. */
728 struct e1000_phy_operations {
729         s32  (*acquire_phy)(struct e1000_hw *);
730         s32  (*check_reset_block)(struct e1000_hw *);
731         s32  (*commit_phy)(struct e1000_hw *);
732         s32  (*force_speed_duplex)(struct e1000_hw *);
733         s32  (*get_cfg_done)(struct e1000_hw *hw);
734         s32  (*get_cable_length)(struct e1000_hw *);
735         s32  (*get_phy_info)(struct e1000_hw *);
736         s32  (*read_phy_reg)(struct e1000_hw *, u32, u16 *);
737         void (*release_phy)(struct e1000_hw *);
738         s32  (*reset_phy)(struct e1000_hw *);
739         s32  (*set_d0_lplu_state)(struct e1000_hw *, bool);
740         s32  (*set_d3_lplu_state)(struct e1000_hw *, bool);
741         s32  (*write_phy_reg)(struct e1000_hw *, u32, u16);
742         s32  (*cfg_on_link_up)(struct e1000_hw *);
743 };
744
745 /* Function pointers for the NVM. */
746 struct e1000_nvm_operations {
747         s32  (*acquire_nvm)(struct e1000_hw *);
748         s32  (*read_nvm)(struct e1000_hw *, u16, u16, u16 *);
749         void (*release_nvm)(struct e1000_hw *);
750         s32  (*update_nvm)(struct e1000_hw *);
751         s32  (*valid_led_default)(struct e1000_hw *, u16 *);
752         s32  (*validate_nvm)(struct e1000_hw *);
753         s32  (*write_nvm)(struct e1000_hw *, u16, u16, u16 *);
754 };
755
756 struct e1000_mac_info {
757         struct e1000_mac_operations ops;
758
759         u8 addr[6];
760         u8 perm_addr[6];
761
762         enum e1000_mac_type type;
763
764         u32 collision_delta;
765         u32 ledctl_default;
766         u32 ledctl_mode1;
767         u32 ledctl_mode2;
768         u32 mc_filter_type;
769         u32 tx_packet_delta;
770         u32 txcw;
771
772         u16 current_ifs_val;
773         u16 ifs_max_val;
774         u16 ifs_min_val;
775         u16 ifs_ratio;
776         u16 ifs_step_size;
777         u16 mta_reg_count;
778         u16 rar_entry_count;
779
780         u8  forced_speed_duplex;
781
782         bool arc_subsystem_valid;
783         bool autoneg;
784         bool autoneg_failed;
785         bool get_link_status;
786         bool in_ifs_mode;
787         bool serdes_has_link;
788         bool tx_pkt_filtering;
789 };
790
791 struct e1000_phy_info {
792         struct e1000_phy_operations ops;
793
794         enum e1000_phy_type type;
795
796         enum e1000_1000t_rx_status local_rx;
797         enum e1000_1000t_rx_status remote_rx;
798         enum e1000_ms_type ms_type;
799         enum e1000_ms_type original_ms_type;
800         enum e1000_rev_polarity cable_polarity;
801         enum e1000_smart_speed smart_speed;
802
803         u32 addr;
804         u32 id;
805         u32 reset_delay_us; /* in usec */
806         u32 revision;
807
808         enum e1000_media_type media_type;
809
810         u16 autoneg_advertised;
811         u16 autoneg_mask;
812         u16 cable_length;
813         u16 max_cable_length;
814         u16 min_cable_length;
815
816         u8 mdix;
817
818         bool disable_polarity_correction;
819         bool is_mdix;
820         bool polarity_correction;
821         bool speed_downgraded;
822         bool autoneg_wait_to_complete;
823 };
824
825 struct e1000_nvm_info {
826         struct e1000_nvm_operations ops;
827
828         enum e1000_nvm_type type;
829         enum e1000_nvm_override override;
830
831         u32 flash_bank_size;
832         u32 flash_base_addr;
833
834         u16 word_size;
835         u16 delay_usec;
836         u16 address_bits;
837         u16 opcode_bits;
838         u16 page_size;
839 };
840
841 struct e1000_bus_info {
842         enum e1000_bus_width width;
843
844         u16 func;
845 };
846
847 struct e1000_fc_info {
848         u32 high_water;          /* Flow control high-water mark */
849         u32 low_water;           /* Flow control low-water mark */
850         u16 pause_time;          /* Flow control pause timer */
851         bool send_xon;           /* Flow control send XON */
852         bool strict_ieee;        /* Strict IEEE mode */
853         enum e1000_fc_mode current_mode; /* FC mode in effect */
854         enum e1000_fc_mode requested_mode; /* FC mode requested by caller */
855 };
856
857 struct e1000_dev_spec_82571 {
858         bool laa_is_present;
859         bool alt_mac_addr_is_present;
860 };
861
862 struct e1000_shadow_ram {
863         u16  value;
864         bool modified;
865 };
866
867 #define E1000_ICH8_SHADOW_RAM_WORDS             2048
868
869 struct e1000_dev_spec_ich8lan {
870         bool kmrn_lock_loss_workaround_enabled;
871         struct e1000_shadow_ram shadow_ram[E1000_ICH8_SHADOW_RAM_WORDS];
872 };
873
874 struct e1000_hw {
875         struct e1000_adapter *adapter;
876
877         u8 __iomem *hw_addr;
878         u8 __iomem *flash_address;
879
880         struct e1000_mac_info  mac;
881         struct e1000_fc_info   fc;
882         struct e1000_phy_info  phy;
883         struct e1000_nvm_info  nvm;
884         struct e1000_bus_info  bus;
885         struct e1000_host_mng_dhcp_cookie mng_cookie;
886
887         union {
888                 struct e1000_dev_spec_82571     e82571;
889                 struct e1000_dev_spec_ich8lan   ich8lan;
890         } dev_spec;
891 };
892
893 #ifdef DEBUG
894 #define hw_dbg(hw, format, arg...) \
895         printk(KERN_DEBUG "%s: " format, e1000e_get_hw_dev_name(hw), ##arg)
896 #else
897 static inline int __attribute__ ((format (printf, 2, 3)))
898 hw_dbg(struct e1000_hw *hw, const char *format, ...)
899 {
900         return 0;
901 }
902 #endif
903
904 #endif