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