i82557reg.h revision 1.5 1 /* $NetBSD: i82557reg.h,v 1.5 2001/05/22 00:07:32 thorpej Exp $ */
2
3 /*-
4 * Copyright (c) 1998, 1999 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Jason R. Thorpe of the Numerical Aerospace Simulation Facility,
9 * NASA Ames Research Center.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 * must display the following acknowledgement:
21 * This product includes software developed by the NetBSD
22 * Foundation, Inc. and its contributors.
23 * 4. Neither the name of The NetBSD Foundation nor the names of its
24 * contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
26 *
27 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
28 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
29 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
31 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
32 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
33 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
34 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
35 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
36 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
37 * POSSIBILITY OF SUCH DAMAGE.
38 */
39
40 /*
41 * Copyright (c) 1995, David Greenman
42 * All rights reserved.
43 *
44 * Redistribution and use in source and binary forms, with or without
45 * modification, are permitted provided that the following conditions
46 * are met:
47 * 1. Redistributions of source code must retain the above copyright
48 * notice unmodified, this list of conditions, and the following
49 * disclaimer.
50 * 2. Redistributions in binary form must reproduce the above copyright
51 * notice, this list of conditions and the following disclaimer in the
52 * documentation and/or other materials provided with the distribution.
53 *
54 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
55 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
56 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
57 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
58 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
59 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
60 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
61 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
62 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
63 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
64 * SUCH DAMAGE.
65 *
66 * Id: if_fxpreg.h,v 1.11 1997/09/29 11:27:42 davidg Exp
67 */
68
69 #define FXP_VENDORID_INTEL 0x8086
70 #define FXP_DEVICEID_i82557 0x1229
71
72 #define FXP_PCI_MMBA 0x10
73 #define FXP_PCI_IOBA 0x14
74
75 /*
76 * Control/status registers.
77 */
78 #define FXP_CSR_SCB_RUSCUS 0x00 /* scb_rus/scb_cus (1 byte) */
79 #define FXP_CSR_SCB_STATACK 0x01 /* scb_statack (1 byte) */
80 #define FXP_CSR_SCB_COMMAND 0x02 /* scb_command (1 byte) */
81 #define FXP_CSR_SCB_INTRCNTL 0x03 /* scb_intrcntl (1 byte) */
82 #define FXP_CSR_SCB_GENERAL 0x04 /* scb_general (4 bytes) */
83 #define FXP_CSR_PORT 0x08 /* port (4 bytes) */
84 #define FXP_CSR_FLASHCONTROL 0x0c /* flash control (2 bytes) */
85 #define FXP_CSR_EEPROMCONTROL 0x0e /* eeprom control (2 bytes) */
86 #define FXP_CSR_MDICONTROL 0x10 /* mdi control (4 bytes) */
87 #define FXP_CSR_FLOWCONTROL 0x19 /* flow control (2 bytes) */
88
89 /*
90 * FOR REFERENCE ONLY, the old definition of FXP_CSR_SCB_RUSCUS:
91 *
92 * volatile u_int8_t :2,
93 * scb_rus:4,
94 * scb_cus:2;
95 */
96
97 #define FXP_PORT_SOFTWARE_RESET 0
98 #define FXP_PORT_SELFTEST 1
99 #define FXP_PORT_SELECTIVE_RESET 2
100 #define FXP_PORT_DUMP 3
101
102 #define FXP_SCB_RUS_IDLE 0
103 #define FXP_SCB_RUS_SUSPENDED 1
104 #define FXP_SCB_RUS_NORESOURCES 2
105 #define FXP_SCB_RUS_READY 4
106 #define FXP_SCB_RUS_SUSP_NORBDS 9
107 #define FXP_SCB_RUS_NORES_NORBDS 10
108 #define FXP_SCB_RUS_READY_NORBDS 12
109
110 #define FXP_SCB_CUS_IDLE 0
111 #define FXP_SCB_CUS_SUSPENDED 1
112 #define FXP_SCB_CUS_ACTIVE 2
113
114 #define FXP_SCB_INTR_DISABLE 0x01 /* disable all interrupts */
115 #define FXP_SCB_INTR_SWI 0x02 /* generate SWI */
116 #define FXP_SCB_INTMASK_FCP 0x04
117 #define FXP_SCB_INTMASK_ER 0x08
118 #define FXP_SCB_INTMASK_RNR 0x10
119 #define FXP_SCB_INTMASK_CNA 0x20
120 #define FXP_SCB_INTMASK_FR 0x40
121 #define FXP_SCB_INTMASK_CXTNO 0x80
122
123 #define FXP_SCB_STATACK_SWI 0x04
124 #define FXP_SCB_STATACK_MDI 0x08
125 #define FXP_SCB_STATACK_RNR 0x10
126 #define FXP_SCB_STATACK_CNA 0x20
127 #define FXP_SCB_STATACK_FR 0x40
128 #define FXP_SCB_STATACK_CXTNO 0x80
129
130 #define FXP_SCB_COMMAND_CU_NOP 0x00
131 #define FXP_SCB_COMMAND_CU_START 0x10
132 #define FXP_SCB_COMMAND_CU_RESUME 0x20
133 #define FXP_SCB_COMMAND_CU_DUMP_ADR 0x40
134 #define FXP_SCB_COMMAND_CU_DUMP 0x50
135 #define FXP_SCB_COMMAND_CU_BASE 0x60
136 #define FXP_SCB_COMMAND_CU_DUMPRESET 0x70
137
138 #define FXP_SCB_COMMAND_RU_NOP 0
139 #define FXP_SCB_COMMAND_RU_START 1
140 #define FXP_SCB_COMMAND_RU_RESUME 2
141 #define FXP_SCB_COMMAND_RU_ABORT 4
142 #define FXP_SCB_COMMAND_RU_LOADHDS 5
143 #define FXP_SCB_COMMAND_RU_BASE 6
144 #define FXP_SCB_COMMAND_RU_RBDRESUME 7
145
146 /*
147 * Command block definitions
148 */
149
150 /*
151 * NOP command.
152 */
153 struct fxp_cb_nop {
154 volatile u_int16_t cb_status;
155 volatile u_int16_t cb_command;
156 volatile u_int32_t link_addr;
157 };
158
159 /*
160 * Individual Address command.
161 */
162 struct fxp_cb_ias {
163 volatile u_int16_t cb_status;
164 volatile u_int16_t cb_command;
165 volatile u_int32_t link_addr;
166 volatile u_int8_t macaddr[6];
167 };
168
169 #if BYTE_ORDER == LITTLE_ENDIAN
170 #define __FXP_BITFIELD2(a, b) a, b
171 #define __FXP_BITFIELD3(a, b, c) a, b, c
172 #define __FXP_BITFIELD4(a, b, c, d) a, b, c, d
173 #define __FXP_BITFIELD6(a, b, c, d, e, f) a, b, c, d, e, f
174 #else
175 #define __FXP_BITFIELD2(a, b) b, a
176 #define __FXP_BITFIELD3(a, b, c) c, b, a
177 #define __FXP_BITFIELD4(a, b, c, d) d, c, b, a
178 #define __FXP_BITFIELD6(a, b, c, d, e, f) f, e, d, c, b, a
179 #endif
180
181 /*
182 * Configure command.
183 */
184 struct fxp_cb_config {
185 volatile u_int16_t cb_status;
186 volatile u_int16_t cb_command;
187 volatile u_int32_t link_addr;
188 volatile u_int8_t __FXP_BITFIELD2(byte_count:6, :2);
189 volatile u_int8_t __FXP_BITFIELD3(rx_fifo_limit:4,
190 tx_fifo_limit:3,
191 :1);
192 volatile u_int8_t adaptive_ifs;
193 volatile u_int8_t :8;
194 volatile u_int8_t __FXP_BITFIELD2(rx_dma_bytecount:7, :1);
195 volatile u_int8_t __FXP_BITFIELD2(tx_dma_bytecount:7,
196 dma_bce:1);
197 volatile u_int8_t __FXP_BITFIELD6(late_scb:1, :1,
198 tno_int:1,
199 ci_int:1, :3,
200 save_bf:1);
201 volatile u_int8_t __FXP_BITFIELD3(disc_short_rx:1,
202 underrun_retry:2, :5);
203 volatile u_int8_t __FXP_BITFIELD2(mediatype:1, :7);
204 volatile u_int8_t :8;
205 volatile u_int8_t __FXP_BITFIELD4(:3,
206 nsai:1,
207 preamble_length:2,
208 loopback:2);
209 volatile u_int8_t __FXP_BITFIELD2(linear_priority:3, :5);
210 volatile u_int8_t __FXP_BITFIELD3(linear_pri_mode:1, :3,
211 interfrm_spacing:4);
212 volatile u_int8_t :8;
213 volatile u_int8_t :8;
214 volatile u_int8_t __FXP_BITFIELD4(promiscuous:1,
215 bcast_disable:1, :5,
216 crscdt:1);
217 volatile u_int8_t :8;
218 volatile u_int8_t :8;
219 volatile u_int8_t __FXP_BITFIELD4(stripping:1,
220 padding:1,
221 rcv_crc_xfer:1, :5);
222 volatile u_int8_t __FXP_BITFIELD3(:6, force_fdx:1,
223 fdx_pin_en:1);
224 volatile u_int8_t __FXP_BITFIELD3(:6, multi_ia:1, :1);
225 volatile u_int8_t __FXP_BITFIELD3(:3, mc_all:1, :4);
226 };
227
228 /*
229 * Multicast setup command.
230 */
231 #define MAXMCADDR 80
232 struct fxp_cb_mcs {
233 volatile u_int16_t cb_status;
234 volatile u_int16_t cb_command;
235 volatile u_int32_t link_addr;
236 volatile u_int16_t mc_cnt;
237 volatile u_int8_t mc_addr[MAXMCADDR][6];
238 };
239
240 /*
241 * Transmit command.
242 */
243 struct fxp_cb_tx {
244 volatile u_int16_t cb_status;
245 volatile u_int16_t cb_command;
246 volatile u_int32_t link_addr;
247 volatile u_int32_t tbd_array_addr;
248 volatile u_int16_t byte_count;
249 volatile u_int8_t tx_threshold;
250 volatile u_int8_t tbd_number;
251 /*
252 * If using the extended TxCB feature, there is a
253 * single TBD right here. We handle this in the
254 * fxp_control_data in i82557var.h.
255 */
256 };
257
258 /*
259 * Transmit buffer descriptors.
260 */
261 struct fxp_tbd {
262 volatile u_int32_t tb_addr;
263 volatile u_int32_t tb_size;
264 };
265
266 /*
267 * Control Block (CB) definitions
268 */
269
270 /* status */
271 #define FXP_CB_STATUS_OK 0x2000
272 #define FXP_CB_STATUS_C 0x8000
273
274 /* commands */
275 #define FXP_CB_COMMAND_NOP 0x0
276 #define FXP_CB_COMMAND_IAS 0x1
277 #define FXP_CB_COMMAND_CONFIG 0x2
278 #define FXP_CB_COMMAND_MCAS 0x3
279 #define FXP_CB_COMMAND_XMIT 0x4
280 #define FXP_CB_COMMAND_RESRV 0x5
281 #define FXP_CB_COMMAND_DUMP 0x6
282 #define FXP_CB_COMMAND_DIAG 0x7
283
284 /* command flags */
285 #define FXP_CB_COMMAND_SF 0x0008 /* simple/flexible mode */
286 #define FXP_CB_COMMAND_I 0x2000 /* generate interrupt on completion */
287 #define FXP_CB_COMMAND_S 0x4000 /* suspend on completion */
288 #define FXP_CB_COMMAND_EL 0x8000 /* end of list */
289
290 /*
291 * Receive Frame Area.
292 *
293 * NOTE! The RFA will NOT be aligned on a 4-byte boundary in the DMA
294 * area! To prevent EGCS from optimizing the copy of link_addr and
295 * rbd_addr (which would cause an unaligned access fault on RISC systems),
296 * we must make them an array of bytes!
297 */
298 struct fxp_rfa {
299 volatile u_int16_t rfa_status;
300 volatile u_int16_t rfa_control;
301 volatile u_int8_t link_addr[4];
302 volatile u_int8_t rbd_addr[4];
303 volatile u_int16_t actual_size;
304 volatile u_int16_t size;
305 };
306
307 #define FXP_RFA_STATUS_RCOL 0x0001 /* receive collision */
308 #define FXP_RFA_STATUS_IAMATCH 0x0002 /* 0 = matches station address */
309 #define FXP_RFA_STATUS_S4 0x0010 /* receive error from PHY */
310 #define FXP_RFA_STATUS_TL 0x0020 /* type/length */
311 #define FXP_RFA_STATUS_FTS 0x0080 /* frame too short */
312 #define FXP_RFA_STATUS_OVERRUN 0x0100 /* DMA overrun */
313 #define FXP_RFA_STATUS_RNR 0x0200 /* no resources */
314 #define FXP_RFA_STATUS_ALIGN 0x0400 /* alignment error */
315 #define FXP_RFA_STATUS_CRC 0x0800 /* CRC error */
316 #define FXP_RFA_STATUS_OK 0x2000 /* packet received okay */
317 #define FXP_RFA_STATUS_C 0x8000 /* packet reception complete */
318
319 #define FXP_RFA_CONTROL_SF 0x0008 /* simple/flexible memory mode */
320 #define FXP_RFA_CONTROL_H 0x0010 /* header RFD */
321 #define FXP_RFA_CONTROL_S 0x4000 /* suspend after reception */
322 #define FXP_RFA_CONTROL_EL 0x8000 /* end of list */
323
324 /*
325 * Statistics dump area definitions
326 */
327 struct fxp_stats {
328 volatile u_int32_t tx_good;
329 volatile u_int32_t tx_maxcols;
330 volatile u_int32_t tx_latecols;
331 volatile u_int32_t tx_underruns;
332 volatile u_int32_t tx_lostcrs;
333 volatile u_int32_t tx_deffered;
334 volatile u_int32_t tx_single_collisions;
335 volatile u_int32_t tx_multiple_collisions;
336 volatile u_int32_t tx_total_collisions;
337 volatile u_int32_t rx_good;
338 volatile u_int32_t rx_crc_errors;
339 volatile u_int32_t rx_alignment_errors;
340 volatile u_int32_t rx_rnr_errors;
341 volatile u_int32_t rx_overrun_errors;
342 volatile u_int32_t rx_cdt_errors;
343 volatile u_int32_t rx_shortframes;
344 volatile u_int32_t completion_status;
345 };
346 #define FXP_STATS_DUMP_COMPLETE 0xa005
347 #define FXP_STATS_DR_COMPLETE 0xa007
348
349 /*
350 * Serial EEPROM control register bits
351 */
352 #define FXP_EEPROM_EESK 0x01 /* shift clock */
353 #define FXP_EEPROM_EECS 0x02 /* chip select */
354 #define FXP_EEPROM_EEDI 0x04 /* data in */
355 #define FXP_EEPROM_EEDO 0x08 /* data out */
356
357 /*
358 * Serial EEPROM opcodes, including start bit
359 */
360 #define FXP_EEPROM_OPC_ERASE 0x4
361 #define FXP_EEPROM_OPC_WRITE 0x5
362 #define FXP_EEPROM_OPC_READ 0x6
363
364 /*
365 * Management Data Interface opcodes
366 */
367 #define FXP_MDI_WRITE 0x1
368 #define FXP_MDI_READ 0x2
369
370 /*
371 * PHY device types (from EEPROM)
372 */
373 #define FXP_PHY_NONE 0
374 #define FXP_PHY_82553A 1
375 #define FXP_PHY_82553C 2
376 #define FXP_PHY_82503 3
377 #define FXP_PHY_DP83840 4
378 #define FXP_PHY_80C240 5
379 #define FXP_PHY_80C24 6
380 #define FXP_PHY_82555 7
381 #define FXP_PHY_DP83840A 10
382