xref: /freebsd/share/man/man4/axge.4 (revision 7431dfd4580e850375fe5478d92ec770344db098)
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 November 22, 2013
34.Dt AXGE 4
35.Os
36.Sh NAME
37.Nm axge
38.Nd "ASIX Electronics AX88178A/AX88179 USB Gigabit 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 xhci"
45.Cd "device ehci"
46.Cd "device uhci"
47.Cd "device ohci"
48.Cd "device usb"
49.Cd "device miibus"
50.Cd "device axge"
51.Ed
52.Pp
53Alternatively, to load the driver as a
54module at boot time, place the following line in
55.Xr loader.conf 5 :
56.Bd -literal -offset indent
57if_axge_load="YES"
58.Ed
59.Sh DESCRIPTION
60The
61.Nm
62driver provides support for USB Gigabit Ethernet adapters based on the ASIX
63Electronics AX88179 USB 3.0 and AX88178A USB 2.0 chipsets.
64.Pp
65The AX88179 and AX88178A contain a 10/100/1000 Ethernet MAC with a GMII
66interface for interfacing with the Gigabit Ethernet PHY.
67.Pp
68These devices will operate with both USB 1.x and USB 2.0 controllers, and the
69AX88179 will operate with USB 3.0 controllers.
70Packets are received and transmitted over separate USB bulk transfer endpoints.
71.Pp
72The
73.Nm
74driver supports the following media types:
75.Bl -tag -width ".Cm 10baseT/UTP"
76.It Cm autoselect
77Enable autoselection of the media type and options.
78The user can manually override
79the autoselected mode by adding media options to
80.Xr rc.conf 5 .
81.It Cm 10baseT/UTP
82Set 10Mbps operation.
83The
84.Xr ifconfig 8
85.Cm mediaopt
86option can also be used to select either
87.Cm full-duplex
88or
89.Cm half-duplex
90modes.
91.It Cm 100baseTX
92Set 100Mbps (Fast Ethernet) operation.
93The
94.Xr ifconfig 8
95.Cm mediaopt
96option can also be used to select either
97.Cm full-duplex
98or
99.Cm half-duplex
100modes.
101.It Cm 1000baseT
102Set 1000Mbps (Gigabit Ethernet) operation (AX88178 only).
103The
104.Xr ifconfig 8
105.Cm mediaopt
106option can also be used to select either
107.Cm full-duplex
108or
109.Cm half-duplex
110modes.
111.El
112.Pp
113The
114.Nm
115driver supports the following media options:
116.Bl -tag -width ".Cm full-duplex"
117.It Cm full-duplex
118Force full duplex operation.
119.It Cm half-duplex
120Force half duplex operation.
121.El
122.Pp
123For more information on configuring this device, see
124.Xr ifconfig 8 .
125.Sh SEE ALSO
126.Xr altq 4 ,
127.Xr arp 4 ,
128.Xr miibus 4 ,
129.Xr netintro 4 ,
130.Xr ng_ether 4 ,
131.Xr rgephy 4 ,
132.Xr vlan 4 ,
133.Xr ifconfig 8
134.Sh HISTORY
135The
136.Nm
137device driver first appeared in
138.Fx 10.1 .
139.Sh AUTHORS
140.An -nosplit
141The
142.Nm
143driver was written by
144.An Kevin Lo Aq Mt kevlo@FreeBSD.org
145and
146.An Li-Wen Hsu Aq Mt lwhsu@FreeBSD.org .
147This manual page was adapted by
148.An Mark Johnston Aq Mt markj@FreeBSD.org
149from the
150.Xr axe 4
151manual page.
152