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:
129 BNX2X PMD for Linux x86_64 gcc target, run the following "make"
132 cd <DPDK-source-directory>
133 make config T=x86_64-native-linuxapp-gcc install
135 To compile BNX2X PMD for Linux x86_64 clang target, run the following "make"
138 cd <DPDK-source-directory>
139 make config T=x86_64-native-linuxapp-clang install
141 To compile BNX2X PMD for Linux i686 gcc target, run the following "make"
144 cd <DPDK-source-directory>
145 make config T=i686-native-linuxapp-gcc install
147 To compile BNX2X PMD for Linux i686 gcc target, run the following "make"
150 .. code-block:: console
152 cd <DPDK-source-directory>
153 make config T=i686-native-linuxapp-gcc install
155 To compile BNX2X PMD for FreeBSD x86_64 clang target, run the following "gmake"
158 cd <DPDK-source-directory>
159 gmake config T=x86_64-native-bsdapp-clang install
161 To compile BNX2X PMD for FreeBSD x86_64 gcc target, run the following "gmake"
164 cd <DPDK-source-directory>
165 gmake config T=x86_64-native-bsdapp-gcc install -Wl,-rpath=/usr/local/lib/gcc49 CC=gcc49
167 To compile BNX2X PMD for FreeBSD x86_64 gcc target, run the following "gmake"
170 .. code-block:: console
172 cd <DPDK-source-directory>
173 gmake config T=x86_64-native-bsdapp-gcc install -Wl,-rpath=/usr/local/lib/gcc49 CC=gcc49
178 .. _bnx2x_Linux-installation:
183 Sample Application Notes
184 ~~~~~~~~~~~~~~~~~~~~~~~~
186 This section demonstrates how to launch ``testpmd`` with QLogic 578xx
187 devices managed by ``librte_pmd_bnx2x`` in Linux operating system.
189 #. Request huge pages:
191 .. code-block:: console
193 echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/nr_hugepages
195 #. Load ``igb_uio`` or ``vfio-pci`` driver:
197 .. code-block:: console
199 insmod ./x86_64-native-linuxapp-gcc/kmod/igb_uio.ko
203 .. code-block:: console
207 #. Bind the QLogic adapters to ``igb_uio`` or ``vfio-pci`` loaded in the
210 ./usertools/dpdk-devbind.py --bind igb_uio 0000:84:00.0 0000:84:00.1
214 Setup VFIO permissions for regular users and then bind to ``vfio-pci``:
216 .. code-block:: console
218 sudo chmod a+x /dev/vfio
220 sudo chmod 0666 /dev/vfio/*
222 ./usertools/dpdk-devbind.py --bind vfio-pci 0000:84:00.0 0000:84:00.1
224 #. Start ``testpmd`` with basic parameters:
226 .. code-block:: console
228 ./x86_64-native-linuxapp-gcc/app/testpmd -c 0xf -n 4 -- -i
232 .. code-block:: console
235 EAL: PCI device 0000:84:00.0 on NUMA socket 1
236 EAL: probe driver: 14e4:168e rte_bnx2x_pmd
237 EAL: PCI memory mapped at 0x7f14f6fe5000
238 EAL: PCI memory mapped at 0x7f14f67e5000
239 EAL: PCI memory mapped at 0x7f15fbd9b000
240 EAL: PCI device 0000:84:00.1 on NUMA socket 1
241 EAL: probe driver: 14e4:168e rte_bnx2x_pmd
242 EAL: PCI memory mapped at 0x7f14f5fe5000
243 EAL: PCI memory mapped at 0x7f14f57e5000
244 EAL: PCI memory mapped at 0x7f15fbd4f000
245 Interactive-mode selected
246 Configuring Port 0 (socket 0)
247 PMD: bnx2x_dev_tx_queue_setup(): fp[00] req_bd=512, thresh=512,
248 usable_bd=1020, total_bd=1024,
250 PMD: bnx2x_dev_rx_queue_setup(): fp[00] req_bd=128, thresh=0,
251 usable_bd=510, total_bd=512,
252 rx_pages=1, cq_pages=8
253 PMD: bnx2x_print_adapter_info():
255 Checking link statuses...
256 Port 0 Link Up - speed 10000 Mbps - full-duplex
257 Port 1 Link Up - speed 10000 Mbps - full-duplex
261 SR-IOV: Prerequisites and sample Application Notes
262 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
264 This section provides instructions to configure SR-IOV with Linux OS.
266 #. Verify SR-IOV and ARI capabilities are enabled on the adapter using ``lspci``:
268 .. code-block:: console
274 .. code-block:: console
277 Capabilities: [1b8 v1] Alternative Routing-ID Interpretation (ARI)
279 Capabilities: [1c0 v1] Single Root I/O Virtualization (SR-IOV)
281 Kernel driver in use: igb_uio
283 #. Load the kernel module:
285 .. code-block:: console
291 .. code-block:: console
293 systemd-udevd[4848]: renamed network interface eth0 to ens5f0
294 systemd-udevd[4848]: renamed network interface eth1 to ens5f1
296 #. Bring up the PF ports:
298 .. code-block:: console
303 #. Create VF device(s):
305 Echo the number of VFs to be created into "sriov_numvfs" sysfs entry
310 .. code-block:: console
312 echo 2 > /sys/devices/pci0000:00/0000:00:03.0/0000:81:00.0/sriov_numvfs
315 #. Assign VF MAC address:
317 Assign MAC address to the VF using iproute2 utility. The syntax is:
318 ip link set <PF iface> vf <VF id> mac <macaddr>
322 .. code-block:: console
324 ip link set ens5f0 vf 0 mac 52:54:00:2f:9d:e8
329 The VF devices may be passed through to the guest VM using virt-manager or
330 virsh etc. bnx2x PMD should be used to bind the VF devices in the guest VM
331 using the instructions outlined in the Application notes below.