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