[src/trunk]: src/share/man/man4 Add man pages for Bill Paul's USB-Ethernet ad...

[augustss <augustss%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/33604c451b06
branches:  trunk
changeset: 480583:33604c451b06
user:      augustss <augustss%NetBSD.org@localhost>
date:      Sun Jan 16 10:43:36 2000 +0000

description:
Add man pages for Bill Paul's USB-Ethernet adapter drivers.
The actual drivers should appear within a few days.

diffstat:

 share/man/man4/Makefile |    3 +-
 share/man/man4/aue.4    |  155 ++++++++++++++++++++++++++++++++++++++++++++++++
 share/man/man4/cue.4    |   94 +++++++++++++++++++++++++++++
 share/man/man4/kue.4    |  106 ++++++++++++++++++++++++++++++++
 4 files changed, 357 insertions(+), 1 deletions(-)

diffs (truncated from 384 to 300 lines):

diff -r ff6b7ee47f80 -r 33604c451b06 share/man/man4/Makefile
--- a/share/man/man4/Makefile   Sun Jan 16 10:38:58 2000 +0000
+++ b/share/man/man4/Makefile   Sun Jan 16 10:43:36 2000 +0000
@@ -1,4 +1,4 @@
-#      $NetBSD: Makefile,v 1.121 2000/01/05 00:17:25 chopps Exp $
+#      $NetBSD: Makefile,v 1.122 2000/01/16 10:43:37 augustss Exp $
 #      @(#)Makefile    8.1 (Berkeley) 6/18/93
 
 MAN=   ahb.4 ahc.4 aria.4 atalk.4 audio.4 awi.4 bha.4 bpf.4 cardbus.4 ccd.4 \
@@ -18,6 +18,7 @@
 
 # USB devices
 MAN+=  uaudio.4 ugen.4 uhid.4 ukbd.4 ulpt.4 umass.4 umodem.4 ums.4 usb.4 \
+       aue.4 cue.4 kue.4 \
        uhci.4 ohci.4
 
 # machine-independent buses
diff -r ff6b7ee47f80 -r 33604c451b06 share/man/man4/aue.4
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man4/aue.4      Sun Jan 16 10:43:36 2000 +0000
@@ -0,0 +1,155 @@
+.\" $NetBSD: aue.4,v 1.1 2000/01/16 10:43:36 augustss Exp $
+.\" Copyright (c) 1997, 1998, 1999
+.\"     Bill Paul <wpaul%ee.columbia.edu@localhost>. 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/aue.4,v 1.2 2000/01/07 22:18:47 wpaul Exp $
+.\"
+.Dd December 25, 1999
+.Dt AUE 4
+.Os
+.Sh NAME
+.Nm aue
+.Nd ADMtek AN986 Pegasus USB Ethernet driver
+.Sh SYNOPSIS
+.Cd "aue*   at uhub?"
+.Cd "ukphy* at mii?"
+.Sh HARDWARE
+The
+.Nm
+driver supports the following adapters:
+.Pp
+.Bl -tag -width -offset indent -compact
+.It Tn Billionton Systems USB100
+.It Tn D-Link DSB-650TX
+.It Tn LinkSys USB100TX
+.It Tn Melco Inc. LU-ATX
+.It Tn SMC 2202USB
+.El
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for USB ethernet adapters based on the ADMtek
+AN986 Pegasus chipset.
+.Pp
+The Pegasus contains a 10/100
+ethernet MAC with MII interface and is designed to work with both
+ethernet and HomePNA transceivers. Although designed to interface with
+100Mbps peripherals, the existing USB standard specifies a maximum
+transfer speed of 12Mbps. Users should therefore not expect to actually
+achieve 100Mbps speeds with these devices.
+.Pp
+The Pegasus supports a 64-bit multicast hash table, single perfect
+filter entry for the station address and promiscuous mode. Packets are
+received and transmitted over separate USB bulk transfer endpoints.
+.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
+file.
+.It 10baseT/UTP
+Set 10Mbps operation. The
+.Ar mediaopt
+option can also be used to enable
+.Ar full-duplex
+operation. Not specifying
+.Ar full duplex
+implies
+.Ar half-duplex
+mode.
+.It 100baseTX
+Set 100Mbps (fast ethernet) operation. The
+.Ar mediaopt
+option can also be used to enable
+.Ar full-duplex
+operation. Not specifying
+.Ar full duplex
+implies
+.Ar half-duplex
+mode.
+.El
+.Pp
+The
+.Nm
+driver supports the following media options:
+.Pp
+.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
+.It full-duplex
+Force full duplex operation. The interface will operate in
+half duplex mode if this media option is not specified.
+.El
+.Pp
+For more information on configuring this device, see
+.Xr ifconfig 8 .
+.Sh DIAGNOSTICS
+.Bl -diag
+.It "aue%d: watchdog timeout"
+A packet was queued for transmission and a transmit command was
+issued, however the device failed to acknowledge the transmission
+before a timeout expired.
+.It "aue%d: no memory for rx list"
+The driver failed to allocate an mbuf for the receiver ring.
+.El
+.Sh SEE ALSO
+.Xr arp 4 ,
+.Xr ifconfig 8 ,
+.Xr netintro 4 ,
+.Xr usb 4 
+.Rs
+.%T ADMtek AN986 data sheet
+.%O http://www.admtek.com.tw
+.Re
+.Sh HISTORY
+The
+.Nm
+device driver first appeared in
+.Fx 4.0 ,
+and in
+.Nx 1.5 .
+.Sh AUTHORS
+The
+.Nm
+driver was written by
+.An Bill Paul Aq wpaul%ee.columbia.edu@localhost .
+.Sh BUGS
+For some reason, outgoing bulk transfers (i.e. packet transmissions)
+fail if the transfer is exactly a multiple of 64 bytes in size. The
+.Nm
+driver works around this by padding such transfers up by one additional
+byte. This does not affect connectivity, however it does cause packets
+to occasionaly appear on the wire with one additional byte for no good
+reason. It is not known if this bug is due to a problem with Pegasus
+chip itself or some peculiarity of the underlying USB support.
diff -r ff6b7ee47f80 -r 33604c451b06 share/man/man4/cue.4
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man4/cue.4      Sun Jan 16 10:43:36 2000 +0000
@@ -0,0 +1,94 @@
+.\" $NetBSD: cue.4,v 1.1 2000/01/16 10:43:37 augustss Exp $
+.\" Copyright (c) 1997, 1998, 1999, 2000
+.\"     Bill Paul <wpaul%ee.columbia.edu@localhost>. 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/cue.4,v 1.1 2000/01/14 03:14:47 wpaul Exp $
+.\"
+.Dd January 13, 2000
+.Dt CUE 4
+.Os
+.Sh NAME
+.Nm cue
+.Nd CATC USB-EL1201A USB Ethernet driver
+.Sh SYNOPSIS
+.Cd "cue* at uhub?"
+.Sh HARDWARE
+The
+.Nm
+driver supports the following adapters:
+.Pp
+.Bl -tag -width -offset indent -compact
+.It Tn Belkin F5U111
+.It Tn CATC Netmate
+.It Tn CATC Netmate II
+.El
+.Sh DESCRIPTION
+The
+.Nm
+driver provides support for USB ethernet adapters based on the Computer
+Access Technology Corporation's USB-EL1202A chipset.
+.Pp
+The USB-EL1202A supports a 512-bit multicast hash filter, single perfect
+filter entry for the station address and promiscuous mode. Packets are
+received and transmitted over separate USB bulk transfer endpoints.
+.Pp
+The CATC adapter supports only 10mbps half-duplex mode, hence there
+are no
+.Xr ifmedia 4
+modes to select.
+.Pp
+For more information on configuring this device, see
+.Xr ifconfig 8 .
+.Sh DIAGNOSTICS
+.Bl -diag
+.It "cue%d: watchdog timeout"
+A packet was queued for transmission and a transmit command was
+issued, however the device failed to acknowledge the transmission
+before a timeout expired.
+.It "cue%d: no memory for rx list"
+The driver failed to allocate an mbuf for the receiver ring.
+.El
+.Sh SEE ALSO
+.Xr arp 4 ,
+.Xr ifconfig 8 ,
+.Xr netintro 4 ,
+.Xr usb 4 
+.Sh HISTORY
+The
+.Nm
+device driver first appeared in
+.Fx 4.0 ,
+and in
+.Nx 1.5 .
+.Sh AUTHORS
+The
+.Nm
+driver was written by
+.An Bill Paul Aq wpaul%ee.columbia.edu@localhost .
diff -r ff6b7ee47f80 -r 33604c451b06 share/man/man4/kue.4
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/share/man/man4/kue.4      Sun Jan 16 10:43:36 2000 +0000
@@ -0,0 +1,106 @@
+.\" $NetBSD: kue.4,v 1.1 2000/01/16 10:43:37 augustss Exp $
+.\" Copyright (c) 1997, 1998, 1999, 2000
+.\"     Bill Paul <wpaul%ee.columbia.edu@localhost>. 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