d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
cad572c41b
freebsd-skq/share/man/man4/axe.4

176 lines
4.9 KiB
Groff
Raw Normal View History

Add device driver support for the ASIX Electronics AX88172 USB 2.0 ethernet controller. The driver has been tested with the LinkSys USB200M adapter. I know for a fact that there are other devices out there with this chip but don't have all the USB vendor/device IDs. Note: I'm not sure if this will force the driver to end up in the install kernel image or not. Special magic needs to be done to exclude it to keep the boot floppies from bloating again, someone please advise.
2003-04-20 19:05:33 +00:00
.\" Copyright (c) 1997, 1998, 1999, 2000-2003
.\" Bill Paul <wpaul@windriver.com>. All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by Bill Paul.
.\" 4. Neither the name of the author nor the names of any co-contributors
.\" may be used to endorse or promote products derived from this software
.\" without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED. IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
.\" THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
Add a "Load module on start up" comment, similar to mac_*.4 pages[1]. Quote .Cd and .Nd text. Bump doc date. Requested by: some user through ru Supported by: ru, dwmalone, brueffer
2005-07-19 00:26:30 +00:00
.Dd July 16, 2005
Add device driver support for the ASIX Electronics AX88172 USB 2.0 ethernet controller. The driver has been tested with the LinkSys USB200M adapter. I know for a fact that there are other devices out there with this chip but don't have all the USB vendor/device IDs. Note: I'm not sure if this will force the driver to end up in the install kernel image or not. Special magic needs to be done to exclude it to keep the boot floppies from bloating again, someone please advise.
2003-04-20 19:05:33 +00:00
.Dt AXE 4
.Os
.Sh NAME
.Nm axe
Add a "Load module on start up" comment, similar to mac_*.4 pages[1]. Quote .Cd and .Nd text. Bump doc date. Requested by: some user through ru Supported by: ru, dwmalone, brueffer
2005-07-19 00:26:30 +00:00
.Nd "ASIX Electronics AX88172 USB Ethernet driver"
Add device driver support for the ASIX Electronics AX88172 USB 2.0 ethernet controller. The driver has been tested with the LinkSys USB200M adapter. I know for a fact that there are other devices out there with this chip but don't have all the USB vendor/device IDs. Note: I'm not sure if this will force the driver to end up in the install kernel image or not. Special magic needs to be done to exclude it to keep the boot floppies from bloating again, someone please advise.
2003-04-20 19:05:33 +00:00
.Sh SYNOPSIS
Work around an apparent mdoc(7) bug. Spotted by: marius Discussed with: ru
2005-10-07 02:32:16 +00:00
To compile this driver into the kernel,
place the following lines in your
Break long lines and kill a few instances of EOL whitespace. Noticed by: ru
2005-07-21 05:02:39 +00:00
kernel configuration file:
Add a "Load module on start up" comment, similar to mac_*.4 pages[1]. Quote .Cd and .Nd text. Bump doc date. Requested by: some user through ru Supported by: ru, dwmalone, brueffer
2005-07-19 00:26:30 +00:00
.Bd -ragged -offset indent
Add device driver support for the ASIX Electronics AX88172 USB 2.0 ethernet controller. The driver has been tested with the LinkSys USB200M adapter. I know for a fact that there are other devices out there with this chip but don't have all the USB vendor/device IDs. Note: I'm not sure if this will force the driver to end up in the install kernel image or not. Special magic needs to be done to exclude it to keep the boot floppies from bloating again, someone please advise.
2003-04-20 19:05:33 +00:00
.Cd "device ehci"
.Cd "device uhci"
.Cd "device ohci"
.Cd "device usb"
.Cd "device miibus"
.Cd "device axe"
Add a "Load module on start up" comment, similar to mac_*.4 pages[1]. Quote .Cd and .Nd text. Bump doc date. Requested by: some user through ru Supported by: ru, dwmalone, brueffer
2005-07-19 00:26:30 +00:00
.Ed
.Pp
Work around an apparent mdoc(7) bug. Spotted by: marius Discussed with: ru
2005-10-07 02:32:16 +00:00
Alternatively, to load the driver as a
module at boot time, place the following line in
Add a "Load module on start up" comment, similar to mac_*.4 pages[1]. Quote .Cd and .Nd text. Bump doc date. Requested by: some user through ru Supported by: ru, dwmalone, brueffer
2005-07-19 00:26:30 +00:00
.Xr loader.conf 5 :
.Bd -literal -offset indent
if_axe_load="YES"
.Ed
Add device driver support for the ASIX Electronics AX88172 USB 2.0 ethernet controller. The driver has been tested with the LinkSys USB200M adapter. I know for a fact that there are other devices out there with this chip but don't have all the USB vendor/device IDs. Note: I'm not sure if this will force the driver to end up in the install kernel image or not. Special magic needs to be done to exclude it to keep the boot floppies from bloating again, someone please advise.
2003-04-20 19:05:33 +00:00
.Sh DESCRIPTION
The
.Nm
- put the list of supported adapters into a HARDWARE section - make the Buffalo entry look better - properly capitalize Ethernet and Fast Ethernet - bump document date MFC after: 3 days
2004-08-25 22:39:05 +00:00
driver provides support for USB Ethernet adapters based on the ASIX
Electronics AX88172 USB 2.0 chipset.
Add device driver support for the ASIX Electronics AX88172 USB 2.0 ethernet controller. The driver has been tested with the LinkSys USB200M adapter. I know for a fact that there are other devices out there with this chip but don't have all the USB vendor/device IDs. Note: I'm not sure if this will force the driver to end up in the install kernel image or not. Special magic needs to be done to exclude it to keep the boot floppies from bloating again, someone please advise.
2003-04-20 19:05:33 +00:00
.Pp
Assorted mdoc(7) fixes. Approved by: re (blanket)
2003-05-29 21:28:36 +00:00
The AX88172 is a USB 2.0 device which contains a 10/100
- put the list of supported adapters into a HARDWARE section - make the Buffalo entry look better - properly capitalize Ethernet and Fast Ethernet - bump document date MFC after: 3 days
2004-08-25 22:39:05 +00:00
Ethernet MAC with MII interface and is designed to work with both
Ethernet and HomePNA transceivers.
Assorted mdoc(7) fixes. Approved by: re (blanket)
2003-05-29 21:28:36 +00:00
The AX88172 will operate with
Spelling fixes.
2004-06-21 17:42:49 +00:00
both USB 1.x and USB 2.0 controllers, however performance with 1.x
controllers will be limited since the USB 1.x standard specifies a
Assorted mdoc(7) fixes. Approved by: re (blanket)
2003-05-29 21:28:36 +00:00
maximum transfer speed of 12Mbps.
Add device driver support for the ASIX Electronics AX88172 USB 2.0 ethernet controller. The driver has been tested with the LinkSys USB200M adapter. I know for a fact that there are other devices out there with this chip but don't have all the USB vendor/device IDs. Note: I'm not sure if this will force the driver to end up in the install kernel image or not. Special magic needs to be done to exclude it to keep the boot floppies from bloating again, someone please advise.
2003-04-20 19:05:33 +00:00
Users with USB 1.x controllers should therefore not expect to actually
achieve 100Mbps speeds with these devices.
.Pp
The AX88172 supports a 64-bit multicast hash table, single perfect
filter entry for the station address, all-multicast mode and promiscuous mode.
Packets are
received and transmitted over separate USB bulk transfer endpoints.
.Pp
The
.Nm
driver supports the following media types:
Assorted mdoc(7) fixes. Approved by: re (blanket)
2003-05-29 21:28:36 +00:00
.Bl -tag -width ".Cm 10baseT/UTP"
.It Cm autoselect
Add device driver support for the ASIX Electronics AX88172 USB 2.0 ethernet controller. The driver has been tested with the LinkSys USB200M adapter. I know for a fact that there are other devices out there with this chip but don't have all the USB vendor/device IDs. Note: I'm not sure if this will force the driver to end up in the install kernel image or not. Special magic needs to be done to exclude it to keep the boot floppies from bloating again, someone please advise.
2003-04-20 19:05:33 +00:00
Enable autoselection of the media type and options.
The user can manually override
the autoselected mode by adding media options to the
.Pa /etc/rc.conf
file.
Assorted mdoc(7) fixes. Approved by: re (blanket)
2003-05-29 21:28:36 +00:00
.It Cm 10baseT/UTP
Add device driver support for the ASIX Electronics AX88172 USB 2.0 ethernet controller. The driver has been tested with the LinkSys USB200M adapter. I know for a fact that there are other devices out there with this chip but don't have all the USB vendor/device IDs. Note: I'm not sure if this will force the driver to end up in the install kernel image or not. Special magic needs to be done to exclude it to keep the boot floppies from bloating again, someone please advise.
2003-04-20 19:05:33 +00:00
Set 10Mbps operation.
The
Assorted mdoc(7) fixes. Approved by: re (blanket)
2003-05-29 21:28:36 +00:00
.Cm mediaopt
Add device driver support for the ASIX Electronics AX88172 USB 2.0 ethernet controller. The driver has been tested with the LinkSys USB200M adapter. I know for a fact that there are other devices out there with this chip but don't have all the USB vendor/device IDs. Note: I'm not sure if this will force the driver to end up in the install kernel image or not. Special magic needs to be done to exclude it to keep the boot floppies from bloating again, someone please advise.
2003-04-20 19:05:33 +00:00
option can also be used to enable
Assorted mdoc(7) fixes. Approved by: re (blanket)
2003-05-29 21:28:36 +00:00
.Cm full-duplex
Add device driver support for the ASIX Electronics AX88172 USB 2.0 ethernet controller. The driver has been tested with the LinkSys USB200M adapter. I know for a fact that there are other devices out there with this chip but don't have all the USB vendor/device IDs. Note: I'm not sure if this will force the driver to end up in the install kernel image or not. Special magic needs to be done to exclude it to keep the boot floppies from bloating again, someone please advise.
2003-04-20 19:05:33 +00:00
operation.
Not specifying
Assorted mdoc(7) fixes. Approved by: re (blanket)
2003-05-29 21:28:36 +00:00
.Cm full-duplex
Add device driver support for the ASIX Electronics AX88172 USB 2.0 ethernet controller. The driver has been tested with the LinkSys USB200M adapter. I know for a fact that there are other devices out there with this chip but don't have all the USB vendor/device IDs. Note: I'm not sure if this will force the driver to end up in the install kernel image or not. Special magic needs to be done to exclude it to keep the boot floppies from bloating again, someone please advise.
2003-04-20 19:05:33 +00:00
implies
Assorted mdoc(7) fixes. Approved by: re (blanket)
2003-05-29 21:28:36 +00:00
.Cm half-duplex
Add device driver support for the ASIX Electronics AX88172 USB 2.0 ethernet controller. The driver has been tested with the LinkSys USB200M adapter. I know for a fact that there are other devices out there with this chip but don't have all the USB vendor/device IDs. Note: I'm not sure if this will force the driver to end up in the install kernel image or not. Special magic needs to be done to exclude it to keep the boot floppies from bloating again, someone please advise.
2003-04-20 19:05:33 +00:00
mode.
Assorted mdoc(7) fixes. Approved by: re (blanket)
2003-05-29 21:28:36 +00:00
.It Cm 100baseTX
- put the list of supported adapters into a HARDWARE section - make the Buffalo entry look better - properly capitalize Ethernet and Fast Ethernet - bump document date MFC after: 3 days
2004-08-25 22:39:05 +00:00
Set 100Mbps (Fast Ethernet) operation.
Add device driver support for the ASIX Electronics AX88172 USB 2.0 ethernet controller. The driver has been tested with the LinkSys USB200M adapter. I know for a fact that there are other devices out there with this chip but don't have all the USB vendor/device IDs. Note: I'm not sure if this will force the driver to end up in the install kernel image or not. Special magic needs to be done to exclude it to keep the boot floppies from bloating again, someone please advise.
2003-04-20 19:05:33 +00:00
The
Assorted mdoc(7) fixes. Approved by: re (blanket)
2003-05-29 21:28:36 +00:00
.Cm mediaopt
Add device driver support for the ASIX Electronics AX88172 USB 2.0 ethernet controller. The driver has been tested with the LinkSys USB200M adapter. I know for a fact that there are other devices out there with this chip but don't have all the USB vendor/device IDs. Note: I'm not sure if this will force the driver to end up in the install kernel image or not. Special magic needs to be done to exclude it to keep the boot floppies from bloating again, someone please advise.
2003-04-20 19:05:33 +00:00
option can also be used to enable
Assorted mdoc(7) fixes. Approved by: re (blanket)
2003-05-29 21:28:36 +00:00
.Cm full-duplex
Add device driver support for the ASIX Electronics AX88172 USB 2.0 ethernet controller. The driver has been tested with the LinkSys USB200M adapter. I know for a fact that there are other devices out there with this chip but don't have all the USB vendor/device IDs. Note: I'm not sure if this will force the driver to end up in the install kernel image or not. Special magic needs to be done to exclude it to keep the boot floppies from bloating again, someone please advise.
2003-04-20 19:05:33 +00:00
operation.
Not specifying
Assorted mdoc(7) fixes. Approved by: re (blanket)
2003-05-29 21:28:36 +00:00
.Cm full-duplex
Add device driver support for the ASIX Electronics AX88172 USB 2.0 ethernet controller. The driver has been tested with the LinkSys USB200M adapter. I know for a fact that there are other devices out there with this chip but don't have all the USB vendor/device IDs. Note: I'm not sure if this will force the driver to end up in the install kernel image or not. Special magic needs to be done to exclude it to keep the boot floppies from bloating again, someone please advise.
2003-04-20 19:05:33 +00:00
implies
Assorted mdoc(7) fixes. Approved by: re (blanket)
2003-05-29 21:28:36 +00:00
.Cm half-duplex
Add device driver support for the ASIX Electronics AX88172 USB 2.0 ethernet controller. The driver has been tested with the LinkSys USB200M adapter. I know for a fact that there are other devices out there with this chip but don't have all the USB vendor/device IDs. Note: I'm not sure if this will force the driver to end up in the install kernel image or not. Special magic needs to be done to exclude it to keep the boot floppies from bloating again, someone please advise.
2003-04-20 19:05:33 +00:00
mode.
.El
.Pp
The
.Nm
driver supports the following media options:
Assorted mdoc(7) fixes. Approved by: re (blanket)
2003-05-29 21:28:36 +00:00
.Bl -tag -width ".Cm 10baseT/UTP"
.It Cm full-duplex
Add device driver support for the ASIX Electronics AX88172 USB 2.0 ethernet controller. The driver has been tested with the LinkSys USB200M adapter. I know for a fact that there are other devices out there with this chip but don't have all the USB vendor/device IDs. Note: I'm not sure if this will force the driver to end up in the install kernel image or not. Special magic needs to be done to exclude it to keep the boot floppies from bloating again, someone please advise.
2003-04-20 19:05:33 +00:00
Force full duplex operation.
The interface will operate in
half duplex mode if this media option is not specified.
.El
.Pp
For more information on configuring this device, see
.Xr ifconfig 8 .
- put the list of supported adapters into a HARDWARE section - make the Buffalo entry look better - properly capitalize Ethernet and Fast Ethernet - bump document date MFC after: 3 days
2004-08-25 22:39:05 +00:00
.Sh HARDWARE
The
.Nm
driver supports ASIX Electronics AX88172 based USB Ethernet
adapters including:
.Pp
.Bl -bullet -compact
.It
Buffalo (Melco Inc.) LUA-U2-KTX
.It
D-Link DUBE100
.It
LinkSys USB200M
.It
Netgear FA120
.It
Add Sitecom LN-029 to list of supported devices.
2004-09-19 19:55:48 +00:00
Sitecom LN-029
.It
Scheduled mdoc(7) sweep.
2005-01-12 10:14:43 +00:00
System TALKS Inc.\& SGC-X2UL
- put the list of supported adapters into a HARDWARE section - make the Buffalo entry look better - properly capitalize Ethernet and Fast Ethernet - bump document date MFC after: 3 days
2004-08-25 22:39:05 +00:00
.El
Add device driver support for the ASIX Electronics AX88172 USB 2.0 ethernet controller. The driver has been tested with the LinkSys USB200M adapter. I know for a fact that there are other devices out there with this chip but don't have all the USB vendor/device IDs. Note: I'm not sure if this will force the driver to end up in the install kernel image or not. Special magic needs to be done to exclude it to keep the boot floppies from bloating again, someone please advise.
2003-04-20 19:05:33 +00:00
.Sh DIAGNOSTICS
.Bl -diag
.It "axe%d: watchdog timeout"
A packet was queued for transmission and a transmit command was
issued, however the device failed to acknowledge the transmission
before a timeout expired.
.It "axe%d: no memory for rx list"
The driver failed to allocate an mbuf for the receiver ring.
.El
.Sh SEE ALSO
.Xr arp 4 ,
.Xr miibus 4 ,
.Xr netintro 4 ,
.Xr ng_ether 4 ,
.Xr ifconfig 8
.Rs
Assorted mdoc(7) fixes. Approved by: re (blanket)
2003-05-29 21:28:36 +00:00
.%T "ASIX AX88172 data sheet"
Add device driver support for the ASIX Electronics AX88172 USB 2.0 ethernet controller. The driver has been tested with the LinkSys USB200M adapter. I know for a fact that there are other devices out there with this chip but don't have all the USB vendor/device IDs. Note: I'm not sure if this will force the driver to end up in the install kernel image or not. Special magic needs to be done to exclude it to keep the boot floppies from bloating again, someone please advise.
2003-04-20 19:05:33 +00:00
.%O http://www.asix.com.tw
.Re
.Sh HISTORY
The
.Nm
device driver first appeared in
.Fx 5.0 .
.Sh AUTHORS
The
.Nm
driver was written by
.An Bill Paul Aq wpaul@windriver.com .
Reference in New Issue Copy Permalink