xref: /freebsd/share/man/man4/aue.4 (revision 86e3186efab0cee149e8a2efdef4bb75f1dade11)
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 kernel 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
52.Nm
53driver 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.Pp
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.Pp
122.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
123.It full-duplex
124Force full duplex operation.
125The interface will operate in
126half duplex mode if this media option is not specified.
127.El
128.Pp
129For more information on configuring this device, see
130.Xr ifconfig 8 .
131.Sh HARDWARE
132Adapters supported by the
133.Nm
134driver include:
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
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 arp 4 ,
188.Xr miibus 4 ,
189.Xr netintro 4 ,
190.Xr ng_ether 4 ,
191.Xr ifconfig 8
192.Rs
193.%T ADMtek AN986 data sheet
194.%O http://www.admtek.com.tw
195.Re
196.Sh HISTORY
197The
198.Nm
199device driver first appeared in
200.Fx 4.0 .
201.Sh AUTHORS
202The
203.Nm
204driver was written by
205.An Bill Paul Aq wpaul@ee.columbia.edu .
206