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