doc/guides/nics/sfc_efx.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright(c) 2019-2021 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_net_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 - Transfer
 148
 149 Supported pattern items (***non-transfer*** rules):
 150
 151 - VOID
 152
 153 - ETH (exact match of source/destination addresses, individual/group match
 154   of destination address, EtherType in the outer frame and exact match of
 155   destination addresses, individual/group match of destination address in
 156   the inner frame)
 157
 158 - VLAN (exact match of VID, double-tagging is supported)
 159
 160 - IPV4 (exact match of source/destination addresses,
 161   IP transport protocol)
 162
 163 - IPV6 (exact match of source/destination addresses,
 164   IP transport protocol)
 165
 166 - TCP (exact match of source/destination ports)
 167
 168 - UDP (exact match of source/destination ports)
 169
 170 - VXLAN (exact match of VXLAN network identifier)
 171
 172 - GENEVE (exact match of virtual network identifier, only Ethernet (0x6558)
 173   protocol type is supported)
 174
 175 - NVGRE (exact match of virtual subnet ID)
 176
 177 Supported actions (***non-transfer*** rules):
 178
 179 - VOID
 180
 181 - QUEUE
 182
 183 - RSS
 184
 185 - DROP
 186
 187 - FLAG (supported only with ef10_essb Rx datapath)
 188
 189 - MARK (supported only with ef10_essb Rx datapath)
 190
 191 Supported pattern items (***transfer*** rules):
 192
 193 - PORT_ID (cannot repeat; conflicts with other traffic source items)
 194
 195 - PHY_PORT (cannot repeat; conflicts with other traffic source items)
 196
 197 - PF (cannot repeat; conflicts with other traffic source items)
 198
 199 - VF (cannot repeat; conflicts with other traffic source items)
 200
 201 - ETH
 202
 203 - VLAN (double-tagging is supported)
 204
 205 - IPV4 (source/destination addresses, IP transport protocol,
 206   type of service, time to live)
 207
 208 - IPV6 (source/destination addresses, IP transport protocol,
 209   traffic class, hop limit)
 210
 211 - TCP (source/destination ports, TCP header length + TCP flags)
 212
 213 - UDP (source/destination ports)
 214
 215 - VXLAN (exact match of VXLAN network identifier)
 216
 217 - GENEVE (exact match of virtual network identifier)
 218
 219 - NVGRE (exact match of virtual subnet ID)
 220
 221 Supported actions (***transfer*** rules):
 222
 223 - OF_POP_VLAN
 224
 225 - OF_PUSH_VLAN
 226
 227 - OF_VLAN_SET_VID
 228
 229 - OF_VLAN_SET_PCP
 230
 231 - VXLAN_DECAP
 232
 233 - VXLAN_ENCAP
 234
 235 - FLAG
 236
 237 - MARK
 238
 239 - PHY_PORT
 240
 241 - PF
 242
 243 - VF
 244
 245 - PORT_ID
 246
 247 - DROP
 248
 249 Validating flow rules depends on the firmware variant.
 250
 251 The :ref:`flow_isolated_mode` is supported.
 252
 253 The implementation is natively thread-safe.
 254
 255 Ethernet destination individual/group match
 256 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 257
 258 Ethernet item supports I/G matching, if only the corresponding bit is set
 259 in the mask of destination address. If destination address in the spec is
 260 multicast, it matches all multicast (and broadcast) packets, otherwise it
 261 matches unicast packets that are not filtered by other flow rules.
 262
 263 Exceptions to flow rules
 264 ~~~~~~~~~~~~~~~~~~~~~~~~
 265
 266 There is a list of exceptional flow rule patterns which will not be
 267 accepted by the PMD. A pattern will be rejected if at least one of the
 268 conditions is met:
 269
 270 - Filtering by IPv4 or IPv6 EtherType without pattern items of internet
 271   layer and above.
 272
 273 - The last item is IPV4 or IPV6, and it's empty.
 274
 275 - Filtering by TCP or UDP IP transport protocol without pattern items of
 276   transport layer and above.
 277
 278 - The last item is TCP or UDP, and it's empty.
 279
 280
 281 Supported NICs
 282 --------------
 283
 284 - Xilinx Adapters:
 285
 286    - Alveo SN1022 SmartNIC
 287
 288 - Solarflare XtremeScale Adapters:
 289
 290    - Solarflare X2522 Dual Port SFP28 10/25GbE Adapter
 291
 292    - Solarflare X2541 Single Port QSFP28 10/25G/100G Adapter
 293
 294    - Solarflare X2542 Dual Port QSFP28 10/25G/100G Adapter
 295
 296 - Solarflare Flareon [Ultra] Server Adapters:
 297
 298    - Solarflare SFN8522 Dual Port SFP+ Server Adapter
 299
 300    - Solarflare SFN8522M Dual Port SFP+ Server Adapter
 301
 302    - Solarflare SFN8042 Dual Port QSFP+ Server Adapter
 303
 304    - Solarflare SFN8542 Dual Port QSFP+ Server Adapter
 305
 306    - Solarflare SFN8722 Dual Port SFP+ OCP Server Adapter
 307
 308    - Solarflare SFN7002F Dual Port SFP+ Server Adapter
 309
 310    - Solarflare SFN7004F Quad Port SFP+ Server Adapter
 311
 312    - Solarflare SFN7042Q Dual Port QSFP+ Server Adapter
 313
 314    - Solarflare SFN7122F Dual Port SFP+ Server Adapter
 315
 316    - Solarflare SFN7124F Quad Port SFP+ Server Adapter
 317
 318    - Solarflare SFN7142Q Dual Port QSFP+ Server Adapter
 319
 320    - Solarflare SFN7322F Precision Time Synchronization Server Adapter
 321
 322
 323 Prerequisites
 324 -------------
 325
 326 - Requires firmware version:
 327
 328    - SFN7xxx: **4.7.1.1001** or higher
 329
 330    - SFN8xxx: **6.0.2.1004** or higher
 331
 332 Visit `Solarflare Support Downloads <https://support.solarflare.com>`_ to get
 333 Solarflare Utilities (either Linux or FreeBSD) with the latest firmware.
 334 Follow instructions from Solarflare Server Adapter User's Guide to
 335 update firmware and configure the adapter.
 336
 337
 338 Pre-Installation Configuration
 339 ------------------------------
 340
 341
 342 Build Options
 343 ~~~~~~~~~~~~~
 344
 345 The following build-time options may be enabled on build time using
 346 ``-Dc_args=`` meson argument (e.g.  ``-Dc_args=-DRTE_LIBRTE_SFC_EFX_DEBUG``).
 347
 348 Please note that enabling debugging options may affect system performance.
 349
 350 - ``RTE_LIBRTE_SFC_EFX_DEBUG`` (undefined by default)
 351
 352   Enable compilation of the extra run-time consistency checks.
 353
 354
 355 Per-Device Parameters
 356 ~~~~~~~~~~~~~~~~~~~~~
 357
 358 The following per-device parameters can be passed via EAL PCI device
 359 allow option like "-a 02:00.0,arg1=value1,...".
 360
 361 Case-insensitive 1/y/yes/on or 0/n/no/off may be used to specify
 362 boolean parameters value.
 363
 364 - ``class`` [net|vdpa] (default **net**)
 365
 366   Choose the mode of operation of ef100 device.
 367   **net** device will work as network device and will be probed by net/sfc driver.
 368   **vdpa** device will work as vdpa device and will be probed by vdpa/sfc driver.
 369   If this parameter is not specified then ef100 device will operate as
 370   network device.
 371
 372 - ``rx_datapath`` [auto|efx|ef10|ef10_essb] (default **auto**)
 373
 374   Choose receive datapath implementation.
 375   **auto** allows the driver itself to make a choice based on firmware
 376   features available and required by the datapath implementation.
 377   **efx** chooses libefx-based datapath which supports Rx scatter.
 378   Supported for SFN7xxx, SFN8xxx and X2xxx family adapters only.
 379   **ef10** chooses EF10 (SFN7xxx, SFN8xxx, X2xxx) native datapath which is
 380   more efficient than libefx-based and provides richer packet type
 381   classification.
 382   **ef10_essb** chooses SFNX2xxx equal stride super-buffer datapath
 383   which may be used on DPDK firmware variant only
 384   (see notes about its limitations above).
 385   **ef100** chooses EF100 native datapath which is the only supported
 386   Rx datapath for EF100 architecture based NICs.
 387
 388 - ``tx_datapath`` [auto|efx|ef10|ef10_simple|ef100] (default **auto**)
 389
 390   Choose transmit datapath implementation.
 391   **auto** allows the driver itself to make a choice based on firmware
 392   features available and required by the datapath implementation.
 393   **efx** chooses libefx-based datapath which supports VLAN insertion
 394   (full-feature firmware variant only), TSO and multi-segment mbufs.
 395   Mbuf segments may come from different mempools, and mbuf reference
 396   counters are treated responsibly.
 397   Supported for SFN7xxx, SFN8xxx and X2xxx family adapters only.
 398   **ef10** chooses EF10 (SFN7xxx, SFN8xxx, X2xxx) native datapath which is
 399   more efficient than libefx-based but has no VLAN insertion support yet.
 400   Mbuf segments may come from different mempools, and mbuf reference
 401   counters are treated responsibly.
 402   **ef10_simple** chooses EF10 (SFN7xxx, SFN8xxx, X2xxx) native datapath which
 403   is even more faster then **ef10** but does not support multi-segment
 404   mbufs, disallows multiple mempools and neglects mbuf reference counters.
 405   **ef100** chooses EF100 native datapath which supports multi-segment
 406   mbufs, VLAN insertion, inner/outer IPv4 and TCP/UDP checksum and TCP
 407   segmentation offloads including VXLAN and GENEVE IPv4/IPv6 tunnels.
 408
 409 - ``perf_profile`` [auto|throughput|low-latency] (default **throughput**)
 410
 411   Choose hardware tuning to be optimized for either throughput or
 412   low-latency.
 413   **auto** allows NIC firmware to make a choice based on
 414   installed licenses and firmware variant configured using **sfboot**.
 415
 416 - ``stats_update_period_ms`` [long] (default **1000**)
 417
 418   Adjust period in milliseconds to update port hardware statistics.
 419   The accepted range is 0 to 65535. The value of **0** may be used
 420   to disable periodic statistics update. One should note that it's
 421   only possible to set an arbitrary value on SFN8xxx and X2xxx provided that
 422   firmware version is 6.2.1.1033 or higher, otherwise any positive
 423   value will select a fixed update period of **1000** milliseconds
 424
 425 - ``fw_variant`` [dont-care|full-feature|ultra-low-latency|
 426   capture-packed-stream|dpdk] (default **dont-care**)
 427
 428   Choose the preferred firmware variant to use.
 429   The parameter is supported for SFN7xxX, SFN8xxx and X2xxx families only.
 430   In order for the selected option to have an effect, the **sfboot** utility
 431   must be configured with the **auto** firmware-variant option.
 432   The preferred firmware variant applies to all ports on the NIC.
 433   **dont-care** ensures that the driver can attach to an unprivileged function.
 434   The datapath firmware type to use is controlled by the **sfboot**
 435   utility.
 436   **full-feature** chooses full featured firmware.
 437   **ultra-low-latency** chooses firmware with fewer features but lower latency.
 438   **capture-packed-stream** chooses firmware for SolarCapture packed stream
 439   mode.
 440   **dpdk** chooses DPDK firmware with equal stride super-buffer Rx mode
 441   for higher Rx packet rate and packet marks support and firmware subvariant
 442   without checksumming on transmit for higher Tx packet rate if
 443   checksumming is not required.
 444
 445 - ``rxd_wait_timeout_ns`` [long] (default **200 us**)
 446
 447   Adjust timeout in nanoseconds to head-of-line block to wait for
 448   Rx descriptors.
 449   The accepted range is 0 to 400 ms.
 450   Flow control should be enabled to make it work.
 451   The value of **0** disables it and packets are dropped immediately.
 452   When a packet is dropped because of no Rx descriptors,
 453   ``rx_nodesc_drop_cnt`` counter grows.
 454   The feature is supported only by the DPDK firmware variant when equal
 455   stride super-buffer Rx mode is used.
 456
 457
 458 Dynamic Logging Parameters
 459 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 460
 461 One may leverage EAL option "--log-level" to change default levels
 462 for the log types supported by the driver. The option is used with
 463 an argument typically consisting of two parts separated by a colon.
 464
 465 Level value is the last part which takes a symbolic name (or integer).
 466 Log type is the former part which may shell match syntax.
 467 Depending on the choice of the expression, the given log level may
 468 be used either for some specific log type or for a subset of types.
 469
 470 SFC EFX PMD provides the following log types available for control:
 471
 472 - ``pmd.net.sfc.driver`` (default level is **notice**)
 473
 474   Affects driver-wide messages unrelated to any particular devices.
 475
 476 - ``pmd.net.sfc.main`` (default level is **notice**)
 477
 478   Matches a subset of per-port log types registered during runtime.
 479   A full name for a particular type may be obtained by appending a
 480   dot and a PCI device identifier (``XXXX:XX:XX.X``) to the prefix.
 481
 482 - ``pmd.net.sfc.mcdi`` (default level is **notice**)
 483
 484   Extra logging of the communication with the NIC's management CPU.
 485   The format of the log is consumed by the Solarflare netlogdecode
 486   cross-platform tool. May be managed per-port, as explained above.