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