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
50 Non-supported Features
51 ----------------------
53 The features not yet supported include:
55 - Link status change interrupt
57 - Receive queue interupts
59 - Priority-based flow control
63 - Configurable RX CRC stripping (always stripped)
65 - Header split on receive
79 - Solarflare Flareon [Ultra] Server Adapters:
81 - Solarflare SFN8522 Dual Port SFP+ Server Adapter
83 - Solarflare SFN8542 Dual Port QSFP+ Server Adapter
85 - Solarflare SFN7002F Dual Port SFP+ Server Adapter
87 - Solarflare SFN7004F Quad Port SFP+ Server Adapter
89 - Solarflare SFN7042Q Dual Port QSFP+ Server Adapter
91 - Solarflare SFN7122F Dual Port SFP+ Server Adapter
93 - Solarflare SFN7124F Quad Port SFP+ Server Adapter
95 - Solarflare SFN7142Q Dual Port QSFP+ Server Adapter
97 - Solarflare SFN7322F Precision Time Synchronization Server Adapter
103 - Requires firmware version:
105 - SFN7xxx: **4.7.1.1001** or higher
107 - SFN8xxx: **6.0.2.1004** or higher
109 Visit `Solarflare Support Downloads <https://support.solarflare.com>`_ to get
110 Solarflare Utilities (either Linux or FreeBSD) with the latest firmware.
111 Follow instructions from Solarflare Server Adapter User's Guide to
112 update firmware and configure the adapter.
115 Pre-Installation Configuration
116 ------------------------------
122 The following options can be modified in the ``.config`` file.
123 Please note that enabling debugging options may affect system performance.
125 - ``CONFIG_RTE_LIBRTE_SFC_EFX_PMD`` (default **y**)
127 Enable compilation of Solarflare libefx-based poll-mode driver.
129 - ``CONFIG_RTE_LIBRTE_SFC_EFX_DEBUG`` (default **n**)
131 Enable compilation of the extra run-time consistency checks.
134 Per-Device Parameters
135 ~~~~~~~~~~~~~~~~~~~~~
137 The following per-device parameters can be passed via EAL PCI device
138 whitelist option like "-w 02:00.0,arg1=value1,...".
140 Case-insensitive 1/y/yes/on or 0/n/no/off may be used to specify
141 boolean parameters value.
143 - ``debug_init`` [bool] (default **n**)
145 Enable extra logging during device intialization and startup.