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