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