doc/guides/nics/sfc_efx.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2019-2020 Xilinx, Inc.
   3     Copyright(c) 2016-2019 Solarflare Communications Inc.
   4
   5     This software was jointly developed between OKTET Labs (under contract
   6     for Solarflare) and Solarflare Communications, Inc.
   7
   8 Solarflare libefx-based Poll Mode Driver
   9 ========================================
  10
  11 The SFC EFX PMD (**librte_pmd_sfc_efx**) provides poll mode driver support
  12 for **Solarflare SFN7xxx and SFN8xxx** family of 10/40 Gbps adapters,
  13 **Solarflare XtremeScale X2xxx** family of 10/25/40/50/100 Gbps adapters and
  14 **Alveo SN1000 SmartNICs** family of 10/25/40/50/100 Gbps adapters.
  15 SFC EFX PMD has support for the latest Linux and FreeBSD operating systems.
  16
  17 More information can be found at `Solarflare Communications website
  18 <http://solarflare.com>`_.
  19
  20
  21 Features
  22 --------
  23
  24 SFC EFX PMD has support for:
  25
  26 - Multiple transmit and receive queues
  27
  28 - Link state information including link status change interrupt
  29
  30 - IPv4/IPv6 TCP/UDP transmit checksum offload
  31
  32 - Inner IPv4/IPv6 TCP/UDP transmit checksum offload
  33
  34 - Port hardware statistics
  35
  36 - Extended statistics (see Solarflare Server Adapter User's Guide for
  37   the statistics description)
  38
  39 - Basic flow control
  40
  41 - MTU update
  42
  43 - Jumbo frames up to 9K
  44
  45 - Promiscuous mode
  46
  47 - Allmulticast mode
  48
  49 - TCP segmentation offload (TSO) including VXLAN and GENEVE encapsulated
  50
  51 - Multicast MAC filter
  52
  53 - IPv4/IPv6 TCP/UDP receive checksum offload
  54
  55 - Inner IPv4/IPv6 TCP/UDP receive checksum offload
  56
  57 - Received packet type information
  58
  59 - Receive side scaling (RSS)
  60
  61 - RSS hash
  62
  63 - Scattered Rx DMA for packet that are larger that a single Rx descriptor
  64
  65 - Receive queue interrupts
  66
  67 - Deferred receive and transmit queue start
  68
  69 - Transmit VLAN insertion (if running firmware variant supports it)
  70
  71 - Flow API
  72
  73 - Loopback
  74
  75 - SR-IOV PF
  76
  77
  78 Non-supported Features
  79 ----------------------
  80
  81 The features not yet supported include:
  82
  83 - Priority-based flow control
  84
  85 - Configurable RX CRC stripping (always stripped)
  86
  87 - Header split on receive
  88
  89 - VLAN filtering
  90
  91 - VLAN stripping
  92
  93 - LRO
  94
  95
  96 Limitations
  97 -----------
  98
  99 Due to requirements on receive buffer alignment and usage of the receive
 100 buffer for the auxiliary packet information provided by the NIC up to
 101 extra 269 (14 bytes prefix plus up to 255 bytes for end padding) bytes may be
 102 required in the receive buffer.
 103 It should be taken into account when mbuf pool for receive is created.
 104
 105
 106 Equal stride super-buffer mode
 107 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 108
 109 When the receive queue uses equal stride super-buffer DMA mode, one HW Rx
 110 descriptor carries many Rx buffers which contiguously follow each other
 111 with some stride (equal to total size of rte_mbuf as mempool object).
 112 Each Rx buffer is an independent rte_mbuf.
 113 However dedicated mempool manager must be used when mempool for the Rx
 114 queue is created. The manager must support dequeue of the contiguous
 115 block of objects and provide mempool info API to get the block size.
 116
 117 Another limitation of a equal stride super-buffer mode, imposed by the
 118 firmware, is that it allows for a single RSS context.
 119
 120
 121 Tunnels support
 122 ---------------
 123
 124 NVGRE, VXLAN and GENEVE tunnels are supported on SFN8xxx and X2xxx family
 125 adapters 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 and X2xxx 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 and X2xxx 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 in the outer frame and exact match of
 154   destination addresses, individual/group match of destination address in
 155   the inner frame)
 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 - GENEVE (exact match of virtual network identifier, only Ethernet (0x6558)
 172   protocol type is supported)
 173
 174 - NVGRE (exact match of virtual subnet ID)
 175
 176 Supported actions:
 177
 178 - VOID
 179
 180 - QUEUE
 181
 182 - RSS
 183
 184 - DROP
 185
 186 - FLAG (supported only with ef10_essb Rx datapath)
 187
 188 - MARK (supported only with ef10_essb Rx datapath)
 189
 190 Validating flow rules depends on the firmware variant.
 191
 192 The :ref:`flow_isolated_mode` is supported.
 193
 194 Ethernet destination individual/group match
 195 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 196
 197 Ethernet item supports I/G matching, if only the corresponding bit is set
 198 in the mask of destination address. If destination address in the spec is
 199 multicast, it matches all multicast (and broadcast) packets, otherwise it
 200 matches unicast packets that are not filtered by other flow rules.
 201
 202 Exceptions to flow rules
 203 ~~~~~~~~~~~~~~~~~~~~~~~~
 204
 205 There is a list of exceptional flow rule patterns which will not be
 206 accepted by the PMD. A pattern will be rejected if at least one of the
 207 conditions is met:
 208
 209 - Filtering by IPv4 or IPv6 EtherType without pattern items of internet
 210   layer and above.
 211
 212 - The last item is IPV4 or IPV6, and it's empty.
 213
 214 - Filtering by TCP or UDP IP transport protocol without pattern items of
 215   transport layer and above.
 216
 217 - The last item is TCP or UDP, and it's empty.
 218
 219
 220 Supported NICs
 221 --------------
 222
 223 - Xilinx Adapters:
 224
 225    - Alveo SN1022 SmartNIC
 226
 227 - Solarflare XtremeScale Adapters:
 228
 229    - Solarflare X2522 Dual Port SFP28 10/25GbE Adapter
 230
 231    - Solarflare X2541 Single Port QSFP28 10/25G/100G Adapter
 232
 233    - Solarflare X2542 Dual Port QSFP28 10/25G/100G Adapter
 234
 235 - Solarflare Flareon [Ultra] Server Adapters:
 236
 237    - Solarflare SFN8522 Dual Port SFP+ Server Adapter
 238
 239    - Solarflare SFN8522M Dual Port SFP+ Server Adapter
 240
 241    - Solarflare SFN8042 Dual Port QSFP+ Server Adapter
 242
 243    - Solarflare SFN8542 Dual Port QSFP+ Server Adapter
 244
 245    - Solarflare SFN8722 Dual Port SFP+ OCP Server Adapter
 246
 247    - Solarflare SFN7002F Dual Port SFP+ Server Adapter
 248
 249    - Solarflare SFN7004F Quad Port SFP+ Server Adapter
 250
 251    - Solarflare SFN7042Q Dual Port QSFP+ Server Adapter
 252
 253    - Solarflare SFN7122F Dual Port SFP+ Server Adapter
 254
 255    - Solarflare SFN7124F Quad Port SFP+ Server Adapter
 256
 257    - Solarflare SFN7142Q Dual Port QSFP+ Server Adapter
 258
 259    - Solarflare SFN7322F Precision Time Synchronization Server Adapter
 260
 261
 262 Prerequisites
 263 -------------
 264
 265 - Requires firmware version:
 266
 267    - SFN7xxx: **4.7.1.1001** or higher
 268
 269    - SFN8xxx: **6.0.2.1004** or higher
 270
 271 Visit `Solarflare Support Downloads <https://support.solarflare.com>`_ to get
 272 Solarflare Utilities (either Linux or FreeBSD) with the latest firmware.
 273 Follow instructions from Solarflare Server Adapter User's Guide to
 274 update firmware and configure the adapter.
 275
 276
 277 Pre-Installation Configuration
 278 ------------------------------
 279
 280
 281 Build Options
 282 ~~~~~~~~~~~~~
 283
 284 The following build-time options may be enabled on build time using
 285 ``-Dc_args=`` meson argument (e.g.  ``-Dc_args=-DRTE_LIBRTE_SFC_EFX_DEBUG``).
 286
 287 Please note that enabling debugging options may affect system performance.
 288
 289 - ``RTE_LIBRTE_SFC_EFX_DEBUG`` (undefined by default)
 290
 291   Enable compilation of the extra run-time consistency checks.
 292
 293
 294 Per-Device Parameters
 295 ~~~~~~~~~~~~~~~~~~~~~
 296
 297 The following per-device parameters can be passed via EAL PCI device
 298 whitelist option like "-w 02:00.0,arg1=value1,...".
 299
 300 Case-insensitive 1/y/yes/on or 0/n/no/off may be used to specify
 301 boolean parameters value.
 302
 303 - ``rx_datapath`` [auto|efx|ef10|ef10_essb] (default **auto**)
 304
 305   Choose receive datapath implementation.
 306   **auto** allows the driver itself to make a choice based on firmware
 307   features available and required by the datapath implementation.
 308   **efx** chooses libefx-based datapath which supports Rx scatter.
 309   Supported for SFN7xxx, SFN8xxx and X2xxx family adapters only.
 310   **ef10** chooses EF10 (SFN7xxx, SFN8xxx, X2xxx) native datapath which is
 311   more efficient than libefx-based and provides richer packet type
 312   classification.
 313   **ef10_essb** chooses SFNX2xxx equal stride super-buffer datapath
 314   which may be used on DPDK firmware variant only
 315   (see notes about its limitations above).
 316   **ef100** chooses EF100 native datapath which is the only supported
 317   Rx datapath for EF100 architecture based NICs.
 318
 319 - ``tx_datapath`` [auto|efx|ef10|ef10_simple|ef100] (default **auto**)
 320
 321   Choose transmit datapath implementation.
 322   **auto** allows the driver itself to make a choice based on firmware
 323   features available and required by the datapath implementation.
 324   **efx** chooses libefx-based datapath which supports VLAN insertion
 325   (full-feature firmware variant only), TSO and multi-segment mbufs.
 326   Mbuf segments may come from different mempools, and mbuf reference
 327   counters are treated responsibly.
 328   Supported for SFN7xxx, SFN8xxx and X2xxx family adapters only.
 329   **ef10** chooses EF10 (SFN7xxx, SFN8xxx, X2xxx) native datapath which is
 330   more efficient than libefx-based but has no VLAN insertion support yet.
 331   Mbuf segments may come from different mempools, and mbuf reference
 332   counters are treated responsibly.
 333   **ef10_simple** chooses EF10 (SFN7xxx, SFN8xxx, X2xxx) native datapath which
 334   is even more faster then **ef10** but does not support multi-segment
 335   mbufs, disallows multiple mempools and neglects mbuf reference counters.
 336   **ef100** chooses EF100 native datapath which supports multi-segment
 337   mbufs, VLAN insertion, inner/outer IPv4 and TCP/UDP checksum and TCP
 338   segmentation offloads including VXLAN and GENEVE IPv4/IPv6 tunnels.
 339
 340 - ``perf_profile`` [auto|throughput|low-latency] (default **throughput**)
 341
 342   Choose hardware tuning to be optimized for either throughput or
 343   low-latency.
 344   **auto** allows NIC firmware to make a choice based on
 345   installed licenses 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.
 360   The parameter is supported for SFN7xxX, SFN8xxx and X2xxx families only.
 361   In order for the selected option to have an effect, the **sfboot** utility
 362   must be configured with the **auto** firmware-variant option.
 363   The preferred firmware variant applies to all ports on the NIC.
 364   **dont-care** ensures that the driver can attach to an unprivileged function.
 365   The datapath firmware type to use is controlled by the **sfboot**
 366   utility.
 367   **full-feature** chooses full featured firmware.
 368   **ultra-low-latency** chooses firmware with fewer features but lower latency.
 369   **capture-packed-stream** chooses firmware for SolarCapture packed stream
 370   mode.
 371   **dpdk** chooses DPDK firmware with equal stride super-buffer Rx mode
 372   for higher Rx packet rate and packet marks support and firmware subvariant
 373   without checksumming on transmit for higher Tx packet rate if
 374   checksumming is not required.
 375
 376 - ``rxd_wait_timeout_ns`` [long] (default **200 us**)
 377
 378   Adjust timeout in nanoseconds to head-of-line block to wait for
 379   Rx descriptors.
 380   The accepted range is 0 to 400 ms.
 381   Flow control should be enabled to make it work.
 382   The value of **0** disables it and packets are dropped immediately.
 383   When a packet is dropped because of no Rx descriptors,
 384   ``rx_nodesc_drop_cnt`` counter grows.
 385   The feature is supported only by the DPDK firmware variant when equal
 386   stride super-buffer Rx mode is used.
 387
 388
 389 Dynamic Logging Parameters
 390 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 391
 392 One may leverage EAL option "--log-level" to change default levels
 393 for the log types supported by the driver. The option is used with
 394 an argument typically consisting of two parts separated by a colon.
 395
 396 Level value is the last part which takes a symbolic name (or integer).
 397 Log type is the former part which may shell match syntax.
 398 Depending on the choice of the expression, the given log level may
 399 be used either for some specific log type or for a subset of types.
 400
 401 SFC EFX PMD provides the following log types available for control:
 402
 403 - ``pmd.net.sfc.driver`` (default level is **notice**)
 404
 405   Affects driver-wide messages unrelated to any particular devices.
 406
 407 - ``pmd.net.sfc.main`` (default level is **notice**)
 408
 409   Matches a subset of per-port log types registered during runtime.
 410   A full name for a particular type may be obtained by appending a
 411   dot and a PCI device identifier (``XXXX:XX:XX.X``) to the prefix.
 412
 413 - ``pmd.net.sfc.mcdi`` (default level is **notice**)
 414
 415   Extra logging of the communication with the NIC's management CPU.
 416   The format of the log is consumed by the Solarflare netlogdecode
 417   cross-platform tool. May be managed per-port, as explained above.