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