1.\" Copyright (c) 2008 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 November 12, 2008 28.Dt ALE 4 29.Os 30.Sh NAME 31.Nm ale 32.Nd Atheros AR8121/AR8113/AR8114 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 ale" 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_ale_load="YES" 47.Ed 48.Sh DESCRIPTION 49The 50.Nm 51device driver provides support for Atheros AR8121 PCI Express 52Gigabit Ethernet controllers and Atheros AR8113/AR8114 PCI 53Express Fast Ethernet controllers. 54.Pp 55All LOMs supported by the 56.Nm 57driver have TCP/UDP/IP checksum offload for both receive and transmit, 58TCP segmentation offload (TSO), hardware VLAN tag stripping/insertion 59features, Wake On Lan (WOL) and an interrupt coalescing/moderation 60mechanism as well as a 64-bit multicast hash filter. 61.Pp 62The AR8121 also supports Jumbo Frames (up to 8132 bytes), which can 63be configured via the interface MTU 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 AR8113 PCI Express Fast Ethernet controller 105.It 106Atheros AR8114 PCI Express Fast Ethernet controller 107.It 108Atheros AR8121 PCI Express Gigabit Ethernet controller 109.El 110.Sh LOADER TUNABLES 111Tunables can be set at the 112.Xr loader 8 113prompt before booting the kernel or stored in 114.Xr loader.conf 5 . 115.Bl -tag -width "xxxxxx" 116.It Va hw.ale.msi_disable 117This tunable disables MSI support on the Ethernet hardware. 118The default value is 0. 119.It Va hw.ale.msix_disable 120This tunable disables MSI-X support on the Ethernet hardware. 121The default value is 0. 122.El 123.Sh SYSCTL VARIABLES 124The following variables are available as both 125.Xr sysctl 8 126variables and 127.Xr loader 8 128tunables: 129.Bl -tag -width "xxxxxx" 130.It Va dev.ale.%d.int_rx_mod 131Maximum amount of time to delay receive interrupt processing in 132units of 1us. 133The accepted range is 0 to 130000, the default is 30(30us). 134Value 0 completely disables the interrupt moderation. 135.It Va dev.ale.%d.int_tx_mod 136Maximum amount of time to delay transmit interrupt processing in 137units of 1us. 138The accepted range is 0 to 130000, the default is 1000(1ms). 139Value 0 completely disables the interrupt moderation. 140.It Va dev.ale.%d.process_limit 141Maximum amount of Rx frames to be processed in the event loop before 142rescheduling a taskqueue. 143The accepted range is 32 to 255, the default value is 128 events. 144The interface does not need to be brought down and up again before 145a change takes effect. 146.El 147.Sh SEE ALSO 148.Xr altq 4 , 149.Xr arp 4 , 150.Xr miibus 4 , 151.Xr netintro 4 , 152.Xr ng_ether 4 , 153.Xr vlan 4 , 154.Xr ifconfig 8 155.Sh HISTORY 156The 157.Nm 158driver was written by 159.An Pyun YongHyeon 160.Aq yongari@FreeBSD.org . 161It first appeared in 162.Fx 7.1 . 163