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 Tunnels support
 125 ---------------
 126
 127 NVGRE, VXLAN and GENEVE tunnels are supported on SFN8xxx and X2xxx family
 128 adapters with full-feature firmware variant running.
 129 **sfboot** should be used to configure NIC to run full-feature firmware variant.
 130 See Solarflare Server Adapter User's Guide for details.
 131
 132 SFN8xxx and X2xxx family adapters provide either inner or outer packet classes.
 133 If adapter firmware advertises support for tunnels then the PMD
 134 configures the hardware to report inner classes, and outer classes are
 135 not reported in received packets.
 136 However, for VXLAN and GENEVE tunnels the PMD does report UDP as the
 137 outer layer 4 packet type.
 138
 139 SFN8xxx and X2xxx family adapters report GENEVE packets as VXLAN.
 140 If UDP ports are configured for only one tunnel type then it is safe to
 141 treat VXLAN packet type indication as the corresponding UDP tunnel type.
 142
 143
 144 Flow API support
 145 ----------------
 146
 147 Supported attributes:
 148
 149 - Ingress
 150
 151 Supported pattern items:
 152
 153 - VOID
 154
 155 - ETH (exact match of source/destination addresses, individual/group match
 156   of destination address, EtherType in the outer frame and exact match of
 157   destination addresses, individual/group match of destination address in
 158   the inner frame)
 159
 160 - VLAN (exact match of VID, double-tagging is supported)
 161
 162 - IPV4 (exact match of source/destination addresses,
 163   IP transport protocol)
 164
 165 - IPV6 (exact match of source/destination addresses,
 166   IP transport protocol)
 167
 168 - TCP (exact match of source/destination ports)
 169
 170 - UDP (exact match of source/destination ports)
 171
 172 - VXLAN (exact match of VXLAN network identifier)
 173
 174 - GENEVE (exact match of virtual network identifier, only Ethernet (0x6558)
 175   protocol type is supported)
 176
 177 - NVGRE (exact match of virtual subnet ID)
 178
 179 Supported actions:
 180
 181 - VOID
 182
 183 - QUEUE
 184
 185 - RSS
 186
 187 - DROP
 188
 189 Validating flow rules depends on the firmware variant.
 190
 191 Ethernet destinaton individual/group match
 192 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 193
 194 Ethernet item supports I/G matching, if only the corresponding bit is set
 195 in the mask of destination address. If destinaton address in the spec is
 196 multicast, it matches all multicast (and broadcast) packets, oherwise it
 197 matches unicast packets that are not filtered by other flow rules.
 198
 199 Exceptions to flow rules
 200 ~~~~~~~~~~~~~~~~~~~~~~~~
 201
 202 There is a list of exceptional flow rule patterns which will not be
 203 accepted by the PMD. A pattern will be rejected if at least one of the
 204 conditions is met:
 205
 206 - Filtering by IPv4 or IPv6 EtherType without pattern items of internet
 207   layer and above.
 208
 209 - The last item is IPV4 or IPV6, and it's empty.
 210
 211 - Filtering by TCP or UDP IP transport protocol without pattern items of
 212   transport layer and above.
 213
 214 - The last item is TCP or UDP, and it's empty.
 215
 216
 217 Supported NICs
 218 --------------
 219
 220 - Solarflare XtremeScale Adapters:
 221
 222    - Solarflare X2522 Dual Port SFP28 10/25GbE Adapter
 223
 224 - Solarflare Flareon [Ultra] Server Adapters:
 225
 226    - Solarflare SFN8522 Dual Port SFP+ Server Adapter
 227
 228    - Solarflare SFN8522M Dual Port SFP+ Server Adapter
 229
 230    - Solarflare SFN8042 Dual Port QSFP+ Server Adapter
 231
 232    - Solarflare SFN8542 Dual Port QSFP+ Server Adapter
 233
 234    - Solarflare SFN8722 Dual Port SFP+ OCP Server Adapter
 235
 236    - Solarflare SFN7002F Dual Port SFP+ Server Adapter
 237
 238    - Solarflare SFN7004F Quad Port SFP+ Server Adapter
 239
 240    - Solarflare SFN7042Q Dual Port QSFP+ Server Adapter
 241
 242    - Solarflare SFN7122F Dual Port SFP+ Server Adapter
 243
 244    - Solarflare SFN7124F Quad Port SFP+ Server Adapter
 245
 246    - Solarflare SFN7142Q Dual Port QSFP+ Server Adapter
 247
 248    - Solarflare SFN7322F Precision Time Synchronization Server Adapter
 249
 250
 251 Prerequisites
 252 -------------
 253
 254 - Requires firmware version:
 255
 256    - SFN7xxx: **4.7.1.1001** or higher
 257
 258    - SFN8xxx: **6.0.2.1004** or higher
 259
 260 Visit `Solarflare Support Downloads <https://support.solarflare.com>`_ to get
 261 Solarflare Utilities (either Linux or FreeBSD) with the latest firmware.
 262 Follow instructions from Solarflare Server Adapter User's Guide to
 263 update firmware and configure the adapter.
 264
 265
 266 Pre-Installation Configuration
 267 ------------------------------
 268
 269
 270 Config File Options
 271 ~~~~~~~~~~~~~~~~~~~
 272
 273 The following options can be modified in the ``.config`` file.
 274 Please note that enabling debugging options may affect system performance.
 275
 276 - ``CONFIG_RTE_LIBRTE_SFC_EFX_PMD`` (default **y**)
 277
 278   Enable compilation of Solarflare libefx-based poll-mode driver.
 279
 280 - ``CONFIG_RTE_LIBRTE_SFC_EFX_DEBUG`` (default **n**)
 281
 282   Enable compilation of the extra run-time consistency checks.
 283
 284
 285 Per-Device Parameters
 286 ~~~~~~~~~~~~~~~~~~~~~
 287
 288 The following per-device parameters can be passed via EAL PCI device
 289 whitelist option like "-w 02:00.0,arg1=value1,...".
 290
 291 Case-insensitive 1/y/yes/on or 0/n/no/off may be used to specify
 292 boolean parameters value.
 293
 294 - ``rx_datapath`` [auto|efx|ef10] (default **auto**)
 295
 296   Choose receive datapath implementation.
 297   **auto** allows the driver itself to make a choice based on firmware
 298   features available and required by the datapath implementation.
 299   **efx** chooses libefx-based datapath which supports Rx scatter.
 300   **ef10** chooses EF10 (SFN7xxx, SFN8xxx, X2xxx) native datapath which is
 301   more efficient than libefx-based and provides richer packet type
 302   classification, but lacks Rx scatter support.
 303
 304 - ``tx_datapath`` [auto|efx|ef10|ef10_simple] (default **auto**)
 305
 306   Choose transmit datapath implementation.
 307   **auto** allows the driver itself to make a choice based on firmware
 308   features available and required by the datapath implementation.
 309   **efx** chooses libefx-based datapath which supports VLAN insertion
 310   (full-feature firmware variant only), TSO and multi-segment mbufs.
 311   Mbuf segments may come from different mempools, and mbuf reference
 312   counters are treated responsibly.
 313   **ef10** chooses EF10 (SFN7xxx, SFN8xxx, X2xxx) native datapath which is
 314   more efficient than libefx-based but has no VLAN insertion and TSO
 315   support yet.
 316   Mbuf segments may come from different mempools, and mbuf reference
 317   counters are treated responsibly.
 318   **ef10_simple** chooses EF10 (SFN7xxx, SFN8xxx, X2xxx) native datapath which
 319   is even more faster then **ef10** but does not support multi-segment
 320   mbufs, disallows multiple mempools and neglects mbuf reference counters.
 321
 322 - ``perf_profile`` [auto|throughput|low-latency] (default **throughput**)
 323
 324   Choose hardware tunning to be optimized for either throughput or
 325   low-latency.
 326   **auto** allows NIC firmware to make a choice based on
 327   installed licences and firmware variant configured using **sfboot**.
 328
 329 - ``stats_update_period_ms`` [long] (default **1000**)
 330
 331   Adjust period in milliseconds to update port hardware statistics.
 332   The accepted range is 0 to 65535. The value of **0** may be used
 333   to disable periodic statistics update. One should note that it's
 334   only possible to set an arbitrary value on SFN8xxx and X2xxx provided that
 335   firmware version is 6.2.1.1033 or higher, otherwise any positive
 336   value will select a fixed update period of **1000** milliseconds
 337
 338 - ``fw_variant`` [dont-care|full-feature|ultra-low-latency|
 339   capture-packed-stream] (default **dont-care**)
 340
 341   Choose the preferred firmware variant to use. In order for the selected
 342   option to have an effect, the **sfboot** utility must be configured with the
 343   **auto** firmware-variant option. The preferred firmware variant applies to
 344   all ports on the NIC.
 345   **dont-care** ensures that the driver can attach to an unprivileged function.
 346   The datapath firmware type to use is controlled by the **sfboot**
 347   utility.
 348   **full-feature** chooses full featured firmware.
 349   **ultra-low-latency** chooses firmware with fewer features but lower latency.
 350   **capture-packed-stream** chooses firmware for SolarCapture packed stream
 351   mode.
 352
 353
 354 Dynamic Logging Parameters
 355 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 356
 357 One may leverage EAL option "--log-level" to change default levels
 358 for the log types supported by the driver. The option is used with
 359 an argument typically consisting of two parts separated by a colon.
 360
 361 Level value is the last part which takes a symbolic name (or integer).
 362 Log type is the former part which may shell match syntax.
 363 Depending on the choice of the expression, the given log level may
 364 be used either for some specific log type or for a subset of types.
 365
 366 SFC EFX PMD provides the following log types available for control:
 367
 368 - ``pmd.net.sfc.driver`` (default level is **notice**)
 369
 370   Affects driver-wide messages unrelated to any particular devices.
 371
 372 - ``pmd.net.sfc.main`` (default level is **notice**)
 373
 374   Matches a subset of per-port log types registered during runtime.
 375   A full name for a particular type may be obtained by appending a
 376   dot and a PCI device identifier (``XXXX:XX:XX.X``) to the prefix.
 377
 378 - ``pmd.net.sfc.mcdi`` (default level is **notice**)
 379
 380   Extra logging of the communication with the NIC's management CPU.
 381   The format of the log is consumed by the Solarflare netlogdecode
 382   cross-platform tool. May be managed per-port, as explained above.