xref: /openbsd/share/man/man4/axe.4 (revision 771fbea0)
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: /repoman/r/ncvs/src/share/man/man4/axe.4,v 1.3 2003/05/29 21:28:35 ru Exp $
32.\" $OpenBSD: axe.4,v 1.46 2019/12/17 18:17:53 jmc Exp $
33.\"
34.Dd $Mdocdate: December 17 2019 $
35.Dt AXE 4
36.Os
37.Sh NAME
38.Nm axe
39.Nd ASIX Electronics AX88172/AX88178/AX88772 10/100/Gigabit USB Ethernet device
40.Sh SYNOPSIS
41.Cd "axe*   at uhub?"
42.Cd "rgephy* at mii?"
43.Cd "rlphy* at mii?"
44.Cd "eephy* at mii?"
45.Sh DESCRIPTION
46The
47.Nm
48driver provides support for USB Ethernet adapters based on the ASIX
49Electronics AX88172, AX88178, and AX88772 USB 2.0 chipsets, including the
50following:
51.Pp
52.Bl -tag -width Ds -offset indent -compact
53.It Apple USB Ethernet Adapter A1277
54.It ATEN UC-210T
55.It BAFO BF-320
56.It Billionton Systems USB2AR
57.It Buffalo(MELCO) LUA-U2-GT
58.It Buffalo(MELCO) LUA-U2-KTX
59.It Corega FEther USB2-TX
60.It D-Link DUB-E100
61.It Delock Gigabit USB 2.0 Ethernet Adapter
62.It Good Way GWUSB2E
63.It Hawking UF200
64.It Intellinet USB 2.0 to Ethernet (rev A)
65.It IO-Data ETG-US2
66.It JVC MP-PRX1
67.It Konig CMP-NWUSB20
68.It Lenovo USB 2.0 Ethernet
69.It Level One USB-0200
70.It Level One USB-0301
71.It Linksys USB200M
72.It Linksys USB1000
73.It Logitec LAN-GTJ/U2
74.It Netgear FA120
75.It Nintendo Wii USB Lan Ethernet Adapter RVL-015
76.It OQO model 01+ Ethernet
77.It Sitecom LN-029
78.It SMC 2209USB/ETH
79.It SnapPort USB 2.0 LAN Adapter
80.It ST Lab USB 2.0 Fast Ethernet
81.It Surecom EP-1427X-2
82.It System TALKS SGC-X2UL
83.It TRENDnet TU2-ET100
84.It Z-TEK ZK-R01-2
85.El
86.Pp
87The AX88172, AX88178, and AX88772 are USB 2.0 devices designed to work with
88either Ethernet or HomePNA transceivers.
89The AX88172 and AX88772 contain 10/100 Ethernet MACs with MII interfaces.
90The AX88178 contains a 10/100/Gigabit Ethernet MAC with a GMII/MII
91interface.
92All adapters will operate with either USB 1.x or USB 2.0 controllers, however
93performance with 1.x controllers will be limited since the USB 1.x standard
94specifies a maximum transfer speed of 12Mbps.
95Users with USB 1.x controllers should therefore not expect to actually
96achieve 100Mbps speeds with these devices.
97.Pp
98A 64-bit multicast hash table is supported,
99single perfect filter entry for the station address,
100all-multicast mode, and promiscuous mode.
101Packets are
102received and transmitted over separate USB bulk transfer endpoints.
103.Pp
104The
105.Nm
106driver supports the following media types:
107.Bl -tag -width "autoselect"
108.It autoselect
109Enable autoselection of the media type and options (this is the default).
110The user can manually override the autoselected mode by adding media
111options to the appropriate
112.Xr hostname.if 5
113file.
114.It 10baseT
115Set 10Mbps operation.
116.It 100baseTX
117Set 100Mbps (Fast Ethernet) operation.
118.It 1000baseT
119Set 1000Mbps (Gigabit Ethernet) operation (AX88178 only).
120.El
121.Pp
122The
123.Nm
124driver supports the following media options:
125.Bl -tag -width "full-duplex"
126.It full-duplex
127Force full-duplex operation.
128.It half-duplex
129Force half-duplex operation.
130.El
131.Pp
132The interface will operate in
133half-duplex mode if no media option is specified.
134.Pp
135For more information on configuring this device, see
136.Xr ifconfig 8 .
137.Sh DIAGNOSTICS
138.Bl -diag
139.It "axe0: watchdog timeout"
140A packet was queued for transmission and a transmit command was
141issued, however the device failed to acknowledge the transmission
142before a timeout expired.
143.It "axe0: no memory for rx list"
144The driver failed to allocate an mbuf for the receiver ring.
145.El
146.Sh SEE ALSO
147.Xr arp 4 ,
148.Xr eephy 4 ,
149.Xr ifmedia 4 ,
150.Xr intro 4 ,
151.Xr netintro 4 ,
152.Xr rgephy 4 ,
153.Xr rlphy 4 ,
154.Xr usb 4 ,
155.Xr hostname.if 5 ,
156.Xr ifconfig 8
157.Rs
158.%T "ASIX AX88172 data sheet"
159.%U http://www.asix.com.tw
160.Re
161.Sh HISTORY
162The
163.Nm
164device driver first appeared in
165.Ox 3.6 .
166.Sh AUTHORS
167.An -nosplit
168The
169.Nm
170driver was written by
171.An Bill Paul Aq Mt wpaul@windriver.com
172and ported to
173.Ox
174by
175.An Greg Taleck Aq Mt taleck@oz.net .
176