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 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  77 .It autoselect
  78 Enable autoselection of the media type and options.
  79 This is only
  80 supported if the PHY chip attached to the Winbond controller
  81 supports NWAY autonegotiation.
  82 The user can manually override
  83 the autoselected mode by adding media options to the
  84 .Pa /etc/rc.conf
  85 file.
  86 .It 10baseT/UTP
  87 Set 10Mbps operation.
  88 The
  89 .Ar mediaopt
  90 option can also be used to select either
  91 .Ar full-duplex
  92 or
  93 .Ar half-duplex
  94 modes.
  95 .It 100baseTX
  96 Set 100Mbps (Fast Ethernet) operation.
  97 The
  98 .Ar mediaopt
  99 option can also be used to select either
 100 .Ar full-duplex
 101 or
 102 .Ar half-duplex
 103 modes.
 104 .El
 105 .Pp
 106 The
 107 .Nm
 108 driver supports the following media options:
 109 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 110 .It full-duplex
 111 Force full duplex operation.
 112 .It half-duplex
 113 Force half duplex operation.
 114 .El
 115 .Pp
 116 Note that the 100baseTX media type is only available if supported
 117 by the adapter.
 118 For more information on configuring this device, see
 119 .Xr ifconfig 8 .
 120 .Sh HARDWARE
 121 The
 122 .Nm
 123 driver supports Winbond W89C840F based Fast Ethernet
 124 adapters and embedded controllers including:
 125 .Pp
 126 .Bl -bullet -compact
 127 .It
 128 Trendware TE100-PCIE
 129 .El
 130 .Sh DIAGNOSTICS
 131 .Bl -diag
 132 .It "wb%d: couldn't map memory"
 133 A fatal initialization error has occurred.
 134 .It "wb%d: couldn't map interrupt"
 135 A fatal initialization error has occurred.
 136 .It "wb%d: watchdog timeout"
 137 The device has stopped responding to the network, or there is a problem with
 138 the network connection (cable).
 139 .It "wb%d: no memory for rx list"
 140 The driver failed to allocate an mbuf for the receiver ring.
 141 .It "wb%d: no memory for tx list"
 142 The driver failed to allocate an mbuf for the transmitter ring when
 143 allocating a pad buffer or collapsing an mbuf chain into a cluster.
 144 .It "wb%d: chip is in D3 power state -- setting to D0"
 145 This message applies only to adapters which support power
 146 management.
 147 Some operating systems place the controller in low power
 148 mode when shutting down, and some PCI BIOSes fail to bring the chip
 149 out of this state before configuring it.
 150 The controller loses all of
 151 its PCI configuration in the D3 state, so if the BIOS does not set
 152 it back to full power mode in time, it will not be able to configure it
 153 correctly.
 154 The driver tries to detect this condition and bring
 155 the adapter back to the D0 (full power) state, but this may not be
 156 enough to return the driver to a fully operational condition.
 157 If
 158 you see this message at boot time and the driver fails to attach
 159 the device as a network interface, you will have to perform second
 160 warm boot to have the device properly configured.
 161 .Pp
 162 Note that this condition only occurs when warm booting from another
 163 operating system.
 164 If you power down your system prior to booting
 165 .Fx ,
 166 the card should be configured correctly.
 167 .El
 168 .Sh SEE ALSO
 169 .Xr arp 4 ,
 170 .Xr miibus 4 ,
 171 .Xr netintro 4 ,
 172 .Xr ng_ether 4 ,
 173 .Xr ifconfig 8
 174 .Sh HISTORY
 175 The
 176 .Nm
 177 device driver first appeared in
 178 .Fx 3.0 .
 179 .Sh AUTHORS
 180 The
 181 .Nm
 182 driver was written by
 183 .An Bill Paul Aq wpaul@ctr.columbia.edu .
 184 .Sh BUGS
 185 The Winbond chip seems to behave strangely in some cases when the
 186 link partner switches modes.
 187 If for example both sides are set to
 188 10Mbps half-duplex, and the other end is changed to 100Mbps
 189 full-duplex, the Winbond's receiver suddenly starts writing trash
 190 all over the RX descriptors.
 191 The
 192 .Nm
 193 driver handles this by forcing a reset of both the controller
 194 chip and attached PHY.
 195 This is drastic, but it appears to be the
 196 only way to recover properly from this condition.