usb4bsd: Port aue(4), cue(4), ipheth(4) and kue(4) USB ethernet drivers.
[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: head/share/man/man4/aue.4 267938 2014-06-26 21:46:14Z bapt $
32 .\"
33 .Dd November 10, 2014
34 .Dt AUE 4
35 .Os
36 .Sh NAME
37 .Nm aue
38 .Nd ADMtek AN986 Pegasus USB Ethernet driver
39 .Sh SYNOPSIS
40 To compile this driver into the kernel,
41 place the following lines in your
42 kernel configuration file:
43 .Bd -ragged -offset indent
44 .Cd "device uhci"
45 .Cd "device ohci"
46 .Cd "device usb"
47 .Cd "device miibus"
48 .Cd "device aue"
49 .Ed
50 .Pp
51 Alternatively, to load the driver as a
52 module at boot time, place the following line in
53 .Xr loader.conf 5 :
54 .Bd -literal -offset indent
55 if_aue_load="YES"
56 .Ed
57 .Sh DESCRIPTION
58 The
59 .Nm
60 driver provides support for USB Ethernet adapters based on the ADMtek
61 AN986 Pegasus chipset.
62 .Pp
63 The LinkSys USB10T adapters that contain the AN986 Pegasus chipset
64 will operate at 100Base-TX and full-duplex.
65 .Pp
66 The Pegasus contains a 10/100
67 Ethernet MAC with MII interface and is designed to work with both
68 Ethernet and HomePNA transceivers.
69 Although designed to interface with
70 100Mbps peripherals, the existing USB standard specifies a maximum
71 transfer speed of 12Mbps.
72 Users should therefore not expect to actually
73 achieve 100Mbps speeds with these devices.
74 .Pp
75 The Pegasus supports a 64-bit multicast hash table, single perfect
76 filter entry for the station address and promiscuous mode.
77 Packets are
78 received and transmitted over separate USB bulk transfer endpoints.
79 .Pp
80 The
81 .Nm
82 driver supports the following media types:
83 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
84 .It autoselect
85 Enable autoselection of the media type and options.
86 The user can manually override
87 the autoselected mode by adding media options to the
88 .Pa /etc/rc.conf
89 file.
90 .It 10baseT/UTP
91 Set 10Mbps operation.
92 The
93 .Ar mediaopt
94 option can also be used to enable
95 .Ar full-duplex
96 operation.
97 Not specifying
98 .Ar full duplex
99 implies
100 .Ar half-duplex
101 mode.
102 .It 100baseTX
103 Set 100Mbps (Fast Ethernet) operation.
104 The
105 .Ar mediaopt
106 option can also be used to enable
107 .Ar full-duplex
108 operation.
109 Not specifying
110 .Ar full duplex
111 implies
112 .Ar half-duplex
113 mode.
114 .El
115 .Pp
116 The
117 .Nm
118 driver supports the following media options:
119 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
120 .It full-duplex
121 Force full duplex operation.
122 The interface will operate in
123 half duplex mode if this media option is not specified.
124 .El
125 .Pp
126 For more information on configuring this device, see
127 .Xr ifconfig 8 .
128 .Sh HARDWARE
129 Adapters supported by the
130 .Nm
131 driver include:
132 .Pp
133 .Bl -bullet -compact
134 .It
135 Abocom UFE1000, DSB650TX_NA
136 .It
137 Accton USB320-EC, SpeedStream
138 .It
139 ADMtek AN986, AN8511
140 .It
141 Billionton USB100, USB100LP, USB100EL, USBE100
142 .It
143 Corega Ether FEther USB-T, FEther USB-TX, FEther USB-TXS
144 .It
145 D-Link DSB-650, DSB-650TX, DSB-650TX-PNA
146 .It
147 Elecom LD-USBL/TX
148 .It
149 Elsa Microlink USB2Ethernet
150 .It
151 HP hn210e
152 .It
153 I-O Data USB ETTX
154 .It
155 Kingston KNU101TX
156 .It
157 LinkSys USB10T adapters that contain the AN986 Pegasus chipset,
158 USB10TA, USB10TX, USB100TX, USB100H1
159 .It
160 MELCO LUA-TX, LUA2-TX
161 .It
162 Netgear FA101
163 .It
164 Planex UE-200TX
165 .It
166 Sandberg USB to Network Link (model number 133-06)
167 .It
168 Siemens Speedstream
169 .It
170 SmartBridges smartNIC
171 .It
172 SMC 2202USB
173 .It
174 SOHOware NUB100
175 .El
176 .Sh DIAGNOSTICS
177 .Bl -diag
178 .It "aue%d: watchdog timeout"
179 A packet was queued for transmission and a transmit command was
180 issued, however the device failed to acknowledge the transmission
181 before a timeout expired.
182 .It "aue%d: no memory for rx list"
183 The driver failed to allocate an mbuf for the receiver ring.
184 .El
185 .Sh SEE ALSO
186 .Xr altq 4 ,
187 .Xr arp 4 ,
188 .Xr ifmedia 4 ,
189 .Xr miibus 4 ,
190 .Xr netintro 4 ,
191 .Xr ng_ether 4 ,
192 .Xr ifconfig 8
193 .Rs
194 .%T ADMtek AN986 data sheet
195 .%O http://www.admtek.com.tw
196 .Re
197 .Sh HISTORY
198 The
199 .Nm
200 device driver first appeared in
201 .Fx 4.0 .
202 .Sh AUTHORS
203 The
204 .Nm
205 driver was written by
206 .An Bill Paul Aq Mt wpaul@ee.columbia.edu .