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