sys/dev/vr/if_vrreg.h

   1 /*-
   2  * SPDX-License-Identifier: BSD-4-Clause
   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$
  35  */
  36
  37 /*
  38  * Rhine register definitions.
  39  */
  40
  41 #define VR_PAR0                 0x00    /* node address 0 to 4 */
  42 #define VR_PAR1                 0x04    /* node address 2 to 6 */
  43 #define VR_RXCFG                0x06    /* receiver config register */
  44 #define VR_TXCFG                0x07    /* transmit config register */
  45 #define VR_CR0                  0x08    /* command register 0 */
  46 #define VR_CR1                  0x09    /* command register 1 */
  47 #define VR_TQW                  0x0A    /* tx queue wake 6105M, 8bits */
  48 #define VR_ISR                  0x0C    /* interrupt/status register */
  49 #define VR_IMR                  0x0E    /* interrupt mask register */
  50 #define VR_MAR0                 0x10    /* multicast hash 0 */
  51 #define VR_MAR1                 0x14    /* multicast hash 1 */
  52 #define VR_MCAM0                0x10
  53 #define VR_MCAM1                0x11
  54 #define VR_MCAM2                0x12
  55 #define VR_MCAM3                0x13
  56 #define VR_MCAM4                0x14
  57 #define VR_MCAM5                0x15
  58 #define VR_VCAM0                0x16
  59 #define VR_VCAM1                0x17
  60 #define VR_RXADDR               0x18    /* rx descriptor list start addr */
  61 #define VR_TXADDR               0x1C    /* tx descriptor list start addr */
  62 #define VR_CURRXDESC0           0x20
  63 #define VR_CURRXDESC1           0x24
  64 #define VR_CURRXDESC2           0x28
  65 #define VR_CURRXDESC3           0x2C
  66 #define VR_NEXTRXDESC0          0x30
  67 #define VR_NEXTRXDESC1          0x34
  68 #define VR_NEXTRXDESC2          0x38
  69 #define VR_NEXTRXDESC3          0x3C
  70 #define VR_CURTXDESC0           0x40
  71 #define VR_CURTXDESC1           0x44
  72 #define VR_CURTXDESC2           0x48
  73 #define VR_CURTXDESC3           0x4C
  74 #define VR_NEXTTXDESC0          0x50
  75 #define VR_NEXTTXDESC1          0x54
  76 #define VR_NEXTTXDESC2          0x58
  77 #define VR_NEXTTXDESC3          0x5C
  78 #define VR_CURRXDMA             0x60    /* current RX DMA address */
  79 #define VR_CURTXDMA             0x64    /* current TX DMA address */
  80 #define VR_TALLYCNT             0x68    /* tally counter test register */
  81 #define VR_PHYADDR              0x6C
  82 #define VR_MIISTAT              0x6D
  83 #define VR_BCR0                 0x6E
  84 #define VR_BCR1                 0x6F
  85 #define VR_MIICMD               0x70
  86 #define VR_MIIADDR              0x71
  87 #define VR_MIIDATA              0x72
  88 #define VR_EECSR                0x74
  89 #define VR_TEST                 0x75
  90 #define VR_GPIO                 0x76
  91 #define VR_CFGA                 0x78
  92 #define VR_CFGB                 0x79
  93 #define VR_CFGC                 0x7A
  94 #define VR_CFGD                 0x7B
  95 #define VR_MPA_CNT              0x7C
  96 #define VR_CRC_CNT              0x7E
  97 #define VR_MISC_CR0             0x80    /* VT6102, 8bits */
  98 #define VR_MISC_CR1             0x81
  99 #define VR_STICKHW              0x83
 100 #define VR_MII_ISR              0x84
 101 #define VR_MII_IMR              0x86
 102 #define VR_CAMMASK              0x88    /* VT6105M, 32bits */
 103 #define VR_CAMCTL               0x92    /* VT6105M, 8bits */
 104 #define VR_CAMADDR              0x93    /* VT6105M, 8bits */
 105 #define VR_FLOWCR0              0x98
 106 #define VR_FLOWCR1              0x99
 107 #define VR_PAUSETIMER           0x9A    /* 16bit */
 108 #define VR_WOLCR_SET            0xA0
 109 #define VR_PWRCFG_SET           0xA1
 110 #define VR_TESTREG_SET          0xA2
 111 #define VR_WOLCFG_SET           0xA3
 112 #define VR_WOLCR_CLR            0xA4
 113 #define VR_PWRCFG_CLR           0xA5
 114 #define VR_TESTREG_CLR          0xA6
 115 #define VR_WOLCFG_CLR           0xA7
 116 #define VR_PWRCSR_SET           0xA8
 117 #define VR_PWRCSR1_SET          0xA9
 118 #define VR_PWRCSR_CLR           0xAC
 119 #define VR_PWRCSR1_CLR          0xAD
 120
 121 /* Misc Registers */
 122 #define VR_MISCCR0_RXPAUSE      0x08
 123 #define VR_MISCCR1_FORSRST      0x40
 124
 125 /*
 126  * RX config bits.
 127  */
 128 #define VR_RXCFG_RX_ERRPKTS     0x01
 129 #define VR_RXCFG_RX_RUNT        0x02
 130 #define VR_RXCFG_RX_MULTI       0x04
 131 #define VR_RXCFG_RX_BROAD       0x08
 132 #define VR_RXCFG_RX_PROMISC     0x10
 133 #define VR_RXCFG_RX_THRESH      0xE0
 134
 135 #define VR_RXTHRESH_32BYTES     0x00
 136 #define VR_RXTHRESH_64BYTES     0x20
 137 #define VR_RXTHRESH_128BYTES    0x40
 138 #define VR_RXTHRESH_256BYTES    0x60
 139 #define VR_RXTHRESH_512BYTES    0x80
 140 #define VR_RXTHRESH_768BYTES    0xA0
 141 #define VR_RXTHRESH_1024BYTES   0xC0
 142 #define VR_RXTHRESH_STORENFWD   0xE0
 143
 144 /*
 145  * TX config bits.
 146  */
 147 #define VR_TXCFG_TXTAGEN        0x01    /* 6105M */
 148 #define VR_TXCFG_LOOPBKMODE     0x06
 149 #define VR_TXCFG_BACKOFF        0x08
 150 #define VR_TXCFG_RXTAGCTL       0x10    /* 6105M */
 151 #define VR_TXCFG_TX_THRESH      0xE0
 152
 153 #define VR_TXTHRESH_32BYTES     0x00
 154 #define VR_TXTHRESH_64BYTES     0x20
 155 #define VR_TXTHRESH_128BYTES    0x40
 156 #define VR_TXTHRESH_256BYTES    0x60
 157 #define VR_TXTHRESH_512BYTES    0x80
 158 #define VR_TXTHRESH_768BYTES    0xA0
 159 #define VR_TXTHRESH_1024BYTES   0xC0
 160 #define VR_TXTHRESH_STORENFWD   0xE0
 161 #define VR_TXTHRESH_MIN         1       /* 64 bytes */
 162 #define VR_TXTHRESH_MAX         5       /* store and forward */
 163
 164 /*
 165  * Command register bits.
 166  */
 167 #define VR_CR0_INIT             0x01
 168 #define VR_CR0_START            0x02
 169 #define VR_CR0_STOP             0x04
 170 #define VR_CR0_RX_ON            0x08
 171 #define VR_CR0_TX_ON            0x10
 172 #define VR_CR0_TX_GO            0x20
 173 #define VR_CR0_RX_GO            0x40
 174 #define VR_CR0_RSVD             0x80
 175 #define VR_CR1_RX_EARLY         0x01
 176 #define VR_CR1_TX_EARLY         0x02
 177 #define VR_CR1_FULLDUPLEX       0x04
 178 #define VR_CR1_TX_NOPOLL        0x08
 179
 180 #define VR_CR1_RESET            0x80
 181
 182 /*
 183  * Interrupt status bits.
 184  */
 185 #define VR_ISR_RX_OK            0x0001  /* packet rx ok */
 186 #define VR_ISR_TX_OK            0x0002  /* packet tx ok */
 187 #define VR_ISR_RX_ERR           0x0004  /* packet rx with err */
 188 #define VR_ISR_TX_ABRT          0x0008  /* tx aborted due to excess colls */
 189 #define VR_ISR_TX_UNDERRUN      0x0010  /* tx buffer underflow */
 190 #define VR_ISR_RX_NOBUF         0x0020  /* no rx buffer available */
 191 #define VR_ISR_BUSERR           0x0040  /* PCI bus error */
 192 #define VR_ISR_STATSOFLOW       0x0080  /* stats counter oflow */
 193 #define VR_ISR_RX_EARLY         0x0100  /* rx early */
 194 #define VR_ISR_LINKSTAT         0x0200  /* MII status change */
 195 #define VR_ISR_ETI              0x0200  /* Tx early (3043/3071) */
 196 #define VR_ISR_UDFI             0x0200  /* Tx FIFO underflow (6102) */
 197 #define VR_ISR_RX_OFLOW         0x0400  /* rx FIFO overflow */
 198 #define VR_ISR_RX_DROPPED       0x0800
 199 #define VR_ISR_RX_NOBUF2        0x1000  /* Rx descriptor running up */
 200 #define VR_ISR_TX_ABRT2         0x2000
 201 #define VR_ISR_LINKSTAT2        0x4000
 202 #define VR_ISR_MAGICPACKET      0x8000
 203
 204 #define VR_ISR_ERR_BITS         "\20"                                   \
 205                                 "\3RXERR\4TXABRT\5TXUNDERRUN"           \
 206                                 "\6RXNOBUF\7BUSERR\10STATSOFLOW"        \
 207                                 "\12TXUDF\13RXOFLOW\14RXDROPPED"        \
 208                                 "\15RXNOBUF2\16TXABRT2"
 209 /*
 210  * Interrupt mask bits.
 211  */
 212 #define VR_IMR_RX_OK            0x0001  /* packet rx ok */
 213 #define VR_IMR_TX_OK            0x0002  /* packet tx ok */
 214 #define VR_IMR_RX_ERR           0x0004  /* packet rx with err */
 215 #define VR_IMR_TX_ABRT          0x0008  /* tx aborted due to excess colls */
 216 #define VR_IMR_TX_UNDERRUN      0x0010  /* tx buffer underflow */
 217 #define VR_IMR_RX_NOBUF         0x0020  /* no rx buffer available */
 218 #define VR_IMR_BUSERR           0x0040  /* PCI bus error */
 219 #define VR_IMR_STATSOFLOW       0x0080  /* stats counter oflow */
 220 #define VR_IMR_RX_EARLY         0x0100  /* rx early */
 221 #define VR_IMR_LINKSTAT         0x0200  /* MII status change */
 222 #define VR_IMR_RX_OFLOW         0x0400  /* rx FIFO overflow */
 223 #define VR_IMR_RX_DROPPED       0x0800
 224 #define VR_IMR_RX_NOBUF2        0x1000
 225 #define VR_IMR_TX_ABRT2         0x2000
 226 #define VR_IMR_LINKSTAT2        0x4000
 227 #define VR_IMR_MAGICPACKET      0x8000
 228
 229 #define VR_INTRS                                                        \
 230         (VR_IMR_RX_OK|VR_IMR_TX_OK|VR_IMR_RX_NOBUF|                     \
 231         VR_IMR_TX_ABRT|VR_IMR_TX_UNDERRUN|VR_IMR_BUSERR|                \
 232         VR_IMR_RX_ERR|VR_ISR_RX_DROPPED)
 233
 234 /*
 235  * MII status register.
 236  */
 237
 238 #define VR_MIISTAT_SPEED        0x01
 239 #define VR_MIISTAT_LINKFAULT    0x02
 240 #define VR_MIISTAT_MGTREADERR   0x04
 241 #define VR_MIISTAT_MIIERR       0x08
 242 #define VR_MIISTAT_PHYOPT       0x10
 243 #define VR_MIISTAT_MDC_SPEED    0x20
 244 #define VR_MIISTAT_RSVD         0x40
 245 #define VR_MIISTAT_GPIO1POLL    0x80
 246
 247 /*
 248  * MII command register bits.
 249  */
 250 #define VR_MIICMD_CLK           0x01
 251 #define VR_MIICMD_DATAOUT       0x02
 252 #define VR_MIICMD_DATAIN        0x04
 253 #define VR_MIICMD_DIR           0x08
 254 #define VR_MIICMD_DIRECTPGM     0x10
 255 #define VR_MIICMD_WRITE_ENB     0x20
 256 #define VR_MIICMD_READ_ENB      0x40
 257 #define VR_MIICMD_AUTOPOLL      0x80
 258
 259 /*
 260  * EEPROM control bits.
 261  */
 262 #define VR_EECSR_DATAIN         0x01    /* data out */
 263 #define VR_EECSR_DATAOUT        0x02    /* data in */
 264 #define VR_EECSR_CLK            0x04    /* clock */
 265 #define VR_EECSR_CS             0x08    /* chip select */
 266 #define VR_EECSR_DPM            0x10
 267 #define VR_EECSR_LOAD           0x20
 268 #define VR_EECSR_EMBP           0x40
 269 #define VR_EECSR_EEPR           0x80
 270
 271 #define VR_EECMD_WRITE          0x140
 272 #define VR_EECMD_READ           0x180
 273 #define VR_EECMD_ERASE          0x1c0
 274
 275 /*
 276  * Test register bits.
 277  */
 278 #define VR_TEST_TEST0           0x01
 279 #define VR_TEST_TEST1           0x02
 280 #define VR_TEST_TEST2           0x04
 281 #define VR_TEST_TSTUD           0x08
 282 #define VR_TEST_TSTOV           0x10
 283 #define VR_TEST_BKOFF           0x20
 284 #define VR_TEST_FCOL            0x40
 285 #define VR_TEST_HBDES           0x80
 286
 287 /*
 288  * Config A register bits.
 289  */
 290 #define VR_CFG_GPIO2OUTENB      0x01
 291 #define VR_CFG_GPIO2OUT         0x02    /* gen. purp. pin */
 292 #define VR_CFG_GPIO2IN          0x04    /* gen. purp. pin */
 293 #define VR_CFG_AUTOOPT          0x08    /* enable rx/tx autopoll */
 294 #define VR_CFG_MIIOPT           0x10
 295 #define VR_CFG_MMIENB           0x20    /* memory mapped mode enb */
 296 #define VR_CFG_JUMPER           0x40    /* PHY and oper. mode select */
 297 #define VR_CFG_EELOAD           0x80    /* enable EEPROM programming */
 298
 299 /*
 300  * Config B register bits.
 301  */
 302 #define VR_CFG_LATMENB          0x01    /* larency timer effect enb. */
 303 #define VR_CFG_MRREADWAIT       0x02
 304 #define VR_CFG_MRWRITEWAIT      0x04
 305 #define VR_CFG_RX_ARB           0x08
 306 #define VR_CFG_TX_ARB           0x10
 307 #define VR_CFG_READMULTI        0x20
 308 #define VR_CFG_TX_PACE          0x40
 309 #define VR_CFG_TX_QDIS          0x80
 310
 311 /*
 312  * Config C register bits.
 313  */
 314 #define VR_CFG_ROMSEL0          0x01
 315 #define VR_CFG_ROMSEL1          0x02
 316 #define VR_CFG_ROMSEL2          0x04
 317 #define VR_CFG_ROMTIMESEL       0x08
 318 #define VR_CFG_RSVD0            0x10
 319 #define VR_CFG_ROMDLY           0x20
 320 #define VR_CFG_ROMOPT           0x40
 321 #define VR_CFG_RSVD1            0x80
 322
 323 /*
 324  * Config D register bits.
 325  */
 326 #define VR_CFG_BACKOFFOPT       0x01
 327 #define VR_CFG_BACKOFFMOD       0x02
 328 #define VR_CFG_CAPEFFECT        0x04
 329 #define VR_CFG_BACKOFFRAND      0x08
 330 #define VR_CFG_MAGICKPACKET     0x10
 331 #define VR_CFG_PCIREADLINE      0x20
 332 #define VR_CFG_DIAG             0x40
 333 #define VR_CFG_GPIOEN           0x80
 334
 335 /* Sticky HW bits */
 336 #define VR_STICKHW_DS0          0x01
 337 #define VR_STICKHW_DS1          0x02
 338 #define VR_STICKHW_WOL_ENB      0x04
 339 #define VR_STICKHW_WOL_STS      0x08
 340 #define VR_STICKHW_LEGWOL_ENB   0x80
 341
 342 /*
 343  * BCR0 register bits. (At least for the VT6102 chip.)
 344  */
 345 #define VR_BCR0_DMA_LENGTH      0x07
 346
 347 #define VR_BCR0_DMA_32BYTES     0x00
 348 #define VR_BCR0_DMA_64BYTES     0x01
 349 #define VR_BCR0_DMA_128BYTES    0x02
 350 #define VR_BCR0_DMA_256BYTES    0x03
 351 #define VR_BCR0_DMA_512BYTES    0x04
 352 #define VR_BCR0_DMA_1024BYTES   0x05
 353 #define VR_BCR0_DMA_STORENFWD   0x07
 354
 355 #define VR_BCR0_RX_THRESH       0x38
 356
 357 #define VR_BCR0_RXTHRESHCFG     0x00
 358 #define VR_BCR0_RXTHRESH64BYTES 0x08
 359 #define VR_BCR0_RXTHRESH128BYTES 0x10
 360 #define VR_BCR0_RXTHRESH256BYTES 0x18
 361 #define VR_BCR0_RXTHRESH512BYTES 0x20
 362 #define VR_BCR0_RXTHRESH1024BYTES 0x28
 363 #define VR_BCR0_RXTHRESHSTORENFWD 0x38
 364 #define VR_BCR0_EXTLED          0x40
 365 #define VR_BCR0_MED2            0x80
 366
 367 /*
 368  * BCR1 register bits. (At least for the VT6102 chip.)
 369  */
 370 #define VR_BCR1_POT0            0x01
 371 #define VR_BCR1_POT1            0x02
 372 #define VR_BCR1_POT2            0x04
 373 #define VR_BCR1_TX_THRESH       0x38
 374 #define VR_BCR1_TXTHRESHCFG     0x00
 375 #define VR_BCR1_TXTHRESH64BYTES 0x08
 376 #define VR_BCR1_TXTHRESH128BYTES 0x10
 377 #define VR_BCR1_TXTHRESH256BYTES 0x18
 378 #define VR_BCR1_TXTHRESH512BYTES 0x20
 379 #define VR_BCR1_TXTHRESH1024BYTES 0x28
 380 #define VR_BCR1_TXTHRESHSTORENFWD 0x38
 381 #define VR_BCR1_VLANFILT_ENB    0x80    /* VT6105M */
 382
 383 /*
 384  * CAMCTL register bits. (VT6105M only)
 385  */
 386 #define VR_CAMCTL_ENA           0x01
 387 #define VR_CAMCTL_VLAN          0x02
 388 #define VR_CAMCTL_MCAST         0x00
 389 #define VR_CAMCTL_WRITE         0x04
 390 #define VR_CAMCTL_READ          0x08
 391
 392 #define VR_CAM_MCAST_CNT        32
 393 #define VR_CAM_VLAN_CNT         32
 394
 395 /*
 396  * FLOWCR1 register bits. (VT6105LOM, VT6105M only)
 397  */
 398 #define VR_FLOWCR1_TXLO4        0x00
 399 #define VR_FLOWCR1_TXLO8        0x40
 400 #define VR_FLOWCR1_TXLO16       0x80
 401 #define VR_FLOWCR1_TXLO24       0xC0
 402 #define VR_FLOWCR1_TXHI24       0x00
 403 #define VR_FLOWCR1_TXHI32       0x10
 404 #define VR_FLOWCR1_TXHI48       0x20
 405 #define VR_FLOWCR1_TXHI64       0x30
 406 #define VR_FLOWCR1_XONXOFF      0x08
 407 #define VR_FLOWCR1_TXPAUSE      0x04
 408 #define VR_FLOWCR1_RXPAUSE      0x02
 409 #define VR_FLOWCR1_HDX          0x01
 410
 411 /*
 412  * WOLCR register bits. (VT6102 or higher only)
 413  */
 414 #define VR_WOLCR_PATTERN0       0x01
 415 #define VR_WOLCR_PATTERN1       0x02
 416 #define VR_WOLCR_PATTERN2       0x04
 417 #define VR_WOLCR_PATTERN3       0x08
 418 #define VR_WOLCR_UCAST          0x10
 419 #define VR_WOLCR_MAGIC          0x20
 420 #define VR_WOLCR_LINKON         0x40
 421 #define VR_WOLCR_LINKOFF        0x80
 422
 423 /*
 424  * PWRCFG register bits. (VT6102 or higher only)
 425  */
 426 #define VR_PWRCFG_WOLEN         0x01
 427 #define VR_PWRCFG_WOLSR         0x02
 428 #define VR_PWRCFG_LEGACY_WOL    0x10
 429 #define VR_PWRCFG_WOLTYPE_PULSE 0x20
 430 #define VR_PWRCFG_SMIITIME      0x80
 431
 432 /*
 433  * WOLCFG register bits. (VT6102 or higher only)
 434  */
 435 #define VR_WOLCFG_PATTERN_PAGE  0x04    /* VT6505 B0 */
 436 #define VR_WOLCFG_SMIIOPT       0x04
 437 #define VR_WOLCFG_SMIIACC       0x08
 438 #define VR_WOLCFG_SAB           0x10
 439 #define VR_WOLCFG_SAM           0x20
 440 #define VR_WOLCFG_SFDX          0x40
 441 #define VR_WOLCFG_PMEOVR        0x80
 442
 443 /*
 444  * Rhine TX/RX list structure.
 445  */
 446
 447 struct vr_desc {
 448         uint32_t                vr_status;
 449         uint32_t                vr_ctl;
 450         uint32_t                vr_data;
 451         uint32_t                vr_nextphys;
 452 };
 453
 454 #define VR_RXSTAT_RXERR         0x00000001
 455 #define VR_RXSTAT_CRCERR        0x00000002
 456 #define VR_RXSTAT_FRAMEALIGNERR 0x00000004
 457 #define VR_RXSTAT_FIFOOFLOW     0x00000008
 458 #define VR_RXSTAT_GIANT         0x00000010
 459 #define VR_RXSTAT_RUNT          0x00000020
 460 #define VR_RXSTAT_BUSERR        0x00000040
 461 #define VR_RXSTAT_FRAG          0x00000040      /* 6105M */
 462 #define VR_RXSTAT_BUFFERR       0x00000080
 463 #define VR_RXSTAT_LASTFRAG      0x00000100
 464 #define VR_RXSTAT_FIRSTFRAG     0x00000200
 465 #define VR_RXSTAT_RLINK         0x00000400
 466 #define VR_RXSTAT_RX_PHYS       0x00000800
 467 #define VR_RXSTAT_RX_BROAD      0x00001000
 468 #define VR_RXSTAT_RX_MULTI      0x00002000
 469 #define VR_RXSTAT_RX_VIDHIT     0x00004000      /* 6105M */
 470 #define VR_RXSTAT_RX_OK         0x00008000
 471 #define VR_RXSTAT_RXLEN         0x07FF0000
 472 #define VR_RXSTAT_RXLEN_EXT     0x78000000
 473 #define VR_RXSTAT_OWN           0x80000000
 474
 475 #define VR_RXBYTES(x)           ((x & VR_RXSTAT_RXLEN) >> 16)
 476 #define VR_RXSTAT_ERR_BITS      "\20"                           \
 477                                 "\1RXERR\2CRCERR\3FRAMEALIGN"   \
 478                                 "\4FIFOOFLOW\5GIANT\6RUNT"      \
 479                                 "\10BUFERR"
 480
 481 #define VR_RXCTL_BUFLEN         0x000007FF
 482 #define VR_RXCTL_BUFLEN_EXT     0x00007800
 483 #define VR_RXCTL_CHAIN          0x00008000
 484 #define VR_RXCTL_TAG            0x00010000
 485 #define VR_RXCTL_UDP            0x00020000
 486 #define VR_RXCTL_TCP            0x00040000
 487 #define VR_RXCTL_IP             0x00080000
 488 #define VR_RXCTL_TCPUDPOK       0x00100000
 489 #define VR_RXCTL_IPOK           0x00200000
 490 #define VR_RXCTL_SNAPTAG        0x00400000
 491 #define VR_RXCTL_RXLERR         0x00800000      /* 6105M */
 492 #define VR_RXCTL_RX_INTR        0x00800000
 493
 494
 495 #define VR_RXCTL (VR_RXCTL_CHAIN|VR_RXCTL_RX_INTR)
 496
 497 #define VR_TXSTAT_DEFER         0x00000001
 498 #define VR_TXSTAT_UNDERRUN      0x00000002
 499 #define VR_TXSTAT_COLLCNT       0x00000078
 500 #define VR_TXSTAT_SQE           0x00000080
 501 #define VR_TXSTAT_ABRT          0x00000100
 502 #define VR_TXSTAT_LATECOLL      0x00000200
 503 #define VR_TXSTAT_CARRLOST      0x00000400
 504 #define VR_TXSTAT_UDF           0x00000800
 505 #define VR_TXSTAT_TBUFF         0x00001000
 506 #define VR_TXSTAT_BUSERR        0x00002000
 507 #define VR_TXSTAT_JABTIMEO      0x00004000
 508 #define VR_TXSTAT_ERRSUM        0x00008000
 509 #define VR_TXSTAT_OWN           0x80000000
 510
 511 #define VR_TXCTL_BUFLEN         0x000007FF
 512 #define VR_TXCTL_BUFLEN_EXT     0x00007800
 513 #define VR_TXCTL_TLINK          0x00008000
 514 #define VR_TXCTL_NOCRC          0x00010000
 515 #define VR_TXCTL_INSERTTAG      0x00020000
 516 #define VR_TXCTL_IPCSUM         0x00040000
 517 #define VR_TXCTL_UDPCSUM        0x00080000
 518 #define VR_TXCTL_TCPCSUM        0x00100000
 519 #define VR_TXCTL_FIRSTFRAG      0x00200000
 520 #define VR_TXCTL_LASTFRAG       0x00400000
 521 #define VR_TXCTL_FINT           0x00800000
 522
 523 #define VR_MIN_FRAMELEN         60
 524
 525 #define VR_FLAG_FORCEDELAY      1
 526 #define VR_FLAG_SCHEDDELAY      2
 527 #define VR_FLAG_DELAYTIMEO      3
 528
 529
 530 #define VR_TIMEOUT              1000
 531 #define VR_MII_TIMEOUT          10000
 532
 533 #define VR_PHYADDR_MASK         0x1f
 534
 535 /*
 536  * General constants that are fun to know.
 537  *
 538  * VIA vendor ID
 539  */
 540 #define VIA_VENDORID                    0x1106
 541
 542 /*
 543  * VIA Rhine device IDs.
 544  */
 545 #define VIA_DEVICEID_RHINE              0x3043
 546 #define VIA_DEVICEID_RHINE_II           0x6100
 547 #define VIA_DEVICEID_RHINE_II_2         0x3065
 548 #define VIA_DEVICEID_RHINE_III          0x3106
 549 #define VIA_DEVICEID_RHINE_III_M        0x3053
 550
 551 /*
 552  * Delta Electronics device ID.
 553  */
 554 #define DELTA_VENDORID                  0x1500
 555
 556 /*
 557  * Delta device IDs.
 558  */
 559 #define DELTA_DEVICEID_RHINE_II         0x1320
 560
 561 /*
 562  * Addtron vendor ID.
 563  */
 564 #define ADDTRON_VENDORID                0x4033
 565
 566 /*
 567  * Addtron device IDs.
 568  */
 569 #define ADDTRON_DEVICEID_RHINE_II       0x1320
 570
 571 /*
 572  * VIA Rhine revision IDs
 573  */
 574
 575 #define REV_ID_VT3043_E                 0x04
 576 #define REV_ID_VT3071_A                 0x20
 577 #define REV_ID_VT3071_B                 0x21
 578 #define REV_ID_VT6102_A                 0x40
 579 #define REV_ID_VT6102_B                 0x41
 580 #define REV_ID_VT6102_C                 0x42
 581 #define REV_ID_VT6102_APOLLO            0x74
 582 #define REV_ID_VT6105_A0                0x80
 583 #define REV_ID_VT6105_B0                0x83
 584 #define REV_ID_VT6105_LOM               0x8A
 585 #define REV_ID_VT6107_A0                0x8C
 586 #define REV_ID_VT6107_A1                0x8D
 587 #define REV_ID_VT6105M_A0               0x90
 588 #define REV_ID_VT6105M_B1               0x94
 589
 590 /*
 591  * PCI low memory base and low I/O base register, and
 592  * other PCI registers.
 593  */
 594
 595 #define VR_PCI_VENDOR_ID        0x00
 596 #define VR_PCI_DEVICE_ID        0x02
 597 #define VR_PCI_COMMAND          0x04
 598 #define VR_PCI_STATUS           0x06
 599 #define VR_PCI_REVID            0x08
 600 #define VR_PCI_CLASSCODE        0x09
 601 #define VR_PCI_LATENCY_TIMER    0x0D
 602 #define VR_PCI_HEADER_TYPE      0x0E
 603 #define VR_PCI_LOIO             0x10
 604 #define VR_PCI_LOMEM            0x14
 605 #define VR_PCI_BIOSROM          0x30
 606 #define VR_PCI_INTLINE          0x3C
 607 #define VR_PCI_INTPIN           0x3D
 608 #define VR_PCI_MINGNT           0x3E
 609 #define VR_PCI_MINLAT           0x0F
 610 #define VR_PCI_RESETOPT         0x48
 611 #define VR_PCI_EEPROM_DATA      0x4C
 612 #define VR_PCI_MODE0            0x50
 613 #define VR_PCI_MODE2            0x52
 614 #define VR_PCI_MODE3            0x53
 615
 616 #define VR_MODE2_PCEROPT        0x80 /* VT6102 only */
 617 #define VR_MODE2_DISABT         0x40
 618 #define VR_MODE2_MRDPL          0x08 /* VT6107A1 and above */
 619 #define VR_MODE2_MODE10T        0x02
 620
 621 #define VR_MODE3_XONOPT         0x80
 622 #define VR_MODE3_TPACEN         0x40
 623 #define VR_MODE3_BACKOPT        0x20
 624 #define VR_MODE3_DLTSEL         0x10
 625 #define VR_MODE3_MIIDMY         0x08
 626 #define VR_MODE3_MIION          0x04
 627
 628 /* power management registers */
 629 #define VR_PCI_CAPID            0xDC /* 8 bits */
 630 #define VR_PCI_NEXTPTR          0xDD /* 8 bits */
 631 #define VR_PCI_PWRMGMTCAP       0xDE /* 16 bits */
 632 #define VR_PCI_PWRMGMTCTRL      0xE0 /* 16 bits */
 633
 634 #define VR_PSTATE_MASK          0x0003
 635 #define VR_PSTATE_D0            0x0000
 636 #define VR_PSTATE_D1            0x0002
 637 #define VR_PSTATE_D2            0x0002
 638 #define VR_PSTATE_D3            0x0003
 639 #define VR_PME_EN               0x0010
 640 #define VR_PME_STATUS           0x8000
 641
 642 #define VR_RX_RING_CNT          128
 643 #define VR_TX_RING_CNT          128
 644 #define VR_TX_RING_SIZE         sizeof(struct vr_desc) * VR_TX_RING_CNT
 645 #define VR_RX_RING_SIZE         sizeof(struct vr_desc) * VR_RX_RING_CNT
 646 #define VR_RING_ALIGN           sizeof(struct vr_desc)
 647 #define VR_RX_ALIGN             sizeof(uint32_t)
 648 #define VR_MAXFRAGS             8
 649 #define VR_TX_INTR_THRESH       8
 650
 651 #define VR_ADDR_LO(x)           ((uint64_t)(x) & 0xffffffff)
 652 #define VR_ADDR_HI(x)           ((uint64_t)(x) >> 32)
 653 #define VR_TX_RING_ADDR(sc, i)  \
 654     ((sc)->vr_rdata.vr_tx_ring_paddr + sizeof(struct vr_desc) * (i))
 655 #define VR_RX_RING_ADDR(sc, i)  \
 656     ((sc)->vr_rdata.vr_rx_ring_paddr + sizeof(struct vr_desc) * (i))
 657 #define VR_INC(x,y)             (x) = (((x) + 1) % y)
 658
 659 struct vr_txdesc {
 660         struct mbuf     *tx_m;
 661         bus_dmamap_t    tx_dmamap;
 662 };
 663
 664 struct vr_rxdesc {
 665         struct mbuf     *rx_m;
 666         bus_dmamap_t    rx_dmamap;
 667         struct vr_desc  *desc;
 668 };
 669
 670 struct vr_chain_data {
 671         bus_dma_tag_t           vr_parent_tag;
 672         bus_dma_tag_t           vr_tx_tag;
 673         struct vr_txdesc        vr_txdesc[VR_TX_RING_CNT];
 674         bus_dma_tag_t           vr_rx_tag;
 675         struct vr_rxdesc        vr_rxdesc[VR_RX_RING_CNT];
 676         bus_dma_tag_t           vr_tx_ring_tag;
 677         bus_dma_tag_t           vr_rx_ring_tag;
 678         bus_dmamap_t            vr_tx_ring_map;
 679         bus_dmamap_t            vr_rx_ring_map;
 680         bus_dmamap_t            vr_rx_sparemap;
 681         int                     vr_tx_pkts;
 682         int                     vr_tx_prod;
 683         int                     vr_tx_cons;
 684         int                     vr_tx_cnt;
 685         int                     vr_rx_cons;
 686 };
 687
 688 struct vr_ring_data {
 689         struct vr_desc          *vr_rx_ring;
 690         struct vr_desc          *vr_tx_ring;
 691         bus_addr_t              vr_rx_ring_paddr;
 692         bus_addr_t              vr_tx_ring_paddr;
 693 };
 694
 695 struct vr_statistics {
 696         uint64_t                tx_ok;
 697         uint64_t                rx_ok;
 698         uint32_t                tx_errors;
 699         uint32_t                rx_errors;
 700         uint32_t                rx_no_buffers;
 701         uint32_t                rx_no_mbufs;
 702         uint32_t                rx_crc_errors;
 703         uint32_t                rx_alignment;
 704         uint32_t                rx_fifo_overflows;
 705         uint32_t                rx_giants;
 706         uint32_t                rx_runts;
 707         uint32_t                tx_abort;
 708         uint32_t                tx_collisions;
 709         uint32_t                tx_late_collisions;
 710         uint32_t                tx_underrun;
 711         uint32_t                bus_errors;
 712         uint32_t                num_restart;
 713 };
 714
 715 struct vr_softc {
 716         struct ifnet            *vr_ifp;        /* interface info */
 717         device_t                vr_dev;
 718         struct resource         *vr_res;
 719         int                     vr_res_id;
 720         int                     vr_res_type;
 721         struct resource         *vr_irq;
 722         void                    *vr_intrhand;
 723         device_t                vr_miibus;
 724         uint8_t                 vr_revid;       /* Rhine chip revision */
 725         int                     vr_flags;       /* See VR_F_* below */
 726 #define VR_F_RESTART            0x0001          /* Restart unit on next tick */
 727 #define VR_F_TXPAUSE            0x0010
 728 #define VR_F_SUSPENDED          0x2000
 729 #define VR_F_DETACHED           0x4000
 730 #define VR_F_LINK               0x8000
 731         int                     vr_if_flags;
 732         struct vr_chain_data    vr_cdata;
 733         struct vr_ring_data     vr_rdata;
 734         struct vr_statistics    vr_stat;
 735         struct callout          vr_stat_callout;
 736         struct mtx              vr_mtx;
 737         int                     vr_quirks;
 738         int                     vr_watchdog_timer;
 739         int                     vr_txthresh;
 740 #ifdef DEVICE_POLLING
 741         int                     rxcycles;
 742 #endif
 743         struct task             vr_inttask;
 744 };
 745
 746 #define VR_LOCK(_sc)            mtx_lock(&(_sc)->vr_mtx)
 747 #define VR_UNLOCK(_sc)          mtx_unlock(&(_sc)->vr_mtx)
 748 #define VR_LOCK_ASSERT(_sc)     mtx_assert(&(_sc)->vr_mtx, MA_OWNED)
 749
 750 /*
 751  * register space access macros
 752  */
 753 #define CSR_WRITE_4(sc, reg, val)       bus_write_4(sc->vr_res, reg, val)
 754 #define CSR_WRITE_2(sc, reg, val)       bus_write_2(sc->vr_res, reg, val)
 755 #define CSR_WRITE_1(sc, reg, val)       bus_write_1(sc->vr_res, reg, val)
 756
 757 #define CSR_READ_2(sc, reg)             bus_read_2(sc->vr_res, reg)
 758 #define CSR_READ_1(sc, reg)             bus_read_1(sc->vr_res, reg)
 759
 760 #define VR_SETBIT(sc, reg, x) CSR_WRITE_1(sc, reg, CSR_READ_1(sc, reg) | (x))
 761 #define VR_CLRBIT(sc, reg, x) CSR_WRITE_1(sc, reg, CSR_READ_1(sc, reg) & ~(x))
 762
 763 #define VR_SETBIT16(sc, reg, x) CSR_WRITE_2(sc, reg, CSR_READ_2(sc, reg) | (x))
 764 #define VR_CLRBIT16(sc, reg, x) CSR_WRITE_2(sc, reg, CSR_READ_2(sc, reg) & ~(x))
 765
 766 #define VR_MCAST_CAM    0
 767 #define VR_VLAN_CAM     1