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