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