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 .\"
  33 .Dd July 16, 2005
  34 .Dt AXE 4
  35 .Os
  36 .Sh NAME
  37 .Nm axe
  38 .Nd "ASIX Electronics AX88172 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 ehci"
  45 .Cd "device uhci"
  46 .Cd "device ohci"
  47 .Cd "device usb"
  48 .Cd "device miibus"
  49 .Cd "device axe"
  50 .Ed
  51 .Pp
  52 Alternatively, to load the driver as a
  53 module at boot time, place the following line in
  54 .Xr loader.conf 5 :
  55 .Bd -literal -offset indent
  56 if_axe_load="YES"
  57 .Ed
  58 .Sh DESCRIPTION
  59 The
  60 .Nm
  61 driver provides support for USB Ethernet adapters based on the ASIX
  62 Electronics AX88172 USB 2.0 chipset.
  63 .Pp
  64 The AX88172 is a USB 2.0 device which contains a 10/100
  65 Ethernet MAC with MII interface and is designed to work with both
  66 Ethernet and HomePNA transceivers.
  67 The AX88172 will operate with
  68 both USB 1.x and USB 2.0 controllers, however performance with 1.x
  69 controllers will be limited since the USB 1.x standard specifies a
  70 maximum transfer speed of 12Mbps.
  71 Users with USB 1.x controllers should therefore not expect to actually
  72 achieve 100Mbps speeds with these devices.
  73 .Pp
  74 The AX88172 supports a 64-bit multicast hash table, single perfect
  75 filter entry for the station address, all-multicast mode and promiscuous mode.
  76 Packets are
  77 received and transmitted over separate USB bulk transfer endpoints.
  78 .Pp
  79 The
  80 .Nm
  81 driver supports the following media types:
  82 .Bl -tag -width ".Cm 10baseT/UTP"
  83 .It Cm autoselect
  84 Enable autoselection of the media type and options.
  85 The user can manually override
  86 the autoselected mode by adding media options to the
  87 .Pa /etc/rc.conf
  88 file.
  89 .It Cm 10baseT/UTP
  90 Set 10Mbps operation.
  91 The
  92 .Cm mediaopt
  93 option can also be used to enable
  94 .Cm full-duplex
  95 operation.
  96 Not specifying
  97 .Cm full-duplex
  98 implies
  99 .Cm half-duplex
 100 mode.
 101 .It Cm 100baseTX
 102 Set 100Mbps (Fast Ethernet) operation.
 103 The
 104 .Cm mediaopt
 105 option can also be used to enable
 106 .Cm full-duplex
 107 operation.
 108 Not specifying
 109 .Cm full-duplex
 110 implies
 111 .Cm half-duplex
 112 mode.
 113 .El
 114 .Pp
 115 The
 116 .Nm
 117 driver supports the following media options:
 118 .Bl -tag -width ".Cm 10baseT/UTP"
 119 .It Cm full-duplex
 120 Force full duplex operation.
 121 The interface will operate in
 122 half duplex mode if this media option is not specified.
 123 .El
 124 .Pp
 125 For more information on configuring this device, see
 126 .Xr ifconfig 8 .
 127 .Sh HARDWARE
 128 The
 129 .Nm
 130 driver supports ASIX Electronics AX88172 based USB Ethernet
 131 adapters including:
 132 .Pp
 133 .Bl -bullet -compact
 134 .It
 135 Buffalo (Melco Inc.) LUA-U2-KTX
 136 .It
 137 D-Link DUBE100
 138 .It
 139 LinkSys USB200M
 140 .It
 141 Netgear FA120
 142 .It
 143 Sitecom LN-029
 144 .It
 145 System TALKS Inc.\& SGC-X2UL
 146 .El
 147 .Sh DIAGNOSTICS
 148 .Bl -diag
 149 .It "axe%d: watchdog timeout"
 150 A packet was queued for transmission and a transmit command was
 151 issued, however the device failed to acknowledge the transmission
 152 before a timeout expired.
 153 .It "axe%d: no memory for rx list"
 154 The driver failed to allocate an mbuf for the receiver ring.
 155 .El
 156 .Sh SEE ALSO
 157 .Xr arp 4 ,
 158 .Xr ifmedia 4 ,
 159 .Xr miibus 4 ,
 160 .Xr netintro 4 ,
 161 .Xr ng_ether 4 ,
 162 .Xr ifconfig 8
 163 .Rs
 164 .%T "ASIX AX88172 data sheet"
 165 .%O http://www.asix.com.tw
 166 .Re
 167 .Sh HISTORY
 168 The
 169 .Nm
 170 device driver first appeared in
 171 .Fx 5.0 .
 172 .Sh AUTHORS
 173 The
 174 .Nm
 175 driver was written by
 176 .An Bill Paul Aq Mt wpaul@windriver.com .