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 - Multicast MAC filter
68 - IPv4/IPv6 TCP/UDP receive checksum offload
70 - Received packet type information
72 - Receive side scaling (RSS)
74 - Scattered Rx DMA for packet that are larger that a single Rx descriptor
76 - Deferred receive and transmit queue start
78 - Transmit VLAN insertion (if running firmware variant supports it)
81 Non-supported Features
82 ----------------------
84 The features not yet supported include:
86 - Receive queue interupts
88 - Priority-based flow control
92 - Configurable RX CRC stripping (always stripped)
94 - Header split on receive
106 Due to requirements on receive buffer alignment and usage of the receive
107 buffer for the auxiliary packet information provided by the NIC up to
108 extra 269 (14 bytes prefix plus up to 255 bytes for end padding) bytes may be
109 required in the receive buffer.
110 It should be taken into account when mbuf pool for receive is created.
116 - Solarflare Flareon [Ultra] Server Adapters:
118 - Solarflare SFN8522 Dual Port SFP+ Server Adapter
120 - Solarflare SFN8542 Dual Port QSFP+ Server Adapter
122 - Solarflare SFN7002F Dual Port SFP+ Server Adapter
124 - Solarflare SFN7004F Quad Port SFP+ Server Adapter
126 - Solarflare SFN7042Q Dual Port QSFP+ Server Adapter
128 - Solarflare SFN7122F Dual Port SFP+ Server Adapter
130 - Solarflare SFN7124F Quad Port SFP+ Server Adapter
132 - Solarflare SFN7142Q Dual Port QSFP+ Server Adapter
134 - Solarflare SFN7322F Precision Time Synchronization Server Adapter
140 - Requires firmware version:
142 - SFN7xxx: **4.7.1.1001** or higher
144 - SFN8xxx: **6.0.2.1004** or higher
146 Visit `Solarflare Support Downloads <https://support.solarflare.com>`_ to get
147 Solarflare Utilities (either Linux or FreeBSD) with the latest firmware.
148 Follow instructions from Solarflare Server Adapter User's Guide to
149 update firmware and configure the adapter.
152 Pre-Installation Configuration
153 ------------------------------
159 The following options can be modified in the ``.config`` file.
160 Please note that enabling debugging options may affect system performance.
162 - ``CONFIG_RTE_LIBRTE_SFC_EFX_PMD`` (default **y**)
164 Enable compilation of Solarflare libefx-based poll-mode driver.
166 - ``CONFIG_RTE_LIBRTE_SFC_EFX_DEBUG`` (default **n**)
168 Enable compilation of the extra run-time consistency checks.
171 Per-Device Parameters
172 ~~~~~~~~~~~~~~~~~~~~~
174 The following per-device parameters can be passed via EAL PCI device
175 whitelist option like "-w 02:00.0,arg1=value1,...".
177 Case-insensitive 1/y/yes/on or 0/n/no/off may be used to specify
178 boolean parameters value.
180 - ``perf_profile`` [auto|throughput|low-latency] (default **throughput**)
182 Choose hardware tunning to be optimized for either throughput or
184 **auto** allows NIC firmware to make a choice based on
185 installed licences and firmware variant configured using **sfboot**.
187 - ``debug_init`` [bool] (default **n**)
189 Enable extra logging during device intialization and startup.
191 - ``mcdi_logging`` [bool] (default **n**)
193 Enable extra logging of the communication with the NIC's management CPU.
194 The logging is done using RTE_LOG() with INFO level and PMD type.
195 The format is consumed by the Solarflare netlogdecode cross-platform tool.