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$
  32 .\"
  33 .Dd January 20, 2008
  34 .Dt AXE 4
  35 .Os
  36 .Sh NAME
  37 .Nm axe
  38 .Nd "ASIX Electronics AX88172/178/772 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, AX88178 and AX88772 USB 2.0 chipsets.
  63 .Pp
  64 The AX88172 and AX88178 are USB 2.0 devices that contain a 10/100
  65 Ethernet MAC with MII interface and are designed to work with both
  66 Ethernet and HomePNA transceivers.
  67 The AX88772 will additionally support 10/100/1000 MACs.
  68 .Pp
  69 These devices will operate with
  70 both USB 1.x and USB 2.0 controllers, however performance with 1.x
  71 controllers will be limited since the USB 1.x standard specifies a
  72 maximum transfer speed of 12Mbps.
  73 Users with USB 1.x controllers should therefore not expect to actually
  74 achieve 100Mbps speeds with these devices.
  75 .Pp
  76 All chipsets support a 64-bit multicast hash table, single perfect
  77 filter entry for the station address, all-multicast mode and promiscuous mode.
  78 Packets are
  79 received and transmitted over separate USB bulk transfer endpoints.
  80 .Pp
  81 The
  82 .Nm
  83 driver supports the following media types:
  84 .Bl -tag -width ".Cm 10baseT/UTP"
  85 .It Cm 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 Cm 10baseT/UTP
  92 Set 10Mbps operation.
  93 The
  94 .Cm mediaopt
  95 option can also be used to enable
  96 .Cm full-duplex
  97 operation.
  98 Not specifying
  99 .Cm full-duplex
 100 implies
 101 .Cm half-duplex
 102 mode.
 103 .It Cm 100baseTX
 104 Set 100Mbps (Fast Ethernet) operation.
 105 The
 106 .Cm mediaopt
 107 option can also be used to enable
 108 .Cm full-duplex
 109 operation.
 110 Not specifying
 111 .Cm full-duplex
 112 implies
 113 .Cm half-duplex
 114 mode.
 115 .El
 116 .Pp
 117 The
 118 .Nm
 119 driver supports the following media options:
 120 .Bl -tag -width ".Cm 10baseT/UTP"
 121 .It Cm full-duplex
 122 Force full duplex operation.
 123 The interface will operate in
 124 half duplex mode if this media option is not specified.
 125 .El
 126 .Pp
 127 For more information on configuring this device, see
 128 .Xr ifconfig 8 .
 129 .Sh HARDWARE
 130 The
 131 .Nm
 132 driver supports ASIX Electronics AX88172/AX88178/AX88772 based USB Ethernet
 133 adapters including:
 134 .Pp
 135 AX88172:
 136 .Bl -bullet -compact
 137 .It
 138 AboCom UF200
 139 .It
 140 Acer Communications EP1427X2
 141 .It
 142 ATen UC210T
 143 .It
 144 Billionton SnapPort
 145 .It
 146 Billionton USB2AR
 147 .It
 148 Buffalo (Melco Inc.) LUA-U2-KTX
 149 .It
 150 Corega USB2_TX
 151 .It
 152 D-Link DUBE100
 153 .It
 154 Goodway GWUSB2E
 155 .It
 156 JVC MP_PRX1
 157 .It
 158 LinkSys USB200M
 159 .It
 160 Netgear FA120
 161 .It
 162 Sitecom LN-029
 163 .It
 164 System TALKS Inc.\& SGC-X2UL
 165 .El
 166 .Pp
 167 AX88178:
 168 .Bl -bullet -compact
 169 .It
 170 Belkin F5D5055
 171 .It
 172 Planex Communications GU1000T
 173 .It
 174 Sitecom Europe LN-028
 175 .El
 176 .Pp
 177 AX88772:
 178 .Bl -bullet -compact
 179 .It
 180 Cisco-Linksys USB200Mv2
 181 .It
 182 D-Link DUBE100B1
 183 .El
 184 .Sh DIAGNOSTICS
 185 .Bl -diag
 186 .It "axe%d: watchdog timeout"
 187 A packet was queued for transmission and a transmit command was
 188 issued, however the device failed to acknowledge the transmission
 189 before a timeout expired.
 190 .It "axe%d: no memory for rx list"
 191 The driver failed to allocate an mbuf for the receiver ring.
 192 .El
 193 .Sh SEE ALSO
 194 .Xr altq 4 ,
 195 .Xr arp 4 ,
 196 .Xr miibus 4 ,
 197 .Xr netintro 4 ,
 198 .Xr ng_ether 4 ,
 199 .Xr ifconfig 8
 200 .Rs
 201 .%T "ASIX AX88172 AX88178 and AX88772 data sheets"
 202 .%O http://www.asix.com.tw
 203 .Re
 204 .Sh HISTORY
 205 The
 206 .Nm
 207 device driver first appeared in
 208 .Fx 5.0 .
 209 .Sh AUTHORS
 210 The
 211 .Nm
 212 driver was written by
 213 .An Bill Paul Aq wpaul@windriver.com .