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