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