xref: /freebsd/share/man/man4/axe.4 (revision 2357939bc239bd5334a169b62313806178dd8f30)
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.El
62.Pp
63The AX88172 is a USB 2.0 device which contains a 10/100
64ethernet MAC with MII interface and is designed to work with both
65ethernet and HomePNA transceivers.
66The AX88172 will operate with
67both USB 1.x and USB 2.0 controllers, however performace with 1.x
68contollers will be limited since the USB 1.x standard specifies a
69maximum transfer speed of 12Mbps.
70Users with USB 1.x controllers should therefore not expect to actually
71achieve 100Mbps speeds with these devices.
72.Pp
73The AX88172 supports a 64-bit multicast hash table, single perfect
74filter entry for the station address, all-multicast mode and promiscuous mode.
75Packets are
76received and transmitted over separate USB bulk transfer endpoints.
77.Pp
78The
79.Nm
80driver supports the following media types:
81.Bl -tag -width ".Cm 10baseT/UTP"
82.It Cm autoselect
83Enable autoselection of the media type and options.
84The user can manually override
85the autoselected mode by adding media options to the
86.Pa /etc/rc.conf
87file.
88.It Cm 10baseT/UTP
89Set 10Mbps operation.
90The
91.Cm mediaopt
92option can also be used to enable
93.Cm full-duplex
94operation.
95Not specifying
96.Cm full-duplex
97implies
98.Cm half-duplex
99mode.
100.It Cm 100baseTX
101Set 100Mbps (fast ethernet) operation.
102The
103.Cm mediaopt
104option can also be used to enable
105.Cm full-duplex
106operation.
107Not specifying
108.Cm full-duplex
109implies
110.Cm half-duplex
111mode.
112.El
113.Pp
114The
115.Nm
116driver supports the following media options:
117.Bl -tag -width ".Cm 10baseT/UTP"
118.It Cm full-duplex
119Force full duplex operation.
120The interface will operate in
121half duplex mode if this media option is not specified.
122.El
123.Pp
124For more information on configuring this device, see
125.Xr ifconfig 8 .
126.Sh DIAGNOSTICS
127.Bl -diag
128.It "axe%d: watchdog timeout"
129A packet was queued for transmission and a transmit command was
130issued, however the device failed to acknowledge the transmission
131before a timeout expired.
132.It "axe%d: no memory for rx list"
133The driver failed to allocate an mbuf for the receiver ring.
134.El
135.Sh SEE ALSO
136.Xr arp 4 ,
137.Xr miibus 4 ,
138.Xr netintro 4 ,
139.Xr ng_ether 4 ,
140.Xr ifconfig 8
141.Rs
142.%T "ASIX AX88172 data sheet"
143.%O http://www.asix.com.tw
144.Re
145.Sh HISTORY
146The
147.Nm
148device driver first appeared in
149.Fx 5.0 .
150.Sh AUTHORS
151The
152.Nm
153driver was written by
154.An Bill Paul Aq wpaul@windriver.com .
155