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