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