[dragonfly.git] / share / man / man4 / ae.4

.\" Copyright (c) 2008 Stanislav Sedov <stas@FreeBSD.org>
.\" All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD: src/share/man/man4/ae.4,v 1.2.2.1.4.1 2009/04/15 03:14:26 kensmith Exp $
.\"
.Dd July 13, 2009
.Dt AE 4
.Os
.Sh NAME
.Nm ae
.Nd "Attansic/Atheros L2 FastEthernet controller driver"
.Sh SYNOPSIS
To compile this driver into the kernel, place the following lines in your
kernel configuration file:
.Bd -ragged -offset indent
.Cd "device miibus"
.Cd "device ae"
.Ed
.Pp
Alternatively, to load the driver as a
module at boot time, place the following line in
.Xr loader.conf 5 :
.Bd -literal -offset indent
if_ae_load="YES"
.Ed
.Sh DESCRIPTION
The
.Nm
device driver provides support for Attansic/Atheros L2 PCIe FastEthernet
controllers.
.Pp
The controller supports hardware Ethernet checksum processing, hardware
VLAN tag stripping/insertion and an interrupt moderation mechanism.
Attansic L2 also features a 64-bit multicast hash filter.
.Pp
The
.Nm
driver supports the following media types:
.Bl -tag -width ".Cm 10baseT/UTP"
.It Cm autoselect
Enable autoselection of the media type and options.
The user can manually override the autoselected mode by
adding media options to
.Xr rc.conf 5 .
.It Cm 10baseT/UTP
Select 10Mbps operation.
.It Cm 100baseTX
Set 100Mbps (FastEthernet) operation.
.El
.Pp
The
.Nm
driver provides support for the following media options:
.Bl -tag -width ".Cm full-duplex"
.It Cm full-duplex
Force full duplex operation.
.It Cm half-duplex
Force half duplex operation.
.El
.Pp
For more information on configuring this device, see
.Xr ifconfig 8 .
.Sh HARDWARE
The
.Nm
driver supports Attansic/Atheros L2 PCIe FastEthernet controllers, and
is known to support the following hardware:
.Pp
.Bl -bullet -compact
.It
ASUS EeePC 701
.It
ASUS EeePC 900
.El
.Pp
Other hardware may or may not work with this driver.
.Sh SYSCTL VARIABLES
The
.Nm
driver collects a number of useful MAC counter during the work.
The statistics is available via the
.Va hw.ae%d.stats
.Xr sysctl 8
tree, where %d corresponds to the controller number.
.Sh DIAGNOSTICS
.Bl -diag
.It "ae%d: watchdog timeout."
The device has stopped responding to the network, or there is a problem with
the network connection (cable).
.It "ae%d: reset timeout."
The card reset operation has been timed out.
.It "ae%d: Generating random ethernet address."
No valid ethernet address was found neither in the controller registers not in
NVRAM.
Random locally administered address with ASUS OUI identifier will be used
instead.
.El
.Sh SEE ALSO
.Xr arp 4 ,
.Xr ifmedia 4 ,
.Xr miibus 4 ,
.Xr netintro 4 ,
.Xr ng_ether 4 ,
.Xr vlan 4 ,
.Xr ifconfig 8
.Sh HISTORY
The
.Nm
driver and this manual page was written by
.An Stanislav Sedov
.Aq stas@FreeBSD.org .
It first appeared in
.Fx 7.1 .
.Sh BUGS
The Attansic L2 FastEthernet contoller supports DMA but do not use a descriptor
based transfer mechanism via scatter-gather DMA.
Thus the data should be copied to/from the controller memory on each
transmit/receive.
Furthermore, a lot of data alignment restrictions apply.
This may introduce a high CPU load on systems with heavy network activity.
Luckily enough this should not be a problem on modern hardware as L2 does
not support speeds faster than 100Mbps.
Commit	Line	Data
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
	34	To compile this driver into the kernel, place the following lines in your
	35	kernel configuration file:
	36	.Bd -ragged -offset indent
	37	.Cd "device miibus"
	38	.Cd "device ae"
	39	.Ed
	40	.Pp
	41	Alternatively, to load the driver as a
	42	module at boot time, place the following line in
	43	.Xr loader.conf 5 :
0133958c	44	.Bd -literal -offset indent
245dd5f4 SZ	45	if_ae_load="YES"
	46	.Ed
	47	.Sh DESCRIPTION
	48	The
	49	.Nm
	50	device driver provides support for Attansic/Atheros L2 PCIe FastEthernet
	51	controllers.
	52	.Pp
	53	The controller supports hardware Ethernet checksum processing, hardware
	54	VLAN tag stripping/insertion and an interrupt moderation mechanism.
	55	Attansic L2 also features a 64-bit multicast hash filter.
	56	.Pp
	57	The
	58	.Nm
	59	driver supports the following media types:
	60	.Bl -tag -width ".Cm 10baseT/UTP"
	61	.It Cm autoselect
	62	Enable autoselection of the media type and options.
	63	The user can manually override the autoselected mode by
	64	adding media options to
	65	.Xr rc.conf 5 .
	66	.It Cm 10baseT/UTP
	67	Select 10Mbps operation.
	68	.It Cm 100baseTX
	69	Set 100Mbps (FastEthernet) operation.
	70	.El
	71	.Pp
	72	The
	73	.Nm
	74	driver provides support for the following media options:
	75	.Bl -tag -width ".Cm full-duplex"
	76	.It Cm full-duplex
	77	Force full duplex operation.
	78	.It Cm half-duplex
	79	Force half duplex operation.
	80	.El
	81	.Pp
	82	For more information on configuring this device, see
	83	.Xr ifconfig 8 .
	84	.Sh HARDWARE
	85	The
	86	.Nm
	87	driver supports Attansic/Atheros L2 PCIe FastEthernet controllers, and
	88	is known to support the following hardware:
	89	.Pp
	90	.Bl -bullet -compact
	91	.It
	92	ASUS EeePC 701
	93	.It
	94	ASUS EeePC 900
	95	.El
	96	.Pp
	97	Other hardware may or may not work with this driver.
	98	.Sh SYSCTL VARIABLES
	99	The
	100	.Nm
	101	driver collects a number of useful MAC counter during the work.
	102	The statistics is available via the
	103	.Va hw.ae%d.stats
	104	.Xr sysctl 8
	105	tree, where %d corresponds to the controller number.
	106	.Sh DIAGNOSTICS
	107	.Bl -diag
	108	.It "ae%d: watchdog timeout."
109	The device has stopped responding to the network, or there is a problem with
110	the network connection (cable).
111	.It "ae%d: reset timeout."
112	The card reset operation has been timed out.
113	.It "ae%d: Generating random ethernet address."
114	No valid ethernet address was found neither in the controller registers not in
115	NVRAM.
116	Random locally administered address with ASUS OUI identifier will be used
117	instead.
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
	128	The
	129	.Nm
	130	driver and this manual page was written by
	131	.An Stanislav Sedov
	132	.Aq stas@FreeBSD.org .
	133	It first appeared in
	134	.Fx 7.1 .
245dd5f4 SZ	135	.Sh BUGS
	136	The Attansic L2 FastEthernet contoller supports DMA but do not use a descriptor
	137	based transfer mechanism via scatter-gather DMA.
	138	Thus the data should be copied to/from the controller memory on each
	139	transmit/receive.
	140	Furthermore, a lot of data alignment restrictions apply.
	141	This may introduce a high CPU load on systems with heavy network activity.
	142	Luckily enough this should not be a problem on modern hardware as L2 does
	143	not support speeds faster than 100Mbps.