sys/pci/if_rlreg.h

   1 /*-
   2  * Copyright (c) 1997, 1998-2003
   3  *      Bill Paul <wpaul@ctr.columbia.edu>.  All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  * 3. All advertising materials mentioning features or use of this software
  14  *    must display the following acknowledgement:
  15  *      This product includes software developed by Bill Paul.
  16  * 4. Neither the name of the author nor the names of any co-contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  24  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  25  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  26  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  27  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  28  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  29  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  30  * THE POSSIBILITY OF SUCH DAMAGE.
  31  *
  32  * $FreeBSD$
  33  */
  34
  35 /*
  36  * RealTek 8129/8139 register offsets
  37  */
  38 #define RL_IDR0         0x0000          /* ID register 0 (station addr) */
  39 #define RL_IDR1         0x0001          /* Must use 32-bit accesses (?) */
  40 #define RL_IDR2         0x0002
  41 #define RL_IDR3         0x0003
  42 #define RL_IDR4         0x0004
  43 #define RL_IDR5         0x0005
  44                                         /* 0006-0007 reserved */
  45 #define RL_MAR0         0x0008          /* Multicast hash table */
  46 #define RL_MAR1         0x0009
  47 #define RL_MAR2         0x000A
  48 #define RL_MAR3         0x000B
  49 #define RL_MAR4         0x000C
  50 #define RL_MAR5         0x000D
  51 #define RL_MAR6         0x000E
  52 #define RL_MAR7         0x000F
  53
  54 #define RL_TXSTAT0      0x0010          /* status of TX descriptor 0 */
  55 #define RL_TXSTAT1      0x0014          /* status of TX descriptor 1 */
  56 #define RL_TXSTAT2      0x0018          /* status of TX descriptor 2 */
  57 #define RL_TXSTAT3      0x001C          /* status of TX descriptor 3 */
  58
  59 #define RL_TXADDR0      0x0020          /* address of TX descriptor 0 */
  60 #define RL_TXADDR1      0x0024          /* address of TX descriptor 1 */
  61 #define RL_TXADDR2      0x0028          /* address of TX descriptor 2 */
  62 #define RL_TXADDR3      0x002C          /* address of TX descriptor 3 */
  63
  64 #define RL_RXADDR               0x0030  /* RX ring start address */
  65 #define RL_RX_EARLY_BYTES       0x0034  /* RX early byte count */
  66 #define RL_RX_EARLY_STAT        0x0036  /* RX early status */
  67 #define RL_COMMAND      0x0037          /* command register */
  68 #define RL_CURRXADDR    0x0038          /* current address of packet read */
  69 #define RL_CURRXBUF     0x003A          /* current RX buffer address */
  70 #define RL_IMR          0x003C          /* interrupt mask register */
  71 #define RL_ISR          0x003E          /* interrupt status register */
  72 #define RL_TXCFG        0x0040          /* transmit config */
  73 #define RL_RXCFG        0x0044          /* receive config */
  74 #define RL_TIMERCNT     0x0048          /* timer count register */
  75 #define RL_MISSEDPKT    0x004C          /* missed packet counter */
  76 #define RL_EECMD        0x0050          /* EEPROM command register */
  77 #define RL_CFG0         0x0051          /* config register #0 */
  78 #define RL_CFG1         0x0052          /* config register #1 */
  79 #define RL_CFG2         0x0053          /* config register #2 */
  80 #define RL_CFG3         0x0054          /* config register #3 */
  81 #define RL_CFG4         0x0055          /* config register #4 */
  82 #define RL_CFG5         0x0056          /* config register #5 */
  83                                         /* 0057 reserved */
  84 #define RL_MEDIASTAT    0x0058          /* media status register (8139) */
  85                                         /* 0059-005A reserved */
  86 #define RL_MII          0x005A          /* 8129 chip only */
  87 #define RL_HALTCLK      0x005B
  88 #define RL_MULTIINTR    0x005C          /* multiple interrupt */
  89 #define RL_PCIREV       0x005E          /* PCI revision value */
  90                                         /* 005F reserved */
  91 #define RL_TXSTAT_ALL   0x0060          /* TX status of all descriptors */
  92
  93 /* Direct PHY access registers only available on 8139 */
  94 #define RL_BMCR         0x0062          /* PHY basic mode control */
  95 #define RL_BMSR         0x0064          /* PHY basic mode status */
  96 #define RL_ANAR         0x0066          /* PHY autoneg advert */
  97 #define RL_LPAR         0x0068          /* PHY link partner ability */
  98 #define RL_ANER         0x006A          /* PHY autoneg expansion */
  99
 100 #define RL_DISCCNT      0x006C          /* disconnect counter */
 101 #define RL_FALSECAR     0x006E          /* false carrier counter */
 102 #define RL_NWAYTST      0x0070          /* NWAY test register */
 103 #define RL_RX_ER        0x0072          /* RX_ER counter */
 104 #define RL_CSCFG        0x0074          /* CS configuration register */
 105
 106 /*
 107  * When operating in special C+ mode, some of the registers in an
 108  * 8139C+ chip have different definitions. These are also used for
 109  * the 8169 gigE chip.
 110  */
 111 #define RL_DUMPSTATS_LO         0x0010  /* counter dump command register */
 112 #define RL_DUMPSTATS_HI         0x0014  /* counter dump command register */
 113 #define RL_TXLIST_ADDR_LO       0x0020  /* 64 bits, 256 byte alignment */
 114 #define RL_TXLIST_ADDR_HI       0x0024  /* 64 bits, 256 byte alignment */
 115 #define RL_TXLIST_ADDR_HPRIO_LO 0x0028  /* 64 bits, 256 byte alignment */
 116 #define RL_TXLIST_ADDR_HPRIO_HI 0x002C  /* 64 bits, 256 byte alignment */
 117 #define RL_CFG2                 0x0053
 118 #define RL_TIMERINT             0x0054  /* interrupt on timer expire */
 119 #define RL_TXSTART              0x00D9  /* 8 bits */
 120 #define RL_CPLUS_CMD            0x00E0  /* 16 bits */
 121 #define RL_RXLIST_ADDR_LO       0x00E4  /* 64 bits, 256 byte alignment */
 122 #define RL_RXLIST_ADDR_HI       0x00E8  /* 64 bits, 256 byte alignment */
 123 #define RL_EARLY_TX_THRESH      0x00EC  /* 8 bits */
 124
 125 /*
 126  * Registers specific to the 8169 gigE chip
 127  */
 128 #define RL_TIMERINT_8169        0x0058  /* different offset than 8139 */
 129 #define RL_PHYAR                0x0060
 130 #define RL_TBICSR               0x0064
 131 #define RL_TBI_ANAR             0x0068
 132 #define RL_TBI_LPAR             0x006A
 133 #define RL_GMEDIASTAT           0x006C  /* 8 bits */
 134 #define RL_MACDBG               0x006D  /* 8 bits, 8168C SPIN2 only */
 135 #define RL_GPIO                 0x006E  /* 8 bits, 8168C SPIN2 only */
 136 #define RL_MAXRXPKTLEN          0x00DA  /* 16 bits, chip multiplies by 8 */
 137 #define RL_GTXSTART             0x0038  /* 8 bits */
 138
 139 /*
 140  * TX config register bits
 141  */
 142 #define RL_TXCFG_CLRABRT        0x00000001      /* retransmit aborted pkt */
 143 #define RL_TXCFG_MAXDMA         0x00000700      /* max DMA burst size */
 144 #define RL_TXCFG_CRCAPPEND      0x00010000      /* CRC append (0 = yes) */
 145 #define RL_TXCFG_LOOPBKTST      0x00060000      /* loopback test */
 146 #define RL_TXCFG_IFG2           0x00080000      /* 8169 only */
 147 #define RL_TXCFG_IFG            0x03000000      /* interframe gap */
 148 #define RL_TXCFG_HWREV          0x7CC00000
 149
 150 #define RL_LOOPTEST_OFF         0x00000000
 151 #define RL_LOOPTEST_ON          0x00020000
 152 #define RL_LOOPTEST_ON_CPLUS    0x00060000
 153
 154 /* Known revision codes. */
 155
 156 #define RL_HWREV_8169           0x00000000
 157 #define RL_HWREV_8169S          0x00800000
 158 #define RL_HWREV_8110S          0x04000000
 159 #define RL_HWREV_8169_8110SB    0x10000000
 160 #define RL_HWREV_8169_8110SC    0x18000000
 161 #define RL_HWREV_8102EL         0x24800000
 162 #define RL_HWREV_8168D          0x28000000
 163 #define RL_HWREV_8168_SPIN1     0x30000000
 164 #define RL_HWREV_8100E          0x30800000
 165 #define RL_HWREV_8101E          0x34000000
 166 #define RL_HWREV_8102E          0x34800000
 167 #define RL_HWREV_8168_SPIN2     0x38000000
 168 #define RL_HWREV_8168_SPIN3     0x38400000
 169 #define RL_HWREV_8168C          0x3C000000
 170 #define RL_HWREV_8168C_SPIN2    0x3C400000
 171 #define RL_HWREV_8168CP         0x3C800000
 172 #define RL_HWREV_8139           0x60000000
 173 #define RL_HWREV_8139A          0x70000000
 174 #define RL_HWREV_8139AG         0x70800000
 175 #define RL_HWREV_8139B          0x78000000
 176 #define RL_HWREV_8130           0x7C000000
 177 #define RL_HWREV_8139C          0x74000000
 178 #define RL_HWREV_8139D          0x74400000
 179 #define RL_HWREV_8139CPLUS      0x74800000
 180 #define RL_HWREV_8101           0x74c00000
 181 #define RL_HWREV_8100           0x78800000
 182 #define RL_HWREV_8169_8110SBL   0x7CC00000
 183 #define RL_HWREV_8169_8110SCE   0x98000000
 184
 185 #define RL_TXDMA_16BYTES        0x00000000
 186 #define RL_TXDMA_32BYTES        0x00000100
 187 #define RL_TXDMA_64BYTES        0x00000200
 188 #define RL_TXDMA_128BYTES       0x00000300
 189 #define RL_TXDMA_256BYTES       0x00000400
 190 #define RL_TXDMA_512BYTES       0x00000500
 191 #define RL_TXDMA_1024BYTES      0x00000600
 192 #define RL_TXDMA_2048BYTES      0x00000700
 193
 194 /*
 195  * Transmit descriptor status register bits.
 196  */
 197 #define RL_TXSTAT_LENMASK       0x00001FFF
 198 #define RL_TXSTAT_OWN           0x00002000
 199 #define RL_TXSTAT_TX_UNDERRUN   0x00004000
 200 #define RL_TXSTAT_TX_OK         0x00008000
 201 #define RL_TXSTAT_EARLY_THRESH  0x003F0000
 202 #define RL_TXSTAT_COLLCNT       0x0F000000
 203 #define RL_TXSTAT_CARR_HBEAT    0x10000000
 204 #define RL_TXSTAT_OUTOFWIN      0x20000000
 205 #define RL_TXSTAT_TXABRT        0x40000000
 206 #define RL_TXSTAT_CARRLOSS      0x80000000
 207
 208 /*
 209  * Interrupt status register bits.
 210  */
 211 #define RL_ISR_RX_OK            0x0001
 212 #define RL_ISR_RX_ERR           0x0002
 213 #define RL_ISR_TX_OK            0x0004
 214 #define RL_ISR_TX_ERR           0x0008
 215 #define RL_ISR_RX_OVERRUN       0x0010
 216 #define RL_ISR_PKT_UNDERRUN     0x0020
 217 #define RL_ISR_LINKCHG          0x0020  /* 8169 only */
 218 #define RL_ISR_FIFO_OFLOW       0x0040  /* 8139 only */
 219 #define RL_ISR_TX_DESC_UNAVAIL  0x0080  /* C+ only */
 220 #define RL_ISR_SWI              0x0100  /* C+ only */
 221 #define RL_ISR_CABLE_LEN_CHGD   0x2000
 222 #define RL_ISR_PCS_TIMEOUT      0x4000  /* 8129 only */
 223 #define RL_ISR_TIMEOUT_EXPIRED  0x4000
 224 #define RL_ISR_SYSTEM_ERR       0x8000
 225
 226 #define RL_INTRS        \
 227         (RL_ISR_TX_OK|RL_ISR_RX_OK|RL_ISR_RX_ERR|RL_ISR_TX_ERR|         \
 228         RL_ISR_RX_OVERRUN|RL_ISR_PKT_UNDERRUN|RL_ISR_FIFO_OFLOW|        \
 229         RL_ISR_PCS_TIMEOUT|RL_ISR_SYSTEM_ERR)
 230
 231 #ifdef RE_TX_MODERATION
 232 #define RL_INTRS_CPLUS  \
 233         (RL_ISR_RX_OK|RL_ISR_RX_ERR|RL_ISR_TX_ERR|                      \
 234         RL_ISR_RX_OVERRUN|RL_ISR_PKT_UNDERRUN|RL_ISR_FIFO_OFLOW|        \
 235         RL_ISR_PCS_TIMEOUT|RL_ISR_SYSTEM_ERR|RL_ISR_TIMEOUT_EXPIRED)
 236 #else
 237 #define RL_INTRS_CPLUS  \
 238         (RL_ISR_RX_OK|RL_ISR_RX_ERR|RL_ISR_TX_ERR|RL_ISR_TX_OK|         \
 239         RL_ISR_RX_OVERRUN|RL_ISR_PKT_UNDERRUN|RL_ISR_FIFO_OFLOW|        \
 240         RL_ISR_PCS_TIMEOUT|RL_ISR_SYSTEM_ERR|RL_ISR_TIMEOUT_EXPIRED)
 241 #endif
 242
 243 /*
 244  * Media status register. (8139 only)
 245  */
 246 #define RL_MEDIASTAT_RXPAUSE    0x01
 247 #define RL_MEDIASTAT_TXPAUSE    0x02
 248 #define RL_MEDIASTAT_LINK       0x04
 249 #define RL_MEDIASTAT_SPEED10    0x08
 250 #define RL_MEDIASTAT_RXFLOWCTL  0x40    /* duplex mode */
 251 #define RL_MEDIASTAT_TXFLOWCTL  0x80    /* duplex mode */
 252
 253 /*
 254  * Receive config register.
 255  */
 256 #define RL_RXCFG_RX_ALLPHYS     0x00000001      /* accept all nodes */
 257 #define RL_RXCFG_RX_INDIV       0x00000002      /* match filter */
 258 #define RL_RXCFG_RX_MULTI       0x00000004      /* accept all multicast */
 259 #define RL_RXCFG_RX_BROAD       0x00000008      /* accept all broadcast */
 260 #define RL_RXCFG_RX_RUNT        0x00000010
 261 #define RL_RXCFG_RX_ERRPKT      0x00000020
 262 #define RL_RXCFG_WRAP           0x00000080
 263 #define RL_RXCFG_MAXDMA         0x00000700
 264 #define RL_RXCFG_BUFSZ          0x00001800
 265 #define RL_RXCFG_FIFOTHRESH     0x0000E000
 266 #define RL_RXCFG_EARLYTHRESH    0x07000000
 267
 268 #define RL_RXDMA_16BYTES        0x00000000
 269 #define RL_RXDMA_32BYTES        0x00000100
 270 #define RL_RXDMA_64BYTES        0x00000200
 271 #define RL_RXDMA_128BYTES       0x00000300
 272 #define RL_RXDMA_256BYTES       0x00000400
 273 #define RL_RXDMA_512BYTES       0x00000500
 274 #define RL_RXDMA_1024BYTES      0x00000600
 275 #define RL_RXDMA_UNLIMITED      0x00000700
 276
 277 #define RL_RXBUF_8              0x00000000
 278 #define RL_RXBUF_16             0x00000800
 279 #define RL_RXBUF_32             0x00001000
 280 #define RL_RXBUF_64             0x00001800
 281
 282 #define RL_RXFIFO_16BYTES       0x00000000
 283 #define RL_RXFIFO_32BYTES       0x00002000
 284 #define RL_RXFIFO_64BYTES       0x00004000
 285 #define RL_RXFIFO_128BYTES      0x00006000
 286 #define RL_RXFIFO_256BYTES      0x00008000
 287 #define RL_RXFIFO_512BYTES      0x0000A000
 288 #define RL_RXFIFO_1024BYTES     0x0000C000
 289 #define RL_RXFIFO_NOTHRESH      0x0000E000
 290
 291 /*
 292  * Bits in RX status header (included with RX'ed packet
 293  * in ring buffer).
 294  */
 295 #define RL_RXSTAT_RXOK          0x00000001
 296 #define RL_RXSTAT_ALIGNERR      0x00000002
 297 #define RL_RXSTAT_CRCERR        0x00000004
 298 #define RL_RXSTAT_GIANT         0x00000008
 299 #define RL_RXSTAT_RUNT          0x00000010
 300 #define RL_RXSTAT_BADSYM        0x00000020
 301 #define RL_RXSTAT_BROAD         0x00002000
 302 #define RL_RXSTAT_INDIV         0x00004000
 303 #define RL_RXSTAT_MULTI         0x00008000
 304 #define RL_RXSTAT_LENMASK       0xFFFF0000
 305
 306 #define RL_RXSTAT_UNFINISHED    0xFFF0          /* DMA still in progress */
 307 /*
 308  * Command register.
 309  */
 310 #define RL_CMD_EMPTY_RXBUF      0x0001
 311 #define RL_CMD_TX_ENB           0x0004
 312 #define RL_CMD_RX_ENB           0x0008
 313 #define RL_CMD_RESET            0x0010
 314 #define RL_CMD_STOPREQ          0x0080
 315
 316 /*
 317  * EEPROM control register
 318  */
 319 #define RL_EE_DATAOUT           0x01    /* Data out */
 320 #define RL_EE_DATAIN            0x02    /* Data in */
 321 #define RL_EE_CLK               0x04    /* clock */
 322 #define RL_EE_SEL               0x08    /* chip select */
 323 #define RL_EE_MODE              (0x40|0x80)
 324
 325 #define RL_EEMODE_OFF           0x00
 326 #define RL_EEMODE_AUTOLOAD      0x40
 327 #define RL_EEMODE_PROGRAM       0x80
 328 #define RL_EEMODE_WRITECFG      (0x80|0x40)
 329
 330 /* 9346 EEPROM commands */
 331 #define RL_9346_ADDR_LEN        6       /* 93C46 1K: 128x16 */
 332 #define RL_9356_ADDR_LEN        8       /* 93C56 2K: 256x16 */
 333
 334 #define RL_9346_WRITE          0x5
 335 #define RL_9346_READ           0x6
 336 #define RL_9346_ERASE          0x7
 337 #define RL_9346_EWEN           0x4
 338 #define RL_9346_EWEN_ADDR      0x30
 339 #define RL_9456_EWDS           0x4
 340 #define RL_9346_EWDS_ADDR      0x00
 341
 342 #define RL_EECMD_WRITE          0x140
 343 #define RL_EECMD_READ_6BIT      0x180
 344 #define RL_EECMD_READ_8BIT      0x600
 345 #define RL_EECMD_ERASE          0x1c0
 346
 347 #define RL_EE_ID                0x00
 348 #define RL_EE_PCI_VID           0x01
 349 #define RL_EE_PCI_DID           0x02
 350 /* Location of station address inside EEPROM */
 351 #define RL_EE_EADDR             0x07
 352
 353 /*
 354  * MII register (8129 only)
 355  */
 356 #define RL_MII_CLK              0x01
 357 #define RL_MII_DATAIN           0x02
 358 #define RL_MII_DATAOUT          0x04
 359 #define RL_MII_DIR              0x80    /* 0 == input, 1 == output */
 360
 361 /*
 362  * Config 0 register
 363  */
 364 #define RL_CFG0_ROM0            0x01
 365 #define RL_CFG0_ROM1            0x02
 366 #define RL_CFG0_ROM2            0x04
 367 #define RL_CFG0_PL0             0x08
 368 #define RL_CFG0_PL1             0x10
 369 #define RL_CFG0_10MBPS          0x20    /* 10 Mbps internal mode */
 370 #define RL_CFG0_PCS             0x40
 371 #define RL_CFG0_SCR             0x80
 372
 373 /*
 374  * Config 1 register
 375  */
 376 #define RL_CFG1_PWRDWN          0x01
 377 #define RL_CFG1_PME             0x01
 378 #define RL_CFG1_SLEEP           0x02
 379 #define RL_CFG1_VPDEN           0x02
 380 #define RL_CFG1_IOMAP           0x04
 381 #define RL_CFG1_MEMMAP          0x08
 382 #define RL_CFG1_RSVD            0x10
 383 #define RL_CFG1_LWACT           0x10
 384 #define RL_CFG1_DRVLOAD         0x20
 385 #define RL_CFG1_LED0            0x40
 386 #define RL_CFG1_FULLDUPLEX      0x40    /* 8129 only */
 387 #define RL_CFG1_LED1            0x80
 388
 389 /*
 390  * Config 2 register
 391  */
 392 #define RL_CFG2_PCI33MHZ        0x00
 393 #define RL_CFG2_PCI66MHZ        0x01
 394 #define RL_CFG2_PCI64BIT        0x08
 395 #define RL_CFG2_AUXPWR          0x10
 396 #define RL_CFG2_MSI             0x20
 397
 398 /*
 399  * Config 3 register
 400  */
 401 #define RL_CFG3_GRANTSEL        0x80
 402 #define RL_CFG3_WOL_MAGIC       0x20
 403 #define RL_CFG3_WOL_LINK        0x10
 404 #define RL_CFG3_FAST_B2B        0x01
 405
 406 /*
 407  * Config 4 register
 408  */
 409 #define RL_CFG4_LWPTN           0x04
 410 #define RL_CFG4_LWPME           0x10
 411
 412 /*
 413  * Config 5 register
 414  */
 415 #define RL_CFG5_WOL_BCAST       0x40
 416 #define RL_CFG5_WOL_MCAST       0x20
 417 #define RL_CFG5_WOL_UCAST       0x10
 418 #define RL_CFG5_WOL_LANWAKE     0x02
 419 #define RL_CFG5_PME_STS         0x01
 420
 421 /*
 422  * 8139C+ register definitions
 423  */
 424
 425 /* RL_DUMPSTATS_LO register */
 426
 427 #define RL_DUMPSTATS_START      0x00000008
 428
 429 /* Transmit start register */
 430
 431 #define RL_TXSTART_SWI          0x01    /* generate TX interrupt */
 432 #define RL_TXSTART_START        0x40    /* start normal queue transmit */
 433 #define RL_TXSTART_HPRIO_START  0x80    /* start hi prio queue transmit */
 434
 435 /*
 436  * Config 2 register, 8139C+/8169/8169S/8110S only
 437  */
 438 #define RL_CFG2_BUSFREQ         0x07
 439 #define RL_CFG2_BUSWIDTH        0x08
 440 #define RL_CFG2_AUXPWRSTS       0x10
 441
 442 #define RL_BUSFREQ_33MHZ        0x00
 443 #define RL_BUSFREQ_66MHZ        0x01
 444
 445 #define RL_BUSWIDTH_32BITS      0x00
 446 #define RL_BUSWIDTH_64BITS      0x08
 447
 448 /* C+ mode command register */
 449
 450 #define RL_CPLUSCMD_TXENB       0x0001  /* enable C+ transmit mode */
 451 #define RL_CPLUSCMD_RXENB       0x0002  /* enable C+ receive mode */
 452 #define RL_CPLUSCMD_PCI_MRW     0x0008  /* enable PCI multi-read/write */
 453 #define RL_CPLUSCMD_PCI_DAC     0x0010  /* PCI dual-address cycle only */
 454 #define RL_CPLUSCMD_RXCSUM_ENB  0x0020  /* enable RX checksum offload */
 455 #define RL_CPLUSCMD_VLANSTRIP   0x0040  /* enable VLAN tag stripping */
 456 #define RL_CPLUSCMD_MACSTAT_DIS 0x0080  /* 8168B/C/CP */
 457 #define RL_CPLUSCMD_ASF         0x0100  /* 8168C/CP */
 458 #define RL_CPLUSCMD_DBG_SEL     0x0200  /* 8168C/CP */
 459 #define RL_CPLUSCMD_FORCE_TXFC  0x0400  /* 8168C/CP */
 460 #define RL_CPLUSCMD_FORCE_RXFC  0x0800  /* 8168C/CP */
 461 #define RL_CPLUSCMD_FORCE_HDPX  0x1000  /* 8168C/CP */
 462 #define RL_CPLUSCMD_NORMAL_MODE 0x2000  /* 8168C/CP */
 463 #define RL_CPLUSCMD_DBG_ENB     0x4000  /* 8168C/CP */
 464 #define RL_CPLUSCMD_BIST_ENB    0x8000  /* 8168C/CP */
 465
 466 /* C+ early transmit threshold */
 467
 468 #define RL_EARLYTXTHRESH_CNT    0x003F  /* byte count times 8 */
 469
 470 /*
 471  * Gigabit PHY access register (8169 only)
 472  */
 473
 474 #define RL_PHYAR_PHYDATA        0x0000FFFF
 475 #define RL_PHYAR_PHYREG         0x001F0000
 476 #define RL_PHYAR_BUSY           0x80000000
 477
 478 /*
 479  * Gigabit media status (8169 only)
 480  */
 481 #define RL_GMEDIASTAT_FDX       0x01    /* full duplex */
 482 #define RL_GMEDIASTAT_LINK      0x02    /* link up */
 483 #define RL_GMEDIASTAT_10MBPS    0x04    /* 10mps link */
 484 #define RL_GMEDIASTAT_100MBPS   0x08    /* 100mbps link */
 485 #define RL_GMEDIASTAT_1000MBPS  0x10    /* gigE link */
 486 #define RL_GMEDIASTAT_RXFLOW    0x20    /* RX flow control on */
 487 #define RL_GMEDIASTAT_TXFLOW    0x40    /* TX flow control on */
 488 #define RL_GMEDIASTAT_TBI       0x80    /* TBI enabled */
 489
 490 /*
 491  * The RealTek doesn't use a fragment-based descriptor mechanism.
 492  * Instead, there are only four register sets, each or which represents
 493  * one 'descriptor.' Basically, each TX descriptor is just a contiguous
 494  * packet buffer (32-bit aligned!) and we place the buffer addresses in
 495  * the registers so the chip knows where they are.
 496  *
 497  * We can sort of kludge together the same kind of buffer management
 498  * used in previous drivers, but we have to do buffer copies almost all
 499  * the time, so it doesn't really buy us much.
 500  *
 501  * For reception, there's just one large buffer where the chip stores
 502  * all received packets.
 503  */
 504
 505 #define RL_RX_BUF_SZ            RL_RXBUF_64
 506 #define RL_RXBUFLEN             (1 << ((RL_RX_BUF_SZ >> 11) + 13))
 507 #define RL_TX_LIST_CNT          4
 508 #define RL_MIN_FRAMELEN         60
 509 #define RL_TX_8139_BUF_ALIGN    4
 510 #define RL_RX_8139_BUF_ALIGN    8
 511 #define RL_RX_8139_BUF_RESERVE  sizeof(int64_t)
 512 #define RL_RX_8139_BUF_GUARD_SZ \
 513         (ETHER_MAX_LEN + ETHER_VLAN_ENCAP_LEN + RL_RX_8139_BUF_RESERVE)
 514 #define RL_TXTHRESH(x)          ((x) << 11)
 515 #define RL_TX_THRESH_INIT       96
 516 #define RL_RX_FIFOTHRESH        RL_RXFIFO_NOTHRESH
 517 #define RL_RX_MAXDMA            RL_RXDMA_UNLIMITED
 518 #define RL_TX_MAXDMA            RL_TXDMA_2048BYTES
 519
 520 #define RL_RXCFG_CONFIG (RL_RX_FIFOTHRESH|RL_RX_MAXDMA|RL_RX_BUF_SZ)
 521 #define RL_TXCFG_CONFIG (RL_TXCFG_IFG|RL_TX_MAXDMA)
 522
 523 #define RL_ETHER_ALIGN  2
 524
 525 /*
 526  * re(4) hardware ip4csum-tx could be mangled with 28 bytes or less IP packets.
 527  */
 528 #define RL_IP4CSUMTX_MINLEN     28
 529 #define RL_IP4CSUMTX_PADLEN     (ETHER_HDR_LEN + RL_IP4CSUMTX_MINLEN)
 530
 531 struct rl_chain_data {
 532         uint16_t                cur_rx;
 533         uint8_t                 *rl_rx_buf;
 534         uint8_t                 *rl_rx_buf_ptr;
 535
 536         struct mbuf             *rl_tx_chain[RL_TX_LIST_CNT];
 537         bus_dmamap_t            rl_tx_dmamap[RL_TX_LIST_CNT];
 538         bus_dma_tag_t           rl_tx_tag;
 539         bus_dma_tag_t           rl_rx_tag;
 540         bus_dmamap_t            rl_rx_dmamap;
 541         bus_addr_t              rl_rx_buf_paddr;
 542         uint8_t                 last_tx;
 543         uint8_t                 cur_tx;
 544 };
 545
 546 #define RL_INC(x)               (x = (x + 1) % RL_TX_LIST_CNT)
 547 #define RL_CUR_TXADDR(x)        ((x->rl_cdata.cur_tx * 4) + RL_TXADDR0)
 548 #define RL_CUR_TXSTAT(x)        ((x->rl_cdata.cur_tx * 4) + RL_TXSTAT0)
 549 #define RL_CUR_TXMBUF(x)        (x->rl_cdata.rl_tx_chain[x->rl_cdata.cur_tx])
 550 #define RL_CUR_DMAMAP(x)        (x->rl_cdata.rl_tx_dmamap[x->rl_cdata.cur_tx])
 551 #define RL_LAST_TXADDR(x)       ((x->rl_cdata.last_tx * 4) + RL_TXADDR0)
 552 #define RL_LAST_TXSTAT(x)       ((x->rl_cdata.last_tx * 4) + RL_TXSTAT0)
 553 #define RL_LAST_TXMBUF(x)       (x->rl_cdata.rl_tx_chain[x->rl_cdata.last_tx])
 554 #define RL_LAST_DMAMAP(x)       (x->rl_cdata.rl_tx_dmamap[x->rl_cdata.last_tx])
 555
 556 struct rl_type {
 557         uint16_t                rl_vid;
 558         uint16_t                rl_did;
 559         int                     rl_basetype;
 560         char                    *rl_name;
 561 };
 562
 563 struct rl_hwrev {
 564         uint32_t                rl_rev;
 565         int                     rl_type;
 566         char                    *rl_desc;
 567 };
 568
 569 struct rl_mii_frame {
 570         uint8_t         mii_stdelim;
 571         uint8_t         mii_opcode;
 572         uint8_t         mii_phyaddr;
 573         uint8_t         mii_regaddr;
 574         uint8_t         mii_turnaround;
 575         uint16_t        mii_data;
 576 };
 577
 578 /*
 579  * MII constants
 580  */
 581 #define RL_MII_STARTDELIM       0x01
 582 #define RL_MII_READOP           0x02
 583 #define RL_MII_WRITEOP          0x01
 584 #define RL_MII_TURNAROUND       0x02
 585
 586 #define RL_8129                 1
 587 #define RL_8139                 2
 588 #define RL_8139CPLUS            3
 589 #define RL_8169                 4
 590
 591 #define RL_ISCPLUS(x)           ((x)->rl_type == RL_8139CPLUS ||        \
 592                                  (x)->rl_type == RL_8169)
 593
 594 /*
 595  * The 8139C+ and 8160 gigE chips support descriptor-based TX
 596  * and RX. In fact, they even support TCP large send. Descriptors
 597  * must be allocated in contiguous blocks that are aligned on a
 598  * 256-byte boundary. The rings can hold a maximum of 64 descriptors.
 599  */
 600
 601 /*
 602  * RX/TX descriptor definition. When large send mode is enabled, the
 603  * lower 11 bits of the TX rl_cmd word are used to hold the MSS, and
 604  * the checksum offload bits are disabled. The structure layout is
 605  * the same for RX and TX descriptors
 606  */
 607
 608 struct rl_desc {
 609         uint32_t                rl_cmdstat;
 610         uint32_t                rl_vlanctl;
 611         uint32_t                rl_bufaddr_lo;
 612         uint32_t                rl_bufaddr_hi;
 613 };
 614
 615 #define RL_TDESC_CMD_FRAGLEN    0x0000FFFF
 616 #define RL_TDESC_CMD_TCPCSUM    0x00010000      /* TCP checksum enable */
 617 #define RL_TDESC_CMD_UDPCSUM    0x00020000      /* UDP checksum enable */
 618 #define RL_TDESC_CMD_IPCSUM     0x00040000      /* IP header checksum enable */
 619 #define RL_TDESC_CMD_MSSVAL     0x07FF0000      /* Large send MSS value */
 620 #define RL_TDESC_CMD_MSSVAL_SHIFT       16      /* Large send MSS value shift */
 621 #define RL_TDESC_CMD_LGSEND     0x08000000      /* TCP large send enb */
 622 #define RL_TDESC_CMD_EOF        0x10000000      /* end of frame marker */
 623 #define RL_TDESC_CMD_SOF        0x20000000      /* start of frame marker */
 624 #define RL_TDESC_CMD_EOR        0x40000000      /* end of ring marker */
 625 #define RL_TDESC_CMD_OWN        0x80000000      /* chip owns descriptor */
 626
 627 #define RL_TDESC_VLANCTL_TAG    0x00020000      /* Insert VLAN tag */
 628 #define RL_TDESC_VLANCTL_DATA   0x0000FFFF      /* TAG data */
 629 /* RTL8168C/RTL8168CP/RTL8111C/RTL8111CP */
 630 #define RL_TDESC_CMD_UDPCSUMV2  0x80000000
 631 #define RL_TDESC_CMD_TCPCSUMV2  0x40000000
 632 #define RL_TDESC_CMD_IPCSUMV2   0x20000000
 633
 634 /*
 635  * Error bits are valid only on the last descriptor of a frame
 636  * (i.e. RL_TDESC_CMD_EOF == 1)
 637  */
 638
 639 #define RL_TDESC_STAT_COLCNT    0x000F0000      /* collision count */
 640 #define RL_TDESC_STAT_EXCESSCOL 0x00100000      /* excessive collisions */
 641 #define RL_TDESC_STAT_LINKFAIL  0x00200000      /* link faulure */
 642 #define RL_TDESC_STAT_OWINCOL   0x00400000      /* out-of-window collision */
 643 #define RL_TDESC_STAT_TXERRSUM  0x00800000      /* transmit error summary */
 644 #define RL_TDESC_STAT_UNDERRUN  0x02000000      /* TX underrun occured */
 645 #define RL_TDESC_STAT_OWN       0x80000000
 646
 647 /*
 648  * RX descriptor cmd/vlan definitions
 649  */
 650
 651 #define RL_RDESC_CMD_EOR        0x40000000
 652 #define RL_RDESC_CMD_OWN        0x80000000
 653 #define RL_RDESC_CMD_BUFLEN     0x00001FFF
 654
 655 #define RL_RDESC_STAT_OWN       0x80000000
 656 #define RL_RDESC_STAT_EOR       0x40000000
 657 #define RL_RDESC_STAT_SOF       0x20000000
 658 #define RL_RDESC_STAT_EOF       0x10000000
 659 #define RL_RDESC_STAT_FRALIGN   0x08000000      /* frame alignment error */
 660 #define RL_RDESC_STAT_MCAST     0x04000000      /* multicast pkt received */
 661 #define RL_RDESC_STAT_UCAST     0x02000000      /* unicast pkt received */
 662 #define RL_RDESC_STAT_BCAST     0x01000000      /* broadcast pkt received */
 663 #define RL_RDESC_STAT_BUFOFLOW  0x00800000      /* out of buffer space */
 664 #define RL_RDESC_STAT_FIFOOFLOW 0x00400000      /* FIFO overrun */
 665 #define RL_RDESC_STAT_GIANT     0x00200000      /* pkt > 4096 bytes */
 666 #define RL_RDESC_STAT_RXERRSUM  0x00100000      /* RX error summary */
 667 #define RL_RDESC_STAT_RUNT      0x00080000      /* runt packet received */
 668 #define RL_RDESC_STAT_CRCERR    0x00040000      /* CRC error */
 669 #define RL_RDESC_STAT_PROTOID   0x00030000      /* Protocol type */
 670 #define RL_RDESC_STAT_UDP       0x00020000      /* UDP, 8168C/CP, 8111C/CP */
 671 #define RL_RDESC_STAT_TCP       0x00010000      /* TCP, 8168C/CP, 8111C/CP */
 672 #define RL_RDESC_STAT_IPSUMBAD  0x00008000      /* IP header checksum bad */
 673 #define RL_RDESC_STAT_UDPSUMBAD 0x00004000      /* UDP checksum bad */
 674 #define RL_RDESC_STAT_TCPSUMBAD 0x00002000      /* TCP checksum bad */
 675 #define RL_RDESC_STAT_FRAGLEN   0x00001FFF      /* RX'ed frame/frag len */
 676 #define RL_RDESC_STAT_GFRAGLEN  0x00003FFF      /* RX'ed frame/frag len */
 677 #define RL_RDESC_STAT_ERRS      (RL_RDESC_STAT_GIANT|RL_RDESC_STAT_RUNT| \
 678                                  RL_RDESC_STAT_CRCERR)
 679
 680 #define RL_RDESC_VLANCTL_TAG    0x00010000      /* VLAN tag available
 681                                                    (rl_vlandata valid)*/
 682 #define RL_RDESC_VLANCTL_DATA   0x0000FFFF      /* TAG data */
 683 /* RTL8168C/RTL8168CP/RTL8111C/RTL8111CP */
 684 #define RL_RDESC_IPV6           0x80000000
 685 #define RL_RDESC_IPV4           0x40000000
 686
 687 #define RL_PROTOID_NONIP        0x00000000
 688 #define RL_PROTOID_TCPIP        0x00010000
 689 #define RL_PROTOID_UDPIP        0x00020000
 690 #define RL_PROTOID_IP           0x00030000
 691 #define RL_TCPPKT(x)            (((x) & RL_RDESC_STAT_PROTOID) == \
 692                                  RL_PROTOID_TCPIP)
 693 #define RL_UDPPKT(x)            (((x) & RL_RDESC_STAT_PROTOID) == \
 694                                  RL_PROTOID_UDPIP)
 695
 696 /*
 697  * Statistics counter structure (8139C+ and 8169 only)
 698  */
 699 struct rl_stats {
 700         uint32_t                rl_tx_pkts_lo;
 701         uint32_t                rl_tx_pkts_hi;
 702         uint32_t                rl_tx_errs_lo;
 703         uint32_t                rl_tx_errs_hi;
 704         uint32_t                rl_tx_errs;
 705         uint16_t                rl_missed_pkts;
 706         uint16_t                rl_rx_framealign_errs;
 707         uint32_t                rl_tx_onecoll;
 708         uint32_t                rl_tx_multicolls;
 709         uint32_t                rl_rx_ucasts_hi;
 710         uint32_t                rl_rx_ucasts_lo;
 711         uint32_t                rl_rx_bcasts_lo;
 712         uint32_t                rl_rx_bcasts_hi;
 713         uint32_t                rl_rx_mcasts;
 714         uint16_t                rl_tx_aborts;
 715         uint16_t                rl_rx_underruns;
 716 };
 717
 718 /*
 719  * Rx/Tx descriptor parameters (8139C+ and 8169 only)
 720  *
 721  * 8139C+
 722  *  Number of descriptors supported : up to 64
 723  *  Descriptor alignment : 256 bytes
 724  *  Tx buffer : At least 4 bytes in length.
 725  *  Rx buffer : At least 8 bytes in length and 8 bytes alignment required.
 726  *
 727  * 8169
 728  *  Number of descriptors supported : up to 1024
 729  *  Descriptor alignment : 256 bytes
 730  *  Tx buffer : At least 4 bytes in length.
 731  *  Rx buffer : At least 8 bytes in length and 8 bytes alignment required.
 732  */
 733 #ifndef __NO_STRICT_ALIGNMENT
 734 #define RE_FIXUP_RX     1
 735 #endif
 736
 737 #define RL_8169_TX_DESC_CNT     256
 738 #define RL_8169_RX_DESC_CNT     256
 739 #define RL_8139_TX_DESC_CNT     64
 740 #define RL_8139_RX_DESC_CNT     64
 741 #define RL_TX_DESC_CNT          RL_8169_TX_DESC_CNT
 742 #define RL_RX_DESC_CNT          RL_8169_RX_DESC_CNT
 743 #define RL_NTXSEGS              32
 744
 745 #define RL_RING_ALIGN           256
 746 #define RL_IFQ_MAXLEN           512
 747 #define RL_TX_DESC_NXT(sc,x)    ((x + 1) & ((sc)->rl_ldata.rl_tx_desc_cnt - 1))
 748 #define RL_TX_DESC_PRV(sc,x)    ((x - 1) & ((sc)->rl_ldata.rl_tx_desc_cnt - 1))
 749 #define RL_RX_DESC_NXT(sc,x)    ((x + 1) & ((sc)->rl_ldata.rl_rx_desc_cnt - 1))
 750 #define RL_OWN(x)               (le32toh((x)->rl_cmdstat) & RL_RDESC_STAT_OWN)
 751 #define RL_RXBYTES(x)           (le32toh((x)->rl_cmdstat) & sc->rl_rxlenmask)
 752 #define RL_PKTSZ(x)             ((x)/* >> 3*/)
 753 #ifdef RE_FIXUP_RX
 754 #define RE_ETHER_ALIGN  sizeof(uint64_t)
 755 #define RE_RX_DESC_BUFLEN       (MCLBYTES - RE_ETHER_ALIGN)
 756 #else
 757 #define RE_ETHER_ALIGN  0
 758 #define RE_RX_DESC_BUFLEN       MCLBYTES
 759 #endif
 760
 761 #define RL_MSI_MESSAGES 1
 762
 763 #define RL_ADDR_LO(y)           ((uint64_t) (y) & 0xFFFFFFFF)
 764 #define RL_ADDR_HI(y)           ((uint64_t) (y) >> 32)
 765
 766 /*
 767  * The number of bits reserved for MSS in RealTek controllers is
 768  * 11bits. This limits the maximum interface MTU size in TSO case
 769  * as upper stack should not generate TCP segments with MSS greater
 770  * than the limit.
 771  */
 772 #define RL_TSO_MTU              (2047 - ETHER_HDR_LEN - ETHER_CRC_LEN)
 773
 774 /* see comment in dev/re/if_re.c */
 775 #define RL_JUMBO_FRAMELEN       7440
 776 #define RL_JUMBO_MTU            (RL_JUMBO_FRAMELEN-ETHER_HDR_LEN-ETHER_CRC_LEN)
 777 #define RL_MAX_FRAMELEN         \
 778         (ETHER_MAX_LEN + ETHER_VLAN_ENCAP_LEN - ETHER_HDR_LEN - ETHER_CRC_LEN)
 779
 780 struct rl_txdesc {
 781         struct mbuf             *tx_m;
 782         bus_dmamap_t            tx_dmamap;
 783 };
 784
 785 struct rl_rxdesc {
 786         struct mbuf             *rx_m;
 787         bus_dmamap_t            rx_dmamap;
 788         bus_size_t              rx_size;
 789 };
 790
 791 struct rl_list_data {
 792         struct rl_txdesc        rl_tx_desc[RL_TX_DESC_CNT];
 793         struct rl_rxdesc        rl_rx_desc[RL_RX_DESC_CNT];
 794         int                     rl_tx_desc_cnt;
 795         int                     rl_rx_desc_cnt;
 796         int                     rl_tx_prodidx;
 797         int                     rl_rx_prodidx;
 798         int                     rl_tx_considx;
 799         int                     rl_tx_free;
 800         bus_dma_tag_t           rl_tx_mtag;     /* mbuf TX mapping tag */
 801         bus_dma_tag_t           rl_rx_mtag;     /* mbuf RX mapping tag */
 802         bus_dmamap_t            rl_rx_sparemap;
 803         bus_dma_tag_t           rl_stag;        /* stats mapping tag */
 804         bus_dmamap_t            rl_smap;        /* stats map */
 805         struct rl_stats         *rl_stats;
 806         bus_addr_t              rl_stats_addr;
 807         bus_dma_tag_t           rl_rx_list_tag;
 808         bus_dmamap_t            rl_rx_list_map;
 809         struct rl_desc          *rl_rx_list;
 810         bus_addr_t              rl_rx_list_addr;
 811         bus_dma_tag_t           rl_tx_list_tag;
 812         bus_dmamap_t            rl_tx_list_map;
 813         struct rl_desc          *rl_tx_list;
 814         bus_addr_t              rl_tx_list_addr;
 815 };
 816
 817 struct rl_softc {
 818         struct ifnet            *rl_ifp;        /* interface info */
 819         bus_space_handle_t      rl_bhandle;     /* bus space handle */
 820         bus_space_tag_t         rl_btag;        /* bus space tag */
 821         device_t                rl_dev;
 822         struct resource         *rl_res;
 823         int                     rl_res_id;
 824         int                     rl_res_type;
 825         struct resource         *rl_irq[RL_MSI_MESSAGES];
 826         void                    *rl_intrhand[RL_MSI_MESSAGES];
 827         device_t                rl_miibus;
 828         bus_dma_tag_t           rl_parent_tag;
 829         uint8_t                 rl_type;
 830         int                     rl_eecmd_read;
 831         int                     rl_eewidth;
 832         uint8_t                 rl_stats_no_timeout;
 833         int                     rl_txthresh;
 834         struct rl_chain_data    rl_cdata;
 835         struct rl_list_data     rl_ldata;
 836         struct callout          rl_stat_callout;
 837         int                     rl_watchdog_timer;
 838         struct mtx              rl_mtx;
 839         struct mbuf             *rl_head;
 840         struct mbuf             *rl_tail;
 841         uint32_t                rl_hwrev;
 842         uint32_t                rl_rxlenmask;
 843         int                     rl_testmode;
 844         int                     rl_if_flags;
 845         int                     suspended;      /* 0 = normal  1 = suspended */
 846 #ifdef DEVICE_POLLING
 847         int                     rxcycles;
 848 #endif
 849
 850         struct task             rl_txtask;
 851         struct task             rl_inttask;
 852
 853         int                     rl_txstart;
 854         uint32_t                rl_flags;
 855 #define RL_FLAG_MSI             0x0001
 856 #define RL_FLAG_PHYWAKE         0x0008
 857 #define RL_FLAG_NOJUMBO         0x0010
 858 #define RL_FLAG_PAR             0x0020
 859 #define RL_FLAG_DESCV2          0x0040
 860 #define RL_FLAG_MACSTAT         0x0080
 861 #define RL_FLAG_FASTETHER       0x0100
 862 #define RL_FLAG_CMDSTOP         0x0200
 863 #define RL_FLAG_MACRESET        0x0400
 864 #define RL_FLAG_WOLRXENB        0x1000
 865 #define RL_FLAG_MACSLEEP        0x2000
 866 #define RL_FLAG_PCIE            0x4000
 867 #define RL_FLAG_LINK            0x8000
 868 };
 869
 870 #define RL_LOCK(_sc)            mtx_lock(&(_sc)->rl_mtx)
 871 #define RL_UNLOCK(_sc)          mtx_unlock(&(_sc)->rl_mtx)
 872 #define RL_LOCK_ASSERT(_sc)     mtx_assert(&(_sc)->rl_mtx, MA_OWNED)
 873
 874 /*
 875  * register space access macros
 876  */
 877 #define CSR_WRITE_STREAM_4(sc, reg, val)        \
 878         bus_space_write_stream_4(sc->rl_btag, sc->rl_bhandle, reg, val)
 879 #define CSR_WRITE_4(sc, reg, val)       \
 880         bus_space_write_4(sc->rl_btag, sc->rl_bhandle, reg, val)
 881 #define CSR_WRITE_2(sc, reg, val)       \
 882         bus_space_write_2(sc->rl_btag, sc->rl_bhandle, reg, val)
 883 #define CSR_WRITE_1(sc, reg, val)       \
 884         bus_space_write_1(sc->rl_btag, sc->rl_bhandle, reg, val)
 885
 886 #define CSR_READ_4(sc, reg)             \
 887         bus_space_read_4(sc->rl_btag, sc->rl_bhandle, reg)
 888 #define CSR_READ_2(sc, reg)             \
 889         bus_space_read_2(sc->rl_btag, sc->rl_bhandle, reg)
 890 #define CSR_READ_1(sc, reg)             \
 891         bus_space_read_1(sc->rl_btag, sc->rl_bhandle, reg)
 892
 893 #define CSR_SETBIT_1(sc, offset, val)           \
 894         CSR_WRITE_1(sc, offset, CSR_READ_1(sc, offset) | (val))
 895
 896 #define CSR_CLRBIT_1(sc, offset, val)           \
 897         CSR_WRITE_1(sc, offset, CSR_READ_1(sc, offset) & ~(val))
 898
 899 #define CSR_SETBIT_2(sc, offset, val)           \
 900         CSR_WRITE_2(sc, offset, CSR_READ_2(sc, offset) | (val))
 901
 902 #define CSR_CLRBIT_2(sc, offset, val)           \
 903         CSR_WRITE_2(sc, offset, CSR_READ_2(sc, offset) & ~(val))
 904
 905 #define CSR_SETBIT_4(sc, offset, val)           \
 906         CSR_WRITE_4(sc, offset, CSR_READ_4(sc, offset) | (val))
 907
 908 #define CSR_CLRBIT_4(sc, offset, val)           \
 909         CSR_WRITE_4(sc, offset, CSR_READ_4(sc, offset) & ~(val))
 910
 911 #define RL_TIMEOUT              1000
 912 #define RL_PHY_TIMEOUT          2000
 913
 914 /*
 915  * General constants that are fun to know.
 916  *
 917  * RealTek PCI vendor ID
 918  */
 919 #define RT_VENDORID                             0x10EC
 920
 921 /*
 922  * RealTek chip device IDs.
 923  */
 924 #define RT_DEVICEID_8139D                       0x8039
 925 #define RT_DEVICEID_8129                        0x8129
 926 #define RT_DEVICEID_8101E                       0x8136
 927 #define RT_DEVICEID_8138                        0x8138
 928 #define RT_DEVICEID_8139                        0x8139
 929 #define RT_DEVICEID_8169SC                      0x8167
 930 #define RT_DEVICEID_8168                        0x8168
 931 #define RT_DEVICEID_8169                        0x8169
 932 #define RT_DEVICEID_8100                        0x8100
 933
 934 #define RT_REVID_8139CPLUS                      0x20
 935
 936 /*
 937  * Accton PCI vendor ID
 938  */
 939 #define ACCTON_VENDORID                         0x1113
 940
 941 /*
 942  * Accton MPX 5030/5038 device ID.
 943  */
 944 #define ACCTON_DEVICEID_5030                    0x1211
 945
 946 /*
 947  * Nortel PCI vendor ID
 948  */
 949 #define NORTEL_VENDORID                         0x126C
 950
 951 /*
 952  * Delta Electronics Vendor ID.
 953  */
 954 #define DELTA_VENDORID                          0x1500
 955
 956 /*
 957  * Delta device IDs.
 958  */
 959 #define DELTA_DEVICEID_8139                     0x1360
 960
 961 /*
 962  * Addtron vendor ID.
 963  */
 964 #define ADDTRON_VENDORID                        0x4033
 965
 966 /*
 967  * Addtron device IDs.
 968  */
 969 #define ADDTRON_DEVICEID_8139                   0x1360
 970
 971 /*
 972  * D-Link vendor ID.
 973  */
 974 #define DLINK_VENDORID                          0x1186
 975
 976 /*
 977  * D-Link DFE-530TX+ device ID
 978  */
 979 #define DLINK_DEVICEID_530TXPLUS                0x1300
 980
 981 /*
 982  * D-Link DFE-5280T device ID
 983  */
 984 #define DLINK_DEVICEID_528T                     0x4300
 985
 986 /*
 987  * D-Link DFE-690TXD device ID
 988  */
 989 #define DLINK_DEVICEID_690TXD                   0x1340
 990
 991 /*
 992  * Corega K.K vendor ID
 993  */
 994 #define COREGA_VENDORID                         0x1259
 995
 996 /*
 997  * Corega FEther CB-TXD device ID
 998  */
 999 #define COREGA_DEVICEID_FETHERCBTXD             0xa117
