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