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 - Port hardware statistics
  52
  53 - Extended statistics (see Solarflare Server Adapter User's Guide for
  54   the statistics description)
  55
  56 - Basic flow control
  57
  58 - MTU update
  59
  60 - Jumbo frames up to 9K
  61
  62 - Promiscuous mode
  63
  64 - Allmulticast mode
  65
  66 - TCP segmentation offload (TSO)
  67
  68 - Multicast MAC filter
  69
  70 - IPv4/IPv6 TCP/UDP receive checksum offload
  71
  72 - Inner IPv4/IPv6 TCP/UDP receive checksum offload
  73
  74 - Received packet type information
  75
  76 - Receive side scaling (RSS)
  77
  78 - RSS hash
  79
  80 - Scattered Rx DMA for packet that are larger that a single Rx descriptor
  81
  82 - Deferred receive and transmit queue start
  83
  84 - Transmit VLAN insertion (if running firmware variant supports it)
  85
  86 - Flow API
  87
  88
  89 Non-supported Features
  90 ----------------------
  91
  92 The features not yet supported include:
  93
  94 - Receive queue interupts
  95
  96 - Priority-based flow control
  97
  98 - Loopback
  99
 100 - Configurable RX CRC stripping (always stripped)
 101
 102 - Header split on receive
 103
 104 - VLAN filtering
 105
 106 - VLAN stripping
 107
 108 - LRO
 109
 110
 111 Limitations
 112 -----------
 113
 114 Due to requirements on receive buffer alignment and usage of the receive
 115 buffer for the auxiliary packet information provided by the NIC up to
 116 extra 269 (14 bytes prefix plus up to 255 bytes for end padding) bytes may be
 117 required in the receive buffer.
 118 It should be taken into account when mbuf pool for receive is created.
 119
 120
 121 Tunnels support
 122 ---------------
 123
 124 NVGRE, VXLAN and GENEVE tunnels are supported on SFN8xxx family adapters
 125 with full-feature firmware variant running.
 126 **sfboot** should be used to configure NIC to run full-feature firmware variant.
 127 See Solarflare Server Adapter User's Guide for details.
 128
 129 SFN8xxx family adapters provide either inner or outer packet classes.
 130 If adapter firmware advertises support for tunnels then the PMD
 131 configures the hardware to report inner classes, and outer classes are
 132 not reported in received packets.
 133 However, for VXLAN and GENEVE tunnels the PMD does report UDP as the
 134 outer layer 4 packet type.
 135
 136 SFN8xxx family adapters report GENEVE packets as VXLAN.
 137 If UDP ports are configured for only one tunnel type then it is safe to
 138 treat VXLAN packet type indication as the corresponding UDP tunnel type.
 139
 140
 141 Flow API support
 142 ----------------
 143
 144 Supported attributes:
 145
 146 - Ingress
 147
 148 Supported pattern items:
 149
 150 - VOID
 151
 152 - ETH (exact match of source/destination addresses, individual/group match
 153   of destination address, EtherType)
 154
 155 - VLAN (exact match of VID, double-tagging is supported)
 156
 157 - IPV4 (exact match of source/destination addresses,
 158   IP transport protocol)
 159
 160 - IPV6 (exact match of source/destination addresses,
 161   IP transport protocol)
 162
 163 - TCP (exact match of source/destination ports)
 164
 165 - UDP (exact match of source/destination ports)
 166
 167 Supported actions:
 168
 169 - VOID
 170
 171 - QUEUE
 172
 173 - RSS
 174
 175 Validating flow rules depends on the firmware variant.
 176
 177 Ethernet destinaton individual/group match
 178 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 179
 180 Ethernet item supports I/G matching, if only the corresponding bit is set
 181 in the mask of destination address. If destinaton address in the spec is
 182 multicast, it matches all multicast (and broadcast) packets, oherwise it
 183 matches unicast packets that are not filtered by other flow rules.
 184
 185
 186 Supported NICs
 187 --------------
 188
 189 - Solarflare Flareon [Ultra] Server Adapters:
 190
 191    - Solarflare SFN8522 Dual Port SFP+ Server Adapter
 192
 193    - Solarflare SFN8542 Dual Port QSFP+ Server Adapter
 194
 195    - Solarflare SFN7002F Dual Port SFP+ Server Adapter
 196
 197    - Solarflare SFN7004F Quad Port SFP+ Server Adapter
 198
 199    - Solarflare SFN7042Q Dual Port QSFP+ Server Adapter
 200
 201    - Solarflare SFN7122F Dual Port SFP+ Server Adapter
 202
 203    - Solarflare SFN7124F Quad Port SFP+ Server Adapter
 204
 205    - Solarflare SFN7142Q Dual Port QSFP+ Server Adapter
 206
 207    - Solarflare SFN7322F Precision Time Synchronization Server Adapter
 208
 209
 210 Prerequisites
 211 -------------
 212
 213 - Requires firmware version:
 214
 215    - SFN7xxx: **4.7.1.1001** or higher
 216
 217    - SFN8xxx: **6.0.2.1004** or higher
 218
 219 Visit `Solarflare Support Downloads <https://support.solarflare.com>`_ to get
 220 Solarflare Utilities (either Linux or FreeBSD) with the latest firmware.
 221 Follow instructions from Solarflare Server Adapter User's Guide to
 222 update firmware and configure the adapter.
 223
 224
 225 Pre-Installation Configuration
 226 ------------------------------
 227
 228
 229 Config File Options
 230 ~~~~~~~~~~~~~~~~~~~
 231
 232 The following options can be modified in the ``.config`` file.
 233 Please note that enabling debugging options may affect system performance.
 234
 235 - ``CONFIG_RTE_LIBRTE_SFC_EFX_PMD`` (default **y**)
 236
 237   Enable compilation of Solarflare libefx-based poll-mode driver.
 238
 239 - ``CONFIG_RTE_LIBRTE_SFC_EFX_DEBUG`` (default **n**)
 240
 241   Enable compilation of the extra run-time consistency checks.
 242
 243
 244 Per-Device Parameters
 245 ~~~~~~~~~~~~~~~~~~~~~
 246
 247 The following per-device parameters can be passed via EAL PCI device
 248 whitelist option like "-w 02:00.0,arg1=value1,...".
 249
 250 Case-insensitive 1/y/yes/on or 0/n/no/off may be used to specify
 251 boolean parameters value.
 252
 253 - ``rx_datapath`` [auto|efx|ef10] (default **auto**)
 254
 255   Choose receive datapath implementation.
 256   **auto** allows the driver itself to make a choice based on firmware
 257   features available and required by the datapath implementation.
 258   **efx** chooses libefx-based datapath which supports Rx scatter.
 259   **ef10** chooses EF10 (SFN7xxx, SFN8xxx) native datapath which is
 260   more efficient than libefx-based and provides richer packet type
 261   classification, but lacks Rx scatter support.
 262
 263 - ``tx_datapath`` [auto|efx|ef10|ef10_simple] (default **auto**)
 264
 265   Choose transmit 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 VLAN insertion
 269   (full-feature firmware variant only), TSO and multi-segment mbufs.
 270   Mbuf segments may come from different mempools, and mbuf reference
 271   counters are treated responsibly.
 272   **ef10** chooses EF10 (SFN7xxx, SFN8xxx) native datapath which is
 273   more efficient than libefx-based but has no VLAN insertion and TSO
 274   support yet.
 275   Mbuf segments may come from different mempools, and mbuf reference
 276   counters are treated responsibly.
 277   **ef10_simple** chooses EF10 (SFN7xxx, SFN8xxx) native datapath which
 278   is even more faster then **ef10** but does not support multi-segment
 279   mbufs, disallows multiple mempools and neglects mbuf reference counters.
 280
 281 - ``perf_profile`` [auto|throughput|low-latency] (default **throughput**)
 282
 283   Choose hardware tunning to be optimized for either throughput or
 284   low-latency.
 285   **auto** allows NIC firmware to make a choice based on
 286   installed licences and firmware variant configured using **sfboot**.
 287
 288 - ``debug_init`` [bool] (default **n**)
 289
 290   Enable extra logging during device initialization and startup.
 291
 292 - ``mcdi_logging`` [bool] (default **n**)
 293
 294   Enable extra logging of the communication with the NIC's management CPU.
 295   The logging is done using RTE_LOG() with INFO level and PMD type.
 296   The format is consumed by the Solarflare netlogdecode cross-platform tool.
 297
 298 - ``stats_update_period_ms`` [long] (default **1000**)
 299
 300   Adjust period in milliseconds to update port hardware statistics.
 301   The accepted range is 0 to 65535. The value of **0** may be used
 302   to disable periodic statistics update. One should note that it's
 303   only possible to set an arbitrary value on SFN8xxx provided that
 304   firmware version is 6.2.1.1033 or higher, otherwise any positive
 305   value will select a fixed update period of **1000** milliseconds