1000
1001 /*
1002  * Corega FEtherII CB-TXD device ID
1003  */
1004 #define COREGA_DEVICEID_FETHERIICBTXD           0xa11e
1005
1006 /*
1007  * Corega CG-LAPCIGT device ID
1008  */
1009 #define COREGA_DEVICEID_CGLAPCIGT               0xc107
1010
1011 /*
1012  * Linksys vendor ID
1013  */
1014 #define LINKSYS_VENDORID                        0x1737
1015
1016 /*
1017  * Linksys EG1032 device ID
1018  */
1019 #define LINKSYS_DEVICEID_EG1032                 0x1032
1020
1021 /*
1022  * Linksys EG1032 rev 3 sub-device ID
1023  */
1024 #define LINKSYS_SUBDEVICE_EG1032_REV3           0x0024
1025
1026 /*
1027  * Peppercon vendor ID
1028  */
1029 #define PEPPERCON_VENDORID                      0x1743
1030
1031 /*
1032  * Peppercon ROL-F device ID
1033  */
1034 #define PEPPERCON_DEVICEID_ROLF                 0x8139
1035
1036 /*
1037  * Planex Communications, Inc. vendor ID
1038  */
1039 #define PLANEX_VENDORID                         0x14ea
1040
1041 /*
1042  * Planex FNW-3603-TX device ID
1043  */
1044 #define PLANEX_DEVICEID_FNW3603TX               0xab06
1045
1046 /*
1047  * Planex FNW-3800-TX device ID
1048  */
1049 #define PLANEX_DEVICEID_FNW3800TX               0xab07
1050
1051 /*
1052  * LevelOne vendor ID
1053  */
1054 #define LEVEL1_VENDORID                         0x018A
1055
1056 /*
1057  * LevelOne FPC-0106TX devide ID
1058  */
1059 #define LEVEL1_DEVICEID_FPC0106TX               0x0106
1060
1061 /*
1062  * Compaq vendor ID
1063  */
1064 #define CP_VENDORID                             0x021B
1065
1066 /*
1067  * Edimax vendor ID
1068  */
1069 #define EDIMAX_VENDORID                         0x13D1
1070
1071 /*
1072  * Edimax EP-4103DL cardbus device ID
1073  */
1074 #define EDIMAX_DEVICEID_EP4103DL                0xAB06
1075
1076 /* US Robotics vendor ID */
1077
1078 #define USR_VENDORID            0x16EC
1079
1080 /* US Robotics 997902 device ID */
1081
1082 #define USR_DEVICEID_997902     0x0116
1083
1084 /*
1085  * PCI low memory base and low I/O base register, and
1086  * other PCI registers.
1087  */
1088
1089 #define RL_PCI_VENDOR_ID        0x00
1090 #define RL_PCI_DEVICE_ID        0x02
1091 #define RL_PCI_COMMAND          0x04
1092 #define RL_PCI_STATUS           0x06
1093 #define RL_PCI_CLASSCODE        0x09
1094 #define RL_PCI_LATENCY_TIMER    0x0D
1095 #define RL_PCI_HEADER_TYPE      0x0E
1096 #define RL_PCI_LOIO             0x10
1097 #define RL_PCI_LOMEM            0x14
1098 #define RL_PCI_BIOSROM          0x30
1099 #define RL_PCI_INTLINE          0x3C
1100 #define RL_PCI_INTPIN           0x3D
1101 #define RL_PCI_MINGNT           0x3E
1102 #define RL_PCI_MINLAT           0x0F
1103 #define RL_PCI_RESETOPT         0x48
1104 #define RL_PCI_EEPROM_DATA      0x4C
1105
1106 #define RL_PCI_CAPID            0x50 /* 8 bits */
1107 #define RL_PCI_NEXTPTR          0x51 /* 8 bits */
1108 #define RL_PCI_PWRMGMTCAP       0x52 /* 16 bits */
1109 #define RL_PCI_PWRMGMTCTRL      0x54 /* 16 bits */
1110
1111 #define RL_PSTATE_MASK          0x0003
1112 #define RL_PSTATE_D0            0x0000
1113 #define RL_PSTATE_D1            0x0002
1114 #define RL_PSTATE_D2            0x0002
1115 #define RL_PSTATE_D3            0x0003
1116 #define RL_PME_EN               0x0010
1117 #define RL_PME_STATUS           0x8000