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 June 25, 2013
  34 .Dt AXE 4
  35 .Os
  36 .Sh NAME
  37 .Nm axe
  38 .Nd "ASIX Electronics AX88x7x/760 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, AX88772, AX88772A, AX88772B and AX88760
  63 USB 2.0 chipsets.
  64 .Pp
  65 The AX88172, AX88772, AX88772A, AX88772B and AX88760 contain a 10/100
  66 Ethernet MAC with MII interface and are designed to work with both
  67 Ethernet and HomePNA transceivers.
  68 The AX88178 has a 10/100/1000 Ethernet MAC with GMII/RGMII interface
  69 for interfacing with Gigabit Ethernet PHY.
  70 .Pp
  71 These devices will operate with
  72 both USB 1.x and USB 2.0 controllers, however performance with 1.x
  73 controllers will be limited since the USB 1.x standard specifies a
  74 maximum transfer speed of 12Mbps.
  75 Users with USB 1.x controllers should therefore not expect to actually
  76 achieve 100Mbps speeds with these devices.
  77 .Pp
  78 All chipsets support a 64-bit multicast hash table, single perfect
  79 filter entry for the station address, all-multicast mode and promiscuous mode.
  80 Packets are
  81 received and transmitted over separate USB bulk transfer endpoints.
  82 .Pp
  83 The
  84 .Nm
  85 driver supports the following media types:
  86 .Bl -tag -width ".Cm 10baseT/UTP"
  87 .It Cm autoselect
  88 Enable autoselection of the media type and options.
  89 The user can manually override
  90 the autoselected mode by adding media options to
  91 .Xr rc.conf 5 .
  92 .It Cm 10baseT/UTP
  93 Set 10Mbps operation.
  94 The
  95 .Xr ifconfig 8
  96 .Cm mediaopt
  97 option can also be used to select either
  98 .Cm full-duplex
  99 or
 100 .Cm half-duplex
 101 modes.
 102 .It Cm 100baseTX
 103 Set 100Mbps (Fast Ethernet) operation.
 104 The
 105 .Xr ifconfig 8
 106 .Cm mediaopt
 107 option can also be used to select either
 108 .Cm full-duplex
 109 or
 110 .Cm half-duplex
 111 modes.
 112 .It Cm 1000baseT
 113 Set 1000Mbps (Gigabit Ethernet) operation (AX88178 only).
 114 The
 115 .Xr ifconfig 8
 116 .Cm mediaopt
 117 option can also be used to select either
 118 .Cm full-duplex
 119 or
 120 .Cm half-duplex
 121 modes.
 122 .El
 123 .Pp
 124 The
 125 .Nm
 126 driver supports the following media options:
 127 .Bl -tag -width ".Cm full-duplex"
 128 .It Cm full-duplex
 129 Force full duplex operation.
 130 .It Cm half-duplex
 131 Force half duplex operation.
 132 .El
 133 .Pp
 134 For more information on configuring this device, see
 135 .Xr ifconfig 8 .
 136 .Sh HARDWARE
 137 The
 138 .Nm
 139 driver supports ASIX Electronics AX88172/AX88178/AX88772/AX88772A/AX88772B/AX88760
 140 based USB Ethernet adapters including:
 141 .Pp
 142 AX88172:
 143 .Bl -bullet -compact
 144 .It
 145 AboCom UF200
 146 .It
 147 Acer Communications EP1427X2
 148 .It
 149 ASIX AX88172
 150 .It
 151 ATen UC210T
 152 .It
 153 Billionton SnapPort
 154 .It
 155 Billionton USB2AR
 156 .It
 157 Buffalo (Melco Inc.) LUA-U2-KTX
 158 .It
 159 Corega USB2_TX
 160 .It
 161 D-Link DUBE100
 162 .It
 163 Goodway GWUSB2E
 164 .It
 165 JVC MP_PRX1
 166 .It
 167 LinkSys USB200M
 168 .It
 169 Netgear FA120
 170 .It
 171 Sitecom LN-029
 172 .It
 173 System TALKS Inc.\& SGC-X2UL
 174 .El
 175 .Pp
 176 AX88178:
 177 .Bl -bullet -compact
 178 .It
 179 ASIX AX88178
 180 .It
 181 Belkin F5D5055
 182 .It
 183 Logitec LAN-GTJ/U2A
 184 .It
 185 Buffalo (Melco Inc.) LUA3-U2-AGT
 186 .It
 187 Planex Communications GU1000T
 188 .It
 189 Sitecom Europe LN-028
 190 .El
 191 .Pp
 192 AX88772:
 193 .Bl -bullet -compact
 194 .It
 195 ASIX AX88772
 196 .It
 197 Buffalo (Melco Inc.) LUA3-U2-ATX
 198 .It
 199 D-Link DUBE100B1
 200 .It
 201 Planex UE-200TX-G
 202 .It
 203 Planex UE-200TX-G2
 204 .El
 205 .Pp
 206 AX88772A:
 207 .Bl -bullet -compact
 208 .It
 209 ASIX AX88772A
 210 .It
 211 Cisco-Linksys USB200Mv2
 212 .El
 213 .Pp
 214 AX88772B:
 215 .Bl -bullet -compact
 216 .It
 217 ASIX AX88772B
 218 .It
 219 Lenovo USB 2.0 Ethernet
 220 .El
 221 .Pp
 222 AX88760:
 223 .Bl -bullet -compact
 224 .It
 225 ASIX AX88760
 226 .El
 227 .Sh DIAGNOSTICS
 228 .Bl -diag
 229 .It "axe%d: watchdog timeout"
 230 A packet was queued for transmission and a transmit command was
 231 issued, however the device failed to acknowledge the transmission
 232 before a timeout expired.
 233 .It "axe%d: no memory for rx list"
 234 The driver failed to allocate an mbuf for the receiver ring.
 235 .El
 236 .Sh SEE ALSO
 237 .Xr altq 4 ,
 238 .Xr arp 4 ,
 239 .Xr miibus 4 ,
 240 .Xr netintro 4 ,
 241 .Xr ng_ether 4 ,
 242 .Xr rgephy 4 ,
 243 .Xr vlan 4 ,
 244 .Xr ifconfig 8
 245 .Rs
 246 .%T "ASIX AX88x7x and AX88760 data sheets"
 247 .%U http://www.asix.com.tw
 248 .Re
 249 .Sh HISTORY
 250 The
 251 .Nm
 252 device driver first appeared in
 253 .Fx 5.0 .
 254 .Sh AUTHORS
 255 The
 256 .Nm
 257 driver was written by
 258 .An Bill Paul Aq wpaul@windriver.com .