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 Supported NICs
  41 --------------
  42
  43 - Solarflare Flareon [Ultra] Server Adapters:
  44
  45    - Solarflare SFN8522 Dual Port SFP+ Server Adapter
  46
  47    - Solarflare SFN8542 Dual Port QSFP+ Server Adapter
  48
  49    - Solarflare SFN7002F Dual Port SFP+ Server Adapter
  50
  51    - Solarflare SFN7004F Quad Port SFP+ Server Adapter
  52
  53    - Solarflare SFN7042Q Dual Port QSFP+ Server Adapter
  54
  55    - Solarflare SFN7122F Dual Port SFP+ Server Adapter
  56
  57    - Solarflare SFN7124F Quad Port SFP+ Server Adapter
  58
  59    - Solarflare SFN7142Q Dual Port QSFP+ Server Adapter
  60
  61    - Solarflare SFN7322F Precision Time Synchronization Server Adapter
  62
  63
  64 Prerequisites
  65 -------------
  66
  67 - Requires firmware version:
  68
  69    - SFN7xxx: **4.7.1.1001** or higher
  70
  71    - SFN8xxx: **6.0.2.1004** or higher
  72
  73 Visit `Solarflare Support Downloads <https://support.solarflare.com>`_ to get
  74 Solarflare Utilities (either Linux or FreeBSD) with the latest firmware.
  75 Follow instructions from Solarflare Server Adapter User's Guide to
  76 update firmware and configure the adapter.
  77
  78
  79 Pre-Installation Configuration
  80 ------------------------------
  81
  82
  83 Config File Options
  84 ~~~~~~~~~~~~~~~~~~~
  85
  86 The following options can be modified in the ``.config`` file.
  87 Please note that enabling debugging options may affect system performance.
  88
  89 - ``CONFIG_RTE_LIBRTE_SFC_EFX_PMD`` (default **y**)
  90
  91   Enable compilation of Solarflare libefx-based poll-mode driver.
  92
  93 - ``CONFIG_RTE_LIBRTE_SFC_EFX_DEBUG`` (default **n**)
  94
  95   Enable compilation of the extra run-time consistency checks.
  96
  97
  98 Per-Device Parameters
  99 ~~~~~~~~~~~~~~~~~~~~~
 100
 101 The following per-device parameters can be passed via EAL PCI device
 102 whitelist option like "-w 02:00.0,arg1=value1,...".
 103
 104 Case-insensitive 1/y/yes/on or 0/n/no/off may be used to specify
 105 boolean parameters value.
 106
 107 - ``debug_init`` [bool] (default **n**)
 108
 109   Enable extra logging during device intialization and startup.