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