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