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