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