2 Copyright (c) 2016 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.
32 ======================
34 The QEDE poll mode driver library (**librte_pmd_qede**) implements support
35 for **QLogic FastLinQ QL4xxxx 25G/40G/100G CNA** family of adapters as well
36 as their virtual functions (VF) in SR-IOV context. It is supported on
37 several standard Linux distros like RHEL7.x, SLES12.x and Ubuntu.
38 It is compile-tested under FreeBSD OS.
40 More information can be found at `QLogic Corporation's Website
41 <http://www.qlogic.com>`_.
46 - Unicast/Multicast filtering
49 - Port hardware statistics
51 - VLAN offload - Filtering and stripping
52 - Stateless checksum offloads (IPv4/TCP/UDP)
53 - Multiple Rx/Tx queues
54 - RSS (with RETA/hash table/key)
56 - Multiple MAC address
57 - Default pause flow control
63 Non-supported Features
64 ----------------------
69 Supported QLogic Adapters
70 -------------------------
72 - QLogic FastLinQ QL4xxxx 25G/40G/100G CNAs.
77 - Requires firmware version **8.10.x.** and management firmware
78 version **8.10.x or higher**. Firmware may be available
79 inbox in certain newer Linux distros under the standard directory
80 ``E.g. /lib/firmware/qed/qed_init_values-8.10.9.0.bin``
82 - If the required firmware files are not available then visit
83 `QLogic Driver Download Center <http://driverdownloads.qlogic.com>`_.
88 - For better performance, it is recommended to use 4K or higher RX/TX rings.
93 The following options can be modified in the ``.config`` file. Please note that
94 enabling debugging options may affect system performance.
96 - ``CONFIG_RTE_LIBRTE_QEDE_PMD`` (default **y**)
98 Toggle compilation of QEDE PMD driver.
100 - ``CONFIG_RTE_LIBRTE_QEDE_DEBUG_INFO`` (default **n**)
102 Toggle display of generic debugging messages.
104 - ``CONFIG_RTE_LIBRTE_QEDE_DEBUG_DRIVER`` (default **n**)
106 Toggle display of ecore related messages.
108 - ``CONFIG_RTE_LIBRTE_QEDE_DEBUG_TX`` (default **n**)
110 Toggle display of transmit fast path run-time messages.
112 - ``CONFIG_RTE_LIBRTE_QEDE_DEBUG_RX`` (default **n**)
114 Toggle display of receive fast path run-time messages.
116 - ``CONFIG_RTE_LIBRTE_QEDE_FW`` (default **""**)
118 Gives absolute path of firmware file.
119 ``Eg: "/lib/firmware/qed/qed_init_values_zipped-8.10.9.0.bin"``
120 Empty string indicates driver will pick up the firmware file
121 from the default location.
126 To compile QEDE PMD for Linux x86_64 gcc target, run the following ``make``
129 cd <DPDK-source-directory>
130 make config T=x86_64-native-linuxapp-gcc install
132 To compile QEDE PMD for Linux x86_64 clang target, run the following ``make``
135 cd <DPDK-source-directory>
136 make config T=x86_64-native-linuxapp-clang install
138 To compile QEDE PMD for FreeBSD x86_64 clang target, run the following ``gmake``
141 cd <DPDK-source-directory>
142 gmake config T=x86_64-native-bsdapp-clang install
144 To compile QEDE PMD for FreeBSD x86_64 gcc target, run the following ``gmake``
147 cd <DPDK-source-directory>
148 gmake config T=x86_64-native-bsdapp-gcc install -Wl,-rpath=\
149 /usr/local/lib/gcc49 CC=gcc49
152 Sample Application Notes
153 ~~~~~~~~~~~~~~~~~~~~~~~~
155 This section demonstrates how to launch ``testpmd`` with QLogic 4xxxx
156 devices managed by ``librte_pmd_qede`` in Linux operating system.
158 #. Request huge pages:
160 .. code-block:: console
162 echo 1024 > /sys/kernel/mm/hugepages/hugepages-2048kB/nr_hugepages/ \
165 #. Load ``igb_uio`` driver:
167 .. code-block:: console
169 insmod ./x86_64-native-linuxapp-gcc/kmod/igb_uio.ko
171 #. Bind the QLogic 4xxxx adapters to ``igb_uio`` loaded in the
174 .. code-block:: console
176 ./tools/dpdk-devbind.py --bind igb_uio 0000:84:00.0 0000:84:00.1 \
177 0000:84:00.2 0000:84:00.3
179 #. Start ``testpmd`` with basic parameters:
180 (Enable QEDE_DEBUG_INFO=y to view informational messages)
182 .. code-block:: console
184 testpmd -c 0xff1 -n 4 -- -i --nb-cores=8 --portmask=0xf --rxd=4096 \
185 --txd=4096 --txfreet=4068 --enable-rx-cksum --rxq=4 --txq=4 \
190 EAL: PCI device 0000:84:00.0 on NUMA socket 1
191 EAL: probe driver: 1077:1634 rte_qede_pmd
192 EAL: Not managed by a supported kernel driver, skipped
193 EAL: PCI device 0000:84:00.1 on NUMA socket 1
194 EAL: probe driver: 1077:1634 rte_qede_pmd
195 EAL: Not managed by a supported kernel driver, skipped
196 EAL: PCI device 0000:88:00.0 on NUMA socket 1
197 EAL: probe driver: 1077:1656 rte_qede_pmd
198 EAL: PCI memory mapped at 0x7f738b200000
199 EAL: PCI memory mapped at 0x7f738b280000
200 EAL: PCI memory mapped at 0x7f738b300000
201 PMD: Chip details : BB1
202 PMD: Driver version : QEDE PMD 8.7.9.0_1.0.0
203 PMD: Firmware version : 8.7.7.0
204 PMD: Management firmware version : 8.7.8.0
205 PMD: Firmware file : /lib/firmware/qed/qed_init_values_zipped-8.7.7.0.bin
206 [QEDE PMD: (84:00.0:dpdk-port-0)]qede_common_dev_init:macaddr \
209 [QEDE PMD: (84:00.0:dpdk-port-0)]qede_tx_queue_setup:txq 0 num_desc 4096 \
210 tx_free_thresh 4068 socket 0
211 [QEDE PMD: (84:00.0:dpdk-port-0)]qede_tx_queue_setup:txq 1 num_desc 4096 \
212 tx_free_thresh 4068 socket 0
213 [QEDE PMD: (84:00.0:dpdk-port-0)]qede_tx_queue_setup:txq 2 num_desc 4096 \
214 tx_free_thresh 4068 socket 0
215 [QEDE PMD: (84:00.0:dpdk-port-0)]qede_tx_queue_setup:txq 3 num_desc 4096 \
216 tx_free_thresh 4068 socket 0
217 [QEDE PMD: (84:00.0:dpdk-port-0)]qede_rx_queue_setup:rxq 0 num_desc 4096 \
218 rx_buf_size=2148 socket 0
219 [QEDE PMD: (84:00.0:dpdk-port-0)]qede_rx_queue_setup:rxq 1 num_desc 4096 \
220 rx_buf_size=2148 socket 0
221 [QEDE PMD: (84:00.0:dpdk-port-0)]qede_rx_queue_setup:rxq 2 num_desc 4096 \
222 rx_buf_size=2148 socket 0
223 [QEDE PMD: (84:00.0:dpdk-port-0)]qede_rx_queue_setup:rxq 3 num_desc 4096 \
224 rx_buf_size=2148 socket 0
225 [QEDE PMD: (84:00.0:dpdk-port-0)]qede_dev_start:port 0
226 [QEDE PMD: (84:00.0:dpdk-port-0)]qede_dev_start:link status: down
228 Checking link statuses...
229 Port 0 Link Up - speed 25000 Mbps - full-duplex
230 Port 1 Link Up - speed 25000 Mbps - full-duplex
231 Port 2 Link Up - speed 25000 Mbps - full-duplex
232 Port 3 Link Up - speed 25000 Mbps - full-duplex
237 SR-IOV: Prerequisites and Sample Application Notes
238 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
240 This section provides instructions to configure SR-IOV with Linux OS.
242 **Note**: librte_pmd_qede will be used to bind to SR-IOV VF device and Linux native kernel driver (QEDE) will function as SR-IOV PF driver.
244 #. Verify SR-IOV and ARI capability is enabled on the adapter using ``lspci``:
246 .. code-block:: console
252 .. code-block:: console
255 Capabilities: [1b8 v1] Alternative Routing-ID Interpretation (ARI)
257 Capabilities: [1c0 v1] Single Root I/O Virtualization (SR-IOV)
259 Kernel driver in use: igb_uio
261 #. Load the kernel module:
263 .. code-block:: console
269 .. code-block:: console
271 systemd-udevd[4848]: renamed network interface eth0 to ens5f0
272 systemd-udevd[4848]: renamed network interface eth1 to ens5f1
274 #. Bring up the PF ports:
276 .. code-block:: console
281 #. Create VF device(s):
283 Echo the number of VFs to be created into ``"sriov_numvfs"`` sysfs entry
288 .. code-block:: console
290 echo 2 > /sys/devices/pci0000:00/0000:00:03.0/0000:81:00.0/sriov_numvfs
293 #. Assign VF MAC address:
295 Assign MAC address to the VF using iproute2 utility. The syntax is::
297 ip link set <PF iface> vf <VF id> mac <macaddr>
301 .. code-block:: console
303 ip link set ens5f0 vf 0 mac 52:54:00:2f:9d:e8
308 The VF devices may be passed through to the guest VM using ``virt-manager`` or
309 ``virsh``. QEDE PMD should be used to bind the VF devices in the guest VM
310 using the instructions outlined in the Application notes above.