summaryrefslogtreecommitdiff
path: root/sys/dev/ic/cs89x0reg.h
blob: dec4304e1bd9e2ead8bba38c63c933f1fb6067b5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
/*	$NetBSD: cs89x0reg.h,v 1.3 2005/12/11 12:21:26 christos Exp $	*/

/*
 * Copyright 1997
 * Digital Equipment Corporation. All rights reserved.
 *
 * This software is furnished under license and may be used and
 * copied only in accordance with the following terms and conditions.
 * Subject to these conditions, you may download, copy, install,
 * use, modify and distribute this software in source and/or binary
 * form. No title or ownership is transferred hereby.
 *
 * 1) Any source code used, modified or distributed must reproduce
 *    and retain this copyright notice and list of conditions as
 *    they appear in the source file.
 *
 * 2) No right is granted to use any trade name, trademark, or logo of
 *    Digital Equipment Corporation. Neither the "Digital Equipment
 *    Corporation" name nor any trademark or logo of Digital Equipment
 *    Corporation may be used to endorse or promote products derived
 *    from this software without the prior written permission of
 *    Digital Equipment Corporation.
 *
 * 3) This software is provided "AS-IS" and any express or implied
 *    warranties, including but not limited to, any implied warranties
 *    of merchantability, fitness for a particular purpose, or
 *    non-infringement are disclaimed. In no event shall DIGITAL be
 *    liable for any damages whatsoever, and in particular, DIGITAL
 *    shall not be liable for special, indirect, consequential, or
 *    incidental damages or damages for lost profits, loss of
 *    revenue or loss of use, whether such damages arise in contract,
 *    negligence, tort, under statute, in equity, at law or otherwise,
 *    even if advised of the possibility of such damage.
 */

/*
**++
**  FACILITY  Crystal CS8900 Ethernet driver register description
**
**  ABSTRACT
**
**     This module provides CS8900 register definitions
**
**  AUTHORS
**
**     Peter Dettori   SEA - Software Engineering.
**
**  CREATION DATE:
**
**       13-Feb-1997.
**
**  MODIFICATION HISTORY:
**
**--
*/

#ifndef _DEV_IC_CS89X0REG_H_
#define	_DEV_IC_CS89X0REG_H_

/*
 * The CS8900 has 8 2-byte registers in I/O space.
 */
#define	CS8900_IOSIZE	16

/*
 * The CS8900 has a 4k memory space.
 */
#define	CS8900_MEMSIZE	4096

/*
 * Size of the DMA area used for packet reception.
 */
#if 0
#define	CS8900_DMASIZE	(64*1024)
#else
#define	CS8900_DMASIZE	(16*1024)
#endif

/*
 * Validate various parameters.
 */
#define	CS8900_MEMBASE_ISVALID(x)	(((x) & (CS8900_MEMSIZE - 1)) == 0)
#define	CS8900_IRQ_ISVALID(x)		((x) == 5 || (x) == 10 ||	\
					 (x) == 11 || (x) == 12)

/* Chip Identification (PacketPage registers) */

#define EISA_NUM_CRYSTAL	0x630E
#define PROD_ID_MASK		0xE000
#define PROD_ID_CS8900		0x0000
#define PROD_ID_CS8920		0x4000
#define PROD_ID_CS8920M		0x6000
#define PROD_REV_MASK		0x1F00


/* IO Port Offsets */

#define PORT_RXTX_DATA		0x0000
#define PORT_RXTX_DATA_1	0x0002
#define PORT_TX_CMD		0x0004
#define PORT_TX_LENGTH		0x0006
#define PORT_ISQ		0x0008
#define PORT_PKTPG_PTR		0x000A
#define PORT_PKTPG_DATA		0x000C
#define PORT_PKTPG_DATA_1	0x000E


/* PacketPage Offsets */

