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 and
  34 **Solarflare XtremeScale X2xxx** family of 10/25/40/50/100 Gbps adapters.
  35 SFC EFX PMD has support for the latest Linux and FreeBSD operating systems.
  36
  37 More information can be found at `Solarflare Communications website
  38 <http://solarflare.com>`_.
  39
  40
  41 Features
  42 --------
  43
  44 SFC EFX PMD has support for:
  45
  46 - Multiple transmit and receive queues
  47
  48 - Link state information including link status change interrupt
  49
  50 - IPv4/IPv6 TCP/UDP transmit checksum offload
  51
  52 - Inner IPv4/IPv6 TCP/UDP transmit checksum offload
  53
  54 - Port hardware statistics
  55
  56 - Extended statistics (see Solarflare Server Adapter User's Guide for
  57   the statistics description)
  58
  59 - Basic flow control
  60
  61 - MTU update
  62
  63 - Jumbo frames up to 9K
  64
  65 - Promiscuous mode
  66
  67 - Allmulticast mode
  68
  69 - TCP segmentation offload (TSO)
  70
  71 - Multicast MAC filter
  72
  73 - IPv4/IPv6 TCP/UDP receive checksum offload
  74
  75 - Inner IPv4/IPv6 TCP/UDP receive checksum offload
  76
  77 - Received packet type information
  78
  79 - Receive side scaling (RSS)
  80
  81 - RSS hash
  82
  83 - Scattered Rx DMA for packet that are larger that a single Rx descriptor
  84
  85 - Deferred receive and transmit queue start
  86
  87 - Transmit VLAN insertion (if running firmware variant supports it)
  88
  89 - Flow API
  90
  91 - Loopback
  92
  93
  94 Non-supported Features
  95 ----------------------
  96
  97 The features not yet supported include:
  98
  99 - Receive queue interupts
 100
 101 - Priority-based flow control
 102
 103 - Configurable RX CRC stripping (always stripped)
 104
 105 - Header split on receive
 106
 107 - VLAN filtering
 108
 109 - VLAN stripping
 110
 111 - LRO
 112
 113
 114 Limitations
 115 -----------
 116
 117 Due to requirements on receive buffer alignment and usage of the receive
 118 buffer for the auxiliary packet information provided by the NIC up to
 119 extra 269 (14 bytes prefix plus up to 255 bytes for end padding) bytes may be
 120 required in the receive buffer.
 121 It should be taken into account when mbuf pool for receive is created.
 122
 123
 124 Equal stride super-buffer mode
 125 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 126
 127 When the receive queue uses equal stride super-buffer DMA mode, one HW Rx
 128 descriptor carries many Rx buffers which contiguously follow each other
 129 with some stride (equal to total size of rte_mbuf as mempool object).
 130 Each Rx buffer is an independent rte_mbuf.
 131 However dedicated mempool manager must be used when mempool for the Rx
 132 queue is created. The manager must support dequeue of the contiguous
 133 block of objects and provide mempool info API to get the block size.
 134
 135 Another limitation of a equal stride super-buffer mode, imposed by the
 136 firmware, is that it allows for a single RSS context.
 137
 138
 139 Tunnels support
 140 ---------------
 141
 142 NVGRE, VXLAN and GENEVE tunnels are supported on SFN8xxx and X2xxx family
 143 adapters with full-feature firmware variant running.
 144 **sfboot** should be used to configure NIC to run full-feature firmware variant.
 145 See Solarflare Server Adapter User's Guide for details.
 146
 147 SFN8xxx and X2xxx family adapters provide either inner or outer packet classes.
 148 If adapter firmware advertises support for tunnels then the PMD
 149 configures the hardware to report inner classes, and outer classes are
 150 not reported in received packets.
 151 However, for VXLAN and GENEVE tunnels the PMD does report UDP as the
 152 outer layer 4 packet type.
 153
 154 SFN8xxx and X2xxx family adapters report GENEVE packets as VXLAN.
 155 If UDP ports are configured for only one tunnel type then it is safe to
 156 treat VXLAN packet type indication as the corresponding UDP tunnel type.
 157
 158
 159 Flow API support
 160 ----------------
 161
 162 Supported attributes:
 163
 164 - Ingress
 165
 166 Supported pattern items:
 167
 168 - VOID
 169
 170 - ETH (exact match of source/destination addresses, individual/group match
 171   of destination address, EtherType in the outer frame and exact match of
 172   destination addresses, individual/group match of destination address in
 173   the inner frame)
 174
 175 - VLAN (exact match of VID, double-tagging is supported)
 176
 177 - IPV4 (exact match of source/destination addresses,
 178   IP transport protocol)
 179
 180 - IPV6 (exact match of source/destination addresses,
 181   IP transport protocol)
 182
 183 - TCP (exact match of source/destination ports)
 184
 185 - UDP (exact match of source/destination ports)
 186
 187 - VXLAN (exact match of VXLAN network identifier)
 188
 189 - GENEVE (exact match of virtual network identifier, only Ethernet (0x6558)
 190   protocol type is supported)
 191
 192 - NVGRE (exact match of virtual subnet ID)
 193
 194 Supported actions:
 195
 196 - VOID
 197
 198 - QUEUE
 199
 200 - RSS
 201
 202 - DROP
 203
 204 Validating flow rules depends on the firmware variant.
 205
 206 Ethernet destinaton individual/group match
 207 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 208
 209 Ethernet item supports I/G matching, if only the corresponding bit is set
 210 in the mask of destination address. If destinaton address in the spec is
 211 multicast, it matches all multicast (and broadcast) packets, oherwise it
 212 matches unicast packets that are not filtered by other flow rules.
 213
 214 Exceptions to flow rules
 215 ~~~~~~~~~~~~~~~~~~~~~~~~
 216
 217 There is a list of exceptional flow rule patterns which will not be
 218 accepted by the PMD. A pattern will be rejected if at least one of the
 219 conditions is met:
 220
 221 - Filtering by IPv4 or IPv6 EtherType without pattern items of internet
 222   layer and above.
 223
 224 - The last item is IPV4 or IPV6, and it's empty.
 225
 226 - Filtering by TCP or UDP IP transport protocol without pattern items of
 227   transport layer and above.
 228
 229 - The last item is TCP or UDP, and it's empty.
 230
 231
 232 Supported NICs
 233 --------------
 234
 235 - Solarflare XtremeScale Adapters:
 236
 237    - Solarflare X2522 Dual Port SFP28 10/25GbE Adapter
 238
 239 - Solarflare Flareon [Ultra] Server Adapters:
 240
 241    - Solarflare SFN8522 Dual Port SFP+ Server Adapter
 242
 243    - Solarflare SFN8522M Dual Port SFP+ Server Adapter
 244
 245    - Solarflare SFN8042 Dual Port QSFP+ Server Adapter
 246
 247    - Solarflare SFN8542 Dual Port QSFP+ Server Adapter
 248
 249    - Solarflare SFN8722 Dual Port SFP+ OCP Server Adapter
 250
 251    - Solarflare SFN7002F Dual Port SFP+ Server Adapter
 252
 253    - Solarflare SFN7004F Quad Port SFP+ Server Adapter
 254
 255    - Solarflare SFN7042Q Dual Port QSFP+ Server Adapter
 256
 257    - Solarflare SFN7122F Dual Port SFP+ Server Adapter
 258
 259    - Solarflare SFN7124F Quad Port SFP+ Server Adapter
 260
 261    - Solarflare SFN7142Q Dual Port QSFP+ Server Adapter
 262
 263    - Solarflare SFN7322F Precision Time Synchronization Server Adapter
 264
 265
 266 Prerequisites
 267 -------------
 268
 269 - Requires firmware version:
 270
 271    - SFN7xxx: **4.7.1.1001** or higher
 272
 273    - SFN8xxx: **6.0.2.1004** or higher
 274
 275 Visit `Solarflare Support Downloads <https://support.solarflare.com>`_ to get
 276 Solarflare Utilities (either Linux or FreeBSD) with the latest firmware.
 277 Follow instructions from Solarflare Server Adapter User's Guide to
 278 update firmware and configure the adapter.
 279
 280
 281 Pre-Installation Configuration
 282 ------------------------------
 283
 284
 285 Config File Options
 286 ~~~~~~~~~~~~~~~~~~~
 287
 288 The following options can be modified in the ``.config`` file.
 289 Please note that enabling debugging options may affect system performance.
 290
 291 - ``CONFIG_RTE_LIBRTE_SFC_EFX_PMD`` (default **y**)
 292
 293   Enable compilation of Solarflare libefx-based poll-mode driver.
 294
 295 - ``CONFIG_RTE_LIBRTE_SFC_EFX_DEBUG`` (default **n**)
 296
 297   Enable compilation of the extra run-time consistency checks.
 298
 299
 300 Per-Device Parameters
 301 ~~~~~~~~~~~~~~~~~~~~~
 302
 303 The following per-device parameters can be passed via EAL PCI device
 304 whitelist option like "-w 02:00.0,arg1=value1,...".
 305
 306 Case-insensitive 1/y/yes/on or 0/n/no/off may be used to specify
 307 boolean parameters value.
 308
 309 - ``rx_datapath`` [auto|efx|ef10|ef10_esps] (default **auto**)
 310
 311   Choose receive datapath implementation.
 312   **auto** allows the driver itself to make a choice based on firmware
 313   features available and required by the datapath implementation.
 314   **efx** chooses libefx-based datapath which supports Rx scatter.
 315   **ef10** chooses EF10 (SFN7xxx, SFN8xxx, X2xxx) native datapath which is
 316   more efficient than libefx-based and provides richer packet type
 317   classification, but lacks Rx scatter support.
 318   **ef10_esps** chooses SFNX2xxx equal stride packed stream datapath
 319   which may be used on DPDK firmware variant only
 320   (see notes about its limitations above).
 321
 322 - ``tx_datapath`` [auto|efx|ef10|ef10_simple] (default **auto**)
 323
 324   Choose transmit datapath implementation.
 325   **auto** allows the driver itself to make a choice based on firmware
 326   features available and required by the datapath implementation.
 327   **efx** chooses libefx-based datapath which supports VLAN insertion
 328   (full-feature firmware variant only), TSO and multi-segment mbufs.
 329   Mbuf segments may come from different mempools, and mbuf reference
 330   counters are treated responsibly.
 331   **ef10** chooses EF10 (SFN7xxx, SFN8xxx, X2xxx) native datapath which is
 332   more efficient than libefx-based but has no VLAN insertion and TSO
 333   support yet.
 334   Mbuf segments may come from different mempools, and mbuf reference
 335   counters are treated responsibly.
 336   **ef10_simple** chooses EF10 (SFN7xxx, SFN8xxx, X2xxx) native datapath which
 337   is even more faster then **ef10** but does not support multi-segment
 338   mbufs, disallows multiple mempools and neglects mbuf reference counters.
 339
 340 - ``perf_profile`` [auto|throughput|low-latency] (default **throughput**)
 341
 342   Choose hardware tunning to be optimized for either throughput or
 343   low-latency.
 344   **auto** allows NIC firmware to make a choice based on
 345   installed licences and firmware variant configured using **sfboot**.
 346
 347 - ``stats_update_period_ms`` [long] (default **1000**)
 348
 349   Adjust period in milliseconds to update port hardware statistics.
 350   The accepted range is 0 to 65535. The value of **0** may be used
 351   to disable periodic statistics update. One should note that it's
 352   only possible to set an arbitrary value on SFN8xxx and X2xxx provided that
 353   firmware version is 6.2.1.1033 or higher, otherwise any positive
 354   value will select a fixed update period of **1000** milliseconds
 355
 356 - ``fw_variant`` [dont-care|full-feature|ultra-low-latency|
 357   capture-packed-stream|dpdk] (default **dont-care**)
 358
 359   Choose the preferred firmware variant to use. In order for the selected
 360   option to have an effect, the **sfboot** utility must be configured with the
 361   **auto** firmware-variant option. The preferred firmware variant applies to
 362   all ports on the NIC.
 363   **dont-care** ensures that the driver can attach to an unprivileged function.
 364   The datapath firmware type to use is controlled by the **sfboot**
 365   utility.
 366   **full-feature** chooses full featured firmware.
 367   **ultra-low-latency** chooses firmware with fewer features but lower latency.
 368   **capture-packed-stream** chooses firmware for SolarCapture packed stream
 369   mode.
 370   **dpdk** chooses DPDK firmware with equal stride super-buffer Rx mode
 371   for higher Rx packet rate and packet marks support and firmware subvariant
 372   without checksumming on transmit for higher Tx packet rate if
 373   checksumming is not required.
 374
 375
 376 Dynamic Logging Parameters
 377 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 378
 379 One may leverage EAL option "--log-level" to change default levels
 380 for the log types supported by the driver. The option is used with
 381 an argument typically consisting of two parts separated by a colon.
 382
 383 Level value is the last part which takes a symbolic name (or integer).
 384 Log type is the former part which may shell match syntax.
 385 Depending on the choice of the expression, the given log level may
 386 be used either for some specific log type or for a subset of types.
 387
 388 SFC EFX PMD provides the following log types available for control:
 389
 390 - ``pmd.net.sfc.driver`` (default level is **notice**)
 391
 392   Affects driver-wide messages unrelated to any particular devices.
 393
 394 - ``pmd.net.sfc.main`` (default level is **notice**)
 395
 396   Matches a subset of per-port log types registered during runtime.
 397   A full name for a particular type may be obtained by appending a
 398   dot and a PCI device identifier (``XXXX:XX:XX.X``) to the prefix.
 399
 400 - ``pmd.net.sfc.mcdi`` (default level is **notice**)
 401
 402   Extra logging of the communication with the NIC's management CPU.
 403   The format of the log is consumed by the Solarflare netlogdecode
 404   cross-platform tool. May be managed per-port, as explained above.