doc/guides/nics/sfc_efx.rst

   1 ..  BSD LICENSE
   2     Copyright (c) 2016 Solarflare Communications Inc.
   3     All rights reserved.
   4
   5     This software was jointly developed between OKTET Labs (under contract
   6     for Solarflare) and Solarflare Communications, Inc.
   7
   8     Redistribution and use in source and binary forms, with or without
   9     modification, are permitted provided that the following conditions are met:
  10
  11     1. Redistributions of source code must retain the above copyright notice,
  12        this list of conditions and the following disclaimer.
  13     2. Redistributions in binary form must reproduce the above copyright notice,
  14        this list of conditions and the following disclaimer in the documentation
  15        and/or other materials provided with the distribution.
  16
  17     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  18     AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
  19     THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  20     PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  21     CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  22     EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  23     PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  24     OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  25     WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  26     OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
  27     EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  28
  29 Solarflare libefx-based Poll Mode Driver
  30 ========================================
  31
  32 The SFC EFX PMD (**librte_pmd_sfc_efx**) provides poll mode driver support
  33 for **Solarflare SFN7xxx and SFN8xxx** family of 10/40 Gbps adapters.
  34 SFC EFX PMD has support for the latest Linux and FreeBSD operating systems.
  35
  36 More information can be found at `Solarflare Communications website
  37 <http://solarflare.com>`_.
  38
  39
  40 Features
  41 --------
  42
  43 SFC EFX PMD has support for:
  44
  45 - Multiple transmit and receive queues
  46
  47 - Link state information including link status change interrupt
  48
  49 - IPv4/IPv6 TCP/UDP transmit checksum offload
  50
  51 - Inner IPv4/IPv6 TCP/UDP transmit checksum offload
  52
  53 - Port hardware statistics
  54
  55 - Extended statistics (see Solarflare Server Adapter User's Guide for
  56   the statistics description)
  57
  58 - Basic flow control
  59
  60 - MTU update
  61
  62 - Jumbo frames up to 9K
  63
  64 - Promiscuous mode
  65
  66 - Allmulticast mode
  67
  68 - TCP segmentation offload (TSO)
  69
  70 - Multicast MAC filter
  71
  72 - IPv4/IPv6 TCP/UDP receive checksum offload
  73
  74 - Inner IPv4/IPv6 TCP/UDP receive checksum offload
  75
  76 - Received packet type information
  77
  78 - Receive side scaling (RSS)
  79
  80 - RSS hash
  81
  82 - Scattered Rx DMA for packet that are larger that a single Rx descriptor
  83
  84 - Deferred receive and transmit queue start
  85
  86 - Transmit VLAN insertion (if running firmware variant supports it)
  87
  88 - Flow API
  89
  90
  91 Non-supported Features
  92 ----------------------
  93
  94 The features not yet supported include:
  95
  96 - Receive queue interupts
  97
  98 - Priority-based flow control
  99
 100 - Loopback
 101
 102 - Configurable RX CRC stripping (always stripped)
 103
 104 - Header split on receive
 105
 106 - VLAN filtering
 107
 108 - VLAN stripping
 109
 110 - LRO
 111
 112
 113 Limitations
 114 -----------
 115
 116 Due to requirements on receive buffer alignment and usage of the receive
 117 buffer for the auxiliary packet information provided by the NIC up to
 118 extra 269 (14 bytes prefix plus up to 255 bytes for end padding) bytes may be
 119 required in the receive buffer.
 120 It should be taken into account when mbuf pool for receive is created.
 121
 122
 123 Tunnels support
 124 ---------------
 125
 126 NVGRE, VXLAN and GENEVE tunnels are supported on SFN8xxx family adapters
 127 with full-feature firmware variant running.
 128 **sfboot** should be used to configure NIC to run full-feature firmware variant.
 129 See Solarflare Server Adapter User's Guide for details.
 130
 131 SFN8xxx family adapters provide either inner or outer packet classes.
 132 If adapter firmware advertises support for tunnels then the PMD
 133 configures the hardware to report inner classes, and outer classes are
 134 not reported in received packets.
 135 However, for VXLAN and GENEVE tunnels the PMD does report UDP as the
 136 outer layer 4 packet type.
 137
 138 SFN8xxx family adapters report GENEVE packets as VXLAN.
 139 If UDP ports are configured for only one tunnel type then it is safe to
 140 treat VXLAN packet type indication as the corresponding UDP tunnel type.
 141
 142
 143 Flow API support
 144 ----------------
 145
 146 Supported attributes:
 147
 148 - Ingress
 149
 150 Supported pattern items:
 151
 152 - VOID
 153
 154 - ETH (exact match of source/destination addresses, individual/group match
 155   of destination address, EtherType)
 156
 157 - VLAN (exact match of VID, double-tagging is supported)
 158
 159 - IPV4 (exact match of source/destination addresses,
 160   IP transport protocol)
 161
 162 - IPV6 (exact match of source/destination addresses,
 163   IP transport protocol)
 164
 165 - TCP (exact match of source/destination ports)
 166
 167 - UDP (exact match of source/destination ports)
 168
 169 - VXLAN (exact match of VXLAN network identifier)
 170
 171 Supported actions:
 172
 173 - VOID
 174
 175 - QUEUE
 176
 177 - RSS
 178
 179 Validating flow rules depends on the firmware variant.
 180
 181 Ethernet destinaton individual/group match
 182 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 183
 184 Ethernet item supports I/G matching, if only the corresponding bit is set
 185 in the mask of destination address. If destinaton address in the spec is
 186 multicast, it matches all multicast (and broadcast) packets, oherwise it
 187 matches unicast packets that are not filtered by other flow rules.
 188
 189
 190 Supported NICs
 191 --------------
 192
 193 - Solarflare Flareon [Ultra] Server Adapters:
 194
 195    - Solarflare SFN8522 Dual Port SFP+ Server Adapter
 196
 197    - Solarflare SFN8522M Dual Port SFP+ Server Adapter
 198
 199    - Solarflare SFN8042 Dual Port QSFP+ Server Adapter
 200
 201    - Solarflare SFN8542 Dual Port QSFP+ Server Adapter
 202
 203    - Solarflare SFN8722 Dual Port SFP+ OCP Server Adapter
 204
 205    - Solarflare SFN7002F Dual Port SFP+ Server Adapter
 206
 207    - Solarflare SFN7004F Quad Port SFP+ Server Adapter
 208
 209    - Solarflare SFN7042Q Dual Port QSFP+ Server Adapter
 210
 211    - Solarflare SFN7122F Dual Port SFP+ Server Adapter
 212
 213    - Solarflare SFN7124F Quad Port SFP+ Server Adapter
 214
 215    - Solarflare SFN7142Q Dual Port QSFP+ Server Adapter
 216
 217    - Solarflare SFN7322F Precision Time Synchronization Server Adapter
 218
 219
 220 Prerequisites
 221 -------------
 222
 223 - Requires firmware version:
 224
 225    - SFN7xxx: **4.7.1.1001** or higher
 226
 227    - SFN8xxx: **6.0.2.1004** or higher
 228
 229 Visit `Solarflare Support Downloads <https://support.solarflare.com>`_ to get
 230 Solarflare Utilities (either Linux or FreeBSD) with the latest firmware.
 231 Follow instructions from Solarflare Server Adapter User's Guide to
 232 update firmware and configure the adapter.
 233
 234
 235 Pre-Installation Configuration
 236 ------------------------------
 237
 238
 239 Config File Options
 240 ~~~~~~~~~~~~~~~~~~~
 241
 242 The following options can be modified in the ``.config`` file.
 243 Please note that enabling debugging options may affect system performance.
 244
 245 - ``CONFIG_RTE_LIBRTE_SFC_EFX_PMD`` (default **y**)
 246
 247   Enable compilation of Solarflare libefx-based poll-mode driver.
 248
 249 - ``CONFIG_RTE_LIBRTE_SFC_EFX_DEBUG`` (default **n**)
 250
 251   Enable compilation of the extra run-time consistency checks.
 252
 253
 254 Per-Device Parameters
 255 ~~~~~~~~~~~~~~~~~~~~~
 256
 257 The following per-device parameters can be passed via EAL PCI device
 258 whitelist option like "-w 02:00.0,arg1=value1,...".
 259
 260 Case-insensitive 1/y/yes/on or 0/n/no/off may be used to specify
 261 boolean parameters value.
 262
 263 - ``rx_datapath`` [auto|efx|ef10] (default **auto**)
 264
 265   Choose receive datapath implementation.
 266   **auto** allows the driver itself to make a choice based on firmware
 267   features available and required by the datapath implementation.
 268   **efx** chooses libefx-based datapath which supports Rx scatter.
 269   **ef10** chooses EF10 (SFN7xxx, SFN8xxx) native datapath which is
 270   more efficient than libefx-based and provides richer packet type
 271   classification, but lacks Rx scatter support.
 272
 273 - ``tx_datapath`` [auto|efx|ef10|ef10_simple] (default **auto**)
 274
 275   Choose transmit datapath implementation.
 276   **auto** allows the driver itself to make a choice based on firmware
 277   features available and required by the datapath implementation.
 278   **efx** chooses libefx-based datapath which supports VLAN insertion
 279   (full-feature firmware variant only), TSO and multi-segment mbufs.
 280   Mbuf segments may come from different mempools, and mbuf reference
 281   counters are treated responsibly.
 282   **ef10** chooses EF10 (SFN7xxx, SFN8xxx) native datapath which is
 283   more efficient than libefx-based but has no VLAN insertion and TSO
 284   support yet.
 285   Mbuf segments may come from different mempools, and mbuf reference
 286   counters are treated responsibly.
 287   **ef10_simple** chooses EF10 (SFN7xxx, SFN8xxx) native datapath which
 288   is even more faster then **ef10** but does not support multi-segment
 289   mbufs, disallows multiple mempools and neglects mbuf reference counters.
 290
 291 - ``perf_profile`` [auto|throughput|low-latency] (default **throughput**)
 292
 293   Choose hardware tunning to be optimized for either throughput or
 294   low-latency.
 295   **auto** allows NIC firmware to make a choice based on
 296   installed licences and firmware variant configured using **sfboot**.
 297
 298 - ``debug_init`` [bool] (default **n**)
 299
 300   Enable extra logging during device initialization and startup.
 301
 302 - ``mcdi_logging`` [bool] (default **n**)
 303
 304   Enable extra logging of the communication with the NIC's management CPU.
 305   The logging is done using RTE_LOG() with INFO level and PMD type.
 306   The format is consumed by the Solarflare netlogdecode cross-platform tool.
 307
 308 - ``stats_update_period_ms`` [long] (default **1000**)
 309
 310   Adjust period in milliseconds to update port hardware statistics.
 311   The accepted range is 0 to 65535. The value of **0** may be used
 312   to disable periodic statistics update. One should note that it's
 313   only possible to set an arbitrary value on SFN8xxx provided that
 314   firmware version is 6.2.1.1033 or higher, otherwise any positive
 315   value will select a fixed update period of **1000** milliseconds