xref: /openbsd/share/man/man4/aue.4 (revision 2851c19f)
1.\"	$OpenBSD: aue.4,v 1.17 2003/07/09 13:26:20 jmc Exp $
2.\"	$NetBSD: aue.4,v 1.9 2002/07/11 00:23:31 rh 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 / ADM8511 Pegasus family USB Ethernet driver
42.Sh SYNOPSIS
43.Cd "aue*   at uhub? port ?"
44.Cd "ukphy* at mii?"
45.Sh DESCRIPTION
46The
47.Nm
48driver provides support for USB Ethernet adapters based on the ADMtek
49AN986 ("Pegasus") and ADM8511 ("Pegasus II") chipsets.
50This includes the following adapters:
51.Pp
52.Bl -tag -width Ds -offset indent -compact
53.It Tn 3Com 3c460b
54.It Tn Abocom UFE1000
55.It Tn Abocom DSB650TX
56.It Tn Accton USB320-EC
57.It Tn Accton SpeedStream Ethernet
58.It Tn Admtek Pegasus
59.It Tn Admtek Pegasus II
60.It Tn Billionton Systems USB100
61.It Tn Corega FEther USB-TX
62.It Tn D-Link DSB-650
63.It Tn D-Link DSB-650TX
64.It Tn D-Link DSB-650TX-PNA
65.It Tn Elecom LD-USB
66.It Tn Elsa Microlink USB2Ethernet
67.It Tn I/O DATA USB ETTX
68.It Tn Kingston KNU101TX
69.It Tn LinkSys USB100TX
70.It Tn LinkSys USB100H1
71.It Tn LinkSys USB10TA
72.It Tn Melco Inc. LUA-TX
73.It Tn Netgear FA101
74.It Tn Siemens SpeedStream USB
75.It Tn Smartbridges smartNIC 2
76.It Tn SMC 2202USB
77.It Tn SMC EZ Connect USB
78.It Tn SOHOware NUB100
79.El
80.Pp
81The Pegasus family of chipsets contain a 10/100
82.Tn Ethernet
83MAC with an MII interface and are designed to work with both
84.Tn Ethernet
85and HomePNA transceivers.
86Although the chipsets are designed to interface with
87100Mbps peripherals, the USB 1.x standards specify a maximum
88transfer speed of 12Mbps.
89Users should therefore not expect to actually
90achieve 100Mbps speeds with these devices.
91.Pp
92The Pegasus chipsets support a 64-bit multicast hash table, single perfect
93filter entry for the station address and promiscuous mode.
94Packets are
95received and transmitted over separate USB bulk transfer endpoints.
96.Pp
97The
98.Nm
99driver supports the following media types:
100.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
101.It autoselect
102Enable autoselection of the media type and options.
103The user can manually override
104the autoselected mode by adding media options to the appropriate
105.Xr hostname.if 5
106file.
107.It 10baseT
108Set 10Mbps operation.
109The
110.Ar mediaopt
111option can also be used to enable
112.Ar full-duplex
113operation.
114Not specifying
115.Ar full duplex
116implies
117.Ar half-duplex
118mode.
119.It 100baseTX
120Set 100Mbps (Fast
121.Tn Ethernet )
122operation.
123The
124.Ar mediaopt
125option can also be used to enable
126.Ar full-duplex
127operation.
128Not specifying
129.Ar full duplex
130implies
131.Ar half-duplex
132mode.
133.El
134.Pp
135The
136.Nm
137driver supports the following media options:
138.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
139.It full-duplex
140Force full duplex operation.
141The interface will operate in
142half duplex mode if this media option is not specified.
143.El
144.Pp
145For more information on configuring this device, see
146.Xr ifconfig 8 .
147.Sh DIAGNOSTICS
148.Bl -diag
149.It "aue%d: watchdog timeout"
150A packet was queued for transmission and a transmit command was
151issued, however the device failed to acknowledge the transmission
152before a timeout expired.
153.It "aue%d: no memory for rx list"
154The driver failed to allocate an mbuf for the receiver ring.
155.El
156.Sh SEE ALSO
157.Xr arp 4 ,
158.Xr ifmedia 4 ,
159.Xr intro 4 ,
160.Xr netintro 4 ,
161.Xr usb 4 ,
162.Xr hostname.if 5 ,
163.Xr ifconfig 8
164.Rs
165.%T ADMtek AN986 and ADM8511 data sheets
166.%O http://www.admtek.com.tw
167.Re
168.Sh HISTORY
169The
170.Nm
171device driver first appeared in
172.Fx 4.0 .
173.Ox
174support was added in
175.Ox 2.7 .
176.Sh AUTHORS
177The
178.Nm
179driver was written by
180.An Bill Paul Aq wpaul@ee.columbia.edu
181and ported to
182.Ox
183by
184.An Aaron Campbell Aq aaron@openbsd.org .
185