share/man/man4/wb.4

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