#define PKTPG_EISA_NUM		0x0000
#define PKTPG_PRODUCT_ID	0x0002
#define PKTPG_IO_BASE		0x0020
#define PKTPG_INT_NUM		0x0022
#define PKTPG_DMA_CHANNEL	0x0024
#define PKTPG_DMA_START_FRAME	0x0026
#define PKTPG_DMA_FRAME_COUNT	0x0028
#define PKTPG_DMA_BYTE_COUNT	0x002A
#define PKTPG_MEM_BASE		0x002C
#define PKTPG_EEPROM_CMD	0x0040
#define PKTPG_EEPROM_DATA	0x0042
#define PKTPG_FRAME_BYTE_COUNT	0x0050
#define PKTPG_RX_CFG		0x0102
#define PKTPG_RX_CTL		0x0104
#define PKTPG_TX_CFG		0x0106
#define PKTPG_BUF_CFG		0x010A
#define PKTPG_LINE_CTL		0x0112
#define PKTPG_SELF_CTL		0x0114
#define PKTPG_BUS_CTL		0x0116
#define PKTPG_TEST_CTL		0x0118
#define	PKTPG_AUTONEG_CTL	0x011C
#define PKTPG_ISQ		0x0120
#define PKTPG_RX_EVENT		0x0124
#define PKTPG_TX_EVENT		0x0128
#define PKTPG_BUF_EVENT		0x012C
#define PKTPG_RX_MISS		0x0130
#define PKTPG_TX_COL		0x0132
#define PKTPG_LINE_ST		0x0134
#define PKTPG_SELF_ST		0x0136
#define PKTPG_BUS_ST		0x0138
#define	PKTPG_TDR		0x013c
#define	PKTPG_AUTONEG_ST	0x013e
#define PKTPG_TX_CMD		0x0144
#define PKTPG_TX_LENGTH		0x0146
#define PKTPG_LOG_ADDR		0x0150	/* logical address filter hash tbl */
#define PKTPG_IND_ADDR		0x0158
#define PKTPG_8920_INT_NUM	0x0370
#define PKTPG_8920_DMA_CHANNEL	0x0374
#define PKTPG_RX_STATUS		0x0400
#define PKTPG_RX_LENGTH		0x0402
#define PKTPG_RX_FRAME		0x0404
#define PKTPG_TX_FRAME		0x0A00


/* EEPROM Offsets */

#define EEPROM_MAC		0x0009
#define EEPROM_IND_ADDR_H	0x001C
#define EEPROM_IND_ADDR_M	0x001D
#define EEPROM_IND_ADDR_L	0x001E
#define EEPROM_ISA_CFG		0x001F
#define EEPROM_MEM_BASE		0x0020
#define EEPROM_XMIT_CTL		0x0023
#define EEPROM_ADPTR_CFG	0x0024


/* Register Numbers */

#define REG_NUM_MASK		0x003F
#define REG_NUM_RX_EVENT	0x0004
#define REG_NUM_TX_EVENT	0x0008
#define REG_NUM_BUF_EVENT	0x000C
#define REG_NUM_RX_MISS		0x0010
#define REG_NUM_TX_COL		0x0012


/* Self Control Register */

#define SELF_CTL_RESET		0x0040
#define SELF_CTL_HC1E		0x2000
#define SELF_CTL_HCB1		0x8000


/* Self Status Register */

#define SELF_ST_INIT_DONE	0x0080
#define SELF_ST_SI_BUSY		0x0100
#define SELF_ST_EEP_PRES	0x0200
#define SELF_ST_EEP_OK		0x0400
#define SELF_ST_EL_PRES		0x0800


/* EEPROM Command Register */

#define EEPROM_WRITE_DISABLE	0x0000
#define EEPROM_WRITE_ENABLE	0x00F0
#define EEPROM_CMD_WRITE	0x0100
#define EEPROM_CMD_READ		0x0200
#define EEPROM_CMD_ELSEL	0x0400


/* Bus Control Register */

#define BUS_CTL_RESET_DMA	0x0040
#define BUS_CTL_USE_SA		0x0200
#define BUS_CTL_MEM_MODE	0x0400
#define BUS_CTL_DMA_BURST	0x0800
#define BUS_CTL_IOCHRDY		0x1000
#define BUS_CTL_DMA_SIZE	0x2000
#define BUS_CTL_INT_ENBL	0x8000


/* Bus Status Register */

#define BUS_ST_TX_BID_ERR	0x0080
#define BUS_ST_RDY4TXNOW	0x0100


/* Line Control Register */

#define LINE_CTL_RX_ON		0x0040
#define LINE_CTL_TX_ON		0x0080
#define LINE_CTL_AUI_ONLY	0x0100
#define LINE_CTL_10BASET	0x0000
#define LINE_CTL_AUTO_SEL	0x0200


/* Test Control Register */

#define TEST_CTL_DIS_LT		0x0080
#define TEST_CTL_ENDEC_LP	0x0200
#define TEST_CTL_AUI_LOOP	0x0400
#define TEST_CTL_DIS_BKOFF	0x0800
#define TEST_CTL_FDX		0x4000


/* Receiver Configuration Register */

#define RX_CFG_SKIP		0x0040
#define RX_CFG_RX_OK_IE		0x0100
#define RX_CFG_RX_DMA_ONLY	0x0200
#define RX_CFG_CRC_ERR_IE	0x1000
#define RX_CFG_RUNT_IE		0x2000
#define RX_CFG_X_DATA_IE	0x4000
#define RX_CFG_ALL_IE		0x7100


/* Receiver Event Register */

#define RX_EVENT_DRIBBLE	0x0080
#define RX_EVENT_RX_OK		0x0100
#define RX_EVENT_IND_ADDR	0x0400
#define RX_EVENT_BCAST		0x0800
#define RX_EVENT_CRC_ERR	0x1000
#define RX_EVENT_RUNT		0x2000
#define RX_EVENT_X_DATA		0x4000


