diff options
Diffstat (limited to 'static/freebsd/man4/em.4 3.html')
| -rw-r--r-- | static/freebsd/man4/em.4 3.html | 243 |
1 files changed, 243 insertions, 0 deletions
diff --git a/static/freebsd/man4/em.4 3.html b/static/freebsd/man4/em.4 3.html new file mode 100644 index 00000000..028ade0a --- /dev/null +++ b/static/freebsd/man4/em.4 3.html @@ -0,0 +1,243 @@ +<table class="head"> + <tr> + <td class="head-ltitle">EM(4)</td> + <td class="head-vol">Device Drivers Manual</td> + <td class="head-rtitle">EM(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">em</code>, <code class="Nm">lem</code>, + <code class="Nm">igb</code> — <span class="Nd">Intel(R) PRO/1000 + Gigabit Ethernet adapter 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 iflib</code> +<br/> +<code class="Cd">device em</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_em_load="YES"</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">em</code> driver provides support for + PCI/PCI-X Gigabit Ethernet adapters based on the Intel 82540, 82541ER, + 82541PI, 82542, 82543, 82544, 82545, 82546, 82546EB, 82546GB, and 82547 + controller chips.</p> +<p class="Pp">The <code class="Nm">em</code> driver provides support for PCI + Express Gigabit Ethernet adapters based on the Intel 82571, 82572, 82573, + 82574, and 82583 Ethernet controller chips.</p> +<p class="Pp">The <code class="Nm">em</code> driver provides support for Gigabit + Ethernet adapters connected to I/O Controller Hub (ICH) and Platform + Controller Hub (PCH) including Intel 80003ES2LAN, 82562, 82566, 82567, + 82577, 82578, 82579, i217, i218, and i219.</p> +<p class="Pp">The <code class="Nm">em</code> driver provides support for PCI + Express Gigabit Ethernet adapters based on the Intel 82575, 82576, 82580, + i210, i211, and i35x. These appear as <code class="Nm">igb</code> interfaces + to maintain compatibility with existing infrastructure.</p> +<p class="Pp">The driver supports Transmit/Receive checksum offload and Jumbo + Frames on all but 82542-based adapters.</p> +<p class="Pp">Furthermore it supports TCP segmentation offload (TSO) on all + adapters but those based on the 82542, 82543, 82544 and 82547 controller + chips. The identification LEDs of the adapters supported by the + <code class="Nm">em</code> driver can be controlled via the + <a class="Xr">led(4)</a> API for localization purposes. For further hardware + information, see the <span class="Pa">README</span> included with the + driver.</p> +<p class="Pp">For questions related to hardware requirements, refer to the + documentation supplied with your Intel PRO/1000 adapter. All hardware + requirements listed apply to use with <span class="Ux">FreeBSD</span>.</p> +<p class="Pp">Support for Jumbo Frames is provided 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. The maximum MTU size for Jumbo Frames is 16114.</p> +<p class="Pp">This driver supports hardware assisted VLANs. The + <code class="Nm">em</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>Enables auto-negotiation for speed and duplex.</dd> + <dt id="10baseT/UTP"><a class="permalink" href="#10baseT/UTP"><code class="Cm">10baseT/UTP</code></a></dt> + <dd>Sets 10Mbps operation. Use the <code class="Cm">mediaopt</code> option to + select <code class="Cm">full-duplex</code> mode.</dd> + <dt id="100baseTX"><a class="permalink" href="#100baseTX"><code class="Cm">100baseTX</code></a></dt> + <dd>Sets 100Mbps operation. Use the <code class="Cm">mediaopt</code> option to + select <code class="Cm">full-duplex</code> mode.</dd> + <dt id="1000baseSX"><a class="permalink" href="#1000baseSX"><code class="Cm">1000baseSX</code></a></dt> + <dd>Sets 1000Mbps operation. Only <code class="Cm">full-duplex</code> mode is + supported at this speed.</dd> + <dt id="1000baseTX"><a class="permalink" href="#1000baseTX"><code class="Cm">1000baseTX</code></a></dt> + <dd>Sets 1000Mbps operation. Only <code class="Cm">full-duplex</code> mode is + supported at this speed.</dd> +</dl> +<p class="Pp">The <code class="Nm">em</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>Forces full-duplex operation</dd> + <dt id="half-duplex"><a class="permalink" href="#half-duplex"><code class="Cm">half-duplex</code></a></dt> + <dd>Forces half-duplex operation.</dd> +</dl> +<p class="Pp">Only use <code class="Cm">mediaopt</code> to set the driver to + <code class="Cm">full-duplex</code>. If <code class="Cm">mediaopt</code> is + not specified, the driver defaults to + <code class="Cm">half-duplex</code>.</p> +<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">em</code> driver supports Gigabit Ethernet + adapters based on the Intel 82540, 82541ER, 82541PI, 82542, 82543, 82544, + 82545, 82546, 82546EB, 82546GB, 82547, 82571, 82572, 82573, 82574, 82575, + 82576, and 82580 controller chips:</p> +<p class="Pp"></p> +<ul class="Bl-bullet Bl-compact"> + <li>Intel Gigabit ET Dual Port Server Adapter (82576)</li> + <li>Intel Gigabit VT Quad Port Server Adapter (82575)</li> + <li>Intel Single, Dual and Quad Gigabit Ethernet Controller (82580)</li> + <li>Intel i210 and i211 Gigabit Ethernet Controller</li> + <li>Intel i350 and i354 Gigabit Ethernet Controller</li> + <li>Intel PRO/1000 CT Network Connection (82547)</li> + <li>Intel PRO/1000 F Server Adapter (82543)</li> + <li>Intel PRO/1000 Gigabit Server Adapter (82542)</li> + <li>Intel PRO/1000 GT Desktop Adapter (82541PI)</li> + <li>Intel PRO/1000 MF Dual Port Server Adapter (82546)</li> + <li>Intel PRO/1000 MF Server Adapter (82545)</li> + <li>Intel PRO/1000 MF Server Adapter (LX) (82545)</li> + <li>Intel PRO/1000 MT Desktop Adapter (82540)</li> + <li>Intel PRO/1000 MT Desktop Adapter (82541)</li> + <li>Intel PRO/1000 MT Dual Port Server Adapter (82546)</li> + <li>Intel PRO/1000 MT Quad Port Server Adapter (82546EB)</li> + <li>Intel PRO/1000 MT Server Adapter (82545)</li> + <li>Intel PRO/1000 PF Dual Port Server Adapter (82571)</li> + <li>Intel PRO/1000 PF Quad Port Server Adapter (82571)</li> + <li>Intel PRO/1000 PF Server Adapter (82572)</li> + <li>Intel PRO/1000 PT Desktop Adapter (82572)</li> + <li>Intel PRO/1000 PT Dual Port Server Adapter (82571)</li> + <li>Intel PRO/1000 PT Quad Port Server Adapter (82571)</li> + <li>Intel PRO/1000 PT Server Adapter (82572)</li> + <li>Intel PRO/1000 T Desktop Adapter (82544)</li> + <li>Intel PRO/1000 T Server Adapter (82543)</li> + <li>Intel PRO/1000 XF Server Adapter (82544)</li> + <li>Intel PRO/1000 XT Server Adapter (82544)</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>. See + <a class="Xr">iflib(4)</a> for per-instance variables.</p> +<dl class="Bl-tag"> + <dt id="hw.em.disable_crc_stripping"><var class="Va">hw.em.disable_crc_stripping</var></dt> + <dd>Disable or enable hardware stripping of CRC field. This is mostly useful + on BMC/IPMI shared interfaces where stripping the CRC causes remote access + over IPMI to fail. Default 0 (enabled).</dd> + <dt id="hw.em.eee_setting"><var class="Va">hw.em.eee_setting</var></dt> + <dd>Disable or enable Energy Efficient Ethernet. Default 1 (disabled).</dd> + <dt id="hw.em.smart_pwr_down"><var class="Va">hw.em.smart_pwr_down</var></dt> + <dd>Enable or disable smart power down features on newer adapters. Default 0 + (disabled).</dd> + <dt id="hw.em.sbp"><var class="Va">hw.em.sbp</var></dt> + <dd>Show bad packets when in promiscuous mode. Default 0 (off).</dd> + <dt id="hw.em.rx_int_delay"><var class="Va">hw.em.rx_int_delay</var></dt> + <dd>This value delays the generation of receive interrupts in units of 1.024 + microseconds. The default value is 0, since adapters may hang with this + feature being enabled.</dd> + <dt id="hw.em.rx_abs_int_delay"><var class="Va">hw.em.rx_abs_int_delay</var></dt> + <dd>If <var class="Va">hw.em.rx_int_delay</var> is non-zero, this tunable + limits the maximum delay in which a receive interrupt is generated.</dd> + <dt id="hw.em.tx_int_delay"><var class="Va">hw.em.tx_int_delay</var></dt> + <dd>This value delays the generation of transmit interrupts in units of 1.024 + microseconds. The default value is 64.</dd> + <dt id="hw.em.tx_abs_int_delay"><var class="Va">hw.em.tx_abs_int_delay</var></dt> + <dd>If <var class="Va">hw.em.tx_int_delay</var> is non-zero, this tunable + limits the maximum delay in which a transmit interrupt is generated.</dd> + <dt id="hw.em.max_interrupt_rate"><var class="Va">hw.em.max_interrupt_rate</var></dt> + <dd>Maximum interrupts per second. The default value is 8000.</dd> + <dt id="hw.em.rx_process_limit"><var class="Va">hw.em.rx_process_limit</var></dt> + <dd>Maximum number of received packets to process at a time, -1 means + unlimited. The default value is 100.</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1> +<dl class="Bl-tag"> + <dt><span class="Pa">/dev/led/em*</span></dt> + <dd>identification LED device nodes</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1> +<p class="Pp">Make the identification LED of em0 blink:</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Li">echo f2 > + /dev/led/em0</code></div> +<p class="Pp">Turn the identification LED of em0 off again:</p> +<p class="Pp"></p> +<div class="Bd Bd-indent"><code class="Li">echo 0 > /dev/led/em0</code></div> +</section> +<section class="Sh"> +<h1 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOSTICS</a></h1> +<dl class="Bl-diag"> + <dt>em%d: Unable to allocate bus resource: memory</dt> + <dd>A fatal initialization error has occurred.</dd> + <dt>em%d: Unable to allocate bus resource: interrupt</dt> + <dd>A fatal initialization error has occurred.</dd> + <dt>em%d: watchdog timeout -- resetting</dt> + <dd>The device has stopped responding to the network, or there is a problem + with the network connection (cable).</dd> +</dl> +</section> +<section class="Sh"> +<h1 class="Sh" id="SUPPORT"><a class="permalink" href="#SUPPORT">SUPPORT</a></h1> +<p class="Pp">For general information and support, go to the Intel support + website at: <span class="Pa">http://support.intel.com</span>.</p> +<p class="Pp">If an issue is identified with the released source code on the + supported kernel with a supported adapter, email the specific information + related to the issue to + <<a class="Mt" href="mailto:freebsd@intel.com">freebsd@intel.com</a>>.</p> +</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">iflib(4)</a>, <a class="Xr">led(4)</a>, + <a class="Xr">netintro(4)</a>, <a class="Xr">ng_ether(4)</a>, + <a class="Xr">polling(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">em</code> device driver first appeared in + <span class="Ux">FreeBSD 4.4</span>. <code class="Nm">em</code> was merged + with the <code class="Nm">lem</code> and <code class="Nm">igb</code> device + drivers and converted to the <a class="Xr">iflib(4)</a> framework in + <span class="Ux">FreeBSD 12.0</span>.</p> +</section> +<section class="Sh"> +<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> +<p class="Pp">The <code class="Nm">em</code> driver was originally written by + <span class="An">Intel Corporation</span> + <<a class="Mt" href="mailto:freebsd@intel.com">freebsd@intel.com</a>>. + It was merged with the <code class="Nm">igb</code> driver and converted to + the <a class="Xr">iflib(4)</a> framework by <span class="An">Matthew + Macy</span> + <<a class="Mt" href="mailto:mmacy@mattmacy.io">mmacy@mattmacy.io</a>> + and <span class="An">Sean Bruno</span> + <<a class="Mt" href="mailto:sbruno@FreeBSD.org">sbruno@FreeBSD.org</a>>.</p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">March 20, 2024</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |