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