freebsd-nq/share/man/man4/tl.4

.\" Copyright (c) 1997, 1998
.\"	Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by Bill Paul.
.\" 4. Neither the name of the author nor the names of any co-contributors
.\"    may be used to endorse or promote products derived from this software
.\"   without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
.\" THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
.Dd May 1, 1998
.Dt TL 4
.Os
.Sh NAME
.Nm tl
.Nd Texas Instruments ThunderLAN ethernet device driver
.Sh SYNOPSIS
.Cd "device miibus"
.Cd "device tl"
.Sh DESCRIPTION
The
.Nm
driver provides support for PCI ethernet adapters based on the Texas
Instruments ThunderLAN ethernet controller chip.
This includes a large
number of Compaq PCI-bus ethernet adapters as well as the integrated
ethernet controllers built in to several models of Compaq Prosignia
servers and Compaq Deskpro desktop machines (Compaq Netelligent 10, 10/100,
10/100 Dual-Port, 10/100 Proliant, 10/100 TX Embedded UTP, 10 T PCI UTP/Coax,
and 10/100 TX UTP; Compaq NetFlex 3P, 3P Integrated, and 3P w/BNC).
This driver also supports
the Olicom OC-2135/2138, OC-2325 and OC-2326 10/100 TX UTP adapters
and the Racore 8165 10/100baseTX and 8148 10baseT/100baseTX/100baseFX
multi-personality cards.
.Pp
The ThunderLAN controller has a standard MII interface that supports
up to 32 physical interface devices (PHYs). It also has a built-in
10baseT PHY hardwired at MII address 31, which may be used in some
10Mbps-only hardware configurations.
In 100Mbps configurations, a
National Semiconductor DP83840A or other MII-compliant PHY may be
attached to the ThunderLAN's MII bus.
If a DP83840A or equivalent
is available, the ThunderLAN chip can operate at either 100Mbps or
10Mbps in either half-duplex or full-duplex modes.
The ThunderLAN's
built-in PHY and the DP83840A also support autonegotiation.
.Pp
The
.Nm
driver supports the following media types:
.Pp
.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
.It autoselect
Enable autoselection of the media type and options.
Note that this
option is only available on those PHYs that support autonegotiation.
Also, the PHY will not advertise those modes that have been explicitly
disabled using the following media options.
.It 10baseT/UTP
Set 10Mbps operation
.It 100baseTX
Set 100Mbps (fast ethernet) operation
.It 10base5/AUI
Enable AUI/BNC interface (useful only with the built-in PHY).
.El
.Pp
The
.Nm
driver supports the following media options:
.Pp
.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
.It full-duplex
Force full duplex operation
.It half-duplex
Force half duplex operation.
.It hw-loopback
Enable hardware loopback mode.
.El
.Pp
Note that the 100baseTX media type is only available if supported
by the PHY.
For more information on configuring this device, see
.Xr ifconfig 8 .
.Sh DIAGNOSTICS
.Bl -diag
.It "tl%d: couldn't map memory"
A fatal initialization error has occurred.
.It "tl%d: couldn't map interrupt"
A fatal initialization error has occurred.
.It "tl%d: device timeout"
The device has stopped responding to the network, or there is a problem with
the network connection (cable).
.It "tl%d: no memory for rx list"
The driver failed to allocate an mbuf for the receiver ring.
.It "tl%d: no memory for tx list"
The driver failed to allocate an mbuf for the transmitter ring when
allocating a pad buffer or collapsing an mbuf chain into a cluster.
.El
.Sh SEE ALSO
.Xr arp 4 ,
.Xr miibus 4 ,
.Xr netintro 4 ,
.Xr ng_ether 4 ,
.Xr ifconfig 8
.Sh HISTORY
The
.Nm
device driver first appeared in
.Fx 2.2 .
.Sh AUTHORS
The
.Nm
driver was written by
.An Bill Paul Aq wpaul@ctr.columbia.edu .
Add man page for ThunderLAN driver. 1998-05-21 03:20:39 +00:00			`.\" Copyright (c) 1997, 1998`
			`.\" Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 3. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed by Bill Paul.`
			`.\" 4. Neither the name of the author nor the names of any co-contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD`
			`.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR`
			`.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF`
			`.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS`
			`.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN`
			`.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)`
			`.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF`
			`.\" THE POSSIBILITY OF SUCH DAMAGE.`
			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
