share/man/man4/ale.4

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