Add man page for ADMtek driver; from FreeBSD.

2 files changed, 157 insertions, 4 deletions

diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index 765fd779b54..61fe9b74e43 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -1,9 +1,9 @@
-#	$OpenBSD: Makefile,v 1.81 1999/10/07 20:51:52 angelos Exp $
+#	$OpenBSD: Makefile,v 1.82 1999/10/28 22:36:39 aaron Exp $
 #	$NetBSD: Makefile,v 1.22.4.2 1996/07/18 00:51:10 jtc Exp $
 
-MAN=	ac97.4 atalk.4 atapiscsi.4 audio.4 adv.4 ahc.4 ax.4 bpf.4 bridge.4 \
-	ccd.4 cd.4 ch.4 clnp.4 cltp.4 cnw.4 ddb.4 de.4 drum.4 eap.4 ec.4 \
-	ef.4 enc.4 ep.4 \
+MAN=	ac97.4 atalk.4 atapiscsi.4 audio.4 adv.4 ahc.4 al.4 ax.4 bpf.4 \
+	bridge.4 ccd.4 cd.4 ch.4 clnp.4 cltp.4 cnw.4 ddb.4 de.4 drum.4 eap.4 \
+	ec.4 ef.4 enc.4 ep.4 \
 	esis.4 eso.4 ess.4 exphy.4 fd.4 ffs_softupdates.4 fpa.4 fxp.4 icmp.4 \
 	icsphy.4 idp.4 ifmedia.4 imp.4 inet.4 inphy.4 ip.4 ipl.4 ipsec.4 \
 	isapnp.4 iso.4 isp.4 ksyms.4 lkm.4 lmc.4 lo.4 lxtphy.4 midi.4 mii.4 \
diff --git a/share/man/man4/al.4 b/share/man/man4/al.4
new file mode 100644
index 00000000000..137956394f8
--- /dev/null
+++ b/share/man/man4/al.4
@@ -0,0 +1,153 @@
+.\"	$OpenBSD: al.4,v 1.1 1999/10/28 22:36:39 aaron Exp $
+.\" Copyright (c) 1997, 1998, 1999
+.\"	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: src/share/man/man4/man4.i386/al.4,v 1.5 1999/09/22 05:07:51 wpaul Exp $
+.\"
+.Dd May 20, 1999
+.Dt AL 4 i386
+.Os
+.Sh NAME
+.Nm al
+.Nd
+ADMtek AL981 Comet and AN985 Centaur Fast Ethernet driver
+.Sh SYNOPSIS
+.Cd "al* at pci? dev ? function ?"
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for PCI Ethernet adapters and embedded
+controllers based on the ADMtek Inc. AL981 Comet and AN 985
+Centaur Fast Ethernet controller chips.
+.Pp
+The ADMtek chip uses bus master DMA and is designed to be a
+DEC 21x4x workalike. The only major difference between the DEC
+and ADMtek parts is that the ADMtek receiver filter is programmed
+using two special registers where as the DEC chip is programmed
+by uploading a special setup frame via the transmit DMA engine.
+The AL981 and AN985 can only be programmed with a single
+perfect filter entry for the local station address and a 64-bit
+multicast hash table; the DEC filter supports several other
+options. The ADMtek Fast Ethernet controllers support both
+10 and 100Mbps speeds in either full or half duplex using
+an internal MII transceiver.
+.Pp
+The
+.Nm
+driver supports the following media types:
+.Pp
+.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
+.It autoselect
+Enable autoselection of the media type and options.
+The user can manually override
+the autoselected mode by adding media options to the
+.Pa /etc/rc.conf
+fine.
+.It 10baseT/UTP
+Set 10Mbps operation. The
+.Ar mediaopt
+option can also be used to select either
+.Ar full-duplex
+or
+.Ar half-duplex modes.
+.It 100baseTX
+Set 100Mbps (Fast Ethernet) operation. The
+.Ar mediaopt
+option can also be used to select either
+.Ar full-duplex
+or
+.Ar half-duplex
+modes.
+.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.
+.El
+.Pp
+For more information on configuring this device, see
+.Xr ifconfig 8 .
+.Sh DIAGNOSTICS
+.Bl -diag
+.It "ax%d: couldn't map memory"
+A fatal initialization error has occurred.
+.It "ax%d: couldn't map interrupt"
+A fatal initialization error has occurred.
+.It "ax%d: watchdog timeout"
+The device has stopped responding to the network, or there is a problem with
+the network connection (cable).
+.It "ax%d: no memory for rx list"
+The driver failed to allocate an mbuf for the receiver ring.
+.It "ax%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.
+.It "ax%d: chip is in D3 power state -- setting to D0"
+This message applies only to adapters which support power
+management. Some operating systems place the controller in low power
+mode when shutting down, and some PCI BIOSes fail to bring the chip
+out of this state before configuring it. The controller loses all of
+its PCI configuration in the D3 state, so if the BIOS does not set
+it back to full power mode in time, it won't be able to configure it
+correctly. The driver tries to detect this condition and bring
+the adapter back to the D0 (full power) state, but this may not be
+enough to return the driver to a fully operational condition. If
+you see this message at boot time and the driver fails to attach
+the device as a network interface, you will have to perform second
+warm boot to have the device properly configured.
+.Pp
+Note that this condition only occurs when warm booting from another
+operating system. If you power down your system prior to booting
+.Fx ,
+the card should be configured correctly.
+.El
+.Sh SEE ALSO
+.Xr arp 4 ,
+.Xr netintro 4 , 
+.Xr ifconfig 8
+.Rs
+.%T ADMtek AL981 data sheet
+.%O http://www.admtek.com.tw
+.Re
+.Sh HISTORY
+The
+.Nm
+device driver first appeared in
+.Ox 2.7 .
+.Sh AUTHORS
+The
+.Nm
+driver was written by
+.An Bill Paul Aq wpaul@ctr.columbia.edu .