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$
  32 .\"
  33 .Dd October 7, 2006
  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 .Pp
  84 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  85 .It autoselect
  86 Enable autoselection of the media type and options.
  87 The user can manually override
  88 the autoselected mode by adding media options to the
  89 .Pa /etc/rc.conf
  90 file.
  91 .It 10baseT/UTP
  92 Set 10Mbps operation.
  93 The
  94 .Ar mediaopt
  95 option can also be used to enable
  96 .Ar full-duplex
  97 operation.
  98 Not specifying
  99 .Ar full duplex
 100 implies
 101 .Ar half-duplex
 102 mode.
 103 .It 100baseTX
 104 Set 100Mbps (Fast Ethernet) operation.
 105 The
 106 .Ar mediaopt
 107 option can also be used to enable
 108 .Ar full-duplex
 109 operation.
 110 Not specifying
 111 .Ar full duplex
 112 implies
 113 .Ar half-duplex
 114 mode.
 115 .El
 116 .Pp
 117 The
 118 .Nm
 119 driver supports the following media options:
 120 .Pp
 121 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 122 .It full-duplex
 123 Force full duplex operation.
 124 The interface will operate in
 125 half duplex mode if this media option is not specified.
 126 .El
 127 .Pp
 128 For more information on configuring this device, see
 129 .Xr ifconfig 8 .
 130 .Sh HARDWARE
 131 Adapters supported by the
 132 .Nm
 133 driver include:
 134 .Pp
 135 .Bl -bullet -compact
 136 .It
 137 Abocom UFE1000, DSB650TX_NA
 138 .It
 139 Accton USB320-EC, SpeedStream
 140 .It
 141 ADMtek AN986, AN8511
 142 .It
 143 Billionton USB100, USB100LP, USB100EL, USBE100
 144 .It
 145 Corega Ether FEther USB-T, FEther USB-TX, FEther USB-TXS
 146 .It
 147 D-Link DSB-650, DSB-650TX, DSB-650TX-PNA
 148 .It
 149 Elecom LD-USBL/TX
 150 .It
 151 Elsa Microlink USB2Ethernet
 152 .It
 153 HP hn210e
 154 .It
 155 I-O Data USB ETTX
 156 .It
 157 Kingston KNU101TX
 158 .It
 159 LinkSys USB10T adapters that contain the AN986 Pegasus chipset,
 160 USB10TA, USB10TX, USB100TX, USB100H1
 161 .It
 162 MELCO LUA-TX, LUA2-TX
 163 .It
 164 Netgear FA101
 165 .It
 166 Planex UE-200TX
 167 .It
 168 Sandberg USB to Network Link (model number 133-06)
 169 .It
 170 Siemens Speedstream
 171 .It
 172 SmartBridges smartNIC
 173 .It
 174 SMC 2202USB
 175 .It
 176 SOHOware NUB100
 177 .El
 178 .Sh DIAGNOSTICS
 179 .Bl -diag
 180 .It "aue%d: watchdog timeout"
 181 A packet was queued for transmission and a transmit command was
 182 issued, however the device failed to acknowledge the transmission
 183 before a timeout expired.
 184 .It "aue%d: no memory for rx list"
 185 The driver failed to allocate an mbuf for the receiver ring.
 186 .El
 187 .Sh SEE ALSO
 188 .Xr altq 4 ,
 189 .Xr arp 4 ,
 190 .Xr miibus 4 ,
 191 .Xr netintro 4 ,
 192 .Xr ng_ether 4 ,
 193 .Xr ifconfig 8
 194 .Rs
 195 .%T ADMtek AN986 data sheet
 196 .%O http://www.admtek.com.tw
 197 .Re
 198 .Sh HISTORY
 199 The
 200 .Nm
 201 device driver first appeared in
 202 .Fx 4.0 .
 203 .Sh AUTHORS
 204 The
 205 .Nm
 206 driver was written by
 207 .An Bill Paul Aq wpaul@ee.columbia.edu .