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 - Inner IPv4/IPv6 TCP/UDP transmit checksum offload
53 - Port hardware statistics
55 - Extended statistics (see Solarflare Server Adapter User's Guide for
56 the statistics description)
62 - Jumbo frames up to 9K
68 - TCP segmentation offload (TSO)
70 - Multicast MAC filter
72 - IPv4/IPv6 TCP/UDP receive checksum offload
74 - Inner IPv4/IPv6 TCP/UDP receive checksum offload
76 - Received packet type information
78 - Receive side scaling (RSS)
82 - Scattered Rx DMA for packet that are larger that a single Rx descriptor
84 - Deferred receive and transmit queue start
86 - Transmit VLAN insertion (if running firmware variant supports it)
91 Non-supported Features
92 ----------------------
94 The features not yet supported include:
96 - Receive queue interupts
98 - Priority-based flow control
102 - Configurable RX CRC stripping (always stripped)
104 - Header split on receive
116 Due to requirements on receive buffer alignment and usage of the receive
117 buffer for the auxiliary packet information provided by the NIC up to
118 extra 269 (14 bytes prefix plus up to 255 bytes for end padding) bytes may be
119 required in the receive buffer.
120 It should be taken into account when mbuf pool for receive is created.
126 NVGRE, VXLAN and GENEVE tunnels are supported on SFN8xxx family adapters
127 with full-feature firmware variant running.
128 **sfboot** should be used to configure NIC to run full-feature firmware variant.
129 See Solarflare Server Adapter User's Guide for details.
131 SFN8xxx family adapters provide either inner or outer packet classes.
132 If adapter firmware advertises support for tunnels then the PMD
133 configures the hardware to report inner classes, and outer classes are
134 not reported in received packets.
135 However, for VXLAN and GENEVE tunnels the PMD does report UDP as the
136 outer layer 4 packet type.
138 SFN8xxx family adapters report GENEVE packets as VXLAN.
139 If UDP ports are configured for only one tunnel type then it is safe to
140 treat VXLAN packet type indication as the corresponding UDP tunnel type.
146 Supported attributes:
150 Supported pattern items:
154 - ETH (exact match of source/destination addresses, individual/group match
155 of destination address, EtherType in the outer frame and exact match of
156 destination addresses, individual/group match of destination address in
159 - VLAN (exact match of VID, double-tagging is supported)
161 - IPV4 (exact match of source/destination addresses,
162 IP transport protocol)
164 - IPV6 (exact match of source/destination addresses,
165 IP transport protocol)
167 - TCP (exact match of source/destination ports)
169 - UDP (exact match of source/destination ports)
171 - VXLAN (exact match of VXLAN network identifier)
173 - GENEVE (exact match of virtual network identifier, only Ethernet (0x6558)
174 protocol type is supported)
176 - NVGRE (exact match of virtual subnet ID)
188 Validating flow rules depends on the firmware variant.
190 Ethernet destinaton individual/group match
191 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
193 Ethernet item supports I/G matching, if only the corresponding bit is set
194 in the mask of destination address. If destinaton address in the spec is
195 multicast, it matches all multicast (and broadcast) packets, oherwise it
196 matches unicast packets that are not filtered by other flow rules.
198 Exceptions to flow rules
199 ~~~~~~~~~~~~~~~~~~~~~~~~
201 There is a list of exceptional flow rule patterns which will not be
202 accepted by the PMD. A pattern will be rejected if at least one of the
205 - Filtering by IPv4 or IPv6 EtherType without pattern items of internet
208 - The last item is IPV4 or IPV6, and it's empty.
210 - Filtering by TCP or UDP IP transport protocol without pattern items of
211 transport layer and above.
213 - The last item is TCP or UDP, and it's empty.
219 - Solarflare Flareon [Ultra] Server Adapters:
221 - Solarflare SFN8522 Dual Port SFP+ Server Adapter
223 - Solarflare SFN8522M Dual Port SFP+ Server Adapter
225 - Solarflare SFN8042 Dual Port QSFP+ Server Adapter
227 - Solarflare SFN8542 Dual Port QSFP+ Server Adapter
229 - Solarflare SFN8722 Dual Port SFP+ OCP Server Adapter
231 - Solarflare SFN7002F Dual Port SFP+ Server Adapter
233 - Solarflare SFN7004F Quad Port SFP+ Server Adapter
235 - Solarflare SFN7042Q Dual Port QSFP+ Server Adapter
237 - Solarflare SFN7122F Dual Port SFP+ Server Adapter
239 - Solarflare SFN7124F Quad Port SFP+ Server Adapter
241 - Solarflare SFN7142Q Dual Port QSFP+ Server Adapter
243 - Solarflare SFN7322F Precision Time Synchronization Server Adapter
249 - Requires firmware version:
251 - SFN7xxx: **4.7.1.1001** or higher
253 - SFN8xxx: **6.0.2.1004** or higher
255 Visit `Solarflare Support Downloads <https://support.solarflare.com>`_ to get
256 Solarflare Utilities (either Linux or FreeBSD) with the latest firmware.
257 Follow instructions from Solarflare Server Adapter User's Guide to
258 update firmware and configure the adapter.
261 Pre-Installation Configuration
262 ------------------------------
268 The following options can be modified in the ``.config`` file.
269 Please note that enabling debugging options may affect system performance.
271 - ``CONFIG_RTE_LIBRTE_SFC_EFX_PMD`` (default **y**)
273 Enable compilation of Solarflare libefx-based poll-mode driver.
275 - ``CONFIG_RTE_LIBRTE_SFC_EFX_DEBUG`` (default **n**)
277 Enable compilation of the extra run-time consistency checks.
280 Per-Device Parameters
281 ~~~~~~~~~~~~~~~~~~~~~
283 The following per-device parameters can be passed via EAL PCI device
284 whitelist option like "-w 02:00.0,arg1=value1,...".
286 Case-insensitive 1/y/yes/on or 0/n/no/off may be used to specify
287 boolean parameters value.
289 - ``rx_datapath`` [auto|efx|ef10] (default **auto**)
291 Choose receive datapath implementation.
292 **auto** allows the driver itself to make a choice based on firmware
293 features available and required by the datapath implementation.
294 **efx** chooses libefx-based datapath which supports Rx scatter.
295 **ef10** chooses EF10 (SFN7xxx, SFN8xxx) native datapath which is
296 more efficient than libefx-based and provides richer packet type
297 classification, but lacks Rx scatter support.
299 - ``tx_datapath`` [auto|efx|ef10|ef10_simple] (default **auto**)
301 Choose transmit datapath implementation.
302 **auto** allows the driver itself to make a choice based on firmware
303 features available and required by the datapath implementation.
304 **efx** chooses libefx-based datapath which supports VLAN insertion
305 (full-feature firmware variant only), TSO and multi-segment mbufs.
306 Mbuf segments may come from different mempools, and mbuf reference
307 counters are treated responsibly.
308 **ef10** chooses EF10 (SFN7xxx, SFN8xxx) native datapath which is
309 more efficient than libefx-based but has no VLAN insertion and TSO
311 Mbuf segments may come from different mempools, and mbuf reference
312 counters are treated responsibly.
313 **ef10_simple** chooses EF10 (SFN7xxx, SFN8xxx) native datapath which
314 is even more faster then **ef10** but does not support multi-segment
315 mbufs, disallows multiple mempools and neglects mbuf reference counters.
317 - ``perf_profile`` [auto|throughput|low-latency] (default **throughput**)
319 Choose hardware tunning to be optimized for either throughput or
321 **auto** allows NIC firmware to make a choice based on
322 installed licences and firmware variant configured using **sfboot**.
324 - ``mcdi_logging`` [bool] (default **n**)
326 Enable extra logging of the communication with the NIC's management CPU.
327 The logging is done using RTE_LOG() with INFO level and PMD type.
328 The format is consumed by the Solarflare netlogdecode cross-platform tool.
330 - ``stats_update_period_ms`` [long] (default **1000**)
332 Adjust period in milliseconds to update port hardware statistics.
333 The accepted range is 0 to 65535. The value of **0** may be used
334 to disable periodic statistics update. One should note that it's
335 only possible to set an arbitrary value on SFN8xxx provided that
336 firmware version is 6.2.1.1033 or higher, otherwise any positive
337 value will select a fixed update period of **1000** milliseconds
340 Dynamic Logging Parameters
341 ~~~~~~~~~~~~~~~~~~~~~~~~~~
343 One may leverage EAL option "--log-level" to change default levels
344 for the log types supported by the driver. The option is used with
345 an argument typically consisting of two parts separated by a comma.
347 Level value is the last part which takes an integer greater than 0.
348 Log type is the former part which may contain a regular expression.
349 Depending on the choice of the expression, the given log level may
350 be used either for some specific log type or for a subset of types.
352 SFC EFX PMD provides the following log types available for control:
354 - ``pmd.net.sfc.driver`` (default level is **6** - ``RTE_LOG_NOTICE``)
356 Affects driver-wide messages unrelated to any particular devices.
358 - ``pmd.net.sfc.main`` (default level is **6** - ``RTE_LOG_NOTICE``)
360 Matches a subset of per-port log types registered during runtime.
361 A full name for a particular type may be obtained by appending a
362 dot and a PCI device identifier (``XXXX:XX:XX.X``) to the prefix.