xref: /freebsd/share/man/man4/axge.4 (revision 328110da2661a8841f12000b99fea27ceacdd5b2)
1.\"
2.\" SPDX-License-Identifier: BSD-4-Clause
3.\"
4.\" Copyright (c) 1997, 1998, 1999, 2000-2003
5.\"     Bill Paul <wpaul@windriver.com>. All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\"    notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\"    notice, this list of conditions and the following disclaimer in the
14.\"    documentation and/or other materials provided with the distribution.
15.\" 3. All advertising materials mentioning features or use of this software
16.\"    must display the following acknowledgement:
17.\"	This product includes software developed by Bill Paul.
18.\" 4. Neither the name of the author nor the names of any co-contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"   without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
26.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
27.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
28.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
29.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
30.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
31.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
32.\" THE POSSIBILITY OF SUCH DAMAGE.
33.\"
34.Dd May 25, 2025
35.Dt AXGE 4
36.Os
37.Sh NAME
38.Nm axge
39.Nd "ASIX Electronics AX88178A/179/179A USB Gigabit Ethernet driver"
40.Sh SYNOPSIS
41To compile this driver into the kernel,
42place the following lines in your
43kernel configuration file:
44.Bd -ragged -offset indent
45.Cd "device xhci"
46.Cd "device ehci"
47.Cd "device uhci"
48.Cd "device ohci"
49.Cd "device usb"
50.Cd "device miibus"
51.Cd "device uether"
52.Cd "device axge"
53.Ed
54.Pp
55Alternatively, to load the driver as a
56module at boot time, place the following line in
57.Xr loader.conf 5 :
58.Bd -literal -offset indent
59if_axge_load="YES"
60.Ed
61.Sh DESCRIPTION
62The
63.Nm
64driver provides support for USB Gigabit Ethernet adapters based on the ASIX
65Electronics AX88179/AX88179A USB 3.0 and AX88178A USB 2.0 chipsets.
66.Pp
67The AX88179, AX88179A and AX88178A contain a 10/100/1000 Ethernet MAC with a
68GMII interface for interfacing with the Gigabit Ethernet PHY.
69.Pp
70These devices will operate with both USB 1.x and USB 2.0 controllers, and the
71AX88179/AX88179A will operate with USB 3.0 controllers.
72Packets are received and transmitted over separate USB bulk transfer endpoints.
73.Pp
74The
75.Nm
76driver supports the following media types:
77.Bl -tag -width ".Cm 10baseT/UTP"
78.It Cm autoselect
79Enable autoselection of the media type and options.
80The user can manually override
81the autoselected mode by adding media options to
82.Xr rc.conf 5 .
83.It Cm 10baseT/UTP
84Set 10Mbps operation.
85The
86.Xr ifconfig 8
87.Cm mediaopt
88option can also be used to select either
89.Cm full-duplex
90or
91.Cm half-duplex
92modes.
93.It Cm 100baseTX
94Set 100Mbps (Fast Ethernet) operation.
95The
96.Xr ifconfig 8
97.Cm mediaopt
98option can also be used to select either
99.Cm full-duplex
100or
101.Cm half-duplex
102modes.
103.It Cm 1000baseT
104Set 1000Mbps (Gigabit Ethernet) operation (AX88178 only).
105The
106.Xr ifconfig 8
107.Cm mediaopt
108option can also be used to select either
109.Cm full-duplex
110or
111.Cm half-duplex
112modes.
113.El
114.Pp
115The
116.Nm
117driver supports the following media options:
118.Bl -tag -width ".Cm full-duplex"
119.It Cm full-duplex
120Force full duplex operation.
121.It Cm half-duplex
122Force half duplex operation.
123.El
124.Pp
125For more information on configuring this device, see
126.Xr ifconfig 8 .
127.Sh HARDWARE
128The
129.Nm
130driver supports the following USB Gigabit Ethernet controllers:
131.Pp
132.Bl -bullet -compact
133.It
134ASIX Electronics AX88179A
135.It
136ASIX Electronics AX88179
137.It
138ASIX Electronics AX88178A
139.El
140.Sh SEE ALSO
141.Xr altq 4 ,
142.Xr arp 4 ,
143.Xr miibus 4 ,
144.Xr netintro 4 ,
145.Xr ng_ether 4 ,
146.Xr rgephy 4 ,
147.Xr vlan 4 ,
148.Xr ifconfig 8
149.Sh HISTORY
150The
151.Nm
152device driver first appeared in
153.Fx 10.1 .
154.Sh AUTHORS
155.An -nosplit
156The
157.Nm
158driver was written by
159.An Kevin Lo Aq Mt kevlo@FreeBSD.org
160and
161.An Li-Wen Hsu Aq Mt lwhsu@FreeBSD.org .
162This manual page was adapted by
163.An Mark Johnston Aq Mt markj@FreeBSD.org
164from the
165.Xr axe 4
166manual page.
167