doc/guides/nics/sfc_efx.rst

   1 ..  BSD LICENSE
   2     Copyright (c) 2016 Solarflare Communications Inc.
   3     All rights reserved.
   4
   5     This software was jointly developed between OKTET Labs (under contract
   6     for Solarflare) and Solarflare Communications, Inc.
   7
   8     Redistribution and use in source and binary forms, with or without
   9     modification, are permitted provided that the following conditions are met:
  10
  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.
  16
  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.
  28
  29 Solarflare libefx-based Poll Mode Driver
  30 ========================================
  31
  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.
  35
  36 More information can be found at `Solarflare Communications website
  37 <http://solarflare.com>`_.
  38
  39
  40 Features
  41 --------
  42
  43 SFC EFX PMD has support for:
  44
  45 - Multiple transmit and receive queues
  46
  47 - Link state information
  48
  49 - IPv4/IPv6 TCP/UDP transmit checksum offload
  50
  51 - Port hardware statistics
  52
  53
  54 Non-supported Features
  55 ----------------------
  56
  57 The features not yet supported include:
  58
  59 - Link status change interrupt
  60
  61 - Receive queue interupts
  62
  63 - Priority-based flow control
  64
  65 - Loopback
  66
  67 - Configurable RX CRC stripping (always stripped)
  68
  69 - Header split on receive
  70
  71 - VLAN filtering
  72
  73 - VLAN stripping
  74
  75 - Scattered receive
  76
  77 - LRO
  78
  79
  80 Limitations
  81 -----------
  82
  83 Due to requirements on receive buffer alignment and usage of the receive
  84 buffer for the auxiliary packet information provided by the NIC up to
  85 extra 269 (14 bytes prefix plus up to 255 bytes for end padding) bytes may be
  86 required in the receive buffer.
  87 It should be taken into account when mbuf pool for receive is created.
  88
  89
  90 Supported NICs
  91 --------------
  92
  93 - Solarflare Flareon [Ultra] Server Adapters:
  94
  95    - Solarflare SFN8522 Dual Port SFP+ Server Adapter
  96
  97    - Solarflare SFN8542 Dual Port QSFP+ Server Adapter
  98
  99    - Solarflare SFN7002F Dual Port SFP+ Server Adapter
 100
 101    - Solarflare SFN7004F Quad Port SFP+ Server Adapter
 102
 103    - Solarflare SFN7042Q Dual Port QSFP+ Server Adapter
 104
 105    - Solarflare SFN7122F Dual Port SFP+ Server Adapter
 106
 107    - Solarflare SFN7124F Quad Port SFP+ Server Adapter
 108
 109    - Solarflare SFN7142Q Dual Port QSFP+ Server Adapter
 110
 111    - Solarflare SFN7322F Precision Time Synchronization Server Adapter
 112
 113
 114 Prerequisites
 115 -------------
 116
 117 - Requires firmware version:
 118
 119    - SFN7xxx: **4.7.1.1001** or higher
 120
 121    - SFN8xxx: **6.0.2.1004** or higher
 122
 123 Visit `Solarflare Support Downloads <https://support.solarflare.com>`_ to get
 124 Solarflare Utilities (either Linux or FreeBSD) with the latest firmware.
 125 Follow instructions from Solarflare Server Adapter User's Guide to
 126 update firmware and configure the adapter.
 127
 128
 129 Pre-Installation Configuration
 130 ------------------------------
 131
 132
 133 Config File Options
 134 ~~~~~~~~~~~~~~~~~~~
 135
 136 The following options can be modified in the ``.config`` file.
 137 Please note that enabling debugging options may affect system performance.
 138
 139 - ``CONFIG_RTE_LIBRTE_SFC_EFX_PMD`` (default **y**)
 140
 141   Enable compilation of Solarflare libefx-based poll-mode driver.
 142
 143 - ``CONFIG_RTE_LIBRTE_SFC_EFX_DEBUG`` (default **n**)
 144
 145   Enable compilation of the extra run-time consistency checks.
 146
 147
 148 Per-Device Parameters
 149 ~~~~~~~~~~~~~~~~~~~~~
 150
 151 The following per-device parameters can be passed via EAL PCI device
 152 whitelist option like "-w 02:00.0,arg1=value1,...".
 153
 154 Case-insensitive 1/y/yes/on or 0/n/no/off may be used to specify
 155 boolean parameters value.
 156
 157 - ``perf_profile`` [auto|throughput|low-latency] (default **throughput**)
 158
 159   Choose hardware tunning to be optimized for either throughput or
 160   low-latency.
 161   **auto** allows NIC firmware to make a choice based on
 162   installed licences and firmware variant configured using **sfboot**.
 163
 164 - ``debug_init`` [bool] (default **n**)
 165
 166   Enable extra logging during device intialization and startup.
 167
 168 - ``mcdi_logging`` [bool] (default **n**)
 169
 170   Enable extra logging of the communication with the NIC's management CPU.
 171   The logging is done using RTE_LOG() with INFO level and PMD type.
 172   The format is consumed by the Solarflare netlogdecode cross-platform tool.