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.
38 .Nd "3Com Etherlink XL and Fast Etherlink XL Ethernet device driver"
40 To compile this driver into the kernel,
41 place the following lines in your
42 kernel configuration file:
43 .Bd -ragged -offset indent
48 Alternatively, to load the driver as a
49 module at boot time, place the following line in
51 .Bd -literal -offset indent
57 driver provides support for PCI Ethernet adapters and embedded
58 controllers based on the 3Com "boomerang," "cyclone," "hurricane"
59 and "tornado" bus-master Etherlink XL chips.
61 The Etherlink XL chips support built-in 10baseT, 10base2 and 10base5
62 transceivers as well as an MII bus for externally attached PHY
64 The 3c905 series typically uses a National Semiconductor
65 NS 83840A 10/100 PHY for 10/100 Mbps support in full or half-duplex.
66 The 3c905B adapters have built-in autonegotiation logic mapped onto
67 the MII for compatibility with previous drivers.
69 adapters such as the 3c905-TX and 3c905B-TX are capable of 10 or
70 100Mbps data rates in either full or half duplex and can be manually
71 configured for any supported mode or automatically negotiate the highest
72 possible mode with a link partner.
76 driver supports the following media types:
77 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
79 Enable autoselection of the media type and options.
81 option is only available with the 3c905 and 3c905B adapters with
82 external PHYs or built-in autonegotiation logic.
84 the driver will choose the mode specified in the EEPROM.
86 change this by adding media options to the
93 option can also be used to select either
99 Set 100Mbps (Fast Ethernet) operation.
102 option can also be used to select either
108 Enable AUI transceiver (available only on COMBO cards).
110 Enable BNC coax transceiver (available only on COMBO cards).
115 driver supports the following media options:
116 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
118 Force full duplex operation
120 Force half duplex operation.
123 Note that the 100baseTX media type is only available if supported
125 For more information on configuring this device, see
130 driver supports the following hardware:
160 3Com 3c980, 3c980B, and 3c980C server adapters
162 3Com 3cSOHO100-TX OfficeConnect adapters
164 3Com 3c450 HomeConnect adapters
166 3Com 3c555, 3c556 and 3c556B mini-PCI adapters
168 3Com 3C3SH573BT, 3C575TX, 3CCFE575BT, 3CXFE575BT, 3CCFE575CT, 3CXFE575CT,
169 3CCFEM656, 3CCFEM656B, and 3CCFEM656C, 3CXFEM656, 3CXFEM656B, and
170 3CXFEM656C CardBus adapters
172 3Com 3c905-TX, 3c905B-TX 3c905C-TX, 3c920B-EMB, and 3c920B-EMB-WNM embedded adapters
175 Both the 3C656 family of CardBus cards and the 3C556 family of MiniPCI
176 cards have a built-in proprietary modem.
181 driver supports this modem.
184 .It "xl%d: couldn't map memory"
185 A fatal initialization error has occurred.
186 .It "xl%d: couldn't map interrupt"
187 A fatal initialization error has occurred.
188 .It "xl%d: device timeout"
189 The device has stopped responding to the network, or there is a problem with
190 the network connection (cable).
191 .It "xl%d: no memory for rx list"
192 The driver failed to allocate an mbuf for the receiver ring.
193 .It "xl%d: no memory for tx list"
194 The driver failed to allocate an mbuf for the transmitter ring when
195 allocating a pad buffer or collapsing an mbuf chain into a cluster.
196 .It "xl%d: command never completed!"
197 Some commands issued to the 3c90x ASIC take time to complete: the
198 driver is supposed to wait until the 'command in progress' bit in
199 the status register clears before continuing.
200 In rare instances, this
202 To avoid getting caught in an infinite wait loop,
203 the driver only polls the bit for a finite number of times before
204 giving up, at which point it issues this message.
206 be printed during driver initialization on slower machines.
208 see this message but the driver continues to function normally, the
209 message can probably be ignored.
210 .It "xl%d: chip is in D3 power state -- setting to D0"
211 This message applies only to 3c905B adapters, which support power
213 Some operating systems place the 3c905B in low power
214 mode when shutting down, and some PCI BIOSes fail to bring the chip
215 out of this state before configuring it.
216 The 3c905B loses all of
217 its PCI configuration in the D3 state, so if the BIOS does not set
218 it back to full power mode in time, it will not be able to configure it
220 The driver tries to detect this condition and bring
221 the adapter back to the D0 (full power) state, but this may not be
222 enough to return the driver to a fully operational condition.
224 you see this message at boot time and the driver fails to attach
225 the device as a network interface, you will have to perform second
226 warm boot to have the device properly configured.
228 Note that this condition only occurs when warm booting from another
230 If you power down your system prior to booting
232 the card should be configured correctly.
233 .It "xl%d: WARNING: no media options bits set in the media options register!"
234 This warning may appear when using the driver on some Dell Latitude
235 docking stations with built-in 3c905-TX adapters.
237 reason, the 'MII available' bit in the media options register on
238 this particular equipment is not set, even though it should be (the
239 3c905-TX always uses an external PHY transceiver).
241 attempt to guess the proper media type based on the PCI device ID
243 The driver makes a lot of noise about this condition because
244 the author considers it a manufacturing defect.
245 .It xl%d: transmission error: %d
246 .It xl%d: tx underrun, increasing tx start threshold to %d bytes
247 This message may appear while the adapter tunes its transmission
248 buffers under various load amounts and are mostly harmless.
249 It is probably safe to ignore them.
264 device driver first appeared in
269 driver was written by
270 .An Bill Paul Aq wpaul@ctr.columbia.edu .