summaryrefslogtreecommitdiffstats
path: root/share/man
diff options
context:
space:
mode:
authoryongari <yongari@FreeBSD.org>2009-06-10 02:19:54 +0000
committeryongari <yongari@FreeBSD.org>2009-06-10 02:19:54 +0000
commitb801626916402df5d41fcce5875fa29ff7fd845c (patch)
tree92501310fc1bee2f3fa1d6904d5e09a2f81211a6 /share/man
parenta09ebeada8be158c6a8b7a65c80851342f97ce3f (diff)
downloadFreeBSD-src-b801626916402df5d41fcce5875fa29ff7fd845c.zip
FreeBSD-src-b801626916402df5d41fcce5875fa29ff7fd845c.tar.gz
Add alc(4) man page and hook up ale(4) to the build.
Also add Xr to appropriate man pages.
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man4/Makefile1
-rw-r--r--share/man/man4/alc.4160
-rw-r--r--share/man/man4/altq.43
-rw-r--r--share/man/man4/miibus.45
-rw-r--r--share/man/man4/vlan.43
5 files changed, 169 insertions, 3 deletions
diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index 9d6debb..da62a9f 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -23,6 +23,7 @@ MAN= aac.4 \
ahc.4 \
ahd.4 \
aio.4 \
+ alc.4 \
ale.4 \
altq.4 \
amd.4 \
diff --git a/share/man/man4/alc.4 b/share/man/man4/alc.4
new file mode 100644
index 0000000..94be944
--- /dev/null
+++ b/share/man/man4/alc.4
@@ -0,0 +1,160 @@
+.\" Copyright (c) 2009 Pyun YongHyeon
+.\" 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$
+.\"
+.Dd June 10, 2009
+.Dt ALC 4
+.Os
+.Sh NAME
+.Nm alc
+.Nd Atheros AR8131/AR8132 Gigabit/Fast Ethernet 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 alc"
+.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_alc_load="YES"
+.Ed
+.Sh DESCRIPTION
+The
+.Nm
+device driver provides support for Atheros AR8131 PCI Express
+Gigabit Ethernet controllers and Atheros AR8132 PCI Express
+Fast Ethernet controllers.
+.Pp
+All LOMs supported by the
+.Nm
+driver have TCP/UDP/IP checksum offload for transmit, TCP
+segmentation offload (TSO), hardware VLAN tag stripping/insertion
+features, Wake On Lan (WOL) and an interrupt moderation mechanism
+as well as a 64-bit multicast hash filter.
+.Pp
+The AR8131/AR8132 supports Jumbo Frames (up to 9216 bytes), which can
+be configured via the interface MTU setting.
+Selecting an MTU larger than 1500 bytes with the
+.Xr ifconfig 8
+utility configures the adapter to receive and transmit Jumbo Frames.
+.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
+Set 10Mbps operation.
+.It Cm 100baseTX
+Set 100Mbps (Fast Ethernet) operation.
+.It Cm 1000baseTX
+Set 1000baseTX operation over twisted pair.
+.El
+.Pp
+The
+.Nm
+driver supports 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
+device driver provides support for the following Ethernet controllers:
+.Pp
+.Bl -bullet -compact
+.It
+Atheros AR8131 PCI Express Gigabit Ethernet controller
+.It
+Atheros AR8132 PCI Express Fast Ethernet controller
+.El
+.Sh LOADER TUNABLES
+Tunables can be set at the
+.Xr loader 8
+prompt before booting the kernel or stored in
+.Xr loader.conf 5 .
+.Bl -tag -width "xxxxxx"
+.It Va hw.alc.msi_disable
+This tunable disables MSI support on the Ethernet hardware.
+The default value is 0.
+.It Va hw.alc.msix_disable
+This tunable disables MSI-X support on the Ethernet hardware.
+The default value is 0.
+.El
+.Sh SYSCTL VARIABLES
+The following variables are available as both
+.Xr sysctl 8
+variables and
+.Xr loader 8
+tunables:
+.Bl -tag -width "xxxxxx"
+.It Va dev.alc.%d.int_rx_mod
+Maximum amount of time to delay receive interrupt processing in
+units of 1us.
+The accepted range is 0 to 130000, the default is 100(100us).
+Value 0 completely disables the interrupt moderation.
+.It Va dev.alc.%d.int_tx_mod
+Maximum amount of time to delay transmit interrupt processing in
+units of 1us.
+The accepted range is 0 to 130000, the default is 50000(50ms).
+Value 0 completely disables the interrupt moderation.
+.It Va dev.alc.%d.process_limit
+Maximum amount of Rx frames to be processed in the event loop before
+rescheduling a taskqueue.
+The accepted range is 32 to 255, the default value is 64 events.
+The interface does not need to be brought down and up again before
+a change takes effect.
+.El
+.Sh SEE ALSO
+.Xr altq 4 ,
+.Xr arp 4 ,
+.Xr miibus 4 ,
+.Xr netintro 4 ,
+.Xr ng_ether 4 ,
+.Xr vlan 4 ,
+.Xr ifconfig 8
+.Sh HISTORY
+The
+.Nm
+driver was written by
+.An Pyun YongHyeon
+.Aq yongari@FreeBSD.org .
+It first appeared in
+.Fx 8.0 .
diff --git a/share/man/man4/altq.4 b/share/man/man4/altq.4
index 5f5cae2..674ffe9 100644
--- a/share/man/man4/altq.4
+++ b/share/man/man4/altq.4
@@ -25,7 +25,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd May 21, 2009
+.Dd June 10, 2009
.Dt ALTQ 4
.Os
.Sh NAME
@@ -116,6 +116,7 @@ are required to use a certain network card with
.Nm .
They have been applied to the following hardware drivers:
.Xr age 4 ,
+.Xr alc 4 ,
.Xr ale 4 ,
.Xr an 4 ,
.Xr ath 4 ,
diff --git a/share/man/man4/miibus.4 b/share/man/man4/miibus.4
index a8ebab3..e6f31d6 100644
--- a/share/man/man4/miibus.4
+++ b/share/man/man4/miibus.4
@@ -8,7 +8,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd November 12, 2008
+.Dd June 10, 2009
.Dt MIIBUS 4
.Os
.Sh NAME
@@ -47,6 +47,8 @@ interface:
.Bl -tag -compact -width ".Xr fxp 4"
.It Xr age 4
Attansic/Atheros L1 Gigabit Ethernet
+.It Xr alc 4
+Atheros AR8131/AR8132 PCIe Ethernet
.It Xr ale 4
Atheros AR8121/AR8113/AR8114 PCIe Ethernet
.It Xr aue 4
@@ -127,6 +129,7 @@ and
but as a result are not well behaved newbus device drivers.
.Sh SEE ALSO
.Xr age 4 ,
+.Xr alc 4 ,
.Xr ale 4 ,
.Xr arp 4 ,
.Xr aue 4 ,
diff --git a/share/man/man4/vlan.4 b/share/man/man4/vlan.4
index 8467d1a..4863f4b 100644
--- a/share/man/man4/vlan.4
+++ b/share/man/man4/vlan.4
@@ -25,7 +25,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd November 12, 2008
+.Dd June 10, 2009
.Dt VLAN 4
.Os
.Sh NAME
@@ -123,6 +123,7 @@ By now, the list of physical interfaces able of full VLAN processing
in the hardware is limited to the following devices:
.Xr ae 4 ,
.Xr age 4 ,
+.Xr alc 4 ,
.Xr ale 4 ,
.Xr bce 4 ,
.Xr bge 4 ,
OpenPOWER on IntegriCloud