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