elink3reg.h revision 1.12
1 /* $NetBSD: elink3reg.h,v 1.12 1997/04/07 23:49:48 jonathan Exp $ */ 2 3 /* 4 * Copyright (c) 1995 Herb Peyerl <hpeyerl (at) beer.org> 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. All advertising materials mentioning features or use of this software 16 * must display the following acknowledgement: 17 * This product includes software developed by Herb Peyerl. 18 * 4. The name of Herb Peyerl may not be used to endorse or promote products 19 * derived from this software without specific prior written permission. 20 * 21 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 22 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 23 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 24 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 26 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 27 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 28 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 29 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 30 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 * 32 */ 33 34 /* 35 * These define the EEPROM data structure. They are used in the probe 36 * function to verify the existance of the adapter after having sent 37 * the ID_Sequence. 38 * 39 * There are others but only the ones we use are defined here. 40 */ 41 #define EEPROM_NODE_ADDR_0 0x0 /* Word */ 42 #define EEPROM_NODE_ADDR_1 0x1 /* Word */ 43 #define EEPROM_NODE_ADDR_2 0x2 /* Word */ 44 #define EEPROM_PROD_ID 0x3 /* 0x9[0-f]50 */ 45 #define EEPROM_MFG_ID 0x7 /* 0x6d50 */ 46 #define EEPROM_ADDR_CFG 0x8 /* Base addr */ 47 #define EEPROM_RESOURCE_CFG 0x9 /* IRQ. Bits 12-15 */ 48 49 /* 50 * These are the registers for the 3Com 3c509 and their bit patterns when 51 * applicable. They have been taken out the the "EtherLink III Parallel 52 * Tasking EISA and ISA Technical Reference" "Beta Draft 10/30/92" manual 53 * from 3com. 54 */ 55 #define EP_COMMAND 0x0e /* Write. BASE+0x0e is always a command reg. */ 56 #define EP_STATUS 0x0e /* Read. BASE+0x0e is always status reg. */ 57 #define EP_WINDOW 0x0f /* Read. BASE+0x0f is always window reg. */ 58 59 /* 60 * Window 0 registers. Setup. 61 */ 62 /* Write */ 63 #define EP_W0_EEPROM_DATA 0x0c 64 #define EP_W0_EEPROM_COMMAND 0x0a 65 #define EP_W0_RESOURCE_CFG 0x08 66 #define EP_W0_ADDRESS_CFG 0x06 67 #define EP_W0_CONFIG_CTRL 0x04 68 /* Read */ 69 #define EP_W0_PRODUCT_ID 0x02 70 #define EP_W0_MFG_ID 0x00 71 72 /* 73 * Window 1 registers. Operating Set. 74 */ 75 /* Write */ 76 #define EP_W1_TX_PIO_WR_2 0x02 77 #define EP_W1_TX_PIO_WR_1 0x00 78 /* Read */ 79 #define EP_W1_FREE_TX 0x0c 80 #define EP_W1_TX_STATUS 0x0b /* byte */ 81 #define EP_W1_TIMER 0x0a /* byte */ 82 #define EP_W1_RX_STATUS 0x08 83 #define EP_W1_RX_PIO_RD_2 0x02 84 #define EP_W1_RX_PIO_RD_1 0x00 85 86 /* 87 * Window 2 registers. Station Address Setup/Read 88 */ 89 /* Read/Write */ 90 #define EP_W2_RECVMASK_0 0x06 91 #define EP_W2_ADDR_5 0x05 92 #define EP_W2_ADDR_4 0x04 93 #define EP_W2_ADDR_3 0x03 94 #define EP_W2_ADDR_2 0x02 95 #define EP_W2_ADDR_1 0x01 96 #define EP_W2_ADDR_0 0x00 97 98 /* 99 * Window 3 registers. Configuration and FIFO Management. 100 */ 101 /* Read */ 102 #define EP_W3_FREE_TX 0x0c 103 #define EP_W3_FREE_RX 0x0a 104 /* Read/Write, at least on busmastering cards. */ 105 #define EP_W3_INTERNAL_CONFIG 0x00 /* 32 bits */ 106 #define EP_W3_OTHER_INT 0x04 /* 8 bits */ 107 #define EP_W3_PIO_RESERVED 0x05 /* 8 bits */ 108 #define EP_W3_MAC_CONTROL 0x06 /* 16 bits */ 109 #define EP_W3_RESET_OPTIONS 0x08 /* 16 bits */ 110 111 /* 112 * Window 4 registers. Diagnostics. 113 */ 114 /* Read/Write */ 115 #define EP_W4_MEDIA_TYPE 0x0a 116 #define EP_W4_CTRLR_STATUS 0x08 117 #define EP_W4_NET_DIAG 0x06 118 #define EP_W4_FIFO_DIAG 0x04 119 #define EP_W4_HOST_DIAG 0x02 120 #define EP_W4_TX_DIAG 0x00 121 122 /* 123 * Window 5 Registers. Results and Internal status. 124 */ 125 /* Read */ 126 #define EP_W5_READ_0_MASK 0x0c 127 #define EP_W5_INTR_MASK 0x0a 128 #define EP_W5_RX_FILTER 0x08 129 #define EP_W5_RX_EARLY_THRESH 0x06 130 #define EP_W5_TX_AVAIL_THRESH 0x02 131 #define EP_W5_TX_START_THRESH 0x00 132 133 /* 134 * Window 6 registers. Statistics. 135 */ 136 /* Read/Write */ 137 #define TX_TOTAL_OK 0x0c 138 #define RX_TOTAL_OK 0x0a 139 #define TX_DEFERRALS 0x08 140 #define RX_FRAMES_OK 0x07 141 #define TX_FRAMES_OK 0x06 142 #define RX_OVERRUNS 0x05 143 #define TX_COLLISIONS 0x04 144 #define TX_AFTER_1_COLLISION 0x03 145 #define TX_AFTER_X_COLLISIONS 0x02 146 #define TX_NO_SQE 0x01 147 #define TX_CD_LOST 0x00 148 149 /* 150 * Window 7 registers. 151 * Address and length for a single bus-master DMA transfer. 152 */ 153 #define EP_W7_MASTER_ADDDRES 0x00 154 #define EP_W7_RX_ERROR 0x04 155 #define EP_W7_MASTER_LEN 0x06 156 #define EP_W7_RX_STATUS 0x08 157 #define EP_W7_TIMER 0x0a 158 #define EP_W7_TX_STATUS 0x0b 159 #define EP_W7_MASTER_STATUS 0x0c 160 161 /* 162 * Register definitions. 163 */ 164 165 /* 166 * Command register. All windows. 167 * 168 * 16 bit register. 169 * 15-11: 5-bit code for command to be executed. 170 * 10-0: 11-bit arg if any. For commands with no args; 171 * this can be set to anything. 172 */ 173 #define GLOBAL_RESET (u_short) 0x0000 /* Wait at least 1ms after issuing */ 174 #define WINDOW_SELECT (u_short) (0x1<<11) 175 #define START_TRANSCEIVER (u_short) (0x2<<11) /* Read ADDR_CFG reg to determine 176 whether this is needed. If so; 177 wait 800 uSec before using trans- 178 ceiver. */ 179 #define RX_DISABLE (u_short) (0x3<<11) /* state disabled on power-up */ 180 #define RX_ENABLE (u_short) (0x4<<11) 181 #define RX_RESET (u_short) (0x5<<11) 182 #define RX_DISCARD_TOP_PACK (u_short) (0x8<<11) 183 #define TX_ENABLE (u_short) (0x9<<11) 184 #define TX_DISABLE (u_short) (0xa<<11) 185 #define TX_RESET (u_short) (0xb<<11) 186 #define REQ_INTR (u_short) (0xc<<11) 187 188 /* 189 * The following C_* acknowledge the various interrupts. 190 * Some of them don't do anything. See the manual. 191 */ 192 #define ACK_INTR (u_short) (0xd << 11) 193 # define C_INTR_LATCH (u_short) (ACK_INTR|0x01) 194 # define C_CARD_FAILURE (u_short) (ACK_INTR|0x02) 195 # define C_TX_COMPLETE (u_short) (ACK_INTR|0x04) 196 # define C_TX_AVAIL (u_short) (ACK_INTR|0x08) 197 # define C_RX_COMPLETE (u_short) (ACK_INTR|0x10) 198 # define C_RX_EARLY (u_short) (ACK_INTR|0x20) 199 # define C_INT_RQD (u_short) (ACK_INTR|0x40) 200 # define C_UPD_STATS (u_short) (ACK_INTR|0x80) 201 202 #define SET_INTR_MASK (u_short) (0x0e<<11) 203 204 /* busmastering-cards only? */ 205 #define STATUS_ENABLE (u_short) (0xf<<11) 206 207 #define SET_RD_0_MASK (u_short) (0x0f<<11) 208 209 #define SET_RX_FILTER (u_short) (0x10<<11) 210 # define FIL_INDIVIDUAL (u_short) (0x01) 211 # define FIL_MULTICAST (u_short) (0x02) 212 # define FIL_BRDCST (u_short) (0x04) 213 # define FIL_PROMISC (u_short) (0x08) 214 215 #define SET_RX_EARLY_THRESH (u_short) (0x11<<11) 216 #define SET_TX_AVAIL_THRESH (u_short) (0x12<<11) 217 #define SET_TX_START_THRESH (u_short) (0x13<<11) 218 #define START_DMA (u_short) (0x14<<11) /* busmaster-only */ 219 # define START_DMA_TX (START_DMA | 0x0)) /* busmaster-only */ 220 # define START_DMA_RX (START_DMA | 0x1) /* busmaster-only */ 221 #define STATS_ENABLE (u_short) (0x15<<11) 222 #define STATS_DISABLE (u_short) (0x16<<11) 223 #define STOP_TRANSCEIVER (u_short) (0x17<<11) 224 225 /* Only on adapters that support power management: */ 226 #define POWERUP (u_short) (0x1b<<11) 227 #define POWERDOWN (u_short) (0x1c<<11) 228 #define POWERAUTO (u_short) (0x1d<<11) 229 230 231 232 /* 233 * Command parameter that disables threshold interrupts 234 * PIO (3c509) cards use 2044. The fifo word-oriented and 2044--2047 work. 235 * "busmastering" cards need 8188. 236 * The implicit two-bit upshift done by busmastering cards means 237 * a value of 2047 disables threshold interrupts on both. 238 */ 239 #define EP_THRESH_DISABLE 2047 240 241 242 /* 243 * Status register. All windows. 244 * 245 * 15-13: Window number(0-7). 246 * 12: Command_in_progress. 247 * 11: reserved / DMA in progress on busmaster cards. 248 * 10: reserved. 249 * 9: reserved. 250 * 8: reserved / DMA done on busmaster cards. 251 * 7: Update Statistics. 252 * 6: Interrupt Requested. 253 * 5: RX Early. 254 * 4: RX Complete. 255 * 3: TX Available. 256 * 2: TX Complete. 257 * 1: Adapter Failure. 258 * 0: Interrupt Latch. 259 */ 260 #define S_INTR_LATCH (u_short) (0x0001) 261 #define S_CARD_FAILURE (u_short) (0x0002) 262 #define S_TX_COMPLETE (u_short) (0x0004) 263 #define S_TX_AVAIL (u_short) (0x0008) 264 #define S_RX_COMPLETE (u_short) (0x0010) 265 #define S_RX_EARLY (u_short) (0x0020) 266 #define S_INT_RQD (u_short) (0x0040) 267 #define S_UPD_STATS (u_short) (0x0080) 268 #define S_DMA_DONE (u_short) (0x0100) /* DMA cards only */ 269 #define S_DMA_IN_PROGRESS (u_short) (0x0800) /* DMA cards only */ 270 #define S_COMMAND_IN_PROGRESS (u_short) (0x1000) 271 272 /* 273 * FIFO Registers. RX Status. 274 * 275 * 15: Incomplete or FIFO empty. 276 * 14: 1: Error in RX Packet 0: Incomplete or no error. 277 * 14-11: Type of error. [14-11] 278 * 1000 = Overrun. 279 * 1011 = Run Packet Error. 280 * 1100 = Alignment Error. 281 * 1101 = CRC Error. 282 * 1001 = Oversize Packet Error (>1514 bytes) 283 * 0010 = Dribble Bits. 284 * (all other error codes, no errors.) 285 * 286 * 10-0: RX Bytes (0-1514) 287 */ 288 #define ERR_INCOMPLETE (u_short) (0x8000) 289 #define ERR_RX (u_short) (0x4000) 290 #define ERR_MASK (u_short) (0x7800) 291 #define ERR_OVERRUN (u_short) (0x4000) 292 #define ERR_RUNT (u_short) (0x5800) 293 #define ERR_ALIGNMENT (u_short) (0x6000) 294 #define ERR_CRC (u_short) (0x6800) 295 #define ERR_OVERSIZE (u_short) (0x4800) 296 #define ERR_DRIBBLE (u_short) (0x1000) 297 298 /* 299 * TX Status 300 * 301 * Reports the transmit status of a completed transmission. Writing this 302 * register pops the transmit completion stack. 303 * 304 * Window 1/Port 0x0b. 305 * 306 * 7: Complete 307 * 6: Interrupt on successful transmission requested. 308 * 5: Jabber Error (TP Only, TX Reset required. ) 309 * 4: Underrun (TX Reset required. ) 310 * 3: Maximum Collisions. 311 * 2: TX Status Overflow. 312 * 1-0: Undefined. 313 * 314 */ 315 #define TXS_COMPLETE 0x80 316 #define TXS_INTR_REQ 0x40 317 #define TXS_JABBER 0x20 318 #define TXS_UNDERRUN 0x10 319 #define TXS_MAX_COLLISION 0x08 320 #define TXS_STATUS_OVERFLOW 0x04 321 322 /* 323 * RX status 324 * Window 1/Port 0x08. 325 */ 326 #define RX_BYTES_MASK (u_short) (0x07ff) 327 328 /* 329 * Internal Config and MAC control (Window 3) 330 * Window 3 / Port 0: 32-bit internal config register: 331 * bits 0-2: fifo buffer ram size 332 * 3: ram width (word/byte) (ro) 333 * 4-5: ram speed 334 * 6-7: rom size 335 * 8-15: reserved 336 * 337 * 16-17: ram split (5:3, 3:1, or 1:1). 338 * 18-19: reserved 339 * 20-22: selected media type 340 * 21: unused 341 * 24: (nonvolatile) driver should autoselect media 342 * 25-31: reseerved 343 * 344 * The low-order 16 bits should generally not be changed by software. 345 * Offsets defined for two 16-bit words, to help out 16-bit busses. 346 */ 347 #define CONFIG_RAMSIZE (u_short) 0x0007 348 #define CONFIG_RAMSIZE_SHIFT (u_short) 0 349 350 #define CONFIG_RAMWIDTH (u_short) 0x0008 351 #define CONFIG_RAMWIDTH_SHIFT (u_short) 3 352 353 #define CONFIG_RAMSPEED (u_short) 0x0030 354 #define CONFIG_RAMSPEED_SHIFT (u_short) 4 355 #define CONFIG_ROMSIZE (u_short) 0x00c0 356 #define CONFIG_ROMSIZE_SHIFT (u_short) 6 357 358 /* Window 3/port 2 */ 359 #define CONFIG_RAMSPLIT (u_short) 0x0003 360 #define CONFIG_RAMSPLIT_SHIFT (u_short) 0 361 #define CONFIG_MEDIAMASK (u_short) 0x0070 362 #define CONFIG_MEDIAMASK_SHIFT (u_short) 4 363 364 /* Active media in EP_W3_RESET_OPTIONS mediamask bits */ 365 366 #define EPMEDIA_10BASE_T (u_short) 0x00 367 #define EPMEDIA_AUI (u_short) 0x01 368 #define EPMEDIA_RESV1 (u_short) 0x02 369 #define EPMEDIA_10BASE_2 (u_short) 0x03 370 #define EPMEDIA_100BASE_TX (u_short) 0x04 371 #define EPMEDIA_100BASE_FX (u_short) 0x05 372 #define EPMEDIA_MII (u_short) 0x06 373 #define EPMEDIA_100BASE_T4 (u_short) 0x07 374 375 376 #define CONFIG_AUTOSELECT (u_short) 0x0100 377 #define CONFIG_AUTOSELECT_SHIFT (u_short) 8 378 379 /* 380 * RESET_OPTIONS (Window 4, on Demon/Vortex/Bomerang only) 381 * also mapped to PCI configuration space on PCI adaptors. 382 * 383 * (same register as Vortex EP_W3_RESET_OPTIONS, mapped to pci-config space) 384 */ 385 #define EP_PCI_100BASE_T4 (1<<0) 386 #define EP_PCI_100BASE_TX (1<<1) 387 #define EP_PCI_100BASE_FX (1<<2) 388 #define EP_PCI_10BASE_T (1<<3) 389 # define EP_PCI_UTP EP_PCI_10BASE_T 390 #define EP_PCI_BNC (1<<4) 391 #define EP_PCI_AUI (1<<5) 392 #define EP_PCI_100BASE_MII (1<<6) 393 #define EP_PCI_INTERNAL_VCO (1<<8) 394 395 /* 396 * FIFO Status (Window 4) 397 * 398 * Supports FIFO diagnostics 399 * 400 * Window 4/Port 0x04.1 401 * 402 * 15: 1=RX receiving (RO). Set when a packet is being received 403 * into the RX FIFO. 404 * 14: Reserved 405 * 13: 1=RX underrun (RO). Generates Adapter Failure interrupt. 406 * Requires RX Reset or Global Reset command to recover. 407 * It is generated when you read past the end of a packet - 408 * reading past what has been received so far will give bad 409 * data. 410 * 12: 1=RX status overrun (RO). Set when there are already 8 411 * packets in the RX FIFO. While this bit is set, no additional 412 * packets are received. Requires no action on the part of 413 * the host. The condition is cleared once a packet has been 414 * read out of the RX FIFO. 415 * 11: 1=RX overrun (RO). Set when the RX FIFO is full (there 416 * may not be an overrun packet yet). While this bit is set, 417 * no additional packets will be received (some additional 418 * bytes can still be pending between the wire and the RX 419 * FIFO). Requires no action on the part of the host. The 420 * condition is cleared once a few bytes have been read out 421 * from the RX FIFO. 422 * 10: 1=TX overrun (RO). Generates adapter failure interrupt. 423 * Requires TX Reset or Global Reset command to recover. 424 * Disables Transmitter. 425 * 9-8: Unassigned. 426 * 7-0: Built in self test bits for the RX and TX FIFO's. 427 */ 428 #define FIFOS_RX_RECEIVING (u_short) 0x8000 429 #define FIFOS_RX_UNDERRUN (u_short) 0x2000 430 #define FIFOS_RX_STATUS_OVERRUN (u_short) 0x1000 431 #define FIFOS_RX_OVERRUN (u_short) 0x0800 432 #define FIFOS_TX_OVERRUN (u_short) 0x0400 433 434 /* 435 * ISA/eisa CONFIG_CNTRL media-present bits. 436 */ 437 #define EP_W0_CC_AUI (1<<13) 438 #define EP_W0_CC_BNC (1<<12) 439 #define EP_W0_CC_UTP (1<<9) 440 441 442 /* EEPROM state flags/commands */ 443 #define EEPROM_BUSY (1<<15) 444 #define EEPROM_TST_MODE (1<<14) 445 #define READ_EEPROM (1<<7) 446 447 /* window 4, MEDIA_STATUS bits */ 448 #define SQE_ENABLE 0x08 /* Enables SQE on AUI ports */ 449 #define JABBER_GUARD_ENABLE 0x40 450 #define LINKBEAT_ENABLE 0x80 451 #define ENABLE_UTP (JABBER_GUARD_ENABLE|LINKBEAT_ENABLE) 452 #define DISABLE_UTP 0x0 453 #define LINKBEAT_DETECT 0x800 454 455 /* 456 * ep_connectors softc media-preset bitflags 457 */ 458 #define EPC_AUI 0x01 459 #define EPC_BNC 0x02 460 #define EPC_RESERVED 0x04 461 #define EPC_UTP 0x08 462 #define EPC_100TX 0x10 463 #define EPC_100FX 0x20 464 #define EPC_MII 0x40 465 #define EPC_100T4 0x80 466 467 468 /* 469 * Misc defines for various things. 470 */ 471 #define TAG_ADAPTER 0xd0 472 #define ACTIVATE_ADAPTER_TO_CONFIG 0xff 473 #define ENABLE_DRQ_IRQ 0x0001 474 #define MFG_ID 0x506d /* `TCM' */ 475 #define PROD_ID 0x5090 476 #define GO_WINDOW(x) bus_space_write_2(sc->sc_iot, \ 477 sc->sc_ioh, EP_COMMAND, WINDOW_SELECT|x) 478 479 480 /* Used to probe for large-packet support. */ 481 #define EP_LARGEWIN_PROBE EP_THRESH_DISABLE 482 #define EP_LARGEWIN_MASK 0xffc 483
Indexes created Tue Sep 30 20:09:53 GMT 2025