rtl81x9reg.h revision 1.47
1/* $OpenBSD: rtl81x9reg.h,v 1.47 2008/04/20 01:18:02 brad Exp $ */ 2 3/* 4 * Copyright (c) 1997, 1998 5 * Bill Paul <wpaul@ctr.columbia.edu>. 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 Bill Paul. 18 * 4. Neither the name of the author nor the names of any co-contributors 19 * may be used to endorse or promote products derived from this software 20 * without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD 26 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 27 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 28 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 29 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 30 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 31 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 32 * THE POSSIBILITY OF SUCH DAMAGE. 33 * 34 * $FreeBSD: src/sys/pci/if_rlreg.h,v 1.14 1999/10/21 19:42:03 wpaul Exp $ 35 */ 36 37/* 38 * RealTek 8129/8139 register offsets 39 */ 40#define RL_IDR0 0x0000 /* ID register 0 (station addr) */ 41#define RL_IDR1 0x0001 /* Must use 32-bit accesses (?) */ 42#define RL_IDR2 0x0002 43#define RL_IDR3 0x0003 44#define RL_IDR4 0x0004 45#define RL_IDR5 0x0005 46 /* 0006-0007 reserved */ 47#define RL_MAR0 0x0008 /* Multicast hash table */ 48#define RL_MAR1 0x0009 49#define RL_MAR2 0x000A 50#define RL_MAR3 0x000B 51#define RL_MAR4 0x000C 52#define RL_MAR5 0x000D 53#define RL_MAR6 0x000E 54#define RL_MAR7 0x000F 55 56#define RL_TXSTAT0 0x0010 /* status of TX descriptor 0 */ 57#define RL_TXSTAT1 0x0014 /* status of TX descriptor 1 */ 58#define RL_TXSTAT2 0x0018 /* status of TX descriptor 2 */ 59#define RL_TXSTAT3 0x001C /* status of TX descriptor 3 */ 60 61#define RL_TXADDR0 0x0020 /* address of TX descriptor 0 */ 62#define RL_TXADDR1 0x0024 /* address of TX descriptor 1 */ 63#define RL_TXADDR2 0x0028 /* address of TX descriptor 2 */ 64#define RL_TXADDR3 0x002C /* address of TX descriptor 3 */ 65 66#define RL_RXADDR 0x0030 /* RX ring start address */ 67#define RL_RX_EARLY_BYTES 0x0034 /* RX early byte count */ 68#define RL_RX_EARLY_STAT 0x0036 /* RX early status */ 69#define RL_COMMAND 0x0037 /* command register */ 70#define RL_CURRXADDR 0x0038 /* current address of packet read */ 71#define RL_CURRXBUF 0x003A /* current RX buffer address */ 72#define RL_IMR 0x003C /* interrupt mask register */ 73#define RL_ISR 0x003E /* interrupt status register */ 74#define RL_TXCFG 0x0040 /* transmit config */ 75#define RL_RXCFG 0x0044 /* receive config */ 76#define RL_TIMERCNT 0x0048 /* timer count register */ 77#define RL_MISSEDPKT 0x004C /* missed packet counter */ 78#define RL_EECMD 0x0050 /* EEPROM command register */ 79#define RL_CFG0 0x0051 /* config register #0 */ 80#define RL_CFG1 0x0052 /* config register #1 */ 81 /* 0053-0057 reserved */ 82#define RL_MEDIASTAT 0x0058 /* media status register (8139) */ 83 /* 0059-005A reserved */ 84#define RL_MII 0x005A /* 8129 chip only */ 85#define RL_HALTCLK 0x005B 86#define RL_MULTIINTR 0x005C /* multiple interrupt */ 87#define RL_PCIREV 0x005E /* PCI revision value */ 88 /* 005F reserved */ 89#define RL_TXSTAT_ALL 0x0060 /* TX status of all descriptors */ 90 91#define RL_CSIDR 0x0064 92#define RL_CSIAR 0x0068 93 94/* Direct PHY access registers only available on 8139 */ 95#define RL_BMCR 0x0062 /* PHY basic mode control */ 96#define RL_BMSR 0x0064 /* PHY basic mode status */ 97#define RL_ANAR 0x0066 /* PHY autoneg advert */ 98#define RL_LPAR 0x0068 /* PHY link partner ability */ 99#define RL_ANER 0x006A /* PHY autoneg expansion */ 100 101#define RL_DISCCNT 0x006C /* disconnect counter */ 102#define RL_FALSECAR 0x006E /* false carrier counter */ 103#define RL_NWAYTST 0x0070 /* NWAY test register */ 104#define RL_RX_ER 0x0072 /* RX_ER counter */ 105#define RL_CSCFG 0x0074 /* CS configuration register */ 106 107/* 108 * When operating in special C+ mode, some of the registers in an 109 * 8139C+ chip have different definitions. These are also used for 110 * the 8169 gigE chip. 111 */ 112#define RL_DUMPSTATS_LO 0x0010 /* counter dump command register */ 113#define RL_DUMPSTATS_HI 0x0014 /* counter dump command register */ 114#define RL_TXLIST_ADDR_LO 0x0020 /* 64 bits, 256 byte alignment */ 115#define RL_TXLIST_ADDR_HI 0x0024 /* 64 bits, 256 byte alignment */ 116#define RL_TXLIST_ADDR_HPRIO_LO 0x0028 /* 64 bits, 256 byte aligned */ 117#define RL_TXLIST_ADDR_HPRIO_HI 0x002C /* 64 bits, 256 byte aligned */ 118#define RL_CFG2 0x0053 119#define RL_TIMERINT 0x0054 /* interrupt on timer expire */ 120#define RL_TXSTART 0x00D9 /* 8 bits */ 121#define RL_CPLUS_CMD 0x00E0 /* 16 bits */ 122#define RL_RXLIST_ADDR_LO 0x00E4 /* 64 bits, 256 byte alignment */ 123#define RL_RXLIST_ADDR_HI 0x00E8 /* 64 bits, 256 byte alignment */ 124#define RL_EARLY_TX_THRESH 0x00EC /* 8 bits */ 125 126/* 127 * Registers specific to the 8169 gigE chip 128 */ 129#define RL_GTXSTART 0x0038 /* 8 bits */ 130#define RL_TIMERINT_8169 0x0058 /* different offset than 8139 */ 131#define RL_PHYAR 0x0060 132#define RL_TBICSR 0x0064 133#define RL_TBI_ANAR 0x0068 134#define RL_TBI_LPAR 0x006A 135#define RL_GMEDIASTAT 0x006C /* 8 bits */ 136#define RL_LDPS 0x0082 /* Link Down Power Saving */ 137#define RL_MAXRXPKTLEN 0x00DA /* 16 bits, chip multiplies by 8 */ 138#define RL_IM 0x00E2 139 140/* 141 * TX config register bits 142 */ 143#define RL_TXCFG_CLRABRT 0x00000001 /* retransmit aborted pkt */ 144#define RL_TXCFG_MAXDMA 0x00000700 /* max DMA burst size */ 145#define RL_TXCFG_CRCAPPEND 0x00010000 /* CRC append (0 = yes) */ 146#define RL_TXCFG_LOOPBKTST 0x00060000 /* loopback test */ 147#define RL_TXCFG_IFG2 0x00080000 /* 8169 only */ 148#define RL_TXCFG_IFG 0x03000000 /* interframe gap */ 149#define RL_TXCFG_HWREV 0x7C800000 150 151#define RL_LOOPTEST_OFF 0x00000000 152#define RL_LOOPTEST_ON 0x00020000 153#define RL_LOOPTEST_ON_CPLUS 0x00060000 154 155/* Known revision codes. */ 156 157#define RL_HWREV_8169 0x00000000 158#define RL_HWREV_8110S 0x00800000 159#define RL_HWREV_8169S 0x04000000 160#define RL_HWREV_8169_8110SB 0x10000000 161#define RL_HWREV_8169_8110SCd 0x18000000 162#define RL_HWREV_8168_SPIN1 0x30000000 163#define RL_HWREV_8100E_SPIN1 0x30800000 164#define RL_HWREV_8101E 0x34000000 165#define RL_HWREV_8168_SPIN2 0x38000000 166#define RL_HWREV_8168_SPIN3 0x38400000 167#define RL_HWREV_8100E_SPIN2 0x38800000 168#define RL_HWREV_8168C 0x3C000000 169#define RL_HWREV_8139 0x60000000 170#define RL_HWREV_8139A 0x70000000 171#define RL_HWREV_8139AG 0x70800000 172#define RL_HWREV_8139B 0x78000000 173#define RL_HWREV_8130 0x7C000000 174#define RL_HWREV_8139C 0x74000000 175#define RL_HWREV_8139D 0x74400000 176#define RL_HWREV_8139CPLUS 0x74800000 177#define RL_HWREV_8101 0x74c00000 178#define RL_HWREV_8100 0x78800000 179#define RL_HWREV_8169_8110SCe 0x98000000 180 181#define RL_TXDMA_16BYTES 0x00000000 182#define RL_TXDMA_32BYTES 0x00000100 183#define RL_TXDMA_64BYTES 0x00000200 184#define RL_TXDMA_128BYTES 0x00000300 185#define RL_TXDMA_256BYTES 0x00000400 186#define RL_TXDMA_512BYTES 0x00000500 187#define RL_TXDMA_1024BYTES 0x00000600 188#define RL_TXDMA_2048BYTES 0x00000700 189 190/* 191 * Transmit descriptor status register bits. 192 */ 193#define RL_TXSTAT_LENMASK 0x00001FFF 194#define RL_TXSTAT_OWN 0x00002000 195#define RL_TXSTAT_TX_UNDERRUN 0x00004000 196#define RL_TXSTAT_TX_OK 0x00008000 197#define RL_TXSTAT_EARLY_THRESH 0x003F0000 198#define RL_TXSTAT_COLLCNT 0x0F000000 199#define RL_TXSTAT_CARR_HBEAT 0x10000000 200#define RL_TXSTAT_OUTOFWIN 0x20000000 201#define RL_TXSTAT_TXABRT 0x40000000 202#define RL_TXSTAT_CARRLOSS 0x80000000 203 204/* 205 * Interrupt status register bits. 206 */ 207#define RL_ISR_RX_OK 0x0001 208#define RL_ISR_RX_ERR 0x0002 209#define RL_ISR_TX_OK 0x0004 210#define RL_ISR_TX_ERR 0x0008 211#define RL_ISR_RX_OVERRUN 0x0010 212#define RL_ISR_PKT_UNDERRUN 0x0020 213#define RL_ISR_LINKCHG 0x0020 /* 8169 only */ 214#define RL_ISR_FIFO_OFLOW 0x0040 /* 8139 only */ 215#define RL_ISR_TX_DESC_UNAVAIL 0x0080 /* C+ only */ 216#define RL_ISR_SWI 0x0100 /* C+ only */ 217#define RL_ISR_CABLE_LEN_CHGD 0x2000 218#define RL_ISR_PCS_TIMEOUT 0x4000 /* 8129 only */ 219#define RL_ISR_TIMEOUT_EXPIRED 0x4000 220#define RL_ISR_SYSTEM_ERR 0x8000 221 222#define RL_INTRS \ 223 (RL_ISR_TX_OK|RL_ISR_RX_OK|RL_ISR_RX_ERR|RL_ISR_TX_ERR| \ 224 RL_ISR_RX_OVERRUN|RL_ISR_PKT_UNDERRUN|RL_ISR_FIFO_OFLOW| \ 225 RL_ISR_PCS_TIMEOUT|RL_ISR_SYSTEM_ERR) 226 227#define RL_INTRS_CPLUS \ 228 (RL_ISR_RX_OK|RL_ISR_RX_ERR|RL_ISR_TX_ERR| \ 229 RL_ISR_RX_OVERRUN|RL_ISR_PKT_UNDERRUN|RL_ISR_FIFO_OFLOW| \ 230 RL_ISR_PCS_TIMEOUT|RL_ISR_SYSTEM_ERR|RL_ISR_TIMEOUT_EXPIRED) 231 232 233/* 234 * Media status register. (8139 only) 235 */ 236#define RL_MEDIASTAT_RXPAUSE 0x01 237#define RL_MEDIASTAT_TXPAUSE 0x02 238#define RL_MEDIASTAT_LINK 0x04 239#define RL_MEDIASTAT_SPEED10 0x08 240#define RL_MEDIASTAT_RXFLOWCTL 0x40 /* duplex mode */ 241#define RL_MEDIASTAT_TXFLOWCTL 0x80 /* duplex mode */ 242 243/* 244 * Receive config register. 245 */ 246#define RL_RXCFG_RX_ALLPHYS 0x00000001 /* accept all nodes */ 247#define RL_RXCFG_RX_INDIV 0x00000002 /* match filter */ 248#define RL_RXCFG_RX_MULTI 0x00000004 /* accept all multicast */ 249#define RL_RXCFG_RX_BROAD 0x00000008 /* accept all broadcast */ 250#define RL_RXCFG_RX_RUNT 0x00000010 251#define RL_RXCFG_RX_ERRPKT 0x00000020 252#define RL_RXCFG_WRAP 0x00000080 253#define RL_RXCFG_MAXDMA 0x00000700 254#define RL_RXCFG_BURSZ 0x00001800 255#define RL_RXCFG_FIFOTHRESH 0x0000E000 256#define RL_RXCFG_EARLYTHRESH 0x07000000 257 258#define RL_RXDMA_16BYTES 0x00000000 259#define RL_RXDMA_32BYTES 0x00000100 260#define RL_RXDMA_64BYTES 0x00000200 261#define RL_RXDMA_128BYTES 0x00000300 262#define RL_RXDMA_256BYTES 0x00000400 263#define RL_RXDMA_512BYTES 0x00000500 264#define RL_RXDMA_1024BYTES 0x00000600 265#define RL_RXDMA_UNLIMITED 0x00000700 266 267#define RL_RXBUF_8 0x00000000 268#define RL_RXBUF_16 0x00000800 269#define RL_RXBUF_32 0x00001000 270#define RL_RXBUF_64 0x00001800 271 272#define RL_RXFIFO_16BYTES 0x00000000 273#define RL_RXFIFO_32BYTES 0x00002000 274#define RL_RXFIFO_64BYTES 0x00004000 275#define RL_RXFIFO_128BYTES 0x00006000 276#define RL_RXFIFO_256BYTES 0x00008000 277#define RL_RXFIFO_512BYTES 0x0000A000 278#define RL_RXFIFO_1024BYTES 0x0000C000 279#define RL_RXFIFO_NOTHRESH 0x0000E000 280 281/* 282 * Bits in RX status header (included with RX'ed packet 283 * in ring buffer). 284 */ 285#define RL_RXSTAT_RXOK 0x00000001 286#define RL_RXSTAT_ALIGNERR 0x00000002 287#define RL_RXSTAT_CRCERR 0x00000004 288#define RL_RXSTAT_GIANT 0x00000008 289#define RL_RXSTAT_RUNT 0x00000010 290#define RL_RXSTAT_BADSYM 0x00000020 291#define RL_RXSTAT_BROAD 0x00002000 292#define RL_RXSTAT_INDIV 0x00004000 293#define RL_RXSTAT_MULTI 0x00008000 294#define RL_RXSTAT_LENMASK 0xFFFF0000 295 296#define RL_RXSTAT_UNFINISHED 0xFFF0 /* DMA still in progress */ 297/* 298 * Command register. 299 */ 300#define RL_CMD_EMPTY_RXBUF 0x0001 301#define RL_CMD_TX_ENB 0x0004 302#define RL_CMD_RX_ENB 0x0008 303#define RL_CMD_RESET 0x0010 304 305/* 306 * EEPROM control register 307 */ 308#define RL_EE_DATAOUT 0x01 /* Data out */ 309#define RL_EE_DATAIN 0x02 /* Data in */ 310#define RL_EE_CLK 0x04 /* clock */ 311#define RL_EE_SEL 0x08 /* chip select */ 312#define RL_EE_MODE (0x40|0x80) 313 314#define RL_EEMODE_OFF 0x00 315#define RL_EEMODE_AUTOLOAD 0x40 316#define RL_EEMODE_PROGRAM 0x80 317#define RL_EEMODE_WRITECFG (0x80|0x40) 318 319/* 9346/9356 EEPROM commands */ 320 321#define RL_9346_ADDR_LEN 6 /* 93C46 1K: 128x16 */ 322#define RL_9356_ADDR_LEN 8 /* 93C56 2K: 256x16 */ 323 324#define RL_9346_WRITE 0x5 325#define RL_9346_READ 0x6 326#define RL_9346_ERASE 0x7 327#define RL_9346_EWEN 0x4 328#define RL_9346_EWEN_ADDR 0x30 329#define RL_9456_EWDS 0x4 330#define RL_9346_EWDS_ADDR 0x00 331 332#define RL_EECMD_WRITE 0x5 /* 0101b */ 333#define RL_EECMD_READ 0x6 /* 0110b */ 334#define RL_EECMD_ERASE 0x7 /* 0111b */ 335#define RL_EECMD_LEN 4 336 337#define RL_EEADDR_LEN0 6 /* 9346 */ 338#define RL_EEADDR_LEN1 8 /* 9356 */ 339 340#define RL_EECMD_READ_6BIT 0x180 /* XXX */ 341#define RL_EECMD_READ_8BIT 0x600 /* EECMD_READ above maybe wrong? */ 342 343#define RL_EE_ID 0x00 344#define RL_EE_PCI_VID 0x01 345#define RL_EE_PCI_DID 0x02 346/* Location of station address inside EEPROM */ 347#define RL_EE_EADDR 0x07 348 349/* 350 * MII register (8129 only) 351 */ 352#define RL_MII_CLK 0x01 353#define RL_MII_DATAIN 0x02 354#define RL_MII_DATAOUT 0x04 355#define RL_MII_DIR 0x80 /* 0 == input, 1 == output */ 356 357/* 358 * Config 0 register 359 */ 360#define RL_CFG0_ROM0 0x01 361#define RL_CFG0_ROM1 0x02 362#define RL_CFG0_ROM2 0x04 363#define RL_CFG0_PL0 0x08 364#define RL_CFG0_PL1 0x10 365#define RL_CFG0_10MBPS 0x20 /* 10 Mbps internal mode */ 366#define RL_CFG0_PCS 0x40 367#define RL_CFG0_SCR 0x80 368 369/* 370 * Config 1 register 371 */ 372#define RL_CFG1_PWRDWN 0x01 373#define RL_CFG1_SLEEP 0x02 374#define RL_CFG1_IOMAP 0x04 375#define RL_CFG1_MEMMAP 0x08 376#define RL_CFG1_RSVD 0x10 377#define RL_CFG1_DRVLOAD 0x20 378#define RL_CFG1_LED0 0x40 379#define RL_CFG1_FULLDUPLEX 0x40 /* 8129 only */ 380#define RL_CFG1_LED1 0x80 381 382/* 383 * 8139C+ register definitions 384 */ 385 386/* RL_DUMPSTATS_LO register */ 387 388#define RL_DUMPSTATS_START 0x00000008 389 390/* Transmit start register */ 391 392#define RL_TXSTART_SWI 0x01 /* generate TX interrupt */ 393#define RL_TXSTART_START 0x40 /* start normal queue transmit */ 394#define RL_TXSTART_HPRIO_START 0x80 /* start hi prio queue transmit */ 395 396/* 397 * Config 2 register, 8139C+/8169/8169S/8110S only 398 */ 399#define RL_CFG2_BUSFREQ 0x07 400#define RL_CFG2_BUSWIDTH 0x08 401#define RL_CFG2_AUXPWRSTS 0x10 402 403#define RL_BUSFREQ_33MHZ 0x00 404#define RL_BUSFREQ_66MHZ 0x01 405 406#define RL_BUSWIDTH_32BITS 0x00 407#define RL_BUSWIDTH_64BITS 0x08 408 409/* C+ mode command register */ 410 411#define RL_CPLUSCMD_TXENB 0x0001 /* enable C+ transmit mode */ 412#define RL_CPLUSCMD_RXENB 0x0002 /* enable C+ receive mode */ 413#define RL_CPLUSCMD_PCI_MRW 0x0008 /* enable PCI multi-read/write */ 414#define RL_CPLUSCMD_PCI_DAC 0x0010 /* PCI dual-address cycle only */ 415#define RL_CPLUSCMD_RXCSUM_ENB 0x0020 /* enable RX checksum offload */ 416#define RL_CPLUSCMD_VLANSTRIP 0x0040 /* enable VLAN tag stripping */ 417 418/* C+ early transmit threshold */ 419 420#define RL_EARLYTXTHRESH_CNT 0x003F /* byte count times 8 */ 421 422/* 423 * Gigabit PHY access register (8169 only) 424 */ 425 426#define RL_PHYAR_PHYDATA 0x0000FFFF 427#define RL_PHYAR_PHYREG 0x001F0000 428#define RL_PHYAR_BUSY 0x80000000 429 430/* 431 * Gigabit media status (8169 only) 432 */ 433#define RL_GMEDIASTAT_FDX 0x01 /* full duplex */ 434#define RL_GMEDIASTAT_LINK 0x02 /* link up */ 435#define RL_GMEDIASTAT_10MBPS 0x04 /* 10mps link */ 436#define RL_GMEDIASTAT_100MBPS 0x08 /* 100mbps link */ 437#define RL_GMEDIASTAT_1000MBPS 0x10 /* gigE link */ 438#define RL_GMEDIASTAT_RXFLOW 0x20 /* RX flow control on */ 439#define RL_GMEDIASTAT_TXFLOW 0x40 /* TX flow control on */ 440#define RL_GMEDIASTAT_TBI 0x80 /* TBI enabled */ 441 442/* 443 * The RealTek doesn't use a fragment-based descriptor mechanism. 444 * Instead, there are only four register sets, each of which represents 445 * one 'descriptor.' Basically, each TX descriptor is just a contiguous 446 * packet buffer (32-bit aligned!) and we place the buffer addresses in 447 * the registers so the chip knows where they are. 448 * 449 * We can sort of kludge together the same kind of buffer management 450 * used in previous drivers, but we have to do buffer copies almost all 451 * the time, so it doesn't really buy us much. 452 * 453 * For reception, there's just one large buffer where the chip stores 454 * all received packets. 455 */ 456 457#define RL_RX_BUF_SZ RL_RXBUF_64 458#define RL_RXBUFLEN (1 << ((RL_RX_BUF_SZ >> 11) + 13)) 459#define RL_TX_LIST_CNT 4 460#define RL_MIN_FRAMELEN 60 461#define RL_TXTHRESH(x) ((x) << 11) 462#define RL_TX_THRESH_INIT 96 463#define RL_RX_FIFOTHRESH RL_RXFIFO_NOTHRESH 464#define RL_RX_MAXDMA RL_RXDMA_UNLIMITED 465#define RL_TX_MAXDMA RL_TXDMA_2048BYTES 466 467#define RL_RXCFG_CONFIG (RL_RX_FIFOTHRESH|RL_RX_MAXDMA|RL_RX_BUF_SZ) 468#define RL_TXCFG_CONFIG (RL_TXCFG_IFG|RL_TX_MAXDMA) 469 470struct rl_chain_data { 471 u_int16_t cur_rx; 472 caddr_t rl_rx_buf; 473 caddr_t rl_rx_buf_ptr; 474 bus_addr_t rl_rx_buf_pa; 475 476 struct mbuf *rl_tx_chain[RL_TX_LIST_CNT]; 477 bus_dmamap_t rl_tx_dmamap[RL_TX_LIST_CNT]; 478 u_int8_t last_tx; 479 u_int8_t cur_tx; 480}; 481 482 483/* 484 * The 8139C+ and 8160 gigE chips support descriptor-based TX 485 * and RX. In fact, they even support TCP large send. Descriptors 486 * must be allocated in contiguous blocks that are aligned on a 487 * 256-byte boundary. The rings can hold a maximum of 64 descriptors. 488 */ 489 490/* 491 * RX/TX descriptor definition. When large send mode is enabled, the 492 * lower 11 bits of the TX rl_cmd word are used to hold the MSS, and 493 * the checksum offload bits are disabled. The structure layout is 494 * the same for RX and TX descriptors 495 */ 496 497struct rl_desc { 498 volatile u_int32_t rl_cmdstat; 499 volatile u_int32_t rl_vlanctl; 500 volatile u_int32_t rl_bufaddr_lo; 501 volatile u_int32_t rl_bufaddr_hi; 502}; 503 504#define RL_TDESC_CMD_FRAGLEN 0x0000FFFF 505#define RL_TDESC_CMD_TCPCSUM 0x00010000 /* TCP checksum enable */ 506#define RL_TDESC_CMD_UDPCSUM 0x00020000 /* UDP checksum enable */ 507#define RL_TDESC_CMD_IPCSUM 0x00040000 /* IP header checksum enable */ 508#define RL_TDESC_CMD_MSSVAL 0x07FF0000 /* Large send MSS value */ 509#define RL_TDESC_CMD_LGSEND 0x08000000 /* TCP large send enb */ 510#define RL_TDESC_CMD_EOF 0x10000000 /* end of frame marker */ 511#define RL_TDESC_CMD_SOF 0x20000000 /* start of frame marker */ 512#define RL_TDESC_CMD_EOR 0x40000000 /* end of ring marker */ 513#define RL_TDESC_CMD_OWN 0x80000000 /* chip owns descriptor */ 514 515#define RL_TDESC_VLANCTL_TAG 0x00020000 /* Insert VLAN tag */ 516#define RL_TDESC_VLANCTL_DATA 0x0000FFFF /* TAG data */ 517 518/* 519 * Error bits are valid only on the last descriptor of a frame 520 * (i.e. RL_TDESC_CMD_EOF == 1) 521 */ 522 523#define RL_TDESC_STAT_COLCNT 0x000F0000 /* collision count */ 524#define RL_TDESC_STAT_EXCESSCOL 0x00100000 /* excessive collisions */ 525#define RL_TDESC_STAT_LINKFAIL 0x00200000 /* link faulure */ 526#define RL_TDESC_STAT_OWINCOL 0x00400000 /* out-of-window collision */ 527#define RL_TDESC_STAT_TXERRSUM 0x00800000 /* transmit error summary */ 528#define RL_TDESC_STAT_UNDERRUN 0x02000000 /* TX underrun occured */ 529#define RL_TDESC_STAT_OWN 0x80000000 530 531/* 532 * RX descriptor cmd/vlan definitions 533 */ 534 535#define RL_RDESC_CMD_EOR 0x40000000 536#define RL_RDESC_CMD_OWN 0x80000000 537#define RL_RDESC_CMD_BUFLEN 0x00001FFF 538 539#define RL_RDESC_STAT_OWN 0x80000000 540#define RL_RDESC_STAT_EOR 0x40000000 541#define RL_RDESC_STAT_SOF 0x20000000 542#define RL_RDESC_STAT_EOF 0x10000000 543#define RL_RDESC_STAT_FRALIGN 0x08000000 /* frame alignment error */ 544#define RL_RDESC_STAT_MCAST 0x04000000 /* multicast pkt received */ 545#define RL_RDESC_STAT_UCAST 0x02000000 /* unicast pkt received */ 546#define RL_RDESC_STAT_BCAST 0x01000000 /* broadcast pkt received */ 547#define RL_RDESC_STAT_BUFOFLOW 0x00800000 /* out of buffer space */ 548#define RL_RDESC_STAT_FIFOOFLOW 0x00400000 /* FIFO overrun */ 549#define RL_RDESC_STAT_GIANT 0x00200000 /* pkt > 4096 bytes */ 550#define RL_RDESC_STAT_RXERRSUM 0x00100000 /* RX error summary */ 551#define RL_RDESC_STAT_RUNT 0x00080000 /* runt packet received */ 552#define RL_RDESC_STAT_CRCERR 0x00040000 /* CRC error */ 553#define RL_RDESC_STAT_PROTOID 0x00030000 /* Protocol type */ 554#define RL_RDESC_STAT_IPSUMBAD 0x00008000 /* IP header checksum bad */ 555#define RL_RDESC_STAT_UDPSUMBAD 0x00004000 /* UDP checksum bad */ 556#define RL_RDESC_STAT_TCPSUMBAD 0x00002000 /* TCP checksum bad */ 557#define RL_RDESC_STAT_FRAGLEN 0x00001FFF /* RX'ed frame/frag len */ 558#define RL_RDESC_STAT_GFRAGLEN 0x00003FFF /* RX'ed frame/frag len */ 559#define RL_RDESC_STAT_ERRS (RL_RDESC_STAT_GIANT|RL_RDESC_STAT_RUNT| \ 560 RL_RDESC_STAT_CRCERR) 561 562#define RL_RDESC_VLANCTL_TAG 0x00010000 /* VLAN tag available 563 (rl_vlandata valid)*/ 564#define RL_RDESC_VLANCTL_DATA 0x0000FFFF /* TAG data */ 565 566#define RL_PROTOID_NONIP 0x00000000 567#define RL_PROTOID_TCPIP 0x00010000 568#define RL_PROTOID_UDPIP 0x00020000 569#define RL_PROTOID_IP 0x00030000 570#define RL_TCPPKT(x) (((x) & RL_RDESC_STAT_PROTOID) == \ 571 RL_PROTOID_TCPIP) 572#define RL_UDPPKT(x) (((x) & RL_RDESC_STAT_PROTOID) == \ 573 RL_PROTOID_UDPIP) 574 575/* 576 * Statistics counter structure (8139C+ and 8169 only) 577 */ 578struct rl_stats { 579 u_int32_t rl_tx_pkts_lo; 580 u_int32_t rl_tx_pkts_hi; 581 u_int32_t rl_tx_errs_lo; 582 u_int32_t rl_tx_errs_hi; 583 u_int32_t rl_tx_errs; 584 u_int16_t rl_missed_pkts; 585 u_int16_t rl_rx_framealign_errs; 586 u_int32_t rl_tx_onecoll; 587 u_int32_t rl_tx_multicolls; 588 u_int32_t rl_rx_ucasts_hi; 589 u_int32_t rl_rx_ucasts_lo; 590 u_int32_t rl_rx_bcasts_lo; 591 u_int32_t rl_rx_bcasts_hi; 592 u_int32_t rl_rx_mcasts; 593 u_int16_t rl_tx_aborts; 594 u_int16_t rl_rx_underruns; 595}; 596 597#define RL_RX_DESC_CNT 64 598#define RL_TX_DESC_CNT_8139 64 599#define RL_TX_DESC_CNT_8169 1024 600 601#define RL_TX_QLEN 64 602 603#define RL_NTXDESC_RSVD 4 604 605#define RL_RX_LIST_SZ (RL_RX_DESC_CNT * sizeof(struct rl_desc)) 606#define RL_RING_ALIGN 256 607#define RL_PKTSZ(x) ((x)/* >> 3*/) 608#ifdef __STRICT_ALIGNMENT 609#define RE_ETHER_ALIGN 2 610#define RE_RX_DESC_BUFLEN (MCLBYTES - RE_ETHER_ALIGN) 611#else 612#define RE_ETHER_ALIGN 0 613#define RE_RX_DESC_BUFLEN MCLBYTES 614#endif 615 616#define RL_TX_DESC_CNT(sc) \ 617 ((sc)->rl_ldata.rl_tx_desc_cnt) 618#define RL_TX_LIST_SZ(sc) \ 619 (RL_TX_DESC_CNT(sc) * sizeof(struct rl_desc)) 620#define RL_NEXT_TX_DESC(sc, x) \ 621 (((x) + 1) % RL_TX_DESC_CNT(sc)) 622#define RL_NEXT_RX_DESC(sc, x) \ 623 (((x) + 1) % RL_RX_DESC_CNT) 624#define RL_NEXT_TXQ(sc, x) \ 625 (((x) + 1) % RL_TX_QLEN) 626 627#define RL_TXDESCSYNC(sc, idx, ops) \ 628 bus_dmamap_sync((sc)->sc_dmat, \ 629 (sc)->rl_ldata.rl_tx_list_map, \ 630 sizeof(struct rl_desc) * (idx), \ 631 sizeof(struct rl_desc), \ 632 (ops)) 633#define RL_RXDESCSYNC(sc, idx, ops) \ 634 bus_dmamap_sync((sc)->sc_dmat, \ 635 (sc)->rl_ldata.rl_rx_list_map, \ 636 sizeof(struct rl_desc) * (idx), \ 637 sizeof(struct rl_desc), \ 638 (ops)) 639 640#define RL_ADDR_LO(y) ((u_int64_t) (y) & 0xFFFFFFFF) 641#define RL_ADDR_HI(y) ((u_int64_t) (y) >> 32) 642 643/* see comment in dev/ic/re.c */ 644#define RL_JUMBO_FRAMELEN 7440 645#define RL_JUMBO_MTU (RL_JUMBO_FRAMELEN-ETHER_HDR_LEN-ETHER_CRC_LEN) 646 647#define MAX_NUM_MULTICAST_ADDRESSES 128 648 649#define RL_INC(x) (x = (x + 1) % RL_TX_LIST_CNT) 650#define RL_CUR_TXADDR(x) ((x->rl_cdata.cur_tx * 4) + RL_TXADDR0) 651#define RL_CUR_TXSTAT(x) ((x->rl_cdata.cur_tx * 4) + RL_TXSTAT0) 652#define RL_CUR_TXMBUF(x) (x->rl_cdata.rl_tx_chain[x->rl_cdata.cur_tx]) 653#define RL_CUR_TXMAP(x) (x->rl_cdata.rl_tx_dmamap[x->rl_cdata.cur_tx]) 654#define RL_LAST_TXADDR(x) ((x->rl_cdata.last_tx * 4) + RL_TXADDR0) 655#define RL_LAST_TXSTAT(x) ((x->rl_cdata.last_tx * 4) + RL_TXSTAT0) 656#define RL_LAST_TXMBUF(x) (x->rl_cdata.rl_tx_chain[x->rl_cdata.last_tx]) 657#define RL_LAST_TXMAP(x) (x->rl_cdata.rl_tx_dmamap[x->rl_cdata.last_tx]) 658 659struct rl_type { 660 u_int16_t rl_vid; 661 u_int16_t rl_did; 662}; 663 664struct rl_mii_frame { 665 u_int8_t mii_stdelim; 666 u_int8_t mii_opcode; 667 u_int8_t mii_phyaddr; 668 u_int8_t mii_regaddr; 669 u_int8_t mii_turnaround; 670 u_int16_t mii_data; 671}; 672 673/* 674 * MII constants 675 */ 676#define RL_MII_STARTDELIM 0x01 677#define RL_MII_READOP 0x02 678#define RL_MII_WRITEOP 0x01 679#define RL_MII_TURNAROUND 0x02 680 681#define RL_UNKNOWN 0 682#define RL_8129 1 683#define RL_8139 2 684 685struct rl_rxsoft { 686 struct mbuf *rxs_mbuf; 687 bus_dmamap_t rxs_dmamap; 688}; 689 690struct rl_txq { 691 struct mbuf *txq_mbuf; 692 bus_dmamap_t txq_dmamap; 693 int txq_descidx; 694 int txq_nsegs; 695}; 696 697struct rl_list_data { 698 struct rl_txq rl_txq[RL_TX_QLEN]; 699 int rl_txq_considx; 700 int rl_txq_prodidx; 701 702 bus_dmamap_t rl_tx_list_map; 703 struct rl_desc *rl_tx_list; 704 int rl_tx_free; /* # of free descriptors */ 705 int rl_tx_nextfree; /* next descriptor to use */ 706 int rl_tx_desc_cnt; /* # of descriptors */ 707 bus_dma_segment_t rl_tx_listseg; 708 int rl_tx_listnseg; 709 710 struct rl_rxsoft rl_rxsoft[RL_RX_DESC_CNT]; 711 bus_dmamap_t rl_rx_list_map; 712 struct rl_desc *rl_rx_list; 713 int rl_rx_prodidx; 714 bus_dma_segment_t rl_rx_listseg; 715 int rl_rx_listnseg; 716}; 717 718struct rl_softc { 719 struct device sc_dev; /* us, as a device */ 720 void * sc_ih; /* interrupt vectoring */ 721 bus_space_handle_t rl_bhandle; /* bus space handle */ 722 bus_space_tag_t rl_btag; /* bus space tag */ 723 bus_dma_tag_t sc_dmat; 724 bus_dma_segment_t sc_rx_seg; 725 bus_dmamap_t sc_rx_dmamap; 726 struct arpcom sc_arpcom; /* interface info */ 727 struct mii_data sc_mii; /* MII information */ 728 u_int8_t rl_type; 729 u_int32_t sc_hwrev; 730 int rl_eecmd_read; 731 int rl_eewidth; 732 void *sc_sdhook; /* shutdownhook */ 733 void *sc_pwrhook; 734 int rl_txthresh; 735 struct rl_chain_data rl_cdata; 736 struct timeout sc_tick_tmo; 737 int if_flags; 738 739 struct rl_list_data rl_ldata; 740 struct mbuf *rl_head; 741 struct mbuf *rl_tail; 742 u_int32_t rl_rxlenmask; 743 int rl_testmode; 744 struct timeout timer_handle; 745 746 int rl_txstart; 747 int rl_link; 748}; 749 750/* 751 * re(4) hardware ip4csum-tx could be mangled with 28 byte or less IP packets 752 */ 753#define RL_IP4CSUMTX_MINLEN 28 754#define RL_IP4CSUMTX_PADLEN (ETHER_HDR_LEN + RL_IP4CSUMTX_MINLEN) 755/* 756 * XXX 757 * We are allocating pad DMA buffer after RX DMA descs for now 758 * because RL_TX_LIST_SZ(sc) always occupies whole page but 759 * RL_RX_LIST_SZ is less than PAGE_SIZE so there is some unused region. 760 */ 761#define RL_RX_DMAMEM_SZ (RL_RX_LIST_SZ + RL_IP4CSUMTX_PADLEN) 762#define RL_TXPADOFF RL_RX_LIST_SZ 763#define RL_TXPADDADDR(sc) \ 764 ((sc)->rl_ldata.rl_rx_list_map->dm_segs[0].ds_addr + RL_TXPADOFF) 765 766/* 767 * register space access macros 768 */ 769#define CSR_WRITE_RAW_4(sc, csr, val) \ 770 bus_space_write_raw_region_4(sc->rl_btag, sc->rl_bhandle, csr, val, 4) 771#define CSR_WRITE_4(sc, csr, val) \ 772 bus_space_write_4(sc->rl_btag, sc->rl_bhandle, csr, val) 773#define CSR_WRITE_2(sc, csr, val) \ 774 bus_space_write_2(sc->rl_btag, sc->rl_bhandle, csr, val) 775#define CSR_WRITE_1(sc, csr, val) \ 776 bus_space_write_1(sc->rl_btag, sc->rl_bhandle, csr, val) 777 778#define CSR_READ_4(sc, csr) \ 779 bus_space_read_4(sc->rl_btag, sc->rl_bhandle, csr) 780#define CSR_READ_2(sc, csr) \ 781 bus_space_read_2(sc->rl_btag, sc->rl_bhandle, csr) 782#define CSR_READ_1(sc, csr) \ 783 bus_space_read_1(sc->rl_btag, sc->rl_bhandle, csr) 784 785#define CSR_SETBIT_1(sc, offset, val) \ 786 CSR_WRITE_1(sc, offset, CSR_READ_1(sc, offset) | (val)) 787 788#define CSR_CLRBIT_1(sc, offset, val) \ 789 CSR_WRITE_1(sc, offset, CSR_READ_1(sc, offset) & ~(val)) 790 791#define CSR_SETBIT_2(sc, offset, val) \ 792 CSR_WRITE_2(sc, offset, CSR_READ_2(sc, offset) | (val)) 793 794#define CSR_CLRBIT_2(sc, offset, val) \ 795 CSR_WRITE_2(sc, offset, CSR_READ_2(sc, offset) & ~(val)) 796 797#define CSR_SETBIT_4(sc, offset, val) \ 798 CSR_WRITE_4(sc, offset, CSR_READ_4(sc, offset) | (val)) 799 800#define CSR_CLRBIT_4(sc, offset, val) \ 801 CSR_WRITE_4(sc, offset, CSR_READ_4(sc, offset) & ~(val)) 802 803#define RL_TIMEOUT 1000 804 805/* 806 * General constants that are fun to know. 807 * 808 * RealTek PCI vendor ID 809 */ 810#define RT_VENDORID 0x10EC 811 812/* 813 * RealTek chip device IDs. 814 */ 815#define RT_DEVICEID_8129 0x8129 816#define RT_DEVICEID_8101E 0x8136 817#define RT_DEVICEID_8138 0x8138 818#define RT_DEVICEID_8139 0x8139 819#define RT_DEVICEID_8169SC 0x8167 820#define RT_DEVICEID_8168 0x8168 821#define RT_DEVICEID_8169 0x8169 822#define RT_DEVICEID_8100 0x8100 823 824/* 825 * Accton PCI vendor ID 826 */ 827#define ACCTON_VENDORID 0x1113 828 829/* 830 * Accton MPX 5030/5038 device ID. 831 */ 832#define ACCTON_DEVICEID_5030 0x1211 833 834/* 835 * Delta Electronics Vendor ID. 836 */ 837#define DELTA_VENDORID 0x1500 838 839/* 840 * Delta device IDs. 841 */ 842#define DELTA_DEVICEID_8139 0x1360 843 844/* 845 * Addtron vendor ID. 846 */ 847#define ADDTRON_VENDORID 0x4033 848 849/* 850 * Addtron device IDs. 851 */ 852#define ADDTRON_DEVICEID_8139 0x1360 853 854/* D-Link Vendor ID */ 855#define DLINK_VENDORID 0x1186 856 857/* D-Link device IDs */ 858#define DLINK_DEVICEID_8139 0x1300 859#define DLINK_DEVICEID_8139_2 0x1340 860 861/* Abocom device IDs */ 862#define ABOCOM_DEVICEID_8139 0xab06 863 864/* 865 * PCI low memory base and low I/O base register, and 866 * other PCI registers. Note: some are only available on 867 * the 3c905B, in particular those that related to power management. 868 */ 869 870#define RL_PCI_VENDOR_ID 0x00 871#define RL_PCI_DEVICE_ID 0x02 872#define RL_PCI_COMMAND 0x04 873#define RL_PCI_STATUS 0x06 874#define RL_PCI_CLASSCODE 0x09 875#define RL_PCI_LATENCY_TIMER 0x0D 876#define RL_PCI_HEADER_TYPE 0x0E 877#define RL_PCI_LOIO 0x10 878#define RL_PCI_LOMEM 0x14 879#define RL_PCI_BIOSROM 0x30 880#define RL_PCI_INTLINE 0x3C 881#define RL_PCI_INTPIN 0x3D 882#define RL_PCI_MINGNT 0x3E 883#define RL_PCI_MINLAT 0x0F 884#define RL_PCI_RESETOPT 0x48 885#define RL_PCI_EEPROM_DATA 0x4C 886 887#define RL_PCI_CAPID 0x50 /* 8 bits */ 888#define RL_PCI_NEXTPTR 0x51 /* 8 bits */ 889#define RL_PCI_PWRMGMTCAP 0x52 /* 16 bits */ 890#define RL_PCI_PWRMGMTCTRL 0x54 /* 16 bits */ 891 892#define RL_PSTATE_MASK 0x0003 893#define RL_PSTATE_D0 0x0000 894#define RL_PSTATE_D1 0x0001 895#define RL_PSTATE_D2 0x0002 896#define RL_PSTATE_D3 0x0003 897#define RL_PME_EN 0x0010 898#define RL_PME_STATUS 0x8000 899 900extern int rl_attach(struct rl_softc *); 901extern int rl_intr(void *); 902extern void rl_setmulti(struct rl_softc *); 903