1 .\" Copyright (c) 2008 Pyun YongHyeon
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .Nd Atheros AR8121/AR8113/AR8114 Gigabit/Fast Ethernet driver
34 To compile this driver into the kernel,
35 place the following lines in your
36 kernel configuration file:
37 .Bd -ragged -offset indent
42 Alternatively, to load the driver as a
43 module at boot time, place the following line in
45 .Bd -literal -offset indent
51 device driver provides support for Atheros AR8121 PCI Express
52 Gigabit Ethernet controllers and Atheros AR8113/AR8114 PCI
53 Express Fast Ethernet controllers.
55 All LOMs supported by the
57 driver have TCP/UDP/IP checksum offload for both receive and transmit,
58 TCP segmentation offload (TSO), hardware VLAN tag stripping/insertion
59 features, Wake On Lan (WOL) and an interrupt coalescing/moderation
60 mechanism as well as a 64-bit multicast hash filter.
62 The AR8121 also supports Jumbo Frames (up to 8132 bytes), which can
63 be configured via the interface MTU setting.
64 Selecting an MTU larger than 1500 bytes with the
66 utility configures the adapter to receive and transmit Jumbo Frames.
70 driver supports the following media types:
71 .Bl -tag -width ".Cm 10baseT/UTP"
73 Enable autoselection of the media type and options.
74 The user can manually override
75 the autoselected mode by adding media options to
80 Set 100Mbps (Fast Ethernet) operation.
82 Set 1000baseTX operation over twisted pair.
87 driver supports the following media options:
88 .Bl -tag -width ".Cm full-duplex"
90 Force full duplex operation.
92 Force half duplex operation.
95 For more information on configuring this device, see
100 device driver provides support for the following Ethernet controllers:
104 Atheros AR8113 PCI Express Fast Ethernet controller
106 Atheros AR8114 PCI Express Fast Ethernet controller
108 Atheros AR8121 PCI Express Gigabit Ethernet controller
111 Tunables can be set at the
113 prompt before booting the kernel or stored in
115 .Bl -tag -width "xxxxxx"
116 .It Va hw.ale.msi_disable
117 This tunable disables MSI support on the Ethernet hardware.
118 The default value is 0.
119 .It Va hw.ale.msix_disable
120 This tunable disables MSI-X support on the Ethernet hardware.
121 The default value is 0.
124 The following variables are available as both
129 .Bl -tag -width "xxxxxx"
130 .It Va dev.ale.%d.int_rx_mod
131 Maximum amount of time to delay receive interrupt processing in
133 The accepted range is 0 to 130000, the default is 30(30us).
134 Value 0 completely disables the interrupt moderation.
135 .It Va dev.ale.%d.int_tx_mod
136 Maximum amount of time to delay transmit interrupt processing in
138 The accepted range is 0 to 130000, the default is 1000(1ms).
139 Value 0 completely disables the interrupt moderation.
140 .It Va dev.ale.%d.process_limit
141 Maximum amount of Rx frames to be processed in the event loop before
142 rescheduling a taskqueue.
143 The accepted range is 32 to 255, the default value is 128 events.
144 The interface does not need to be brought down and up again before
145 a change takes effect.
158 driver was written by
160 .Aq yongari@FreeBSD.org .