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