share/man/man4/axe.4

   1 .\" Copyright (c) 1997, 1998, 1999, 2000-2003
   2 .\"     Bill Paul <wpaul@windriver.com>. 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/axe.4,v 1.12 2005/10/07 02:32:15 trhodes Exp $
  32 .\" $DragonFly: src/share/man/man4/axe.4,v 1.4 2007/02/25 12:03:07 swildner Exp $
  33 .\"
  34 .Dd July 16, 2005
  35 .Dt AXE 4
  36 .Os
  37 .Sh NAME
  38 .Nm axe
  39 .Nd "ASIX Electronics AX88172 USB Ethernet driver"
  40 .Sh SYNOPSIS
  41 To compile this driver into the kernel,
  42 place the following lines in your
  43 kernel configuration file:
  44 .Bd -ragged -offset indent
  45 .Cd "device ehci"
  46 .Cd "device uhci"
  47 .Cd "device ohci"
  48 .Cd "device usb"
  49 .Cd "device miibus"
  50 .Cd "device axe"
  51 .Ed
  52 .Pp
  53 Alternatively, to load the driver as a
  54 module at boot time, place the following line in
  55 .Xr loader.conf 5 :
  56 .Bd -literal -offset indent
  57 if_axe_load="YES"
  58 .Ed
  59 .Sh DESCRIPTION
  60 The
  61 .Nm
  62 driver provides support for USB Ethernet adapters based on the ASIX
  63 Electronics AX88172 USB 2.0 chipset.
  64 .Pp
  65 The AX88172 is a USB 2.0 device which contains a 10/100
  66 Ethernet MAC with MII interface and is designed to work with both
  67 Ethernet and HomePNA transceivers.
  68 The AX88172 will operate with
  69 both USB 1.x and USB 2.0 controllers, however performance with 1.x
  70 controllers will be limited since the USB 1.x standard specifies a
  71 maximum transfer speed of 12Mbps.
  72 Users with USB 1.x controllers should therefore not expect to actually
  73 achieve 100Mbps speeds with these devices.
  74 .Pp
  75 The AX88172 supports a 64-bit multicast hash table, single perfect
  76 filter entry for the station address, all-multicast mode 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 ".Cm 10baseT/UTP"
  84 .It Cm 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 Cm 10baseT/UTP
  91 Set 10Mbps operation.
  92 The
  93 .Cm mediaopt
  94 option can also be used to enable
  95 .Cm full-duplex
  96 operation.
  97 Not specifying
  98 .Cm full-duplex
  99 implies
 100 .Cm half-duplex
 101 mode.
 102 .It Cm 100baseTX
 103 Set 100Mbps (Fast Ethernet) operation.
 104 The
 105 .Cm mediaopt
 106 option can also be used to enable
 107 .Cm full-duplex
 108 operation.
 109 Not specifying
 110 .Cm full-duplex
 111 implies
 112 .Cm half-duplex
 113 mode.
 114 .El
 115 .Pp
 116 The
 117 .Nm
 118 driver supports the following media options:
 119 .Bl -tag -width ".Cm 10baseT/UTP"
 120 .It Cm 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 The
 130 .Nm
 131 driver supports ASIX Electronics AX88172 based USB Ethernet
 132 adapters including:
 133 .Pp
 134 .Bl -bullet -compact
 135 .It
 136 Buffalo (Melco Inc.) LUA-U2-KTX
 137 .It
 138 D-Link DUBE100
 139 .It
 140 LinkSys USB200M
 141 .It
 142 Netgear FA120
 143 .It
 144 Sitecom LN-029
 145 .It
 146 System TALKS Inc.\& SGC-X2UL
 147 .El
 148 .Sh DIAGNOSTICS
 149 .Bl -diag
 150 .It "axe%d: watchdog timeout"
 151 A packet was queued for transmission and a transmit command was
 152 issued, however the device failed to acknowledge the transmission
 153 before a timeout expired.
 154 .It "axe%d: no memory for rx list"
 155 The driver failed to allocate an mbuf for the receiver ring.
 156 .El
 157 .Sh SEE ALSO
 158 .Xr arp 4 ,
 159 .Xr ifmedia 4 ,
 160 .Xr miibus 4 ,
 161 .Xr netintro 4 ,
 162 .Xr ng_ether 4 ,
 163 .Xr ifconfig 8
 164 .Rs
 165 .%T "ASIX AX88172 data sheet"
 166 .%O http://www.asix.com.tw
 167 .Re
 168 .Sh HISTORY
 169 The
 170 .Nm
 171 device driver first appeared in
 172 .Fx 5.0 .
 173 .Sh AUTHORS
 174 The
 175 .Nm
 176 driver was written by
 177 .An Bill Paul Aq wpaul@windriver.com .