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: src/share/man/man4/xl.4,v 1.11.2.6 2003/02/17 21:20:39 trhodes Exp $ 32.\" 33.Dd August 16, 1998 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 40.Cd "device miibus" 41.Cd "device xl" 42.Sh DESCRIPTION 43The 44.Nm 45driver provides support for PCI ethernet adapters and embedded 46controllers based on the 3Com "boomerang" and "cyclone" bus-master 47Etherlink XL chips. 48This includes the 3c900-TP, 3c900-COMBO, 3c905-TX, 493c905-T4, 3c905B-TP, 3c905B-T4 and 3c905B-TX, and embedded 3c905-TX 50and 3c905B-TX ethernet hardware in certain Dell Optiplex and Dell 51Precision desktop machines, and certain Dell Latitude laptop docking 52stations. 53.Pp 54The Etherlink XL chips support built-in 10baseT, 10base2 and 10base5 55transceivers as well as an MII bus for externally attached PHY 56transceivers. 57The 3c905 series typically uses a National Semiconductor 58NS 83840A 10/100 PHY for 10/100 Mbps support in full or half-duplex. 59The 3c905B adapters have built-in autonegotiation logic mapped onto 60the MII for compatibility with previous drivers. 61Fast Etherlink XL 62adapters such as the 3c905-TX and 3c905B-TX are capable of 10 or 63100Mbps data rates in either full or half duplex and can be manually 64configured for any supported mode or automatically negotiate the highest 65possible mode with a link partner. 66.Pp 67The 68.Nm 69driver supports the following media types: 70.Bl -tag -width xxxxxxxxxxxxxxxxxxxx 71.It autoselect 72Enable autoselection of the media type and options. 73Note that this 74option is only available with the 3c905 and 3c905B adapters with 75external PHYs or built-in autonegotiation logic. 76For 3c900 adapters, 77the driver will choose the mode specified in the EEPROM. 78The user can 79change this by adding media options to the 80.Pa /etc/rc.conf 81file. 82.It 10baseT/UTP 83Set 10Mbps operation. 84The 85.Ar mediaopt 86option can also be used to select either 87.Ar full-duplex 88or 89.Ar half-duplex 90modes. 91.It 100baseTX 92Set 100Mbps (fast ethernet) operation. 93The 94.Ar mediaopt 95option can also be used to select either 96.Ar full-duplex 97or 98.Ar half-duplex 99modes. 100.It 10base5/AUI 101Enable AUI transceiver (available only on COMBO cards). 102.It 10base2/BNC 103Enable BNC coax transceiver (available only on COMBO cards). 104.El 105.Pp 106The 107.Nm 108driver supports the following media options: 109.Bl -tag -width xxxxxxxxxxxxxxxxxxxx 110.It full-duplex 111Force full duplex operation 112.It half-duplex 113Force half duplex operation. 114.El 115.Pp 116Note that the 100baseTX media type is only available if supported 117by the adapter. 118For more information on configuring this device, see 119.Xr ifconfig 8 . 120The 121.Nm 122driver supports 123.Xr polling 4 . 124.Sh DIAGNOSTICS 125.Bl -diag 126.It "xl%d: couldn't map memory" 127A fatal initialization error has occurred. 128.It "xl%d: couldn't map interrupt" 129A fatal initialization error has occurred. 130.It "xl%d: device timeout" 131The device has stopped responding to the network, or there is a problem with 132the network connection (cable). 133.It "xl%d: no memory for rx list" 134The driver failed to allocate an mbuf for the receiver ring. 135.It "xl%d: no memory for tx list" 136The driver failed to allocate an mbuf for the transmitter ring when 137allocating a pad buffer or collapsing an mbuf chain into a cluster. 138.It "xl%d: command never completed!" 139Some commands issued to the 3c90x ASIC take time to complete: the 140driver is supposed to wait until the 'command in progress' bit in 141the status register clears before continuing. 142In rare instances, this 143bit may not clear. 144To avoid getting caught in an infinite wait loop, 145the driver only polls the bit for a finite number of times before 146giving up, at which point it issues this message. 147This message may 148be printed during driver initialization on slower machines. 149If you 150see this message but the driver continues to function normally, the 151message can probably be ignored. 152.It "xl%d: chip is in D3 power state -- setting to D0" 153This message applies only to 3c905B adapters, which support power 154management. 155Some operating systems place the 3c905B in low power 156mode when shutting down, and some PCI BIOSes fail to bring the chip 157out of this state before configuring it. 158The 3c905B loses all of 159its PCI configuration in the D3 state, so if the BIOS does not set 160it back to full power mode in time, it won't be able to configure it 161correctly. 162The driver tries to detect this condition and bring 163the adapter back to the D0 (full power) state, but this may not be 164enough to return the driver to a fully operational condition. 165If 166you see this message at boot time and the driver fails to attach 167the device as a network interface, you will have to perform second 168warm boot to have the device properly configured. 169.Pp 170Note that this condition only occurs when warm booting from another 171operating system. 172If you power down your system prior to booting 173.Dx , 174the card should be configured correctly. 175.It "xl%d: WARNING: no media options bits set in the media options register!" 176This warning may appear when using the driver on some Dell Latitude 177docking stations with built-in 3c905-TX adapters. 178For whatever the 179reason, the 'MII available' bit in the media options register on 180this particular equipment is not set, even though it should be (the 1813c905-TX always uses an external PHY transceiver). The driver will 182attempt to guess the proper media type based on the PCI device ID 183word. 184The driver makes a lot of noise about this condition because 185the author considers it a manufacturing defect. 186.El 187.Sh SEE ALSO 188.Xr arp 4 , 189.Xr ifmedia 4 , 190.Xr miibus 4 , 191.Xr netintro 4 , 192.Xr ng_ether 4 , 193.Xr polling 4 , 194.Xr ifconfig 8 195.Sh HISTORY 196The 197.Nm 198device driver first appeared in 199.Fx 3.0 . 200.Sh AUTHORS 201The 202.Nm 203driver was written by 204.An Bill Paul Aq Mt wpaul@ctr.columbia.edu . 205