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