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.
  57 Although designed to interface with
  58 100Mbps peripherals, the existing USB standard specifies a maximum
  59 transfer speed of 12Mbps.
  60 Users should therefore not expect to actually
  61 achieve 100Mbps speeds with these devices.
  62 .Pp
  63 The Pegasus supports a 64-bit multicast hash table, single perfect
  64 filter entry for the station address and promiscuous mode.
  65 Packets are
  66 received and transmitted over separate USB bulk transfer endpoints.
  67 .Pp
  68 The
  69 .Nm
  70 driver supports the following media types:
  71 .Pp
  72 .Bl -tag -width xxxxxxxxxxxxxxxxxxxx
  73 .It autoselect
  74 Enable autoselection of the media type and options.
  75 The user can manually override
  76 the autoselected mode by adding media options to the
  77 .Pa /etc/rc.conf
  78 file.
  79 .It 10baseT/UTP
  80 Set 10Mbps operation.
  81 The
  82 .Ar mediaopt
  83 option can also be used to enable
  84 .Ar full-duplex
  85 operation.
  86 Not specifying
  87 .Ar full duplex
  88 implies
  89 .Ar half-duplex
  90 mode.
  91 .It 100baseTX
  92 Set 100Mbps (fast ethernet) 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 .El
 104 .Pp
 105 The
 106 .Nm
 107 driver supports the following media options:
 108 .Pp
 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 netintro 4 ,
 130 .Xr ifconfig 8 ,
 131 .Xr ng_ether 8
 132 .Rs
 133 .%T ADMtek AN986 data sheet
 134 .%O http://www.admtek.com.tw
 135 .Re
 136 .Sh HISTORY
 137 The
 138 .Nm
 139 device driver first appeared in
 140 .Fx 4.0 .
 141 .Sh AUTHORS
 142 The
 143 .Nm
 144 driver was written by
 145 .An Bill Paul Aq wpaul@ee.columbia.edu .