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