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: src/share/man/man4/vr.4,v 1.11.2.5 2003/02/17 21:20:39 trhodes Exp $
  32 .\" $DragonFly: src/share/man/man4/vr.4,v 1.8 2008/07/11 10:38:50 thomas Exp $
  33 .\"
  34 .Dd November 22, 1998
  35 .Dt VR 4
  36 .Os
  37 .Sh NAME
  38 .Nm vr
  39 .Nd "VIA Technologies VT3043 and VT86C100A ethernet device driver"
  40 .Sh SYNOPSIS
  41 .Cd "device miibus"
  42 .Cd "device vr"
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 driver provides support for PCI ethernet adapters and embedded
  47 controllers based on the VIA Technologies VT3043 Rhine I and
  48 VT86C100A Rhine II fast ethernet controller chips.
  49 This includes
  50 the D-Link DFE530-TX, the Hawking Technologies PN102TX, the
  51 AOpen/Acer ALN-320, and various other commodity fast ethernet
  52 cards.
  53 .Pp
  54 The VIA Rhine chips use bus master DMA and have a descriptor layout
  55 designed to resemble that of the DEC 21x4x "tulip" chips.
  56 The register
  57 layout is different however and the receive filter in the Rhine chips
  58 is much simpler and is programmed through registers rather than by
  59 downloading a special setup frame through the transmit DMA engine.
  60 Transmit and receive DMA buffers must be longword
  61 aligned.
  62 The Rhine chips are meant to be interfaced with external
  63 physical layer devices via an MII bus.
  64 They support both
  65 10 and 100Mbps speeds in either full or half duplex.
  66 .Pp
  67 The
  68 .Nm
  69 driver supports the following media types:
  70 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  71 .It autoselect
  72 Enable autoselection of the media type and options.
  73 The user can manually override
  74 the autoselected mode by adding media options to the
  75 .Pa /etc/rc.conf
  76 file.
  77 .It 10baseT/UTP
  78 Set 10Mbps operation.
  79 The
  80 .Ar mediaopt
  81 option can also be used to select either
  82 .Ar full-duplex
  83 or
  84 .Ar half-duplex
  85 modes.
  86 .It 100baseTX
  87 Set 100Mbps (fast ethernet) operation.
  88 The
  89 .Ar mediaopt
  90 option can also be used to select either
  91 .Ar full-duplex
  92 or
  93 .Ar half-duplex
  94 modes.
  95 .El
  96 .Pp
  97 The
  98 .Nm
  99 driver supports the following media options:
 100 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 101 .It full-duplex
 102 Force full duplex operation
 103 .It half-duplex
 104 Force half duplex operation.
 105 .El
 106 .Pp
 107 Note that the 100baseTX media type is only available if supported
 108 by the adapter.
 109 .Pp
 110 For more information on configuring this device, see
 111 .Xr ifconfig 8 .
 112 The
 113 .Nm
 114 driver supports
 115 .Xr polling 4 .
 116 .Sh DIAGNOSTICS
 117 .Bl -diag
 118 .It "vr%d: couldn't map memory"
 119 A fatal initialization error has occurred.
 120 .It "vr%d: couldn't map interrupt"
 121 A fatal initialization error has occurred.
 122 .It "vr%d: watchdog timeout"
 123 The device has stopped responding to the network, or there is a problem with
 124 the network connection (cable).
 125 .It "vr%d: no memory for rx list"
 126 The driver failed to allocate an mbuf for the receiver ring.
 127 .It "vr%d: no memory for tx list"
 128 The driver failed to allocate an mbuf for the transmitter ring when
 129 allocating a pad buffer or collapsing an mbuf chain into a cluster.
 130 .It "vr%d: chip is in D3 power state -- setting to D0"
 131 This message applies only to adapters which support power
 132 management.
 133 Some operating systems place the controller in low power
 134 mode when shutting down, and some PCI BIOSes fail to bring the chip
 135 out of this state before configuring it.
 136 The controller loses all of
 137 its PCI configuration in the D3 state, so if the BIOS does not set
 138 it back to full power mode in time, it won't be able to configure it
 139 correctly.
 140 The driver tries to detect this condition and bring
 141 the adapter back to the D0 (full power) state, but this may not be
 142 enough to return the driver to a fully operational condition.
 143 If
 144 you see this message at boot time and the driver fails to attach
 145 the device as a network interface, you will have to perform second
 146 warm boot to have the device properly configured.
 147 .Pp
 148 Note that this condition only occurs when warm booting from another
 149 operating system.
 150 If you power down your system prior to booting
 151 .Dx ,
 152 the card should be configured correctly.
 153 .El
 154 .Sh SEE ALSO
 155 .Xr arp 4 ,
 156 .Xr ifmedia 4 ,
 157 .Xr miibus 4 ,
 158 .Xr netintro 4 ,
 159 .Xr ng_ether 4 ,
 160 .Xr polling 4 ,
 161 .Xr ifconfig 8
 162 .Rs
 163 .%T The VIA Technologies VT86C100A data sheet
 164 .%O http://www.via.com.tw
 165 .Re
 166 .Sh HISTORY
 167 The
 168 .Nm
 169 device driver first appeared in
 170 .Fx 3.0 .
 171 .Sh AUTHORS
 172 The
 173 .Nm
 174 driver was written by
 175 .An Bill Paul Aq wpaul@ctr.columbia.edu .
 176 .Sh BUGS
 177 The
 178 .Nm
 179 driver always copies transmit mbuf chains into longword-aligned
 180 buffers prior to transmission in order to pacify the Rhine chips.
 181 If buffers are not aligned correctly, the chip will round the
 182 supplied buffer address and begin DMAing from the wrong location.
 183 This buffer copying impairs transmit performance on slower systems but can't
 184 be avoided.
 185 On faster machines (e.g. a Pentium II), the performance
 186 impact is much less noticeable.