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)
64 Co-existence considerations
65 ---------------------------
67 - BCM578xx being a CNA can have both NIC and Storage personalities.
68 However, coexistence with storage protocol drivers (cnic, bnx2fc and
69 bnx2fi) is not supported on the same adapter. So storage personality
70 has to be disabled on that adapter when used in DPDK applications.
72 - For SR-IOV case, bnx2x PMD will be used to bind to SR-IOV VF device and
73 Linux native kernel driver (bnx2x) will be attached to SR-IOV PF.
84 - Requires firmware version **7.2.51.0**. It is inbox on most of the
85 standard Linux distros. If it is not available visit
86 `QLogic Driver Download Center <http://driverdownloads.qlogic.com>`_
87 to get the required firmware.
89 Pre-Installation Configuration
90 ------------------------------
95 The following options can be modified in the ``.config`` file. Please note that
96 enabling debugging options may affect system performance.
98 - ``CONFIG_RTE_LIBRTE_BNX2X_PMD`` (default **y**)
100 Toggle compilation of bnx2x driver.
102 - ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG`` (default **n**)
104 Toggle display of generic debugging messages.
106 - ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_INIT`` (default **n**)
108 Toggle display of initialization related messages.
110 - ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_TX`` (default **n**)
112 Toggle display of transmit fast path run-time messages.
114 - ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_RX`` (default **n**)
116 Toggle display of receive fast path run-time messages.
118 - ``CONFIG_RTE_LIBRTE_BNX2X_DEBUG_PERIODIC`` (default **n**)
120 Toggle display of register reads and writes.
123 .. _bnx2x_driver-compilation:
128 BNX2X PMD for Linux x86_64 gcc target, run the following "make"
131 cd <DPDK-source-directory>
132 make config T=x86_64-native-linuxapp-gcc install
134 To compile BNX2X PMD for Linux x86_64 clang target, run the following "make"
137 cd <DPDK-source-directory>
138 make config T=x86_64-native-linuxapp-clang install
140 To compile BNX2X PMD for Linux i686 gcc target, run the following "make"
143 cd <DPDK-source-directory>
144 make config T=i686-native-linuxapp-gcc install
146 To compile BNX2X PMD for FreeBSD x86_64 clang target, run the following "gmake"
149 cd <DPDK-source-directory>
150 gmake config T=x86_64-native-bsdapp-clang install
152 To compile BNX2X PMD for FreeBSD x86_64 gcc target, run the following "gmake"
155 cd <DPDK-source-directory>
156 gmake config T=x86_64-native-bsdapp-gcc install -Wl,-rpath=/usr/local/lib/gcc48 CC=gcc48
158 To compile BNX2X PMD for FreeBSD x86_64 gcc target, run the following "gmake"
161 .. code-block:: console
163 cd <DPDK-source-directory>
164 gmake config T=x86_64-native-bsdapp-gcc install -Wl,-rpath=/usr/local/lib/gcc48 CC=gcc48
169 .. _bnx2x_Linux-installation:
174 Sample Application Notes
175 ~~~~~~~~~~~~~~~~~~~~~~~~
177 This section demonstrates how to launch ``testpmd`` with QLogic 578xx
178 devices managed by ``librte_pmd_bnx2x`` in Linux operating system.
180 #. Request huge pages:
182 .. code-block:: console
184 echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
186 #. Load ``igb_uio`` or ``vfio-pci`` driver:
188 .. code-block:: console
190 insmod ./x86_64-native-linuxapp-gcc/kmod/igb_uio.ko
194 .. code-block:: console
198 #. Bind the QLogic adapters to ``igb_uio`` or ``vfio-pci`` loaded in the
201 ./tools/dpdk_nic_bind.py --bind igb_uio 0000:84:00.0 0000:84:00.1
205 Setup VFIO permissions for regular users and then bind to ``vfio-pci``:
207 .. code-block:: console
209 sudo chmod a+x /dev/vfio
211 sudo chmod 0666 /dev/vfio/*
213 ./tools/dpdk_nic_bind.py --bind vfio-pci 0000:84:00.0 0000:84:00.1
215 #. Start ``testpmd`` with basic parameters:
217 .. code-block:: console
219 ./x86_64-native-linuxapp-gcc/app/testpmd -c 0xf -n 4 -- -i
223 .. code-block:: console
226 EAL: PCI device 0000:84:00.0 on NUMA socket 1
227 EAL: probe driver: 14e4:168e rte_bnx2x_pmd
228 EAL: PCI memory mapped at 0x7f14f6fe5000
229 EAL: PCI memory mapped at 0x7f14f67e5000
230 EAL: PCI memory mapped at 0x7f15fbd9b000
231 EAL: PCI device 0000:84:00.1 on NUMA socket 1
232 EAL: probe driver: 14e4:168e rte_bnx2x_pmd
233 EAL: PCI memory mapped at 0x7f14f5fe5000
234 EAL: PCI memory mapped at 0x7f14f57e5000
235 EAL: PCI memory mapped at 0x7f15fbd4f000
236 Interactive-mode selected
237 Configuring Port 0 (socket 0)
238 PMD: bnx2x_dev_tx_queue_setup(): fp[00] req_bd=512, thresh=512,
239 usable_bd=1020, total_bd=1024,
241 PMD: bnx2x_dev_rx_queue_setup(): fp[00] req_bd=128, thresh=0,
242 usable_bd=510, total_bd=512,
243 rx_pages=1, cq_pages=8
244 PMD: bnx2x_print_adapter_info():
246 Checking link statuses...
247 Port 0 Link Up - speed 10000 Mbps - full-duplex
248 Port 1 Link Up - speed 10000 Mbps - full-duplex
252 SR-IOV: Prerequisites and sample Application Notes
253 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
255 This section provides instructions to configure SR-IOV with Linux OS.
257 #. Verify SR-IOV and ARI capabilities are enabled on the adapter using ``lspci``:
259 .. code-block:: console
265 .. code-block:: console
268 Capabilities: [1b8 v1] Alternative Routing-ID Interpretation (ARI)
270 Capabilities: [1c0 v1] Single Root I/O Virtualization (SR-IOV)
272 Kernel driver in use: igb_uio
274 #. Load the kernel module:
276 .. code-block:: console
282 .. code-block:: console
284 systemd-udevd[4848]: renamed network interface eth0 to ens5f0
285 systemd-udevd[4848]: renamed network interface eth1 to ens5f1
287 #. Bring up the PF ports:
289 .. code-block:: console
294 #. Create VF device(s):
296 Echo the number of VFs to be created into "sriov_numvfs" sysfs entry
301 .. code-block:: console
303 echo 2 > /sys/devices/pci0000:00/0000:00:03.0/0000:81:00.0/sriov_numvfs
306 #. Assign VF MAC address:
308 Assign MAC address to the VF using iproute2 ulility. The syntax is:
309 ip link set <PF iface> vf <VF id> mac <macaddr>
313 .. code-block:: console
315 ip link set ens5f0 vf 0 mac 52:54:00:2f:9d:e8
320 The VF devices may be passed through to the guest VM using virt-manager or
321 virsh etc. bnx2x PMD should be used to bind the VF devices in the guest VM
322 using the instructions outlined in the Application notes below.