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