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