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