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