share/man/man4/age.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 .\" $FreeBSD$
  26 .\"
  27 .Dd September 18, 2008
  28 .Dt AGE 4
  29 .Os
  30 .Sh NAME
  31 .Nm age
  32 .Nd Attansic/Atheros L1 Gigabit 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 age"
  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_age_load="YES"
  47 .Ed
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 device driver provides support for Attansic/Atheros L1 PCI Express
  52 Gigabit Ethernet controllers.
  53 .Pp
  54 All LOMs supported by the
  55 .Nm
  56 driver have TCP/UDP/IP checksum offload for both transmit and
  57 receive, TCP segmentation offload (TSO), hardware VLAN tag
  58 stripping/insertion features and an interrupt moderation mechanism
  59 as well as a 64-bit multicast hash filter.
  60 .Pp
  61 The L1 also supports Jumbo Frames (up to 10240 bytes), which can be
  62 configured via the interface MTU setting.
  63 Selecting an MTU larger than 1500 bytes with the
  64 .Xr ifconfig 8
  65 utility configures the adapter to receive and transmit Jumbo Frames.
  66 .Pp
  67 The
  68 .Nm
  69 driver supports the following media types:
  70 .Bl -tag -width ".Cm 10baseT/UTP"
  71 .It Cm autoselect
  72 Enable autoselection of the media type and options.
  73 The user can manually override
  74 the autoselected mode by adding media options to
  75 .Xr rc.conf 5 .
  76 .It Cm 10baseT/UTP
  77 Set 10Mbps operation.
  78 .It Cm 100baseTX
  79 Set 100Mbps (Fast Ethernet) operation.
  80 .It Cm 1000baseTX
  81 Set 1000baseTX operation over twisted pair.
  82 .El
  83 .Pp
  84 The
  85 .Nm
  86 driver supports the following media options:
  87 .Bl -tag -width ".Cm full-duplex"
  88 .It Cm full-duplex
  89 Force full duplex operation.
  90 .It Cm half-duplex
  91 Force half duplex operation.
  92 .El
  93 .Pp
  94 For more information on configuring this device, see
  95 .Xr ifconfig 8 .
  96 .Sh HARDWARE
  97 The
  98 .Nm
  99 driver provides support for LOMs based on
 100 Attansic/Atheros L1 Gigabit Ethernet controller chips, including:
 101 .Pp
 102 .Bl -bullet -compact
 103 .It
 104 ASUS M2N8-VMX
 105 .It
 106 ASUS M2V
 107 .It
 108 ASUS M3A
 109 .It
 110 ASUS P2-M2A590G
 111 .It
 112 ASUS P5B-E
 113 .It
 114 ASUS P5B-MX/WIFI-AP
 115 .It
 116 ASUS P5B-VMSE
 117 .It
 118 ASUS P5K
 119 .It
 120 ASUS P5KC
 121 .It
 122 ASUS P5KPL-C
 123 .It
 124 ASUS P5KPL-VM
 125 .It
 126 ASUS P5K-SE
 127 .It
 128 ASUS P5K-V
 129 .It
 130 ASUS P5L-MX
 131 .It
 132 ASUS P5DL2-VM
 133 .It
 134 ASUS P5L-VM 1394
 135 .It
 136 ASUS G2S
 137 .El
 138 .Sh LOADER TUNABLES
 139 Tunables can be set at the
 140 .Xr loader 8
 141 prompt before booting the kernel or stored in
 142 .Xr loader.conf 5 .
 143 .Bl -tag -width "xxxxxx"
 144 .It Va hw.age.msi_disable
 145 This tunable disables MSI support on the Ethernet hardware.
 146 The default value is 0.
 147 .It Va hw.age.msix_disable
 148 This tunable disables MSI-X support on the Ethernet hardware.
 149 The default value is 0.
 150 .El
 151 .Sh SYSCTL VARIABLES
 152 The following variables are available as both
 153 .Xr sysctl 8
 154 variables and
 155 .Xr loader 8
 156 tunables:
 157 .Bl -tag -width "xxxxxx"
 158 .It Va dev.age.%d.int_mod
 159 Maximum amount of time to delay interrupt processing in units of
 160 2us.
 161 The accepted range is 0 to 65000, the default is 50 (100us).
 162 Value 0 completely disables the interrupt moderation.
 163 .It Va dev.age.%d.process_limit
 164 Maximum amount of Rx events to be processed in the event loop before
 165 rescheduling a taskqueue.
 166 The accepted range is 30 to 255, the default value is 128 events.
 167 The interface does not need to be brought down and up again before
 168 a change takes effect.
 169 .It Va dev.age.%d.stats
 170 Display lots of useful MAC counters maintained in the driver.
 171 .El
 172 .Sh SEE ALSO
 173 .Xr altq 4 ,
 174 .Xr arp 4 ,
 175 .Xr miibus 4 ,
 176 .Xr netintro 4 ,
 177 .Xr ng_ether 4 ,
 178 .Xr vlan 4 ,
 179 .Xr ifconfig 8
 180 .Sh HISTORY
 181 The
 182 .Nm
 183 driver was written by
 184 .An Pyun YongHyeon
 185 .Aq yongari@FreeBSD.org .
 186 It first appeared in
 187 .Fx 7.1 .