xref: /openbsd/share/man/man4/vr.4 (revision db3296cf)
1.\"	$OpenBSD: vr.4,v 1.13 2003/04/11 04:32:28 jmc Exp $
2.\"
3.\" Copyright (c) 1997, 1998
4.\"	Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by Bill Paul.
17.\" 4. Neither the name of the author nor the names of any co-contributors
18.\"    may be used to endorse or promote products derived from this software
19.\"   without specific prior written permission.
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
22.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24.\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
25.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
31.\" THE POSSIBILITY OF SUCH DAMAGE.
32.\"
33.\"	$FreeBSD: vr.4,v 1.3 1999/03/25 00:52:44 wpaul Exp $
34.\"
35.Dd November 22, 1998
36.Dt VR 4
37.Os
38.Sh NAME
39.Nm vr
40.Nd VIA Technologies VT3043 and VT86C100A Ethernet driver
41.Sh SYNOPSIS
42.Cd "vr* at pci? dev ? function ?"
43.Sh DESCRIPTION
44The
45.Nm
46driver provides support for PCI Ethernet adapters and embedded
47controllers based on the VIA Technologies VT3043 Rhine I,
48VT86C100A Rhine II, and VT6105 Rhine III Fast Ethernet controller chips.
49This includes the D-Link DFE530-TX and various other commodity Fast Ethernet
50cards.
51.Pp
52The VIA Rhine chips use bus master DMA and have a software interface
53designed to resemble that of the DEC 21x4x "tulip" chips.
54The major differences are that the receive filter in the Rhine chips is
55much simpler and is programmed through registers rather than by
56downloading a special setup frame through the transmit DMA engine,
57and that transmit and receive DMA buffers must be longword aligned.
58The Rhine chips are meant to be interfaced with external
59physical layer devices via an MII bus.
60They support both 10 and 100Mbps speeds in either full or half duplex.
61.Pp
62The
63.Nm
64driver supports the following media types:
65.Pp
66.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
67.It autoselect
68Enable autoselection of the media type and options.
69The user can manually override
70the autoselected mode by adding media options to the appropriate
71.Xr hostname.if 5
72file.
73.It 10baseT
74Set 10Mbps operation.
75The
76.Ar mediaopt
77option can also be used to select either
78.Ar full-duplex
79or
80.Ar half-duplex
81modes.
82.It 100baseTX
83Set 100Mbps (Fast Ethernet) operation.
84The
85.Ar mediaopt
86option can also be used to select either
87.Ar full-duplex
88or
89.Ar half-duplex
90modes.
91.El
92.Pp
93The
94.Nm
95driver supports the following media options:
96.Pp
97.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
98.It full-duplex
99Force full duplex operation.
100.It half-duplex
101Force half duplex operation.
102.El
103.Pp
104Note that the 100baseTX media type is only available if supported
105by the adapter.
106For more information on configuring this device, see
107.Xr ifconfig 8 .
108.Sh DIAGNOSTICS
109.Bl -diag
110.It "vr%d: couldn't map memory"
111A fatal initialization error has occurred.
112.It "vr%d: couldn't map interrupt"
113A fatal initialization error has occurred.
114.It "vr%d: watchdog timeout"
115The device has stopped responding to the network, or there is a problem with
116the network connection (cable).
117.It "vr%d: no memory for rx list"
118The driver failed to allocate an mbuf for the receiver ring.
119.It "vr%d: no memory for tx list"
120The driver failed to allocate an mbuf for the transmitter ring when
121allocating a pad buffer or collapsing an mbuf chain into a cluster.
122.It "vr%d: chip is in D3 power state -- setting to D0"
123This message applies only to adapters which support power management.
124Some operating systems place the controller in low power
125mode when shutting down, and some PCI BIOSes fail to bring the chip
126out of this state before configuring it.
127The controller loses all of its PCI configuration in the D3 state, so if the
128BIOS does not set it back to full power mode in time, it won't be able to
129configure it correctly.
130The driver tries to detect this condition and bring
131the adapter back to the D0 (full power) state, but this may not be
132enough to return the driver to a fully operational condition.
133If this message appears at boot time and the driver fails to attach
134the device as a network interface, a second warm boot will have to be
135performed to have the device properly configured.
136.Pp
137Note that this condition only occurs when warm booting from another
138operating system.
139If the system is powered down prior to booting
140.Ox ,
141the card should be configured correctly.
142.El
143.Sh SEE ALSO
144.Xr arp 4 ,
145.Xr ifmedia 4 ,
146.Xr intro 4 ,
147.Xr netintro 4 ,
148.Xr pci 4 ,
149.Xr hostname.if 5 ,
150.Xr ifconfig 8
151.Rs
152.%T The VIA Technologies VT86C100A data sheet
153.%O http://www.via.com.tw
154.Re
155.Sh HISTORY
156The
157.Nm
158device driver first appeared in
159.Fx 3.0 .
160.Ox
161support first appeared in
162.Ox 2.5 .
163.Sh AUTHORS
164The
165.Nm
166driver was written by
167.An Bill Paul Aq wpaul@ctr.columbia.edu .
168.Sh BUGS
169The
170.Nm
171driver always copies transmit mbuf chains into longword-aligned
172buffers prior to transmission in order to pacify the Rhine chips.
173If buffers are not aligned correctly, the chip will round the
174supplied buffer address and begin DMAing from the wrong location.
175This buffer copying impairs transmit performance on slower systems but can't
176be avoided.
177On faster machines (e.g., a Pentium II), the performance
178impact is much less noticeable.
179