2 Copyright (c) 2016 Solarflare Communications Inc.
5 This software was jointly developed between OKTET Labs (under contract
6 for Solarflare) and Solarflare Communications, Inc.
8 Redistribution and use in source and binary forms, with or without
9 modification, are permitted provided that the following conditions are met:
11 1. Redistributions of source code must retain the above copyright notice,
12 this list of conditions and the following disclaimer.
13 2. Redistributions in binary form must reproduce the above copyright notice,
14 this list of conditions and the following disclaimer in the documentation
15 and/or other materials provided with the distribution.
17 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
18 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
19 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
20 PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
21 CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
22 EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
23 PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
24 OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
25 WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
26 OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
27 EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 Solarflare libefx-based Poll Mode Driver
30 ========================================
32 The SFC EFX PMD (**librte_pmd_sfc_efx**) provides poll mode driver support
33 for **Solarflare SFN7xxx and SFN8xxx** family of 10/40 Gbps adapters.
34 SFC EFX PMD has support for the latest Linux and FreeBSD operating systems.
36 More information can be found at `Solarflare Communications website
37 <http://solarflare.com>`_.
43 SFC EFX PMD has support for:
45 - Multiple transmit and receive queues
47 - Link state information including link status change interrupt
49 - IPv4/IPv6 TCP/UDP transmit checksum offload
51 - Port hardware statistics
53 - Extended statistics (see Solarflare Server Adapter User's Guide for
54 the statistics description)
60 - Jumbo frames up to 9K
66 - TCP segmentation offload (TSO)
68 - Multicast MAC filter
70 - IPv4/IPv6 TCP/UDP receive checksum offload
72 - Received packet type information
74 - Receive side scaling (RSS)
78 - Scattered Rx DMA for packet that are larger that a single Rx descriptor
80 - Deferred receive and transmit queue start
82 - Transmit VLAN insertion (if running firmware variant supports it)
87 Non-supported Features
88 ----------------------
90 The features not yet supported include:
92 - Receive queue interupts
94 - Priority-based flow control
98 - Configurable RX CRC stripping (always stripped)
100 - Header split on receive
112 Due to requirements on receive buffer alignment and usage of the receive
113 buffer for the auxiliary packet information provided by the NIC up to
114 extra 269 (14 bytes prefix plus up to 255 bytes for end padding) bytes may be
115 required in the receive buffer.
116 It should be taken into account when mbuf pool for receive is created.
122 Supported attributes:
126 Supported pattern items:
130 - ETH (exact match of source/destination addresses, individual/group match
131 of destination address, EtherType)
133 - VLAN (exact match of VID, double-tagging is supported)
135 - IPV4 (exact match of source/destination addresses,
136 IP transport protocol)
138 - IPV6 (exact match of source/destination addresses,
139 IP transport protocol)
141 - TCP (exact match of source/destination ports)
143 - UDP (exact match of source/destination ports)
153 Validating flow rules depends on the firmware variant.
155 Ethernet destinaton individual/group match
156 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
158 Ethernet item supports I/G matching, if only the corresponding bit is set
159 in the mask of destination address. If destinaton address in the spec is
160 multicast, it matches all multicast (and broadcast) packets, oherwise it
161 matches unicast packets that are not filtered by other flow rules.
167 - Solarflare Flareon [Ultra] Server Adapters:
169 - Solarflare SFN8522 Dual Port SFP+ Server Adapter
171 - Solarflare SFN8542 Dual Port QSFP+ Server Adapter
173 - Solarflare SFN7002F Dual Port SFP+ Server Adapter
175 - Solarflare SFN7004F Quad Port SFP+ Server Adapter
177 - Solarflare SFN7042Q Dual Port QSFP+ Server Adapter
179 - Solarflare SFN7122F Dual Port SFP+ Server Adapter
181 - Solarflare SFN7124F Quad Port SFP+ Server Adapter
183 - Solarflare SFN7142Q Dual Port QSFP+ Server Adapter
185 - Solarflare SFN7322F Precision Time Synchronization Server Adapter
191 - Requires firmware version:
193 - SFN7xxx: **4.7.1.1001** or higher
195 - SFN8xxx: **6.0.2.1004** or higher
197 Visit `Solarflare Support Downloads <https://support.solarflare.com>`_ to get
198 Solarflare Utilities (either Linux or FreeBSD) with the latest firmware.
199 Follow instructions from Solarflare Server Adapter User's Guide to
200 update firmware and configure the adapter.
203 Pre-Installation Configuration
204 ------------------------------
210 The following options can be modified in the ``.config`` file.
211 Please note that enabling debugging options may affect system performance.
213 - ``CONFIG_RTE_LIBRTE_SFC_EFX_PMD`` (default **y**)
215 Enable compilation of Solarflare libefx-based poll-mode driver.
217 - ``CONFIG_RTE_LIBRTE_SFC_EFX_DEBUG`` (default **n**)
219 Enable compilation of the extra run-time consistency checks.
222 Per-Device Parameters
223 ~~~~~~~~~~~~~~~~~~~~~
225 The following per-device parameters can be passed via EAL PCI device
226 whitelist option like "-w 02:00.0,arg1=value1,...".
228 Case-insensitive 1/y/yes/on or 0/n/no/off may be used to specify
229 boolean parameters value.
231 - ``rx_datapath`` [auto|efx|ef10] (default **auto**)
233 Choose receive datapath implementation.
234 **auto** allows the driver itself to make a choice based on firmware
235 features available and required by the datapath implementation.
236 **efx** chooses libefx-based datapath which supports Rx scatter.
237 **ef10** chooses EF10 (SFN7xxx, SFN8xxx) native datapath which is
238 more efficient than libefx-based and provides richer packet type
239 classification, but lacks Rx scatter support.
241 - ``tx_datapath`` [auto|efx|ef10|ef10_simple] (default **auto**)
243 Choose transmit datapath implementation.
244 **auto** allows the driver itself to make a choice based on firmware
245 features available and required by the datapath implementation.
246 **efx** chooses libefx-based datapath which supports VLAN insertion
247 (full-feature firmware variant only), TSO and multi-segment mbufs.
248 Mbuf segments may come from different mempools, and mbuf reference
249 counters are treated responsibly.
250 **ef10** chooses EF10 (SFN7xxx, SFN8xxx) native datapath which is
251 more efficient than libefx-based but has no VLAN insertion and TSO
253 Mbuf segments may come from different mempools, and mbuf reference
254 counters are treated responsibly.
255 **ef10_simple** chooses EF10 (SFN7xxx, SFN8xxx) native datapath which
256 is even more faster then **ef10** but does not support multi-segment
257 mbufs, disallows multiple mempools and neglects mbuf reference counters.
259 - ``perf_profile`` [auto|throughput|low-latency] (default **throughput**)
261 Choose hardware tunning to be optimized for either throughput or
263 **auto** allows NIC firmware to make a choice based on
264 installed licences and firmware variant configured using **sfboot**.
266 - ``debug_init`` [bool] (default **n**)
268 Enable extra logging during device initialization and startup.
270 - ``mcdi_logging`` [bool] (default **n**)
272 Enable extra logging of the communication with the NIC's management CPU.
273 The logging is done using RTE_LOG() with INFO level and PMD type.
274 The format is consumed by the Solarflare netlogdecode cross-platform tool.
276 - ``stats_update_period_ms`` [long] (default **1000**)
278 Adjust period in milliseconds to update port hardware statistics.
279 The accepted range is 0 to 65535. The value of **0** may be used
280 to disable periodic statistics update. One should note that it's
281 only possible to set an arbitrary value on SFN8xxx provided that
282 firmware version is 6.2.1.1033 or higher, otherwise any positive
283 value will select a fixed update period of **1000** milliseconds