/* Receiver Control Register */

#define RX_CTL_INDHASH_A	0x0040
#define RX_CTL_PROMISC_A	0x0080
#define RX_CTL_RX_OK_A		0x0100
#define RX_CTL_MCAST_A		0x0200
#define RX_CTL_IND_A		0x0400
#define RX_CTL_BCAST_A		0x0800
#define RX_CTL_CRC_ERR_A	0x1000
#define RX_CTL_RUNT_A		0x2000
#define RX_CTL_X_DATA_A		0x4000


/* Transmit Configuration Register */

#define TX_CFG_LOSS_CRS_IE	0x0040
#define TX_CFG_SQE_ERR_IE	0x0080
#define TX_CFG_TX_OK_IE		0x0100
#define TX_CFG_OUT_WIN_IE	0x0200
#define TX_CFG_JABBER_IE	0x0400
#define TX_CFG_16_COLL_IE	0x8000
#define TX_CFG_ALL_IE		0x8FC0



/* Transmit Configuration Register */

#define TX_EVENT_LOSS_CRS	0x0040
#define TX_EVENT_SQE_ERR	0x0080
#define TX_EVENT_TX_OK		0x0100
#define TX_EVENT_OUT_WIN	0x0200
#define TX_EVENT_JABBER		0x0400
#define TX_EVENT_COLL_MASK	0x7800
#define TX_EVENT_16_COLL	0x8000


/* Transmit Command Register */

#define TX_CMD_START_5		0x0000
#define TX_CMD_START_381	0x0080
#define TX_CMD_START_1021	0x0040
#define TX_CMD_START_ALL	0x00C0
#define TX_CMD_FORCE		0x0100
#define TX_CMD_ONE_COLL		0x0200
#define TX_CMD_NO_CRC		0x1000
#define TX_CMD_NO_PAD		0x2000


/* Buffer Configuration Register */

#define BUF_CFG_SW_INT		0x0040
#define BUF_CFG_RX_DMA_IE	0x0080
#define BUF_CFG_RDY4TX_IE	0x0100
#define BUF_CFG_RX_MISS_IE	0x0400
#define BUF_CFG_TX_UNDR_IE	0x0200
#define BUF_CFG_RX_128_IE	0x0800
#define BUF_CFG_TX_COL_OVER_IE	0x1000
#define BUF_CFG_RX_MISS_OVER_IE	0x2000
#define BUF_CFG_RX_DEST_IE	0x8000

/* Buffer Event Register */

#define BUF_EVENT_SW_INT	0x0040
#define BUF_EVENT_RX_DMA	0x0080
#define BUF_EVENT_RDY4TX	0x0100
#define BUF_EVENT_TX_UNDR	0x0200
#define BUF_EVENT_RX_MISS	0x0400
#define BUF_EVENT_RX_128	0x0800
#define BUF_EVENT_RX_DEST	0x8000


/* Autonegotiation Control Register */

#define	AUTOCTL_NEG_NOW		0x0040
#define	AUTOCTL_ALLOW_FDX	0x0080
#define	AUTOCTL_NEG_ENABLE	0x0100
#define	AUTOCTL_NLP_ENABLE	0x0200
#define	AUTOCTL_FORCE_FDX	0x8000


/* Autonegotiation Status Register */

#define	AUTOST_NEG_BUSY		0x0080
#define	AUTOST_FLP_LINK		0x0100
#define	AUTOST_FLP_LINK_GOOD	0x0800
#define	AUTOST_LINK_FAULT	0x1000
#define	AUTOST_HDX_ACTIVE	0x4000
#define	AUTOST_FDX_ACTIVE	0x8000


/* ISA Configuration from EEPROM */

#define ISA_CFG_IRQ_MASK	0x000F
#define ISA_CFG_USE_SA		0x0080
#define ISA_CFG_IOCHRDY		0x0100
#define ISA_CFG_MEM_MODE	0x8000


/* Memory Base from EEPROM */

#define MEM_BASE_MASK		0xFFF0


/* Adpater Configuration from EEPROM */

#define ADPTR_CFG_MEDIA		0x0060
#define ADPTR_CFG_10BASET	0x0020
#define ADPTR_CFG_AUI		0x0040
#define ADPTR_CFG_10BASE2	0x0060
#define ADPTR_CFG_DCDC_POL	0x0080


/* Transmission Control from EEPROM */

#define XMIT_CTL_FDX		0x8000


/* Miscellaneous definitions */

#define MAXLOOP			0x8888
#define RXBUFCOUNT		16
#define MC_LOANED		5

#endif /* _DEV_IC_CS89X0REG_H_ */