xref: /freebsd/share/man/man4/aue.4 (revision 3642298923e528d795e3a30ec165d2b469e28b40)
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 July 16, 2005
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 support for the
41.Nm
42driver into your kernel, place 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 aue"
50.Ed
51.Pp
52Alternatively, to load the
53.Nm
54driver 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 Ethernet adapters based on the ADMtek
63AN986 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.Pp
86.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
87.It autoselect
88Enable autoselection of the media type and options.
89The user can manually override
90the autoselected mode by adding media options to the
91.Pa /etc/rc.conf
92file.
93.It 10baseT/UTP
94Set 10Mbps operation.
95The
96.Ar mediaopt
97option can also be used to enable
98.Ar full-duplex
99operation.
100Not specifying
101.Ar full duplex
102implies
103.Ar half-duplex
104mode.
105.It 100baseTX
106Set 100Mbps (Fast Ethernet) operation.
107The
108.Ar mediaopt
109option can also be used to enable
110.Ar full-duplex
111operation.
112Not specifying
113.Ar full duplex
114implies
115.Ar half-duplex
116mode.
117.El
118.Pp
119The
120.Nm
121driver supports the following media options:
122.Pp
123.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
124.It full-duplex
125Force full duplex operation.
126The interface will operate in
127half duplex mode if this media option is not specified.
128.El
129.Pp
130For more information on configuring this device, see
131.Xr ifconfig 8 .
132.Sh HARDWARE
133Adapters supported by the
134.Nm
135driver include:
136.Pp
137.Bl -bullet -compact
138.It
139Abocom UFE1000, DSB650TX_NA
140.It
141Accton USB320-EC, SpeedStream
142.It
143ADMtek AN986, AN8511
144.It
145Billionton USB100, USB100LP, USB100EL, USBE100
146.It
147Corega Ether FEther USB-T, FEther USB-TX, FEther USB-TXS
148.It
149D-Link DSB-650, DSB-650TX, DSB-650TX-PNA
150.It
151Elecom LD-USBL/TX
152.It
153Elsa Microlink USB2Ethernet
154.It
155HP hn210e
156.It
157I-O Data USB ETTX
158.It
159Kingston KNU101TX
160.It
161LinkSys USB10T adapters that contain the AN986 Pegasus chipset,
162USB10TA, USB10TX, USB100TX, USB100H1
163.It
164MELCO LUA-TX, LUA2-TX
165.It
166Planex UE-200TX
167.It
168Sandberg USB to Network Link (model number 133-06)
169.It
170Siemens Speedstream
171.It
172SmartBridges smartNIC
173.It
174SMC 2202USB
175.It
176SOHOware NUB100
177.El
178.Sh DIAGNOSTICS
179.Bl -diag
180.It "aue%d: watchdog timeout"
181A packet was queued for transmission and a transmit command was
182issued, however the device failed to acknowledge the transmission
183before a timeout expired.
184.It "aue%d: no memory for rx list"
185The driver failed to allocate an mbuf for the receiver ring.
186.El
187.Sh SEE ALSO
188.Xr arp 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 wpaul@ee.columbia.edu .
207