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 December 25, 1999
  34 .Dt AUE 4 i386
  35 .Os FreeBSD
  36 .Sh NAME
  37 .Nm aue
  38 .Nd
  39 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 and the
  52 SMC 2202USB.
  53 .Pp
  54 The Pegasus contains a 10/100
  55 ethernet MAC with MII interface and is designed to work with both
  56 ethernet and HomePNA transceivers. Although designed to interface with
  57 100Mbps peripherals, the existing USB standard specifies a maximum
  58 transfer speed of 12Mbps. Users should therefore not expect to actually
  59 achieve 100Mbps speeds with these devices.
  60 .Pp
  61 The Pegasus supports a 64-bit multicast hash table, single perfect
  62 filter entry for the station address and promiscuous mode. Packets are
  63 received and transmitted over separate USB bulk transfer endpoints.
  64 .Pp
  65 The
  66 .Nm
  67 driver supports the following media types:
  68 .Pp
  69 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  70 .It autoselect
  71 Enable autoselection of the media type and options.
  72 The user can manually override
  73 the autoselected mode by adding media options to the
  74 .Pa /etc/rc.conf
  75 file.
  76 .It 10baseT/UTP
  77 Set 10Mbps operation. The
  78 .Ar mediaopt
  79 option can also be used to enable
  80 .Ar full-duplex
  81 operation. Not specifying
  82 .Ar full duplex
  83 implies
  84 .Ar half-duplex
  85 mode.
  86 .It 100baseTX
  87 Set 100Mbps (fast ethernet) operation. The
  88 .Ar mediaopt
  89 option can also be used to enable
  90 .Ar full-duplex
  91 operation. Not specifying
  92 .Ar full duplex
  93 implies
  94 .Ar half-duplex
  95 mode.
  96 .El
  97 .Pp
  98 The
  99 .Nm
 100 driver supports the following media options:
 101 .Pp
 102 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
 103 .It full-duplex
 104 Force full duplex operation. The interface will operate in
 105 half duplex mode if this media option is not specified.
 106 .El
 107 .Pp
 108 For more information on configuring this device, see
 109 .Xr ifconfig 8 .
 110 .Sh DIAGNOSTICS
 111 .Bl -diag
 112 .It "aue%d: watchdog timeout"
 113 A packet was queued for transmission and a transmit command was
 114 issued, however the device failed to acknowledge the transmission
 115 before a timeout expired.
 116 .It "aue%d: no memory for rx list"
 117 The 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
 129 The
 130 .Nm
 131 device driver first appeared in
 132 .Fx 4.0 .
 133 .Sh AUTHORS
 134 The
 135 .Nm
 136 driver was written by
 137 .An Bill Paul Aq wpaul@ee.columbia.edu .
 138 .Sh BUGS
 139 For some reason, outgoing bulk transfers (i.e. packet transmissions)
 140 fail if the transfer is exactly a multiple of 64 bytes in size. The
 141 .Nm
 142 driver works around this by padding such transfers up by one additional
 143 byte. This does not affect connectivity, however it does cause packets
 144 to occasionaly appear on the wire with one additional byte for no good
 145 reason. It is not known if this bug is due to a problem with Pegasus
 146 chip itself or some peculiarity of the underlying USB support.