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