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$ 32.\" 33.Dd August 16, 1998 34.Dt XL 4 35.Os FreeBSD 36.Sh NAME 37.Nm xl 38.Nd 393Com 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 modes. 92.It 100baseTX 93Set 100Mbps (fast ethernet) operation. 94The 95.Ar mediaopt 96option can abso be used to select either 97.Ar full-duplex 98or 99.Ar half-duplex modes. 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.Pp 110.Bl -tag -width xxxxxxxxxxxxxxxxxxxx 111.It full-duplex 112Force full duplex operation 113.It half-duplex 114Force half duplex operation. 115.El 116.Pp 117Note that the 100baseTX media type is only available if supported 118by the adapter. 119For more information on configuring this device, see 120.Xr ifconfig 8 . 121.Sh DIAGNOSTICS 122.Bl -diag 123.It "xl%d: couldn't map memory" 124A fatal initialization error has occurred. 125.It "xl%d: couldn't map interrupt" 126A fatal initialization error has occurred. 127.It "xl%d: device timeout" 128The device has stopped responding to the network, or there is a problem with 129the network connection (cable). 130.It "xl%d: no memory for rx list" 131The driver failed to allocate an mbuf for the receiver ring. 132.It "xl%d: no memory for tx list" 133The driver failed to allocate an mbuf for the transmitter ring when 134allocating a pad buffer or collapsing an mbuf chain into a cluster. 135.It "xl%d: command never completed!" 136Some commands issued to the 3c90x ASIC take time to complete: the 137driver is supposed to wait until the 'command in progress' bit in 138the status register clears before continuing. 139In rare instances, this 140bit may not clear. 141To avoid getting caught in an infinite wait loop, 142the driver only polls the bit for a finite number of times before 143giving up, at which point it issues this message. 144This message may 145be printed during driver initialization on slower machines. 146If you 147see this message but the driver continues to function normally, the 148message can probably be ignored. 149.It "xl%d: chip is in D3 power state -- setting to D0" 150This message applies only to 3c905B adapters, which support power 151management. 152Some operating systems place the 3c905B in low power 153mode when shutting down, and some PCI BIOSes fail to bring the chip 154out of this state before configuring it. 155The 3c905B loses all of 156its PCI configuration in the D3 state, so if the BIOS does not set 157it back to full power mode in time, it won't be able to configure it 158correctly. 159The driver tries to detect this condition and bring 160the adapter back to the D0 (full power) state, but this may not be 161enough to return the driver to a fully operational condition. 162If 163you see this message at boot time and the driver fails to attach 164the device as a network interface, you will have to perform second 165warm boot to have the device properly configured. 166.Pp 167Note that this condition only occurs when warm booting from another 168operating system. 169If you power down your system prior to booting 170.Fx , 171the card should be configured correctly. 172.It "xl%d: WARNING: no media options bits set in the media options register!" 173This warning may appear when using the driver on some Dell Latitude 174docking stations with built-in 3c905-TX adapters. 175For whatever the 176reason, the 'MII available' bit in the media options register on 177this particular equipment is not set, even though it should be (the 1783c905-TX always uses an external PHY transceiver). The driver will 179attempt to guess the proper media type based on the PCI device ID 180word. 181The driver makes a lot of noise about this condition because 182the author considers it a manufacturing defect. 183.El 184.Sh SEE ALSO 185.Xr arp 4 , 186.Xr netintro 4 , 187.Xr ifconfig 8 , 188.Xr ng_ether 8 189.Sh HISTORY 190The 191.Nm 192device driver first appeared in 193.Fx 3.0 . 194.Sh AUTHORS 195The 196.Nm 197driver was written by 198.An Bill Paul Aq wpaul@ctr.columbia.edu . 199