doc/guides/nics/bnx2x.rst

   1 ..  SPDX-License-Identifier: BSD-3-Clause
   2     Copyright (c) 2015 QLogic Corporation
   3
   4 BNX2X Poll Mode Driver
   5 ======================
   6
   7 The BNX2X poll mode driver library (**librte_pmd_bnx2x**) implements support
   8 for **QLogic 578xx** 10/20 Gbps family of adapters as well as their virtual
   9 functions (VF) in SR-IOV context. It is supported on several standard Linux
  10 distros like RHEL and SLES. It is compile-tested under FreeBSD OS.
  11
  12 More information can be found at `QLogic Corporation's Official Website
  13 <http://www.qlogic.com>`_.
  14
  15 Supported Features
  16 ------------------
  17
  18 BNX2X PMD has support for:
  19
  20 - Base L2 features
  21 - Unicast/multicast filtering
  22 - Promiscuous mode
  23 - Port hardware statistics
  24 - SR-IOV VF
  25
  26 Non-supported Features
  27 ----------------------
  28
  29 The features not yet supported include:
  30
  31 - TSS (Transmit Side Scaling)
  32 - RSS (Receive Side Scaling)
  33 - LRO/TSO offload
  34 - Checksum offload
  35 - SR-IOV PF
  36 - Rx TX scatter gather
  37
  38 Co-existence considerations
  39 ---------------------------
  40
  41 - QLogic 578xx CNAs support Ethernet, iSCSI and FCoE functionalities.
  42   These functionalities are supported using QLogic Linux kernel
  43   drivers bnx2x, cnic, bnx2i and bnx2fc. DPDK is supported on these
  44   adapters using bnx2x PMD.
  45
  46 - When SR-IOV is not enabled on the adapter,
  47   QLogic Linux kernel drivers (bnx2x, cnic, bnx2i and bnx2fc) and bnx2x
  48   PMD can’t be attached to different PFs on a given QLogic 578xx
  49   adapter.
  50   A given adapter needs to be completely used by DPDK or Linux drivers.
  51   Before binding DPDK driver to one or more PFs on the adapter,
  52   please make sure to unbind Linux drivers from all PFs of the adapter.
  53   If there are multiple adapters on the system, one or more adapters
  54   can be used by DPDK driver completely and other adapters can be used
  55   by Linux drivers completely.
  56
  57 - When SR-IOV is enabled on the adapter,
  58   Linux kernel drivers (bnx2x, cnic, bnx2i and bnx2fc) can be bound
  59   to the PFs of a given adapter and either bnx2x PMD or Linux drivers
  60   bnx2x can be bound to the VFs of the adapter.
  61
  62 Supported QLogic NICs
  63 ---------------------
  64
  65 - 578xx
  66
  67 Prerequisites
  68 -------------
  69
  70 - Requires firmware version **7.13.11.0**. It is included in most of the
  71   standard Linux distros. If it is not available visit
  72   `linux-firmware git repository <https://git.kernel.org/pub/scm/linux/kernel/git/firmware/linux-firmware.git/plain/bnx2x/bnx2x-e2-7.13.11.0.fw>`_
  73   to get the required firmware.
  74
  75 Pre-Installation Configuration
  76 ------------------------------
  77
  78 Config File Options
  79 ~~~~~~~~~~~~~~~~~~~
  80
  81 The following options can be modified in the ``.config`` file. Please note that
  82 enabling debugging options may affect system performance.
  83
  84 - ``CONFIG_RTE_LIBRTE_BNX2X_PMD`` (default **n**)
  85
  86   Toggle compilation of bnx2x driver. To use bnx2x PMD set this config parameter
  87   to 'y'. Also, in order for firmware binary to load user will need zlib devel
  88   package installed.
  89
  90 - ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_TX`` (default **n**)
  91
  92   Toggle display of transmit fast path run-time messages.
  93
  94 - ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_RX`` (default **n**)
  95
  96   Toggle display of receive fast path run-time messages.
  97
  98 - ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_PERIODIC`` (default **n**)
  99
 100   Toggle display of register reads and writes.
 101
 102
 103 .. _bnx2x_driver-compilation:
 104
 105 Driver compilation and testing
 106 ------------------------------
 107
 108 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
 109 for details.
 110
 111 Jumbo: Limitation
 112 -----------------
 113
 114 Rx descriptor limit for number of segments per MTU is set to 1.
 115 PMD doesn't support Jumbo Rx scatter gather. Some applciations can
 116 adjust mbuf_size based on this param and max_pkt_len.
 117
 118 For others, PMD detects the condition where Rx packet length cannot
 119 be held by configured mbuf size and logs the message.
 120
 121 Example output:
 122
 123    .. code-block:: console
 124
 125       [...]
 126       [bnx2x_recv_pkts:397(04:00.0:dpdk-port-0)] mbuf size 2048 is not enough to hold Rx packet length more than 2046
 127
 128 SR-IOV: Prerequisites and sample Application Notes
 129 --------------------------------------------------
 130
 131 This section provides instructions to configure SR-IOV with Linux OS.
 132
 133 #. Verify SR-IOV and ARI capabilities are enabled on the adapter using ``lspci``:
 134
 135    .. code-block:: console
 136
 137       lspci -s <slot> -vvv
 138
 139    Example output:
 140
 141    .. code-block:: console
 142
 143       [...]
 144       Capabilities: [1b8 v1] Alternative Routing-ID Interpretation (ARI)
 145       [...]
 146       Capabilities: [1c0 v1] Single Root I/O Virtualization (SR-IOV)
 147       [...]
 148       Kernel driver in use: igb_uio
 149
 150 #. Load the kernel module:
 151
 152    .. code-block:: console
 153
 154       modprobe bnx2x
 155
 156    Example output:
 157
 158    .. code-block:: console
 159
 160       systemd-udevd[4848]: renamed network interface eth0 to ens5f0
 161       systemd-udevd[4848]: renamed network interface eth1 to ens5f1
 162
 163 #. Bring up the PF ports:
 164
 165    .. code-block:: console
 166
 167       ifconfig ens5f0 up
 168       ifconfig ens5f1 up
 169
 170 #. Create VF device(s):
 171
 172    Echo the number of VFs to be created into "sriov_numvfs" sysfs entry
 173    of the parent PF.
 174
 175    Example output:
 176
 177    .. code-block:: console
 178
 179       echo 2 > /sys/devices/pci0000:00/0000:00:03.0/0000:81:00.0/sriov_numvfs
 180
 181 #. Assign VF MAC address:
 182
 183    Assign MAC address to the VF using iproute2 utility. The syntax is:
 184    ip link set <PF iface> vf <VF id> mac <macaddr>
 185
 186    Example output:
 187
 188    .. code-block:: console
 189
 190       ip link set ens5f0 vf 0 mac 52:54:00:2f:9d:e8
 191
 192 #. PCI Passthrough:
 193
 194    The VF devices may be passed through to the guest VM using virt-manager or
 195    virsh etc. bnx2x PMD should be used to bind the VF devices in the guest VM
 196    using the instructions outlined in the Application notes below.
 197
 198 #. Running testpmd:
 199    (Supply ``--log-level="pmd.net.bnx2x.driver",7`` to view informational messages):
 200
 201    Follow instructions available in the document
 202    :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
 203    to run testpmd.
 204
 205    Example output:
 206
 207    .. code-block:: console
 208
 209       [...]
 210       EAL: PCI device 0000:84:00.0 on NUMA socket 1
 211       EAL:   probe driver: 14e4:168e rte_bnx2x_pmd
 212       EAL:   PCI memory mapped at 0x7f14f6fe5000
 213       EAL:   PCI memory mapped at 0x7f14f67e5000
 214       EAL:   PCI memory mapped at 0x7f15fbd9b000
 215       EAL: PCI device 0000:84:00.1 on NUMA socket 1
 216       EAL:   probe driver: 14e4:168e rte_bnx2x_pmd
 217       EAL:   PCI memory mapped at 0x7f14f5fe5000
 218       EAL:   PCI memory mapped at 0x7f14f57e5000
 219       EAL:   PCI memory mapped at 0x7f15fbd4f000
 220       Interactive-mode selected
 221       Configuring Port 0 (socket 0)
 222       PMD: bnx2x_dev_tx_queue_setup(): fp[00] req_bd=512, thresh=512,
 223                    usable_bd=1020, total_bd=1024,
 224                                 tx_pages=4
 225       PMD: bnx2x_dev_rx_queue_setup(): fp[00] req_bd=128, thresh=0,
 226                    usable_bd=510, total_bd=512,
 227                                 rx_pages=1, cq_pages=8
 228       PMD: bnx2x_print_adapter_info():
 229       [...]
 230       Checking link statuses...
 231       Port 0 Link Up - speed 10000 Mbps - full-duplex
 232       Port 1 Link Up - speed 10000 Mbps - full-duplex
 233       Done
 234       testpmd>