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