summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/ale.4 3.html
blob: a27678dfff33010f41722b130f7cf539a9dbd635 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
<table class="head">
  <tr>
    <td class="head-ltitle">ALE(4)</td>
    <td class="head-vol">Device Drivers Manual</td>
    <td class="head-rtitle">ALE(4)</td>
  </tr>
</table>
<div class="manual-text">
<section class="Sh">
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
<p class="Pp"><code class="Nm">ale</code> &#x2014; <span class="Nd">Atheros
    AR8121/AR8113/AR8114 Gigabit/Fast Ethernet driver</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp">To compile this driver into the kernel, place the following lines
    in your kernel configuration file:</p>
<div class="Bd Pp Bd-indent"><code class="Cd">device miibus</code>
<br/>
<code class="Cd">device ale</code></div>
<p class="Pp">Alternatively, to load the driver as a module at boot time, place
    the following line in <a class="Xr">loader.conf(5)</a>:</p>
<div class="Bd Pp Bd-indent Li">
<pre>if_ale_load=&quot;YES&quot;</pre>
</div>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The <code class="Nm">ale</code> device driver provides support for
    Atheros AR8121 PCI Express Gigabit Ethernet controllers and Atheros
    AR8113/AR8114 PCI Express Fast Ethernet controllers.</p>
<p class="Pp">All LOMs supported by the <code class="Nm">ale</code> driver have
    TCP/UDP/IP checksum offload for both receive and transmit, TCP segmentation
    offload (TSO), hardware VLAN tag stripping/insertion features, Wake On Lan
    (WOL) and an interrupt coalescing/moderation mechanism as well as a 64-bit
    multicast hash filter.</p>
<p class="Pp">The AR8121 also supports Jumbo Frames (up to 8132 bytes), which
    can be configured via the interface MTU setting. Selecting an MTU larger
    than 1500 bytes with the <a class="Xr">ifconfig(8)</a> utility configures
    the adapter to receive and transmit Jumbo Frames.</p>
<p class="Pp">The <code class="Nm">ale</code> driver supports the following
    media types:</p>
<dl class="Bl-tag">
  <dt id="autoselect"><a class="permalink" href="#autoselect"><code class="Cm">autoselect</code></a></dt>
  <dd>Enable autoselection of the media type and options. The user can manually
      override the autoselected mode by adding media options to
      <a class="Xr">rc.conf(5)</a>.</dd>
  <dt id="10baseT/UTP"><a class="permalink" href="#10baseT/UTP"><code class="Cm">10baseT/UTP</code></a></dt>
  <dd>Set 10Mbps operation.</dd>
  <dt id="100baseTX"><a class="permalink" href="#100baseTX"><code class="Cm">100baseTX</code></a></dt>
  <dd>Set 100Mbps (Fast Ethernet) operation.</dd>
  <dt id="1000baseTX"><a class="permalink" href="#1000baseTX"><code class="Cm">1000baseTX</code></a></dt>
  <dd>Set 1000baseTX operation over twisted pair.</dd>
</dl>
<p class="Pp">The <code class="Nm">ale</code> driver supports the following
    media options:</p>
<dl class="Bl-tag">
  <dt id="full-duplex"><a class="permalink" href="#full-duplex"><code class="Cm">full-duplex</code></a></dt>
  <dd>Force full duplex operation.</dd>
  <dt id="half-duplex"><a class="permalink" href="#half-duplex"><code class="Cm">half-duplex</code></a></dt>
  <dd>Force half duplex operation.</dd>
</dl>
<p class="Pp">For more information on configuring this device, see
    <a class="Xr">ifconfig(8)</a>.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1>
<p class="Pp">The <code class="Nm">ale</code> device driver provides support for
    the following Ethernet controllers:</p>
<p class="Pp"></p>
<ul class="Bl-bullet Bl-compact">
  <li>Atheros AR8113 PCI Express Fast Ethernet controller</li>
  <li>Atheros AR8114 PCI Express Fast Ethernet controller</li>
  <li>Atheros AR8121 PCI Express Gigabit Ethernet controller</li>
</ul>
</section>
<section class="Sh">
<h1 class="Sh" id="LOADER_TUNABLES"><a class="permalink" href="#LOADER_TUNABLES">LOADER
  TUNABLES</a></h1>
<p class="Pp">Tunables can be set at the <a class="Xr">loader(8)</a> prompt
    before booting the kernel or stored in <a class="Xr">loader.conf(5)</a>.</p>
<dl class="Bl-tag">
  <dt id="hw.ale.msi_disable"><var class="Va">hw.ale.msi_disable</var></dt>
  <dd>This tunable disables MSI support on the Ethernet hardware. The default
      value is 0.</dd>
  <dt id="hw.ale.msix_disable"><var class="Va">hw.ale.msix_disable</var></dt>
  <dd>This tunable disables MSI-X support on the Ethernet hardware. The default
      value is 0.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="SYSCTL_VARIABLES"><a class="permalink" href="#SYSCTL_VARIABLES">SYSCTL
  VARIABLES</a></h1>
<p class="Pp">The following variables are available as both
    <a class="Xr">sysctl(8)</a> variables and <a class="Xr">loader(8)</a>
    tunables:</p>
<dl class="Bl-tag">
  <dt id="dev.ale._d.int_rx_mod"><var class="Va">dev.ale.%d.int_rx_mod</var></dt>
  <dd>Maximum amount of time to delay receive interrupt processing in units of
      1us. The accepted range is 0 to 130000, the default is 30(30us). Value 0
      completely disables the interrupt moderation.</dd>
  <dt id="dev.ale._d.int_tx_mod"><var class="Va">dev.ale.%d.int_tx_mod</var></dt>
  <dd>Maximum amount of time to delay transmit interrupt processing in units of
      1us. The accepted range is 0 to 130000, the default is 1000(1ms). Value 0
      completely disables the interrupt moderation.</dd>
  <dt id="dev.ale._d.process_limit"><var class="Va">dev.ale.%d.process_limit</var></dt>
  <dd>Maximum amount of Rx frames to be processed in the event loop before
      rescheduling a taskqueue. The accepted range is 32 to 255, the default
      value is 128 events. The interface does not need to be brought down and up
      again before a change takes effect.</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
  ALSO</a></h1>
<p class="Pp"><a class="Xr">altq(4)</a>, <a class="Xr">arp(4)</a>,
    <a class="Xr">miibus(4)</a>, <a class="Xr">netintro(4)</a>,
    <a class="Xr">ng_ether(4)</a>, <a class="Xr">vlan(4)</a>,
    <a class="Xr">ifconfig(8)</a></p>
</section>
<section class="Sh">
<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
<p class="Pp">The <code class="Nm">ale</code> driver was written by
    <span class="An">Pyun YongHyeon</span>
    &lt;<a class="Mt" href="mailto:yongari@FreeBSD.org">yongari@FreeBSD.org</a>&gt;.
    It first appeared in <span class="Ux">FreeBSD 7.1</span>.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">November 12, 2008</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>