1 /* $NetBSD: i82586.h,v 1.6 1997/03/15 18:10:48 is 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 * Intel 82586 Ethernet chip 39 * Register, bit, and structure definitions. 40 * 41 * Written by GAW with reference to the Clarkson Packet Driver code for this 42 * chip written by Russ Nelson and others. 43 * 44 * Sun support added by Charles D. Cranor, 25-Oct-94 45 * 46 * XXX: This is very much like dev/ic/i82586reg.h except for 47 * XXX: the SWAP() macro used here to byte-swap word constants. 48 * XXX: (This should probably replace the version in dev/ic) 49 */ 50 51 struct ie_en_addr { 52 u_char data[6]; 53 }; 54 55 /* 56 * This is the master configuration block. It tells the hardware where all 57 * the rest of the stuff is. 58 */ 59 struct ie_sys_conf_ptr { 60 u_short mbz; /* must be zero (alignment) */ 61 u_char ie_bus_use; /* true if 8-bit only */ 62 u_char mbz2[5]; /* must be zero */ 63 u_int ie_iscp_ptr; /* 24-bit physaddr of ISCP */ 64 }; 65 66 /* 67 * Note that this is wired in hardware; the SCP is always located here, no 68 * matter what. 69 */ 70 #define IE_SCP_ADDR 0xfffff4 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_int_sys_conf_ptr { 78 u_char ie_busy; /* zeroed after init */ 79 u_char mbz; 80 u_short ie_scb_offset; /* 16-bit physaddr of next struct */ 81 u_int ie_base; /* 24-bit physaddr for all 16-bit vars */ 82 }; 83 84 /* 85 * This FINALLY tells the hardware what to do and where to put it. 86 */ 87 struct ie_sys_ctl_block { 88 u_short ie_status; /* status word */ 89 u_short ie_command; /* command word */ 90 u_short ie_command_list; /* 16-pointer to command block list */ 91 u_short ie_recv_list; /* 16-pointer to receive frame list */ 92 u_short ie_err_crc; /* CRC errors */ 93 u_short ie_err_align; /* Alignment errors */ 94 u_short ie_err_resource; /* Resource errors */ 95 u_short ie_err_overrun; /* Overrun errors */ 96 }; 97 98 /* Command values */ 99 #define IE_RU_COMMAND SWAP(0x0070) /* mask for RU command */ 100 #define IE_RU_NOP SWAP(0) /* for completeness */ 101 #define IE_RU_START SWAP(0x0010) /* start receive unit command */ 102 #define IE_RU_ENABLE SWAP(0x0020) /* enable receiver command */ 103 #define IE_RU_DISABLE SWAP(0x0030) /* disable receiver command */ 104 #define IE_RU_ABORT SWAP(0x0040) /* abort current receive operation */ 105 106 #define IE_CU_COMMAND SWAP(0x0700) /* mask for CU command */ 107 #define IE_CU_NOP SWAP(0) /* included for completeness */ 108 #define IE_CU_START SWAP(0x0100) /* do-command command */ 109 #define IE_CU_RESUME SWAP(0x0200) /* resume a suspended cmd list */ 110 #define IE_CU_STOP SWAP(0x0300) /* SUSPEND was already taken */ 111 #define IE_CU_ABORT SWAP(0x0400) /* abort current command */ 112 113 #define IE_ACK_COMMAND SWAP(0xf000) /* mask for ACK command */ 114 #define IE_ACK_CX SWAP(0x8000) /* ack IE_ST_DONE */ 115 #define IE_ACK_FR SWAP(0x4000) /* ack IE_ST_RECV */ 116 #define IE_ACK_CNA SWAP(0x2000) /* ack IE_ST_ALLDONE */ 117 #define IE_ACK_RNR SWAP(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 SWAP(0xf000) /* mask for cause of interrupt */ 124 #define IE_ST_DONE SWAP(0x8000) /* command with I bit completed */ 125 #define IE_ST_RECV SWAP(0x4000) /* frame received */ 126 #define IE_ST_ALLDONE SWAP(0x2000) /* all commands completed */ 127 #define IE_ST_RNR SWAP(0x1000) /* receive not ready */ 128 129 #define IE_CU_STATUS SWAP(0x700) /* mask for command unit status */ 130 #define IE_CU_ACTIVE SWAP(0x200) /* command unit is active */ 131 #define IE_CU_SUSPEND SWAP(0x100) /* command unit is suspended */ 132 133 #define IE_RU_STATUS SWAP(0x70) /* mask for receiver unit status */ 134 #define IE_RU_SUSPEND SWAP(0x10) /* receiver is suspended */ 135 #define IE_RU_NOSPACE SWAP(0x20) /* receiver has no resources */ 136 #define IE_RU_READY SWAP(0x40) /* reveiver 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 152 #define IE_FD_LAST SWAP(0x8000) /* last rfd in list */ 153 #define IE_FD_SUSP SWAP(0x4000) /* suspend RU after receipt */ 154 155 #define IE_FD_COMPLETE SWAP(0x8000) /* frame is complete */ 156 #define IE_FD_BUSY SWAP(0x4000) /* frame is busy */ 157 #define IE_FD_OK SWAP(0x2000) /* frame is bad */ 158 #define IE_FD_RNR SWAP(0x0200) /* receiver out of resources here */ 159 160 /* 161 * linked list of buffers... 162 */ 163 struct ie_recv_buf_desc { 164 u_short ie_rbd_actual; /* status for this buffer */ 165 u_short ie_rbd_next; /* 16-pointer to next RBD */ 166 u_int ie_rbd_buffer; /* 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 171 #define IE_RBD_LAST SWAP(0x8000) /* last buffer */ 172 #define IE_RBD_USED SWAP(0x4000) /* this buffer has data */ 173 /* 174 * All commands share this in common. 175 */ 176 struct ie_cmd_common { 177 u_short ie_cmd_status; /* status of this command */ 178 u_short ie_cmd_cmd; /* command word */ 179 u_short ie_cmd_link; /* link to next command */ 180 }; 181 182 #define IE_STAT_COMPL SWAP(0x8000) /* command is completed */ 183 #define IE_STAT_BUSY SWAP(0x4000) /* command is running now */ 184 #define IE_STAT_OK SWAP(0x2000) /* command completed successfully */ 185 #define IE_STAT_ABORT SWAP(0x1000) /* command was aborted */ 186 187 #define IE_CMD_NOP SWAP(0x0000) /* NOP */ 188 #define IE_CMD_IASETUP SWAP(0x0001) /* initial address setup */ 189 #define IE_CMD_CONFIG SWAP(0x0002) /* configure command */ 190 #define IE_CMD_MCAST SWAP(0x0003) /* multicast setup command */ 191 #define IE_CMD_XMIT SWAP(0x0004) /* transmit command */ 192 #define IE_CMD_TDR SWAP(0x0005) /* time-domain reflectometer command */ 193 #define IE_CMD_DUMP SWAP(0x0006) /* dump command */ 194 #define IE_CMD_DIAGNOSE SWAP(0x0007) /* diagnostics command */ 195 196 #define IE_CMD_LAST SWAP(0x8000) /* this is the last command in the list */ 197 #define IE_CMD_SUSPEND SWAP(0x4000) /* suspend CU after this command */ 198 #define IE_CMD_INTR SWAP(0x2000) /* post an interrupt after completion */ 199 200 /* 201 * This is the command to transmit a frame. 202 */ 203 struct ie_xmit_cmd { 204 struct ie_cmd_common com; /* common part */ 205 #define ie_xmit_status com.ie_cmd_status 206 207 u_short ie_xmit_desc; /* 16-pointer to buffer descriptor */ 208 struct ie_en_addr ie_xmit_addr; /* destination address */ 209 210 u_short ie_xmit_length; /* 802.3 length/Ether type field */ 211 }; 212 213 #define IE_XS_MAXCOLL SWAP(0x000f) /* number of collisions during transmit */ 214 #define IE_XS_EXCMAX SWAP(0x0020) /* exceeded maximum number of collisions */ 215 #define IE_XS_SQE SWAP(0x0040) /* SQE positive */ 216 #define IE_XS_DEFERRED SWAP(0x0080) /* transmission deferred */ 217 #define IE_XS_UNDERRUN SWAP(0x0100) /* DMA underrun */ 218 #define IE_XS_LOSTCTS SWAP(0x0200) /* Lost CTS */ 219 #define IE_XS_NOCARRIER SWAP(0x0400) /* No Carrier */ 220 #define IE_XS_LATECOLL SWAP(0x0800) /* Late collision */ 221 222 /* 223 * This is a buffer descriptor for a frame to be transmitted. 224 */ 225 226 struct ie_xmit_buf { 227 u_short ie_xmit_flags; /* see below */ 228 u_short ie_xmit_next; /* 16-pointer to next desc. */ 229 u_int ie_xmit_buf; /* 24-pointer to the actual buffer */ 230 }; 231 232 #define IE_XMIT_LAST SWAP(0x8000) /* this TBD is the last one */ 233 /* The rest of the `flags' word is actually the length. */ 234 235 /* 236 * Multicast setup command. 237 * The command must fit in a transmit buffer (1536). 238 * Also, would like size of ie_mcast_addrs to be even. 239 */ 240 241 #define MAXMCAST 247 242 243 struct ie_mcast_cmd { 244 struct ie_cmd_common com; /* common part */ 245 #define ie_mcast_status com.ie_cmd_status 246 247 u_short ie_mcast_bytes; /* size (in bytes) of multicast addresses */ 248 struct ie_en_addr ie_mcast_addrs[MAXMCAST + 1]; /* space for them */ 249 }; 250 251 /* 252 * Time Domain Reflectometer command. 253 */ 254 255 struct ie_tdr_cmd { 256 struct ie_cmd_common com; /* common part */ 257 #define ie_tdr_status com.ie_cmd_status 258 259 u_short ie_tdr_time; /* error bits and time */ 260 }; 261 262 #define IE_TDR_SUCCESS SWAP(0x8000) /* TDR succeeded without error */ 263 #define IE_TDR_XCVR SWAP(0x4000) /* detected a transceiver problem */ 264 #define IE_TDR_OPEN SWAP(0x2000) /* detected an open */ 265 #define IE_TDR_SHORT SWAP(0x1000) /* TDR detected a short */ 266 #define IE_TDR_TIME SWAP(0x07ff) /* mask for reflection time */ 267 268 /* 269 * Initial Address Setup command 270 */ 271 struct ie_iasetup_cmd { 272 struct ie_cmd_common com; 273 #define ie_iasetup_status com.ie_cmd_status 274 275 struct ie_en_addr ie_address; 276 }; 277 278 /* 279 * Configuration command 280 */ 281 struct ie_config_cmd { 282 struct ie_cmd_common com; /* common part */ 283 #define ie_config_status com.ie_cmd_status 284 285 u_char ie_config_count; /* byte count (0x0c) */ 286 u_char ie_fifo; /* fifo (8) */ 287 u_char ie_save_bad; /* save bad frames (0x40) */ 288 u_char ie_addr_len; /* address length (0x2e) (AL-LOC == 1) */ 289 u_char ie_priority; /* priority and backoff (0x0) */ 290 u_char ie_ifs; /* inter-frame spacing (0x60) */ 291 u_char ie_slot_low; /* slot time, LSB (0x0) */ 292 u_char ie_slot_high; /* slot time, MSN, and retries (0xf2) */ 293 u_char ie_promisc; /* 1 if promiscuous, else 0 */ 294 u_char ie_crs_cdt; /* CSMA/CD parameters (0x0) */ 295 u_char ie_min_len; /* min frame length (0x40) */ 296 u_char ie_junk; /* stuff for 82596 (0xff) */ 297 }; 298