Add man page for ThunderLAN driver.

1 files changed, 124 insertions, 0 deletions

diff --git a/share/man/man4/tl.4 b/share/man/man4/tl.4
new file mode 100644
index 0000000..7491592
--- /dev/null
+++ b/share/man/man4/tl.4
@@ -0,0 +1,124 @@
+.\" 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: tl.4,v 1.3 1998/05/06 05:40:56 wpaul Exp $
+.\"
+.Dd May 1, 1998
+.Dt TL 4 i386
+.Os FreeBSD
+.Sh NAME
+.Nm tl
+.Nd
+Texas Instruments ThunderLAN ethernet device driver
+.Sh SYNOPSIS
+.Cd "device tl0"
+.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.
+.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 explcitly
+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 fauled 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 netintro 4 , 
+.Xr ifconfig 8
+.Sh HISTORY
+The
+.Nm
+device driver first appeared in
+.Fx 2.2 .
+.Sh AUTHOR
+The
+.Nm
+driver was written by
+.An Bill Paul Aq wpaul@ctr.columbia.edu .