2 Copyright (c) 2015 QLogic Corporation
5 Redistribution and use in source and binary forms, with or without
6 modification, are permitted provided that the following conditions
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
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.
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.
31 BNX2X Poll Mode Driver
32 ======================
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.
39 More information can be found at `QLogic Corporation's Official Website
40 <http://www.qlogic.com>`_.
45 BNX2X PMD has support for:
48 - Unicast/multicast filtering
50 - Port hardware statistics
53 Non-supported Features
54 ----------------------
56 The features not yet supported include:
58 - TSS (Transmit Side Scaling)
59 - RSS (Receive Side Scaling)
63 - Rx TX scatter gather
65 Co-existence considerations
66 ---------------------------
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.
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.
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 `QLogic Driver Download Center <http://driverdownloads.qlogic.com>`_
88 to get the required firmware.
90 Pre-Installation Configuration
91 ------------------------------
96 The following options can be modified in the ``.config`` file. Please note that
97 enabling debugging options may affect system performance.
99 - ``CONFIG_RTE_LIBRTE_BNX2X_PMD`` (default **y**)
101 Toggle compilation of bnx2x driver.
103 - ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG`` (default **n**)
105 Toggle display of generic debugging messages.
107 - ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_INIT`` (default **n**)
109 Toggle display of initialization related messages.
111 - ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_TX`` (default **n**)
113 Toggle display of transmit fast path run-time messages.
115 - ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_RX`` (default **n**)
117 Toggle display of receive fast path run-time messages.
119 - ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_PERIODIC`` (default **n**)
121 Toggle display of register reads and writes.
124 .. _bnx2x_driver-compilation:
126 Driver compilation and testing
127 ------------------------------
129 Refer to the document :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
132 SR-IOV: Prerequisites and sample Application Notes
133 --------------------------------------------------
135 This section provides instructions to configure SR-IOV with Linux OS.
137 #. Verify SR-IOV and ARI capabilities are enabled on the adapter using ``lspci``:
139 .. code-block:: console
145 .. code-block:: console
148 Capabilities: [1b8 v1] Alternative Routing-ID Interpretation (ARI)
150 Capabilities: [1c0 v1] Single Root I/O Virtualization (SR-IOV)
152 Kernel driver in use: igb_uio
154 #. Load the kernel module:
156 .. code-block:: console
162 .. code-block:: console
164 systemd-udevd[4848]: renamed network interface eth0 to ens5f0
165 systemd-udevd[4848]: renamed network interface eth1 to ens5f1
167 #. Bring up the PF ports:
169 .. code-block:: console
174 #. Create VF device(s):
176 Echo the number of VFs to be created into "sriov_numvfs" sysfs entry
181 .. code-block:: console
183 echo 2 > /sys/devices/pci0000:00/0000:00:03.0/0000:81:00.0/sriov_numvfs
185 #. Assign VF MAC address:
187 Assign MAC address to the VF using iproute2 utility. The syntax is:
188 ip link set <PF iface> vf <VF id> mac <macaddr>
192 .. code-block:: console
194 ip link set ens5f0 vf 0 mac 52:54:00:2f:9d:e8
198 The VF devices may be passed through to the guest VM using virt-manager or
199 virsh etc. bnx2x PMD should be used to bind the VF devices in the guest VM
200 using the instructions outlined in the Application notes below.
204 Follow instructions available in the document
205 :ref:`compiling and testing a PMD for a NIC <pmd_build_and_test>`
210 .. code-block:: console
213 EAL: PCI device 0000:84:00.0 on NUMA socket 1
214 EAL: probe driver: 14e4:168e rte_bnx2x_pmd
215 EAL: PCI memory mapped at 0x7f14f6fe5000
216 EAL: PCI memory mapped at 0x7f14f67e5000
217 EAL: PCI memory mapped at 0x7f15fbd9b000
218 EAL: PCI device 0000:84:00.1 on NUMA socket 1
219 EAL: probe driver: 14e4:168e rte_bnx2x_pmd
220 EAL: PCI memory mapped at 0x7f14f5fe5000
221 EAL: PCI memory mapped at 0x7f14f57e5000
222 EAL: PCI memory mapped at 0x7f15fbd4f000
223 Interactive-mode selected
224 Configuring Port 0 (socket 0)
225 PMD: bnx2x_dev_tx_queue_setup(): fp[00] req_bd=512, thresh=512,
226 usable_bd=1020, total_bd=1024,
228 PMD: bnx2x_dev_rx_queue_setup(): fp[00] req_bd=128, thresh=0,
229 usable_bd=510, total_bd=512,
230 rx_pages=1, cq_pages=8
231 PMD: bnx2x_print_adapter_info():
233 Checking link statuses...
234 Port 0 Link Up - speed 10000 Mbps - full-duplex
235 Port 1 Link Up - speed 10000 Mbps - full-duplex