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