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