Annotation of sys/arch/mvme68k/dev/i82586.h, Revision 1.1.1.1
1.1 nbrk 1: /* $OpenBSD: i82586.h,v 1.4 2003/06/02 05:09:14 deraadt Exp $ */
2:
3: /*-
4: * Copyright (c) 1995 Theo de Raadt
5: * Copyright (c) 1992, University of Vermont and State Agricultural College.
6: * Copyright (c) 1992, Garrett A. Wollman.
7: * All rights reserved.
8: *
9: * Redistribution and use in source and binary forms, with or without
10: * modification, are permitted provided that the following conditions
11: * are met:
12: * 1. Redistributions of source code must retain the above copyright
13: * notice, this list of conditions and the following disclaimer.
14: * 2. Redistributions in binary form must reproduce the above copyright
15: * notice, this list of conditions and the following disclaimer in the
16: * documentation and/or other materials provided with the distribution.
17: * 3. All advertising materials mentioning features or use of this software
18: * must display the following acknowledgement:
19: * This product includes software developed by the University of
20: * Vermont and State Agricultural College and Garrett A. Wollman.
21: * 4. Neither the name of the University nor the name of the author
22: * may be used to endorse or promote products derived from this software
23: * without specific prior written permission.
24: *
25: * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
26: * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
28: * ARE DISCLAIMED. IN NO EVENT SHALL THE UNIVERSITY OR AUTHOR BE LIABLE
29: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
30: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
31: * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
32: * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
33: * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
34: * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35: * SUCH DAMAGE.
36: */
37:
38: /*
39: * Intel 82586 Ethernet chip
40: * Register, bit, and structure definitions.
41: *
42: * Written by GAW with reference to the Clarkson Packet Driver code for this
43: * chip written by Russ Nelson and others.
44: *
45: * Sun support added by Charles D. Cranor, 25-Oct-94
46: */
47:
48: struct ie_en_addr {
49: u_char data[6];
50: };
51:
52: /*
53: * This is the master configuration block. It tells the hardware where all
54: * the rest of the stuff is.
55: */
56: struct ie_sys_conf_ptr {
57: u_char mbz1[3]; /* must be zero */
58: u_char ie_bus_use; /* true if 8-bit only */
59: u_char mbz2[4]; /* must be zero */
60: caddr_t ie_iscp_ptr; /* 24-bit physaddr of ISCP */
61: };
62:
63: /*
64: * The tells the hardware where all the rest of the stuff is, too.
65: * FIXME: some of these should be re-commented after we figure out their
66: * REAL function.
67: */
68: struct ie_int_sys_conf_ptr {
69: u_char mbz1[1];
70: u_char ie_busy; /* zeroed after init */
71: u_short ie_scb_offset; /* 16-bit physaddr of next struct */
72: caddr_t ie_base; /* 24-bit physaddr for all 16-bit vars */
73: };
74:
75: /*
76: * This FINALLY tells the hardware what to do and where to put it.
77: */
78: struct ie_sys_ctl_block {
79: u_short ie_status; /* status word */
80: u_short ie_command; /* command word */
81: u_short ie_command_list; /* 16-pointer to command block list */
82: u_short ie_recv_list; /* 16-pointer to receive frame list */
83: u_short ie_err_crc; /* CRC errors */
84: u_short ie_err_align; /* Alignment errors */
85: u_short ie_err_resource; /* Resource errors */
86: u_short ie_err_overrun; /* Overrun errors */
87: };
88:
89: /* Command values */
90: #define IE_RU_COMMAND SWAP(0x0070) /* mask for RU command */
91: #define IE_RU_NOP SWAP(0) /* for completeness */
92: #define IE_RU_START SWAP(0x0010) /* start receive unit command */
93: #define IE_RU_ENABLE SWAP(0x0020) /* enable receiver command */
94: #define IE_RU_DISABLE SWAP(0x0030) /* disable receiver command */
95: #define IE_RU_ABORT SWAP(0x0040) /* abort current receive operation */
96:
97: #define IE_CU_COMMAND SWAP(0x0700) /* mask for CU command */
98: #define IE_CU_NOP SWAP(0) /* included for completeness */
99: #define IE_CU_START SWAP(0x0100) /* do-command command */
100: #define IE_CU_RESUME SWAP(0x0200) /* resume a suspended cmd list */
101: #define IE_CU_STOP SWAP(0x0300) /* SUSPEND was already taken */
102: #define IE_CU_ABORT SWAP(0x0400) /* abort current command */
103:
104: #define IE_ACK_COMMAND SWAP(0xf000) /* mask for ACK command */
105: #define IE_ACK_CX SWAP(0x8000) /* ack IE_ST_DONE */
106: #define IE_ACK_FR SWAP(0x4000) /* ack IE_ST_RECV */
107: #define IE_ACK_CNA SWAP(0x2000) /* ack IE_ST_ALLDONE */
108: #define IE_ACK_RNR SWAP(0x1000) /* ack IE_ST_RNR */
109:
110: #define IE_ACTION_COMMAND(x) (((x) & IE_CU_COMMAND) == IE_CU_START)
111: /* is this command an action command? */
112:
113: /* Status values */
114: #define IE_ST_WHENCE SWAP(0xf000) /* mask for cause of interrupt */
115: #define IE_ST_DONE SWAP(0x8000) /* command with I bit completed */
116: #define IE_ST_RECV SWAP(0x4000) /* frame received */
117: #define IE_ST_ALLDONE SWAP(0x2000) /* all commands completed */
118: #define IE_ST_RNR SWAP(0x1000) /* receive not ready */
119:
120: #define IE_CU_STATUS SWAP(0x700) /* mask for command unit status */
121: #define IE_CU_ACTIVE SWAP(0x200) /* command unit is active */
122: #define IE_CU_SUSPEND SWAP(0x100) /* command unit is suspended */
123:
124: #define IE_RU_STATUS SWAP(0x70) /* mask for receiver unit status */
125: #define IE_RU_SUSPEND SWAP(0x10) /* receiver is suspended */
126: #define IE_RU_NOSPACE SWAP(0x20) /* receiver has no resources */
127: #define IE_RU_READY SWAP(0x40) /* reveiver is ready */
128:
129: /*
130: * This is filled in partially by the chip, partially by us.
131: */
132: struct ie_recv_frame_desc {
133: u_short ie_fd_status; /* status for this frame */
134: u_short ie_fd_last; /* end of frame list flag */
135: u_short ie_fd_next; /* 16-pointer to next RFD */
136: u_short ie_fd_buf_desc; /* 16-pointer to list of buffer desc's */
137: struct ie_en_addr dest; /* destination ether */
138: struct ie_en_addr src; /* source ether */
139: u_short ie_length; /* 802 length/Ether type */
140: u_short mbz; /* must be zero */
141: };
142:
143: #define IE_FD_LAST SWAP(0x8000) /* last rfd in list */
144: #define IE_FD_SUSP SWAP(0x4000) /* suspend RU after receipt */
145:
146: #define IE_FD_COMPLETE SWAP(0x8000) /* frame is complete */
147: #define IE_FD_BUSY SWAP(0x4000) /* frame is busy */
148: #define IE_FD_OK SWAP(0x2000) /* frame is bad */
149: #define IE_FD_RNR SWAP(0x0200) /* receiver out of resources here */
150:
151: /*
152: * linked list of buffers...
153: */
154: struct ie_recv_buf_desc {
155: u_short ie_rbd_actual; /* status for this buffer */
156: u_short ie_rbd_next; /* 16-pointer to next RBD */
157: caddr_t ie_rbd_buffer; /* 24-pointer to buffer for this RBD */
158: u_short ie_rbd_length; /* length of the buffer */
159: u_short mbz; /* must be zero */
160: };
161:
162: #define IE_RBD_LAST SWAP(0x8000) /* last buffer */
163: #define IE_RBD_USED SWAP(0x4000) /* this buffer has data */
164: /*
165: * All commands share this in common.
166: */
167: struct ie_cmd_common {
168: u_short ie_cmd_status; /* status of this command */
169: u_short ie_cmd_cmd; /* command word */
170: u_short ie_cmd_link; /* link to next command */
171: };
172:
173: #define IE_STAT_COMPL SWAP(0x8000) /* command is completed */
174: #define IE_STAT_BUSY SWAP(0x4000) /* command is running now */
175: #define IE_STAT_OK SWAP(0x2000) /* command completed successfully */
176: #define IE_STAT_ABORT SWAP(0x1000) /* command was aborted */
177:
178:
179: #define IE_CMD_NOP SWAP(0x0000) /* NOP */
180: #define IE_CMD_IASETUP SWAP(0x0001) /* initial address setup */
181: #define IE_CMD_CONFIG SWAP(0x0002) /* configure command */
182: #define IE_CMD_MCAST SWAP(0x0003) /* multicast setup command */
183: #define IE_CMD_XMIT SWAP(0x0004) /* transmit command */
184: #define IE_CMD_TDR SWAP(0x0005) /* time-domain reflectometer command */
185: #define IE_CMD_DUMP SWAP(0x0006) /* dump command */
186: #define IE_CMD_DIAGNOSE SWAP(0x0007) /* diagnostics command */
187:
188: #define IE_CMD_LAST SWAP(0x8000) /* this is the last command in the list */
189: #define IE_CMD_SUSPEND SWAP(0x4000) /* suspend CU after this command */
190: #define IE_CMD_INTR SWAP(0x2000) /* post an interrupt after completion */
191:
192: /*
193: * This is the command to transmit a frame.
194: */
195: struct ie_xmit_cmd {
196: struct ie_cmd_common com; /* common part */
197: #define ie_xmit_status com.ie_cmd_status
198:
199: u_short ie_xmit_desc; /* 16-pointer to buffer descriptor */
200: struct ie_en_addr ie_xmit_addr; /* destination address */
201:
202: u_short ie_xmit_length; /* 802.3 length/Ether type field */
203: };
204:
205: #define IE_XS_MAXCOLL SWAP(0x000f) /* number of collisions during transmit */
206: #define IE_XS_EXCMAX SWAP(0x0020) /* exceeded maximum number of collisions */
207: #define IE_XS_SQE SWAP(0x0040) /* SQE positive */
208: #define IE_XS_DEFERRED SWAP(0x0080) /* transmission deferred */
209: #define IE_XS_UNDERRUN SWAP(0x0100) /* DMA underrun */
210: #define IE_XS_LOSTCTS SWAP(0x0200) /* Lost CTS */
211: #define IE_XS_NOCARRIER SWAP(0x0400) /* No Carrier */
212:
213: /*
214: * This is a buffer descriptor for a frame to be transmitted.
215: */
216:
217: struct ie_xmit_buf {
218: u_short ie_xmit_flags; /* see below */
219: u_short ie_xmit_next; /* 16-pointer to next desc. */
220: caddr_t ie_xmit_buf; /* 24-pointer to the actual buffer */
221: };
222:
223: #define IE_XMIT_LAST SWAP(0x8000) /* this TBD is the last one */
224: /* The rest of the `flags' word is actually the length. */
225:
226: /*
227: * Multicast setup command.
228: */
229:
230: #define MAXMCAST 250 /* must fit in transmit buffer */
231:
232: struct ie_mcast_cmd {
233: struct ie_cmd_common com; /* common part */
234: #define ie_mcast_status com.ie_cmd_status
235:
236: u_short ie_mcast_bytes; /* size (in bytes) of multicast addresses */
237: struct ie_en_addr ie_mcast_addrs[MAXMCAST + 1]; /* space for them */
238: };
239:
240: /*
241: * Time Domain Reflectometer command.
242: */
243:
244: struct ie_tdr_cmd {
245: struct ie_cmd_common com; /* common part */
246: #define ie_tdr_status com.ie_cmd_status
247:
248: u_short ie_tdr_time; /* error bits and time */
249: };
250:
251: #define IE_TDR_SUCCESS SWAP(0x8000) /* TDR succeeded without error */
252: #define IE_TDR_XCVR SWAP(0x4000) /* detected a transceiver problem */
253: #define IE_TDR_OPEN SWAP(0x2000) /* detected an open */
254: #define IE_TDR_SHORT SWAP(0x1000) /* TDR detected a short */
255: #define IE_TDR_TIME SWAP(0x07ff) /* mask for reflection time */
256:
257: /*
258: * Initial Address Setup command
259: */
260: struct ie_iasetup_cmd {
261: struct ie_cmd_common com;
262: #define ie_iasetup_status com.ie_cmd_status
263:
264: struct ie_en_addr ie_address;
265: };
266:
267: /*
268: * Configuration command
269: */
270: struct ie_config_cmd {
271: struct ie_cmd_common com; /* common part */
272: #define ie_config_status com.ie_cmd_status
273:
274: u_char ie_config_count; /* byte count (0x0c) */
275: u_char ie_fifo; /* fifo (8) */
276: u_char ie_save_bad; /* save bad frames (0x40) */
277: u_char ie_addr_len; /* address length (0x2e) (AL-LOC == 1) */
278: u_char ie_priority; /* priority and backoff (0x0) */
279: u_char ie_ifs; /* inter-frame spacing (0x60) */
280: u_char ie_slot_low; /* slot time, LSB (0x0) */
281: u_char ie_slot_high; /* slot time, MSN, and retries (0xf2) */
282: u_char ie_promisc; /* 1 if promiscuous, else 0 */
283: u_char ie_crs_cdt; /* CSMA/CD parameters (0x0) */
284: u_char ie_min_len; /* min frame length (0x40) */
285: u_char ie_junk; /* stuff for 82596 (0xff) */
286: };
CVSweb
![[BACK]](/icons/back.gif){kind=icon}
Return to i82586.h CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / sys / arch / mvme68k / dev