xref: /freebsd/share/man/man4/aue.4 (revision a3d2cb099811709ffafc683980fe0f9e04632419)
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, including the following:
50.Pp
51.Bl -bullet -compact
52.It
53Abocom UFE1000, DSB650TX_NA
54.It
55Accton USB320-EC, SpeedStream
56.It
57ADMtek AN986, AN8511
58.It
59Billionton USB100, USB100LP, USB100EL, USBE100
60.It
61Corega Ether FEther USB-T, FEther USB-TX, FEther USB-TXS
62.It
63D-Link DSB-650, DSB-650TX, DSB-650TX-PNA
64.It
65Elecom LD-USBL/TX
66.It
67Elsa Microlink USB2Ethernet
68.It
69HP hn210e
70.It
71I-O Data USB ETTX
72.It
73Kingston KNU101TX
74.It
75LinkSys USB10T adapters that contain the AN986 Pegasus chipset,
76USB10TA, USB10TX, USB100TX, USB100H1
77.It
78MELCO LUA-TX, LUA2-TX
79.It
80Planex UE-200TX
81.It
82Siemens Speedstream
83.It
84SmartBridges smartNIC
85.It
86SMC 2202USB
87.It
88SOHOware NUB100
89.El
90.Pp
91The LinkSys USB10T adapters that contain the AN986 Pegasus chipset
92will operate at 100Base-TX and full-duplex.
93.Pp
94The Pegasus contains a 10/100
95ethernet MAC with MII interface and is designed to work with both
96ethernet and HomePNA transceivers.
97Although designed to interface with
98100Mbps peripherals, the existing USB standard specifies a maximum
99transfer speed of 12Mbps.
100Users should therefore not expect to actually
101achieve 100Mbps speeds with these devices.
102.Pp
103The Pegasus supports a 64-bit multicast hash table, single perfect
104filter entry for the station address and promiscuous mode.
105Packets are
106received and transmitted over separate USB bulk transfer endpoints.
107.Pp
108The
109.Nm
110driver supports the following media types:
111.Pp
112.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
113.It autoselect
114Enable autoselection of the media type and options.
115The user can manually override
116the autoselected mode by adding media options to the
117.Pa /etc/rc.conf
118file.
119.It 10baseT/UTP
120Set 10Mbps operation.
121The
122.Ar mediaopt
123option can also be used to enable
124.Ar full-duplex
125operation.
126Not specifying
127.Ar full duplex
128implies
129.Ar half-duplex
130mode.
131.It 100baseTX
132Set 100Mbps (fast ethernet) operation.
133The
134.Ar mediaopt
135option can also be used to enable
136.Ar full-duplex
137operation.
138Not specifying
139.Ar full duplex
140implies
141.Ar half-duplex
142mode.
143.El
144.Pp
145The
146.Nm
147driver supports the following media options:
148.Pp
149.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
150.It full-duplex
151Force full duplex operation.
152The interface will operate in
153half duplex mode if this media option is not specified.
154.El
155.Pp
156For more information on configuring this device, see
157.Xr ifconfig 8 .
158.Sh DIAGNOSTICS
159.Bl -diag
160.It "aue%d: watchdog timeout"
161A packet was queued for transmission and a transmit command was
162issued, however the device failed to acknowledge the transmission
163before a timeout expired.
164.It "aue%d: no memory for rx list"
165The driver failed to allocate an mbuf for the receiver ring.
166.El
167.Sh SEE ALSO
168.Xr arp 4 ,
169.Xr miibus 4 ,
170.Xr netintro 4 ,
171.Xr ng_ether 4 ,
172.Xr ifconfig 8
173.Rs
174.%T ADMtek AN986 data sheet
175.%O http://www.admtek.com.tw
176.Re
177.Sh HISTORY
178The
179.Nm
180device driver first appeared in
181.Fx 4.0 .
182.Sh AUTHORS
183The
184.Nm
185driver was written by
186.An Bill Paul Aq wpaul@ee.columbia.edu .
187