/share/man/man4/alc.4

  1.\" Copyright (c) 2009 Pyun YongHyeon
  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 August 9, 2010
 28.Dt ALC 4
 29.Os
 30.Sh NAME
 31.Nm alc
 32.Nd Atheros AR813x/AR815x Gigabit/Fast Ethernet driver
 33.Sh SYNOPSIS
 34To compile this driver into the kernel,
 35place the following lines in your
 36kernel configuration file:
 37.Bd -ragged -offset indent
 38.Cd "device miibus"
 39.Cd "device alc"
 40.Ed
 41.Pp
 42Alternatively, to load the driver as a
 43module at boot time, place the following line in
 44.Xr loader.conf 5 :
 45.Bd -literal -offset indent
 46if_alc_load="YES"
 47.Ed
 48.Sh DESCRIPTION
 49The
 50.Nm
 51device driver provides support for Atheros AR813x and AR815x PCI
 52Express Gigabit/Fast Ethernet controllers.
 53.Pp
 54All LOMs supported by the
 55.Nm
 56driver have TCP/UDP/IP checksum offload for transmit, TCP
 57segmentation offload (TSO), hardware VLAN tag stripping/insertion
 58features, Wake On Lan (WOL) and an interrupt moderation mechanism
 59as well as a 64-bit multicast hash filter.
 60.Pp
 61The AR813x and AR815x supports Jumbo Frames (up to 9216 and 6144
 62bytes, respectively), which can be configured via the interface
 63MTU setting.
 64Selecting an MTU larger than 1500 bytes with the
 65.Xr ifconfig 8
 66utility configures the adapter to receive and transmit Jumbo Frames.
 67.Pp
 68The
 69.Nm
 70driver supports the following media types:
 71.Bl -tag -width ".Cm 10baseT/UTP"
 72.It Cm autoselect
 73Enable autoselection of the media type and options.
 74The user can manually override
 75the autoselected mode by adding media options to
 76.Xr rc.conf 5 .
 77.It Cm 10baseT/UTP
 78Set 10Mbps operation.
 79.It Cm 100baseTX
 80Set 100Mbps (Fast Ethernet) operation.
 81.It Cm 1000baseTX
 82Set 1000baseTX operation over twisted pair.
 83.El
 84.Pp
 85The
 86.Nm
 87driver supports the following media options:
 88.Bl -tag -width ".Cm full-duplex"
 89.It Cm full-duplex
 90Force full duplex operation.
 91.It Cm half-duplex
 92Force half duplex operation.
 93.El
 94.Pp
 95For more information on configuring this device, see
 96.Xr ifconfig 8 .
 97.Sh HARDWARE
 98The
 99.Nm
100device driver provides support for the following Ethernet controllers:
101.Pp
102.Bl -bullet -compact
103.It
104Atheros AR8131 PCI Express Gigabit Ethernet controller
105.It
106Atheros AR8132 PCI Express Fast Ethernet controller
107.It
108Atheros AR8151 v1.0 PCI Express Gigabit Ethernet controller
109.It
110Atheros AR8151 v2.0 PCI Express Gigabit Ethernet controller
111.It
112Atheros AR8152 v1.1 PCI Express Fast Ethernet controller
113.It
114Atheros AR8152 v2.0 PCI Express Fast Ethernet controller
115.El
116.Sh LOADER TUNABLES
117Tunables can be set at the
118.Xr loader 8
119prompt before booting the kernel or stored in
120.Xr loader.conf 5 .
121.Bl -tag -width "xxxxxx"
122.It Va hw.alc.msi_disable
123This tunable disables MSI support on the Ethernet hardware.
124The default value is 0.
125.It Va hw.alc.msix_disable
126This tunable disables MSI-X support on the Ethernet hardware.
127The default value is 0.
128.El
129.Sh SYSCTL VARIABLES
130The following variables are available as both
131.Xr sysctl 8
132variables and
133.Xr loader 8
134tunables:
135.Bl -tag -width "xxxxxx"
136.It Va dev.alc.%d.int_rx_mod
137Maximum amount of time to delay receive interrupt processing in
138units of 1us.
139The accepted range is 0 to 130000, the default is 100(100us).
140Value 0 completely disables the interrupt moderation.
141.It Va dev.alc.%d.int_tx_mod
142Maximum amount of time to delay transmit interrupt processing in
143units of 1us.
144The accepted range is 0 to 130000, the default is 1000(1ms).
145Value 0 completely disables the interrupt moderation.
146.It Va dev.alc.%d.process_limit
147Maximum amount of Rx frames to be processed in the event loop before
148rescheduling a taskqueue.
149The accepted range is 32 to 255, the default value is 64 events.
150The interface does not need to be brought down and up again before
151a change takes effect.
152.El
153.Sh SEE ALSO
154.Xr altq 4 ,
155.Xr arp 4 ,
156.Xr miibus 4 ,
157.Xr netintro 4 ,
158.Xr ng_ether 4 ,
159.Xr vlan 4 ,
160.Xr ifconfig 8
161.Sh HISTORY
162The
163.Nm
164driver was written by
165.An Pyun YongHyeon
166.Aq yongari@FreeBSD.org .
167It first appeared in
168.Fx 8.0 .