if_edreg.h revision 73374
1/* 2 * Copyright (C) 1993, David Greenman. This software may be used, modified, 3 * copied, distributed, and sold, in both source and binary form provided 4 * that the above copyright and these terms are retained. Under no 5 * circumstances is the author responsible for the proper functioning 6 * of this software, nor does the author assume any responsibility 7 * for damages incurred with its use. 8 * 9 * $FreeBSD: head/sys/dev/ed/if_edreg.h 73374 2001-03-03 08:31:37Z imp $ 10 */ 11/* 12 * National Semiconductor DS8390 NIC register definitions 13 * 14 * 15 * Modification history 16 * 17 * Revision 2.2 1993/11/29 16:33:39 davidg 18 * From Thomas Sandford <t.d.g.sandford@comp.brad.ac.uk> 19 * Add support for the 8013W board type 20 * 21 * Revision 2.1 1993/11/22 10:52:33 davidg 22 * patch to add support for SMC8216 (Elite-Ultra) boards 23 * from Glen H. Lowe 24 * 25 * Revision 2.0 93/09/29 00:37:15 davidg 26 * changed double buffering flag to multi buffering 27 * made changes/additions for 3c503 multi-buffering 28 * ...companion to Rev. 2.0 of 'ed' driver. 29 * 30 * Revision 1.1 93/06/23 03:01:07 davidg 31 * Initial revision 32 * 33 */ 34 35/* 36 * Page 0 register offsets 37 */ 38#define ED_P0_CR 0x00 /* Command Register */ 39 40#define ED_P0_CLDA0 0x01 /* Current Local DMA Addr low (read) */ 41#define ED_P0_PSTART 0x01 /* Page Start register (write) */ 42 43#define ED_P0_CLDA1 0x02 /* Current Local DMA Addr high (read) */ 44#define ED_P0_PSTOP 0x02 /* Page Stop register (write) */ 45 46#define ED_P0_BNRY 0x03 /* Boundary Pointer */ 47 48#define ED_P0_TSR 0x04 /* Transmit Status Register (read) */ 49#define ED_P0_TPSR 0x04 /* Transmit Page Start (write) */ 50 51#define ED_P0_NCR 0x05 /* Number of Collisions Reg (read) */ 52#define ED_P0_TBCR0 0x05 /* Transmit Byte count, low (write) */ 53 54#define ED_P0_FIFO 0x06 /* FIFO register (read) */ 55#define ED_P0_TBCR1 0x06 /* Transmit Byte count, high (write) */ 56 57#define ED_P0_ISR 0x07 /* Interrupt Status Register */ 58 59#define ED_P0_CRDA0 0x08 /* Current Remote DMA Addr low (read) */ 60#define ED_P0_RSAR0 0x08 /* Remote Start Address low (write) */ 61 62#define ED_P0_CRDA1 0x09 /* Current Remote DMA Addr high (read) */ 63#define ED_P0_RSAR1 0x09 /* Remote Start Address high (write) */ 64 65#define ED_P0_RBCR0 0x0a /* Remote Byte Count low (write) */ 66 67#define ED_P0_RBCR1 0x0b /* Remote Byte Count high (write) */ 68 69#define ED_P0_RSR 0x0c /* Receive Status (read) */ 70#define ED_P0_RCR 0x0c /* Receive Configuration Reg (write) */ 71 72#define ED_P0_CNTR0 0x0d /* frame alignment error counter (read) */ 73#define ED_P0_TCR 0x0d /* Transmit Configuration Reg (write) */ 74 75#define ED_P0_CNTR1 0x0e /* CRC error counter (read) */ 76#define ED_P0_DCR 0x0e /* Data Configuration Reg (write) */ 77 78#define ED_P0_CNTR2 0x0f /* missed packet counter (read) */ 79#define ED_P0_IMR 0x0f /* Interrupt Mask Register (write) */ 80 81/* 82 * Page 1 register offsets 83 */ 84#define ED_P1_CR 0x00 /* Command Register */ 85#define ED_P1_PAR0 0x01 /* Physical Address Register 0 */ 86#define ED_P1_PAR1 0x02 /* Physical Address Register 1 */ 87#define ED_P1_PAR2 0x03 /* Physical Address Register 2 */ 88#define ED_P1_PAR3 0x04 /* Physical Address Register 3 */ 89#define ED_P1_PAR4 0x05 /* Physical Address Register 4 */ 90#define ED_P1_PAR5 0x06 /* Physical Address Register 5 */ 91#define ED_P1_PAR(i) (ED_P1_PAR0 + i) 92#define ED_P1_CURR 0x07 /* Current RX ring-buffer page */ 93#define ED_P1_MAR0 0x08 /* Multicast Address Register 0 */ 94#define ED_P1_MAR1 0x09 /* Multicast Address Register 1 */ 95#define ED_P1_MAR2 0x0a /* Multicast Address Register 2 */ 96#define ED_P1_MAR3 0x0b /* Multicast Address Register 3 */ 97#define ED_P1_MAR4 0x0c /* Multicast Address Register 4 */ 98#define ED_P1_MAR5 0x0d /* Multicast Address Register 5 */ 99#define ED_P1_MAR6 0x0e /* Multicast Address Register 6 */ 100#define ED_P1_MAR7 0x0f /* Multicast Address Register 7 */ 101#define ED_P1_MAR(i) (ED_P1_MAR0 + i) 102 103/* 104 * Page 2 register offsets 105 */ 106#define ED_P2_CR 0x00 /* Command Register */ 107#define ED_P2_PSTART 0x01 /* Page Start (read) */ 108#define ED_P2_CLDA0 0x01 /* Current Local DMA Addr 0 (write) */ 109#define ED_P2_PSTOP 0x02 /* Page Stop (read) */ 110#define ED_P2_CLDA1 0x02 /* Current Local DMA Addr 1 (write) */ 111#define ED_P2_RNPP 0x03 /* Remote Next Packet Pointer */ 112#define ED_P2_TPSR 0x04 /* Transmit Page Start (read) */ 113#define ED_P2_LNPP 0x05 /* Local Next Packet Pointer */ 114#define ED_P2_ACU 0x06 /* Address Counter Upper */ 115#define ED_P2_ACL 0x07 /* Address Counter Lower */ 116#define ED_P2_RCR 0x0c /* Receive Configuration Register (read) */ 117#define ED_P2_TCR 0x0d /* Transmit Configuration Register (read) */ 118#define ED_P2_DCR 0x0e /* Data Configuration Register (read) */ 119#define ED_P2_IMR 0x0f /* Interrupt Mask Register (read) */ 120 121/* 122 * Command Register (CR) definitions 123 */ 124 125/* 126 * STP: SToP. Software reset command. Takes the controller offline. No 127 * packets will be received or transmitted. Any reception or 128 * transmission in progress will continue to completion before 129 * entering reset state. To exit this state, the STP bit must 130 * reset and the STA bit must be set. The software reset has 131 * executed only when indicated by the RST bit in the ISR being 132 * set. 133 */ 134#define ED_CR_STP 0x01 135 136/* 137 * STA: STArt. This bit is used to activate the NIC after either power-up, 138 * or when the NIC has been put in reset mode by software command 139 * or error. 140 */ 141#define ED_CR_STA 0x02 142 143/* 144 * TXP: Transmit Packet. This bit must be set to indicate transmission of 145 * a packet. TXP is internally reset either after the transmission is 146 * completed or aborted. This bit should be set only after the Transmit 147 * Byte Count and Transmit Page Start register have been programmed. 148 */ 149#define ED_CR_TXP 0x04 150 151/* 152 * RD0, RD1, RD2: Remote DMA Command. These three bits control the operation 153 * of the remote DMA channel. RD2 can be set to abort any remote DMA 154 * command in progress. The Remote Byte Count registers should be cleared 155 * when a remote DMA has been aborted. The Remote Start Addresses are not 156 * restored to the starting address if the remote DMA is aborted. 157 * 158 * RD2 RD1 RD0 function 159 * 0 0 0 not allowed 160 * 0 0 1 remote read 161 * 0 1 0 remote write 162 * 0 1 1 send packet 163 * 1 X X abort 164 */ 165#define ED_CR_RD0 0x08 166#define ED_CR_RD1 0x10 167#define ED_CR_RD2 0x20 168 169/* 170 * PS0, PS1: Page Select. The two bits select which register set or 'page' to 171 * access. 172 * 173 * PS1 PS0 page 174 * 0 0 0 175 * 0 1 1 176 * 1 0 2 177 * 1 1 reserved 178 */ 179#define ED_CR_PS0 0x40 180#define ED_CR_PS1 0x80 181/* bit encoded aliases */ 182#define ED_CR_PAGE_0 0x00 /* (for consistency) */ 183#define ED_CR_PAGE_1 0x40 184#define ED_CR_PAGE_2 0x80 185 186/* 187 * Interrupt Status Register (ISR) definitions 188 */ 189 190/* 191 * PRX: Packet Received. Indicates packet received with no errors. 192 */ 193#define ED_ISR_PRX 0x01 194 195/* 196 * PTX: Packet Transmitted. Indicates packet transmitted with no errors. 197 */ 198#define ED_ISR_PTX 0x02 199 200/* 201 * RXE: Receive Error. Indicates that a packet was received with one or more 202 * the following errors: CRC error, frame alignment error, FIFO overrun, 203 * missed packet. 204 */ 205#define ED_ISR_RXE 0x04 206 207/* 208 * TXE: Transmission Error. Indicates that an attempt to transmit a packet 209 * resulted in one or more of the following errors: excessive 210 * collisions, FIFO underrun. 211 */ 212#define ED_ISR_TXE 0x08 213 214/* 215 * OVW: OverWrite. Indicates a receive ring-buffer overrun. Incoming network 216 * would exceed (has exceeded?) the boundary pointer, resulting in data 217 * that was previously received and not yet read from the buffer to be 218 * overwritten. 219 */ 220#define ED_ISR_OVW 0x10 221 222/* 223 * CNT: Counter Overflow. Set when the MSB of one or more of the Network Talley 224 * Counters has been set. 225 */ 226#define ED_ISR_CNT 0x20 227 228/* 229 * RDC: Remote Data Complete. Indicates that a Remote DMA operation has completed. 230 */ 231#define ED_ISR_RDC 0x40 232 233/* 234 * RST: Reset status. Set when the NIC enters the reset state and cleared when a 235 * Start Command is issued to the CR. This bit is also set when a receive 236 * ring-buffer overrun (OverWrite) occurs and is cleared when one or more 237 * packets have been removed from the ring. This is a read-only bit. 238 */ 239#define ED_ISR_RST 0x80 240 241/* 242 * Interrupt Mask Register (IMR) definitions 243 */ 244 245/* 246 * PRXE: Packet Received interrupt Enable. If set, a received packet will cause 247 * an interrupt. 248 */ 249#define ED_IMR_PRXE 0x01 250 251/* 252 * PTXE: Packet Transmit interrupt Enable. If set, an interrupt is generated when 253 * a packet transmission completes. 254 */ 255#define ED_IMR_PTXE 0x02 256 257/* 258 * RXEE: Receive Error interrupt Enable. If set, an interrupt will occur whenever a 259 * packet is received with an error. 260 */ 261#define ED_IMR_RXEE 0x04 262 263/* 264 * TXEE: Transmit Error interrupt Enable. If set, an interrupt will occur whenever 265 * a transmission results in an error. 266 */ 267#define ED_IMR_TXEE 0x08 268 269/* 270 * OVWE: OverWrite error interrupt Enable. If set, an interrupt is generated whenever 271 * the receive ring-buffer is overrun. i.e. when the boundary pointer is exceeded. 272 */ 273#define ED_IMR_OVWE 0x10 274 275/* 276 * CNTE: Counter overflow interrupt Enable. If set, an interrupt is generated whenever 277 * the MSB of one or more of the Network Statistics counters has been set. 278 */ 279#define ED_IMR_CNTE 0x20 280 281/* 282 * RDCE: Remote DMA Complete interrupt Enable. If set, an interrupt is generated 283 * when a remote DMA transfer has completed. 284 */ 285#define ED_IMR_RDCE 0x40 286 287/* 288 * bit 7 is unused/reserved 289 */ 290 291/* 292 * Data Configuration Register (DCR) definitions 293 */ 294 295/* 296 * WTS: Word Transfer Select. WTS establishes byte or word transfers for 297 * both remote and local DMA transfers 298 */ 299#define ED_DCR_WTS 0x01 300 301/* 302 * BOS: Byte Order Select. BOS sets the byte order for the host. 303 * Should be 0 for 80x86, and 1 for 68000 series processors 304 */ 305#define ED_DCR_BOS 0x02 306 307/* 308 * LAS: Long Address Select. When LAS is 1, the contents of the remote 309 * DMA registers RSAR0 and RSAR1 are used to provide A16-A31 310 */ 311#define ED_DCR_LAS 0x04 312 313/* 314 * LS: Loopback Select. When 0, loopback mode is selected. Bits D1 and D2 315 * of the TCR must also be programmed for loopback operation. 316 * When 1, normal operation is selected. 317 */ 318#define ED_DCR_LS 0x08 319 320/* 321 * AR: Auto-initialize Remote. When 0, data must be removed from ring-buffer 322 * under program control. When 1, remote DMA is automatically initiated 323 * and the boundary pointer is automatically updated 324 */ 325#define ED_DCR_AR 0x10 326 327/* 328 * FT0, FT1: Fifo Threshold select. 329 * FT1 FT0 Word-width Byte-width 330 * 0 0 1 word 2 bytes 331 * 0 1 2 words 4 bytes 332 * 1 0 4 words 8 bytes 333 * 1 1 8 words 12 bytes 334 * 335 * During transmission, the FIFO threshold indicates the number of bytes 336 * or words that the FIFO has filled from the local DMA before BREQ is 337 * asserted. The transmission threshold is 16 bytes minus the receiver 338 * threshold. 339 */ 340#define ED_DCR_FT0 0x20 341#define ED_DCR_FT1 0x40 342 343/* 344 * bit 7 (0x80) is unused/reserved 345 */ 346 347/* 348 * Transmit Configuration Register (TCR) definitions 349 */ 350 351/* 352 * CRC: Inhibit CRC. If 0, CRC will be appended by the transmitter, if 0, CRC 353 * is not appended by the transmitter. 354 */ 355#define ED_TCR_CRC 0x01 356 357/* 358 * LB0, LB1: Loopback control. These two bits set the type of loopback that is 359 * to be performed. 360 * 361 * LB1 LB0 mode 362 * 0 0 0 - normal operation (DCR_LS = 0) 363 * 0 1 1 - internal loopback (DCR_LS = 0) 364 * 1 0 2 - external loopback (DCR_LS = 1) 365 * 1 1 3 - external loopback (DCR_LS = 0) 366 */ 367#define ED_TCR_LB0 0x02 368#define ED_TCR_LB1 0x04 369 370/* 371 * ATD: Auto Transmit Disable. Clear for normal operation. When set, allows 372 * another station to disable the NIC's transmitter by transmitting to 373 * a multicast address hashing to bit 62. Reception of a multicast address 374 * hashing to bit 63 enables the transmitter. 375 */ 376#define ED_TCR_ATD 0x08 377 378/* 379 * OFST: Collision Offset enable. This bit when set modifies the backoff 380 * algorithm to allow prioritization of nodes. 381 */ 382#define ED_TCR_OFST 0x10 383 384/* 385 * bits 5, 6, and 7 are unused/reserved 386 */ 387 388/* 389 * Transmit Status Register (TSR) definitions 390 */ 391 392/* 393 * PTX: Packet Transmitted. Indicates successful transmission of packet. 394 */ 395#define ED_TSR_PTX 0x01 396 397/* 398 * bit 1 (0x02) is unused/reserved 399 */ 400 401/* 402 * COL: Transmit Collided. Indicates that the transmission collided at least 403 * once with another station on the network. 404 */ 405#define ED_TSR_COL 0x04 406 407/* 408 * ABT: Transmit aborted. Indicates that the transmission was aborted due to 409 * excessive collisions. 410 */ 411#define ED_TSR_ABT 0x08 412 413/* 414 * CRS: Carrier Sense Lost. Indicates that carrier was lost during the 415 * transmission of the packet. (Transmission is not aborted because 416 * of a loss of carrier) 417 */ 418#define ED_TSR_CRS 0x10 419 420/* 421 * FU: FIFO Underrun. Indicates that the NIC wasn't able to access bus/ 422 * transmission memory before the FIFO emptied. Transmission of the 423 * packet was aborted. 424 */ 425#define ED_TSR_FU 0x20 426 427/* 428 * CDH: CD Heartbeat. Indicates that the collision detection circuitry 429 * isn't working correctly during a collision heartbeat test. 430 */ 431#define ED_TSR_CDH 0x40 432 433/* 434 * OWC: Out of Window Collision: Indicates that a collision occurred after 435 * a slot time (51.2us). The transmission is rescheduled just as in 436 * normal collisions. 437 */ 438#define ED_TSR_OWC 0x80 439 440/* 441 * Receiver Configuration Register (RCR) definitions 442 */ 443 444/* 445 * SEP: Save Errored Packets. If 0, error packets are discarded. If set to 1, 446 * packets with CRC and frame errors are not discarded. 447 */ 448#define ED_RCR_SEP 0x01 449 450/* 451 * AR: Accept Runt packet. If 0, packet with less than 64 byte are discarded. 452 * If set to 1, packets with less than 64 byte are not discarded. 453 */ 454#define ED_RCR_AR 0x02 455 456/* 457 * AB: Accept Broadcast. If set, packets sent to the broadcast address will be 458 * accepted. 459 */ 460#define ED_RCR_AB 0x04 461 462/* 463 * AM: Accept Multicast. If set, packets sent to a multicast address are checked 464 * for a match in the hashing array. If clear, multicast packets are ignored. 465 */ 466#define ED_RCR_AM 0x08 467 468/* 469 * PRO: Promiscuous Physical. If set, all packets with a physical addresses are 470 * accepted. If clear, a physical destination address must match this 471 * station's address. Note: for full promiscuous mode, RCR_AB and RCR_AM 472 * must also be set. In addition, the multicast hashing array must be set 473 * to all 1's so that all multicast addresses are accepted. 474 */ 475#define ED_RCR_PRO 0x10 476 477/* 478 * MON: Monitor Mode. If set, packets will be checked for good CRC and framing, 479 * but are not stored in the ring-buffer. If clear, packets are stored (normal 480 * operation). 481 */ 482#define ED_RCR_MON 0x20 483 484/* 485 * INTT: Interrupt Trigger Mode for AX88190. 486 */ 487#define ED_RCR_INTT 0x40 488 489/* 490 * bit 7 is unused/reserved. 491 */ 492 493/* 494 * Receiver Status Register (RSR) definitions 495 */ 496 497/* 498 * PRX: Packet Received without error. 499 */ 500#define ED_RSR_PRX 0x01 501 502/* 503 * CRC: CRC error. Indicates that a packet has a CRC error. Also set for frame 504 * alignment errors. 505 */ 506#define ED_RSR_CRC 0x02 507 508/* 509 * FAE: Frame Alignment Error. Indicates that the incoming packet did not end on 510 * a byte boundary and the CRC did not match at the last byte boundary. 511 */ 512#define ED_RSR_FAE 0x04 513 514/* 515 * FO: FIFO Overrun. Indicates that the FIFO was not serviced (during local DMA) 516 * causing it to overrun. Reception of the packet is aborted. 517 */ 518#define ED_RSR_FO 0x08 519 520/* 521 * MPA: Missed Packet. Indicates that the received packet couldn't be stored in 522 * the ring-buffer because of insufficient buffer space (exceeding the 523 * boundary pointer), or because the transfer to the ring-buffer was inhibited 524 * by RCR_MON - monitor mode. 525 */ 526#define ED_RSR_MPA 0x10 527 528/* 529 * PHY: Physical address. If 0, the packet received was sent to a physical address. 530 * If 1, the packet was accepted because of a multicast/broadcast address 531 * match. 532 */ 533#define ED_RSR_PHY 0x20 534 535/* 536 * DIS: Receiver Disabled. Set to indicate that the receiver has entered monitor 537 * mode. Cleared when the receiver exits monitor mode. 538 */ 539#define ED_RSR_DIS 0x40 540 541/* 542 * DFR: Deferring. Set to indicate a 'jabber' condition. The CRS and COL inputs 543 * are active, and the transceiver has set the CD line as a result of the 544 * jabber. 545 */ 546#define ED_RSR_DFR 0x80 547 548/* 549 * receive ring descriptor 550 * 551 * The National Semiconductor DS8390 Network interface controller uses 552 * the following receive ring headers. The way this works is that the 553 * memory on the interface card is chopped up into 256 bytes blocks. 554 * A contiguous portion of those blocks are marked for receive packets 555 * by setting start and end block #'s in the NIC. For each packet that 556 * is put into the receive ring, one of these headers (4 bytes each) is 557 * tacked onto the front. The first byte is a copy of the receiver status 558 * register at the time the packet was received. 559 */ 560struct ed_ring { 561 u_char rsr; /* receiver status */ 562 u_char next_packet; /* pointer to next packet */ 563 u_short count; /* bytes in packet (length + 4) */ 564}; 565 566/* 567 * Common constants 568 */ 569#define ED_PAGE_SIZE 256 /* Size of RAM pages in bytes */ 570#define ED_TXBUF_SIZE 6 /* Size of TX buffer in pages */ 571 572/* 573 * Vendor types 574 */ 575#define ED_VENDOR_WD_SMC 0x00 /* Western Digital/SMC */ 576#define ED_VENDOR_3COM 0x01 /* 3Com */ 577#define ED_VENDOR_NOVELL 0x02 /* Novell */ 578#define ED_VENDOR_PCCARD 0x03 /* PCMCIA/PCCARD */ 579#define ED_VENDOR_HP 0x04 /* Hewlett Packard */ 580 581/* 582 * Compile-time config flags 583 */ 584/* 585 * this sets the default for enabling/disabling the transceiver 586 */ 587#define ED_FLAGS_DISABLE_TRANCEIVER 0x0001 588 589/* 590 * This forces the board to be used in 8/16bit mode even if it 591 * autoconfigs differently 592 */ 593#define ED_FLAGS_FORCE_8BIT_MODE 0x0002 594#define ED_FLAGS_FORCE_16BIT_MODE 0x0004 595 596/* 597 * This disables the use of double transmit buffers. 598 */ 599#define ED_FLAGS_NO_MULTI_BUFFERING 0x0008 600 601/* 602 * This forces all operations with the NIC memory to use Programmed 603 * I/O (i.e. not via shared memory) 604 */ 605#define ED_FLAGS_FORCE_PIO 0x0010 606 607/* 608 * These are flags describing the chip type. 609 */ 610#define ED_FLAGS_TOSH_ETHER 0x10000 611#define ED_FLAGS_GWETHER 0x20000 612#define ED_FLAGS_AX88190 0x30000 613#define ED_FLAGS_LINKSYS 0x80000 614 615#define ED_FLAGS_GETTYPE(flg) ((flg) & 0xff0000) 616 617/* 618 * Definitions for Western digital/SMC WD80x3 series ASIC 619 */ 620/* 621 * Memory Select Register (MSR) 622 */ 623#define ED_WD_MSR 0 624 625/* next three definitions for Toshiba */ 626#define ED_WD_MSR_POW 0x02 /* 0 = power save, 1 = normal (R/W) */ 627#define ED_WD_MSR_BSY 0x04 /* gate array busy (R) */ 628#define ED_WD_MSR_LEN 0x20 /* data bus width, 0 = 16 bits, 629 1 = 8 bits (R/W) */ 630#define ED_WD_MSR_ADDR 0x3f /* Memory decode bits 18-13 */ 631#define ED_WD_MSR_MENB 0x40 /* Memory enable */ 632#define ED_WD_MSR_RST 0x80 /* Reset board */ 633 634/* 635 * Interface Configuration Register (ICR) 636 */ 637#define ED_WD_ICR 1 638 639#define ED_WD_ICR_16BIT 0x01 /* 16-bit interface */ 640#define ED_WD_ICR_OAR 0x02 /* select register. 0=BIO 1=EAR */ 641#define ED_WD_ICR_IR2 0x04 /* high order bit of encoded IRQ */ 642#define ED_WD_ICR_MSZ 0x08 /* memory size (0=8k 1=32k) */ 643#define ED_WD_ICR_RLA 0x10 /* recall LAN address */ 644#define ED_WD_ICR_RX7 0x20 /* recall all but i/o and LAN address */ 645#define ED_WD_ICR_RIO 0x40 /* recall i/o address */ 646#define ED_WD_ICR_STO 0x80 /* store to non-volatile memory */ 647#define ED_WD_ICR_MEM 0xe0 /* shared mem address A15-A13 (R/W) */ 648#define ED_WD_ICR_MSZ1 0x0f /* memory size, 0x08 = 64K, 0x04 = 32K, 649 0x02 = 16K, 0x01 = 8K */ 650 /* 64K can only be used if mem address 651 above 1Mb */ 652 /* IAR holds address A23-A16 (R/W) */ 653 654/* 655 * IO Address Register (IAR) 656 */ 657#define ED_WD_IAR 2 658 659/* 660 * EEROM Address Register 661 */ 662#define ED_WD_EAR 3 663 664/* 665 * Interrupt Request Register (IRR) 666 */ 667#define ED_WD_IRR 4 668 669#define ED_WD_IRR_0WS 0x01 /* use 0 wait-states on 8 bit bus */ 670#define ED_WD_IRR_OUT1 0x02 /* WD83C584 pin 1 output */ 671#define ED_WD_IRR_OUT2 0x04 /* WD83C584 pin 2 output */ 672#define ED_WD_IRR_OUT3 0x08 /* WD83C584 pin 3 output */ 673#define ED_WD_IRR_FLASH 0x10 /* Flash RAM is in the ROM socket */ 674 675/* 676 * The three bits of the encoded IRQ are decoded as follows: 677 * 678 * IR2 IR1 IR0 IRQ 679 * 0 0 0 2/9 680 * 0 0 1 3 681 * 0 1 0 5 682 * 0 1 1 7 683 * 1 0 0 10 684 * 1 0 1 11 685 * 1 1 0 15 686 * 1 1 1 4 687 */ 688#define ED_WD_IRR_IR0 0x20 /* bit 0 of encoded IRQ */ 689#define ED_WD_IRR_IR1 0x40 /* bit 1 of encoded IRQ */ 690#define ED_WD_IRR_IEN 0x80 /* Interrupt enable */ 691 692/* 693 * LA Address Register (LAAR) 694 */ 695#define ED_WD_LAAR 5 696 697#define ED_WD_LAAR_ADDRHI 0x1f /* bits 23-19 of RAM address */ 698#define ED_WD_LAAR_0WS16 0x20 /* enable 0 wait-states on 16 bit bus */ 699#define ED_WD_LAAR_L16EN 0x40 /* enable 16-bit operation */ 700#define ED_WD_LAAR_M16EN 0x80 /* enable 16-bit memory access */ 701 702/* i/o base offset to station address/card-ID PROM */ 703#define ED_WD_PROM 8 704 705/* 706 * 83C790 specific registers 707 */ 708/* 709 * Hardware Support Register (HWR) ('790) 710 */ 711#define ED_WD790_HWR 4 712 713#define WD_WD790_HWR_NUKE 0x10 /* hardware reset */ 714#define ED_WD790_HWR_LPRM 0x40 /* LAN PROM select */ 715#define ED_WD790_HWR_SWH 0x80 /* switch register set */ 716 717/* 718 * ICR790 Interrupt Control Register for the 83C790 719 */ 720#define ED_WD790_ICR 6 721 722#define ED_WD790_ICR_EIL 0x01 /* enable interrupts */ 723 724/* 725 * REV/IOPA Revision / I/O Pipe register for the 83C79X 726 */ 727#define ED_WD790_REV 7 728 729#define ED_WD790 0x20 730#define ED_WD795 0x40 731 732/* 733 * 79X RAM Address Register (RAR) 734 * Enabled with SWH bit=1 in HWR register 735 */ 736#define ED_WD790_RAR 0x0b 737 738#define ED_WD790_RAR_SZ8 0x00 /* 8k memory buffer */ 739#define ED_WD790_RAR_SZ16 0x10 /* 16k memory buffer */ 740#define ED_WD790_RAR_SZ32 0x20 /* 32k memory buffer */ 741#define ED_WD790_RAR_SZ64 0x30 /* 64k memory buffer */ 742 743/* 744 * General Control Register (GCR) 745 * Enabled with SWH bit=1 in HWR register 746 */ 747#define ED_WD790_GCR 0x0d 748 749#define ED_WD790_GCR_IR0 0x04 /* bit 0 of encoded IRQ */ 750#define ED_WD790_GCR_IR1 0x08 /* bit 1 of encoded IRQ */ 751#define ED_WD790_GCR_ZWSEN 0x20 /* zero wait state enable */ 752#define ED_WD790_GCR_IR2 0x40 /* bit 2 of encoded IRQ */ 753#define ED_WD790_GCR_LIT 0x01 /* Link Integrity Test Enable */ 754/* 755 * The three bits of the encoded IRQ are decoded as follows: 756 * 757 * IR2 IR1 IR0 IRQ 758 * 0 0 0 none 759 * 0 0 1 9 760 * 0 1 0 3 761 * 0 1 1 5 762 * 1 0 0 7 763 * 1 0 1 10 764 * 1 1 0 11 765 * 1 1 1 15 766 */ 767 768/* i/o base offset to CARD ID */ 769#define ED_WD_CARD_ID ED_WD_PROM+6 770 771/* Board type codes in card ID */ 772#define ED_TYPE_WD8003S 0x02 773#define ED_TYPE_WD8003E 0x03 774#define ED_TYPE_WD8013EBT 0x05 775#define ED_TYPE_TOSHIBA1 0x11 /* named PCETA1 */ 776#define ED_TYPE_TOSHIBA2 0x12 /* named PCETA2 */ 777#define ED_TYPE_TOSHIBA3 0x13 /* named PCETB */ 778#define ED_TYPE_TOSHIBA4 0x14 /* named PCETC */ 779#define ED_TYPE_WD8003W 0x24 780#define ED_TYPE_WD8003EB 0x25 781#define ED_TYPE_WD8013W 0x26 782#define ED_TYPE_WD8013EP 0x27 783#define ED_TYPE_WD8013WC 0x28 784#define ED_TYPE_WD8013EPC 0x29 785#define ED_TYPE_SMC8216T 0x2a 786#define ED_TYPE_SMC8216C 0x2b 787#define ED_TYPE_WD8013EBP 0x2c 788 789/* Bit definitions in card ID */ 790#define ED_WD_REV_MASK 0x1f /* Revision mask */ 791#define ED_WD_SOFTCONFIG 0x20 /* Soft config */ 792#define ED_WD_LARGERAM 0x40 /* Large RAM */ 793#define ED_MICROCHANEL 0x80 /* Microchannel bus (vs. isa) */ 794 795/* 796 * Checksum total. All 8 bytes in station address PROM will add up to this 797 */ 798#define ED_WD_ROM_CHECKSUM_TOTAL 0xFF 799#define ED_WD_ROM_CHECKSUM_TOTAL_TOSH_ETHER 0xA5 800 801#define ED_WD_NIC_OFFSET 0x10 /* I/O base offset to NIC */ 802#define ED_WD_ASIC_OFFSET 0 /* I/O base offset to ASIC */ 803#define ED_WD_IO_PORTS 32 /* # of i/o addresses used */ 804 805#define ED_WD_PAGE_OFFSET 0 /* page offset for NIC access to mem */ 806 807/* 808 * Definitions for 3Com 3c503 809 */ 810#define ED_3COM_NIC_OFFSET 0 811#define ED_3COM_ASIC_OFFSET 0x400 /* offset to nic i/o regs */ 812 813/* 814 * XXX - The I/O address range is fragmented in the 3c503; this is the 815 * number of regs at iobase. 816 */ 817#define ED_3COM_IO_PORTS 16 /* # of i/o addresses used */ 818 819/* tx memory starts in second bank on 8bit cards */ 820#define ED_3COM_TX_PAGE_OFFSET_8BIT 0x20 821 822/* tx memory starts in first bank on 16bit cards */ 823#define ED_3COM_TX_PAGE_OFFSET_16BIT 0x0 824 825/* ...and rx memory starts in second bank */ 826#define ED_3COM_RX_PAGE_OFFSET_16BIT 0x20 827 828 829/* 830 * Page Start Register. Must match PSTART in NIC 831 */ 832#define ED_3COM_PSTR 0 833 834/* 835 * Page Stop Register. Must match PSTOP in NIC 836 */ 837#define ED_3COM_PSPR 1 838 839/* 840 * Drq Timer Register. Determines number of bytes to be transfered during 841 * a DMA burst. 842 */ 843#define ED_3COM_DQTR 2 844 845/* 846 * Base Configuration Register. Read-only register which contains the 847 * board-configured I/O base address of the adapter. Bit encoded. 848 */ 849#define ED_3COM_BCFR 3 850 851#define ED_3COM_BCFR_2E0 0x01 852#define ED_3COM_BCFR_2A0 0x02 853#define ED_3COM_BCFR_280 0x04 854#define ED_3COM_BCFR_250 0x08 855#define ED_3COM_BCFR_350 0x10 856#define ED_3COM_BCFR_330 0x20 857#define ED_3COM_BCFR_310 0x40 858#define ED_3COM_BCFR_300 0x80 859 860/* 861 * EPROM Configuration Register. Read-only register which contains the 862 * board-configured memory base address. Bit encoded. 863 */ 864#define ED_3COM_PCFR 4 865 866#define ED_3COM_PCFR_C8000 0x10 867#define ED_3COM_PCFR_CC000 0x20 868#define ED_3COM_PCFR_D8000 0x40 869#define ED_3COM_PCFR_DC000 0x80 870 871/* 872 * GA Configuration Register. Gate-Array Configuration Register. 873 */ 874#define ED_3COM_GACFR 5 875 876/* 877 * mbs2 mbs1 mbs0 start address 878 * 0 0 0 0x0000 879 * 0 0 1 0x2000 880 * 0 1 0 0x4000 881 * 0 1 1 0x6000 882 * 883 * Note that with adapters with only 8K, the setting for 0x2000 must 884 * always be used. 885 */ 886#define ED_3COM_GACFR_MBS0 0x01 887#define ED_3COM_GACFR_MBS1 0x02 888#define ED_3COM_GACFR_MBS2 0x04 889 890#define ED_3COM_GACFR_RSEL 0x08 /* enable shared memory */ 891#define ED_3COM_GACFR_TEST 0x10 /* for GA testing */ 892#define ED_3COM_GACFR_OWS 0x20 /* select 0WS access to GA */ 893#define ED_3COM_GACFR_TCM 0x40 /* Mask DMA interrupts */ 894#define ED_3COM_GACFR_NIM 0x80 /* Mask NIC interrupts */ 895 896/* 897 * Control Register. Miscellaneous control functions. 898 */ 899#define ED_3COM_CR 6 900 901#define ED_3COM_CR_RST 0x01 /* Reset GA and NIC */ 902#define ED_3COM_CR_XSEL 0x02 /* Transceiver select. BNC=1(def) AUI=0 */ 903#define ED_3COM_CR_EALO 0x04 /* window EA PROM 0-15 to I/O base */ 904#define ED_3COM_CR_EAHI 0x08 /* window EA PROM 16-31 to I/O base */ 905#define ED_3COM_CR_SHARE 0x10 /* select interrupt sharing option */ 906#define ED_3COM_CR_DBSEL 0x20 /* Double buffer select */ 907#define ED_3COM_CR_DDIR 0x40 /* DMA direction select */ 908#define ED_3COM_CR_START 0x80 /* Start DMA controller */ 909 910/* 911 * Status Register. Miscellaneous status information. 912 */ 913#define ED_3COM_STREG 7 914 915#define ED_3COM_STREG_REV 0x07 /* GA revision */ 916#define ED_3COM_STREG_DIP 0x08 /* DMA in progress */ 917#define ED_3COM_STREG_DTC 0x10 /* DMA terminal count */ 918#define ED_3COM_STREG_OFLW 0x20 /* Overflow */ 919#define ED_3COM_STREG_UFLW 0x40 /* Underflow */ 920#define ED_3COM_STREG_DPRDY 0x80 /* Data port ready */ 921 922/* 923 * Interrupt/DMA Configuration Register 924 */ 925#define ED_3COM_IDCFR 8 926 927#define ED_3COM_IDCFR_DRQ0 0x01 /* DMA request 1 select */ 928#define ED_3COM_IDCFR_DRQ1 0x02 /* DMA request 2 select */ 929#define ED_3COM_IDCFR_DRQ2 0x04 /* DMA request 3 select */ 930#define ED_3COM_IDCFR_UNUSED 0x08 /* not used */ 931#define ED_3COM_IDCFR_IRQ2 0x10 /* Interrupt request 2 select */ 932#define ED_3COM_IDCFR_IRQ3 0x20 /* Interrupt request 3 select */ 933#define ED_3COM_IDCFR_IRQ4 0x40 /* Interrupt request 4 select */ 934#define ED_3COM_IDCFR_IRQ5 0x80 /* Interrupt request 5 select */ 935 936/* 937 * DMA Address Register MSB 938 */ 939#define ED_3COM_DAMSB 9 940 941/* 942 * DMA Address Register LSB 943 */ 944#define ED_3COM_DALSB 0x0a 945 946/* 947 * Vector Pointer Register 2 948 */ 949#define ED_3COM_VPTR2 0x0b 950 951/* 952 * Vector Pointer Register 1 953 */ 954#define ED_3COM_VPTR1 0x0c 955 956/* 957 * Vector Pointer Register 0 958 */ 959#define ED_3COM_VPTR0 0x0d 960 961/* 962 * Register File Access MSB 963 */ 964#define ED_3COM_RFMSB 0x0e 965 966/* 967 * Register File Access LSB 968 */ 969#define ED_3COM_RFLSB 0x0f 970 971/* 972 * Definitions for Novell NE1000/2000 boards 973 */ 974 975/* 976 * Board type codes 977 */ 978#define ED_TYPE_NE1000 0x01 979#define ED_TYPE_NE2000 0x02 980 981/* 982 * Register offsets/total 983 */ 984#define ED_NOVELL_NIC_OFFSET 0x00 985#define ED_NOVELL_ASIC_OFFSET 0x10 986#define ED_NOVELL_IO_PORTS 32 987 988/* 989 * Remote DMA data register; for reading or writing to the NIC mem 990 * via programmed I/O (offset from ASIC base) 991 */ 992#define ED_NOVELL_DATA 0x00 993 994/* 995 * Reset register; reading from this register causes a board reset 996 */ 997#define ED_NOVELL_RESET 0x0f 998 999/* 1000 * Definitions for PCCARD 1001 */ 1002#define ED_PC_PAGE_OFFSET 0x40 /* page offset for NIC access to mem */ 1003#define ED_PC_IO_PORTS 32 1004#define ED_PC_ASIC_OFFSET 0x10 1005#define ED_PC_RESET 0x0f /* Reset(offset from ASIC base) */ 1006#define ED_PC_MISC 0x08 /* Misc (offset from ASIC base) */ 1007 1008/* 1009 * if_ze.h constants 1010 */ 1011 1012#define ZE_PAGE_OFFSET 0x40 /* mem buffer starts at 0x4000 */ 1013 1014#define ZE_DATA_IO 0x10 1015#define ZE_MISC 0x18 1016#define ZE_RESET 0x1F 1017 1018/* 1019 * Definitions for HP PC LAN Adapter Plus; based on the CRYNWR packet 1020 * driver for the card. 1021 */ 1022 1023#define ED_HPP_ASIC_OFFSET 0x00 /* Offset to ASIC registers */ 1024#define ED_HPP_NIC_OFFSET 0x10 /* Offset to 8390 registers */ 1025 1026#define ED_HPP_ID 0x00 /* ID register, always 0x4850 */ 1027#define ED_HPP_PAGING 0x02 /* Page select register */ 1028#define ED_HPP_OPTION 0x04 /* Bitmask of supported options */ 1029#define ED_HPP_PAGE_0 0x08 /* Page 0 */ 1030#define ED_HPP_PAGE_2 0x0A /* Page 2 */ 1031#define ED_HPP_PAGE_4 0x0C /* Page 4 */ 1032#define ED_HPP_PAGE_6 0x0E /* Page 6 */ 1033 1034/* PERF PAGE */ 1035#define ED_HPP_OUT_ADDR ED_HPP_PAGE_0 /* I/O output location */ 1036#define ED_HPP_IN_ADDR ED_HPP_PAGE_2 /* I/O input location */ 1037#define ED_HPP_DATAPORT ED_HPP_PAGE_4 /* I/O data transfer */ 1038/* MAC PAGE */ 1039#define ED_HPP_MAC_ADDR 0x08 /* Offset of MAC address in MAC page */ 1040 1041#define ED_HPP_IO_PORTS 32 /* Number of IO ports */ 1042 1043#define ED_HPP_TX_PAGE_OFFSET 0x00 /* first page of TX buffer */ 1044#define ED_HPP_RX_PAGE_START 0x06 /* start at page 6 */ 1045#define ED_HPP_RX_PAGE_STOP 0x80 /* end at page 128 */ 1046 1047/* 1048 * Register pages supported. 1049 */ 1050 1051#define ED_HPP_PAGE_PERF 0 /* Normal operation */ 1052#define ED_HPP_PAGE_MAC 1 /* The ethernet address and checksum */ 1053#define ED_HPP_PAGE_HW 2 /* Hardware parameters in EEPROM */ 1054#define ED_HPP_PAGE_LAN 4 /* Transciever selection etc */ 1055#define ED_HPP_PAGE_ID 6 /* ID */ 1056 1057/* 1058 * Options supported. 1059 */ 1060 1061#define ED_HPP_OPTION_NIC_RESET 0x0001 /* active low */ 1062#define ED_HPP_OPTION_CHIP_RESET 0x0002 /* active low */ 1063#define ED_HPP_OPTION_ENABLE_IRQ 0x0004 1064#define ED_HPP_OPTION_FAKE_INTR 0x0008 1065#define ED_HPP_OPTION_BOOT_ROM_ENB 0x0010 1066#define ED_HPP_OPTION_IO_ENB 0x0020 1067#define ED_HPP_OPTION_MEM_ENABLE 0x0040 1068#define ED_HPP_OPTION_ZERO_WAIT 0x0080 1069#define ED_HPP_OPTION_MEM_DISABLE 0x1000 1070 1071/* 1072 * Page ID configuration. 1073 */ 1074 1075#define ED_HPP_ID_REVISION_MASK 0x0300 /* revision id */ 1076#define ED_HPP_ID_SOFT_MODEL_MASK 0xFC00 /* soft model number */ 1077#define ED_HPP_ID_16_BIT_ACCESS 0x0010 /* if set use 16 bit accesses */ 1078#define ED_HPP_ID_TWISTED_PAIR 0x0040 1079 1080/* 1081 * Hardware configuration. 1082 */ 1083 1084#define ED_HPP_HW_MEM_MAP 0x09 /* low mem map location in HW page */ 1085#define ED_HPP_HW_ID 0x0C /* revision number, capabilities */ 1086#define ED_HPP_HW_IRQ 0x0D /* IRQ channel register in HW page */ 1087#define ED_HPP_HW_WRAP 0x0E /* mem wrap page for rcv */ 1088 1089/* 1090 * Lan configuration 1091 */ 1092 1093#define ED_HPP_LAN_AUI 0x01 /* Use AUI */ 1094#define ED_HPP_LAN_TL 0x40 /* Don't use AUI */ 1095 1096/* 1097 * Card types. 1098 */ 1099 1100#define ED_TYPE_HP_PCLANPLUS 0x00 1101 1102/* 1103 * Chip types. 1104 */ 1105 1106#define ED_CHIP_TYPE_DP8390 0x00 1107#define ED_CHIP_TYPE_WD790 0x01 1108#define ED_CHIP_TYPE_AX88190 0x02 1109 1110/* 1111 * AX88190 IOBASE registers. 1112 */ 1113 1114#define ED_AX88190_IOBASE0 0x3ca 1115#define ED_AX88190_IOBASE1 0x3cc 1116 1117/* 1118 * MII bus definitions. 1119 */ 1120#define ED_MII_STARTDELIM 0x01 1121#define ED_MII_WRITEOP 0x01 1122#define ED_MII_READOP 0x02 1123#define ED_MII_TURNAROUND 0x02 1124#define ED_MII_IDLE 0x01 1125 1126#define ED_MII_STARTDELIM_BITS 2 1127#define ED_MII_OP_BITS 2 1128#define ED_MII_PHY_BITS 5 1129#define ED_MII_REG_BITS 5 1130#define ED_MII_TURNAROUND_BITS 2 1131#define ED_MII_DATA_BITS 16 1132#define ED_MII_ACK_BITS 1 1133#define ED_MII_IDLE_BITS 1 1134 1135/* Dlink chipset used on some Netgear and Dlink PCMCIA cards */ 1136#define ED_DLINK_MIIBUS 0x0c /* MII bus register on ASIC */ 1137 1138#define ED_DLINK_MII_RESET1 0x04 1139#define ED_DLINK_MII_RESET2 0x08 1140 1141#define ED_DLINK_MII_DATATIN 0x10 1142#define ED_DLINK_MII_DIROUT 0x20 1143#define ED_DLINK_MII_DATAOUT 0x40 1144#define ED_DLINK_MII_CLK 0x80 1145