xref: /dragonfly/share/man/man4/wb.4 (revision 62f7f702)
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: src/share/man/man4/wb.4,v 1.10.2.5 2003/02/17 21:20:39 trhodes Exp $
32.\" $DragonFly: src/share/man/man4/wb.4,v 1.5 2008/05/02 02:05:05 swildner Exp $
33.\"
34.Dd November 4, 1998
35.Dt WB 4
36.Os
37.Sh NAME
38.Nm wb
39.Nd Winbond W89C840F fast ethernet device driver
40.Sh SYNOPSIS
41.Cd "device miibus"
42.Cd "device wb"
43.Sh DESCRIPTION
44The
45.Nm
46driver provides support for PCI ethernet adapters and embedded
47controllers based on the Winbond W89C840F fast ethernet controller
48chip.
49This includes the Trendware TE100-PCIE and various other cheap
50boards.
51The 840F should not be confused with the 940F, which is
52an NE2000 clone and only supports 10Mbps speeds.
53.Pp
54The Winbond controller uses bus master DMA and is designed to be
55a DEC 'tulip' workalike.
56It differs from the standard DEC design
57in several ways: the control and status registers are spaced 4
58bytes apart instead of 8, and the receive filter is programmed through
59registers rather than by downloading a special setup frame via
60the transmit DMA engine.
61Using an external PHY, the Winbond chip
62supports both 10 and 100Mbps speeds in either full or half duplex.
63.Pp
64The
65.Nm
66driver supports the following media types:
67.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
68.It autoselect
69Enable autoselection of the media type and options.
70This is only
71supported if the PHY chip attached to the Winbond controller
72supports NWAY autonegotiation.
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 DIAGNOSTICS
112.Bl -diag
113.It "wb%d: couldn't map memory"
114A fatal initialization error has occurred.
115.It "wb%d: couldn't map interrupt"
116A fatal initialization error has occurred.
117.It "wb%d: watchdog timeout"
118The device has stopped responding to the network, or there is a problem with
119the network connection (cable).
120.It "wb%d: no memory for rx list"
121The driver failed to allocate an mbuf for the receiver ring.
122.It "wb%d: no memory for tx list"
123The driver failed to allocate an mbuf for the transmitter ring when
124allocating a pad buffer or collapsing an mbuf chain into a cluster.
125.It "wb%d: chip is in D3 power state -- setting to D0"
126This message applies only to adapters which support power
127management.
128Some operating systems place the controller in low power
129mode when shutting down, and some PCI BIOSes fail to bring the chip
130out of this state before configuring it.
131The controller loses all of
132its PCI configuration in the D3 state, so if the BIOS does not set
133it back to full power mode in time, it won't be able to configure it
134correctly.
135The driver tries to detect this condition and bring
136the adapter back to the D0 (full power) state, but this may not be
137enough to return the driver to a fully operational condition.
138If
139you see this message at boot time and the driver fails to attach
140the device as a network interface, you will have to perform second
141warm boot to have the device properly configured.
142.Pp
143Note that this condition only occurs when warm booting from another
144operating system.
145If you power down your system prior to booting
146.Dx ,
147the card should be configured correctly.
148.El
149.Sh SEE ALSO
150.Xr arp 4 ,
151.Xr ifmedia 4 ,
152.Xr miibus 4 ,
153.Xr netintro 4 ,
154.Xr ng_ether 4 ,
155.Xr ifconfig 8
156.Sh HISTORY
157The
158.Nm
159device driver first appeared in
160.Fx 3.0 .
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
17010Mbps half-duplex, and the other end is changed to 100Mbps
171full-duplex, the Winbond's receiver suddenly starts writing trash
172all over the RX descriptors.
173The
174.Nm
175driver handles this by forcing a reset of both the controller
176chip and attached PHY.
177This is drastic, but it appears to be the
178only way to recover properly from this condition.
179