doc/guides/nics/bnx2x.rst

   1 ..  BSD LICENSE
   2     Copyright (c) 2015 QLogic Corporation
   3     All rights reserved.
   4
   5     Redistribution and use in source and binary forms, with or without
   6     modification, are permitted provided that the following conditions
   7     are met:
   8
   9     * Redistributions of source code must retain the above copyright
  10     notice, this list of conditions and the following disclaimer.
  11     * Redistributions in binary form must reproduce the above copyright
  12     notice, this list of conditions and the following disclaimer in
  13     the documentation and/or other materials provided with the
  14     distribution.
  15     * Neither the name of QLogic Corporation nor the names of its
  16     contributors may be used to endorse or promote products derived
  17     from this software without specific prior written permission.
  18
  19     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20     "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21     LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22     A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23     OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24     SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25     LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26     DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27     THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29     OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30
  31 BNX2X Poll Mode Driver
  32 ======================
  33
  34 The BNX2X poll mode driver library (**librte_pmd_bnx2x**) implements support
  35 for **QLogic 578xx** 10/20 Gbps family of adapters as well as their virtual
  36 functions (VF) in SR-IOV context. It is supported on several standard Linux
  37 distros like Red Hat 7.x and SLES12 OS. It is compile-tested under FreeBSD OS.
  38
  39 More information can be found at `QLogic Corporation's Official Website
  40 <http://www.qlogic.com>`_.
  41
  42 Supported Features
  43 ------------------
  44
  45 BNX2X PMD has support for:
  46
  47 - Base L2 features
  48 - Unicast/multicast filtering
  49 - Promiscuous mode
  50 - Port hardware statistics
  51 - SR-IOV VF
  52
  53 Non-supported Features
  54 ----------------------
  55
  56 The features not yet supported include:
  57
  58 - TSS (Transmit Side Scaling)
  59 - RSS (Receive Side Scaling)
  60 - LRO/TSO offload
  61 - Checksum offload
  62 - SR-IOV PF
  63 - Rx TX scatter gather
  64
  65 Co-existence considerations
  66 ---------------------------
  67
  68 - BCM578xx being a CNA can have both NIC and Storage personalities.
  69   However, coexistence with storage protocol drivers (cnic, bnx2fc and
  70   bnx2fi) is not supported on the same adapter. So storage personality
  71   has to be disabled on that adapter when used in DPDK applications.
  72
  73 - For SR-IOV case, bnx2x PMD will be used to bind to SR-IOV VF device and
  74   Linux native kernel driver (bnx2x) will be attached to SR-IOV PF.
  75
  76
  77 Supported QLogic NICs
  78 ---------------------
  79
  80 - 578xx
  81
  82 Prerequisites
  83 -------------
  84
  85 - Requires firmware version **7.2.51.0**. It is included in most of the
  86   standard Linux distros. If it is not available visit
  87   `linux-firmware git repository <https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/plain/bnx2x/bnx2x-e2-7.2.51.0.fw>`_
  88   to get the required firmware.
  89
  90 Pre-Installation Configuration
  91 ------------------------------
  92
  93 Config File Options
  94 ~~~~~~~~~~~~~~~~~~~
  95
  96 The following options can be modified in the ``.config`` file. Please note that
  97 enabling debugging options may affect system performance.
  98
  99 - ``CONFIG_RTE_LIBRTE_BNX2X_PMD`` (default **n**)
 100
 101   Toggle compilation of bnx2x driver. To use bnx2x PMD set this config parameter
 102   to 'y'. Also, in order for firmware binary to load user will need zlib devel
 103   package installed.
 104
 105 - ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_TX`` (default **n**)
 106
 107   Toggle display of transmit fast path run-time messages.
 108
 109 - ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_RX`` (default **n**)
 110
 111   Toggle display of receive fast path run-time messages.
 112
 113 - ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_PERIODIC`` (default **n**)
 114
 115   Toggle display of register reads and writes.
 116
 117
 118 .. _bnx2x_driver-compilation:
 119
 120 Driver compilation and testing
 121 ------------------------------
 122
 123 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
 124 for details.
 125
 126 SR-IOV: Prerequisites and sample Application Notes
 127 --------------------------------------------------
 128
 129 This section provides instructions to configure SR-IOV with Linux OS.
 130
 131 #. Verify SR-IOV and ARI capabilities are enabled on the adapter using ``lspci``:
 132
 133    .. code-block:: console
 134
 135       lspci -s <slot> -vvv
 136
 137    Example output:
 138
 139    .. code-block:: console
 140
 141       [...]
 142       Capabilities: [1b8 v1] Alternative Routing-ID Interpretation (ARI)
 143       [...]
 144       Capabilities: [1c0 v1] Single Root I/O Virtualization (SR-IOV)
 145       [...]
 146       Kernel driver in use: igb_uio
 147
 148 #. Load the kernel module:
 149
 150    .. code-block:: console
 151
 152       modprobe bnx2x
 153
 154    Example output:
 155
 156    .. code-block:: console
 157
 158       systemd-udevd[4848]: renamed network interface eth0 to ens5f0
 159       systemd-udevd[4848]: renamed network interface eth1 to ens5f1
 160
 161 #. Bring up the PF ports:
 162
 163    .. code-block:: console
 164
 165       ifconfig ens5f0 up
 166       ifconfig ens5f1 up
 167
 168 #. Create VF device(s):
 169
 170    Echo the number of VFs to be created into "sriov_numvfs" sysfs entry
 171    of the parent PF.
 172
 173    Example output:
 174
 175    .. code-block:: console
 176
 177       echo 2 > /sys/devices/pci0000:00/0000:00:03.0/0000:81:00.0/sriov_numvfs
 178
 179 #. Assign VF MAC address:
 180
 181    Assign MAC address to the VF using iproute2 utility. The syntax is:
 182    ip link set <PF iface> vf <VF id> mac <macaddr>
 183
 184    Example output:
 185
 186    .. code-block:: console
 187
 188       ip link set ens5f0 vf 0 mac 52:54:00:2f:9d:e8
 189
 190 #. PCI Passthrough:
 191
 192    The VF devices may be passed through to the guest VM using virt-manager or
 193    virsh etc. bnx2x PMD should be used to bind the VF devices in the guest VM
 194    using the instructions outlined in the Application notes below.
 195
 196 #. Running testpmd:
 197
 198    Follow instructions available in the document
 199    :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
 200    to run testpmd.
 201
 202    Example output:
 203
 204    .. code-block:: console
 205
 206       [...]
 207       EAL: PCI device 0000:84:00.0 on NUMA socket 1
 208       EAL:   probe driver: 14e4:168e rte_bnx2x_pmd
 209       EAL:   PCI memory mapped at 0x7f14f6fe5000
 210       EAL:   PCI memory mapped at 0x7f14f67e5000
 211       EAL:   PCI memory mapped at 0x7f15fbd9b000
 212       EAL: PCI device 0000:84:00.1 on NUMA socket 1
 213       EAL:   probe driver: 14e4:168e rte_bnx2x_pmd
 214       EAL:   PCI memory mapped at 0x7f14f5fe5000
 215       EAL:   PCI memory mapped at 0x7f14f57e5000
 216       EAL:   PCI memory mapped at 0x7f15fbd4f000
 217       Interactive-mode selected
 218       Configuring Port 0 (socket 0)
 219       PMD: bnx2x_dev_tx_queue_setup(): fp[00] req_bd=512, thresh=512,
 220                    usable_bd=1020, total_bd=1024,
 221                                 tx_pages=4
 222       PMD: bnx2x_dev_rx_queue_setup(): fp[00] req_bd=128, thresh=0,
 223                    usable_bd=510, total_bd=512,
 224                                 rx_pages=1, cq_pages=8
 225       PMD: bnx2x_print_adapter_info():
 226       [...]
 227       Checking link statuses...
 228       Port 0 Link Up - speed 10000 Mbps - full-duplex
 229       Port 1 Link Up - speed 10000 Mbps - full-duplex
 230       Done
 231       testpmd>