Add man page for ThunderLAN driver. 1998-05-21 03:20:39 +00:00			`.\"`
			`.Dd May 1, 1998`
* remove i386 specific mark * some style and syntax fixes * some duplicated $FreeBSD$ tags removed 1999-11-15 23:14:32 +00:00			`.Dt TL 4`
mdoc(7) police: removed HISTORY info from the .Os call. 2001-07-10 15:31:11 +00:00			`.Os`
Add man page for ThunderLAN driver. 1998-05-21 03:20:39 +00:00			`.Sh NAME`
			`.Nm tl`
mdoc(7) police: normalize .Nd. 2001-04-18 15:54:10 +00:00			`.Nd Texas Instruments ThunderLAN ethernet device driver`
Add man page for ThunderLAN driver. 1998-05-21 03:20:39 +00:00			`.Sh SYNOPSIS`
Second round of config related changes to the manpages. device blah0 -> device blah for PCI devices and busses. 2000-01-23 16:13:26 +00:00			`.Cd "device miibus"`
			`.Cd "device tl"`
Add man page for ThunderLAN driver. 1998-05-21 03:20:39 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Nm`
			`driver provides support for PCI ethernet adapters based on the Texas`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-01 14:50:24 +00:00			`Instruments ThunderLAN ethernet controller chip.`
			`This includes a large`
Add man page for ThunderLAN driver. 1998-05-21 03:20:39 +00:00			`number of Compaq PCI-bus ethernet adapters as well as the integrated`
			`ethernet controllers built in to several models of Compaq Prosignia`
Catch up with the hardware notes: list the supported Compaq controllers. PR: 55641 Submitted by: Lukas Ertl <l.ertl@univie.ac.at> 2003-09-05 14:17:33 +00:00			`servers and Compaq Deskpro desktop machines (Compaq Netelligent 10, 10/100,`
			`10/100 Dual-Port, 10/100 Proliant, 10/100 TX Embedded UTP, 10 T PCI UTP/Coax,`
			`and 10/100 TX UTP; Compaq NetFlex 3P, 3P Integrated, and 3P w/BNC).`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-01 14:50:24 +00:00			`This driver also supports`
Add two additional cards to the supported adapters list: the Racore 8165 and Racore 8148 adapters are now supported by the ThunderLAN driver. The 8165 is just a plain vanilla 10/100 card; the 8148 is a 'multi- personality' adapter which can support 10baseT, 100baseTX and 100baseFX if you include the proper modules. Also update the tl man page to mention the Racore cards. 1999-01-29 16:25:20 +00:00			`the Olicom OC-2135/2138, OC-2325 and OC-2326 10/100 TX UTP adapters`
			`and the Racore 8165 10/100baseTX and 8148 10baseT/100baseTX/100baseFX`
			`multi-personality cards.`
Add man page for ThunderLAN driver. 1998-05-21 03:20:39 +00:00			`.Pp`
			`The ThunderLAN controller has a standard MII interface that supports`
			`up to 32 physical interface devices (PHYs). It also has a built-in`
			`10baseT PHY hardwired at MII address 31, which may be used in some`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-01 14:50:24 +00:00			`10Mbps-only hardware configurations.`
			`In 100Mbps configurations, a`
Add man page for ThunderLAN driver. 1998-05-21 03:20:39 +00:00			`National Semiconductor DP83840A or other MII-compliant PHY may be`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-01 14:50:24 +00:00			`attached to the ThunderLAN's MII bus.`
			`If a DP83840A or equivalent`
Add man page for ThunderLAN driver. 1998-05-21 03:20:39 +00:00			`is available, the ThunderLAN chip can operate at either 100Mbps or`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-01 14:50:24 +00:00			`10Mbps in either half-duplex or full-duplex modes.`
			`The ThunderLAN's`
