share/man/man4/sfxge.4

   1 .\" Copyright (c) 2011-2015 Solarflare Communications Inc.
   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 are met:
   6 .\"
   7 .\" 1. Redistributions of source code must retain the above copyright notice,
   8 .\"    this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright notice,
  10 .\"    this list of conditions and the following disclaimer in the documentation
  11 .\"    and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  14 .\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  15 .\" THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16 .\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  17 .\" CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18 .\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19 .\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  20 .\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  21 .\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  22 .\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  23 .\" EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .\" The views and conclusions contained in the software and documentation are
  26 .\" those of the authors and should not be interpreted as representing official
  27 .\" policies, either expressed or implied, of the FreeBSD Project.
  28 .\"
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd February 22, 2015
  32 .Dt SFXGE 4
  33 .Os
  34 .Sh NAME
  35 .Nm sfxge
  36 .Nd "Solarflare 10Gb Ethernet adapter driver"
  37 .Sh SYNOPSIS
  38 To compile this driver into the kernel,
  39 place the following lines in your
  40 kernel configuration file:
  41 .Bd -ragged -offset indent
  42 .Cd "device sfxge"
  43 .Ed
  44 .Pp
  45 To load the driver as a
  46 module at boot time, place the following line in
  47 .Xr loader.conf 5 :
  48 .Bd -literal -offset indent
  49 sfxge_load="YES"
  50 .Ed
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 driver provides support for 10Gb Ethernet adapters based on
  55 Solarflare SFC9000 family controllers.
  56 The driver supports jumbo
  57 frames, transmit/receive checksum offload, TCP Segmentation Offload
  58 (TSO), Large Receive Offload (LRO), VLAN checksum offload, VLAN TSO,
  59 and Receive Side Scaling (RSS) using MSI-X interrupts.
  60 .Pp
  61 The driver allocates 1 receive queue, transmit queue, event queue and
  62 IRQ per CPU up to a maximum of 64.
  63 IRQ affinities should be spread out using
  64 .Xr cpuset 1 .
  65 Interrupt moderation may be controlled through the sysctl
  66 .Va dev.sfxge.%d.int_mod
  67 (units are microseconds).
  68 .Pp
  69 For more information on configuring this device, see
  70 .Xr ifconfig 8 .
  71 .Pp
  72 A large number of MAC, PHY and data path statistics are available
  73 under the sysctl
  74 .Va dev.sfxge.%d.stats .
  75 The adapter's VPD
  76 fields including its serial number are available under the sysctl
  77 .Va dev.sfxge.%d.vpd .
  78 .Sh HARDWARE
  79 The
  80 .Nm
  81 driver supports all 10Gb Ethernet adapters based on Solarflare SFC9000
  82 family controllers.
  83 .Sh LOADER TUNABLES
  84 Tunables can be set at the
  85 .Xr loader 8
  86 prompt before booting the kernel or stored in
  87 .Xr loader.conf 5 .
  88 Actual values can be obtained using
  89 .Xr sysctl 8 .
  90 .Bl -tag -width indent
  91 .It Va hw.sfxge.rx_ring
  92 The maximum number of descriptors in a receive queue ring.
  93 Supported values are: 512, 1024, 2048 and 4096.
  94 .It Va hw.sfxge.tx_ring
  95 The maximum number of descriptors in a transmit queue ring.
  96 Supported values are: 512, 1024, 2048 and 4096.
  97 .It Va hw.sfxge.tx_dpl_get_max
  98 The maximum length of the deferred packet
  99 .Dq get-list
 100 for queued transmit packets (TCP and non-TCP), used only if the transmit
 101 queue lock can be acquired.
 102 If a packet is dropped, the
 103 .Va tx_get_overflow
 104 counter is incremented and the local sender receives ENOBUFS.
 105 The value must be greater than 0.
 106 .It Va hw.sfxge.tx_dpl_get_non_tcp_max
 107 The maximum number of non-TCP packets in the deferred packet
 108 .Dq get-list
 109 , used only if the transmit queue lock can be acquired.
 110 If a packet is dropped, the
 111 .Va tx_get_non_tcp_overflow
 112 counter is incremented and the local sender receives ENOBUFS.
 113 The value must be greater than 0.
 114 .It Va hw.sfxge.tx_dpl_put_max
 115 The maximum length of the deferred packet
 116 .Dq put-list
 117 for queued transmit
 118 packets, used if the transmit queue lock cannot be acquired.
 119 If a packet is dropped, the
 120 .Va tx_put_overflow
 121 counter is incremented and the local sender receives ENOBUFS.
 122 The value must be greater than or equal to 0.
 123 .It Va hw.sfxge.tso_fw_assisted
 124 Bitmask to enable/disable usage of FW-assisted TSO version if supported
 125 by NIC firmware.
 126 FATSOv1 (bit 0) and FATSOv2 (bit 1) are supported.
 127 All enabled by default.
 128 .It Va hw.sfxge.N.max_rss_channels
 129 The maximum number of allocated RSS channels for the Nth adapter.
 130 If set to 0 or unset, the number of channels is determined by the number
 131 of CPU cores.
 132 .It Va hw.sfxge.lro.table_size
 133 Size of the LRO hash table.
 134 Must be a power of 2.
 135 A larger table means we can accelerate a larger number of streams.
 136 .It Va hw.sfxge.lro.chain_max
 137 The maximum length of a hash chain.
 138 If chains get too long then the lookup time increases and may exceed
 139 the benefit of LRO.
 140 .It Va hw.sfxge.lro.idle_ticks
 141 The maximum time (in ticks) that a connection can be idle before it's LRO
 142 state is discarded.
 143 .It Va hw.sfxge.lro.slow_start_packets
 144 Number of packets with payload that must arrive in-order before a connection
 145 is eligible for LRO.
 146 The idea is we should avoid coalescing segments when the sender is in
 147 slow-start because reducing the ACK rate can damage performance.
 148 .It Va hw.sfxge.lro.loss_packets
 149 Number of packets with payload that must arrive in-order following loss
 150 before a connection is eligible for LRO.
 151 The idea is we should avoid coalescing segments when the sender is recovering
 152 from loss, because reducing the ACK rate can damage performance.
 153 .It Va hw.sfxge.mcdi_logging
 154 Enable logging of MCDI protocol messages  (only available if enabled at compile-time).
 155 .It Va hw.sfxge.N.mcdi_logging
 156 Enable or disable logging of MCDI protocol messages on a per-port basis. The default for each
 157 port will be the value of
 158 .Va hw.sfxge.mcdi_logging.
 159 The logging may also be enabled or disabled after the driver is loaded using the sysctl
 160 .Va dev.sfxge.%d.mcdi_logging.
 161 .El
 162 .Sh SUPPORT
 163 For general information and support,
 164 go to the Solarflare support website at:
 165 .Pa https://support.solarflare.com .
 166 .Sh SEE ALSO
 167 .Xr arp 4 ,
 168 .Xr netintro 4 ,
 169 .Xr ng_ether 4 ,
 170 .Xr vlan 4 ,
 171 .Xr cpuset 1 ,
 172 .Xr ifconfig 8
 173 .Sh AUTHORS
 174 The
 175 .Nm
 176 driver was written by
 177 .An Philip Paeps
 178 and
 179 .An Solarflare Communications, Inc.