PageRenderTime 8ms CodeModel.GetById 1ms app.highlight 3ms RepoModel.GetById 1ms app.codeStats 0ms

/share/man/man4/axe.4

https://bitbucket.org/freebsd/freebsd-head/
Forth | 256 lines | 256 code | 0 blank | 0 comment | 6 complexity | cc869c8fa2a45a95a7c07eb6cc4ba0e7 MD5 | raw file
  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 October 25, 2011
 34.Dt AXE 4
 35.Os
 36.Sh NAME
 37.Nm axe
 38.Nd "ASIX Electronics AX88x7x/760 USB Ethernet driver"
 39.Sh SYNOPSIS
 40To compile this driver into the kernel,
 41place the following lines in your
 42kernel configuration file:
 43.Bd -ragged -offset indent
 44.Cd "device ehci"
 45.Cd "device uhci"
 46.Cd "device ohci"
 47.Cd "device usb"
 48.Cd "device miibus"
 49.Cd "device axe"
 50.Ed
 51.Pp
 52Alternatively, to load the driver as a
 53module at boot time, place the following line in
 54.Xr loader.conf 5 :
 55.Bd -literal -offset indent
 56if_axe_load="YES"
 57.Ed
 58.Sh DESCRIPTION
 59The
 60.Nm
 61driver provides support for USB Ethernet adapters based on the ASIX
 62Electronics AX88172, AX88178, AX88772, AX88772A, AX88772B and AX88760
 63USB 2.0 chipsets.
 64.Pp
 65The AX88172, AX88772, AX88772A, AX88772B and AX88760 contain a 10/100
 66Ethernet MAC with MII interface and are designed to work with both
 67Ethernet and HomePNA transceivers.
 68The AX88178 has a 10/100/1000 Ethernet MAC with GMII/RGMII interface
 69for interfacing with Gigabit Ethernet PHY.
 70.Pp
 71These devices will operate with
 72both USB 1.x and USB 2.0 controllers, however performance with 1.x
 73controllers will be limited since the USB 1.x standard specifies a
 74maximum transfer speed of 12Mbps.
 75Users with USB 1.x controllers should therefore not expect to actually
 76achieve 100Mbps speeds with these devices.
 77.Pp
 78All chipsets support a 64-bit multicast hash table, single perfect
 79filter entry for the station address, all-multicast mode and promiscuous mode.
 80Packets are
 81received and transmitted over separate USB bulk transfer endpoints.
 82.Pp
 83The
 84.Nm
 85driver supports the following media types:
 86.Bl -tag -width ".Cm 10baseT/UTP"
 87.It Cm autoselect
 88Enable autoselection of the media type and options.
 89The user can manually override
 90the autoselected mode by adding media options to
 91.Xr rc.conf 5 .
 92.It Cm 10baseT/UTP
 93Set 10Mbps operation.
 94The
 95.Xr ifconfig 8
 96.Cm mediaopt
 97option can also be used to select either
 98.Cm full-duplex
 99or
100.Cm half-duplex
101modes.
102.It Cm 100baseTX
103Set 100Mbps (Fast Ethernet) operation.
104The
105.Xr ifconfig 8
106.Cm mediaopt
107option can also be used to select either
108.Cm full-duplex
109or
110.Cm half-duplex
111modes.
112.It Cm 1000baseT
113Set 1000Mbps (Gigabit Ethernet) operation (AX88178 only).
114The
115.Xr ifconfig 8
116.Cm mediaopt
117option can also be used to select either
118.Cm full-duplex
119or
120.Cm half-duplex
121modes.
122.El
123.Pp
124The
125.Nm
126driver supports the following media options:
127.Bl -tag -width ".Cm full-duplex"
128.It Cm full-duplex
129Force full duplex operation.
130.It Cm half-duplex
131Force half duplex operation.
132.El
133.Pp
134For more information on configuring this device, see
135.Xr ifconfig 8 .
136.Sh HARDWARE
137The
138.Nm
139driver supports ASIX Electronics AX88172/AX88178/AX88772/AX88772A/AX88772B/AX88760
140based USB Ethernet adapters including:
141.Pp
142AX88172:
143.Bl -bullet -compact
144.It
145AboCom UF200
146.It
147Acer Communications EP1427X2
148.It
149ASIX AX88172
150.It
151ATen UC210T
152.It
153Billionton SnapPort
154.It
155Billionton USB2AR
156.It
157Buffalo (Melco Inc.) LUA-U2-KTX
158.It
159Corega USB2_TX
160.It
161D-Link DUBE100
162.It
163Goodway GWUSB2E
164.It
165JVC MP_PRX1
166.It
167LinkSys USB200M
168.It
169Netgear FA120
170.It
171Sitecom LN-029
172.It
173System TALKS Inc.\& SGC-X2UL
174.El
175.Pp
176AX88178:
177.Bl -bullet -compact
178.It
179ASIX AX88178
180.It
181Belkin F5D5055
182.It
183Logitec LAN-GTJ/U2A
184.It
185Buffalo (Melco Inc.) LUA3-U2-AGT
186.It
187Planex Communications GU1000T
188.It
189Sitecom Europe LN-028
190.El
191.Pp
192AX88772:
193.Bl -bullet -compact
194.It
195ASIX AX88772
196.It
197Buffalo (Melco Inc.) LUA3-U2-ATX
198.It
199D-Link DUBE100B1
200.It
201Planex UE-200TX-G
202.It
203Planex UE-200TX-G2
204.El
205.Pp
206AX88772A:
207.Bl -bullet -compact
208.It
209ASIX AX88772A
210.It
211Cisco-Linksys USB200Mv2
212.El
213.Pp
214AX88772B:
215.Bl -bullet -compact
216.It
217ASIX AX88772B
218.El
219.Pp
220AX88760:
221.Bl -bullet -compact
222.It
223ASIX AX88760
224.El
225.Sh DIAGNOSTICS
226.Bl -diag
227.It "axe%d: watchdog timeout"
228A packet was queued for transmission and a transmit command was
229issued, however the device failed to acknowledge the transmission
230before a timeout expired.
231.It "axe%d: no memory for rx list"
232The driver failed to allocate an mbuf for the receiver ring.
233.El
234.Sh SEE ALSO
235.Xr altq 4 ,
236.Xr arp 4 ,
237.Xr miibus 4 ,
238.Xr netintro 4 ,
239.Xr ng_ether 4 ,
240.Xr rgephy 4 ,
241.Xr vlan 4 ,
242.Xr ifconfig 8
243.Rs
244.%T "ASIX AX88x7x and AX88760 data sheets"
245.%U http://www.asix.com.tw
246.Re
247.Sh HISTORY
248The
249.Nm
250device driver first appeared in
251.Fx 5.0 .
252.Sh AUTHORS
253The
254.Nm
255driver was written by
256.An Bill Paul Aq wpaul@windriver.com .