Add man page for ThunderLAN driver. 1998-05-21 03:20:39 +00:00			`built-in PHY and the DP83840A also support autonegotiation.`
			`.Pp`
			`The`
			`.Nm`
			`driver supports the following media types:`
			`.Pp`
			`.Bl -tag -width xxxxxxxxxxxxxxxxxxxx`
			`.It autoselect`
Remove single-space hard sentence breaks. These degrade the quality of the typeset output, tend to make diffs harder to read and provide bad examples for new-comers to mdoc. 2000-03-01 14:50:24 +00:00			`Enable autoselection of the media type and options.`
			`Note that this`
Add man page for ThunderLAN driver. 1998-05-21 03:20:39 +00:00			`option is only available on those PHYs that support autonegotiation.`
Ispell sweep of share/man/man4. 2002-01-21 12:09:13 +00:00			`Also, the PHY will not advertise those modes that have been explicitly`
Add man page for ThunderLAN driver. 1998-05-21 03:20:39 +00:00			`disabled using the following media options.`
			`.It 10baseT/UTP`
			`Set 10Mbps operation`
			`.It 100baseTX`
			`Set 100Mbps (fast ethernet) operation`
			`.It 10base5/AUI`
			`Enable AUI/BNC interface (useful only with the built-in PHY).`
			`.El`
			`.Pp`
			`The`
			`.Nm`
			`driver supports the following media options:`
			`.Pp`
			`.Bl -tag -width xxxxxxxxxxxxxxxxxxxx`
			`.It full-duplex`
			`Force full duplex operation`
			`.It half-duplex`
			`Force half duplex operation.`
			`.It hw-loopback`
			`Enable hardware loopback mode.`
			`.El`
			`.Pp`
			`Note that the 100baseTX media type is only available if supported`
			`by the PHY.`
			`For more information on configuring this device, see`
			`.Xr ifconfig 8 .`
			`.Sh DIAGNOSTICS`
			`.Bl -diag`
			`.It "tl%d: couldn't map memory"`
			`A fatal initialization error has occurred.`
			`.It "tl%d: couldn't map interrupt"`
			`A fatal initialization error has occurred.`
			`.It "tl%d: device timeout"`
			`The device has stopped responding to the network, or there is a problem with`
			`the network connection (cable).`
			`.It "tl%d: no memory for rx list"`
			`The driver failed to allocate an mbuf for the receiver ring.`
			`.It "tl%d: no memory for tx list"`
Fix typo (fauled) 1998-12-05 09:31:25 +00:00			`The driver failed to allocate an mbuf for the transmitter ring when`
Add man page for ThunderLAN driver. 1998-05-21 03:20:39 +00:00			`allocating a pad buffer or collapsing an mbuf chain into a cluster.`
			`.El`
			`.Sh SEE ALSO`
			`.Xr arp 4 ,`
Xref miibus(4). 2003-02-15 17:12:53 +00:00			`.Xr miibus 4 ,`
Removed whitespace at end-of-line; no content changes. I simply did cd src/share; find man[1-9] -type f\|xargs perl -pi -e 's/[ \t]+$//' BTW, what editors are the culprits? I'm using vim and it shows me whitespace at EOL in troff files with a thick blue block... Reviewed by: Silence from cvs diff -b MFC after: 7 days 2001-07-14 19:41:16 +00:00			`.Xr netintro 4 ,`
Move netgraph node type man pages from section 8 to section 4. 2000-05-04 17:40:13 +00:00			`.Xr ng_ether 4 ,`
			`.Xr ifconfig 8`
Add man page for ThunderLAN driver. 1998-05-21 03:20:39 +00:00			`.Sh HISTORY`
			`The`
			`.Nm`
			`device driver first appeared in`
			`.Fx 2.2 .`
Various man page cleanup: - Sort xrefs - FreeBSD.ORG -> FreeBSD.org - Be consistent with section names as outlined in mdoc(7). - Other misc mdoc cleanup. PR: doc/13144 Submitted by: Alexey M. Zelkin <phantom@cris.net> 1999-08-15 10:48:36 +00:00			`.Sh AUTHORS`
Add man page for ThunderLAN driver. 1998-05-21 03:20:39 +00:00			`The`
			`.Nm`
			`driver was written by`
			`.An Bill Paul Aq wpaul@ctr.columbia.edu .`