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: src/share/man/man4/xl.4,v 1.11.2.6 2003/02/17 21:20:39 trhodes Exp $
  32 .\" $DragonFly: src/share/man/man4/xl.4,v 1.7 2008/07/11 10:38:50 thomas Exp $
  33 .\"
  34 .Dd August 16, 1998
  35 .Dt XL 4
  36 .Os
  37 .Sh NAME
  38 .Nm xl
  39 .Nd "3Com Etherlink XL and Fast Etherlink XL ethernet device driver"
  40 .Sh SYNOPSIS
  41 .Cd "device miibus"
  42 .Cd "device xl"
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 driver provides support for PCI ethernet adapters and embedded
  47 controllers based on the 3Com "boomerang" and "cyclone" bus-master
  48 Etherlink XL chips.
  49 This includes the 3c900-TP, 3c900-COMBO, 3c905-TX,
  50 3c905-T4, 3c905B-TP, 3c905B-T4 and 3c905B-TX, and embedded 3c905-TX
  51 and 3c905B-TX ethernet hardware in certain Dell Optiplex and Dell
  52 Precision desktop machines, and certain Dell Latitude laptop docking
  53 stations.
  54 .Pp
  55 The Etherlink XL chips support built-in 10baseT, 10base2 and 10base5
  56 transceivers as well as an MII bus for externally attached PHY
  57 transceivers.
  58 The 3c905 series typically uses a National Semiconductor
  59 NS 83840A 10/100 PHY for 10/100 Mbps support in full or half-duplex.
  60 The 3c905B adapters have built-in autonegotiation logic mapped onto
  61 the MII for compatibility with previous drivers.
  62 Fast Etherlink XL
  63 adapters such as the 3c905-TX and 3c905B-TX are capable of 10 or
  64 100Mbps data rates in either full or half duplex and can be manually
  65 configured for any supported mode or automatically negotiate the highest
  66 possible mode with a link partner.
  67 .Pp
  68 The
  69 .Nm
  70 driver supports the following media types:
  71 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  72 .It autoselect
  73 Enable autoselection of the media type and options.
  74 Note that this
  75 option is only available with the 3c905 and 3c905B adapters with
  76 external PHYs or built-in autonegotiation logic.
  77 For 3c900 adapters,
  78 the driver will choose the mode specified in the EEPROM.
  79 The user can
  80 change this by adding media options to the
  81 .Pa /etc/rc.conf
  82 file.
  83 .It 10baseT/UTP
  84 Set 10Mbps operation.
  85 The
  86 .Ar mediaopt
  87 option can also be used to select either
  88 .Ar full-duplex
  89 or
  90 .Ar half-duplex
  91 modes.
  92 .It 100baseTX
  93 Set 100Mbps (fast ethernet) operation.
  94 The
  95 .Ar mediaopt
  96 option can also be used to select either
  97 .Ar full-duplex
  98 or
  99 .Ar half-duplex
 100 modes.
 101 .It 10base5/AUI
 102 Enable AUI transceiver (available only on COMBO cards).
 103 .It 10base2/BNC
 104 Enable BNC coax transceiver (available only on COMBO cards).
 105 .El
 106 .Pp
 107 The
 108 .Nm
 109 driver supports the following media options:
 110 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 111 .It full-duplex
 112 Force full duplex operation
 113 .It half-duplex
 114 Force half duplex operation.
 115 .El
 116 .Pp
 117 Note that the 100baseTX media type is only available if supported
 118 by the adapter.
 119 For more information on configuring this device, see
 120 .Xr ifconfig 8 .
 121 The
 122 .Nm
 123 driver supports
 124 .Xr polling 4 .
 125 .Sh DIAGNOSTICS
 126 .Bl -diag
 127 .It "xl%d: couldn't map memory"
 128 A fatal initialization error has occurred.
 129 .It "xl%d: couldn't map interrupt"
 130 A fatal initialization error has occurred.
 131 .It "xl%d: device timeout"
 132 The device has stopped responding to the network, or there is a problem with
 133 the network connection (cable).
 134 .It "xl%d: no memory for rx list"
 135 The driver failed to allocate an mbuf for the receiver ring.
 136 .It "xl%d: no memory for tx list"
 137 The driver failed to allocate an mbuf for the transmitter ring when
 138 allocating a pad buffer or collapsing an mbuf chain into a cluster.
 139 .It "xl%d: command never completed!"
 140 Some commands issued to the 3c90x ASIC take time to complete: the
 141 driver is supposed to wait until the 'command in progress' bit in
 142 the status register clears before continuing.
 143 In rare instances, this
 144 bit may not clear.
 145 To avoid getting caught in an infinite wait loop,
 146 the driver only polls the bit for a finite number of times before
 147 giving up, at which point it issues this message.
 148 This message may
 149 be printed during driver initialization on slower machines.
 150 If you
 151 see this message but the driver continues to function normally, the
 152 message can probably be ignored.
 153 .It "xl%d: chip is in D3 power state -- setting to D0"
 154 This message applies only to 3c905B adapters, which support power
 155 management.
 156 Some operating systems place the 3c905B in low power
 157 mode when shutting down, and some PCI BIOSes fail to bring the chip
 158 out of this state before configuring it.
 159 The 3c905B loses all of
 160 its PCI configuration in the D3 state, so if the BIOS does not set
 161 it back to full power mode in time, it won't be able to configure it
 162 correctly.
 163 The driver tries to detect this condition and bring
 164 the adapter back to the D0 (full power) state, but this may not be
 165 enough to return the driver to a fully operational condition.
 166 If
 167 you see this message at boot time and the driver fails to attach
 168 the device as a network interface, you will have to perform second
 169 warm boot to have the device properly configured.
 170 .Pp
 171 Note that this condition only occurs when warm booting from another
 172 operating system.
 173 If you power down your system prior to booting
 174 .Dx ,
 175 the card should be configured correctly.
 176 .It "xl%d: WARNING: no media options bits set in the media options register!"
 177 This warning may appear when using the driver on some Dell Latitude
 178 docking stations with built-in 3c905-TX adapters.
 179 For whatever the
 180 reason, the 'MII available' bit in the media options register on
 181 this particular equipment is not set, even though it should be (the
 182 3c905-TX always uses an external PHY transceiver). The driver will
 183 attempt to guess the proper media type based on the PCI device ID
 184 word.
 185 The driver makes a lot of noise about this condition because
 186 the author considers it a manufacturing defect.
 187 .El
 188 .Sh SEE ALSO
 189 .Xr arp 4 ,
 190 .Xr ifmedia 4 ,
 191 .Xr miibus 4 ,
 192 .Xr netintro 4 ,
 193 .Xr ng_ether 4 ,
 194 .Xr polling 4 ,
 195 .Xr ifconfig 8
 196 .Sh HISTORY
 197 The
 198 .Nm
 199 device driver first appeared in
 200 .Fx 3.0 .
 201 .Sh AUTHORS
 202 The
 203 .Nm
 204 driver was written by
 205 .An Bill Paul Aq wpaul@ctr.columbia.edu .