xref: /freebsd/share/man/man4/axe.4 (revision f0adf7f5cdd241db2f2c817683191a6ef64a4e95)
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$
32.\"
33.Dd April 20, 2003
34.Dt AXE 4
35.Os
36.Sh NAME
37.Nm axe
38.Nd ASIX Electronics AX88172 USB Ethernet driver
39.Sh SYNOPSIS
40.Cd "device ehci"
41.Cd "device uhci"
42.Cd "device ohci"
43.Cd "device usb"
44.Cd "device miibus"
45.Cd "device axe"
46.Sh DESCRIPTION
47The
48.Nm
49driver provides support for USB ethernet adapters based on the ASIX
50Electronics AX88172 USB 2.0 chipset, including the following:
51.Pp
52.Bl -bullet -compact
53.It
54Buffalo(MELCO) LUA-U2-KTX
55.It
56D-Link DUBE100
57.It
58LinkSys USB200M
59.It
60Netgear FA120
61.It
62System TALKS Inc. SGC-X2UL
63.El
64.Pp
65The AX88172 is a USB 2.0 device which contains a 10/100
66ethernet MAC with MII interface and is designed to work with both
67ethernet and HomePNA transceivers.
68The AX88172 will operate with
69both USB 1.x and USB 2.0 controllers, however performance with 1.x
70controllers will be limited since the USB 1.x standard specifies a
71maximum transfer speed of 12Mbps.
72Users with USB 1.x controllers should therefore not expect to actually
73achieve 100Mbps speeds with these devices.
74.Pp
75The AX88172 supports a 64-bit multicast hash table, single perfect
76filter entry for the station address, all-multicast mode and promiscuous mode.
77Packets are
78received and transmitted over separate USB bulk transfer endpoints.
79.Pp
80The
81.Nm
82driver supports the following media types:
83.Bl -tag -width ".Cm 10baseT/UTP"
84.It Cm autoselect
85Enable autoselection of the media type and options.
86The user can manually override
87the autoselected mode by adding media options to the
88.Pa /etc/rc.conf
89file.
90.It Cm 10baseT/UTP
91Set 10Mbps operation.
92The
93.Cm mediaopt
94option can also be used to enable
95.Cm full-duplex
96operation.
97Not specifying
98.Cm full-duplex
99implies
100.Cm half-duplex
101mode.
102.It Cm 100baseTX
103Set 100Mbps (fast ethernet) operation.
104The
105.Cm mediaopt
106option can also be used to enable
107.Cm full-duplex
108operation.
109Not specifying
110.Cm full-duplex
111implies
112.Cm half-duplex
113mode.
114.El
115.Pp
116The
117.Nm
118driver supports the following media options:
119.Bl -tag -width ".Cm 10baseT/UTP"
120.It Cm full-duplex
121Force full duplex operation.
122The interface will operate in
123half duplex mode if this media option is not specified.
124.El
125.Pp
126For more information on configuring this device, see
127.Xr ifconfig 8 .
128.Sh DIAGNOSTICS
129.Bl -diag
130.It "axe%d: watchdog timeout"
131A packet was queued for transmission and a transmit command was
132issued, however the device failed to acknowledge the transmission
133before a timeout expired.
134.It "axe%d: no memory for rx list"
135The driver failed to allocate an mbuf for the receiver ring.
136.El
137.Sh SEE ALSO
138.Xr arp 4 ,
139.Xr miibus 4 ,
140.Xr netintro 4 ,
141.Xr ng_ether 4 ,
142.Xr ifconfig 8
143.Rs
144.%T "ASIX AX88172 data sheet"
145.%O http://www.asix.com.tw
146.Re
147.Sh HISTORY
148The
149.Nm
150device driver first appeared in
151.Fx 5.0 .
152.Sh AUTHORS
153The
154.Nm
155driver was written by
156.An Bill Paul Aq wpaul@windriver.com .
157