xref: /freebsd/share/man/man4/aue.4 (revision 2a4a1db342263067035ce69a4017c645da63455d)
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 LinkSys USB100TX, the Billionton
50Systems USB100, the Melco Inc. LU-ATX, the D-Link DSB-650TX, the
51SMC 2202USB, and those LinkSys USB10T adapters that contain the
52AN986 Pegasus chipset.
53The LinkSys USB10T adapters that contain the AN986 Pegasus chipset
54will operate at 100Base-TX and full-duplex.
55.Pp
56The Pegasus contains a 10/100
57ethernet MAC with MII interface and is designed to work with both
58ethernet and HomePNA transceivers.
59Although designed to interface with
60100Mbps peripherals, the existing USB standard specifies a maximum
61transfer speed of 12Mbps.
62Users should therefore not expect to actually
63achieve 100Mbps speeds with these devices.
64.Pp
65The Pegasus supports a 64-bit multicast hash table, single perfect
66filter entry for the station address and promiscuous mode.
67Packets are
68received and transmitted over separate USB bulk transfer endpoints.
69.Pp
70The
71.Nm
72driver supports the following media types:
73.Pp
74.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
75.It autoselect
76Enable autoselection of the media type and options.
77The user can manually override
78the autoselected mode by adding media options to the
79.Pa /etc/rc.conf
80file.
81.It 10baseT/UTP
82Set 10Mbps operation.
83The
84.Ar mediaopt
85option can also be used to enable
86.Ar full-duplex
87operation.
88Not specifying
89.Ar full duplex
90implies
91.Ar half-duplex
92mode.
93.It 100baseTX
94Set 100Mbps (fast ethernet) 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.El
106.Pp
107The
108.Nm
109driver supports the following media options:
110.Pp
111.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
112.It full-duplex
113Force full duplex operation.
114The interface will operate in
115half duplex mode if this media option is not specified.
116.El
117.Pp
118For more information on configuring this device, see
119.Xr ifconfig 8 .
120.Sh DIAGNOSTICS
121.Bl -diag
122.It "aue%d: watchdog timeout"
123A packet was queued for transmission and a transmit command was
124issued, however the device failed to acknowledge the transmission
125before a timeout expired.
126.It "aue%d: no memory for rx list"
127The driver failed to allocate an mbuf for the receiver ring.
128.El
129.Sh SEE ALSO
130.Xr arp 4 ,
131.Xr netintro 4 ,
132.Xr ng_ether 4 ,
133.Xr ifconfig 8
134.Rs
135.%T ADMtek AN986 data sheet
136.%O http://www.admtek.com.tw
137.Re
138.Sh HISTORY
139The
140.Nm
141device driver first appeared in
142.Fx 4.0 .
143.Sh AUTHORS
144The
145.Nm
146driver was written by
147.An Bill Paul Aq wpaul@ee.columbia.edu .
148