share/man/man4/xl.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 January 23, 2008
  34 .Dt XL 4
  35 .Os
  36 .Sh NAME
  37 .Nm xl
  38 .Nd "3Com Etherlink XL and Fast Etherlink XL 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 xl"
  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_xl_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 3Com "boomerang," "cyclone," "hurricane"
  59 and "tornado" bus-master Etherlink XL chips.
  60 .Pp
  61 The Etherlink XL chips support built-in 10baseT, 10base2 and 10base5
  62 transceivers as well as an MII bus for externally attached PHY
  63 transceivers.
  64 The 3c905 series typically uses a National Semiconductor
  65 NS 83840A 10/100 PHY for 10/100 Mbps support in full or half-duplex.
  66 The 3c905B adapters have built-in autonegotiation logic mapped onto
  67 the MII for compatibility with previous drivers.
  68 Fast Etherlink XL
  69 adapters such as the 3c905-TX and 3c905B-TX are capable of 10 or
  70 100Mbps data rates in either full or half duplex and can be manually
  71 configured for any supported mode or automatically negotiate the highest
  72 possible mode with a link partner.
  73 .Pp
  74 The
  75 .Nm
  76 driver supports the following media types:
  77 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  78 .It autoselect
  79 Enable autoselection of the media type and options.
  80 Note that this
  81 option is only available with the 3c905 and 3c905B adapters with
  82 external PHYs or built-in autonegotiation logic.
  83 For 3c900 adapters,
  84 the driver will choose the mode specified in the EEPROM.
  85 The user can
  86 change this by adding media options to the
  87 .Pa /etc/rc.conf
  88 file.
  89 .It 10baseT/UTP
  90 Set 10Mbps operation.
  91 The
  92 .Ar mediaopt
  93 option can also be used to select either
  94 .Ar full-duplex
  95 or
  96 .Ar half-duplex
  97 modes.
  98 .It 100baseTX
  99 Set 100Mbps (Fast Ethernet) operation.
 100 The
 101 .Ar mediaopt
 102 option can also be used to select either
 103 .Ar full-duplex
 104 or
 105 .Ar half-duplex
 106 modes.
 107 .It 10base5/AUI
 108 Enable AUI transceiver (available only on COMBO cards).
 109 .It 10base2/BNC
 110 Enable BNC coax transceiver (available only on COMBO cards).
 111 .El
 112 .Pp
 113 The
 114 .Nm
 115 driver supports the following media options:
 116 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 117 .It full-duplex
 118 Force full duplex operation.
 119 .It half-duplex
 120 Force half duplex operation.
 121 .El
 122 .Pp
 123 Note that the 100baseTX media type is only available if supported
 124 by the adapter.
 125 For more information on configuring this device, see
 126 .Xr ifconfig 8 .
 127 .Sh HARDWARE
 128 The
 129 .Nm
 130 driver supports the following hardware:
 131 .Pp
 132 .Bl -bullet -compact
 133 .It
 134 3Com 3c900-TPO
 135 .It
 136 3Com 3c900-COMBO
 137 .It
 138 3Com 3c905-TX
 139 .It
 140 3Com 3c905-T4
 141 .It
 142 3Com 3c900B-TPO
 143 .It
 144 3Com 3c900B-TPC
 145 .It
 146 3Com 3c900B-FL
 147 .It
 148 3Com 3c900B-COMBO
 149 .It
 150 3Com 3c905B-T4
 151 .It
 152 3Com 3c905B-TX
 153 .It
 154 3Com 3c905B-FX
 155 .It
 156 3Com 3c905B-COMBO
 157 .It
 158 3Com 3c905C-TX
 159 .It
 160 3Com 3c980, 3c980B, and 3c980C server adapters
 161 .It
 162 3Com 3cSOHO100-TX OfficeConnect adapters
 163 .It
 164 3Com 3c450 HomeConnect adapters
 165 .It
 166 3Com 3c555, 3c556 and 3c556B mini-PCI adapters
 167 .It
 168 3Com 3C3SH573BT, 3C575TX, 3CCFE575BT, 3CXFE575BT, 3CCFE575CT, 3CXFE575CT,
 169 3CCFEM656, 3CCFEM656B, and 3CCFEM656C, 3CXFEM656, 3CXFEM656B, and
 170 3CXFEM656C CardBus adapters
 171 .It
 172 3Com 3c905-TX, 3c905B-TX 3c905C-TX, 3c920B-EMB, and 3c920B-EMB-WNM embedded adapters
 173 .El
 174 .Pp
 175 Both the 3C656 family of CardBus cards and the 3C556 family of MiniPCI
 176 cards have a built-in proprietary modem.
 177 Neither the
 178 .Nm
 179 driver nor any other
 180 .Fx
 181 driver supports this modem.
 182 .Sh DIAGNOSTICS
 183 .Bl -diag
 184 .It "xl%d: couldn't map memory"
 185 A fatal initialization error has occurred.
 186 .It "xl%d: couldn't map interrupt"
 187 A fatal initialization error has occurred.
 188 .It "xl%d: device timeout"
 189 The device has stopped responding to the network, or there is a problem with
 190 the network connection (cable).
 191 .It "xl%d: no memory for rx list"
 192 The driver failed to allocate an mbuf for the receiver ring.
 193 .It "xl%d: no memory for tx list"
 194 The driver failed to allocate an mbuf for the transmitter ring when
 195 allocating a pad buffer or collapsing an mbuf chain into a cluster.
 196 .It "xl%d: command never completed!"
 197 Some commands issued to the 3c90x ASIC take time to complete: the
 198 driver is supposed to wait until the 'command in progress' bit in
 199 the status register clears before continuing.
 200 In rare instances, this
 201 bit may not clear.
 202 To avoid getting caught in an infinite wait loop,
 203 the driver only polls the bit for a finite number of times before
 204 giving up, at which point it issues this message.
 205 This message may
 206 be printed during driver initialization on slower machines.
 207 If you
 208 see this message but the driver continues to function normally, the
 209 message can probably be ignored.
 210 .It "xl%d: chip is in D3 power state -- setting to D0"
 211 This message applies only to 3c905B adapters, which support power
 212 management.
 213 Some operating systems place the 3c905B in low power
 214 mode when shutting down, and some PCI BIOSes fail to bring the chip
 215 out of this state before configuring it.
 216 The 3c905B loses all of
 217 its PCI configuration in the D3 state, so if the BIOS does not set
 218 it back to full power mode in time, it will not be able to configure it
 219 correctly.
 220 The driver tries to detect this condition and bring
 221 the adapter back to the D0 (full power) state, but this may not be
 222 enough to return the driver to a fully operational condition.
 223 If
 224 you see this message at boot time and the driver fails to attach
 225 the device as a network interface, you will have to perform second
 226 warm boot to have the device properly configured.
 227 .Pp
 228 Note that this condition only occurs when warm booting from another
 229 operating system.
 230 If you power down your system prior to booting
 231 .Fx ,
 232 the card should be configured correctly.
 233 .It "xl%d: WARNING: no media options bits set in the media options register!"
 234 This warning may appear when using the driver on some Dell Latitude
 235 docking stations with built-in 3c905-TX adapters.
 236 For whatever the
 237 reason, the 'MII available' bit in the media options register on
 238 this particular equipment is not set, even though it should be (the
 239 3c905-TX always uses an external PHY transceiver).
 240 The driver will
 241 attempt to guess the proper media type based on the PCI device ID
 242 word.
 243 The driver makes a lot of noise about this condition because
 244 the author considers it a manufacturing defect.
 245 .It xl%d: transmission error: %d
 246 .It xl%d: tx underrun, increasing tx start threshold to %d bytes
 247 This message may appear while the adapter tunes its transmission
 248 buffers under various load amounts and are mostly harmless.
 249 It is probably safe to ignore them.
 250 .El
 251 .Sh SEE ALSO
 252 .Xr altq 4 ,
 253 .Xr arp 4 ,
 254 .Xr cardbus 4 ,
 255 .Xr miibus 4 ,
 256 .Xr netintro 4 ,
 257 .Xr ng_ether 4 ,
 258 .Xr pccard 4 ,
 259 .Xr polling 4 ,
 260 .Xr ifconfig 8
 261 .Sh HISTORY
 262 The
 263 .Nm
 264 device driver first appeared in
 265 .Fx 3.0 .
 266 .Sh AUTHORS
 267 The
 268 .Nm
 269 driver was written by
 270 .An Bill Paul Aq wpaul@ctr.columbia.edu .