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