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