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