1 .\" Copyright (c) 1997, 1998
2 .\" Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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.
31 .\" $FreeBSD: src/share/man/man4/xl.4,v 1.11.2.6 2003/02/17 21:20:39 trhodes Exp $
38 .Nd "3Com Etherlink XL and Fast Etherlink XL ethernet device driver"
45 driver provides support for PCI ethernet adapters and embedded
46 controllers based on the 3Com "boomerang" and "cyclone" bus-master
48 This includes the 3c900-TP, 3c900-COMBO, 3c905-TX,
49 3c905-T4, 3c905B-TP, 3c905B-T4 and 3c905B-TX, and embedded 3c905-TX
50 and 3c905B-TX ethernet hardware in certain Dell Optiplex and Dell
51 Precision desktop machines, and certain Dell Latitude laptop docking
54 The Etherlink XL chips support built-in 10baseT, 10base2 and 10base5
55 transceivers as well as an MII bus for externally attached PHY
57 The 3c905 series typically uses a National Semiconductor
58 NS 83840A 10/100 PHY for 10/100 Mbps support in full or half-duplex.
59 The 3c905B adapters have built-in autonegotiation logic mapped onto
60 the MII for compatibility with previous drivers.
62 adapters such as the 3c905-TX and 3c905B-TX are capable of 10 or
63 100Mbps data rates in either full or half duplex and can be manually
64 configured for any supported mode or automatically negotiate the highest
65 possible mode with a link partner.
69 driver supports the following media types:
71 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
73 Enable autoselection of the media type and options.
75 option is only available with the 3c905 and 3c905B adapters with
76 external PHYs or built-in autonegotiation logic.
78 the driver will choose the mode specified in the EEPROM.
80 change this by adding media options to the
87 option can also be used to select either
93 Set 100Mbps (fast ethernet) operation.
96 option can also be used to select either
102 Enable AUI transceiver (available only on COMBO cards).
104 Enable BNC coax transceiver (available only on COMBO cards).
109 driver supports the following media options:
111 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
113 Force full duplex operation
115 Force half duplex operation.
118 Note that the 100baseTX media type is only available if supported
120 For more information on configuring this device, see
124 .It "xl%d: couldn't map memory"
125 A fatal initialization error has occurred.
126 .It "xl%d: couldn't map interrupt"
127 A fatal initialization error has occurred.
128 .It "xl%d: device timeout"
129 The device has stopped responding to the network, or there is a problem with
130 the network connection (cable).
131 .It "xl%d: no memory for rx list"
132 The driver failed to allocate an mbuf for the receiver ring.
133 .It "xl%d: no memory for tx list"
134 The driver failed to allocate an mbuf for the transmitter ring when
135 allocating a pad buffer or collapsing an mbuf chain into a cluster.
136 .It "xl%d: command never completed!"
137 Some commands issued to the 3c90x ASIC take time to complete: the
138 driver is supposed to wait until the 'command in progress' bit in
139 the status register clears before continuing.
140 In rare instances, this
142 To avoid getting caught in an infinite wait loop,
143 the driver only polls the bit for a finite number of times before
144 giving up, at which point it issues this message.
146 be printed during driver initialization on slower machines.
148 see this message but the driver continues to function normally, the
149 message can probably be ignored.
150 .It "xl%d: chip is in D3 power state -- setting to D0"
151 This message applies only to 3c905B adapters, which support power
153 Some operating systems place the 3c905B in low power
154 mode when shutting down, and some PCI BIOSes fail to bring the chip
155 out of this state before configuring it.
156 The 3c905B loses all of
157 its PCI configuration in the D3 state, so if the BIOS does not set
158 it back to full power mode in time, it won't be able to configure it
160 The driver tries to detect this condition and bring
161 the adapter back to the D0 (full power) state, but this may not be
162 enough to return the driver to a fully operational condition.
164 you see this message at boot time and the driver fails to attach
165 the device as a network interface, you will have to perform second
166 warm boot to have the device properly configured.
168 Note that this condition only occurs when warm booting from another
170 If you power down your system prior to booting
172 the card should be configured correctly.
173 .It "xl%d: WARNING: no media options bits set in the media options register!"
174 This warning may appear when using the driver on some Dell Latitude
175 docking stations with built-in 3c905-TX adapters.
177 reason, the 'MII available' bit in the media options register on
178 this particular equipment is not set, even though it should be (the
179 3c905-TX always uses an external PHY transceiver). The driver will
180 attempt to guess the proper media type based on the PCI device ID
182 The driver makes a lot of noise about this condition because
183 the author considers it a manufacturing defect.
194 device driver first appeared in
199 driver was written by
200 .An Bill Paul Aq wpaul@ctr.columbia.edu .