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