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