xref: /netbsd-src/share/man/man4/aue.4 (revision 23c8222edbfb0f0932d88a8351d3a0cf817dfb9e)
1.\"	$NetBSD: aue.4,v 1.16 2004/01/05 05:12:54 grant 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 January 5, 2004
36.Dt AUE 4
37.Os
38.Sh NAME
39.Nm aue
40.Nd ADMtek AN986 and AN8511 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 @Home USB 10/100
51.It Tn Abocom DSB650TX
52.It Tn Billionton Systems USB100
53.It Tn Compaq HNE-200
54.It Tn Corega FEther USB-TX
55.It Tn Corega FEther USB-TXS
56.It Tn D-Link DSB-650
57.It Tn D-Link DSB-650TX
58.It Tn D-Link DSB-650TX-PNA
59.It Tn I/O DATA USB ETTX
60.It Tn Hawking UF100
61.It Tn Kingston KNU101TX
62.It Tn LinkSys USB100TX
63.It Tn LinkSys USB100H1
64.It Tn LinkSys USB10TA
65.It Tn Melco Inc. LU-ATX
66.It Tn Microsoft MN110
67.It Tn SOHOware NUB100
68.It Tn SMC 2202USB
69.It Tn SMC 2206USB/ETH
70.El
71.Sh DESCRIPTION
72The
73.Nm
74driver provides support for USB
75.Tn Ethernet
76adapters based on the ADMtek AN986 Pegasus and AN8511 Pegasus II chipsets.
77.Pp
78The Pegasus contains a 10/100
79.Tn Ethernet
80MAC with MII interface and is designed to work with both
81.Tn Ethernet
82and HomePNA transceivers.  Although designed to interface with
83100Mbps peripherals, the existing USB standard specifies a maximum
84transfer speed of 12Mbps.  Users should therefore not expect to actually
85achieve 100Mbps speeds with these devices.
86.Pp
87The Pegasus supports a 64-bit multicast hash table, single perfect
88filter entry for the station address and promiscuous mode.  Packets are
89received and transmitted over separate USB bulk transfer endpoints.
90.Pp
91The
92.Nm
93driver supports the following media types:
94.Pp
95.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
96.It autoselect
97Enable automatic selection of the media type and options.  The user can
98manually override the automatically selected mode by adding media options to
99the
100.Pa /etc/rc.conf
101file.
102.It 10baseT/UTP
103Set 10Mbps operation.  The
104.Ar mediaopt
105option can also be used to enable
106.Ar full-duplex
107operation.  Not specifying
108.Ar full duplex
109implies
110.Ar half-duplex
111mode.
112.It 100baseTX
113Set 100Mbps (fast
114.Tn Ethernet )
115operation.  The
116.Ar mediaopt
117option can also be used to enable
118.Ar full-duplex
119operation.  Not specifying
120.Ar full duplex
121implies
122.Ar half-duplex
123mode.
124.El
125.Pp
126The
127.Nm
128driver supports the following media options:
129.Pp
130.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
131.It full-duplex
132Force full duplex operation.  The interface will operate in half duplex mode
133if this media option is not specified.
134.El
135.Pp
136For more information on configuring this device, see
137.Xr ifconfig 8 .
138.Sh DIAGNOSTICS
139.Bl -diag
140.It "aue%d: watchdog timeout"
141A packet was queued for transmission and a transmit command was
142issued, however the device failed to acknowledge the transmission
143before a timeout expired.
144.It "aue%d: no memory for rx list"
145The driver failed to allocate an mbuf for the receiver ring.
146.El
147.Sh SEE ALSO
148.Xr arp 4 ,
149.Xr netintro 4 ,
150.Xr usb 4 ,
151.Xr ifconfig 8
152.Rs
153.%T ADMtek AN986 data sheet
154.%O http://www.admtek.com.tw
155.Re
156.Sh HISTORY
157The
158.Nm
159device driver first appeared in
160.Fx 4.0 ,
161and in
162.Nx 1.5 .
163.Sh AUTHORS
164The
165.Nm
166driver was written by
167.An Bill Paul
168.Aq wpaul@ee.columbia.edu .
169