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