xref: /freebsd/share/man/man4/aue.4 (revision 328110da2661a8841f12000b99fea27ceacdd5b2)
1.\"
2.\" SPDX-License-Identifier: BSD-4-Clause
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.Dd May 26, 2025
35.Dt AUE 4
36.Os
37.Sh NAME
38.Nm aue
39.Nd ADMtek AN986 Pegasus USB Fast Ethernet driver
40.Sh SYNOPSIS
41To compile this driver into the kernel,
42place the following lines in your
43kernel configuration file:
44.Bd -ragged -offset indent
45.Cd "device uhci"
46.Cd "device ohci"
47.Cd "device usb"
48.Cd "device miibus"
49.Cd "device uether"
50.Cd "device aue"
51.Ed
52.Pp
53Alternatively, to load the driver as a
54module at boot time, place the following line in
55.Xr loader.conf 5 :
56.Bd -literal -offset indent
57if_aue_load="YES"
58.Ed
59.Sh DESCRIPTION
60The
61.Nm
62driver provides support for USB Fast Ethernet adapters based on the
63ADMtek AN986 Pegasus chipset.
64.Pp
65The LinkSys USB10T adapters that contain the AN986 Pegasus chipset
66will operate at 100Base-TX and full-duplex.
67.Pp
68The Pegasus contains a 10/100
69Ethernet MAC with MII interface and is designed to work with both
70Ethernet and HomePNA transceivers.
71Although designed to interface with
72100Mbps peripherals, the existing USB standard specifies a maximum
73transfer speed of 12Mbps.
74Users should therefore not expect to actually
75achieve 100Mbps speeds with these devices.
76.Pp
77The Pegasus supports a 64-bit multicast hash table, single perfect
78filter entry for the station address and promiscuous mode.
79Packets are
80received and transmitted over separate USB bulk transfer endpoints.
81.Pp
82The
83.Nm
84driver supports the following media types:
85.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
86.It autoselect
87Enable autoselection of the media type and options.
88The user can manually override
89the autoselected mode by adding media options to the
90.Pa /etc/rc.conf
91file.
92.It 10baseT/UTP
93Set 10Mbps operation.
94The
95.Ar mediaopt
96option can also be used to enable
97.Ar full-duplex
98operation.
99Not specifying
100.Ar full duplex
101implies
102.Ar half-duplex
103mode.
104.It 100baseTX
105Set 100Mbps (Fast Ethernet) operation.
106The
107.Ar mediaopt
108option can also be used to enable
109.Ar full-duplex
110operation.
111Not specifying
112.Ar full duplex
113implies
114.Ar half-duplex
115mode.
116.El
117.Pp
118The
119.Nm
120driver supports the following media options:
121.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
122.It full-duplex
123Force full duplex operation.
124The interface will operate in
125half duplex mode if this media option is not specified.
126.El
127.Pp
128For more information on configuring this device, see
129.Xr ifconfig 8 .
130.Sh HARDWARE
131The
132.Nm
133driver supports the following USB Fast Ethernet adapters based on the
134ADMtek AN986 Pegasus chipset:
135.Pp
136.Bl -bullet -compact
137.It
138Abocom UFE1000, DSB650TX_NA
139.It
140Accton USB320-EC, SpeedStream
141.It
142ADMtek AN986, AN8511
143.It
144Billionton USB100, USB100LP, USB100EL, USBE100
145.It
146Corega Ether FEther USB-T, FEther USB-TX, FEther USB-TXS
147.It
148D-Link DSB-650, DSB-650TX, DSB-650TX-PNA
149.It
150Elecom LD-USBL/TX
151.It
152Elsa Microlink USB2Ethernet
153.It
154HP hn210e
155.It
156I-O Data USB ETTX
157.It
158Kingston KNU101TX
159.It
160LinkSys USB10T adapters that contain the AN986 Pegasus chipset,
161USB10TA, USB10TX, USB100TX, USB100H1
162.It
163MELCO LUA-TX, LUA2-TX
164.It
165Netgear FA101
166.It
167Planex UE-200TX
168.It
169Sandberg USB to Network Link (model number 133-06)
170.It
171Siemens Speedstream
172.It
173SmartBridges smartNIC
174.It
175SMC 2202USB
176.It
177SOHOware NUB100
178.El
179.Sh DIAGNOSTICS
180.Bl -diag
181.It "aue%d: watchdog timeout"
182A packet was queued for transmission and a transmit command was
183issued, however the device failed to acknowledge the transmission
184before a timeout expired.
185.It "aue%d: no memory for rx list"
186The driver failed to allocate an mbuf for the receiver ring.
187.El
188.Sh SEE ALSO
189.Xr altq 4 ,
190.Xr arp 4 ,
191.Xr miibus 4 ,
192.Xr netintro 4 ,
193.Xr ng_ether 4 ,
194.Xr ifconfig 8
195.Rs
196.%T ADMtek AN986 data sheet
197.%U http://www.admtek.com.tw
198.Re
199.Sh HISTORY
200The
201.Nm
202device driver first appeared in
203.Fx 4.0 .
204.Sh AUTHORS
205The
206.Nm
207driver was written by
208.An Bill Paul Aq Mt wpaul@ee.columbia.edu .
209