f3d87d7b9fdccd89ec65a30580fb46a86c871c51
[firefly-linux-kernel-4.4.55.git] / drivers / net / ethernet / intel / igb / e1000_defines.h
1 /*******************************************************************************
2
3   Intel(R) Gigabit Ethernet Linux driver
4   Copyright(c) 2007-2013 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   e1000-devel Mailing List <e1000-devel@lists.sourceforge.net>
24   Intel Corporation, 5200 N.E. Elam Young Parkway, Hillsboro, OR 97124-6497
25
26 *******************************************************************************/
27
28 #ifndef _E1000_DEFINES_H_
29 #define _E1000_DEFINES_H_
30
31 /* Number of Transmit and Receive Descriptors must be a multiple of 8 */
32 #define REQ_TX_DESCRIPTOR_MULTIPLE  8
33 #define REQ_RX_DESCRIPTOR_MULTIPLE  8
34
35 /* Definitions for power management and wakeup registers */
36 /* Wake Up Control */
37 #define E1000_WUC_PME_EN     0x00000002 /* PME Enable */
38
39 /* Wake Up Filter Control */
40 #define E1000_WUFC_LNKC 0x00000001 /* Link Status Change Wakeup Enable */
41 #define E1000_WUFC_MAG  0x00000002 /* Magic Packet Wakeup Enable */
42 #define E1000_WUFC_EX   0x00000004 /* Directed Exact Wakeup Enable */
43 #define E1000_WUFC_MC   0x00000008 /* Directed Multicast Wakeup Enable */
44 #define E1000_WUFC_BC   0x00000010 /* Broadcast Wakeup Enable */
45
46 /* Extended Device Control */
47 #define E1000_CTRL_EXT_SDP3_DATA 0x00000080 /* Value of SW Defineable Pin 3 */
48 /* Physical Func Reset Done Indication */
49 #define E1000_CTRL_EXT_PFRSTD    0x00004000
50 #define E1000_CTRL_EXT_LINK_MODE_MASK 0x00C00000
51 #define E1000_CTRL_EXT_LINK_MODE_PCIE_SERDES  0x00C00000
52 #define E1000_CTRL_EXT_LINK_MODE_1000BASE_KX  0x00400000
53 #define E1000_CTRL_EXT_LINK_MODE_SGMII   0x00800000
54 #define E1000_CTRL_EXT_LINK_MODE_GMII   0x00000000
55 #define E1000_CTRL_EXT_EIAME          0x01000000
56 #define E1000_CTRL_EXT_IRCA           0x00000001
57 /* Interrupt delay cancellation */
58 /* Driver loaded bit for FW */
59 #define E1000_CTRL_EXT_DRV_LOAD       0x10000000
60 /* Interrupt acknowledge Auto-mask */
61 /* Clear Interrupt timers after IMS clear */
62 /* packet buffer parity error detection enabled */
63 /* descriptor FIFO parity error detection enable */
64 #define E1000_CTRL_EXT_PBA_CLR        0x80000000 /* PBA Clear */
65 #define E1000_I2CCMD_REG_ADDR_SHIFT   16
66 #define E1000_I2CCMD_PHY_ADDR_SHIFT   24
67 #define E1000_I2CCMD_OPCODE_READ      0x08000000
68 #define E1000_I2CCMD_OPCODE_WRITE     0x00000000
69 #define E1000_I2CCMD_READY            0x20000000
70 #define E1000_I2CCMD_ERROR            0x80000000
71 #define E1000_MAX_SGMII_PHY_REG_ADDR  255
72 #define E1000_I2CCMD_PHY_TIMEOUT      200
73 #define E1000_IVAR_VALID              0x80
74 #define E1000_GPIE_NSICR              0x00000001
75 #define E1000_GPIE_MSIX_MODE          0x00000010
76 #define E1000_GPIE_EIAME              0x40000000
77 #define E1000_GPIE_PBA                0x80000000
78
79 /* Receive Descriptor bit definitions */
80 #define E1000_RXD_STAT_DD       0x01    /* Descriptor Done */
81 #define E1000_RXD_STAT_EOP      0x02    /* End of Packet */
82 #define E1000_RXD_STAT_IXSM     0x04    /* Ignore checksum */
83 #define E1000_RXD_STAT_VP       0x08    /* IEEE VLAN Packet */
84 #define E1000_RXD_STAT_UDPCS    0x10    /* UDP xsum calculated */
85 #define E1000_RXD_STAT_TCPCS    0x20    /* TCP xsum calculated */
86 #define E1000_RXD_STAT_TS       0x10000 /* Pkt was time stamped */
87
88 #define E1000_RXDEXT_STATERR_LB    0x00040000
89 #define E1000_RXDEXT_STATERR_CE    0x01000000
90 #define E1000_RXDEXT_STATERR_SE    0x02000000
91 #define E1000_RXDEXT_STATERR_SEQ   0x04000000
92 #define E1000_RXDEXT_STATERR_CXE   0x10000000
93 #define E1000_RXDEXT_STATERR_TCPE  0x20000000
94 #define E1000_RXDEXT_STATERR_IPE   0x40000000
95 #define E1000_RXDEXT_STATERR_RXE   0x80000000
96
97 /* Same mask, but for extended and packet split descriptors */
98 #define E1000_RXDEXT_ERR_FRAME_ERR_MASK ( \
99     E1000_RXDEXT_STATERR_CE  |            \
100     E1000_RXDEXT_STATERR_SE  |            \
101     E1000_RXDEXT_STATERR_SEQ |            \
102     E1000_RXDEXT_STATERR_CXE |            \
103     E1000_RXDEXT_STATERR_RXE)
104
105 #define E1000_MRQC_RSS_FIELD_IPV4_TCP          0x00010000
106 #define E1000_MRQC_RSS_FIELD_IPV4              0x00020000
107 #define E1000_MRQC_RSS_FIELD_IPV6_TCP_EX       0x00040000
108 #define E1000_MRQC_RSS_FIELD_IPV6              0x00100000
109 #define E1000_MRQC_RSS_FIELD_IPV6_TCP          0x00200000
110
111
112 /* Management Control */
113 #define E1000_MANC_SMBUS_EN      0x00000001 /* SMBus Enabled - RO */
114 #define E1000_MANC_ASF_EN        0x00000002 /* ASF Enabled - RO */
115 #define E1000_MANC_EN_BMC2OS     0x10000000 /* OSBMC is Enabled or not */
116 /* Enable Neighbor Discovery Filtering */
117 #define E1000_MANC_RCV_TCO_EN    0x00020000 /* Receive TCO Packets Enabled */
118 #define E1000_MANC_BLK_PHY_RST_ON_IDE   0x00040000 /* Block phy resets */
119 /* Enable MAC address filtering */
120 #define E1000_MANC_EN_MAC_ADDR_FILTER   0x00100000
121
122 /* Receive Control */
123 #define E1000_RCTL_EN             0x00000002    /* enable */
124 #define E1000_RCTL_SBP            0x00000004    /* store bad packet */
125 #define E1000_RCTL_UPE            0x00000008    /* unicast promiscuous enable */
126 #define E1000_RCTL_MPE            0x00000010    /* multicast promiscuous enab */
127 #define E1000_RCTL_LPE            0x00000020    /* long packet enable */
128 #define E1000_RCTL_LBM_MAC        0x00000040    /* MAC loopback mode */
129 #define E1000_RCTL_LBM_TCVR       0x000000C0    /* tcvr loopback mode */
130 #define E1000_RCTL_RDMTS_HALF     0x00000000    /* rx desc min threshold size */
131 #define E1000_RCTL_MO_SHIFT       12            /* multicast offset shift */
132 #define E1000_RCTL_BAM            0x00008000    /* broadcast enable */
133 #define E1000_RCTL_SZ_512         0x00020000    /* rx buffer size 512 */
134 #define E1000_RCTL_SZ_256         0x00030000    /* rx buffer size 256 */
135 #define E1000_RCTL_VFE            0x00040000    /* vlan filter enable */
136 #define E1000_RCTL_CFIEN          0x00080000    /* canonical form enable */
137 #define E1000_RCTL_DPF            0x00400000    /* Discard Pause Frames */
138 #define E1000_RCTL_PMCF           0x00800000    /* pass MAC control frames */
139 #define E1000_RCTL_SECRC          0x04000000    /* Strip Ethernet CRC */
140
141 /* Use byte values for the following shift parameters
142  * Usage:
143  *     psrctl |= (((ROUNDUP(value0, 128) >> E1000_PSRCTL_BSIZE0_SHIFT) &
144  *                  E1000_PSRCTL_BSIZE0_MASK) |
145  *                ((ROUNDUP(value1, 1024) >> E1000_PSRCTL_BSIZE1_SHIFT) &
146  *                  E1000_PSRCTL_BSIZE1_MASK) |
147  *                ((ROUNDUP(value2, 1024) << E1000_PSRCTL_BSIZE2_SHIFT) &
148  *                  E1000_PSRCTL_BSIZE2_MASK) |
149  *                ((ROUNDUP(value3, 1024) << E1000_PSRCTL_BSIZE3_SHIFT) |;
150  *                  E1000_PSRCTL_BSIZE3_MASK))
151  * where value0 = [128..16256],  default=256
152  *       value1 = [1024..64512], default=4096
153  *       value2 = [0..64512],    default=4096
154  *       value3 = [0..64512],    default=0
155  */
156
157 #define E1000_PSRCTL_BSIZE0_MASK   0x0000007F
158 #define E1000_PSRCTL_BSIZE1_MASK   0x00003F00
159 #define E1000_PSRCTL_BSIZE2_MASK   0x003F0000
160 #define E1000_PSRCTL_BSIZE3_MASK   0x3F000000
161
162 #define E1000_PSRCTL_BSIZE0_SHIFT  7            /* Shift _right_ 7 */
163 #define E1000_PSRCTL_BSIZE1_SHIFT  2            /* Shift _right_ 2 */
164 #define E1000_PSRCTL_BSIZE2_SHIFT  6            /* Shift _left_ 6 */
165 #define E1000_PSRCTL_BSIZE3_SHIFT 14            /* Shift _left_ 14 */
166
167 /* SWFW_SYNC Definitions */
168 #define E1000_SWFW_EEP_SM   0x1
169 #define E1000_SWFW_PHY0_SM  0x2
170 #define E1000_SWFW_PHY1_SM  0x4
171 #define E1000_SWFW_PHY2_SM  0x20
172 #define E1000_SWFW_PHY3_SM  0x40
173
174 /* FACTPS Definitions */
175 /* Device Control */
176 #define E1000_CTRL_FD       0x00000001  /* Full duplex.0=half; 1=full */
177 #define E1000_CTRL_GIO_MASTER_DISABLE 0x00000004 /*Blocks new Master requests */
178 #define E1000_CTRL_LRST     0x00000008  /* Link reset. 0=normal,1=reset */
179 #define E1000_CTRL_ASDE     0x00000020  /* Auto-speed detect enable */
180 #define E1000_CTRL_SLU      0x00000040  /* Set link up (Force Link) */
181 #define E1000_CTRL_ILOS     0x00000080  /* Invert Loss-Of Signal */
182 #define E1000_CTRL_SPD_SEL  0x00000300  /* Speed Select Mask */
183 #define E1000_CTRL_SPD_100  0x00000100  /* Force 100Mb */
184 #define E1000_CTRL_SPD_1000 0x00000200  /* Force 1Gb */
185 #define E1000_CTRL_FRCSPD   0x00000800  /* Force Speed */
186 #define E1000_CTRL_FRCDPX   0x00001000  /* Force Duplex */
187 /* Defined polarity of Dock/Undock indication in SDP[0] */
188 /* Reset both PHY ports, through PHYRST_N pin */
189 /* enable link status from external LINK_0 and LINK_1 pins */
190 #define E1000_CTRL_SWDPIN0  0x00040000  /* SWDPIN 0 value */
191 #define E1000_CTRL_SWDPIN1  0x00080000  /* SWDPIN 1 value */
192 #define E1000_CTRL_SWDPIO0  0x00400000  /* SWDPIN 0 Input or output */
193 #define E1000_CTRL_RST      0x04000000  /* Global reset */
194 #define E1000_CTRL_RFCE     0x08000000  /* Receive Flow Control enable */
195 #define E1000_CTRL_TFCE     0x10000000  /* Transmit flow control enable */
196 #define E1000_CTRL_VME      0x40000000  /* IEEE VLAN mode enable */
197 #define E1000_CTRL_PHY_RST  0x80000000  /* PHY Reset */
198 /* Initiate an interrupt to manageability engine */
199 #define E1000_CTRL_I2C_ENA  0x02000000  /* I2C enable */
200
201 /* Bit definitions for the Management Data IO (MDIO) and Management Data
202  * Clock (MDC) pins in the Device Control Register.
203  */
204
205 #define E1000_CONNSW_ENRGSRC             0x4
206 #define E1000_PCS_CFG_PCS_EN             8
207 #define E1000_PCS_LCTL_FLV_LINK_UP       1
208 #define E1000_PCS_LCTL_FSV_100           2
209 #define E1000_PCS_LCTL_FSV_1000          4
210 #define E1000_PCS_LCTL_FDV_FULL          8
211 #define E1000_PCS_LCTL_FSD               0x10
212 #define E1000_PCS_LCTL_FORCE_LINK        0x20
213 #define E1000_PCS_LCTL_FORCE_FCTRL       0x80
214 #define E1000_PCS_LCTL_AN_ENABLE         0x10000
215 #define E1000_PCS_LCTL_AN_RESTART        0x20000
216 #define E1000_PCS_LCTL_AN_TIMEOUT        0x40000
217 #define E1000_ENABLE_SERDES_LOOPBACK     0x0410
218
219 #define E1000_PCS_LSTS_LINK_OK           1
220 #define E1000_PCS_LSTS_SPEED_100         2
221 #define E1000_PCS_LSTS_SPEED_1000        4
222 #define E1000_PCS_LSTS_DUPLEX_FULL       8
223 #define E1000_PCS_LSTS_SYNK_OK           0x10
224
225 /* Device Status */
226 #define E1000_STATUS_FD         0x00000001      /* Full duplex.0=half,1=full */
227 #define E1000_STATUS_LU         0x00000002      /* Link up.0=no,1=link */
228 #define E1000_STATUS_FUNC_MASK  0x0000000C      /* PCI Function Mask */
229 #define E1000_STATUS_FUNC_SHIFT 2
230 #define E1000_STATUS_FUNC_1     0x00000004      /* Function 1 */
231 #define E1000_STATUS_TXOFF      0x00000010      /* transmission paused */
232 #define E1000_STATUS_SPEED_100  0x00000040      /* Speed 100Mb/s */
233 #define E1000_STATUS_SPEED_1000 0x00000080      /* Speed 1000Mb/s */
234 /* Change in Dock/Undock state. Clear on write '0'. */
235 /* Status of Master requests. */
236 #define E1000_STATUS_GIO_MASTER_ENABLE 0x00080000
237 /* BMC external code execution disabled */
238
239 /* Constants used to intrepret the masked PCI-X bus speed. */
240
241 #define SPEED_10    10
242 #define SPEED_100   100
243 #define SPEED_1000  1000
244 #define HALF_DUPLEX 1
245 #define FULL_DUPLEX 2
246
247
248 #define ADVERTISE_10_HALF                 0x0001
249 #define ADVERTISE_10_FULL                 0x0002
250 #define ADVERTISE_100_HALF                0x0004
251 #define ADVERTISE_100_FULL                0x0008
252 #define ADVERTISE_1000_HALF               0x0010 /* Not used, just FYI */
253 #define ADVERTISE_1000_FULL               0x0020
254
255 /* 1000/H is not supported, nor spec-compliant. */
256 #define E1000_ALL_SPEED_DUPLEX (ADVERTISE_10_HALF  |  ADVERTISE_10_FULL | \
257                                 ADVERTISE_100_HALF |  ADVERTISE_100_FULL | \
258                                                       ADVERTISE_1000_FULL)
259 #define E1000_ALL_NOT_GIG      (ADVERTISE_10_HALF  |  ADVERTISE_10_FULL | \
260                                 ADVERTISE_100_HALF |  ADVERTISE_100_FULL)
261 #define E1000_ALL_100_SPEED    (ADVERTISE_100_HALF |  ADVERTISE_100_FULL)
262 #define E1000_ALL_10_SPEED     (ADVERTISE_10_HALF  |  ADVERTISE_10_FULL)
263 #define E1000_ALL_FULL_DUPLEX  (ADVERTISE_10_FULL  |  ADVERTISE_100_FULL | \
264                                                       ADVERTISE_1000_FULL)
265 #define E1000_ALL_HALF_DUPLEX  (ADVERTISE_10_HALF  |  ADVERTISE_100_HALF)
266
267 #define AUTONEG_ADVERTISE_SPEED_DEFAULT   E1000_ALL_SPEED_DUPLEX
268
269 /* LED Control */
270 #define E1000_LEDCTL_LED0_MODE_SHIFT      0
271 #define E1000_LEDCTL_LED0_BLINK           0x00000080
272
273 #define E1000_LEDCTL_MODE_LED_ON        0xE
274 #define E1000_LEDCTL_MODE_LED_OFF       0xF
275
276 /* Transmit Descriptor bit definitions */
277 #define E1000_TXD_POPTS_IXSM 0x01       /* Insert IP checksum */
278 #define E1000_TXD_POPTS_TXSM 0x02       /* Insert TCP/UDP checksum */
279 #define E1000_TXD_CMD_EOP    0x01000000 /* End of Packet */
280 #define E1000_TXD_CMD_IFCS   0x02000000 /* Insert FCS (Ethernet CRC) */
281 #define E1000_TXD_CMD_RS     0x08000000 /* Report Status */
282 #define E1000_TXD_CMD_DEXT   0x20000000 /* Descriptor extension (0 = legacy) */
283 #define E1000_TXD_STAT_DD    0x00000001 /* Descriptor Done */
284 /* Extended desc bits for Linksec and timesync */
285
286 /* Transmit Control */
287 #define E1000_TCTL_EN     0x00000002    /* enable tx */
288 #define E1000_TCTL_PSP    0x00000008    /* pad short packets */
289 #define E1000_TCTL_CT     0x00000ff0    /* collision threshold */
290 #define E1000_TCTL_COLD   0x003ff000    /* collision distance */
291 #define E1000_TCTL_RTLC   0x01000000    /* Re-transmit on late collision */
292
293 /* DMA Coalescing register fields */
294 #define E1000_DMACR_DMACWT_MASK         0x00003FFF /* DMA Coalescing
295                                                         * Watchdog Timer */
296 #define E1000_DMACR_DMACTHR_MASK        0x00FF0000 /* DMA Coalescing Receive
297                                                         * Threshold */
298 #define E1000_DMACR_DMACTHR_SHIFT       16
299 #define E1000_DMACR_DMAC_LX_MASK        0x30000000 /* Lx when no PCIe
300                                                         * transactions */
301 #define E1000_DMACR_DMAC_LX_SHIFT       28
302 #define E1000_DMACR_DMAC_EN             0x80000000 /* Enable DMA Coalescing */
303 /* DMA Coalescing BMC-to-OS Watchdog Enable */
304 #define E1000_DMACR_DC_BMC2OSW_EN       0x00008000
305
306 #define E1000_DMCTXTH_DMCTTHR_MASK      0x00000FFF /* DMA Coalescing Transmit
307                                                         * Threshold */
308
309 #define E1000_DMCTLX_TTLX_MASK          0x00000FFF /* Time to LX request */
310
311 #define E1000_DMCRTRH_UTRESH_MASK       0x0007FFFF /* Receive Traffic Rate
312                                                         * Threshold */
313 #define E1000_DMCRTRH_LRPRCW            0x80000000 /* Rcv packet rate in
314                                                         * current window */
315
316 #define E1000_DMCCNT_CCOUNT_MASK        0x01FFFFFF /* DMA Coal Rcv Traffic
317                                                         * Current Cnt */
318
319 #define E1000_FCRTC_RTH_COAL_MASK       0x0003FFF0 /* Flow ctrl Rcv Threshold
320                                                         * High val */
321 #define E1000_FCRTC_RTH_COAL_SHIFT      4
322 #define E1000_PCIEMISC_LX_DECISION      0x00000080 /* Lx power decision */
323
324 /* Timestamp in Rx buffer */
325 #define E1000_RXPBS_CFG_TS_EN           0x80000000
326
327 /* SerDes Control */
328 #define E1000_SCTL_DISABLE_SERDES_LOOPBACK 0x0400
329
330 /* Receive Checksum Control */
331 #define E1000_RXCSUM_IPOFL     0x00000100   /* IPv4 checksum offload */
332 #define E1000_RXCSUM_TUOFL     0x00000200   /* TCP / UDP checksum offload */
333 #define E1000_RXCSUM_CRCOFL    0x00000800   /* CRC32 offload enable */
334 #define E1000_RXCSUM_PCSD      0x00002000   /* packet checksum disabled */
335
336 /* Header split receive */
337 #define E1000_RFCTL_LEF        0x00040000
338
339 /* Collision related configuration parameters */
340 #define E1000_COLLISION_THRESHOLD       15
341 #define E1000_CT_SHIFT                  4
342 #define E1000_COLLISION_DISTANCE        63
343 #define E1000_COLD_SHIFT                12
344
345 /* Ethertype field values */
346 #define ETHERNET_IEEE_VLAN_TYPE 0x8100  /* 802.3ac packet */
347
348 #define MAX_JUMBO_FRAME_SIZE    0x3F00
349
350 /* PBA constants */
351 #define E1000_PBA_34K 0x0022
352 #define E1000_PBA_64K 0x0040    /* 64KB */
353
354 /* SW Semaphore Register */
355 #define E1000_SWSM_SMBI         0x00000001 /* Driver Semaphore bit */
356 #define E1000_SWSM_SWESMBI      0x00000002 /* FW Semaphore bit */
357
358 /* Interrupt Cause Read */
359 #define E1000_ICR_TXDW          0x00000001 /* Transmit desc written back */
360 #define E1000_ICR_LSC           0x00000004 /* Link Status Change */
361 #define E1000_ICR_RXSEQ         0x00000008 /* rx sequence error */
362 #define E1000_ICR_RXDMT0        0x00000010 /* rx desc min. threshold (0) */
363 #define E1000_ICR_RXT0          0x00000080 /* rx timer intr (ring 0) */
364 #define E1000_ICR_VMMB          0x00000100 /* VM MB event */
365 #define E1000_ICR_TS            0x00080000 /* Time Sync Interrupt */
366 #define E1000_ICR_DRSTA         0x40000000 /* Device Reset Asserted */
367 /* If this bit asserted, the driver should claim the interrupt */
368 #define E1000_ICR_INT_ASSERTED  0x80000000
369 /* LAN connected device generates an interrupt */
370 #define E1000_ICR_DOUTSYNC      0x10000000 /* NIC DMA out of sync */
371
372 /* Extended Interrupt Cause Read */
373 #define E1000_EICR_RX_QUEUE0    0x00000001 /* Rx Queue 0 Interrupt */
374 #define E1000_EICR_RX_QUEUE1    0x00000002 /* Rx Queue 1 Interrupt */
375 #define E1000_EICR_RX_QUEUE2    0x00000004 /* Rx Queue 2 Interrupt */
376 #define E1000_EICR_RX_QUEUE3    0x00000008 /* Rx Queue 3 Interrupt */
377 #define E1000_EICR_TX_QUEUE0    0x00000100 /* Tx Queue 0 Interrupt */
378 #define E1000_EICR_TX_QUEUE1    0x00000200 /* Tx Queue 1 Interrupt */
379 #define E1000_EICR_TX_QUEUE2    0x00000400 /* Tx Queue 2 Interrupt */
380 #define E1000_EICR_TX_QUEUE3    0x00000800 /* Tx Queue 3 Interrupt */
381 #define E1000_EICR_OTHER        0x80000000 /* Interrupt Cause Active */
382 /* TCP Timer */
383
384 /* This defines the bits that are set in the Interrupt Mask
385  * Set/Read Register.  Each bit is documented below:
386  *   o RXT0   = Receiver Timer Interrupt (ring 0)
387  *   o TXDW   = Transmit Descriptor Written Back
388  *   o RXDMT0 = Receive Descriptor Minimum Threshold hit (ring 0)
389  *   o RXSEQ  = Receive Sequence Error
390  *   o LSC    = Link Status Change
391  */
392 #define IMS_ENABLE_MASK ( \
393     E1000_IMS_RXT0   |    \
394     E1000_IMS_TXDW   |    \
395     E1000_IMS_RXDMT0 |    \
396     E1000_IMS_RXSEQ  |    \
397     E1000_IMS_LSC    |    \
398     E1000_IMS_DOUTSYNC)
399
400 /* Interrupt Mask Set */
401 #define E1000_IMS_TXDW      E1000_ICR_TXDW      /* Transmit desc written back */
402 #define E1000_IMS_LSC       E1000_ICR_LSC       /* Link Status Change */
403 #define E1000_IMS_VMMB      E1000_ICR_VMMB      /* Mail box activity */
404 #define E1000_IMS_TS        E1000_ICR_TS        /* Time Sync Interrupt */
405 #define E1000_IMS_RXSEQ     E1000_ICR_RXSEQ     /* rx sequence error */
406 #define E1000_IMS_RXDMT0    E1000_ICR_RXDMT0    /* rx desc min. threshold */
407 #define E1000_IMS_RXT0      E1000_ICR_RXT0      /* rx timer intr */
408 #define E1000_IMS_DRSTA     E1000_ICR_DRSTA     /* Device Reset Asserted */
409 #define E1000_IMS_DOUTSYNC  E1000_ICR_DOUTSYNC /* NIC DMA out of sync */
410
411 /* Extended Interrupt Mask Set */
412 #define E1000_EIMS_OTHER        E1000_EICR_OTHER   /* Interrupt Cause Active */
413
414 /* Interrupt Cause Set */
415 #define E1000_ICS_LSC       E1000_ICR_LSC       /* Link Status Change */
416 #define E1000_ICS_RXDMT0    E1000_ICR_RXDMT0    /* rx desc min. threshold */
417 #define E1000_ICS_DRSTA     E1000_ICR_DRSTA     /* Device Reset Aserted */
418
419 /* Extended Interrupt Cause Set */
420 /* E1000_EITR_CNT_IGNR is only for 82576 and newer */
421 #define E1000_EITR_CNT_IGNR     0x80000000 /* Don't reset counters on write */
422
423
424 /* Transmit Descriptor Control */
425 /* Enable the counting of descriptors still to be processed. */
426
427 /* Flow Control Constants */
428 #define FLOW_CONTROL_ADDRESS_LOW  0x00C28001
429 #define FLOW_CONTROL_ADDRESS_HIGH 0x00000100
430 #define FLOW_CONTROL_TYPE         0x8808
431
432 /* Transmit Config Word */
433 #define E1000_TXCW_ASM_DIR      0x00000100 /* TXCW astm pause direction */
434 #define E1000_TXCW_PAUSE        0x00000080 /* TXCW sym pause request */
435
436 /* 802.1q VLAN Packet Size */
437 #define VLAN_TAG_SIZE              4    /* 802.3ac tag (not DMA'd) */
438 #define E1000_VLAN_FILTER_TBL_SIZE 128  /* VLAN Filter Table (4096 bits) */
439
440 /* Receive Address */
441 /* Number of high/low register pairs in the RAR. The RAR (Receive Address
442  * Registers) holds the directed and multicast addresses that we monitor.
443  * Technically, we have 16 spots.  However, we reserve one of these spots
444  * (RAR[15]) for our directed address used by controllers with
445  * manageability enabled, allowing us room for 15 multicast addresses.
446  */
447 #define E1000_RAH_AV  0x80000000        /* Receive descriptor valid */
448 #define E1000_RAL_MAC_ADDR_LEN 4
449 #define E1000_RAH_MAC_ADDR_LEN 2
450 #define E1000_RAH_POOL_MASK 0x03FC0000
451 #define E1000_RAH_POOL_1 0x00040000
452
453 /* Error Codes */
454 #define E1000_SUCCESS      0
455 #define E1000_ERR_NVM      1
456 #define E1000_ERR_PHY      2
457 #define E1000_ERR_CONFIG   3
458 #define E1000_ERR_PARAM    4
459 #define E1000_ERR_MAC_INIT 5
460 #define E1000_ERR_RESET   9
461 #define E1000_ERR_MASTER_REQUESTS_PENDING 10
462 #define E1000_BLK_PHY_RESET   12
463 #define E1000_ERR_SWFW_SYNC 13
464 #define E1000_NOT_IMPLEMENTED 14
465 #define E1000_ERR_MBX      15
466 #define E1000_ERR_INVALID_ARGUMENT  16
467 #define E1000_ERR_NO_SPACE          17
468 #define E1000_ERR_NVM_PBA_SECTION   18
469 #define E1000_ERR_INVM_VALUE_NOT_FOUND  19
470 #define E1000_ERR_I2C               20
471
472 /* Loop limit on how long we wait for auto-negotiation to complete */
473 #define COPPER_LINK_UP_LIMIT              10
474 #define PHY_AUTO_NEG_LIMIT                45
475 #define PHY_FORCE_LIMIT                   20
476 /* Number of 100 microseconds we wait for PCI Express master disable */
477 #define MASTER_DISABLE_TIMEOUT      800
478 /* Number of milliseconds we wait for PHY configuration done after MAC reset */
479 #define PHY_CFG_TIMEOUT             100
480 /* Number of 2 milliseconds we wait for acquiring MDIO ownership. */
481 /* Number of milliseconds for NVM auto read done after MAC reset. */
482 #define AUTO_READ_DONE_TIMEOUT      10
483
484 /* Flow Control */
485 #define E1000_FCRTL_XONE 0x80000000     /* Enable XON frame transmission */
486
487 #define E1000_TSYNCTXCTL_VALID    0x00000001 /* tx timestamp valid */
488 #define E1000_TSYNCTXCTL_ENABLED  0x00000010 /* enable tx timestampping */
489
490 #define E1000_TSYNCRXCTL_VALID      0x00000001 /* rx timestamp valid */
491 #define E1000_TSYNCRXCTL_TYPE_MASK  0x0000000E /* rx type mask */
492 #define E1000_TSYNCRXCTL_TYPE_L2_V2       0x00
493 #define E1000_TSYNCRXCTL_TYPE_L4_V1       0x02
494 #define E1000_TSYNCRXCTL_TYPE_L2_L4_V2    0x04
495 #define E1000_TSYNCRXCTL_TYPE_ALL         0x08
496 #define E1000_TSYNCRXCTL_TYPE_EVENT_V2    0x0A
497 #define E1000_TSYNCRXCTL_ENABLED    0x00000010 /* enable rx timestampping */
498
499 #define E1000_TSYNCRXCFG_PTP_V1_CTRLT_MASK   0x000000FF
500 #define E1000_TSYNCRXCFG_PTP_V1_SYNC_MESSAGE       0x00
501 #define E1000_TSYNCRXCFG_PTP_V1_DELAY_REQ_MESSAGE  0x01
502 #define E1000_TSYNCRXCFG_PTP_V1_FOLLOWUP_MESSAGE   0x02
503 #define E1000_TSYNCRXCFG_PTP_V1_DELAY_RESP_MESSAGE 0x03
504 #define E1000_TSYNCRXCFG_PTP_V1_MANAGEMENT_MESSAGE 0x04
505
506 #define E1000_TSYNCRXCFG_PTP_V2_MSGID_MASK               0x00000F00
507 #define E1000_TSYNCRXCFG_PTP_V2_SYNC_MESSAGE                 0x0000
508 #define E1000_TSYNCRXCFG_PTP_V2_DELAY_REQ_MESSAGE            0x0100
509 #define E1000_TSYNCRXCFG_PTP_V2_PATH_DELAY_REQ_MESSAGE       0x0200
510 #define E1000_TSYNCRXCFG_PTP_V2_PATH_DELAY_RESP_MESSAGE      0x0300
511 #define E1000_TSYNCRXCFG_PTP_V2_FOLLOWUP_MESSAGE             0x0800
512 #define E1000_TSYNCRXCFG_PTP_V2_DELAY_RESP_MESSAGE           0x0900
513 #define E1000_TSYNCRXCFG_PTP_V2_PATH_DELAY_FOLLOWUP_MESSAGE  0x0A00
514 #define E1000_TSYNCRXCFG_PTP_V2_ANNOUNCE_MESSAGE             0x0B00
515 #define E1000_TSYNCRXCFG_PTP_V2_SIGNALLING_MESSAGE           0x0C00
516 #define E1000_TSYNCRXCFG_PTP_V2_MANAGEMENT_MESSAGE           0x0D00
517
518 #define E1000_TIMINCA_16NS_SHIFT 24
519
520 #define E1000_TSICR_TXTS 0x00000002
521 #define E1000_TSIM_TXTS 0x00000002
522
523 #define E1000_MDICNFG_EXT_MDIO    0x80000000      /* MDI ext/int destination */
524 #define E1000_MDICNFG_COM_MDIO    0x40000000      /* MDI shared w/ lan 0 */
525 #define E1000_MDICNFG_PHY_MASK    0x03E00000
526 #define E1000_MDICNFG_PHY_SHIFT   21
527
528 /* PCI Express Control */
529 #define E1000_GCR_CMPL_TMOUT_MASK       0x0000F000
530 #define E1000_GCR_CMPL_TMOUT_10ms       0x00001000
531 #define E1000_GCR_CMPL_TMOUT_RESEND     0x00010000
532 #define E1000_GCR_CAP_VER2              0x00040000
533
534 /* mPHY Address Control and Data Registers */
535 #define E1000_MPHY_ADDR_CTL          0x0024 /* mPHY Address Control Register */
536 #define E1000_MPHY_ADDR_CTL_OFFSET_MASK 0xFFFF0000
537 #define E1000_MPHY_DATA                 0x0E10 /* mPHY Data Register */
538
539 /* mPHY PCS CLK Register */
540 #define E1000_MPHY_PCS_CLK_REG_OFFSET  0x0004 /* mPHY PCS CLK AFE CSR Offset */
541 /* mPHY Near End Digital Loopback Override Bit */
542 #define E1000_MPHY_PCS_CLK_REG_DIGINELBEN 0x10
543
544 #define E1000_PCS_LCTL_FORCE_FCTRL      0x80
545 #define E1000_PCS_LSTS_AN_COMPLETE      0x10000
546
547 /* PHY Control Register */
548 #define MII_CR_FULL_DUPLEX      0x0100  /* FDX =1, half duplex =0 */
549 #define MII_CR_RESTART_AUTO_NEG 0x0200  /* Restart auto negotiation */
550 #define MII_CR_POWER_DOWN       0x0800  /* Power down */
551 #define MII_CR_AUTO_NEG_EN      0x1000  /* Auto Neg Enable */
552 #define MII_CR_LOOPBACK         0x4000  /* 0 = normal, 1 = loopback */
553 #define MII_CR_RESET            0x8000  /* 0 = normal, 1 = PHY reset */
554 #define MII_CR_SPEED_1000       0x0040
555 #define MII_CR_SPEED_100        0x2000
556 #define MII_CR_SPEED_10         0x0000
557
558 /* PHY Status Register */
559 #define MII_SR_LINK_STATUS       0x0004 /* Link Status 1 = link */
560 #define MII_SR_AUTONEG_COMPLETE  0x0020 /* Auto Neg Complete */
561
562 /* Autoneg Advertisement Register */
563 #define NWAY_AR_10T_HD_CAPS      0x0020   /* 10T   Half Duplex Capable */
564 #define NWAY_AR_10T_FD_CAPS      0x0040   /* 10T   Full Duplex Capable */
565 #define NWAY_AR_100TX_HD_CAPS    0x0080   /* 100TX Half Duplex Capable */
566 #define NWAY_AR_100TX_FD_CAPS    0x0100   /* 100TX Full Duplex Capable */
567 #define NWAY_AR_PAUSE            0x0400   /* Pause operation desired */
568 #define NWAY_AR_ASM_DIR          0x0800   /* Asymmetric Pause Direction bit */
569
570 /* Link Partner Ability Register (Base Page) */
571 #define NWAY_LPAR_PAUSE          0x0400 /* LP Pause operation desired */
572 #define NWAY_LPAR_ASM_DIR        0x0800 /* LP Asymmetric Pause Direction bit */
573
574 /* Autoneg Expansion Register */
575
576 /* 1000BASE-T Control Register */
577 #define CR_1000T_HD_CAPS         0x0100 /* Advertise 1000T HD capability */
578 #define CR_1000T_FD_CAPS         0x0200 /* Advertise 1000T FD capability  */
579 #define CR_1000T_MS_VALUE        0x0800 /* 1=Configure PHY as Master */
580                                         /* 0=Configure PHY as Slave */
581 #define CR_1000T_MS_ENABLE       0x1000 /* 1=Master/Slave manual config value */
582                                         /* 0=Automatic Master/Slave config */
583
584 /* 1000BASE-T Status Register */
585 #define SR_1000T_REMOTE_RX_STATUS 0x1000 /* Remote receiver OK */
586 #define SR_1000T_LOCAL_RX_STATUS  0x2000 /* Local receiver OK */
587
588
589 /* PHY 1000 MII Register/Bit Definitions */
590 /* PHY Registers defined by IEEE */
591 #define PHY_CONTROL      0x00 /* Control Register */
592 #define PHY_STATUS       0x01 /* Status Register */
593 #define PHY_ID1          0x02 /* Phy Id Reg (word 1) */
594 #define PHY_ID2          0x03 /* Phy Id Reg (word 2) */
595 #define PHY_AUTONEG_ADV  0x04 /* Autoneg Advertisement */
596 #define PHY_LP_ABILITY   0x05 /* Link Partner Ability (Base Page) */
597 #define PHY_1000T_CTRL   0x09 /* 1000Base-T Control Reg */
598 #define PHY_1000T_STATUS 0x0A /* 1000Base-T Status Reg */
599
600 /* NVM Control */
601 #define E1000_EECD_SK        0x00000001 /* NVM Clock */
602 #define E1000_EECD_CS        0x00000002 /* NVM Chip Select */
603 #define E1000_EECD_DI        0x00000004 /* NVM Data In */
604 #define E1000_EECD_DO        0x00000008 /* NVM Data Out */
605 #define E1000_EECD_REQ       0x00000040 /* NVM Access Request */
606 #define E1000_EECD_GNT       0x00000080 /* NVM Access Grant */
607 #define E1000_EECD_PRES      0x00000100 /* NVM Present */
608 /* NVM Addressing bits based on type 0=small, 1=large */
609 #define E1000_EECD_ADDR_BITS 0x00000400
610 #define E1000_NVM_GRANT_ATTEMPTS   1000 /* NVM # attempts to gain grant */
611 #define E1000_EECD_AUTO_RD          0x00000200  /* NVM Auto Read done */
612 #define E1000_EECD_SIZE_EX_MASK     0x00007800  /* NVM Size */
613 #define E1000_EECD_SIZE_EX_SHIFT     11
614 #define E1000_EECD_FLUPD_I210           0x00800000 /* Update FLASH */
615 #define E1000_EECD_FLUDONE_I210         0x04000000 /* Update FLASH done*/
616 #define E1000_FLUDONE_ATTEMPTS          20000
617 #define E1000_EERD_EEWR_MAX_COUNT       512 /* buffered EEPROM words rw */
618 #define E1000_I210_FIFO_SEL_RX          0x00
619 #define E1000_I210_FIFO_SEL_TX_QAV(_i)  (0x02 + (_i))
620 #define E1000_I210_FIFO_SEL_TX_LEGACY   E1000_I210_FIFO_SEL_TX_QAV(0)
621 #define E1000_I210_FIFO_SEL_BMC2OS_TX   0x06
622 #define E1000_I210_FIFO_SEL_BMC2OS_RX   0x01
623 #define E1000_EECD_FLUPD_I210           0x00800000 /* Update FLASH */
624 #define E1000_EECD_FLUDONE_I210         0x04000000 /* Update FLASH done*/
625 #define E1000_FLUDONE_ATTEMPTS          20000
626 #define E1000_EERD_EEWR_MAX_COUNT       512 /* buffered EEPROM words rw */
627 #define E1000_I210_FIFO_SEL_RX          0x00
628 #define E1000_I210_FIFO_SEL_TX_QAV(_i)  (0x02 + (_i))
629 #define E1000_I210_FIFO_SEL_TX_LEGACY   E1000_I210_FIFO_SEL_TX_QAV(0)
630 #define E1000_I210_FIFO_SEL_BMC2OS_TX   0x06
631 #define E1000_I210_FIFO_SEL_BMC2OS_RX   0x01
632
633
634 /* Offset to data in NVM read/write registers */
635 #define E1000_NVM_RW_REG_DATA   16
636 #define E1000_NVM_RW_REG_DONE   2    /* Offset to READ/WRITE done bit */
637 #define E1000_NVM_RW_REG_START  1    /* Start operation */
638 #define E1000_NVM_RW_ADDR_SHIFT 2    /* Shift to the address bits */
639 #define E1000_NVM_POLL_READ     0    /* Flag for polling for read complete */
640
641 /* NVM Word Offsets */
642 #define NVM_COMPAT                 0x0003
643 #define NVM_ID_LED_SETTINGS        0x0004 /* SERDES output amplitude */
644 #define NVM_VERSION                0x0005
645 #define NVM_INIT_CONTROL2_REG      0x000F
646 #define NVM_INIT_CONTROL3_PORT_B   0x0014
647 #define NVM_INIT_CONTROL3_PORT_A   0x0024
648 #define NVM_ALT_MAC_ADDR_PTR       0x0037
649 #define NVM_CHECKSUM_REG           0x003F
650 #define NVM_COMPATIBILITY_REG_3    0x0003
651 #define NVM_COMPATIBILITY_BIT_MASK 0x8000
652 #define NVM_MAC_ADDR               0x0000
653 #define NVM_SUB_DEV_ID             0x000B
654 #define NVM_SUB_VEN_ID             0x000C
655 #define NVM_DEV_ID                 0x000D
656 #define NVM_VEN_ID                 0x000E
657 #define NVM_INIT_CTRL_2            0x000F
658 #define NVM_INIT_CTRL_4            0x0013
659 #define NVM_LED_1_CFG              0x001C
660 #define NVM_LED_0_2_CFG            0x001F
661
662 /* NVM version defines */
663 #define NVM_ETRACK_WORD            0x0042
664 #define NVM_COMB_VER_OFF           0x0083
665 #define NVM_COMB_VER_PTR           0x003d
666 #define NVM_MAJOR_MASK             0xF000
667 #define NVM_MINOR_MASK             0x0FF0
668 #define NVM_BUILD_MASK             0x000F
669 #define NVM_COMB_VER_MASK          0x00FF
670 #define NVM_MAJOR_SHIFT                12
671 #define NVM_MINOR_SHIFT                 4
672 #define NVM_COMB_VER_SHFT               8
673 #define NVM_VER_INVALID            0xFFFF
674 #define NVM_ETRACK_SHIFT               16
675 #define NVM_ETS_CFG                     0x003E
676 #define NVM_ETS_LTHRES_DELTA_MASK       0x07C0
677 #define NVM_ETS_LTHRES_DELTA_SHIFT      6
678 #define NVM_ETS_TYPE_MASK               0x0038
679 #define NVM_ETS_TYPE_SHIFT              3
680 #define NVM_ETS_TYPE_EMC                0x000
681 #define NVM_ETS_NUM_SENSORS_MASK        0x0007
682 #define NVM_ETS_DATA_LOC_MASK           0x3C00
683 #define NVM_ETS_DATA_LOC_SHIFT          10
684 #define NVM_ETS_DATA_INDEX_MASK         0x0300
685 #define NVM_ETS_DATA_INDEX_SHIFT        8
686 #define NVM_ETS_DATA_HTHRESH_MASK       0x00FF
687
688 #define E1000_NVM_CFG_DONE_PORT_0  0x040000 /* MNG config cycle done */
689 #define E1000_NVM_CFG_DONE_PORT_1  0x080000 /* ...for second port */
690 #define E1000_NVM_CFG_DONE_PORT_2  0x100000 /* ...for third port */
691 #define E1000_NVM_CFG_DONE_PORT_3  0x200000 /* ...for fourth port */
692
693 #define NVM_82580_LAN_FUNC_OFFSET(a) (a ? (0x40 + (0x40 * a)) : 0)
694
695 /* Mask bits for fields in Word 0x24 of the NVM */
696 #define NVM_WORD24_COM_MDIO         0x0008 /* MDIO interface shared */
697 #define NVM_WORD24_EXT_MDIO         0x0004 /* MDIO accesses routed external */
698
699 /* Mask bits for fields in Word 0x0f of the NVM */
700 #define NVM_WORD0F_PAUSE_MASK       0x3000
701 #define NVM_WORD0F_ASM_DIR          0x2000
702
703 /* Mask bits for fields in Word 0x1a of the NVM */
704
705 /* length of string needed to store part num */
706 #define E1000_PBANUM_LENGTH         11
707
708 /* For checksumming, the sum of all words in the NVM should equal 0xBABA. */
709 #define NVM_SUM                    0xBABA
710
711 #define NVM_PBA_OFFSET_0           8
712 #define NVM_PBA_OFFSET_1           9
713 #define NVM_RESERVED_WORD               0xFFFF
714 #define NVM_PBA_PTR_GUARD          0xFAFA
715 #define NVM_WORD_SIZE_BASE_SHIFT   6
716
717 /* NVM Commands - Microwire */
718
719 /* NVM Commands - SPI */
720 #define NVM_MAX_RETRY_SPI          5000 /* Max wait of 5ms, for RDY signal */
721 #define NVM_WRITE_OPCODE_SPI       0x02 /* NVM write opcode */
722 #define NVM_READ_OPCODE_SPI        0x03 /* NVM read opcode */
723 #define NVM_A8_OPCODE_SPI          0x08 /* opcode bit-3 = address bit-8 */
724 #define NVM_WREN_OPCODE_SPI        0x06 /* NVM set Write Enable latch */
725 #define NVM_RDSR_OPCODE_SPI        0x05 /* NVM read Status register */
726
727 /* SPI NVM Status Register */
728 #define NVM_STATUS_RDY_SPI         0x01
729
730 /* Word definitions for ID LED Settings */
731 #define ID_LED_RESERVED_0000 0x0000
732 #define ID_LED_RESERVED_FFFF 0xFFFF
733 #define ID_LED_DEFAULT       ((ID_LED_OFF1_ON2  << 12) | \
734                               (ID_LED_OFF1_OFF2 <<  8) | \
735                               (ID_LED_DEF1_DEF2 <<  4) | \
736                               (ID_LED_DEF1_DEF2))
737 #define ID_LED_DEF1_DEF2     0x1
738 #define ID_LED_DEF1_ON2      0x2
739 #define ID_LED_DEF1_OFF2     0x3
740 #define ID_LED_ON1_DEF2      0x4
741 #define ID_LED_ON1_ON2       0x5
742 #define ID_LED_ON1_OFF2      0x6
743 #define ID_LED_OFF1_DEF2     0x7
744 #define ID_LED_OFF1_ON2      0x8
745 #define ID_LED_OFF1_OFF2     0x9
746
747 #define IGP_ACTIVITY_LED_MASK   0xFFFFF0FF
748 #define IGP_ACTIVITY_LED_ENABLE 0x0300
749 #define IGP_LED3_MODE           0x07000000
750
751 /* PCI/PCI-X/PCI-EX Config space */
752 #define PCIE_DEVICE_CONTROL2         0x28
753 #define PCIE_DEVICE_CONTROL2_16ms    0x0005
754
755 #define PHY_REVISION_MASK      0xFFFFFFF0
756 #define MAX_PHY_REG_ADDRESS    0x1F  /* 5 bit address bus (0-0x1F) */
757 #define MAX_PHY_MULTI_PAGE_REG 0xF
758
759 /* Bit definitions for valid PHY IDs. */
760 /* I = Integrated
761  * E = External
762  */
763 #define M88E1111_I_PHY_ID    0x01410CC0
764 #define M88E1112_E_PHY_ID    0x01410C90
765 #define I347AT4_E_PHY_ID     0x01410DC0
766 #define IGP03E1000_E_PHY_ID  0x02A80390
767 #define I82580_I_PHY_ID      0x015403A0
768 #define I350_I_PHY_ID        0x015403B0
769 #define M88_VENDOR           0x0141
770 #define I210_I_PHY_ID        0x01410C00
771
772 /* M88E1000 Specific Registers */
773 #define M88E1000_PHY_SPEC_CTRL     0x10  /* PHY Specific Control Register */
774 #define M88E1000_PHY_SPEC_STATUS   0x11  /* PHY Specific Status Register */
775 #define M88E1000_EXT_PHY_SPEC_CTRL 0x14  /* Extended PHY Specific Control */
776
777 #define M88E1000_PHY_PAGE_SELECT   0x1D  /* Reg 29 for page number setting */
778 #define M88E1000_PHY_GEN_CONTROL   0x1E  /* Its meaning depends on reg 29 */
779
780 /* M88E1000 PHY Specific Control Register */
781 #define M88E1000_PSCR_POLARITY_REVERSAL 0x0002 /* 1=Polarity Reversal enabled */
782 /* 1=CLK125 low, 0=CLK125 toggling */
783 #define M88E1000_PSCR_MDI_MANUAL_MODE  0x0000  /* MDI Crossover Mode bits 6:5 */
784                                                /* Manual MDI configuration */
785 #define M88E1000_PSCR_MDIX_MANUAL_MODE 0x0020  /* Manual MDIX configuration */
786 /* 1000BASE-T: Auto crossover, 100BASE-TX/10BASE-T: MDI Mode */
787 #define M88E1000_PSCR_AUTO_X_1000T     0x0040
788 /* Auto crossover enabled all speeds */
789 #define M88E1000_PSCR_AUTO_X_MODE      0x0060
790 /* 1=Enable Extended 10BASE-T distance (Lower 10BASE-T Rx Threshold
791  * 0=Normal 10BASE-T Rx Threshold
792  */
793 /* 1=5-bit interface in 100BASE-TX, 0=MII interface in 100BASE-TX */
794 #define M88E1000_PSCR_ASSERT_CRS_ON_TX     0x0800 /* 1=Assert CRS on Transmit */
795
796 /* M88E1000 PHY Specific Status Register */
797 #define M88E1000_PSSR_REV_POLARITY       0x0002 /* 1=Polarity reversed */
798 #define M88E1000_PSSR_DOWNSHIFT          0x0020 /* 1=Downshifted */
799 #define M88E1000_PSSR_MDIX               0x0040 /* 1=MDIX; 0=MDI */
800 /* 0 = <50M
801  * 1 = 50-80M
802  * 2 = 80-110M
803  * 3 = 110-140M
804  * 4 = >140M
805  */
806 #define M88E1000_PSSR_CABLE_LENGTH       0x0380
807 #define M88E1000_PSSR_SPEED              0xC000 /* Speed, bits 14:15 */
808 #define M88E1000_PSSR_1000MBS            0x8000 /* 10=1000Mbs */
809
810 #define M88E1000_PSSR_CABLE_LENGTH_SHIFT 7
811
812 /* M88E1000 Extended PHY Specific Control Register */
813 /* 1 = Lost lock detect enabled.
814  * Will assert lost lock and bring
815  * link down if idle not seen
816  * within 1ms in 1000BASE-T
817  */
818 /* Number of times we will attempt to autonegotiate before downshifting if we
819  * are the master
820  */
821 #define M88E1000_EPSCR_MASTER_DOWNSHIFT_MASK 0x0C00
822 #define M88E1000_EPSCR_MASTER_DOWNSHIFT_1X   0x0000
823 /* Number of times we will attempt to autonegotiate before downshifting if we
824  * are the slave
825  */
826 #define M88E1000_EPSCR_SLAVE_DOWNSHIFT_MASK  0x0300
827 #define M88E1000_EPSCR_SLAVE_DOWNSHIFT_1X    0x0100
828 #define M88E1000_EPSCR_TX_CLK_25      0x0070 /* 25  MHz TX_CLK */
829
830 /* Intel i347-AT4 Registers */
831
832 #define I347AT4_PCDL                   0x10 /* PHY Cable Diagnostics Length */
833 #define I347AT4_PCDC                   0x15 /* PHY Cable Diagnostics Control */
834 #define I347AT4_PAGE_SELECT            0x16
835
836 /* i347-AT4 Extended PHY Specific Control Register */
837
838 /*  Number of times we will attempt to autonegotiate before downshifting if we
839  *  are the master
840  */
841 #define I347AT4_PSCR_DOWNSHIFT_ENABLE 0x0800
842 #define I347AT4_PSCR_DOWNSHIFT_MASK   0x7000
843 #define I347AT4_PSCR_DOWNSHIFT_1X     0x0000
844 #define I347AT4_PSCR_DOWNSHIFT_2X     0x1000
845 #define I347AT4_PSCR_DOWNSHIFT_3X     0x2000
846 #define I347AT4_PSCR_DOWNSHIFT_4X     0x3000
847 #define I347AT4_PSCR_DOWNSHIFT_5X     0x4000
848 #define I347AT4_PSCR_DOWNSHIFT_6X     0x5000
849 #define I347AT4_PSCR_DOWNSHIFT_7X     0x6000
850 #define I347AT4_PSCR_DOWNSHIFT_8X     0x7000
851
852 /* i347-AT4 PHY Cable Diagnostics Control */
853 #define I347AT4_PCDC_CABLE_LENGTH_UNIT 0x0400 /* 0=cm 1=meters */
854
855 /* Marvell 1112 only registers */
856 #define M88E1112_VCT_DSP_DISTANCE       0x001A
857
858 /* M88EC018 Rev 2 specific DownShift settings */
859 #define M88EC018_EPSCR_DOWNSHIFT_COUNTER_MASK  0x0E00
860 #define M88EC018_EPSCR_DOWNSHIFT_COUNTER_5X    0x0800
861
862 /* MDI Control */
863 #define E1000_MDIC_DATA_MASK 0x0000FFFF
864 #define E1000_MDIC_REG_MASK  0x001F0000
865 #define E1000_MDIC_REG_SHIFT 16
866 #define E1000_MDIC_PHY_MASK  0x03E00000
867 #define E1000_MDIC_PHY_SHIFT 21
868 #define E1000_MDIC_OP_WRITE  0x04000000
869 #define E1000_MDIC_OP_READ   0x08000000
870 #define E1000_MDIC_READY     0x10000000
871 #define E1000_MDIC_INT_EN    0x20000000
872 #define E1000_MDIC_ERROR     0x40000000
873 #define E1000_MDIC_DEST      0x80000000
874
875 /* Thermal Sensor */
876 #define E1000_THSTAT_PWR_DOWN       0x00000001 /* Power Down Event */
877 #define E1000_THSTAT_LINK_THROTTLE  0x00000002 /* Link Speed Throttle Event */
878
879 /* Energy Efficient Ethernet */
880 #define E1000_IPCNFG_EEE_1G_AN       0x00000008  /* EEE Enable 1G AN */
881 #define E1000_IPCNFG_EEE_100M_AN     0x00000004  /* EEE Enable 100M AN */
882 #define E1000_EEER_TX_LPI_EN         0x00010000  /* EEE Tx LPI Enable */
883 #define E1000_EEER_RX_LPI_EN         0x00020000  /* EEE Rx LPI Enable */
884 #define E1000_EEER_FRC_AN            0x10000000  /* Enable EEE in loopback */
885 #define E1000_EEER_LPI_FC            0x00040000  /* EEE Enable on FC */
886 #define E1000_EEE_SU_LPI_CLK_STP     0X00800000  /* EEE LPI Clock Stop */
887 #define E1000_EEER_EEE_NEG           0x20000000  /* EEE capability nego */
888 #define E1000_EEE_LP_ADV_ADDR_I350   0x040F      /* EEE LP Advertisement */
889 #define E1000_EEE_LP_ADV_DEV_I210    7           /* EEE LP Adv Device */
890 #define E1000_EEE_LP_ADV_ADDR_I210   61          /* EEE LP Adv Register */
891 #define E1000_MMDAC_FUNC_DATA        0x4000      /* Data, no post increment */
892
893 /* SerDes Control */
894 #define E1000_GEN_CTL_READY             0x80000000
895 #define E1000_GEN_CTL_ADDRESS_SHIFT     8
896 #define E1000_GEN_POLL_TIMEOUT          640
897
898 #define E1000_VFTA_ENTRY_SHIFT               5
899 #define E1000_VFTA_ENTRY_MASK                0x7F
900 #define E1000_VFTA_ENTRY_BIT_SHIFT_MASK      0x1F
901
902 /* DMA Coalescing register fields */
903 #define E1000_PCIEMISC_LX_DECISION      0x00000080 /* Lx power decision based
904                                                       on DMA coal */
905
906 /* Tx Rate-Scheduler Config fields */
907 #define E1000_RTTBCNRC_RS_ENA           0x80000000
908 #define E1000_RTTBCNRC_RF_DEC_MASK      0x00003FFF
909 #define E1000_RTTBCNRC_RF_INT_SHIFT     14
910 #define E1000_RTTBCNRC_RF_INT_MASK      \
911         (E1000_RTTBCNRC_RF_DEC_MASK << E1000_RTTBCNRC_RF_INT_SHIFT)
912
913 #endif