xref: /openbsd-src/share/man/man4/wb.4 (revision d13be5d47e4149db2549a9828e244d59dbc43f15)
1.\"	$OpenBSD: wb.4,v 1.18 2008/05/08 03:30:17 brad 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: wb.4,v 1.2 1998/12/05 09:31:25 rnordier Exp $
34.\"
35.Dd $Mdocdate: May 8 2008 $
36.Dt WB 4
37.Os
38.Sh NAME
39.Nm wb
40.Nd Winbond W89C840F 10/100 Ethernet device
41.Sh SYNOPSIS
42.Cd "wb* at pci?"
43.Cd "amphy* at mii?"
44.Sh DESCRIPTION
45The
46.Nm
47driver provides support for PCI Ethernet adapters and embedded
48controllers based on the Winbond W89C840F Fast Ethernet controller chip.
49This includes the TRENDnet TE100-PCIE and various other cheap boards.
50The 840F should not be confused with the 940F, which is
51an NE2000 clone and only supports 10Mbps speeds.
52.Pp
53The Winbond controller uses bus master DMA and is designed to be
54a DEC "tulip" work-alike.
55It differs from the standard DEC design
56in several ways: the control and status registers are spaced 4
57bytes apart instead of 8, and the receive filter is programmed through
58registers rather than by downloading a special setup frame via
59the transmit DMA engine.
60Using an external PHY, the Winbond chip
61supports both 10 and 100Mbps speeds in either full or half duplex.
62.Pp
63The
64.Nm
65driver supports the following media types:
66.Bl -tag -width full-duplex
67.It autoselect
68Enable autoselection of the media type and options.
69This is only supported if the PHY chip attached to the Winbond controller
70supports NWAY autonegotiation.
71The user can manually override
72the autoselected mode by adding media options to the appropriate
73.Xr hostname.if 5
74file.
75.It 10baseT
76Set 10Mbps operation.
77The
78.Ar mediaopt
79option can also be used to select either
80.Ar full-duplex
81or
82.Ar half-duplex
83modes.
84.It 100baseTX
85Set 100Mbps (Fast Ethernet) operation.
86The
87.Ar mediaopt
88option can also be used to select either
89.Ar full-duplex
90or
91.Ar half-duplex
92modes.
93.El
94.Pp
95The
96.Nm
97driver supports the following media options:
98.Bl -tag -width full-duplex
99.It full-duplex
100Force full duplex operation.
101.It half-duplex
102Force half duplex operation.
103.El
104.Pp
105Note that the 100baseTX media type is only available if supported
106by the adapter.
107For more information on configuring this device, see
108.Xr ifconfig 8 .
109.Sh DIAGNOSTICS
110.Bl -diag
111.It "wb%d: couldn't map memory"
112A fatal initialization error has occurred.
113.It "wb%d: couldn't map interrupt"
114A fatal initialization error has occurred.
115.It "wb%d: watchdog timeout"
116The device has stopped responding to the network, or there is a problem with
117the network connection (cable).
118.It "wb%d: no memory for rx list"
119The driver failed to allocate an mbuf for the receiver ring.
120.It "wb%d: no memory for tx list"
121The driver failed to allocate an mbuf for the transmitter ring when
122allocating a pad buffer or collapsing an mbuf chain into a cluster.
123.It "wb%d: chip is in D3 power state -- setting to D0"
124This message applies only to adapters which support power management.
125Some operating systems place the controller in low power
126mode when shutting down, and some PCI BIOSes fail to bring the chip
127out of this state before configuring it.
128The controller loses all of its PCI configuration in the D3 state, so if the
129BIOS does not set it back to full power mode in time, it won't be able
130to configure it correctly.
131The driver tries to detect this condition and bring
132the adapter back to the D0 (full power) state, but this may not be
133enough to return the driver to a fully operational condition.
134If this message appears at boot time and the driver fails to attach
135the device as a network interface, a second warm boot will have to be
136performed to have the device properly configured.
137.Pp
138Note that this condition only occurs when warm booting from another
139operating system.
140If the system is powered down prior to booting
141.Ox ,
142the card should be configured correctly.
143.El
144.Sh SEE ALSO
145.Xr amphy 4 ,
146.Xr arp 4 ,
147.Xr ifmedia 4 ,
148.Xr intro 4 ,
149.Xr netintro 4 ,
150.Xr pci 4 ,
151.Xr hostname.if 5 ,
152.Xr ifconfig 8
153.Sh HISTORY
154The
155.Nm
156device driver first appeared in
157.Fx 3.0 .
158.Ox
159support first appeared in
160.Ox 2.5 .
161.Sh AUTHORS
162The
163.Nm
164driver was written by
165.An Bill Paul Aq wpaul@ctr.columbia.edu .
166.Sh BUGS
167The Winbond chip seems to behave strangely in some cases when the
168link partner switches modes.
169If, for example, both sides are set to 10Mbps half-duplex, and the other end
170is changed to 100Mbps full-duplex, the Winbond's receiver suddenly starts
171writing trash all over the RX descriptors.
172The
173.Nm
174driver handles this by forcing a reset of both the controller
175chip and attached PHY.
176This is drastic, but it appears to be the only way to recover properly from
177this condition.
178