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