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