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