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