Merge from Etherboot 5.4
[people/holger/gpxe.git] / src / drivers / net / smc9000.h
1 /*------------------------------------------------------------------------
2  * smc9000.h
3  *
4  * Copyright (C) 1998 by Daniel Engström
5  * Copyright (C) 1996 by Erik Stahlman
6  *
7  * This software may be used and distributed according to the terms
8  * of the GNU Public License, incorporated herein by reference.
9  *
10  * This file contains register information and access macros for
11  * the SMC91xxx chipset.
12  *
13  * Information contained in this file was obtained from the SMC91C94
14  * manual from SMC.  To get a copy, if you really want one, you can find
15  * information under www.smsc.com in the components division.
16  * ( this thanks to advice from Donald Becker ).
17  *
18  * Authors
19  *      Daniel Engström                         <daniel.engstrom@riksnett.no>
20  *      Erik Stahlman                           <erik@vt.edu>
21  *
22  * History
23  * 96-01-06              Erik Stahlman   moved definitions here from main .c
24  *                                       file
25  * 96-01-19              Erik Stahlman   polished this up some, and added
26  *                                       better error handling
27  * 98-09-25              Daniel Engström adjusted for Etherboot
28  * 98-09-27              Daniel Engström moved some static strings back to the
29  *                                       main .c file
30  * --------------------------------------------------------------------------*/
31 #ifndef _SMC9000_H_
32 # define _SMC9000_H_
33
34 /* I want some simple types */
35 typedef unsigned char                   byte;
36 typedef unsigned short                  word;
37 typedef unsigned long int               dword;
38
39 /*---------------------------------------------------------------
40  *
41  * A description of the SMC registers is probably in order here,
42  * although for details, the SMC datasheet is invaluable.
43  *
44  * Basically, the chip has 4 banks of registers ( 0 to 3 ), which
45  * are accessed by writing a number into the BANK_SELECT register
46  * ( I also use a SMC_SELECT_BANK macro for this ).
47  *
48  * The banks are configured so that for most purposes, bank 2 is all
49  * that is needed for simple run time tasks.
50  * ----------------------------------------------------------------------*/
51
52 /*
53  * Bank Select Register:
54  *
55  *              yyyy yyyy 0000 00xx
56  *              xx              = bank number
57  *              yyyy yyyy       = 0x33, for identification purposes.
58  */
59 #define BANK_SELECT             14
60
61 /* BANK 0  */
62
63 #define TCR             0       /* transmit control register */
64 #define TCR_ENABLE      0x0001  /* if this is 1, we can transmit */
65 #define TCR_FDUPLX      0x0800  /* receive packets sent out */
66 #define TCR_STP_SQET    0x1000  /* stop transmitting if Signal quality error */
67 #define TCR_MON_CNS     0x0400  /* monitors the carrier status */
68 #define TCR_PAD_ENABLE  0x0080  /* pads short packets to 64 bytes */
69
70 #define TCR_CLEAR       0       /* do NOTHING */
71 /* the normal settings for the TCR register : */
72 #define TCR_NORMAL      (TCR_ENABLE | TCR_PAD_ENABLE)
73
74
75 #define EPH_STATUS      2
76 #define ES_LINK_OK      0x4000  /* is the link integrity ok ? */
77
78 #define RCR             4
79 #define RCR_SOFTRESET   0x8000  /* resets the chip */
80 #define RCR_STRIP_CRC   0x200   /* strips CRC */
81 #define RCR_ENABLE      0x100   /* IFF this is set, we can receive packets */
82 #define RCR_ALMUL       0x4     /* receive all multicast packets */
83 #define RCR_PROMISC     0x2     /* enable promiscuous mode */
84
85 /* the normal settings for the RCR register : */
86 #define RCR_NORMAL      (RCR_STRIP_CRC | RCR_ENABLE)
87 #define RCR_CLEAR       0x0             /* set it to a base state */
88
89 #define COUNTER         6
90 #define MIR             8
91 #define MCR             10
92 /* 12 is reserved */
93
94 // Receive/Phy Control Register
95 /* BANK 0  */
96 #define RPC_REG         0x000A
97 #define RPC_SPEED       0x2000  // When 1 PHY is in 100Mbps mode.
98 #define RPC_DPLX        0x1000  // When 1 PHY is in Full-Duplex Mode
99 #define RPC_ANEG        0x0800  // When 1 PHY is in Auto-Negotiate Mode
100 #define RPC_LSXA_SHFT   5       // Bits to shift LS2A,LS1A,LS0A to lsb
101 #define RPC_LSXB_SHFT   2       // Bits to get LS2B,LS1B,LS0B to lsb
102 #define RPC_LED_100_10  (0x00)  // LED = 100Mbps OR's with 10Mbps link detect
103 #define RPC_LED_RES     (0x01)  // LED = Reserved
104 #define RPC_LED_10      (0x02)  // LED = 10Mbps link detect
105 #define RPC_LED_FD      (0x03)  // LED = Full Duplex Mode
106 #define RPC_LED_TX_RX   (0x04)  // LED = TX or RX packet occurred
107 #define RPC_LED_100     (0x05)  // LED = 100Mbps link dectect
108 #define RPC_LED_TX      (0x06)  // LED = TX packet occurred
109 #define RPC_LED_RX      (0x07)  // LED = RX packet occurred
110 #define RPC_DEFAULT (RPC_ANEG | (RPC_LED_100 << RPC_LSXA_SHFT) | (RPC_LED_FD << RPC_LSXB_SHFT) | RPC_SPEED | RPC_DPLX)
111
112 /* BANK 1 */
113 #define CONFIG                  0
114 #define CFG_AUI_SELECT          0x100
115 #define BASE                    2
116 #define ADDR0                   4
117 #define ADDR1                   6
118 #define ADDR2                   8
119 #define GENERAL                 10
120 #define CONTROL                 12
121 #define CTL_POWERDOWN           0x2000
122 #define CTL_LE_ENABLE           0x80
123 #define CTL_CR_ENABLE           0x40
124 #define CTL_TE_ENABLE           0x0020
125 #define CTL_AUTO_RELEASE        0x0800
126 #define CTL_EPROM_ACCESS        0x0003 /* high if Eprom is being read */
127
128 /* BANK 2 */
129 #define MMU_CMD         0
130 #define MC_BUSY         1       /* only readable bit in the register */
131 #define MC_NOP          0
132 #define MC_ALLOC        0x20    /* or with number of 256 byte packets */
133 #define MC_RESET        0x40
134 #define MC_REMOVE       0x60    /* remove the current rx packet */
135 #define MC_RELEASE      0x80    /* remove and release the current rx packet */
136 #define MC_FREEPKT      0xA0    /* Release packet in PNR register */
137 #define MC_ENQUEUE      0xC0    /* Enqueue the packet for transmit */
138
139 #define PNR_ARR         2
140 #define FIFO_PORTS      4
141
142 #define FP_RXEMPTY      0x8000
143 #define FP_TXEMPTY      0x80
144
145 #define POINTER         6
146 #define PTR_READ        0x2000
147 #define PTR_RCV         0x8000
148 #define PTR_AUTOINC     0x4000
149 #define PTR_AUTO_INC    0x0040
150
151 #define DATA_1          8
152 #define DATA_2          10
153 #define INTERRUPT       12
154
155 #define INT_MASK        13
156 #define IM_RCV_INT      0x1
157 #define IM_TX_INT       0x2
158 #define IM_TX_EMPTY_INT 0x4
159 #define IM_ALLOC_INT    0x8
160 #define IM_RX_OVRN_INT  0x10
161 #define IM_EPH_INT      0x20
162 #define IM_ERCV_INT     0x40 /* not on SMC9192 */
163
164 /* BANK 3 */
165 #define MULTICAST1      0
166 #define MULTICAST2      2
167 #define MULTICAST3      4
168 #define MULTICAST4      6
169 #define MGMT            8
170 #define REVISION        10 /* ( hi: chip id   low: rev # ) */
171
172 // Management Interface Register (MII)
173 #define MII_REG         0x0008
174 #define MII_MSK_CRS100  0x4000 // Disables CRS100 detection during tx half dup
175 #define MII_MDOE        0x0008 // MII Output Enable
176 #define MII_MCLK        0x0004 // MII Clock, pin MDCLK
177 #define MII_MDI         0x0002 // MII Input, pin MDI
178 #define MII_MDO         0x0001 // MII Output, pin MDO
179
180 /* this is NOT on SMC9192 */
181 #define ERCV            12
182
183 /* Note that 9194 and 9196 have the smame chip id,
184  * the 9196 will have revisions starting at 6 */
185 #define CHIP_9190       3
186 #define CHIP_9194       4
187 #define CHIP_9195       5
188 #define CHIP_9196       4
189 #define CHIP_91100      7
190 #define CHIP_91100FD    8
191
192 #define REV_9196        6
193
194 /*
195  * Transmit status bits
196  */
197 #define TS_SUCCESS      0x0001
198 #define TS_LOSTCAR      0x0400
199 #define TS_LATCOL       0x0200
200 #define TS_16COL        0x0010
201
202 /*
203  * Receive status bits
204  */
205 #define RS_ALGNERR      0x8000
206 #define RS_BADCRC       0x2000
207 #define RS_ODDFRAME     0x1000
208 #define RS_TOOLONG      0x0800
209 #define RS_TOOSHORT     0x0400
210 #define RS_MULTICAST    0x0001
211 #define RS_ERRORS       (RS_ALGNERR | RS_BADCRC | RS_TOOLONG | RS_TOOSHORT)
212
213
214 // PHY Register Addresses (LAN91C111 Internal PHY)
215
216 // PHY Control Register
217 #define PHY_CNTL_REG            0x00
218 #define PHY_CNTL_RST            0x8000  // 1=PHY Reset
219 #define PHY_CNTL_LPBK           0x4000  // 1=PHY Loopback
220 #define PHY_CNTL_SPEED          0x2000  // 1=100Mbps, 0=10Mpbs
221 #define PHY_CNTL_ANEG_EN        0x1000 // 1=Enable Auto negotiation
222 #define PHY_CNTL_PDN            0x0800  // 1=PHY Power Down mode
223 #define PHY_CNTL_MII_DIS        0x0400  // 1=MII 4 bit interface disabled
224 #define PHY_CNTL_ANEG_RST       0x0200 // 1=Reset Auto negotiate
225 #define PHY_CNTL_DPLX           0x0100  // 1=Full Duplex, 0=Half Duplex
226 #define PHY_CNTL_COLTST         0x0080  // 1= MII Colision Test
227
228 // PHY Status Register
229 #define PHY_STAT_REG            0x01
230 #define PHY_STAT_CAP_T4         0x8000  // 1=100Base-T4 capable
231 #define PHY_STAT_CAP_TXF        0x4000  // 1=100Base-X full duplex capable
232 #define PHY_STAT_CAP_TXH        0x2000  // 1=100Base-X half duplex capable
233 #define PHY_STAT_CAP_TF         0x1000  // 1=10Mbps full duplex capable
234 #define PHY_STAT_CAP_TH         0x0800  // 1=10Mbps half duplex capable
235 #define PHY_STAT_CAP_SUPR       0x0040  // 1=recv mgmt frames with not preamble
236 #define PHY_STAT_ANEG_ACK       0x0020  // 1=ANEG has completed
237 #define PHY_STAT_REM_FLT        0x0010  // 1=Remote Fault detected
238 #define PHY_STAT_CAP_ANEG       0x0008  // 1=Auto negotiate capable
239 #define PHY_STAT_LINK           0x0004  // 1=valid link
240 #define PHY_STAT_JAB            0x0002  // 1=10Mbps jabber condition
241 #define PHY_STAT_EXREG          0x0001  // 1=extended registers implemented
242
243 // PHY Identifier Registers
244 #define PHY_ID1_REG             0x02    // PHY Identifier 1
245 #define PHY_ID2_REG             0x03    // PHY Identifier 2
246
247 // PHY Auto-Negotiation Advertisement Register
248 #define PHY_AD_REG              0x04
249 #define PHY_AD_NP               0x8000  // 1=PHY requests exchange of Next Page
250 #define PHY_AD_ACK              0x4000  // 1=got link code word from remote
251 #define PHY_AD_RF               0x2000  // 1=advertise remote fault
252 #define PHY_AD_T4               0x0200  // 1=PHY is capable of 100Base-T4
253 #define PHY_AD_TX_FDX           0x0100  // 1=PHY is capable of 100Base-TX FDPLX
254 #define PHY_AD_TX_HDX           0x0080  // 1=PHY is capable of 100Base-TX HDPLX
255 #define PHY_AD_10_FDX           0x0040  // 1=PHY is capable of 10Base-T FDPLX
256 #define PHY_AD_10_HDX           0x0020  // 1=PHY is capable of 10Base-T HDPLX
257 #define PHY_AD_CSMA             0x0001  // 1=PHY is capable of 802.3 CMSA
258
259 // PHY Auto-negotiation Remote End Capability Register
260 #define PHY_RMT_REG             0x05
261 // Uses same bit definitions as PHY_AD_REG
262
263 // PHY Configuration Register 1
264 #define PHY_CFG1_REG            0x10
265 #define PHY_CFG1_LNKDIS         0x8000  // 1=Rx Link Detect Function disabled
266 #define PHY_CFG1_XMTDIS         0x4000  // 1=TP Transmitter Disabled
267 #define PHY_CFG1_XMTPDN         0x2000  // 1=TP Transmitter Powered Down
268 #define PHY_CFG1_BYPSCR         0x0400  // 1=Bypass scrambler/descrambler
269 #define PHY_CFG1_UNSCDS         0x0200  // 1=Unscramble Idle Reception Disable
270 #define PHY_CFG1_EQLZR          0x0100  // 1=Rx Equalizer Disabled
271 #define PHY_CFG1_CABLE          0x0080  // 1=STP(150ohm), 0=UTP(100ohm)
272 #define PHY_CFG1_RLVL0          0x0040  // 1=Rx Squelch level reduced by 4.5db
273 #define PHY_CFG1_TLVL_SHIFT     2       // Transmit Output Level Adjust
274 #define PHY_CFG1_TLVL_MASK      0x003C
275 #define PHY_CFG1_TRF_MASK       0x0003  // Transmitter Rise/Fall time
276
277
278 // PHY Configuration Register 2
279 #define PHY_CFG2_REG            0x11
280 #define PHY_CFG2_APOLDIS        0x0020  // 1=Auto Polarity Correction disabled
281 #define PHY_CFG2_JABDIS         0x0010  // 1=Jabber disabled
282 #define PHY_CFG2_MREG           0x0008  // 1=Multiple register access (MII mgt)
283 #define PHY_CFG2_INTMDIO        0x0004  // 1=Interrupt signaled with MDIO pulseo
284
285 // PHY Status Output (and Interrupt status) Register
286 #define PHY_INT_REG             0x12    // Status Output (Interrupt Status)
287 #define PHY_INT_INT             0x8000  // 1=bits have changed since last read
288 #define PHY_INT_LNKFAIL         0x4000  // 1=Link Not detected
289 #define PHY_INT_LOSSSYNC        0x2000  // 1=Descrambler has lost sync
290 #define PHY_INT_CWRD            0x1000  // 1=Invalid 4B5B code detected on rx
291 #define PHY_INT_SSD             0x0800  // 1=No Start Of Stream detected on rx
292 #define PHY_INT_ESD             0x0400  // 1=No End Of Stream detected on rx
293 #define PHY_INT_RPOL            0x0200  // 1=Reverse Polarity detected
294 #define PHY_INT_JAB             0x0100  // 1=Jabber detected
295 #define PHY_INT_SPDDET          0x0080  // 1=100Base-TX mode, 0=10Base-T mode
296 #define PHY_INT_DPLXDET         0x0040  // 1=Device in Full Duplex
297
298 // PHY Interrupt/Status Mask Register
299 #define PHY_MASK_REG            0x13    // Interrupt Mask
300 // Uses the same bit definitions as PHY_INT_REG
301
302
303 /*-------------------------------------------------------------------------
304  *  I define some macros to make it easier to do somewhat common
305  * or slightly complicated, repeated tasks.
306  --------------------------------------------------------------------------*/
307
308 /* select a register bank, 0 to 3  */
309
310 #define SMC_SELECT_BANK(x, y) { _outw( y, x + BANK_SELECT ); }
311
312 /* define a small delay for the reset */
313 #define SMC_DELAY(x) { inw( x + RCR );\
314                         inw( x + RCR );\
315                         inw( x + RCR ); }
316
317
318 #endif  /* _SMC_9000_H_ */
319