1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright (c) 2015 QLogic Corporation
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.
12 More information can be found at `QLogic Corporation's Official Website
13 <http://www.qlogic.com>`_.
18 BNX2X PMD has support for:
21 - Unicast/multicast filtering
23 - Port hardware statistics
26 Non-supported Features
27 ----------------------
29 The features not yet supported include:
31 - TSS (Transmit Side Scaling)
32 - RSS (Receive Side Scaling)
36 - Rx TX scatter gather
38 Co-existence considerations
39 ---------------------------
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.
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
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.
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.
70 - Requires firmware version **7.2.51.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.2.51.0.fw>`_
73 to get the required firmware.
75 Pre-Installation Configuration
76 ------------------------------
81 The following options can be modified in the ``.config`` file. Please note that
82 enabling debugging options may affect system performance.
84 - ``CONFIG_RTE_LIBRTE_BNX2X_PMD`` (default **n**)
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
90 - ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_TX`` (default **n**)
92 Toggle display of transmit fast path run-time messages.
94 - ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_RX`` (default **n**)
96 Toggle display of receive fast path run-time messages.
98 - ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_PERIODIC`` (default **n**)
100 Toggle display of register reads and writes.
103 .. _bnx2x_driver-compilation:
105 Driver compilation and testing
106 ------------------------------
108 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
111 SR-IOV: Prerequisites and sample Application Notes
112 --------------------------------------------------
114 This section provides instructions to configure SR-IOV with Linux OS.
116 #. Verify SR-IOV and ARI capabilities are enabled on the adapter using ``lspci``:
118 .. code-block:: console
124 .. code-block:: console
127 Capabilities: [1b8 v1] Alternative Routing-ID Interpretation (ARI)
129 Capabilities: [1c0 v1] Single Root I/O Virtualization (SR-IOV)
131 Kernel driver in use: igb_uio
133 #. Load the kernel module:
135 .. code-block:: console
141 .. code-block:: console
143 systemd-udevd[4848]: renamed network interface eth0 to ens5f0
144 systemd-udevd[4848]: renamed network interface eth1 to ens5f1
146 #. Bring up the PF ports:
148 .. code-block:: console
153 #. Create VF device(s):
155 Echo the number of VFs to be created into "sriov_numvfs" sysfs entry
160 .. code-block:: console
162 echo 2 > /sys/devices/pci0000:00/0000:00:03.0/0000:81:00.0/sriov_numvfs
164 #. Assign VF MAC address:
166 Assign MAC address to the VF using iproute2 utility. The syntax is:
167 ip link set <PF iface> vf <VF id> mac <macaddr>
171 .. code-block:: console
173 ip link set ens5f0 vf 0 mac 52:54:00:2f:9d:e8
177 The VF devices may be passed through to the guest VM using virt-manager or
178 virsh etc. bnx2x PMD should be used to bind the VF devices in the guest VM
179 using the instructions outlined in the Application notes below.
182 (Supply ``--log-level="pmd.net.bnx2x.driver",7`` to view informational messages):
184 Follow instructions available in the document
185 :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
190 .. code-block:: console
193 EAL: PCI device 0000:84:00.0 on NUMA socket 1
194 EAL: probe driver: 14e4:168e rte_bnx2x_pmd
195 EAL: PCI memory mapped at 0x7f14f6fe5000
196 EAL: PCI memory mapped at 0x7f14f67e5000
197 EAL: PCI memory mapped at 0x7f15fbd9b000
198 EAL: PCI device 0000:84:00.1 on NUMA socket 1
199 EAL: probe driver: 14e4:168e rte_bnx2x_pmd
200 EAL: PCI memory mapped at 0x7f14f5fe5000
201 EAL: PCI memory mapped at 0x7f14f57e5000
202 EAL: PCI memory mapped at 0x7f15fbd4f000
203 Interactive-mode selected
204 Configuring Port 0 (socket 0)
205 PMD: bnx2x_dev_tx_queue_setup(): fp[00] req_bd=512, thresh=512,
206 usable_bd=1020, total_bd=1024,
208 PMD: bnx2x_dev_rx_queue_setup(): fp[00] req_bd=128, thresh=0,
209 usable_bd=510, total_bd=512,
210 rx_pages=1, cq_pages=8
211 PMD: bnx2x_print_adapter_info():
213 Checking link statuses...
214 Port 0 Link Up - speed 10000 Mbps - full-duplex
215 Port 1 Link Up - speed 10000 Mbps - full-duplex