1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2019-2020 Xilinx, Inc.
3 Copyright(c) 2016-2019 Solarflare Communications Inc.
5 This software was jointly developed between OKTET Labs (under contract
6 for Solarflare) and Solarflare Communications, Inc.
8 Solarflare libefx-based Poll Mode Driver
9 ========================================
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.
17 More information can be found at `Solarflare Communications website
18 <http://solarflare.com>`_.
24 SFC EFX PMD has support for:
26 - Multiple transmit and receive queues
28 - Link state information including link status change interrupt
30 - IPv4/IPv6 TCP/UDP transmit checksum offload
32 - Inner IPv4/IPv6 TCP/UDP transmit checksum offload
34 - Port hardware statistics
36 - Extended statistics (see Solarflare Server Adapter User's Guide for
37 the statistics description)
43 - Jumbo frames up to 9K
49 - TCP segmentation offload (TSO) including VXLAN and GENEVE encapsulated
51 - Multicast MAC filter
53 - IPv4/IPv6 TCP/UDP receive checksum offload
55 - Inner IPv4/IPv6 TCP/UDP receive checksum offload
57 - Received packet type information
59 - Receive side scaling (RSS)
63 - Scattered Rx DMA for packet that are larger that a single Rx descriptor
65 - Receive queue interrupts
67 - Deferred receive and transmit queue start
69 - Transmit VLAN insertion (if running firmware variant supports it)
78 Non-supported Features
79 ----------------------
81 The features not yet supported include:
83 - Priority-based flow control
85 - Configurable RX CRC stripping (always stripped)
87 - Header split on receive
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.
106 Equal stride super-buffer mode
107 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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.
117 Another limitation of a equal stride super-buffer mode, imposed by the
118 firmware, is that it allows for a single RSS context.
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.
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.
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.
144 Supported attributes:
149 Supported pattern items (***non-transfer*** rules):
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
158 - VLAN (exact match of VID, double-tagging is supported)
160 - IPV4 (exact match of source/destination addresses,
161 IP transport protocol)
163 - IPV6 (exact match of source/destination addresses,
164 IP transport protocol)
166 - TCP (exact match of source/destination ports)
168 - UDP (exact match of source/destination ports)
170 - VXLAN (exact match of VXLAN network identifier)
172 - GENEVE (exact match of virtual network identifier, only Ethernet (0x6558)
173 protocol type is supported)
175 - NVGRE (exact match of virtual subnet ID)
177 Supported actions (***non-transfer*** rules):
187 - FLAG (supported only with ef10_essb Rx datapath)
189 - MARK (supported only with ef10_essb Rx datapath)
191 Supported pattern items (***transfer*** rules):
193 - PORT_ID (cannot repeat; conflicts with other traffic source items)
195 - PHY_PORT (cannot repeat; conflicts with other traffic source items)
197 - PF (cannot repeat; conflicts with other traffic source items)
199 - VF (cannot repeat; conflicts with other traffic source items)
203 - VLAN (double-tagging is supported)
205 Supported actions (***transfer*** rules):
229 Validating flow rules depends on the firmware variant.
231 The :ref:`flow_isolated_mode` is supported.
233 Ethernet destination individual/group match
234 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
236 Ethernet item supports I/G matching, if only the corresponding bit is set
237 in the mask of destination address. If destination address in the spec is
238 multicast, it matches all multicast (and broadcast) packets, otherwise it
239 matches unicast packets that are not filtered by other flow rules.
241 Exceptions to flow rules
242 ~~~~~~~~~~~~~~~~~~~~~~~~
244 There is a list of exceptional flow rule patterns which will not be
245 accepted by the PMD. A pattern will be rejected if at least one of the
248 - Filtering by IPv4 or IPv6 EtherType without pattern items of internet
251 - The last item is IPV4 or IPV6, and it's empty.
253 - Filtering by TCP or UDP IP transport protocol without pattern items of
254 transport layer and above.
256 - The last item is TCP or UDP, and it's empty.
264 - Alveo SN1022 SmartNIC
266 - Solarflare XtremeScale Adapters:
268 - Solarflare X2522 Dual Port SFP28 10/25GbE Adapter
270 - Solarflare X2541 Single Port QSFP28 10/25G/100G Adapter
272 - Solarflare X2542 Dual Port QSFP28 10/25G/100G Adapter
274 - Solarflare Flareon [Ultra] Server Adapters:
276 - Solarflare SFN8522 Dual Port SFP+ Server Adapter
278 - Solarflare SFN8522M Dual Port SFP+ Server Adapter
280 - Solarflare SFN8042 Dual Port QSFP+ Server Adapter
282 - Solarflare SFN8542 Dual Port QSFP+ Server Adapter
284 - Solarflare SFN8722 Dual Port SFP+ OCP Server Adapter
286 - Solarflare SFN7002F Dual Port SFP+ Server Adapter
288 - Solarflare SFN7004F Quad Port SFP+ Server Adapter
290 - Solarflare SFN7042Q Dual Port QSFP+ Server Adapter
292 - Solarflare SFN7122F Dual Port SFP+ Server Adapter
294 - Solarflare SFN7124F Quad Port SFP+ Server Adapter
296 - Solarflare SFN7142Q Dual Port QSFP+ Server Adapter
298 - Solarflare SFN7322F Precision Time Synchronization Server Adapter
304 - Requires firmware version:
306 - SFN7xxx: **4.7.1.1001** or higher
308 - SFN8xxx: **6.0.2.1004** or higher
310 Visit `Solarflare Support Downloads <https://support.solarflare.com>`_ to get
311 Solarflare Utilities (either Linux or FreeBSD) with the latest firmware.
312 Follow instructions from Solarflare Server Adapter User's Guide to
313 update firmware and configure the adapter.
316 Pre-Installation Configuration
317 ------------------------------
323 The following build-time options may be enabled on build time using
324 ``-Dc_args=`` meson argument (e.g. ``-Dc_args=-DRTE_LIBRTE_SFC_EFX_DEBUG``).
326 Please note that enabling debugging options may affect system performance.
328 - ``RTE_LIBRTE_SFC_EFX_DEBUG`` (undefined by default)
330 Enable compilation of the extra run-time consistency checks.
333 Per-Device Parameters
334 ~~~~~~~~~~~~~~~~~~~~~
336 The following per-device parameters can be passed via EAL PCI device
337 whitelist option like "-w 02:00.0,arg1=value1,...".
339 Case-insensitive 1/y/yes/on or 0/n/no/off may be used to specify
340 boolean parameters value.
342 - ``rx_datapath`` [auto|efx|ef10|ef10_essb] (default **auto**)
344 Choose receive datapath implementation.
345 **auto** allows the driver itself to make a choice based on firmware
346 features available and required by the datapath implementation.
347 **efx** chooses libefx-based datapath which supports Rx scatter.
348 Supported for SFN7xxx, SFN8xxx and X2xxx family adapters only.
349 **ef10** chooses EF10 (SFN7xxx, SFN8xxx, X2xxx) native datapath which is
350 more efficient than libefx-based and provides richer packet type
352 **ef10_essb** chooses SFNX2xxx equal stride super-buffer datapath
353 which may be used on DPDK firmware variant only
354 (see notes about its limitations above).
355 **ef100** chooses EF100 native datapath which is the only supported
356 Rx datapath for EF100 architecture based NICs.
358 - ``tx_datapath`` [auto|efx|ef10|ef10_simple|ef100] (default **auto**)
360 Choose transmit datapath implementation.
361 **auto** allows the driver itself to make a choice based on firmware
362 features available and required by the datapath implementation.
363 **efx** chooses libefx-based datapath which supports VLAN insertion
364 (full-feature firmware variant only), TSO and multi-segment mbufs.
365 Mbuf segments may come from different mempools, and mbuf reference
366 counters are treated responsibly.
367 Supported for SFN7xxx, SFN8xxx and X2xxx family adapters only.
368 **ef10** chooses EF10 (SFN7xxx, SFN8xxx, X2xxx) native datapath which is
369 more efficient than libefx-based but has no VLAN insertion support yet.
370 Mbuf segments may come from different mempools, and mbuf reference
371 counters are treated responsibly.
372 **ef10_simple** chooses EF10 (SFN7xxx, SFN8xxx, X2xxx) native datapath which
373 is even more faster then **ef10** but does not support multi-segment
374 mbufs, disallows multiple mempools and neglects mbuf reference counters.
375 **ef100** chooses EF100 native datapath which supports multi-segment
376 mbufs, VLAN insertion, inner/outer IPv4 and TCP/UDP checksum and TCP
377 segmentation offloads including VXLAN and GENEVE IPv4/IPv6 tunnels.
379 - ``perf_profile`` [auto|throughput|low-latency] (default **throughput**)
381 Choose hardware tuning to be optimized for either throughput or
383 **auto** allows NIC firmware to make a choice based on
384 installed licenses and firmware variant configured using **sfboot**.
386 - ``stats_update_period_ms`` [long] (default **1000**)
388 Adjust period in milliseconds to update port hardware statistics.
389 The accepted range is 0 to 65535. The value of **0** may be used
390 to disable periodic statistics update. One should note that it's
391 only possible to set an arbitrary value on SFN8xxx and X2xxx provided that
392 firmware version is 6.2.1.1033 or higher, otherwise any positive
393 value will select a fixed update period of **1000** milliseconds
395 - ``fw_variant`` [dont-care|full-feature|ultra-low-latency|
396 capture-packed-stream|dpdk] (default **dont-care**)
398 Choose the preferred firmware variant to use.
399 The parameter is supported for SFN7xxX, SFN8xxx and X2xxx families only.
400 In order for the selected option to have an effect, the **sfboot** utility
401 must be configured with the **auto** firmware-variant option.
402 The preferred firmware variant applies to all ports on the NIC.
403 **dont-care** ensures that the driver can attach to an unprivileged function.
404 The datapath firmware type to use is controlled by the **sfboot**
406 **full-feature** chooses full featured firmware.
407 **ultra-low-latency** chooses firmware with fewer features but lower latency.
408 **capture-packed-stream** chooses firmware for SolarCapture packed stream
410 **dpdk** chooses DPDK firmware with equal stride super-buffer Rx mode
411 for higher Rx packet rate and packet marks support and firmware subvariant
412 without checksumming on transmit for higher Tx packet rate if
413 checksumming is not required.
415 - ``rxd_wait_timeout_ns`` [long] (default **200 us**)
417 Adjust timeout in nanoseconds to head-of-line block to wait for
419 The accepted range is 0 to 400 ms.
420 Flow control should be enabled to make it work.
421 The value of **0** disables it and packets are dropped immediately.
422 When a packet is dropped because of no Rx descriptors,
423 ``rx_nodesc_drop_cnt`` counter grows.
424 The feature is supported only by the DPDK firmware variant when equal
425 stride super-buffer Rx mode is used.
428 Dynamic Logging Parameters
429 ~~~~~~~~~~~~~~~~~~~~~~~~~~
431 One may leverage EAL option "--log-level" to change default levels
432 for the log types supported by the driver. The option is used with
433 an argument typically consisting of two parts separated by a colon.
435 Level value is the last part which takes a symbolic name (or integer).
436 Log type is the former part which may shell match syntax.
437 Depending on the choice of the expression, the given log level may
438 be used either for some specific log type or for a subset of types.
440 SFC EFX PMD provides the following log types available for control:
442 - ``pmd.net.sfc.driver`` (default level is **notice**)
444 Affects driver-wide messages unrelated to any particular devices.
446 - ``pmd.net.sfc.main`` (default level is **notice**)
448 Matches a subset of per-port log types registered during runtime.
449 A full name for a particular type may be obtained by appending a
450 dot and a PCI device identifier (``XXXX:XX:XX.X``) to the prefix.
452 - ``pmd.net.sfc.mcdi`` (default level is **notice**)
454 Extra logging of the communication with the NIC's management CPU.
455 The format of the log is consumed by the Solarflare netlogdecode
456 cross-platform tool. May be managed per-port, as explained above.