Sort sections in various manual pages.
[dragonfly.git] / share / man / man4 / ae.4
CommitLineData
245dd5f4
SZ
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: src/share/man/man4/ae.4,v 1.2.2.1.4.1 2009/04/15 03:14:26 kensmith Exp $
26.\"
27.Dd July 13, 2009
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 :
0133958c 44.Bd -literal -offset indent
245dd5f4
SZ
45if_ae_load="YES"
46.Ed
47.Sh DESCRIPTION
48The
49.Nm
50device driver provides support for Attansic/Atheros L2 PCIe FastEthernet
51controllers.
52.Pp
53The controller supports hardware Ethernet checksum processing, hardware
54VLAN tag stripping/insertion and an interrupt moderation mechanism.
55Attansic L2 also features a 64-bit multicast hash filter.
56.Pp
57The
58.Nm
59driver supports the following media types:
60.Bl -tag -width ".Cm 10baseT/UTP"
61.It Cm autoselect
62Enable autoselection of the media type and options.
63The user can manually override the autoselected mode by
64adding media options to
65.Xr rc.conf 5 .
66.It Cm 10baseT/UTP
67Select 10Mbps operation.
68.It Cm 100baseTX
69Set 100Mbps (FastEthernet) operation.
70.El
71.Pp
72The
73.Nm
74driver provides support for the following media options:
75.Bl -tag -width ".Cm full-duplex"
76.It Cm full-duplex
77Force full duplex operation.
78.It Cm half-duplex
79Force half duplex operation.
80.El
81.Pp
82For more information on configuring this device, see
83.Xr ifconfig 8 .
84.Sh HARDWARE
85The
86.Nm
87driver supports Attansic/Atheros L2 PCIe FastEthernet controllers, and
88is known to support the following hardware:
89.Pp
90.Bl -bullet -compact
91.It
92ASUS EeePC 701
93.It
94ASUS EeePC 900
95.El
96.Pp
97Other hardware may or may not work with this driver.
98.Sh SYSCTL VARIABLES
99The
100.Nm
101driver collects a number of useful MAC counter during the work.
102The statistics is available via the
103.Va hw.ae%d.stats
104.Xr sysctl 8
105tree, where %d corresponds to the controller number.
106.Sh DIAGNOSTICS
107.Bl -diag
108.It "ae%d: watchdog timeout."
109The device has stopped responding to the network, or there is a problem with
110the network connection (cable).
111.It "ae%d: reset timeout."
112The card reset operation has been timed out.
113.It "ae%d: Generating random ethernet address."
114No valid ethernet address was found neither in the controller registers not in
115NVRAM.
116Random locally administered address with ASUS OUI identifier will be used
117instead.
118.El
119.Sh SEE ALSO
120.Xr arp 4 ,
121.Xr ifmedia 4 ,
122.Xr miibus 4 ,
123.Xr netintro 4 ,
124.Xr ng_ether 4 ,
125.Xr vlan 4 ,
126.Xr ifconfig 8
a68e0df0
SW
127.Sh HISTORY
128The
129.Nm
130driver and this manual page was written by
131.An Stanislav Sedov
132.Aq stas@FreeBSD.org .
133It first appeared in
134.Fx 7.1 .
245dd5f4
SZ
135.Sh BUGS
136The Attansic L2 FastEthernet contoller supports DMA but do not use a descriptor
137based transfer mechanism via scatter-gather DMA.
138Thus the data should be copied to/from the controller memory on each
139transmit/receive.
140Furthermore, a lot of data alignment restrictions apply.
141This may introduce a high CPU load on systems with heavy network activity.
142Luckily enough this should not be a problem on modern hardware as L2 does
143not support speeds faster than 100Mbps.