diff options
Diffstat (limited to 'static/freebsd/man4/sfxge.4 3.html')
| -rw-r--r-- | static/freebsd/man4/sfxge.4 3.html | 155 |
1 files changed, 155 insertions, 0 deletions
diff --git a/static/freebsd/man4/sfxge.4 3.html b/static/freebsd/man4/sfxge.4 3.html new file mode 100644 index 00000000..caafc59a --- /dev/null +++ b/static/freebsd/man4/sfxge.4 3.html @@ -0,0 +1,155 @@ +<table class="head"> + <tr> + <td class="head-ltitle">SFXGE(4)</td> + <td class="head-vol">Device Drivers Manual (amd64)</td> + <td class="head-rtitle">SFXGE(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">sfxge</code> — <span class="Nd">Solarflare + 10Gb 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 sfxge</code></div> +<p class="Pp">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>sfxge_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">sfxge</code> driver provides support for 10Gb + Ethernet adapters based on Solarflare SFC9000 and XtremeScale X2 family + controllers. The driver supports jumbo frames, transmit/receive checksum + offload, TCP Segmentation Offload (TSO), Large Receive Offload (LRO), VLAN + checksum offload, VLAN TSO, and Receive Side Scaling (RSS) using MSI-X + interrupts.</p> +<p class="Pp">The driver allocates 1 receive queue, transmit queue, event queue + and IRQ per CPU up to a maximum of 64. IRQ affinities should be spread out + using <a class="Xr">cpuset(1)</a>. Interrupt moderation may be controlled + through the sysctl <var class="Va">dev.sfxge.%d.int_mod</var> (units are + microseconds).</p> +<p class="Pp">For more information on configuring this device, see + <a class="Xr">ifconfig(8)</a>.</p> +<p class="Pp">A large number of MAC, PHY and data path statistics are available + under the sysctl <var class="Va">dev.sfxge.%d.stats</var>. The adapter's VPD + fields including its serial number are available under the sysctl + <var class="Va">dev.sfxge.%d.vpd</var>.</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">sfxge</code> driver supports all 10Gb + Ethernet adapters based on Solarflare SFC9000 family controllers.</p> +</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>. + Actual values can be obtained using <a class="Xr">sysctl(8)</a>.</p> +<dl class="Bl-tag"> + <dt id="hw.sfxge.rx_ring"><var class="Va">hw.sfxge.rx_ring</var></dt> + <dd>The maximum number of descriptors in a receive queue ring. Supported + values are: 512, 1024, 2048 and 4096.</dd> + <dt id="hw.sfxge.tx_ring"><var class="Va">hw.sfxge.tx_ring</var></dt> + <dd>The maximum number of descriptors in a transmit queue ring. Supported + values are: 512, 1024, 2048 and 4096.</dd> + <dt id="hw.sfxge.tx_dpl_get_max"><var class="Va">hw.sfxge.tx_dpl_get_max</var></dt> + <dd>The maximum length of the deferred packet “get-list” for + queued transmit packets (TCP and non-TCP), used only if the transmit queue + lock can be acquired. If a packet is dropped, the + <var class="Va">tx_get_overflow</var> counter is incremented and the local + sender receives ENOBUFS. The value must be greater than 0.</dd> + <dt id="hw.sfxge.tx_dpl_get_non_tcp_max"><var class="Va">hw.sfxge.tx_dpl_get_non_tcp_max</var></dt> + <dd>The maximum number of non-TCP packets in the deferred packet + “get-list” , used only if the transmit queue lock can be + acquired. If a packet is dropped, the + <var class="Va">tx_get_non_tcp_overflow</var> counter is incremented and + the local sender receives ENOBUFS. The value must be greater than 0.</dd> + <dt id="hw.sfxge.tx_dpl_put_max"><var class="Va">hw.sfxge.tx_dpl_put_max</var></dt> + <dd>The maximum length of the deferred packet “put-list” for + queued transmit packets, used if the transmit queue lock cannot be + acquired. If a packet is dropped, the + <var class="Va">tx_put_overflow</var> counter is incremented and the local + sender receives ENOBUFS. The value must be greater than or equal to + 0.</dd> + <dt id="hw.sfxge.tso_fw_assisted"><var class="Va">hw.sfxge.tso_fw_assisted</var></dt> + <dd>Bitmask to enable/disable usage of FW-assisted TSO version if supported by + NIC firmware. FATSOv1 (bit 0) and FATSOv2 (bit 1) are supported. All + enabled by default.</dd> + <dt id="hw.sfxge.N.max_rss_channels"><var class="Va">hw.sfxge.N.max_rss_channels</var></dt> + <dd>The maximum number of allocated RSS channels for the Nth adapter. If set + to 0 or unset, the number of channels is determined by the number of CPU + cores.</dd> + <dt id="hw.sfxge.lro.table_size"><var class="Va">hw.sfxge.lro.table_size</var></dt> + <dd>Size of the LRO hash table. Must be a power of 2. A larger table means we + can accelerate a larger number of streams.</dd> + <dt id="hw.sfxge.lro.chain_max"><var class="Va">hw.sfxge.lro.chain_max</var></dt> + <dd>The maximum length of a hash chain. If chains get too long then the lookup + time increases and may exceed the benefit of LRO.</dd> + <dt id="hw.sfxge.lro.idle_ticks"><var class="Va">hw.sfxge.lro.idle_ticks</var></dt> + <dd>The maximum time (in ticks) that a connection can be idle before it's LRO + state is discarded.</dd> + <dt id="hw.sfxge.lro.slow_start_packets"><var class="Va">hw.sfxge.lro.slow_start_packets</var></dt> + <dd>Number of packets with payload that must arrive in-order before a + connection is eligible for LRO. The idea is we should avoid coalescing + segments when the sender is in slow-start because reducing the ACK rate + can damage performance.</dd> + <dt id="hw.sfxge.lro.loss_packets"><var class="Va">hw.sfxge.lro.loss_packets</var></dt> + <dd>Number of packets with payload that must arrive in-order following loss + before a connection is eligible for LRO. The idea is we should avoid + coalescing segments when the sender is recovering from loss, because + reducing the ACK rate can damage performance.</dd> + <dt id="hw.sfxge.mcdi_logging"><var class="Va">hw.sfxge.mcdi_logging</var></dt> + <dd>Enable logging of MCDI protocol messages (only available if enabled at + compile-time).</dd> + <dt id="hw.sfxge.N.mcdi_logging"><var class="Va">hw.sfxge.N.mcdi_logging</var></dt> + <dd>Enable or disable logging of MCDI protocol messages on a per-port basis. + The default for each port will be the value of + <var class="Va">hw.sfxge.mcdi_logging.</var> The logging may also be + enabled or disabled after the driver is loaded using the sysctl + <var class="Va">dev.sfxge.%d.mcdi_logging.</var></dd> + <dt id="hw.sfxge.stats_update_period_ms"><var class="Va">hw.sfxge.stats_update_period_ms</var></dt> + <dd>Period in milliseconds to refresh interface statistics from hardware. The + accepted range is 0 to 65535, the default is 1000 (1 second). Use zero + value to disable periodic statistics update. Supported on SFN8xxx series + adapters with firmware v6.2.1.1033 and later and SFN5xxx, SFN6xxx and + XtremeScale X2xxx series adapters. SFN7xxx series adapters and sfN8xxx + series with earlier firmware use a fixed 1000 milliseconds statistics + update period. The period may also be changed after the driver is loaded + using the sysctl + <var class="Va">dev.sfxge.%d.stats_update_period_ms</var>.</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 Solarflare support + website at: <span class="Pa">https://support.solarflare.com</span>.</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">cpuset(1)</a>, <a class="Xr">arp(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="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> +<p class="Pp">The <code class="Nm">sfxge</code> driver was written by + <span class="An">Philip Paeps</span> and + <br/> + <span class="An">Solarflare Communications, Inc.</span></p> +</section> +</div> +<table class="foot"> + <tr> + <td class="foot-date">February 22, 2015</td> + <td class="foot-os">FreeBSD 15.0</td> + </tr> +</table> |