xref: /openbmc/u-boot/drivers/net/smc91111.h (revision 70ad375e)
1 /*------------------------------------------------------------------------
2  . smc91111.h - macros for the LAN91C111 Ethernet Driver
3  .
4  . (C) Copyright 2002
5  . Sysgo Real-Time Solutions, GmbH <www.elinos.com>
6  . Rolf Offermanns <rof@sysgo.de>
7  . Copyright (C) 2001 Standard Microsystems Corporation (SMSC)
8  .       Developed by Simple Network Magic Corporation (SNMC)
9  . Copyright (C) 1996 by Erik Stahlman (ES)
10  .
11   * SPDX-License-Identifier:	GPL-2.0+
12  .
13  . This file contains register information and access macros for
14  . the LAN91C111 single chip ethernet controller.  It is a modified
15  . version of the smc9194.h file.
16  .
17  . Information contained in this file was obtained from the LAN91C111
18  . manual from SMC.  To get a copy, if you really want one, you can find
19  . information under www.smsc.com.
20  .
21  . Authors
22  .	Erik Stahlman				( erik@vt.edu )
23  .	Daris A Nevil				( dnevil@snmc.com )
24  .
25  . History
26  . 03/16/01		Daris A Nevil	Modified for use with LAN91C111 device
27  .
28  ---------------------------------------------------------------------------*/
29 #ifndef _SMC91111_H_
30 #define _SMC91111_H_
31 
32 #include <asm/types.h>
33 #include <config.h>
34 
35 /*
36  * This function may be called by the board specific initialisation code
37  * in order to override the default mac address.
38  */
39 
40 void smc_set_mac_addr (const unsigned char *addr);
41 
42 
43 /* I want some simple types */
44 
45 typedef unsigned char			byte;
46 typedef unsigned short			word;
47 typedef unsigned long int		dword;
48 
49 struct smc91111_priv{
50 	u8 dev_num;
51 };
52 
53 /*
54  . DEBUGGING LEVELS
55  .
56  . 0 for normal operation
57  . 1 for slightly more details
58  . >2 for various levels of increasingly useless information
59  .    2 for interrupt tracking, status flags
60  .    3 for packet info
61  .    4 for complete packet dumps
62 */
63 /*#define SMC_DEBUG 0 */
64 
65 /* Because of bank switching, the LAN91xxx uses only 16 I/O ports */
66 
67 #define	SMC_IO_EXTENT	16
68 
69 #ifdef CONFIG_CPU_PXA25X
70 
71 #ifdef CONFIG_XSENGINE
72 #define	SMC_inl(a,r)	(*((volatile dword *)((a)->iobase+((r)<<1))))
73 #define	SMC_inw(a,r)	(*((volatile word *)((a)->iobase+((r)<<1))))
74 #define SMC_inb(a,p)  ({ \
75 	unsigned int __p = (unsigned int)((a)->iobase + ((p)<<1)); \
76 	unsigned int __v = *(volatile unsigned short *)((__p) & ~2); \
77 	if (__p & 2) __v >>= 8; \
78 	else __v &= 0xff; \
79 	__v; })
80 #elif defined(CONFIG_XAENIAX)
81 #define SMC_inl(a,r)	(*((volatile dword *)((a)->iobase+(r))))
82 #define SMC_inw(a,z)	({ \
83 	unsigned int __p = (unsigned int)((a)->iobase + (z)); \
84 	unsigned int __v = *(volatile unsigned int *)((__p) & ~3); \
85 	if (__p & 3) __v >>= 16; \
86 	else __v &= 0xffff; \
87 	__v; })
88 #define SMC_inb(a,p)	({ \
89 	unsigned int ___v = SMC_inw((a),(p) & ~1); \
90 	if ((p) & 1) ___v >>= 8; \
91 	else ___v &= 0xff; \
92 	___v; })
93 #else
94 #define	SMC_inl(a,r)	(*((volatile dword *)((a)->iobase+(r))))
95 #define	SMC_inw(a,r)	(*((volatile word *)((a)->iobase+(r))))
96 #define SMC_inb(a,p)	({ \
97 	unsigned int __p = (unsigned int)((a)->iobase + (p)); \
98 	unsigned int __v = *(volatile unsigned short *)((__p) & ~1); \
99 	if (__p & 1) __v >>= 8; \
100 	else __v &= 0xff; \
101 	__v; })
102 #endif
103 
104 #ifdef CONFIG_XSENGINE
105 #define	SMC_outl(a,d,r)	(*((volatile dword *)((a)->iobase+(r<<1))) = d)
106 #define	SMC_outw(a,d,r)	(*((volatile word *)((a)->iobase+(r<<1))) = d)
107 #elif defined (CONFIG_XAENIAX)
108 #define SMC_outl(a,d,r)	(*((volatile dword *)((a)->iobase+(r))) = d)
109 #define SMC_outw(a,d,p)	({ \
110 	dword __dwo = SMC_inl((a),(p) & ~3); \
111 	dword __dwn = (word)(d); \
112 	__dwo &= ((p) & 3) ? 0x0000ffff : 0xffff0000; \
113 	__dwo |= ((p) & 3) ? __dwn << 16 : __dwn; \
114 	SMC_outl((a), __dwo, (p) & ~3); \
115 })
116 #else
117 #define	SMC_outl(a,d,r)	(*((volatile dword *)((a)->iobase+(r))) = d)
118 #define	SMC_outw(a,d,r)	(*((volatile word *)((a)->iobase+(r))) = d)
119 #endif
120 
121 #define	SMC_outb(a,d,r)	({	word __d = (byte)(d);  \
122 				word __w = SMC_inw((a),(r)&~1);  \
123 				__w &= ((r)&1) ? 0x00FF : 0xFF00;  \
124 				__w |= ((r)&1) ? __d<<8 : __d;  \
125 				SMC_outw((a),__w,(r)&~1);  \
126 			})
127 
128 #define SMC_outsl(a,r,b,l)	({	int __i; \
129 					dword *__b2; \
130 					__b2 = (dword *) b; \
131 					for (__i = 0; __i < l; __i++) { \
132 					    SMC_outl((a), *(__b2 + __i), r); \
133 					} \
134 				})
135 
136 #define SMC_outsw(a,r,b,l)	({	int __i; \
137 					word *__b2; \
138 					__b2 = (word *) b; \
139 					for (__i = 0; __i < l; __i++) { \
140 					    SMC_outw((a), *(__b2 + __i), r); \
141 					} \
142 				})
143 
144 #define SMC_insl(a,r,b,l)	({	int __i ;  \
145 					dword *__b2;  \
146 					__b2 = (dword *) b;  \
147 					for (__i = 0; __i < l; __i++) {  \
148 					  *(__b2 + __i) = SMC_inl((a),(r));  \
149 					  SMC_inl((a),0);  \
150 					};  \
151 				})
152 
153 #define SMC_insw(a,r,b,l)		({	int __i ;  \
154 					word *__b2;  \
155 					__b2 = (word *) b;  \
156 					for (__i = 0; __i < l; __i++) {  \
157 					  *(__b2 + __i) = SMC_inw((a),(r));  \
158 					  SMC_inw((a),0);  \
159 					};  \
160 				})
161 
162 #define SMC_insb(a,r,b,l)	({	int __i ;  \
163 					byte *__b2;  \
164 					__b2 = (byte *) b;  \
165 					for (__i = 0; __i < l; __i++) {  \
166 					  *(__b2 + __i) = SMC_inb((a),(r));  \
167 					  SMC_inb((a),0);  \
168 					};  \
169 				})
170 
171 #elif defined(CONFIG_LEON)	/* if not CONFIG_CPU_PXA25X */
172 
173 #define SMC_LEON_SWAP16(_x_) ({ word _x = (_x_); ((_x << 8) | (_x >> 8)); })
174 
175 #define SMC_LEON_SWAP32(_x_)			\
176     ({ dword _x = (_x_);			\
177        ((_x << 24) |				\
178        ((0x0000FF00UL & _x) <<  8) |		\
179        ((0x00FF0000UL & _x) >>  8) |		\
180        (_x  >> 24)); })
181 
182 #define	SMC_inl(a,r)	(SMC_LEON_SWAP32((*(volatile dword *)((a)->iobase+((r)<<0)))))
183 #define	SMC_inl_nosw(a,r)	((*(volatile dword *)((a)->iobase+((r)<<0))))
184 #define	SMC_inw(a,r)	(SMC_LEON_SWAP16((*(volatile word *)((a)->iobase+((r)<<0)))))
185 #define	SMC_inw_nosw(a,r)	((*(volatile word *)((a)->iobase+((r)<<0))))
186 #define SMC_inb(a,p)	({ \
187 	word ___v = SMC_inw((a),(p) & ~1); \
188 	if ((p) & 1) ___v >>= 8; \
189 	else ___v &= 0xff; \
190 	___v; })
191 
192 #define	SMC_outl(a,d,r)	(*(volatile dword *)((a)->iobase+((r)<<0))=SMC_LEON_SWAP32(d))
193 #define	SMC_outl_nosw(a,d,r)	(*(volatile dword *)((a)->iobase+((r)<<0))=(d))
194 #define	SMC_outw(a,d,r)	(*(volatile word *)((a)->iobase+((r)<<0))=SMC_LEON_SWAP16(d))
195 #define	SMC_outw_nosw(a,d,r)	(*(volatile word *)((a)->iobase+((r)<<0))=(d))
196 #define	SMC_outb(a,d,r)	do{	word __d = (byte)(d);  \
197 				word __w = SMC_inw((a),(r)&~1);  \
198 				__w &= ((r)&1) ? 0x00FF : 0xFF00;  \
199 				__w |= ((r)&1) ? __d<<8 : __d;  \
200 				SMC_outw((a),__w,(r)&~1);  \
201 			}while(0)
202 #define SMC_outsl(a,r,b,l)	do{	int __i; \
203 					dword *__b2; \
204 					__b2 = (dword *) b; \
205 					for (__i = 0; __i < l; __i++) { \
206 					    SMC_outl_nosw((a), *(__b2 + __i), r); \
207 					} \
208 				}while(0)
209 #define SMC_outsw(a,r,b,l)	do{	int __i; \
210 					word *__b2; \
211 					__b2 = (word *) b; \
212 					for (__i = 0; __i < l; __i++) { \
213 					    SMC_outw_nosw((a), *(__b2 + __i), r); \
214 					} \
215 				}while(0)
216 #define SMC_insl(a,r,b,l)	do{	int __i ;  \
217 					dword *__b2;  \
218 					__b2 = (dword *) b;  \
219 					for (__i = 0; __i < l; __i++) {  \
220 					  *(__b2 + __i) = SMC_inl_nosw((a),(r));  \
221 					};  \
222 				}while(0)
223 
224 #define SMC_insw(a,r,b,l)		do{	int __i ;  \
225 					word *__b2;  \
226 					__b2 = (word *) b;  \
227 					for (__i = 0; __i < l; __i++) {  \
228 					  *(__b2 + __i) = SMC_inw_nosw((a),(r));  \
229 					};  \
230 				}while(0)
231 
232 #define SMC_insb(a,r,b,l)		do{	int __i ;  \
233 					byte *__b2;  \
234 					__b2 = (byte *) b;  \
235 					for (__i = 0; __i < l; __i++) {  \
236 					  *(__b2 + __i) = SMC_inb((a),(r));  \
237 					};  \
238 				}while(0)
239 
240 #else			/* if not CONFIG_CPU_PXA25X and not CONFIG_LEON */
241 
242 #ifndef CONFIG_SMC_USE_IOFUNCS /* these macros don't work on some boards */
243 /*
244  * We have only 16 Bit PCMCIA access on Socket 0
245  */
246 
247 #ifdef CONFIG_ADNPESC1
248 #define	SMC_inw(a,r)	(*((volatile word *)((a)->iobase+((r)<<1))))
249 #elif CONFIG_BLACKFIN
250 #define	SMC_inw(a,r)	({ word __v = (*((volatile word *)((a)->iobase+(r)))); SSYNC(); __v;})
251 #elif CONFIG_ARM64
252 #define	SMC_inw(a, r)	(*((volatile word*)((a)->iobase+((dword)(r)))))
253 #else
254 #define SMC_inw(a, r)	(*((volatile word*)((a)->iobase+(r))))
255 #endif
256 #define  SMC_inb(a,r)	(((r)&1) ? SMC_inw((a),(r)&~1)>>8 : SMC_inw((a),(r)&0xFF))
257 
258 #ifdef CONFIG_ADNPESC1
259 #define	SMC_outw(a,d,r)	(*((volatile word *)((a)->iobase+((r)<<1))) = d)
260 #elif CONFIG_BLACKFIN
261 #define	SMC_outw(a, d, r)	\
262 			({	(*((volatile word*)((a)->iobase+((r)))) = d); \
263 				SSYNC(); \
264 			})
265 #elif CONFIG_ARM64
266 #define	SMC_outw(a, d, r)	\
267 			(*((volatile word*)((a)->iobase+((dword)(r)))) = d)
268 #else
269 #define	SMC_outw(a, d, r)	\
270 			(*((volatile word*)((a)->iobase+(r))) = d)
271 #endif
272 #define	SMC_outb(a,d,r)	({	word __d = (byte)(d);  \
273 				word __w = SMC_inw((a),(r)&~1);  \
274 				__w &= ((r)&1) ? 0x00FF : 0xFF00;  \
275 				__w |= ((r)&1) ? __d<<8 : __d;  \
276 				SMC_outw((a),__w,(r)&~1);  \
277 			})
278 #if 0
279 #define	SMC_outsw(a,r,b,l)	outsw((a)->iobase+(r), (b), (l))
280 #else
281 #define SMC_outsw(a,r,b,l)	({	int __i; \
282 					word *__b2; \
283 					__b2 = (word *) b; \
284 					for (__i = 0; __i < l; __i++) { \
285 					    SMC_outw((a), *(__b2 + __i), r); \
286 					} \
287 				})
288 #endif
289 
290 #if 0
291 #define	SMC_insw(a,r,b,l)	insw((a)->iobase+(r), (b), (l))
292 #else
293 #define SMC_insw(a,r,b,l)	({	int __i ;  \
294 					word *__b2;  \
295 					__b2 = (word *) b;  \
296 					for (__i = 0; __i < l; __i++) {  \
297 					  *(__b2 + __i) = SMC_inw((a),(r));  \
298 					  SMC_inw((a),0);  \
299 					};  \
300 				})
301 #endif
302 
303 #endif  /* CONFIG_SMC_USE_IOFUNCS */
304 
305 #if defined(CONFIG_SMC_USE_32_BIT)
306 
307 #ifdef CONFIG_XSENGINE
308 #define	SMC_inl(a,r)	(*((volatile dword *)((a)->iobase+(r<<1))))
309 #else
310 #define	SMC_inl(a,r)	(*((volatile dword *)((a)->iobase+(r))))
311 #endif
312 
313 #define SMC_insl(a,r,b,l)	({	int __i ;  \
314 					dword *__b2;  \
315 					__b2 = (dword *) b;  \
316 					for (__i = 0; __i < l; __i++) {  \
317 					  *(__b2 + __i) = SMC_inl((a),(r));  \
318 					  SMC_inl((a),0);  \
319 					};  \
320 				})
321 
322 #ifdef CONFIG_XSENGINE
323 #define	SMC_outl(a,d,r)	(*((volatile dword *)((a)->iobase+(r<<1))) = d)
324 #else
325 #define	SMC_outl(a,d,r)	(*((volatile dword *)((a)->iobase+(r))) = d)
326 #endif
327 #define SMC_outsl(a,r,b,l)	({	int __i; \
328 					dword *__b2; \
329 					__b2 = (dword *) b; \
330 					for (__i = 0; __i < l; __i++) { \
331 					    SMC_outl((a), *(__b2 + __i), r); \
332 					} \
333 				})
334 
335 #endif /* CONFIG_SMC_USE_32_BIT */
336 
337 #endif
338 
339 /*---------------------------------------------------------------
340  .
341  . A description of the SMSC registers is probably in order here,
342  . although for details, the SMC datasheet is invaluable.
343  .
344  . Basically, the chip has 4 banks of registers ( 0 to 3 ), which
345  . are accessed by writing a number into the BANK_SELECT register
346  . ( I also use a SMC_SELECT_BANK macro for this ).
347  .
348  . The banks are configured so that for most purposes, bank 2 is all
349  . that is needed for simple run time tasks.
350  -----------------------------------------------------------------------*/
351 
352 /*
353  . Bank Select Register:
354  .
355  .		yyyy yyyy 0000 00xx
356  .		xx		= bank number
357  .		yyyy yyyy	= 0x33, for identification purposes.
358 */
359 #define	BANK_SELECT		14
360 
361 /* Transmit Control Register */
362 /* BANK 0  */
363 #define	TCR_REG		0x0000	/* transmit control register */
364 #define TCR_ENABLE	0x0001	/* When 1 we can transmit */
365 #define TCR_LOOP	0x0002	/* Controls output pin LBK */
366 #define TCR_FORCOL	0x0004	/* When 1 will force a collision */
367 #define TCR_PAD_EN	0x0080	/* When 1 will pad tx frames < 64 bytes w/0 */
368 #define TCR_NOCRC	0x0100	/* When 1 will not append CRC to tx frames */
369 #define TCR_MON_CSN	0x0400	/* When 1 tx monitors carrier */
370 #define TCR_FDUPLX	0x0800  /* When 1 enables full duplex operation */
371 #define TCR_STP_SQET	0x1000	/* When 1 stops tx if Signal Quality Error */
372 #define	TCR_EPH_LOOP	0x2000	/* When 1 enables EPH block loopback */
373 #define	TCR_SWFDUP	0x8000	/* When 1 enables Switched Full Duplex mode */
374 
375 #define	TCR_CLEAR	0	/* do NOTHING */
376 /* the default settings for the TCR register : */
377 /* QUESTION: do I want to enable padding of short packets ? */
378 #define	TCR_DEFAULT	TCR_ENABLE
379 
380 
381 /* EPH Status Register */
382 /* BANK 0  */
383 #define EPH_STATUS_REG	0x0002
384 #define ES_TX_SUC	0x0001	/* Last TX was successful */
385 #define ES_SNGL_COL	0x0002	/* Single collision detected for last tx */
386 #define ES_MUL_COL	0x0004	/* Multiple collisions detected for last tx */
387 #define ES_LTX_MULT	0x0008	/* Last tx was a multicast */
388 #define ES_16COL	0x0010	/* 16 Collisions Reached */
389 #define ES_SQET		0x0020	/* Signal Quality Error Test */
390 #define ES_LTXBRD	0x0040	/* Last tx was a broadcast */
391 #define ES_TXDEFR	0x0080	/* Transmit Deferred */
392 #define ES_LATCOL	0x0200	/* Late collision detected on last tx */
393 #define ES_LOSTCARR	0x0400	/* Lost Carrier Sense */
394 #define ES_EXC_DEF	0x0800	/* Excessive Deferral */
395 #define ES_CTR_ROL	0x1000	/* Counter Roll Over indication */
396 #define ES_LINK_OK	0x4000	/* Driven by inverted value of nLNK pin */
397 #define ES_TXUNRN	0x8000	/* Tx Underrun */
398 
399 
400 /* Receive Control Register */
401 /* BANK 0  */
402 #define	RCR_REG		0x0004
403 #define	RCR_RX_ABORT	0x0001	/* Set if a rx frame was aborted */
404 #define	RCR_PRMS	0x0002	/* Enable promiscuous mode */
405 #define	RCR_ALMUL	0x0004	/* When set accepts all multicast frames */
406 #define RCR_RXEN	0x0100	/* IFF this is set, we can receive packets */
407 #define	RCR_STRIP_CRC	0x0200	/* When set strips CRC from rx packets */
408 #define	RCR_ABORT_ENB	0x0200	/* When set will abort rx on collision */
409 #define	RCR_FILT_CAR	0x0400	/* When set filters leading 12 bit s of carrier */
410 #define RCR_SOFTRST	0x8000	/* resets the chip */
411 
412 /* the normal settings for the RCR register : */
413 #define	RCR_DEFAULT	(RCR_STRIP_CRC | RCR_RXEN)
414 #define RCR_CLEAR	0x0	/* set it to a base state */
415 
416 /* Counter Register */
417 /* BANK 0  */
418 #define	COUNTER_REG	0x0006
419 
420 /* Memory Information Register */
421 /* BANK 0  */
422 #define	MIR_REG		0x0008
423 
424 /* Receive/Phy Control Register */
425 /* BANK 0  */
426 #define	RPC_REG		0x000A
427 #define	RPC_SPEED	0x2000	/* When 1 PHY is in 100Mbps mode. */
428 #define	RPC_DPLX	0x1000	/* When 1 PHY is in Full-Duplex Mode */
429 #define	RPC_ANEG	0x0800	/* When 1 PHY is in Auto-Negotiate Mode */
430 #define	RPC_LSXA_SHFT	5	/* Bits to shift LS2A,LS1A,LS0A to lsb */
431 #define	RPC_LSXB_SHFT	2	/* Bits to get LS2B,LS1B,LS0B to lsb */
432 #define RPC_LED_100_10	(0x00)	/* LED = 100Mbps OR's with 10Mbps link detect */
433 #define RPC_LED_RES	(0x01)	/* LED = Reserved */
434 #define RPC_LED_10	(0x02)	/* LED = 10Mbps link detect */
435 #define RPC_LED_FD	(0x03)	/* LED = Full Duplex Mode */
436 #define RPC_LED_TX_RX	(0x04)	/* LED = TX or RX packet occurred */
437 #define RPC_LED_100	(0x05)	/* LED = 100Mbps link dectect */
438 #define RPC_LED_TX	(0x06)	/* LED = TX packet occurred */
439 #define RPC_LED_RX	(0x07)	/* LED = RX packet occurred */
440 #if defined(CONFIG_DK1C20) || defined(CONFIG_DK1S10)
441 /* buggy schematic: LEDa -> yellow, LEDb --> green */
442 #define RPC_DEFAULT	( RPC_SPEED | RPC_DPLX | RPC_ANEG	\
443 			| (RPC_LED_TX_RX << RPC_LSXA_SHFT)	\
444 			| (RPC_LED_100_10 << RPC_LSXB_SHFT)	)
445 #elif defined(CONFIG_ADNPESC1)
446 /* SSV ADNP/ESC1 has only one LED: LEDa -> Rx/Tx indicator */
447 #define RPC_DEFAULT	( RPC_SPEED | RPC_DPLX | RPC_ANEG	\
448 			| (RPC_LED_TX_RX << RPC_LSXA_SHFT)	\
449 			| (RPC_LED_100_10 << RPC_LSXB_SHFT)	)
450 #else
451 /* SMSC reference design: LEDa --> green, LEDb --> yellow */
452 #define RPC_DEFAULT	( RPC_SPEED | RPC_DPLX | RPC_ANEG	\
453 			| (RPC_LED_100_10 << RPC_LSXA_SHFT)	\
454 			| (RPC_LED_TX_RX << RPC_LSXB_SHFT)	)
455 #endif
456 
457 /* Bank 0 0x000C is reserved */
458 
459 /* Bank Select Register */
460 /* All Banks */
461 #define BSR_REG	0x000E
462 
463 
464 /* Configuration Reg */
465 /* BANK 1 */
466 #define CONFIG_REG	0x0000
467 #define CONFIG_EXT_PHY	0x0200	/* 1=external MII, 0=internal Phy */
468 #define CONFIG_GPCNTRL	0x0400	/* Inverse value drives pin nCNTRL */
469 #define CONFIG_NO_WAIT	0x1000	/* When 1 no extra wait states on ISA bus */
470 #define CONFIG_EPH_POWER_EN 0x8000 /* When 0 EPH is placed into low power mode. */
471 
472 /* Default is powered-up, Internal Phy, Wait States, and pin nCNTRL=low */
473 #define CONFIG_DEFAULT	(CONFIG_EPH_POWER_EN)
474 
475 
476 /* Base Address Register */
477 /* BANK 1 */
478 #define	BASE_REG	0x0002
479 
480 
481 /* Individual Address Registers */
482 /* BANK 1 */
483 #define	ADDR0_REG	0x0004
484 #define	ADDR1_REG	0x0006
485 #define	ADDR2_REG	0x0008
486 
487 
488 /* General Purpose Register */
489 /* BANK 1 */
490 #define	GP_REG		0x000A
491 
492 
493 /* Control Register */
494 /* BANK 1 */
495 #define	CTL_REG		0x000C
496 #define CTL_RCV_BAD	0x4000 /* When 1 bad CRC packets are received */
497 #define CTL_AUTO_RELEASE 0x0800 /* When 1 tx pages are released automatically */
498 #define	CTL_LE_ENABLE	0x0080 /* When 1 enables Link Error interrupt */
499 #define	CTL_CR_ENABLE	0x0040 /* When 1 enables Counter Rollover interrupt */
500 #define	CTL_TE_ENABLE	0x0020 /* When 1 enables Transmit Error interrupt */
501 #define	CTL_EEPROM_SELECT 0x0004 /* Controls EEPROM reload & store */
502 #define	CTL_RELOAD	0x0002 /* When set reads EEPROM into registers */
503 #define	CTL_STORE	0x0001 /* When set stores registers into EEPROM */
504 #define CTL_DEFAULT     (0x1A10) /* Autorelease enabled*/
505 
506 /* MMU Command Register */
507 /* BANK 2 */
508 #define MMU_CMD_REG	0x0000
509 #define MC_BUSY		1	/* When 1 the last release has not completed */
510 #define MC_NOP		(0<<5)	/* No Op */
511 #define	MC_ALLOC	(1<<5)	/* OR with number of 256 byte packets */
512 #define	MC_RESET	(2<<5)	/* Reset MMU to initial state */
513 #define	MC_REMOVE	(3<<5)	/* Remove the current rx packet */
514 #define MC_RELEASE	(4<<5)	/* Remove and release the current rx packet */
515 #define MC_FREEPKT	(5<<5)	/* Release packet in PNR register */
516 #define MC_ENQUEUE	(6<<5)	/* Enqueue the packet for transmit */
517 #define MC_RSTTXFIFO	(7<<5)	/* Reset the TX FIFOs */
518 
519 
520 /* Packet Number Register */
521 /* BANK 2 */
522 #define	PN_REG		0x0002
523 
524 
525 /* Allocation Result Register */
526 /* BANK 2 */
527 #define	AR_REG		0x0003
528 #define AR_FAILED	0x80	/* Alocation Failed */
529 
530 
531 /* RX FIFO Ports Register */
532 /* BANK 2 */
533 #define RXFIFO_REG	0x0004	/* Must be read as a word */
534 #define RXFIFO_REMPTY	0x8000	/* RX FIFO Empty */
535 
536 
537 /* TX FIFO Ports Register */
538 /* BANK 2 */
539 #define TXFIFO_REG	RXFIFO_REG	/* Must be read as a word */
540 #define TXFIFO_TEMPTY	0x80	/* TX FIFO Empty */
541 
542 
543 /* Pointer Register */
544 /* BANK 2 */
545 #define PTR_REG		0x0006
546 #define	PTR_RCV		0x8000 /* 1=Receive area, 0=Transmit area */
547 #define	PTR_AUTOINC	0x4000 /* Auto increment the pointer on each access */
548 #define PTR_READ	0x2000 /* When 1 the operation is a read */
549 #define PTR_NOTEMPTY	0x0800 /* When 1 _do not_ write fifo DATA REG */
550 
551 
552 /* Data Register */
553 /* BANK 2 */
554 #define	SMC91111_DATA_REG	0x0008
555 
556 
557 /* Interrupt Status/Acknowledge Register */
558 /* BANK 2 */
559 #define	SMC91111_INT_REG	0x000C
560 
561 
562 /* Interrupt Mask Register */
563 /* BANK 2 */
564 #define IM_REG		0x000D
565 #define	IM_MDINT	0x80 /* PHY MI Register 18 Interrupt */
566 #define	IM_ERCV_INT	0x40 /* Early Receive Interrupt */
567 #define	IM_EPH_INT	0x20 /* Set by Etheret Protocol Handler section */
568 #define	IM_RX_OVRN_INT	0x10 /* Set by Receiver Overruns */
569 #define	IM_ALLOC_INT	0x08 /* Set when allocation request is completed */
570 #define	IM_TX_EMPTY_INT	0x04 /* Set if the TX FIFO goes empty */
571 #define	IM_TX_INT	0x02 /* Transmit Interrrupt */
572 #define IM_RCV_INT	0x01 /* Receive Interrupt */
573 
574 
575 /* Multicast Table Registers */
576 /* BANK 3 */
577 #define	MCAST_REG1	0x0000
578 #define	MCAST_REG2	0x0002
579 #define	MCAST_REG3	0x0004
580 #define	MCAST_REG4	0x0006
581 
582 
583 /* Management Interface Register (MII) */
584 /* BANK 3 */
585 #define	MII_REG		0x0008
586 #define MII_MSK_CRS100	0x4000 /* Disables CRS100 detection during tx half dup */
587 #define MII_MDOE	0x0008 /* MII Output Enable */
588 #define MII_MCLK	0x0004 /* MII Clock, pin MDCLK */
589 #define MII_MDI		0x0002 /* MII Input, pin MDI */
590 #define MII_MDO		0x0001 /* MII Output, pin MDO */
591 
592 
593 /* Revision Register */
594 /* BANK 3 */
595 #define	REV_REG		0x000A /* ( hi: chip id   low: rev # ) */
596 
597 
598 /* Early RCV Register */
599 /* BANK 3 */
600 /* this is NOT on SMC9192 */
601 #define	ERCV_REG	0x000C
602 #define ERCV_RCV_DISCRD	0x0080 /* When 1 discards a packet being received */
603 #define ERCV_THRESHOLD	0x001F /* ERCV Threshold Mask */
604 
605 /* External Register */
606 /* BANK 7 */
607 #define	EXT_REG		0x0000
608 
609 
610 #define CHIP_9192	3
611 #define CHIP_9194	4
612 #define CHIP_9195	5
613 #define CHIP_9196	6
614 #define CHIP_91100	7
615 #define CHIP_91100FD	8
616 #define CHIP_91111FD	9
617 
618 #if 0
619 static const char * chip_ids[ 15 ] =  {
620 	NULL, NULL, NULL,
621 	/* 3 */ "SMC91C90/91C92",
622 	/* 4 */ "SMC91C94",
623 	/* 5 */ "SMC91C95",
624 	/* 6 */ "SMC91C96",
625 	/* 7 */ "SMC91C100",
626 	/* 8 */ "SMC91C100FD",
627 	/* 9 */ "SMC91C111",
628 	NULL, NULL,
629 	NULL, NULL, NULL};
630 #endif
631 
632 /*
633  . Transmit status bits
634 */
635 #define TS_SUCCESS 0x0001
636 #define TS_LOSTCAR 0x0400
637 #define TS_LATCOL  0x0200
638 #define TS_16COL   0x0010
639 
640 /*
641  . Receive status bits
642 */
643 #define RS_ALGNERR	0x8000
644 #define RS_BRODCAST	0x4000
645 #define RS_BADCRC	0x2000
646 #define RS_ODDFRAME	0x1000	/* bug: the LAN91C111 never sets this on receive */
647 #define RS_TOOLONG	0x0800
648 #define RS_TOOSHORT	0x0400
649 #define RS_MULTICAST	0x0001
650 #define RS_ERRORS	(RS_ALGNERR | RS_BADCRC | RS_TOOLONG | RS_TOOSHORT)
651 
652 
653 /* PHY Types */
654 enum {
655 	PHY_LAN83C183 = 1,	/* LAN91C111 Internal PHY */
656 	PHY_LAN83C180
657 };
658 
659 
660 /* PHY Register Addresses (LAN91C111 Internal PHY) */
661 
662 /* PHY Control Register */
663 #define PHY_CNTL_REG		0x00
664 #define PHY_CNTL_RST		0x8000	/* 1=PHY Reset */
665 #define PHY_CNTL_LPBK		0x4000	/* 1=PHY Loopback */
666 #define PHY_CNTL_SPEED		0x2000	/* 1=100Mbps, 0=10Mpbs */
667 #define PHY_CNTL_ANEG_EN	0x1000 /* 1=Enable Auto negotiation */
668 #define PHY_CNTL_PDN		0x0800	/* 1=PHY Power Down mode */
669 #define PHY_CNTL_MII_DIS	0x0400	/* 1=MII 4 bit interface disabled */
670 #define PHY_CNTL_ANEG_RST	0x0200 /* 1=Reset Auto negotiate */
671 #define PHY_CNTL_DPLX		0x0100	/* 1=Full Duplex, 0=Half Duplex */
672 #define PHY_CNTL_COLTST		0x0080	/* 1= MII Colision Test */
673 
674 /* PHY Status Register */
675 #define PHY_STAT_REG		0x01
676 #define PHY_STAT_CAP_T4		0x8000	/* 1=100Base-T4 capable */
677 #define PHY_STAT_CAP_TXF	0x4000	/* 1=100Base-X full duplex capable */
678 #define PHY_STAT_CAP_TXH	0x2000	/* 1=100Base-X half duplex capable */
679 #define PHY_STAT_CAP_TF		0x1000	/* 1=10Mbps full duplex capable */
680 #define PHY_STAT_CAP_TH		0x0800	/* 1=10Mbps half duplex capable */
681 #define PHY_STAT_CAP_SUPR	0x0040	/* 1=recv mgmt frames with not preamble */
682 #define PHY_STAT_ANEG_ACK	0x0020	/* 1=ANEG has completed */
683 #define PHY_STAT_REM_FLT	0x0010	/* 1=Remote Fault detected */
684 #define PHY_STAT_CAP_ANEG	0x0008	/* 1=Auto negotiate capable */
685 #define PHY_STAT_LINK		0x0004	/* 1=valid link */
686 #define PHY_STAT_JAB		0x0002	/* 1=10Mbps jabber condition */
687 #define PHY_STAT_EXREG		0x0001	/* 1=extended registers implemented */
688 
689 /* PHY Identifier Registers */
690 #define PHY_ID1_REG		0x02	/* PHY Identifier 1 */
691 #define PHY_ID2_REG		0x03	/* PHY Identifier 2 */
692 
693 /* PHY Auto-Negotiation Advertisement Register */
694 #define PHY_AD_REG		0x04
695 #define PHY_AD_NP		0x8000	/* 1=PHY requests exchange of Next Page */
696 #define PHY_AD_ACK		0x4000	/* 1=got link code word from remote */
697 #define PHY_AD_RF		0x2000	/* 1=advertise remote fault */
698 #define PHY_AD_T4		0x0200	/* 1=PHY is capable of 100Base-T4 */
699 #define PHY_AD_TX_FDX		0x0100	/* 1=PHY is capable of 100Base-TX FDPLX */
700 #define PHY_AD_TX_HDX		0x0080	/* 1=PHY is capable of 100Base-TX HDPLX */
701 #define PHY_AD_10_FDX		0x0040	/* 1=PHY is capable of 10Base-T FDPLX */
702 #define PHY_AD_10_HDX		0x0020	/* 1=PHY is capable of 10Base-T HDPLX */
703 #define PHY_AD_CSMA		0x0001	/* 1=PHY is capable of 802.3 CMSA */
704 
705 /* PHY Auto-negotiation Remote End Capability Register */
706 #define PHY_RMT_REG		0x05
707 /* Uses same bit definitions as PHY_AD_REG */
708 
709 /* PHY Configuration Register 1 */
710 #define PHY_CFG1_REG		0x10
711 #define PHY_CFG1_LNKDIS		0x8000	/* 1=Rx Link Detect Function disabled */
712 #define PHY_CFG1_XMTDIS		0x4000	/* 1=TP Transmitter Disabled */
713 #define PHY_CFG1_XMTPDN		0x2000	/* 1=TP Transmitter Powered Down */
714 #define PHY_CFG1_BYPSCR		0x0400	/* 1=Bypass scrambler/descrambler */
715 #define PHY_CFG1_UNSCDS		0x0200	/* 1=Unscramble Idle Reception Disable */
716 #define PHY_CFG1_EQLZR		0x0100	/* 1=Rx Equalizer Disabled */
717 #define PHY_CFG1_CABLE		0x0080	/* 1=STP(150ohm), 0=UTP(100ohm) */
718 #define PHY_CFG1_RLVL0		0x0040	/* 1=Rx Squelch level reduced by 4.5db */
719 #define PHY_CFG1_TLVL_SHIFT	2	/* Transmit Output Level Adjust */
720 #define PHY_CFG1_TLVL_MASK	0x003C
721 #define PHY_CFG1_TRF_MASK	0x0003	/* Transmitter Rise/Fall time */
722 
723 
724 /* PHY Configuration Register 2 */
725 #define PHY_CFG2_REG		0x11
726 #define PHY_CFG2_APOLDIS	0x0020	/* 1=Auto Polarity Correction disabled */
727 #define PHY_CFG2_JABDIS		0x0010	/* 1=Jabber disabled */
728 #define PHY_CFG2_MREG		0x0008	/* 1=Multiple register access (MII mgt) */
729 #define PHY_CFG2_INTMDIO	0x0004	/* 1=Interrupt signaled with MDIO pulseo */
730 
731 /* PHY Status Output (and Interrupt status) Register */
732 #define PHY_INT_REG		0x12	/* Status Output (Interrupt Status) */
733 #define PHY_INT_INT		0x8000	/* 1=bits have changed since last read */
734 #define	PHY_INT_LNKFAIL		0x4000	/* 1=Link Not detected */
735 #define PHY_INT_LOSSSYNC	0x2000	/* 1=Descrambler has lost sync */
736 #define PHY_INT_CWRD		0x1000	/* 1=Invalid 4B5B code detected on rx */
737 #define PHY_INT_SSD		0x0800	/* 1=No Start Of Stream detected on rx */
738 #define PHY_INT_ESD		0x0400	/* 1=No End Of Stream detected on rx */
739 #define PHY_INT_RPOL		0x0200	/* 1=Reverse Polarity detected */
740 #define PHY_INT_JAB		0x0100	/* 1=Jabber detected */
741 #define PHY_INT_SPDDET		0x0080	/* 1=100Base-TX mode, 0=10Base-T mode */
742 #define PHY_INT_DPLXDET		0x0040	/* 1=Device in Full Duplex */
743 
744 /* PHY Interrupt/Status Mask Register */
745 #define PHY_MASK_REG		0x13	/* Interrupt Mask */
746 /* Uses the same bit definitions as PHY_INT_REG */
747 
748 
749 /*-------------------------------------------------------------------------
750  .  I define some macros to make it easier to do somewhat common
751  . or slightly complicated, repeated tasks.
752  --------------------------------------------------------------------------*/
753 
754 /* select a register bank, 0 to 3  */
755 
756 #define SMC_SELECT_BANK(a,x)  { SMC_outw((a), (x), BANK_SELECT ); }
757 
758 /* this enables an interrupt in the interrupt mask register */
759 #define SMC_ENABLE_INT(a,x) {\
760 		unsigned char mask;\
761 		SMC_SELECT_BANK((a),2);\
762 		mask = SMC_inb((a), IM_REG );\
763 		mask |= (x);\
764 		SMC_outb( (a), mask, IM_REG ); \
765 }
766 
767 /* this disables an interrupt from the interrupt mask register */
768 
769 #define SMC_DISABLE_INT(a,x) {\
770 		unsigned char mask;\
771 		SMC_SELECT_BANK(2);\
772 		mask = SMC_inb( (a), IM_REG );\
773 		mask &= ~(x);\
774 		SMC_outb( (a), mask, IM_REG ); \
775 }
776 
777 /*----------------------------------------------------------------------
778  . Define the interrupts that I want to receive from the card
779  .
780  . I want:
781  .  IM_EPH_INT, for nasty errors
782  .  IM_RCV_INT, for happy received packets
783  .  IM_RX_OVRN_INT, because I have to kick the receiver
784  .  IM_MDINT, for PHY Register 18 Status Changes
785  --------------------------------------------------------------------------*/
786 #define SMC_INTERRUPT_MASK   (IM_EPH_INT | IM_RX_OVRN_INT | IM_RCV_INT | \
787 	IM_MDINT)
788 
789 #endif  /* _SMC_91111_H_ */
790