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