1.\" $OpenBSD: xl.4,v 1.22 2001/06/22 12:15:48 mpech Exp $ 2.\" 3.\" Copyright (c) 1997, 1998 4.\" Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 9.\" 1. Redistributions of source code must retain the above copyright 10.\" notice, this list of conditions and the following disclaimer. 11.\" 2. Redistributions in binary form must reproduce the above copyright 12.\" notice, this list of conditions and the following disclaimer in the 13.\" documentation and/or other materials provided with the distribution. 14.\" 3. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by Bill Paul. 17.\" 4. Neither the name of the author nor the names of any co-contributors 18.\" may be used to endorse or promote products derived from this software 19.\" without specific prior written permission. 20.\" 21.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND 22.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 23.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 24.\" ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD 25.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 26.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 27.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 29.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 30.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 31.\" THE POSSIBILITY OF SUCH DAMAGE. 32.\" 33.\" $FreeBSD: xl.4,v 1.1 1998/08/16 17:19:58 wpaul Exp $ 34.\" 35.Dd August 16, 1998 36.Dt XL 4 37.Os 38.Sh NAME 39.Nm xl 40.Nd 3Com EtherLink XL and Fast EtherLink XL Ethernet driver 41.Sh SYNOPSIS 42.Cd "xl* at pci? dev ? function ?" 43.Cd "xl* at cardbus? dev ? function ?" 44.Sh DESCRIPTION 45The 46.Nm 47device driver supports the 3Com EtherLink XL and Fast EtherLink XL family 48of Ethernet cards, and embedded controllers based on the 3Com 49.Dq boomerang 50and 51.Dq cyclone 52bus master EtherLink XL chips. 53This includes, among others, the following models: 54.Pp 55.Bl -tag -width 3CXXXX -offset indent -compact 56.It 3C555 57EtherLink XL MiniPCI 58.It 3C556 59EtherLink XL MiniPCI 60.It 3C556B 61EtherLink XL MiniPCI 62.It 3C575 6310/100 LAN CardBus PC Card 64.It 3C656 6510/100 LAN+Modem CardBus PC Card 66.It 3C900 67EtherLink XL PCI 68.It 3C900B 69EtherLink XL PCI 70.It 3C905 71Fast EtherLink XL PCI 72.It 3C905B 73Fast EtherLink XL PCI 74.It 3C905C 75Fast EtherLink XL PCI 76.It 3C980 77Fast EtherLink Server NIC 78.It 3CSOHO 79OfficeConnect Fast Ethernet NIC 80.El 81.Pp 82It also supports embedded 3C905-TX and 3C905B-TX Ethernet hardware found 83in certain Dell OptiPlex and Dell Precision desktop machines, as well as 84some Dell Latitude laptop docking stations. 85Other models of 3Com network cards are supported by the 86.Xr ec 4 , 87.Xr eg 4 , 88.Xr el 4 , 89.Xr ep 4 , 90and 91.Xr ie 4 92drivers. 93.Pp 94Category 3, 4 or 5 unshielded twisted-pair (UTP) cable should be used for 95RJ-45 (10baseT), thick Ethernet coaxial (RG59 B/U, 50 ohm) for AUI/DIX, 96and thin Ethernet coaxial (RG58 A/U or C/U, 50 ohm +/- 4) for BNC (10base2). 97Some 3Com NICs also support MII connectors (switchable 10/100Mbps UTP). 98The 3C905B-FX and other similar cards are capable of 100Mbps over fiber. 99.Pp 100The 3C985 series of Gigabit cards are supported by the 101.Xr ti 4 102driver. 103.Pp 104The following media types and options (as given to 105.Xr ifconfig 8 ) 106are supported: 107.Pp 108.Bl -tag -width xxx -offset indent 109.It Cm media No autoselect 110Enable autoselection of media type and options. 111Note that this media type is only available with 112adapters that have external PHYs or built-in autonegotiation logic. 113For 3C900 and 3C900B adapters, the driver 114will choose the mode specified in the EEPROM. 115You can change this by adding media options to the appropriate 116.Pa /etc/hostname.xlX 117file. 118.It Cm media No 100baseFX Cm mediaopt No full-duplex 119For those cards that support it, force full-duplex 100Mbps operation over fiber. 120.It Cm media No 100baseFX Cm mediaopt No half-duplex 121For those cards that support it, force half-duplex 100Mbps operation over fiber. 122.It Cm media No 100baseTX Cm mediaopt No full-duplex 123Set 100Mbps (Fast Ethernet) operation and force full-duplex mode. 124.It Cm media No 100baseTX Cm mediaopt No half-duplex 125Set 100Mbps (Fast Ethernet) operation and force half-duplex mode. 126.It Cm media No 10baseT Cm mediaopt No full-duplex 127Set 10baseT (UTP) operation and force full-duplex mode. 128.It Cm media No 10baseT Cm mediaopt No half-duplex 129Set 10baseT (UTP) operation and force half-duplex mode. 130.It Cm media No 10base5 131Set 10base5 (thick-net) operation (half-duplex only). 132.It Cm media No 10base2 133Set 10base2 (thin-net) operation (half-duplex only). 134.El 135.Pp 136For more information on configuring this device, see 137.Xr ifconfig 8 . 138To view a list of media types and options supported by your card try 139.Ic ifconfig -m <device> . 140For example, 141.Ic ifconfig -m xl0 . 142.Sh DIAGNOSTICS 143.Bl -diag 144.It "xl%d: couldn't map memory" 145A fatal initialization error has occurred. 146.It "xl%d: couldn't map interrupt" 147A fatal initialization error has occurred. 148.It "xl%d: device timeout" 149The device has stopped responding to the network, or there is a problem with 150the network connection (cable). 151.It "xl%d: no memory for rx list" 152The driver failed to allocate an mbuf for the receiver ring. 153.It "xl%d: no memory for tx list" 154The driver failed to allocate an mbuf for the transmitter ring when 155allocating a pad buffer or collapsing an mbuf chain into a cluster. 156.It "xl%d: command never completed!" 157Some commands issued to the 3C90x ASIC take time to complete: the 158driver is supposed to wait until the 159.Dq command in progress 160bit in the status register clears before continuing. 161In rare instances, this bit may not clear. 162To avoid getting caught in an infinite wait loop, 163the driver only polls the bit a finite number of times before 164giving up, at which point it issues this message. 165This message may be printed during driver initialization on slower machines. 166If you see this message but the driver continues to function normally, the 167message can probably be ignored. 168.It "xl%d: chip is in D3 power state -- setting to D0" 169This message applies only to 3C905B adapters, which support power management. 170Some operating systems place the 3C905B in low power 171mode when shutting down, and some PCI BIOSs fail to bring the chip 172out of this state before configuring it. 173The 3C905B loses all of its PCI configuration in the D3 state, so if the 174BIOS does not set it back to full power mode in time, 175it won't be able to configure it correctly. 176The driver tries to detect this condition and bring 177the adapter back to the D0 (full power) state, but this may not be 178enough to return the driver to a fully operational condition. 179If you see this message at boot time and the driver fails to attach 180the device as a network interface, you will have to perform second 181warm boot to have the device properly configured. 182.Pp 183Note that this condition only occurs when warm booting from another 184operating system. 185If you power down your system prior to booting 186.Ox , 187the card should be configured correctly. 188.It "xl%d: WARNING: no media options bits set in the media options register!" 189This warning may appear when using the driver on some Dell Latitude 190docking stations with built-in 3C905-TX adapters. 191For whatever the reason, the 192.Dq MII available 193bit in the media options register on 194this particular equipment is not set, even though it should be (the 1953C905-TX always uses an external PHY transceiver). 196The driver will 197attempt to guess the proper media type based on the PCI device ID word. 198The driver makes a lot of noise about this condition because 199the author considers it a manufacturing defect. 200.El 201.Sh SEE ALSO 202.Xr ec 4 , 203.Xr eg 4 , 204.Xr el 4 , 205.Xr ep 4 , 206.Xr ie 4 , 207.Xr ti 4 , 208.Xr ifmedia 4 , 209.Xr ifconfig 8 210.Sh HISTORY 211The 212.Nm 213device driver first appeared in 214.Fx 3.0 . 215.Ox 216support was added in 217.Ox 2.4 . 218.Sh AUTHORS 219The 220.Nm 221driver was written by 222.An Bill Paul Aq wpaul@ctr.columbia.edu . 223