xref: /netbsd-src/share/man/man4/aue.4 (revision 08c81a9c2dc8c7300e893321eb65c0925d60871c)
1.\"	$NetBSD: aue.4,v 1.9 2002/07/11 00:23:31 rh Exp $
2.\"
3.\" Copyright (c) 1997, 1998, 1999
4.\"     Bill Paul <wpaul@ee.columbia.edu>. All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"     This product includes software developed by Bill Paul.
17.\" 4. Neither the name of the author nor the names of any co-contributors
18.\"    may be used to endorse or promote products derived from this software
19.\"   without specific prior written permission.
20.\"
21.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
22.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24.\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
25.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
26.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
27.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
28.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
29.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
30.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
31.\" THE POSSIBILITY OF SUCH DAMAGE.
32.\"
33.\" FreeBSD: src/share/man/man4/aue.4,v 1.2 2000/01/07 22:18:47 wpaul Exp
34.\"
35.Dd December 25, 1999
36.Dt AUE 4
37.Os
38.Sh NAME
39.Nm aue
40.Nd ADMtek AN986 Pegasus USB Ethernet driver
41.Sh SYNOPSIS
42.Cd "aue*   at uhub?"
43.Cd "ukphy* at mii?"
44.Sh HARDWARE
45The
46.Nm
47driver supports the following adapters:
48.Pp
49.Bl -tag -width Dv -offset indent -compact
50.It Tn Abocom DSB650TX
51.It Tn Billionton Systems USB100
52.It Tn Corega FEther USB-TX
53.It Tn D-Link DSB-650
54.It Tn D-Link DSB-650TX
55.It Tn D-Link DSB-650TX-PNA
56.It Tn I/O DATA USB ETTX
57.It Tn Kingston KNU101TX
58.It Tn LinkSys USB100TX
59.It Tn LinkSys USB100H1
60.It Tn LinkSys USB10TA
61.It Tn Melco Inc. LU-ATX
62.It Tn SOHOware NUB100
63.It Tn SMC 2202USB
64.It Tn SMC 2206USB/ETH
65.El
66.Sh DESCRIPTION
67The
68.Nm
69driver provides support for USB
70.Tn Ethernet
71adapters based on the ADMtek AN986 Pegasus chipset.
72.Pp
73The Pegasus contains a 10/100
74.Tn Ethernet
75MAC with MII interface and is designed to work with both
76.Tn Ethernet
77and HomePNA transceivers.  Although designed to interface with
78100Mbps peripherals, the existing USB standard specifies a maximum
79transfer speed of 12Mbps.  Users should therefore not expect to actually
80achieve 100Mbps speeds with these devices.
81.Pp
82The Pegasus supports a 64-bit multicast hash table, single perfect
83filter entry for the station address and promiscuous mode.  Packets are
84received and transmitted over separate USB bulk transfer endpoints.
85.Pp
86The
87.Nm
88driver supports the following media types:
89.Pp
90.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
91.It autoselect
92Enable automatic selection of the media type and options.  The user can
93manually override the automatically selected mode by adding media options to
94the
95.Pa /etc/rc.conf
96file.
97.It 10baseT/UTP
98Set 10Mbps operation.  The
99.Ar mediaopt
100option can also be used to enable
101.Ar full-duplex
102operation.  Not specifying
103.Ar full duplex
104implies
105.Ar half-duplex
106mode.
107.It 100baseTX
108Set 100Mbps (fast
109.Tn Ethernet )
110operation.  The
111.Ar mediaopt
112option can also be used to enable
113.Ar full-duplex
114operation.  Not specifying
115.Ar full duplex
116implies
117.Ar half-duplex
118mode.
119.El
120.Pp
121The
122.Nm
123driver supports the following media options:
124.Pp
125.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
126.It full-duplex
127Force full duplex operation.  The interface will operate in half duplex mode
128if this media option is not specified.
129.El
130.Pp
131For more information on configuring this device, see
132.Xr ifconfig 8 .
133.Sh DIAGNOSTICS
134.Bl -diag
135.It "aue%d: watchdog timeout"
136A packet was queued for transmission and a transmit command was
137issued, however the device failed to acknowledge the transmission
138before a timeout expired.
139.It "aue%d: no memory for rx list"
140The driver failed to allocate an mbuf for the receiver ring.
141.El
142.Sh SEE ALSO
143.Xr arp 4 ,
144.Xr netintro 4 ,
145.Xr usb 4 ,
146.Xr ifconfig 8
147.Rs
148.%T ADMtek AN986 data sheet
149.%O http://www.admtek.com.tw
150.Re
151.Sh HISTORY
152The
153.Nm
154device driver first appeared in
155.Fx 4.0 ,
156and in
157.Nx 1.5 .
158.Sh AUTHORS
159The
160.Nm
161driver was written by
162.An Bill Paul
163.Aq wpaul@ee.columbia.edu .
164