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