1 /* $NetBSD: i82586.h,v 1.1 1996/05/17 21:18:16 chuck 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 46 struct ie_en_addr { 47 u_char data[6]; 48 }; 49 /* 50 * the only actual IE registers. 51 */ 52 struct iereg { 53 u_short ie_porthigh; 54 u_short ie_portlow; 55 u_long ie_attention; 56 }; 57 #define IE_PORT_NEWSCP 0x00000002 58 #define IE_PORT_RESET 0x00000000 59 60 /* 61 * This is the master configuration block. It tells the hardware where 62 * all the rest of the stuff is. 63 */ 64 struct ie_scp { 65 u_char mbz1[3]; /* must be zero */ 66 u_char scp_sysbus; /* true if 8-bit only */ 67 u_char mbz2[4]; /* must be zero */ 68 u_short scp_iscp_low; /* 24-bit physaddr of ISCP */ 69 u_char mbz3[1]; 70 u_char scp_iscp_high; /* the rest of the physaddr.. */ 71 }; 72 /* 73 * The tells the hardware where all the rest of the stuff is, too. 74 * FIXME: some of these should be re-commented after we figure out their 75 * REAL function. 76 */ 77 struct ie_iscp { 78 u_char mbz1[1]; 79 u_char iscp_busy; /* zeroed after init */ 80 u_short iscp_scboffset; /* 16-bit physaddr of next struct */ 81 u_short iscp_base_low; /* 24-bit physaddr for all 16-bit vars */ 82 u_char mbz2[1]; 83 u_char iscp_base_high; /* rest of physaddr ... */ 84 }; 85 /* 86 * This FINALLY tells the hardware what to do and where to put it. 87 */ 88 struct ie_scb { 89 u_short ie_status; /* status word */ 90 u_short ie_command; /* command word */ 91 u_short ie_command_list;/* 16-pointer to command block list */ 92 u_short ie_recv_list; /* 16-pointer to receive frame list */ 93 u_short ie_err_crc; /* CRC errors */ 94 u_short ie_err_align; /* Alignment errors */ 95 u_short ie_err_resource;/* Resource errors */ 96 u_short ie_err_overrun; /* Overrun errors */ 97 }; 98 /* Command values */ 99 #define IE_RU_COMMAND 0x0070 /* mask for RU command */ 100 #define IE_RU_NOP 0 /* for completeness */ 101 #define IE_RU_START 0x0010 /* start receive unit command */ 102 #define IE_RU_ENABLE 0x0020 /* enable receiver command */ 103 #define IE_RU_DISABLE 0x0030 /* disable receiver command */ 104 #define IE_RU_ABORT 0x0040 /* abort current receive operation */ 105 106 #define IE_CU_COMMAND 0x0700 /* mask for CU command */ 107 #define IE_CU_NOP 0 /* included for completeness */ 108 #define IE_CU_START 0x0100 /* do-command command */ 109 #define IE_CU_RESUME 0x0200 /* resume a suspended cmd list */ 110 #define IE_CU_STOP 0x0300 /* SUSPEND was already taken */ 111 #define IE_CU_ABORT 0x0400 /* abort current command */ 112 113 #define IE_ACK_COMMAND 0xf000 /* mask for ACK command */ 114 #define IE_ACK_CX 0x8000 /* ack IE_ST_DONE */ 115 #define IE_ACK_FR 0x4000 /* ack IE_ST_RECV */ 116 #define IE_ACK_CNA 0x2000 /* ack IE_ST_ALLDONE */ 117 #define IE_ACK_RNR 0x1000 /* ack IE_ST_RNR */ 118 119 #define IE_ACTION_COMMAND(x) (((x) & IE_CU_COMMAND) == IE_CU_START) 120 /* is this command an action command? */ 121 122 /* Status values */ 123 #define IE_ST_WHENCE 0xf000 /* mask for cause of interrupt */ 124 #define IE_ST_DONE 0x8000 /* command with I bit completed */ 125 #define IE_ST_RECV 0x4000 /* frame received */ 126 #define IE_ST_ALLDONE 0x2000 /* all commands completed */ 127 #define IE_ST_RNR 0x1000 /* receive not ready */ 128 129 #define IE_CU_STATUS 0x700 /* mask for command unit status */ 130 #define IE_CU_ACTIVE 0x200 /* command unit is active */ 131 #define IE_CU_SUSPEND 0x100 /* command unit is suspended */ 132 133 #define IE_RU_STATUS 0x70 /* mask for receiver unit status */ 134 #define IE_RU_SUSPEND 0x10 /* receiver is suspended */ 135 #define IE_RU_NOSPACE 0x20 /* receiver has no resources */ 136 #define IE_RU_READY 0x40 /* receiver is ready */ 137 138 /* 139 * This is filled in partially by the chip, partially by us. 140 */ 141 struct ie_recv_frame_desc { 142 u_short ie_fd_status; /* status for this frame */ 143 u_short ie_fd_last; /* end of frame list flag */ 144 u_short ie_fd_next; /* 16-pointer to next RFD */ 145 u_short ie_fd_buf_desc; /* 16-pointer to list of buffer desc's */ 146 struct ie_en_addr dest; /* destination ether */ 147 struct ie_en_addr src; /* source ether */ 148 u_short ie_length; /* 802 length/Ether type */ 149 u_short mbz; /* must be zero */ 150 }; 151 #define IE_FD_LAST 0x8000 /* last rfd in list */ 152 #define IE_FD_SUSP 0x4000 /* suspend RU after receipt */ 153 154 #define IE_FD_COMPLETE 0x8000 /* frame is complete */ 155 #define IE_FD_BUSY 0x4000 /* frame is busy */ 156 #define IE_FD_OK 0x2000 /* frame is bad */ 157 #define IE_FD_RNR 0x0200 /* receiver out of resources here */ 158 159 /* 160 * linked list of buffers... 161 */ 162 struct ie_recv_buf_desc { 163 u_short ie_rbd_actual; /* status for this buffer */ 164 u_short ie_rbd_next; /* 16-pointer to next RBD */ 165 u_short ie_rbd_buffer_low; /* 24-pointer to buffer for this RBD */ 166 u_short ie_rbd_buffer_high; /* 24-pointer to buffer for this RBD */ 167 u_short ie_rbd_length; /* length of the buffer */ 168 u_short mbz; /* must be zero */ 169 }; 170 #define IE_RBD_LAST 0x8000 /* last buffer */ 171 #define IE_RBD_USED 0x4000 /* this buffer has data */ 172 /* 173 * All commands share this in common. 174 */ 175 struct ie_cmd_common { 176 u_short ie_cmd_status; /* status of this command */ 177 u_short ie_cmd_cmd; /* command word */ 178 u_short ie_cmd_link; /* link to next command */ 179 }; 180 #define IE_STAT_COMPL 0x8000 /* command is completed */ 181 #define IE_STAT_BUSY 0x4000 /* command is running now */ 182 #define IE_STAT_OK 0x2000 /* command completed successfully */ 183 #define IE_STAT_ABORT 0x1000 /* command was aborted */ 184 185 186 #define IE_CMD_NOP 0x0000 /* NOP */ 187 #define IE_CMD_IASETUP 0x0001 /* initial address setup */ 188 #define IE_CMD_CONFIG 0x0002 /* configure command */ 189 #define IE_CMD_MCAST 0x0003 /* multicast setup command */ 190 #define IE_CMD_XMIT 0x0004 /* transmit command */ 191 #define IE_CMD_TDR 0x0005 /* time-domain reflectometer command */ 192 #define IE_CMD_DUMP 0x0006 /* dump command */ 193 #define IE_CMD_DIAGNOSE 0x0007 /* diagnostics command */ 194 195 #define IE_CMD_LAST 0x8000 /* this is the last command in the list */ 196 #define IE_CMD_SUSPEND 0x4000 /* suspend CU after this command */ 197 #define IE_CMD_INTR 0x2000 /* post an interrupt after completion */ 198 199 /* 200 * This is the command to transmit a frame. 201 */ 202 struct ie_xmit_cmd { 203 struct ie_cmd_common com; /* common part */ 204 #define ie_xmit_status com.ie_cmd_status 205 206 u_short ie_xmit_desc; /* 16-pointer to buffer descriptor */ 207 struct ie_en_addr ie_xmit_addr; /* destination address */ 208 209 u_short ie_xmit_length; /* 802.3 length/Ether type field */ 210 }; 211 #define IE_XS_MAXCOLL 0x000f /* number of collisions during transmit */ 212 #define IE_XS_EXCMAX 0x0020 /* exceeded maximum number of collisions */ 213 #define IE_XS_SQE 0x0040 /* SQE positive */ 214 #define IE_XS_DEFERRED 0x0080 /* transmission deferred */ 215 #define IE_XS_UNDERRUN 0x0100 /* DMA underrun */ 216 #define IE_XS_LOSTCTS 0x0200 /* Lost CTS */ 217 #define IE_XS_NOCARRIER 0x0400 /* No Carrier */ 218 219 /* 220 * This is a buffer descriptor for a frame to be transmitted. 221 */ 222 223 struct ie_xmit_buf { 224 u_short ie_xmit_flags; /* see below */ 225 u_short ie_xmit_next; /* 16-pointer to next desc. */ 226 u_short ie_xmit_buf_low;/* 24-pointer to the actual buffer */ 227 u_short ie_xmit_buf_high; /* 24-pointer to the actual buffer */ 228 }; 229 #define IE_XMIT_LAST 0x8000 /* this TBD is the last one */ 230 /* The rest of the `flags' word is actually the length. */ 231 232 /* 233 * Multicast setup command. 234 */ 235 236 #define MAXMCAST 250 /* must fit in transmit buffer */ 237 238 struct ie_mcast_cmd { 239 struct ie_cmd_common com; /* common part */ 240 #define ie_mcast_status com.ie_cmd_status 241 242 u_short ie_mcast_bytes; /* size (in bytes) of multicast addresses */ 243 struct ie_en_addr ie_mcast_addrs[MAXMCAST + 1]; /* space for them */ 244 }; 245 /* 246 * Time Domain Reflectometer command. 247 */ 248 249 struct ie_tdr_cmd { 250 struct ie_cmd_common com; /* common part */ 251 #define ie_tdr_status com.ie_cmd_status 252 253 u_short ie_tdr_time; /* error bits and time */ 254 }; 255 #define IE_TDR_SUCCESS 0x8000 /* TDR succeeded without error */ 256 #define IE_TDR_XCVR 0x4000 /* detected a transceiver problem */ 257 #define IE_TDR_OPEN 0x2000 /* detected an open */ 258 #define IE_TDR_SHORT 0x1000 /* TDR detected a short */ 259 #define IE_TDR_TIME 0x07ff /* mask for reflection time */ 260 261 /* 262 * Initial Address Setup command 263 */ 264 struct ie_iasetup_cmd { 265 struct ie_cmd_common com; 266 #define ie_iasetup_status com.ie_cmd_status 267 268 struct ie_en_addr ie_address; 269 }; 270 /* 271 * Configuration command 272 */ 273 struct ie_config_cmd { 274 struct ie_cmd_common com; /* common part */ 275 #define ie_config_status com.ie_cmd_status 276 277 u_char ie_config_count;/* byte count (0x0c) */ 278 u_char ie_fifo; /* fifo (8) */ 279 u_char ie_save_bad; /* save bad frames (0x40) */ 280 u_char ie_addr_len; /* address length (0x2e) (AL-LOC == 1) */ 281 u_char ie_priority; /* priority and backoff (0x0) */ 282 u_char ie_ifs; /* inter-frame spacing (0x60) */ 283 u_char ie_slot_low; /* slot time, LSB (0x0) */ 284 u_char ie_slot_high; /* slot time, MSN, and retries (0xf2) */ 285 u_char ie_promisc; /* 1 if promiscuous, else 0 */ 286 u_char ie_crs_cdt; /* CSMA/CD parameters (0x0) */ 287 u_char ie_min_len; /* min frame length (0x40) */ 288 u_char ie_junk; /* stuff for 82596 (0xff) */ 289 }; 290 291 struct iemem { 292 volatile struct ie_scp im_scp; 293 u_char xx1[4]; 294 volatile struct ie_iscp im_iscp; 295 296 volatile struct ie_scb im_scb; 297 volatile struct ie_config_cmd im_cc; 298 volatile struct ie_iasetup_cmd im_ic; 299 volatile struct ie_recv_frame_desc im_rfd[NRXBUF]; 300 volatile struct ie_recv_buf_desc im_rbd[NRXBUF]; 301 volatile struct ie_xmit_cmd im_xc[NTXBUF]; 302 volatile struct ie_xmit_buf im_xd[NTXBUF]; 303 volatile u_char im_rxbuf[NRXBUF * IE_RBUF_SIZE]; 304 volatile u_char im_txbuf[NTXBUF * ETHER_MAX_LEN]; 305 306 }; 307