1.\" $OpenBSD: xl.4,v 1.42 2008/09/07 06:55:34 jmc 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 $Mdocdate: September 7 2008 $ 36.Dt XL 4 37.Os 38.Sh NAME 39.Nm xl 40.Nd "3Com EtherLink XL and Fast EtherLink XL 10/100 Ethernet device" 41.Sh SYNOPSIS 42.Cd "xl* at pci?" 43.Cd "xl* at cardbus?" 44.Cd "amphy* at mii?" 45.Cd "bmtphy* at mii?" 46.Cd "exphy* at mii?" 47.Cd "nsphy* at mii?" 48.Cd "tqphy* at mii?" 49.Sh DESCRIPTION 50The 51.Nm 52device driver supports the 3Com EtherLink XL and Fast EtherLink XL family 53of Ethernet cards, and embedded controllers based on the 3Com 54.Dq boomerang 55and 56.Dq cyclone 57bus master EtherLink XL chips. 58This includes, among others, the following models: 59.Pp 60.Bl -tag -width 3CXXXXX -offset indent -compact 61.It 3C555 62EtherLink XL Mini PCI 63.It 3C556 64EtherLink XL Mini PCI 65.It 3C556B 66EtherLink XL Mini PCI 67.It 3C575 6810/100 LAN CardBus PC Card 69.It 3C656 7010/100 LAN+Modem CardBus PC Card 71.It 3C900 72EtherLink XL PCI 73.It 3C900B 74EtherLink XL PCI 75.It 3C905 76Fast EtherLink XL PCI 77.It 3C905B 78Fast EtherLink XL PCI 79.It 3C905C 80Fast EtherLink XL PCI 81.It 3C980 82Fast EtherLink Server NIC 83.It 3CSOHO 84OfficeConnect Fast Ethernet NIC 85.It 9201 86NVIDIA nForce2 integrated 3Com 9201 (nForce2-ST, nForce2-GT) 87.It 920BEMB 883c920B-EMB-WNM Integrated Fast Ethernet. 89.El 90.Pp 91It also supports embedded 3C905-TX and 3C905B-TX Ethernet hardware found 92in certain Dell OptiPlex and Dell Precision desktop machines, as well as 93some Dell Latitude laptop docking stations. 94.Pp 95Category 3, 4 or 5 unshielded twisted-pair (UTP) cable should be used for 96RJ-45 (10baseT), thick Ethernet coaxial (RG59 B/U, 50 ohm) for AUI/DIX, 97and thin Ethernet coaxial (RG58 A/U or C/U, 50 ohm +/- 4) for BNC (10base2). 98Some 3Com NICs also support MII connectors (switchable 10/100Mbps UTP). 99The 3C905B-FX and other similar cards are capable of 100Mbps over fiber. 100.Pp 101Hardware receive IP/TCP/UDP checksum offload for IPv4 is supported on the 3C905B. 102.Pp 103The following media types and options (as given to 104.Xr ifconfig 8 ) 105are supported: 106.Bl -tag -width xxx -offset indent 107.It Cm media No autoselect 108Enable autoselection of media type and options. 109Note that this media type is only available with 110adapters that have external PHYs or built-in autonegotiation logic. 111For 3C900 and 3C900B adapters, the driver 112will choose the mode specified in the EEPROM. 113This can be changed by adding media options to the appropriate 114.Xr hostname.if 5 115file. 116.It Cm media No 100baseFX Cm mediaopt No full-duplex 117For those cards that support it, force full-duplex 100Mbps operation over fiber. 118.It Cm media No 100baseFX Cm mediaopt No half-duplex 119For those cards that support it, force half-duplex 100Mbps operation over fiber. 120.It Cm media No 100baseTX Cm mediaopt No full-duplex 121Set 100Mbps (Fast Ethernet) operation and force full-duplex mode. 122.It Cm media No 100baseTX Cm mediaopt No half-duplex 123Set 100Mbps (Fast Ethernet) operation and force half-duplex mode. 124.It Cm media No 10baseT Cm mediaopt No full-duplex 125Set 10baseT (UTP) operation and force full-duplex mode. 126.It Cm media No 10baseT Cm mediaopt No half-duplex 127Set 10baseT (UTP) operation and force half-duplex mode. 128.It Cm media No 10base5 129Set 10base5 (thick-net) operation (half-duplex only). 130.It Cm media No 10base2 131Set 10base2 (thin-net) operation (half-duplex only). 132.El 133.Pp 134For more information on configuring this device, see 135.Xr ifconfig 8 . 136To view a list of media types and options supported by this card try 137.Ic ifconfig <device> media . 138For example, 139.Ic ifconfig xl0 media . 140.Sh DIAGNOSTICS 141.Bl -diag 142.It "xl%d: couldn't map memory" 143A fatal initialization error has occurred. 144.It "xl%d: couldn't map interrupt" 145A fatal initialization error has occurred. 146.It "xl%d: device timeout" 147The device has stopped responding to the network, or there is a problem with 148the network connection (cable). 149.It "xl%d: no memory for rx list" 150The driver failed to allocate an mbuf for the receiver ring. 151.It "xl%d: no memory for tx list" 152The driver failed to allocate an mbuf for the transmitter ring when 153allocating a pad buffer or collapsing an mbuf chain into a cluster. 154.It "xl%d: command never completed!" 155Some commands issued to the 3C90x ASIC take time to complete: the 156driver is supposed to wait until the 157.Dq command in progress 158bit in the status register clears before continuing. 159In some instances, this bit may not clear. 160To avoid getting caught in an infinite wait loop, 161the driver only polls the bit a finite number of times before 162giving up, at which point it issues this message. 163This message may be printed during driver initialization on slower machines. 164If this message appears but the driver continues to function normally, the 165message can probably be ignored. 166.It "xl%d: chip is in D3 power state -- setting to D0" 167This message applies only to 3C905B adapters, which support power management. 168Some operating systems place the 3C905B in low power 169mode when shutting down, and some PCI BIOSes fail to bring the chip 170out of this state before configuring it. 171The 3C905B loses all of its PCI configuration in the D3 state, so if the 172BIOS does not set it back to full power mode in time, 173it won't be able to configure it correctly. 174The driver tries to detect this condition and bring 175the adapter back to the D0 (full power) state, but this may not be 176enough to return the driver to a fully operational condition. 177If this message appears at boot time and the driver fails to attach 178the device as a network interface, a second warm boot will have to be 179performed to have the device properly configured. 180.Pp 181Note that this condition only occurs when warm booting from another 182operating system. 183If the system is powered down prior to booting 184.Ox , 185the card should be configured correctly. 186.It "xl%d: WARNING: no media options bits set in the media options register!" 187This warning may appear when using the driver on some Dell Latitude 188docking stations with built-in 3C905-TX adapters. 189For whatever the reason, the 190.Dq MII available 191bit in the media options register on 192this particular equipment is not set, even though it should be (the 1933C905-TX always uses an external PHY transceiver). 194The driver will 195attempt to guess the proper media type based on the PCI device ID word. 196The driver makes a lot of noise about this condition because 197the author considers it a manufacturing defect. 198.El 199.Sh SEE ALSO 200.Xr amphy 4 , 201.Xr arp 4 , 202.Xr bmtphy 4 , 203.Xr cardbus 4 , 204.Xr exphy 4 , 205.Xr ifmedia 4 , 206.Xr intro 4 , 207.Xr netintro 4 , 208.Xr nsphy 4 , 209.Xr tqphy 4 , 210.Xr hostname.if 5 , 211.Xr ifconfig 8 212.Sh HISTORY 213The 214.Nm 215device driver first appeared in 216.Fx 3.0 . 217.Ox 218support was added in 219.Ox 2.4 . 220.Sh AUTHORS 221The 222.Nm 223driver was written by 224.An Bill Paul Aq wpaul@ctr.columbia.edu . 225