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