xref: /freebsd/share/man/man4/ae.4 (revision 0957b409)
1.\" Copyright (c) 2008 Stanislav Sedov <stas@FreeBSD.org>
2.\" 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.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd October 24, 2018
28.Dt AE 4
29.Os
30.Sh NAME
31.Nm ae
32.Nd "Attansic/Atheros L2 FastEthernet controller driver"
33.Sh SYNOPSIS
34To compile this driver into the kernel, place the following lines in your
35kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "device miibus"
38.Cd "device ae"
39.Ed
40.Pp
41Alternatively, to load the driver as a
42module at boot time, place the following line in
43.Xr loader.conf 5 :
44.Bd -literal -offset indent
45if_ae_load="YES"
46.Ed
47.Sh DEPRECATION NOTICE
48The
49.Nm
50driver is not present in
51.Fx 13.0
52and later.
53See https://github.com/freebsd/fcp/blob/master/fcp-0101.md for more
54information.
55.Sh DESCRIPTION
56The
57.Nm
58device driver provides support for Attansic/Atheros L2 PCIe FastEthernet
59controllers.
60.Pp
61The controller supports hardware Ethernet checksum processing, hardware
62VLAN tag stripping/insertion and an interrupt moderation mechanism.
63Attansic L2 also features a 64-bit multicast hash filter.
64.Pp
65The
66.Nm
67driver supports the following media types:
68.Bl -tag -width ".Cm 10baseT/UTP"
69.It Cm autoselect
70Enable autoselection of the media type and options.
71The user can manually override the autoselected mode by
72adding media options to
73.Xr rc.conf 5 .
74.It Cm 10baseT/UTP
75Select 10Mbps operation.
76.It Cm 100baseTX
77Set 100Mbps (FastEthernet) operation.
78.El
79.Pp
80The
81.Nm
82driver provides support for the following media options:
83.Bl -tag -width ".Cm full-duplex"
84.It Cm full-duplex
85Force full duplex operation.
86.It Cm half-duplex
87Force half duplex operation.
88.El
89.Pp
90For more information on configuring this device, see
91.Xr ifconfig 8 .
92.Sh HARDWARE
93The
94.Nm
95driver supports Attansic/Atheros L2 PCIe FastEthernet controllers, and
96is known to support the following hardware:
97.Pp
98.Bl -bullet -compact
99.It
100ASUS EeePC 701
101.It
102ASUS EeePC 900
103.El
104.Pp
105Other hardware may or may not work with this driver.
106.Sh LOADER TUNABLES
107Tunables can be set at the
108.Xr loader 8
109prompt before booting the kernel or stored in
110.Xr loader.conf 5 .
111.Bl -tag -width "xxxxxx"
112.It Va hw.ae.msi_disable
113This tunable disables MSI support on the Ethernet hardware.
114The default value is 0.
115.El
116.Sh SYSCTL VARIABLES
117The
118.Nm
119driver collects a number of useful MAC counter during the work.
120The statistics is available via the
121.Va dev.ae.%d.stats
122.Xr sysctl 8
123tree, where %d corresponds to the controller number.
124.Sh DIAGNOSTICS
125.Bl -diag
126.It "ae%d: watchdog timeout."
127The device has stopped responding to the network, or there is a problem with
128the network connection (cable).
129.It "ae%d: reset timeout."
130The card reset operation has been timed out.
131.It "ae%d: Generating random ethernet address."
132No valid Ethernet address was found in the controller NVRAM and registers.
133Random locally administered address with ASUS OUI identifier will be used
134instead.
135.El
136.Sh SEE ALSO
137.Xr altq 4 ,
138.Xr arp 4 ,
139.Xr miibus 4 ,
140.Xr netintro 4 ,
141.Xr ng_ether 4 ,
142.Xr vlan 4 ,
143.Xr ifconfig 8
144.Sh HISTORY
145The
146.Nm
147driver and this manual page was written by
148.An Stanislav Sedov Aq Mt stas@FreeBSD.org .
149It first appeared in
150.Fx 7.1 .
151.Sh BUGS
152The Attansic L2 FastEthernet controller supports DMA but does not use a
153descriptor based transfer mechanism via scatter-gather DMA.
154Thus the data should be copied to/from the controller memory on each
155transmit/receive.
156Furthermore, a lot of data alignment restrictions apply.
157This may introduce a high CPU load on systems with heavy network activity.
158Luckily enough this should not be a problem on modern hardware as L2 does
159not support speeds faster than 100Mbps.
160