xref: /freebsd/share/man/man4/ae.4 (revision 5eaa7d4d6574ec04ae1b0e5db406acbb33ef7700)
18faf6cdcSStanislav Sedov.\" Copyright (c) 2008 Stanislav Sedov <stas@FreeBSD.org>
28faf6cdcSStanislav Sedov.\" All rights reserved.
38faf6cdcSStanislav Sedov.\"
48faf6cdcSStanislav Sedov.\" Redistribution and use in source and binary forms, with or without
58faf6cdcSStanislav Sedov.\" modification, are permitted provided that the following conditions
68faf6cdcSStanislav Sedov.\" are met:
78faf6cdcSStanislav Sedov.\" 1. Redistributions of source code must retain the above copyright
88faf6cdcSStanislav Sedov.\"    notice, this list of conditions and the following disclaimer.
98faf6cdcSStanislav Sedov.\" 2. Redistributions in binary form must reproduce the above copyright
108faf6cdcSStanislav Sedov.\"    notice, this list of conditions and the following disclaimer in the
118faf6cdcSStanislav Sedov.\"    documentation and/or other materials provided with the distribution.
128faf6cdcSStanislav Sedov.\"
138faf6cdcSStanislav Sedov.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
148faf6cdcSStanislav Sedov.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
158faf6cdcSStanislav Sedov.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
168faf6cdcSStanislav Sedov.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
178faf6cdcSStanislav Sedov.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
188faf6cdcSStanislav Sedov.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
198faf6cdcSStanislav Sedov.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
208faf6cdcSStanislav Sedov.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
218faf6cdcSStanislav Sedov.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
228faf6cdcSStanislav Sedov.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
238faf6cdcSStanislav Sedov.\" SUCH DAMAGE.
248faf6cdcSStanislav Sedov.\"
258faf6cdcSStanislav Sedov.\" $FreeBSD$
268faf6cdcSStanislav Sedov.\"
27*5eaa7d4dSBrooks Davis.Dd May 17, 2019
288faf6cdcSStanislav Sedov.Dt AE 4
298faf6cdcSStanislav Sedov.Os
308faf6cdcSStanislav Sedov.Sh NAME
318faf6cdcSStanislav Sedov.Nm ae
3203bc0ffaSSimon L. B. Nielsen.Nd "Attansic/Atheros L2 FastEthernet controller driver"
338faf6cdcSStanislav Sedov.Sh SYNOPSIS
348faf6cdcSStanislav SedovTo compile this driver into the kernel, place the following lines in your
358faf6cdcSStanislav Sedovkernel configuration file:
368faf6cdcSStanislav Sedov.Bd -ragged -offset indent
378faf6cdcSStanislav Sedov.Cd "device miibus"
388faf6cdcSStanislav Sedov.Cd "device ae"
398faf6cdcSStanislav Sedov.Ed
408faf6cdcSStanislav Sedov.Pp
418faf6cdcSStanislav SedovAlternatively, to load the driver as a
428faf6cdcSStanislav Sedovmodule at boot time, place the following line in
438faf6cdcSStanislav Sedov.Xr loader.conf 5 :
44a90fbe1dSUlrich Spörlein.Bd -literal -offset indent
458faf6cdcSStanislav Sedovif_ae_load="YES"
468faf6cdcSStanislav Sedov.Ed
478faf6cdcSStanislav Sedov.Sh DESCRIPTION
488faf6cdcSStanislav SedovThe
498faf6cdcSStanislav Sedov.Nm
508faf6cdcSStanislav Sedovdevice driver provides support for Attansic/Atheros L2 PCIe FastEthernet
518faf6cdcSStanislav Sedovcontrollers.
528faf6cdcSStanislav Sedov.Pp
538faf6cdcSStanislav SedovThe controller supports hardware Ethernet checksum processing, hardware
548faf6cdcSStanislav SedovVLAN tag stripping/insertion and an interrupt moderation mechanism.
558faf6cdcSStanislav SedovAttansic L2 also features a 64-bit multicast hash filter.
568faf6cdcSStanislav Sedov.Pp
578faf6cdcSStanislav SedovThe
588faf6cdcSStanislav Sedov.Nm
598faf6cdcSStanislav Sedovdriver supports the following media types:
608faf6cdcSStanislav Sedov.Bl -tag -width ".Cm 10baseT/UTP"
618faf6cdcSStanislav Sedov.It Cm autoselect
628faf6cdcSStanislav SedovEnable autoselection of the media type and options.
638faf6cdcSStanislav SedovThe user can manually override the autoselected mode by
648faf6cdcSStanislav Sedovadding media options to
658faf6cdcSStanislav Sedov.Xr rc.conf 5 .
668faf6cdcSStanislav Sedov.It Cm 10baseT/UTP
678faf6cdcSStanislav SedovSelect 10Mbps operation.
688faf6cdcSStanislav Sedov.It Cm 100baseTX
698faf6cdcSStanislav SedovSet 100Mbps (FastEthernet) operation.
708faf6cdcSStanislav Sedov.El
718faf6cdcSStanislav Sedov.Pp
728faf6cdcSStanislav SedovThe
738faf6cdcSStanislav Sedov.Nm
748faf6cdcSStanislav Sedovdriver provides support for the following media options:
758faf6cdcSStanislav Sedov.Bl -tag -width ".Cm full-duplex"
768faf6cdcSStanislav Sedov.It Cm full-duplex
778faf6cdcSStanislav SedovForce full duplex operation.
788faf6cdcSStanislav Sedov.It Cm half-duplex
798faf6cdcSStanislav SedovForce half duplex operation.
808faf6cdcSStanislav Sedov.El
818faf6cdcSStanislav Sedov.Pp
828faf6cdcSStanislav SedovFor more information on configuring this device, see
838faf6cdcSStanislav Sedov.Xr ifconfig 8 .
848faf6cdcSStanislav Sedov.Sh HARDWARE
858faf6cdcSStanislav SedovThe
868faf6cdcSStanislav Sedov.Nm
8703bc0ffaSSimon L. B. Nielsendriver supports Attansic/Atheros L2 PCIe FastEthernet controllers, and
8803bc0ffaSSimon L. B. Nielsenis known to support the following hardware:
898faf6cdcSStanislav Sedov.Pp
908faf6cdcSStanislav Sedov.Bl -bullet -compact
918faf6cdcSStanislav Sedov.It
928faf6cdcSStanislav SedovASUS EeePC 701
938faf6cdcSStanislav Sedov.It
948faf6cdcSStanislav SedovASUS EeePC 900
958faf6cdcSStanislav Sedov.El
968faf6cdcSStanislav Sedov.Pp
978faf6cdcSStanislav SedovOther hardware may or may not work with this driver.
988faf6cdcSStanislav Sedov.Sh LOADER TUNABLES
998faf6cdcSStanislav SedovTunables can be set at the
1008faf6cdcSStanislav Sedov.Xr loader 8
1018faf6cdcSStanislav Sedovprompt before booting the kernel or stored in
1028faf6cdcSStanislav Sedov.Xr loader.conf 5 .
1038faf6cdcSStanislav Sedov.Bl -tag -width "xxxxxx"
1048faf6cdcSStanislav Sedov.It Va hw.ae.msi_disable
1058faf6cdcSStanislav SedovThis tunable disables MSI support on the Ethernet hardware.
1068faf6cdcSStanislav SedovThe default value is 0.
1078faf6cdcSStanislav Sedov.El
1088faf6cdcSStanislav Sedov.Sh SYSCTL VARIABLES
1098faf6cdcSStanislav SedovThe
1108faf6cdcSStanislav Sedov.Nm
1118faf6cdcSStanislav Sedovdriver collects a number of useful MAC counter during the work.
1128faf6cdcSStanislav SedovThe statistics is available via the
1138faf6cdcSStanislav Sedov.Va dev.ae.%d.stats
1148faf6cdcSStanislav Sedov.Xr sysctl 8
1158faf6cdcSStanislav Sedovtree, where %d corresponds to the controller number.
1168faf6cdcSStanislav Sedov.Sh DIAGNOSTICS
1178faf6cdcSStanislav Sedov.Bl -diag
1188faf6cdcSStanislav Sedov.It "ae%d: watchdog timeout."
1198faf6cdcSStanislav SedovThe device has stopped responding to the network, or there is a problem with
1208faf6cdcSStanislav Sedovthe network connection (cable).
1218faf6cdcSStanislav Sedov.It "ae%d: reset timeout."
1228faf6cdcSStanislav SedovThe card reset operation has been timed out.
1238faf6cdcSStanislav Sedov.It "ae%d: Generating random ethernet address."
124b1763c47SStanislav SedovNo valid Ethernet address was found in the controller NVRAM and registers.
1258faf6cdcSStanislav SedovRandom locally administered address with ASUS OUI identifier will be used
1268faf6cdcSStanislav Sedovinstead.
1278faf6cdcSStanislav Sedov.El
1288faf6cdcSStanislav Sedov.Sh SEE ALSO
1298faf6cdcSStanislav Sedov.Xr altq 4 ,
1308faf6cdcSStanislav Sedov.Xr arp 4 ,
1318faf6cdcSStanislav Sedov.Xr miibus 4 ,
1328faf6cdcSStanislav Sedov.Xr netintro 4 ,
1338faf6cdcSStanislav Sedov.Xr ng_ether 4 ,
1348faf6cdcSStanislav Sedov.Xr vlan 4 ,
1358faf6cdcSStanislav Sedov.Xr ifconfig 8
1360afc94c1SUlrich Spörlein.Sh HISTORY
1370afc94c1SUlrich SpörleinThe
1380afc94c1SUlrich Spörlein.Nm
1390afc94c1SUlrich Spörleindriver and this manual page was written by
1406c899950SBaptiste Daroussin.An Stanislav Sedov Aq Mt stas@FreeBSD.org .
1410afc94c1SUlrich SpörleinIt first appeared in
1420afc94c1SUlrich Spörlein.Fx 7.1 .
1438faf6cdcSStanislav Sedov.Sh BUGS
144b06cfd40SJoel DahlThe Attansic L2 FastEthernet controller supports DMA but does not use a
145b1763c47SStanislav Sedovdescriptor based transfer mechanism via scatter-gather DMA.
1468faf6cdcSStanislav SedovThus the data should be copied to/from the controller memory on each
1478faf6cdcSStanislav Sedovtransmit/receive.
1488faf6cdcSStanislav SedovFurthermore, a lot of data alignment restrictions apply.
1498faf6cdcSStanislav SedovThis may introduce a high CPU load on systems with heavy network activity.
1508faf6cdcSStanislav SedovLuckily enough this should not be a problem on modern hardware as L2 does
1518faf6cdcSStanislav Sedovnot support speeds faster than 100Mbps.
152