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