xref: /OK3568_Linux_fs/u-boot/drivers/net/lan91c96.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /*------------------------------------------------------------------------
2*4882a593Smuzhiyun  * lan91c96.h
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * (C) Copyright 2002
5*4882a593Smuzhiyun  * Sysgo Real-Time Solutions, GmbH <www.elinos.com>
6*4882a593Smuzhiyun  * Rolf Offermanns <rof@sysgo.de>
7*4882a593Smuzhiyun  * Copyright (C) 2001 Standard Microsystems Corporation (SMSC)
8*4882a593Smuzhiyun  *       Developed by Simple Network Magic Corporation (SNMC)
9*4882a593Smuzhiyun  * Copyright (C) 1996 by Erik Stahlman (ES)
10*4882a593Smuzhiyun  *
11*4882a593Smuzhiyun  * SPDX-License-Identifier:	GPL-2.0+
12*4882a593Smuzhiyun  *
13*4882a593Smuzhiyun  * This file contains register information and access macros for
14*4882a593Smuzhiyun  * the LAN91C96 single chip ethernet controller.  It is a modified
15*4882a593Smuzhiyun  * version of the smc9111.h file.
16*4882a593Smuzhiyun  *
17*4882a593Smuzhiyun  * Information contained in this file was obtained from the LAN91C96
18*4882a593Smuzhiyun  * manual from SMC. To get a copy, if you really want one, you can find
19*4882a593Smuzhiyun  * information under www.smsc.com.
20*4882a593Smuzhiyun  *
21*4882a593Smuzhiyun  * Authors
22*4882a593Smuzhiyun  *	Erik Stahlman				( erik@vt.edu )
23*4882a593Smuzhiyun  *	Daris A Nevil				( dnevil@snmc.com )
24*4882a593Smuzhiyun  *
25*4882a593Smuzhiyun  * History
26*4882a593Smuzhiyun  * 04/30/03	Mathijs Haarman		Modified smc91111.h (u-boot version)
27*4882a593Smuzhiyun  *		                        for lan91c96
28*4882a593Smuzhiyun  *-------------------------------------------------------------------------
29*4882a593Smuzhiyun  */
30*4882a593Smuzhiyun #ifndef _LAN91C96_H_
31*4882a593Smuzhiyun #define _LAN91C96_H_
32*4882a593Smuzhiyun 
33*4882a593Smuzhiyun #include <asm/types.h>
34*4882a593Smuzhiyun #include <asm/io.h>
35*4882a593Smuzhiyun #include <config.h>
36*4882a593Smuzhiyun 
37*4882a593Smuzhiyun /* I want some simple types */
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun typedef unsigned char			byte;
40*4882a593Smuzhiyun typedef unsigned short			word;
41*4882a593Smuzhiyun typedef unsigned long int		dword;
42*4882a593Smuzhiyun 
43*4882a593Smuzhiyun /*
44*4882a593Smuzhiyun  * DEBUGGING LEVELS
45*4882a593Smuzhiyun  *
46*4882a593Smuzhiyun  * 0 for normal operation
47*4882a593Smuzhiyun  * 1 for slightly more details
48*4882a593Smuzhiyun  * >2 for various levels of increasingly useless information
49*4882a593Smuzhiyun  *    2 for interrupt tracking, status flags
50*4882a593Smuzhiyun  *    3 for packet info
51*4882a593Smuzhiyun  *    4 for complete packet dumps
52*4882a593Smuzhiyun  */
53*4882a593Smuzhiyun /*#define SMC_DEBUG 0 */
54*4882a593Smuzhiyun 
55*4882a593Smuzhiyun /* Because of bank switching, the LAN91xxx uses only 16 I/O ports */
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun #define	SMC_IO_EXTENT	16
58*4882a593Smuzhiyun 
59*4882a593Smuzhiyun #ifdef CONFIG_CPU_PXA25X
60*4882a593Smuzhiyun 
61*4882a593Smuzhiyun #define	SMC_IO_SHIFT	0
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun #define	SMCREG(edev, r)	((edev)->iobase+((r)<<SMC_IO_SHIFT))
64*4882a593Smuzhiyun 
65*4882a593Smuzhiyun #define	SMC_inl(edev, r)	(*((volatile dword *)SMCREG(edev, r)))
66*4882a593Smuzhiyun #define	SMC_inw(edev, r)	(*((volatile word *)SMCREG(edev, r)))
67*4882a593Smuzhiyun #define SMC_inb(edev, p) ({ \
68*4882a593Smuzhiyun 	unsigned int __p = p; \
69*4882a593Smuzhiyun 	unsigned int __v = SMC_inw(edev, __p & ~1); \
70*4882a593Smuzhiyun 	if (__p & 1) __v >>= 8; \
71*4882a593Smuzhiyun 	else __v &= 0xff; \
72*4882a593Smuzhiyun 	__v; })
73*4882a593Smuzhiyun 
74*4882a593Smuzhiyun #define	SMC_outl(edev, d, r)	(*((volatile dword *)SMCREG(edev, r)) = d)
75*4882a593Smuzhiyun #define	SMC_outw(edev, d, r)	(*((volatile word *)SMCREG(edev, r)) = d)
76*4882a593Smuzhiyun #define	SMC_outb(edev, d, r)	({	word __d = (byte)(d);  \
77*4882a593Smuzhiyun 				word __w = SMC_inw(edev, (r)&~1);  \
78*4882a593Smuzhiyun 				__w &= ((r)&1) ? 0x00FF : 0xFF00;  \
79*4882a593Smuzhiyun 				__w |= ((r)&1) ? __d<<8 : __d;  \
80*4882a593Smuzhiyun 				SMC_outw(edev, __w, (r)&~1);  \
81*4882a593Smuzhiyun 			})
82*4882a593Smuzhiyun 
83*4882a593Smuzhiyun #define SMC_outsl(edev, r, b, l)	({	int __i; \
84*4882a593Smuzhiyun 					dword *__b2; \
85*4882a593Smuzhiyun 					__b2 = (dword *) b; \
86*4882a593Smuzhiyun 					for (__i = 0; __i < l; __i++) { \
87*4882a593Smuzhiyun 						SMC_outl(edev, *(__b2 + __i),\
88*4882a593Smuzhiyun 							r); \
89*4882a593Smuzhiyun 					} \
90*4882a593Smuzhiyun 				})
91*4882a593Smuzhiyun 
92*4882a593Smuzhiyun #define SMC_outsw(edev, r, b, l)	({	int __i; \
93*4882a593Smuzhiyun 					word *__b2; \
94*4882a593Smuzhiyun 					__b2 = (word *) b; \
95*4882a593Smuzhiyun 					for (__i = 0; __i < l; __i++) { \
96*4882a593Smuzhiyun 						SMC_outw(edev, *(__b2 + __i),\
97*4882a593Smuzhiyun 							r); \
98*4882a593Smuzhiyun 					} \
99*4882a593Smuzhiyun 				})
100*4882a593Smuzhiyun 
101*4882a593Smuzhiyun #define SMC_insl(edev, r, b, l)		({	int __i ;  \
102*4882a593Smuzhiyun 					dword *__b2;  \
103*4882a593Smuzhiyun 					__b2 = (dword *) b;  \
104*4882a593Smuzhiyun 					for (__i = 0; __i < l; __i++) {  \
105*4882a593Smuzhiyun 						*(__b2 + __i) = SMC_inl(edev,\
106*4882a593Smuzhiyun 							r);  \
107*4882a593Smuzhiyun 						SMC_inl(edev, 0);  \
108*4882a593Smuzhiyun 					};  \
109*4882a593Smuzhiyun 				})
110*4882a593Smuzhiyun 
111*4882a593Smuzhiyun #define SMC_insw(edev, r, b, l)		({	int __i ;  \
112*4882a593Smuzhiyun 					word *__b2;  \
113*4882a593Smuzhiyun 					__b2 = (word *) b;  \
114*4882a593Smuzhiyun 					for (__i = 0; __i < l; __i++) {  \
115*4882a593Smuzhiyun 						*(__b2 + __i) = SMC_inw(edev,\
116*4882a593Smuzhiyun 							r);  \
117*4882a593Smuzhiyun 						SMC_inw(edev, 0);  \
118*4882a593Smuzhiyun 					};  \
119*4882a593Smuzhiyun 				})
120*4882a593Smuzhiyun 
121*4882a593Smuzhiyun #define SMC_insb(edev, r, b, l)		({	int __i ;  \
122*4882a593Smuzhiyun 					byte *__b2;  \
123*4882a593Smuzhiyun 					__b2 = (byte *) b;  \
124*4882a593Smuzhiyun 					for (__i = 0; __i < l; __i++) {  \
125*4882a593Smuzhiyun 						*(__b2 + __i) = SMC_inb(edev,\
126*4882a593Smuzhiyun 							r);  \
127*4882a593Smuzhiyun 						SMC_inb(edev, 0);  \
128*4882a593Smuzhiyun 					};  \
129*4882a593Smuzhiyun 				})
130*4882a593Smuzhiyun 
131*4882a593Smuzhiyun #else /* if not CONFIG_CPU_PXA25X */
132*4882a593Smuzhiyun 
133*4882a593Smuzhiyun /*
134*4882a593Smuzhiyun  * We have only 16 Bit PCMCIA access on Socket 0
135*4882a593Smuzhiyun  */
136*4882a593Smuzhiyun 
137*4882a593Smuzhiyun #define	SMC_inw(edev, r)	(*((volatile word *)((edev)->iobase+(r))))
138*4882a593Smuzhiyun #define  SMC_inb(edev, r)	(((r)&1) ? SMC_inw(edev, (r)&~1)>>8 :\
139*4882a593Smuzhiyun 					SMC_inw(edev, r)&0xFF)
140*4882a593Smuzhiyun 
141*4882a593Smuzhiyun #define	SMC_outw(edev, d, r)	(*((volatile word *)((edev)->iobase+(r))) = d)
142*4882a593Smuzhiyun #define	SMC_outb(edev, d, r)	({	word __d = (byte)(d);  \
143*4882a593Smuzhiyun 				word __w = SMC_inw(edev, (r)&~1);  \
144*4882a593Smuzhiyun 				__w &= ((r)&1) ? 0x00FF : 0xFF00;  \
145*4882a593Smuzhiyun 				__w |= ((r)&1) ? __d<<8 : __d;  \
146*4882a593Smuzhiyun 				SMC_outw(edev, __w, (r)&~1);  \
147*4882a593Smuzhiyun 			})
148*4882a593Smuzhiyun #define SMC_outsw(edev, r, b, l)	({	int __i; \
149*4882a593Smuzhiyun 					word *__b2; \
150*4882a593Smuzhiyun 					__b2 = (word *) b; \
151*4882a593Smuzhiyun 					for (__i = 0; __i < l; __i++) { \
152*4882a593Smuzhiyun 						SMC_outw(edev, *(__b2 + __i),\
153*4882a593Smuzhiyun 							r); \
154*4882a593Smuzhiyun 					} \
155*4882a593Smuzhiyun 				})
156*4882a593Smuzhiyun 
157*4882a593Smuzhiyun #define SMC_insw(edev, r, b, l)	({	int __i ;  \
158*4882a593Smuzhiyun 					word *__b2;  \
159*4882a593Smuzhiyun 					__b2 = (word *) b;  \
160*4882a593Smuzhiyun 					for (__i = 0; __i < l; __i++) {  \
161*4882a593Smuzhiyun 						*(__b2 + __i) = SMC_inw(edev,\
162*4882a593Smuzhiyun 							r);  \
163*4882a593Smuzhiyun 						SMC_inw(edev, 0);  \
164*4882a593Smuzhiyun 					};  \
165*4882a593Smuzhiyun 				})
166*4882a593Smuzhiyun 
167*4882a593Smuzhiyun #endif
168*4882a593Smuzhiyun 
169*4882a593Smuzhiyun /*
170*4882a593Smuzhiyun  ****************************************************************************
171*4882a593Smuzhiyun  *	Bank Select Field
172*4882a593Smuzhiyun  ****************************************************************************
173*4882a593Smuzhiyun  */
174*4882a593Smuzhiyun #define LAN91C96_BANK_SELECT  14       /* Bank Select Register */
175*4882a593Smuzhiyun #define LAN91C96_BANKSELECT (0x3UC << 0)
176*4882a593Smuzhiyun #define BANK0               0x00
177*4882a593Smuzhiyun #define BANK1               0x01
178*4882a593Smuzhiyun #define BANK2               0x02
179*4882a593Smuzhiyun #define BANK3               0x03
180*4882a593Smuzhiyun #define BANK4               0x04
181*4882a593Smuzhiyun 
182*4882a593Smuzhiyun /*
183*4882a593Smuzhiyun  ****************************************************************************
184*4882a593Smuzhiyun  *	EEPROM Addresses.
185*4882a593Smuzhiyun  ****************************************************************************
186*4882a593Smuzhiyun  */
187*4882a593Smuzhiyun #define EEPROM_MAC_OFFSET_1    0x6020
188*4882a593Smuzhiyun #define EEPROM_MAC_OFFSET_2    0x6021
189*4882a593Smuzhiyun #define EEPROM_MAC_OFFSET_3    0x6022
190*4882a593Smuzhiyun 
191*4882a593Smuzhiyun /*
192*4882a593Smuzhiyun  ****************************************************************************
193*4882a593Smuzhiyun  *	Bank 0 Register Map in I/O Space
194*4882a593Smuzhiyun  ****************************************************************************
195*4882a593Smuzhiyun  */
196*4882a593Smuzhiyun #define LAN91C96_TCR          0        /* Transmit Control Register */
197*4882a593Smuzhiyun #define LAN91C96_EPH_STATUS   2        /* EPH Status Register */
198*4882a593Smuzhiyun #define LAN91C96_RCR          4        /* Receive Control Register */
199*4882a593Smuzhiyun #define LAN91C96_COUNTER      6        /* Counter Register */
200*4882a593Smuzhiyun #define LAN91C96_MIR          8        /* Memory Information Register */
201*4882a593Smuzhiyun #define LAN91C96_MCR          10       /* Memory Configuration Register */
202*4882a593Smuzhiyun 
203*4882a593Smuzhiyun /*
204*4882a593Smuzhiyun  ****************************************************************************
205*4882a593Smuzhiyun  *	Transmit Control Register - Bank 0 - Offset 0
206*4882a593Smuzhiyun  ****************************************************************************
207*4882a593Smuzhiyun  */
208*4882a593Smuzhiyun #define LAN91C96_TCR_TXENA        (0x1U << 0)
209*4882a593Smuzhiyun #define LAN91C96_TCR_LOOP         (0x1U << 1)
210*4882a593Smuzhiyun #define LAN91C96_TCR_FORCOL       (0x1U << 2)
211*4882a593Smuzhiyun #define LAN91C96_TCR_TXP_EN       (0x1U << 3)
212*4882a593Smuzhiyun #define LAN91C96_TCR_PAD_EN       (0x1U << 7)
213*4882a593Smuzhiyun #define LAN91C96_TCR_NOCRC        (0x1U << 8)
214*4882a593Smuzhiyun #define LAN91C96_TCR_MON_CSN      (0x1U << 10)
215*4882a593Smuzhiyun #define LAN91C96_TCR_FDUPLX       (0x1U << 11)
216*4882a593Smuzhiyun #define LAN91C96_TCR_STP_SQET     (0x1U << 12)
217*4882a593Smuzhiyun #define LAN91C96_TCR_EPH_LOOP     (0x1U << 13)
218*4882a593Smuzhiyun #define LAN91C96_TCR_ETEN_TYPE    (0x1U << 14)
219*4882a593Smuzhiyun #define LAN91C96_TCR_FDSE         (0x1U << 15)
220*4882a593Smuzhiyun 
221*4882a593Smuzhiyun /*
222*4882a593Smuzhiyun  ****************************************************************************
223*4882a593Smuzhiyun  *	EPH Status Register - Bank 0 - Offset 2
224*4882a593Smuzhiyun  ****************************************************************************
225*4882a593Smuzhiyun  */
226*4882a593Smuzhiyun #define LAN91C96_EPHSR_TX_SUC     (0x1U << 0)
227*4882a593Smuzhiyun #define LAN91C96_EPHSR_SNGL_COL   (0x1U << 1)
228*4882a593Smuzhiyun #define LAN91C96_EPHSR_MUL_COL    (0x1U << 2)
229*4882a593Smuzhiyun #define LAN91C96_EPHSR_LTX_MULT   (0x1U << 3)
230*4882a593Smuzhiyun #define LAN91C96_EPHSR_16COL      (0x1U << 4)
231*4882a593Smuzhiyun #define LAN91C96_EPHSR_SQET       (0x1U << 5)
232*4882a593Smuzhiyun #define LAN91C96_EPHSR_LTX_BRD    (0x1U << 6)
233*4882a593Smuzhiyun #define LAN91C96_EPHSR_TX_DEFR    (0x1U << 7)
234*4882a593Smuzhiyun #define LAN91C96_EPHSR_WAKEUP     (0x1U << 8)
235*4882a593Smuzhiyun #define LAN91C96_EPHSR_LATCOL     (0x1U << 9)
236*4882a593Smuzhiyun #define LAN91C96_EPHSR_LOST_CARR  (0x1U << 10)
237*4882a593Smuzhiyun #define LAN91C96_EPHSR_EXC_DEF    (0x1U << 11)
238*4882a593Smuzhiyun #define LAN91C96_EPHSR_CTR_ROL    (0x1U << 12)
239*4882a593Smuzhiyun 
240*4882a593Smuzhiyun #define LAN91C96_EPHSR_LINK_OK    (0x1U << 14)
241*4882a593Smuzhiyun #define LAN91C96_EPHSR_TX_UNRN    (0x1U << 15)
242*4882a593Smuzhiyun 
243*4882a593Smuzhiyun #define LAN91C96_EPHSR_ERRORS     (LAN91C96_EPHSR_SNGL_COL  |    \
244*4882a593Smuzhiyun 				   LAN91C96_EPHSR_MUL_COL   |    \
245*4882a593Smuzhiyun 				   LAN91C96_EPHSR_16COL     |    \
246*4882a593Smuzhiyun 				   LAN91C96_EPHSR_SQET      |    \
247*4882a593Smuzhiyun 				   LAN91C96_EPHSR_TX_DEFR   |    \
248*4882a593Smuzhiyun 				   LAN91C96_EPHSR_LATCOL    |    \
249*4882a593Smuzhiyun 				   LAN91C96_EPHSR_LOST_CARR |    \
250*4882a593Smuzhiyun 				   LAN91C96_EPHSR_EXC_DEF   |    \
251*4882a593Smuzhiyun 				   LAN91C96_EPHSR_LINK_OK   |    \
252*4882a593Smuzhiyun 				   LAN91C96_EPHSR_TX_UNRN)
253*4882a593Smuzhiyun 
254*4882a593Smuzhiyun /*
255*4882a593Smuzhiyun  ****************************************************************************
256*4882a593Smuzhiyun  *	Receive Control Register - Bank 0 - Offset 4
257*4882a593Smuzhiyun  ****************************************************************************
258*4882a593Smuzhiyun  */
259*4882a593Smuzhiyun #define LAN91C96_RCR_RX_ABORT     (0x1U << 0)
260*4882a593Smuzhiyun #define LAN91C96_RCR_PRMS         (0x1U << 1)
261*4882a593Smuzhiyun #define LAN91C96_RCR_ALMUL        (0x1U << 2)
262*4882a593Smuzhiyun #define LAN91C96_RCR_RXEN         (0x1U << 8)
263*4882a593Smuzhiyun #define LAN91C96_RCR_STRIP_CRC    (0x1U << 9)
264*4882a593Smuzhiyun #define LAN91C96_RCR_FILT_CAR     (0x1U << 14)
265*4882a593Smuzhiyun #define LAN91C96_RCR_SOFT_RST     (0x1U << 15)
266*4882a593Smuzhiyun 
267*4882a593Smuzhiyun /*
268*4882a593Smuzhiyun  ****************************************************************************
269*4882a593Smuzhiyun  *	Counter Register - Bank 0 - Offset 6
270*4882a593Smuzhiyun  ****************************************************************************
271*4882a593Smuzhiyun  */
272*4882a593Smuzhiyun #define LAN91C96_ECR_SNGL_COL     (0xFU << 0)
273*4882a593Smuzhiyun #define LAN91C96_ECR_MULT_COL     (0xFU << 5)
274*4882a593Smuzhiyun #define LAN91C96_ECR_DEF_TX       (0xFU << 8)
275*4882a593Smuzhiyun #define LAN91C96_ECR_EXC_DEF_TX   (0xFU << 12)
276*4882a593Smuzhiyun 
277*4882a593Smuzhiyun /*
278*4882a593Smuzhiyun  ****************************************************************************
279*4882a593Smuzhiyun  *	Memory Information Register - Bank 0 - OFfset 8
280*4882a593Smuzhiyun  ****************************************************************************
281*4882a593Smuzhiyun  */
282*4882a593Smuzhiyun #define LAN91C96_MIR_SIZE        (0x18 << 0)    /* 6144 bytes */
283*4882a593Smuzhiyun 
284*4882a593Smuzhiyun /*
285*4882a593Smuzhiyun  ****************************************************************************
286*4882a593Smuzhiyun  *	Memory Configuration Register - Bank 0 - Offset 10
287*4882a593Smuzhiyun  ****************************************************************************
288*4882a593Smuzhiyun  */
289*4882a593Smuzhiyun #define LAN91C96_MCR_MEM_RES      (0xFFU << 0)
290*4882a593Smuzhiyun #define LAN91C96_MCR_MEM_MULT     (0x3U << 9)
291*4882a593Smuzhiyun #define LAN91C96_MCR_HIGH_ID      (0x3U << 12)
292*4882a593Smuzhiyun 
293*4882a593Smuzhiyun #define LAN91C96_MCR_TRANSMIT_PAGES 0x6
294*4882a593Smuzhiyun 
295*4882a593Smuzhiyun /*
296*4882a593Smuzhiyun  ****************************************************************************
297*4882a593Smuzhiyun  *	Bank 1 Register Map in I/O Space
298*4882a593Smuzhiyun  ****************************************************************************
299*4882a593Smuzhiyun  */
300*4882a593Smuzhiyun #define LAN91C96_CONFIG       0        /* Configuration Register */
301*4882a593Smuzhiyun #define LAN91C96_BASE         2        /* Base Address Register */
302*4882a593Smuzhiyun #define LAN91C96_IA0          4        /* Individual Address Register - 0 */
303*4882a593Smuzhiyun #define LAN91C96_IA1          5        /* Individual Address Register - 1 */
304*4882a593Smuzhiyun #define LAN91C96_IA2          6        /* Individual Address Register - 2 */
305*4882a593Smuzhiyun #define LAN91C96_IA3          7        /* Individual Address Register - 3 */
306*4882a593Smuzhiyun #define LAN91C96_IA4          8        /* Individual Address Register - 4 */
307*4882a593Smuzhiyun #define LAN91C96_IA5          9        /* Individual Address Register - 5 */
308*4882a593Smuzhiyun #define LAN91C96_GEN_PURPOSE  10       /* General Address Registers */
309*4882a593Smuzhiyun #define LAN91C96_CONTROL      12       /* Control Register */
310*4882a593Smuzhiyun 
311*4882a593Smuzhiyun /*
312*4882a593Smuzhiyun  ****************************************************************************
313*4882a593Smuzhiyun  *	Configuration Register - Bank 1 - Offset 0
314*4882a593Smuzhiyun  ****************************************************************************
315*4882a593Smuzhiyun  */
316*4882a593Smuzhiyun #define LAN91C96_CR_INT_SEL0      (0x1U << 1)
317*4882a593Smuzhiyun #define LAN91C96_CR_INT_SEL1      (0x1U << 2)
318*4882a593Smuzhiyun #define LAN91C96_CR_RES           (0x3U << 3)
319*4882a593Smuzhiyun #define LAN91C96_CR_DIS_LINK      (0x1U << 6)
320*4882a593Smuzhiyun #define LAN91C96_CR_16BIT         (0x1U << 7)
321*4882a593Smuzhiyun #define LAN91C96_CR_AUI_SELECT    (0x1U << 8)
322*4882a593Smuzhiyun #define LAN91C96_CR_SET_SQLCH     (0x1U << 9)
323*4882a593Smuzhiyun #define LAN91C96_CR_FULL_STEP     (0x1U << 10)
324*4882a593Smuzhiyun #define LAN91C96_CR_NO_WAIT       (0x1U << 12)
325*4882a593Smuzhiyun 
326*4882a593Smuzhiyun /*
327*4882a593Smuzhiyun  ****************************************************************************
328*4882a593Smuzhiyun  *	Base Address Register - Bank 1 - Offset 2
329*4882a593Smuzhiyun  ****************************************************************************
330*4882a593Smuzhiyun  */
331*4882a593Smuzhiyun #define LAN91C96_BAR_RA_BITS      (0x27U << 0)
332*4882a593Smuzhiyun #define LAN91C96_BAR_ROM_SIZE     (0x1U << 6)
333*4882a593Smuzhiyun #define LAN91C96_BAR_A_BITS       (0xFFU << 8)
334*4882a593Smuzhiyun 
335*4882a593Smuzhiyun /*
336*4882a593Smuzhiyun  ****************************************************************************
337*4882a593Smuzhiyun  *	Control Register - Bank 1 - Offset 12
338*4882a593Smuzhiyun  ****************************************************************************
339*4882a593Smuzhiyun  */
340*4882a593Smuzhiyun #define LAN91C96_CTR_STORE        (0x1U << 0)
341*4882a593Smuzhiyun #define LAN91C96_CTR_RELOAD       (0x1U << 1)
342*4882a593Smuzhiyun #define LAN91C96_CTR_EEPROM       (0x1U << 2)
343*4882a593Smuzhiyun #define LAN91C96_CTR_TE_ENABLE    (0x1U << 5)
344*4882a593Smuzhiyun #define LAN91C96_CTR_CR_ENABLE    (0x1U << 6)
345*4882a593Smuzhiyun #define LAN91C96_CTR_LE_ENABLE    (0x1U << 7)
346*4882a593Smuzhiyun #define LAN91C96_CTR_BIT_8        (0x1U << 8)
347*4882a593Smuzhiyun #define LAN91C96_CTR_AUTO_RELEASE (0x1U << 11)
348*4882a593Smuzhiyun #define LAN91C96_CTR_WAKEUP_EN    (0x1U << 12)
349*4882a593Smuzhiyun #define LAN91C96_CTR_PWRDN        (0x1U << 13)
350*4882a593Smuzhiyun #define LAN91C96_CTR_RCV_BAD      (0x1U << 14)
351*4882a593Smuzhiyun 
352*4882a593Smuzhiyun /*
353*4882a593Smuzhiyun  ****************************************************************************
354*4882a593Smuzhiyun  *	Bank 2 Register Map in I/O Space
355*4882a593Smuzhiyun  ****************************************************************************
356*4882a593Smuzhiyun  */
357*4882a593Smuzhiyun #define LAN91C96_MMU            0      /* MMU Command Register */
358*4882a593Smuzhiyun #define LAN91C96_AUTO_TX_START  1      /* Auto Tx Start Register */
359*4882a593Smuzhiyun #define LAN91C96_PNR            2      /* Packet Number Register */
360*4882a593Smuzhiyun #define LAN91C96_ARR            3      /* Allocation Result Register */
361*4882a593Smuzhiyun #define LAN91C96_FIFO           4      /* FIFO Ports Register */
362*4882a593Smuzhiyun #define LAN91C96_POINTER        6      /* Pointer Register */
363*4882a593Smuzhiyun #define LAN91C96_DATA_HIGH      8      /* Data High Register */
364*4882a593Smuzhiyun #define LAN91C96_DATA_LOW       10     /* Data Low Register */
365*4882a593Smuzhiyun #define LAN91C96_INT_STATS      12     /* Interrupt Status Register - RO */
366*4882a593Smuzhiyun #define LAN91C96_INT_ACK        12     /* Interrupt Acknowledge Register -WO */
367*4882a593Smuzhiyun #define LAN91C96_INT_MASK       13     /* Interrupt Mask Register */
368*4882a593Smuzhiyun 
369*4882a593Smuzhiyun /*
370*4882a593Smuzhiyun  ****************************************************************************
371*4882a593Smuzhiyun  *	MMU Command Register - Bank 2 - Offset 0
372*4882a593Smuzhiyun  ****************************************************************************
373*4882a593Smuzhiyun  */
374*4882a593Smuzhiyun #define LAN91C96_MMUCR_NO_BUSY    (0x1U << 0)
375*4882a593Smuzhiyun #define LAN91C96_MMUCR_N1         (0x1U << 1)
376*4882a593Smuzhiyun #define LAN91C96_MMUCR_N2         (0x1U << 2)
377*4882a593Smuzhiyun #define LAN91C96_MMUCR_COMMAND    (0xFU << 4)
378*4882a593Smuzhiyun #define LAN91C96_MMUCR_ALLOC_TX   (0x2U << 4)    /* WXYZ = 0010 */
379*4882a593Smuzhiyun #define LAN91C96_MMUCR_RESET_MMU  (0x4U << 4)    /* WXYZ = 0100 */
380*4882a593Smuzhiyun #define LAN91C96_MMUCR_REMOVE_RX  (0x6U << 4)    /* WXYZ = 0110 */
381*4882a593Smuzhiyun #define LAN91C96_MMUCR_REMOVE_TX  (0x7U << 4)    /* WXYZ = 0111 */
382*4882a593Smuzhiyun #define LAN91C96_MMUCR_RELEASE_RX (0x8U << 4)    /* WXYZ = 1000 */
383*4882a593Smuzhiyun #define LAN91C96_MMUCR_RELEASE_TX (0xAU << 4)    /* WXYZ = 1010 */
384*4882a593Smuzhiyun #define LAN91C96_MMUCR_ENQUEUE    (0xCU << 4)    /* WXYZ = 1100 */
385*4882a593Smuzhiyun #define LAN91C96_MMUCR_RESET_TX   (0xEU << 4)    /* WXYZ = 1110 */
386*4882a593Smuzhiyun 
387*4882a593Smuzhiyun /*
388*4882a593Smuzhiyun  ****************************************************************************
389*4882a593Smuzhiyun  *	Auto Tx Start Register - Bank 2 - Offset 1
390*4882a593Smuzhiyun  ****************************************************************************
391*4882a593Smuzhiyun  */
392*4882a593Smuzhiyun #define LAN91C96_AUTOTX           (0xFFU << 0)
393*4882a593Smuzhiyun 
394*4882a593Smuzhiyun /*
395*4882a593Smuzhiyun  ****************************************************************************
396*4882a593Smuzhiyun  *	Packet Number Register - Bank 2 - Offset 2
397*4882a593Smuzhiyun  ****************************************************************************
398*4882a593Smuzhiyun  */
399*4882a593Smuzhiyun #define LAN91C96_PNR_TX           (0x1FU << 0)
400*4882a593Smuzhiyun 
401*4882a593Smuzhiyun /*
402*4882a593Smuzhiyun  ****************************************************************************
403*4882a593Smuzhiyun  *	Allocation Result Register - Bank 2 - Offset 3
404*4882a593Smuzhiyun  ****************************************************************************
405*4882a593Smuzhiyun  */
406*4882a593Smuzhiyun #define LAN91C96_ARR_ALLOC_PN     (0x7FU << 0)
407*4882a593Smuzhiyun #define LAN91C96_ARR_FAILED       (0x1U << 7)
408*4882a593Smuzhiyun 
409*4882a593Smuzhiyun /*
410*4882a593Smuzhiyun  ****************************************************************************
411*4882a593Smuzhiyun  *	FIFO Ports Register - Bank 2 - Offset 4
412*4882a593Smuzhiyun  ****************************************************************************
413*4882a593Smuzhiyun  */
414*4882a593Smuzhiyun #define LAN91C96_FIFO_TX_DONE_PN  (0x1FU << 0)
415*4882a593Smuzhiyun #define LAN91C96_FIFO_TEMPTY      (0x1U << 7)
416*4882a593Smuzhiyun #define LAN91C96_FIFO_RX_DONE_PN  (0x1FU << 8)
417*4882a593Smuzhiyun #define LAN91C96_FIFO_RXEMPTY     (0x1U << 15)
418*4882a593Smuzhiyun 
419*4882a593Smuzhiyun /*
420*4882a593Smuzhiyun  ****************************************************************************
421*4882a593Smuzhiyun  *	Pointer Register - Bank 2 - Offset 6
422*4882a593Smuzhiyun  ****************************************************************************
423*4882a593Smuzhiyun  */
424*4882a593Smuzhiyun #define LAN91C96_PTR_LOW          (0xFFU << 0)
425*4882a593Smuzhiyun #define LAN91C96_PTR_HIGH         (0x7U << 8)
426*4882a593Smuzhiyun #define LAN91C96_PTR_AUTO_TX      (0x1U << 11)
427*4882a593Smuzhiyun #define LAN91C96_PTR_ETEN         (0x1U << 12)
428*4882a593Smuzhiyun #define LAN91C96_PTR_READ         (0x1U << 13)
429*4882a593Smuzhiyun #define LAN91C96_PTR_AUTO_INCR    (0x1U << 14)
430*4882a593Smuzhiyun #define LAN91C96_PTR_RCV          (0x1U << 15)
431*4882a593Smuzhiyun 
432*4882a593Smuzhiyun #define LAN91C96_PTR_RX_FRAME     (LAN91C96_PTR_RCV       |    \
433*4882a593Smuzhiyun 				   LAN91C96_PTR_AUTO_INCR |    \
434*4882a593Smuzhiyun 				   LAN91C96_PTR_READ)
435*4882a593Smuzhiyun 
436*4882a593Smuzhiyun /*
437*4882a593Smuzhiyun  ****************************************************************************
438*4882a593Smuzhiyun  *	Data Register - Bank 2 - Offset 8
439*4882a593Smuzhiyun  ****************************************************************************
440*4882a593Smuzhiyun  */
441*4882a593Smuzhiyun #define LAN91C96_CONTROL_CRC      (0x1U << 4)    /* CRC bit */
442*4882a593Smuzhiyun #define LAN91C96_CONTROL_ODD      (0x1U << 5)    /* ODD bit */
443*4882a593Smuzhiyun 
444*4882a593Smuzhiyun /*
445*4882a593Smuzhiyun  ****************************************************************************
446*4882a593Smuzhiyun  *	Interrupt Status Register - Bank 2 - Offset 12
447*4882a593Smuzhiyun  ****************************************************************************
448*4882a593Smuzhiyun  */
449*4882a593Smuzhiyun #define LAN91C96_IST_RCV_INT      (0x1U << 0)
450*4882a593Smuzhiyun #define LAN91C96_IST_TX_INT       (0x1U << 1)
451*4882a593Smuzhiyun #define LAN91C96_IST_TX_EMPTY_INT (0x1U << 2)
452*4882a593Smuzhiyun #define LAN91C96_IST_ALLOC_INT    (0x1U << 3)
453*4882a593Smuzhiyun #define LAN91C96_IST_RX_OVRN_INT  (0x1U << 4)
454*4882a593Smuzhiyun #define LAN91C96_IST_EPH_INT      (0x1U << 5)
455*4882a593Smuzhiyun #define LAN91C96_IST_ERCV_INT     (0x1U << 6)
456*4882a593Smuzhiyun #define LAN91C96_IST_RX_IDLE_INT  (0x1U << 7)
457*4882a593Smuzhiyun 
458*4882a593Smuzhiyun /*
459*4882a593Smuzhiyun  ****************************************************************************
460*4882a593Smuzhiyun  *	Interrupt Acknowledge Register - Bank 2 - Offset 12
461*4882a593Smuzhiyun  ****************************************************************************
462*4882a593Smuzhiyun  */
463*4882a593Smuzhiyun #define LAN91C96_ACK_TX_INT       (0x1U << 1)
464*4882a593Smuzhiyun #define LAN91C96_ACK_TX_EMPTY_INT (0x1U << 2)
465*4882a593Smuzhiyun #define LAN91C96_ACK_RX_OVRN_INT  (0x1U << 4)
466*4882a593Smuzhiyun #define LAN91C96_ACK_ERCV_INT     (0x1U << 6)
467*4882a593Smuzhiyun 
468*4882a593Smuzhiyun /*
469*4882a593Smuzhiyun  ****************************************************************************
470*4882a593Smuzhiyun  *	Interrupt Mask Register - Bank 2 - Offset 13
471*4882a593Smuzhiyun  ****************************************************************************
472*4882a593Smuzhiyun  */
473*4882a593Smuzhiyun #define LAN91C96_MSK_RCV_INT      (0x1U << 0)
474*4882a593Smuzhiyun #define LAN91C96_MSK_TX_INT       (0x1U << 1)
475*4882a593Smuzhiyun #define LAN91C96_MSK_TX_EMPTY_INT (0x1U << 2)
476*4882a593Smuzhiyun #define LAN91C96_MSK_ALLOC_INT    (0x1U << 3)
477*4882a593Smuzhiyun #define LAN91C96_MSK_RX_OVRN_INT  (0x1U << 4)
478*4882a593Smuzhiyun #define LAN91C96_MSK_EPH_INT      (0x1U << 5)
479*4882a593Smuzhiyun #define LAN91C96_MSK_ERCV_INT     (0x1U << 6)
480*4882a593Smuzhiyun #define LAN91C96_MSK_TX_IDLE_INT  (0x1U << 7)
481*4882a593Smuzhiyun 
482*4882a593Smuzhiyun /*
483*4882a593Smuzhiyun  ****************************************************************************
484*4882a593Smuzhiyun  *	Bank 3 Register Map in I/O Space
485*4882a593Smuzhiyun  **************************************************************************
486*4882a593Smuzhiyun  */
487*4882a593Smuzhiyun #define LAN91C96_MGMT_MDO         (0x1U << 0)
488*4882a593Smuzhiyun #define LAN91C96_MGMT_MDI         (0x1U << 1)
489*4882a593Smuzhiyun #define LAN91C96_MGMT_MCLK        (0x1U << 2)
490*4882a593Smuzhiyun #define LAN91C96_MGMT_MDOE        (0x1U << 3)
491*4882a593Smuzhiyun #define LAN91C96_MGMT_LOW_ID      (0x3U << 4)
492*4882a593Smuzhiyun #define LAN91C96_MGMT_IOS0        (0x1U << 8)
493*4882a593Smuzhiyun #define LAN91C96_MGMT_IOS1        (0x1U << 9)
494*4882a593Smuzhiyun #define LAN91C96_MGMT_IOS2        (0x1U << 10)
495*4882a593Smuzhiyun #define LAN91C96_MGMT_nXNDEC      (0x1U << 11)
496*4882a593Smuzhiyun #define LAN91C96_MGMT_HIGH_ID     (0x3U << 12)
497*4882a593Smuzhiyun 
498*4882a593Smuzhiyun /*
499*4882a593Smuzhiyun  ****************************************************************************
500*4882a593Smuzhiyun  *	Revision Register - Bank 3 - Offset 10
501*4882a593Smuzhiyun  ****************************************************************************
502*4882a593Smuzhiyun  */
503*4882a593Smuzhiyun #define LAN91C96_REV_REVID        (0xFU << 0)
504*4882a593Smuzhiyun #define LAN91C96_REV_CHIPID       (0xFU << 4)
505*4882a593Smuzhiyun 
506*4882a593Smuzhiyun /*
507*4882a593Smuzhiyun  ****************************************************************************
508*4882a593Smuzhiyun  *	Early RCV Register - Bank 3 - Offset 12
509*4882a593Smuzhiyun  ****************************************************************************
510*4882a593Smuzhiyun  */
511*4882a593Smuzhiyun #define LAN91C96_ERCV_THRESHOLD   (0x1FU << 0)
512*4882a593Smuzhiyun #define LAN91C96_ERCV_RCV_DISCRD  (0x1U << 7)
513*4882a593Smuzhiyun 
514*4882a593Smuzhiyun /*
515*4882a593Smuzhiyun  ****************************************************************************
516*4882a593Smuzhiyun  *	PCMCIA Configuration Registers
517*4882a593Smuzhiyun  ****************************************************************************
518*4882a593Smuzhiyun  */
519*4882a593Smuzhiyun #define LAN91C96_ECOR    0x8000        /* Ethernet Configuration Register */
520*4882a593Smuzhiyun #define LAN91C96_ECSR    0x8002        /* Ethernet Configuration and Status */
521*4882a593Smuzhiyun 
522*4882a593Smuzhiyun /*
523*4882a593Smuzhiyun  ****************************************************************************
524*4882a593Smuzhiyun  *	PCMCIA Ethernet Configuration Option Register (ECOR)
525*4882a593Smuzhiyun  ****************************************************************************
526*4882a593Smuzhiyun  */
527*4882a593Smuzhiyun #define LAN91C96_ECOR_ENABLE       (0x1U << 0)
528*4882a593Smuzhiyun #define LAN91C96_ECOR_WR_ATTRIB    (0x1U << 2)
529*4882a593Smuzhiyun #define LAN91C96_ECOR_LEVEL_REQ    (0x1U << 6)
530*4882a593Smuzhiyun #define LAN91C96_ECOR_SRESET       (0x1U << 7)
531*4882a593Smuzhiyun 
532*4882a593Smuzhiyun /*
533*4882a593Smuzhiyun  ****************************************************************************
534*4882a593Smuzhiyun  *	PCMCIA Ethernet Configuration and Status Register (ECSR)
535*4882a593Smuzhiyun  ****************************************************************************
536*4882a593Smuzhiyun  */
537*4882a593Smuzhiyun #define LAN91C96_ECSR_INTR        (0x1U << 1)
538*4882a593Smuzhiyun #define LAN91C96_ECSR_PWRDWN      (0x1U << 2)
539*4882a593Smuzhiyun #define LAN91C96_ECSR_IOIS8       (0x1U << 5)
540*4882a593Smuzhiyun 
541*4882a593Smuzhiyun /*
542*4882a593Smuzhiyun  ****************************************************************************
543*4882a593Smuzhiyun  *	Receive Frame Status Word - See page 38 of the LAN91C96 specification.
544*4882a593Smuzhiyun  ****************************************************************************
545*4882a593Smuzhiyun  */
546*4882a593Smuzhiyun #define LAN91C96_TOO_SHORT        (0x1U << 10)
547*4882a593Smuzhiyun #define LAN91C96_TOO_LONG         (0x1U << 11)
548*4882a593Smuzhiyun #define LAN91C96_ODD_FRM          (0x1U << 12)
549*4882a593Smuzhiyun #define LAN91C96_BAD_CRC          (0x1U << 13)
550*4882a593Smuzhiyun #define LAN91C96_BROD_CAST        (0x1U << 14)
551*4882a593Smuzhiyun #define LAN91C96_ALGN_ERR         (0x1U << 15)
552*4882a593Smuzhiyun 
553*4882a593Smuzhiyun #define FRAME_FILTER              (LAN91C96_TOO_SHORT | LAN91C96_TOO_LONG  | LAN91C96_BAD_CRC   | LAN91C96_ALGN_ERR)
554*4882a593Smuzhiyun 
555*4882a593Smuzhiyun /*
556*4882a593Smuzhiyun  ****************************************************************************
557*4882a593Smuzhiyun  *	Default MAC Address
558*4882a593Smuzhiyun  ****************************************************************************
559*4882a593Smuzhiyun  */
560*4882a593Smuzhiyun #define MAC_DEF_HI  0x0800
561*4882a593Smuzhiyun #define MAC_DEF_MED 0x3333
562*4882a593Smuzhiyun #define MAC_DEF_LO  0x0100
563*4882a593Smuzhiyun 
564*4882a593Smuzhiyun /*
565*4882a593Smuzhiyun  ****************************************************************************
566*4882a593Smuzhiyun  *	Default I/O Signature - 0x33
567*4882a593Smuzhiyun  ****************************************************************************
568*4882a593Smuzhiyun  */
569*4882a593Smuzhiyun #define LAN91C96_LOW_SIGNATURE        (0x33U << 0)
570*4882a593Smuzhiyun #define LAN91C96_HIGH_SIGNATURE       (0x33U << 8)
571*4882a593Smuzhiyun #define LAN91C96_SIGNATURE (LAN91C96_HIGH_SIGNATURE | LAN91C96_LOW_SIGNATURE)
572*4882a593Smuzhiyun 
573*4882a593Smuzhiyun #define LAN91C96_MAX_PAGES     6        /* Maximum number of 256 pages. */
574*4882a593Smuzhiyun #define ETHERNET_MAX_LENGTH 1514
575*4882a593Smuzhiyun 
576*4882a593Smuzhiyun 
577*4882a593Smuzhiyun /*-------------------------------------------------------------------------
578*4882a593Smuzhiyun  *  I define some macros to make it easier to do somewhat common
579*4882a593Smuzhiyun  * or slightly complicated, repeated tasks.
580*4882a593Smuzhiyun  *-------------------------------------------------------------------------
581*4882a593Smuzhiyun  */
582*4882a593Smuzhiyun 
583*4882a593Smuzhiyun /* select a register bank, 0 to 3  */
584*4882a593Smuzhiyun 
585*4882a593Smuzhiyun #define SMC_SELECT_BANK(edev, x)  { SMC_outw(edev, x, LAN91C96_BANK_SELECT); }
586*4882a593Smuzhiyun 
587*4882a593Smuzhiyun /* this enables an interrupt in the interrupt mask register */
588*4882a593Smuzhiyun #define SMC_ENABLE_INT(edev, x) {\
589*4882a593Smuzhiyun 		unsigned char mask;\
590*4882a593Smuzhiyun 		SMC_SELECT_BANK(edev, 2);\
591*4882a593Smuzhiyun 		mask = SMC_inb(edev, LAN91C96_INT_MASK);\
592*4882a593Smuzhiyun 		mask |= (x);\
593*4882a593Smuzhiyun 		SMC_outb(edev, mask, LAN91C96_INT_MASK); \
594*4882a593Smuzhiyun }
595*4882a593Smuzhiyun 
596*4882a593Smuzhiyun /* this disables an interrupt from the interrupt mask register */
597*4882a593Smuzhiyun 
598*4882a593Smuzhiyun #define SMC_DISABLE_INT(edev, x) {\
599*4882a593Smuzhiyun 		unsigned char mask;\
600*4882a593Smuzhiyun 		SMC_SELECT_BANK(edev, 2);\
601*4882a593Smuzhiyun 		mask = SMC_inb(edev, LAN91C96_INT_MASK);\
602*4882a593Smuzhiyun 		mask &= ~(x);\
603*4882a593Smuzhiyun 		SMC_outb(edev, mask, LAN91C96_INT_MASK); \
604*4882a593Smuzhiyun }
605*4882a593Smuzhiyun 
606*4882a593Smuzhiyun /*----------------------------------------------------------------------
607*4882a593Smuzhiyun  * Define the interrupts that I want to receive from the card
608*4882a593Smuzhiyun  *
609*4882a593Smuzhiyun  * I want:
610*4882a593Smuzhiyun  *  LAN91C96_IST_EPH_INT, for nasty errors
611*4882a593Smuzhiyun  *  LAN91C96_IST_RCV_INT, for happy received packets
612*4882a593Smuzhiyun  *  LAN91C96_IST_RX_OVRN_INT, because I have to kick the receiver
613*4882a593Smuzhiyun  *-------------------------------------------------------------------------
614*4882a593Smuzhiyun  */
615*4882a593Smuzhiyun #define SMC_INTERRUPT_MASK   (LAN91C96_IST_EPH_INT | LAN91C96_IST_RX_OVRN_INT | LAN91C96_IST_RCV_INT)
616*4882a593Smuzhiyun 
617*4882a593Smuzhiyun #endif  /* _LAN91C96_H_ */
618