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 Options
  79 ~~~~~~~~~~~~~~
  80
  81 The following options can be enabled with Meson flags. Please note that
  82 enabling debugging options may affect system performance.
  83
  84 - ``RTE_LIBRTE_BNX2X_DEBUG_TX`` (default **disabled**)
  85
  86   Toggle display of transmit fast path run-time messages.
  87
  88 - ``RTE_LIBRTE_BNX2X_DEBUG_RX`` (default **disabled**)
  89
  90   Toggle display of receive fast path run-time messages.
  91
  92 - ``RTE_LIBRTE_BNX2X_DEBUG_PERIODIC`` (default **disabled**)
  93
  94   Toggle display of register reads and writes.
  95
  96 .. _bnx2x_driver-compilation:
  97
  98 Driver compilation and testing
  99 ------------------------------
 100
 101 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
 102 for details.
 103
 104 Jumbo: Limitation
 105 -----------------
 106
 107 Rx descriptor limit for number of segments per MTU is set to 1.
 108 PMD doesn't support Jumbo Rx scatter gather. Some applciations can
 109 adjust mbuf_size based on this param and max_pkt_len.
 110
 111 For others, PMD detects the condition where Rx packet length cannot
 112 be held by configured mbuf size and logs the message.
 113
 114 Example output:
 115
 116    .. code-block:: console
 117
 118       [...]
 119       [bnx2x_recv_pkts:397(04:00.0:dpdk-port-0)] mbuf size 2048 is not enough to hold Rx packet length more than 2046
 120
 121 SR-IOV: Prerequisites and sample Application Notes
 122 --------------------------------------------------
 123
 124 This section provides instructions to configure SR-IOV with Linux OS.
 125
 126 #. Verify SR-IOV and ARI capabilities are enabled on the adapter using ``lspci``:
 127
 128    .. code-block:: console
 129
 130       lspci -s <slot> -vvv
 131
 132    Example output:
 133
 134    .. code-block:: console
 135
 136       [...]
 137       Capabilities: [1b8 v1] Alternative Routing-ID Interpretation (ARI)
 138       [...]
 139       Capabilities: [1c0 v1] Single Root I/O Virtualization (SR-IOV)
 140       [...]
 141       Kernel driver in use: igb_uio
 142
 143 #. Load the kernel module:
 144
 145    .. code-block:: console
 146
 147       modprobe bnx2x
 148
 149    Example output:
 150
 151    .. code-block:: console
 152
 153       systemd-udevd[4848]: renamed network interface eth0 to ens5f0
 154       systemd-udevd[4848]: renamed network interface eth1 to ens5f1
 155
 156 #. Bring up the PF ports:
 157
 158    .. code-block:: console
 159
 160       ifconfig ens5f0 up
 161       ifconfig ens5f1 up
 162
 163 #. Create VF device(s):
 164
 165    Echo the number of VFs to be created into "sriov_numvfs" sysfs entry
 166    of the parent PF.
 167
 168    Example output:
 169
 170    .. code-block:: console
 171
 172       echo 2 > /sys/devices/pci0000:00/0000:00:03.0/0000:81:00.0/sriov_numvfs
 173
 174 #. Assign VF MAC address:
 175
 176    Assign MAC address to the VF using iproute2 utility. The syntax is:
 177    ip link set <PF iface> vf <VF id> mac <macaddr>
 178
 179    Example output:
 180
 181    .. code-block:: console
 182
 183       ip link set ens5f0 vf 0 mac 52:54:00:2f:9d:e8
 184
 185 #. PCI Passthrough:
 186
 187    The VF devices may be passed through to the guest VM using virt-manager or
 188    virsh etc. bnx2x PMD should be used to bind the VF devices in the guest VM
 189    using the instructions outlined in the Application notes below.
 190
 191 #. Running testpmd:
 192    (Supply ``--log-level="pmd.net.bnx2x.driver",7`` to view informational messages):
 193
 194    Follow instructions available in the document
 195    :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
 196    to run testpmd.
 197
 198    Example output:
 199
 200    .. code-block:: console
 201
 202       [...]
 203       EAL: PCI device 0000:84:00.0 on NUMA socket 1
 204       EAL:   probe driver: 14e4:168e rte_bnx2x_pmd
 205       EAL:   PCI memory mapped at 0x7f14f6fe5000
 206       EAL:   PCI memory mapped at 0x7f14f67e5000
 207       EAL:   PCI memory mapped at 0x7f15fbd9b000
 208       EAL: PCI device 0000:84:00.1 on NUMA socket 1
 209       EAL:   probe driver: 14e4:168e rte_bnx2x_pmd
 210       EAL:   PCI memory mapped at 0x7f14f5fe5000
 211       EAL:   PCI memory mapped at 0x7f14f57e5000
 212       EAL:   PCI memory mapped at 0x7f15fbd4f000
 213       Interactive-mode selected
 214       Configuring Port 0 (socket 0)
 215       PMD: bnx2x_dev_tx_queue_setup(): fp[00] req_bd=512, thresh=512,
 216                    usable_bd=1020, total_bd=1024,
 217                                 tx_pages=4
 218       PMD: bnx2x_dev_rx_queue_setup(): fp[00] req_bd=128, thresh=0,
 219                    usable_bd=510, total_bd=512,
 220                                 rx_pages=1, cq_pages=8
 221       PMD: bnx2x_print_adapter_info():
 222       [...]
 223       Checking link statuses...
 224       Port 0 Link Up - speed 10000 Mbps - full-duplex
 225       Port 1 Link Up - speed 10000 Mbps - full-duplex
 226       Done
 227       testpmd>