share/man/man4/vr.4

   1 .\" Copyright (c) 1997, 1998
   2 .\"     Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by Bill Paul.
  15 .\" 4. Neither the name of the author nor the names of any co-contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"   without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  23 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  29 .\" THE POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd February 7, 2010
  34 .Dt VR 4
  35 .Os
  36 .Sh NAME
  37 .Nm vr
  38 .Nd "VIA Technologies Rhine I/II/III Ethernet device driver"
  39 .Sh SYNOPSIS
  40 To compile this driver into the kernel,
  41 place the following lines in your
  42 kernel configuration file:
  43 .Bd -ragged -offset indent
  44 .Cd "device miibus"
  45 .Cd "device vr"
  46 .Ed
  47 .Pp
  48 Alternatively, to load the driver as a
  49 module at boot time, place the following line in
  50 .Xr loader.conf 5 :
  51 .Bd -literal -offset indent
  52 if_vr_load="YES"
  53 .Ed
  54 .Sh DESCRIPTION
  55 The
  56 .Nm
  57 driver provides support for PCI Ethernet adapters and embedded
  58 controllers based on the VIA Technologies VT3043 Rhine I,
  59 VT86C100A Rhine II, and VT6105/VT6105M Rhine III Fast Ethernet
  60 controller chips.
  61 .Pp
  62 The VIA Rhine chips use bus master DMA and have a descriptor layout
  63 designed to resemble that of the DEC 21x4x
  64 .Dq tulip
  65 chips.
  66 The register
  67 layout is different however and the receive filter in the Rhine chips
  68 is much simpler and is programmed through registers rather than by
  69 downloading a special setup frame through the transmit DMA engine.
  70 Transmit and receive DMA buffers must be longword
  71 aligned.
  72 The Rhine chips are meant to be interfaced with external
  73 physical layer devices via an MII bus.
  74 They support both
  75 10 and 100Mbps speeds in either full or half duplex.
  76 .Pp
  77 The
  78 .Nm
  79 driver supports the following media types:
  80 .Pp
  81 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  82 .It autoselect
  83 Enable autoselection of the media type and options.
  84 The user can manually override
  85 the autoselected mode by adding media options to the
  86 .Pa /etc/rc.conf
  87 file.
  88 .It 10baseT/UTP
  89 Set 10Mbps operation.
  90 The
  91 .Ar mediaopt
  92 option can also be used to select either
  93 .Ar full-duplex
  94 or
  95 .Ar half-duplex
  96 modes.
  97 .It 100baseTX
  98 Set 100Mbps (Fast Fthernet) operation.
  99 The
 100 .Ar mediaopt
 101 option can also be used to select either
 102 .Ar full-duplex
 103 or
 104 .Ar half-duplex
 105 modes.
 106 .El
 107 .Pp
 108 The
 109 .Nm
 110 driver supports the following media options:
 111 .Pp
 112 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 113 .It full-duplex
 114 Force full duplex operation
 115 .It half-duplex
 116 Force half duplex operation.
 117 .El
 118 .Pp
 119 Note that the 100baseTX media type is only available if supported
 120 by the adapter.
 121 For more information on configuring this device, see
 122 .Xr ifconfig 8 .
 123 .Sh HARDWARE
 124 The
 125 .Nm
 126 driver supports VIA Technologies Rhine I, Rhine II, and Rhine III based
 127 Fast Ethernet adapters including:
 128 .Pp
 129 .Bl -bullet -compact
 130 .It
 131 AOpen/Acer ALN-320
 132 .It
 133 D-Link DFE520-TX
 134 .It
 135 D-Link DFE530-TX
 136 .It
 137 Hawking Technologies PN102TX
 138 .It
 139 Soekris Engineering net5501
 140 .El
 141 .Sh SYSCTL VARIABLES
 142 The following variables are available as
 143 .Xr sysctl 8
 144 variables:
 145 .Bl -tag -width indent
 146 .It Va dev.vr.%d.stats
 147 Display lots of useful MAC counters maintained in the driver.
 148 .El
 149 .Sh DIAGNOSTICS
 150 .Bl -diag
 151 .It "vr%d: couldn't map memory"
 152 A fatal initialization error has occurred.
 153 .It "vr%d: couldn't map interrupt"
 154 A fatal initialization error has occurred.
 155 .It "vr%d: watchdog timeout"
 156 The device has stopped responding to the network, or there is a problem with
 157 the network connection (cable).
 158 .It "vr%d: no memory for rx list"
 159 The driver failed to allocate an mbuf for the receiver ring.
 160 .It "vr%d: no memory for tx list"
 161 The driver failed to allocate an mbuf for the transmitter ring when
 162 allocating a pad buffer or collapsing an mbuf chain into a cluster.
 163 .It "vr%d: chip is in D3 power state -- setting to D0"
 164 This message applies only to adapters which support power
 165 management.
 166 Some operating systems place the controller in low power
 167 mode when shutting down, and some PCI BIOSes fail to bring the chip
 168 out of this state before configuring it.
 169 The controller loses all of
 170 its PCI configuration in the D3 state, so if the BIOS does not set
 171 it back to full power mode in time, it will not be able to configure it
 172 correctly.
 173 The driver tries to detect this condition and bring
 174 the adapter back to the D0 (full power) state, but this may not be
 175 enough to return the driver to a fully operational condition.
 176 If
 177 you see this message at boot time and the driver fails to attach
 178 the device as a network interface, you will have to perform second
 179 warm boot to have the device properly configured.
 180 .Pp
 181 Note that this condition only occurs when warm booting from another
 182 operating system.
 183 If you power down your system prior to booting
 184 .Fx ,
 185 the card should be configured correctly.
 186 .El
 187 .Sh SEE ALSO
 188 .Xr altq 4 ,
 189 .Xr arp 4 ,
 190 .Xr miibus 4 ,
 191 .Xr netintro 4 ,
 192 .Xr ng_ether 4 ,
 193 .Xr polling 4 ,
 194 .Xr ifconfig 8
 195 .Rs
 196 .%T The VIA Technologies VT86C100A data sheet
 197 .%O http://www.via.com.tw
 198 .Re
 199 .Sh HISTORY
 200 The
 201 .Nm
 202 device driver first appeared in
 203 .Fx 3.0 .
 204 .Sh AUTHORS
 205 The
 206 .Nm
 207 driver was written by
 208 .An Bill Paul Aq wpaul@ctr.columbia.edu .
 209 .Sh BUGS
 210 The
 211 .Nm
 212 driver always copies transmit mbuf chains into longword-aligned
 213 buffers prior to transmission in order to pacify the Rhine chips.
 214 If buffers are not aligned correctly, the chip will round the
 215 supplied buffer address and begin DMAing from the wrong location.
 216 This buffer copying impairs transmit performance on slower systems but cannot
 217 be avoided.
 218 On faster machines (e.g.\& a Pentium II), the performance
 219 impact is much less noticeable.