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.3 2004/03/11 12:28:55 hmp 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 .Pp
  71 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  72 .It autoselect
  73 Enable autoselection of the media type and options.
  74 The user can manually override
  75 the autoselected mode by adding media options to the
  76 .Pa /etc/rc.conf
  77 file.
  78 .It 10baseT/UTP
  79 Set 10Mbps operation.
  80 The
  81 .Ar mediaopt
  82 option can also be used to select either
  83 .Ar full-duplex
  84 or
  85 .Ar half-duplex
  86 modes.
  87 .It 100baseTX
  88 Set 100Mbps (fast ethernet) operation.
  89 The
  90 .Ar mediaopt
  91 option can also be used to select either
  92 .Ar full-duplex
  93 or
  94 .Ar half-duplex
  95 modes.
  96 .El
  97 .Pp
  98 The
  99 .Nm
 100 driver supports the following media options:
 101 .Pp
 102 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 103 .It full-duplex
 104 Force full duplex operation
 105 .It half-duplex
 106 Force half duplex operation.
 107 .El
 108 .Pp
 109 Note that the 100baseTX media type is only available if supported
 110 by the adapter.
 111 For more information on configuring this device, see
 112 .Xr ifconfig 8 .
 113 .Sh DIAGNOSTICS
 114 .Bl -diag
 115 .It "vr%d: couldn't map memory"
 116 A fatal initialization error has occurred.
 117 .It "vr%d: couldn't map interrupt"
 118 A fatal initialization error has occurred.
 119 .It "vr%d: watchdog timeout"
 120 The device has stopped responding to the network, or there is a problem with
 121 the network connection (cable).
 122 .It "vr%d: no memory for rx list"
 123 The driver failed to allocate an mbuf for the receiver ring.
 124 .It "vr%d: no memory for tx list"
 125 The driver failed to allocate an mbuf for the transmitter ring when
 126 allocating a pad buffer or collapsing an mbuf chain into a cluster.
 127 .It "vr%d: chip is in D3 power state -- setting to D0"
 128 This message applies only to adapters which support power
 129 management.
 130 Some operating systems place the controller in low power
 131 mode when shutting down, and some PCI BIOSes fail to bring the chip
 132 out of this state before configuring it.
 133 The controller loses all of
 134 its PCI configuration in the D3 state, so if the BIOS does not set
 135 it back to full power mode in time, it won't be able to configure it
 136 correctly.
 137 The driver tries to detect this condition and bring
 138 the adapter back to the D0 (full power) state, but this may not be
 139 enough to return the driver to a fully operational condition.
 140 If
 141 you see this message at boot time and the driver fails to attach
 142 the device as a network interface, you will have to perform second
 143 warm boot to have the device properly configured.
 144 .Pp
 145 Note that this condition only occurs when warm booting from another
 146 operating system.
 147 If you power down your system prior to booting
 148 .Dx ,
 149 the card should be configured correctly.
 150 .El
 151 .Sh SEE ALSO
 152 .Xr arp 4 ,
 153 .Xr miibus 4 ,
 154 .Xr netintro 4 ,
 155 .Xr ng_ether 4 ,
 156 .Xr ifconfig 8
 157 .Rs
 158 .%T The VIA Technologies VT86C100A data sheet
 159 .%O http://www.via.com.tw
 160 .Re
 161 .Sh HISTORY
 162 The
 163 .Nm
 164 device driver first appeared in
 165 .Fx 3.0 .
 166 .Sh AUTHORS
 167 The
 168 .Nm
 169 driver was written by
 170 .An Bill Paul Aq wpaul@ctr.columbia.edu .
 171 .Sh BUGS
 172 The
 173 .Nm
 174 driver always copies transmit mbuf chains into longword-aligned
 175 buffers prior to transmission in order to pacify the Rhine chips.
 176 If buffers are not aligned correctly, the chip will round the
 177 supplied buffer address and begin DMAing from the wrong location.
 178 This buffer copying impairs transmit performance on slower systems but can't
 179 be avoided.
 180 On faster machines (e.g. a Pentium II), the performance
 181 impact is much less noticable.