2 Copyright(c) 2015-2016 Intel Corporation. All rights reserved.
4 Redistribution and use in source and binary forms, with or without
5 modification, are permitted provided that the following conditions
8 * Redistributions of source code must retain the above copyright
9 notice, this list of conditions and the following disclaimer.
10 * Redistributions in binary form must reproduce the above copyright
11 notice, this list of conditions and the following disclaimer in
12 the documentation and/or other materials provided with the
14 * Neither the name of Intel Corporation nor the names of its
15 contributors may be used to endorse or promote products derived
16 from this software without specific prior written permission.
18 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 Intel(R) QuickAssist (QAT) Crypto Poll Mode Driver
31 ==================================================
33 The QAT PMD provides poll mode crypto driver support for the following
34 hardware accelerator devices:
36 * ``Intel QuickAssist Technology DH895xCC``
37 * ``Intel QuickAssist Technology C62x``
38 * ``Intel QuickAssist Technology C3xxx``
39 * ``Intel QuickAssist Technology D15xx``
45 The QAT PMD has support for:
49 * ``RTE_CRYPTO_CIPHER_3DES_CBC``
50 * ``RTE_CRYPTO_CIPHER_3DES_CTR``
51 * ``RTE_CRYPTO_CIPHER_AES128_CBC``
52 * ``RTE_CRYPTO_CIPHER_AES192_CBC``
53 * ``RTE_CRYPTO_CIPHER_AES256_CBC``
54 * ``RTE_CRYPTO_CIPHER_AES128_CTR``
55 * ``RTE_CRYPTO_CIPHER_AES192_CTR``
56 * ``RTE_CRYPTO_CIPHER_AES256_CTR``
57 * ``RTE_CRYPTO_CIPHER_SNOW3G_UEA2``
58 * ``RTE_CRYPTO_CIPHER_AES_GCM``
59 * ``RTE_CRYPTO_CIPHER_NULL``
60 * ``RTE_CRYPTO_CIPHER_KASUMI_F8``
61 * ``RTE_CRYPTO_CIPHER_DES_CBC``
62 * ``RTE_CRYPTO_CIPHER_AES_DOCSISBPI``
63 * ``RTE_CRYPTO_CIPHER_DES_DOCSISBPI``
64 * ``RTE_CRYPTO_CIPHER_ZUC_EEA3``
68 * ``RTE_CRYPTO_AUTH_SHA1_HMAC``
69 * ``RTE_CRYPTO_AUTH_SHA224_HMAC``
70 * ``RTE_CRYPTO_AUTH_SHA256_HMAC``
71 * ``RTE_CRYPTO_AUTH_SHA384_HMAC``
72 * ``RTE_CRYPTO_AUTH_SHA512_HMAC``
73 * ``RTE_CRYPTO_AUTH_AES_XCBC_MAC``
74 * ``RTE_CRYPTO_AUTH_SNOW3G_UIA2``
75 * ``RTE_CRYPTO_AUTH_MD5_HMAC``
76 * ``RTE_CRYPTO_AUTH_NULL``
77 * ``RTE_CRYPTO_AUTH_KASUMI_F9``
78 * ``RTE_CRYPTO_AUTH_AES_GMAC``
79 * ``RTE_CRYPTO_AUTH_ZUC_EIA3``
85 * Hash only is not supported except SNOW 3G UIA2 and KASUMI F9.
86 * Only supports the session-oriented API implementation (session-less APIs are not supported).
87 * SNOW 3G (UEA2) and KASUMI (F8) supported only if cipher length, cipher offset fields are byte-aligned.
88 * SNOW 3G (UIA2) and KASUMI (F9) supported only if hash length, hash offset fields are byte-aligned.
89 * No BSD support as BSD QAT kernel driver not available.
90 * ZUC EEA3/EIA3 is not supported by dh895xcc devices
91 * Maximum additional authenticated data (AAD) for GCM is 240 bytes long.
97 To enable QAT in DPDK, follow the instructions for modifying the compile-time
98 configuration file as described `here <http://dpdk.org/doc/guides/linux_gsg/build_dpdk.html>`_.
100 Quick instructions are as follows:
102 .. code-block:: console
104 cd to the top-level DPDK directory
105 make config T=x86_64-native-linuxapp-gcc
106 sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_QAT\)=n,\1=y,' build/.config
109 To use the DPDK QAT PMD an SRIOV-enabled QAT kernel driver is required. The VF
110 devices exposed by this driver will be used by the QAT PMD. The devices and
111 available kernel drivers and device ids are :
113 .. _table_qat_pmds_drivers:
115 .. table:: QAT devices and drivers
117 +----------+--------+---------------+------------+--------+---------+--------+------------+
118 | Device | Driver | Kernel Module | Pci Driver | PF Did | Num PFs | Vf Did | VFs per PF |
119 +==========+========+===============+============+========+=========+========+============+
120 | DH895xCC | 01.org | icp_qa_al | n/a | 435 | 1 | 443 | 32 |
121 +----------+--------+---------------+------------+--------+---------+--------+------------+
122 | DH895xCC | 4.4+ | qat_dh895xcc | dh895xcc | 435 | 1 | 443 | 32 |
123 +----------+--------+---------------+------------+--------+---------+--------+------------+
124 | C62x | 4.5+ | qat_c62x | c6xx | 37c8 | 3 | 37c9 | 16 |
125 +----------+--------+---------------+------------+--------+---------+--------+------------+
126 | C3xxx | 4.5+ | qat_c3xxx | c3xxx | 19e2 | 1 | 19e3 | 16 |
127 +----------+--------+---------------+------------+--------+---------+--------+------------+
128 | D15xx | p | qat_d15xx | d15xx | 6f54 | 1 | 6f55 | 16 |
129 +----------+--------+---------------+------------+--------+---------+--------+------------+
132 The ``Driver`` column indicates either the Linux kernel version in which
133 support for this device was introduced or a driver available on Intel's 01.org
134 website. There are both linux and 01.org kernel drivers available for some
135 devices. p = release pending.
137 If you are running on a kernel which includes a driver for your device, see
138 `Installation using kernel.org driver`_ below. Otherwise see
139 `Installation using 01.org QAT driver`_.
142 Installation using kernel.org driver
143 ------------------------------------
145 The examples below are based on the C62x device, if you have a different device
146 use the corresponding values in the above table.
148 In BIOS ensure that SRIOV is enabled and either:
151 * Enable VT-d and set ``"intel_iommu=on iommu=pt"`` in the grub file.
153 Check that the QAT driver is loaded on your system, by executing::
157 You should see the kernel module for your device listed, e.g.::
160 intel_qat 82336 1 qat_c62x
162 Next, you need to expose the Virtual Functions (VFs) using the sysfs file system.
164 First find the BDFs (Bus-Device-Function) of the physical functions (PFs) of
169 You should see output similar to::
171 1a:00.0 Co-processor: Intel Corporation Device 37c8
172 3d:00.0 Co-processor: Intel Corporation Device 37c8
173 3f:00.0 Co-processor: Intel Corporation Device 37c8
175 Enable the VFs for each PF by echoing the number of VFs per PF to the pci driver::
177 echo 16 > /sys/bus/pci/drivers/c6xx/0000:1a:00.0/sriov_numvfs
178 echo 16 > /sys/bus/pci/drivers/c6xx/0000:3d:00.0/sriov_numvfs
179 echo 16 > /sys/bus/pci/drivers/c6xx/0000:3f:00.0/sriov_numvfs
181 Check that the VFs are available for use. For example ``lspci -d:37c9`` should
182 list 48 VF devices available for a ``C62x`` device.
184 To complete the installation follow the instructions in
185 `Binding the available VFs to the DPDK UIO driver`_.
189 If the QAT kernel modules are not loaded and you see an error like ``Failed
190 to load MMP firmware qat_895xcc_mmp.bin`` in kernel logs, this may be as a
191 result of not using a distribution, but just updating the kernel directly.
193 Download firmware from the `kernel firmware repo
194 <http://git.kernel.org/cgit/linux/kernel/git/firmware/linux-firmware.git/tree/>`_.
196 Copy qat binaries to ``/lib/firmware``::
198 cp qat_895xcc.bin /lib/firmware
199 cp qat_895xcc_mmp.bin /lib/firmware
201 Change to your linux source root directory and start the qat kernel modules::
203 insmod ./drivers/crypto/qat/qat_common/intel_qat.ko
204 insmod ./drivers/crypto/qat/qat_dh895xcc/qat_dh895xcc.ko
209 If you see the following warning in ``/var/log/messages`` it can be ignored:
210 ``IOMMU should be enabled for SR-IOV to work correctly``.
213 Installation using 01.org QAT driver
214 ------------------------------------
216 Download the latest QuickAssist Technology Driver from `01.org
217 <https://01.org/packet-processing/intel%C2%AE-quickassist-technology-drivers-and-patches>`_.
218 Consult the *Getting Started Guide* at the same URL for further information.
220 The steps below assume you are:
222 * Building on a platform with one ``DH895xCC`` device.
223 * Using package ``qatmux.l.2.3.0-34.tgz``.
224 * On Fedora21 kernel ``3.17.4-301.fc21.x86_64``.
226 In the BIOS ensure that SRIOV is enabled and VT-d is disabled.
228 Uninstall any existing QAT driver, for example by running:
230 * ``./installer.sh uninstall`` in the directory where originally installed.
232 * or ``rmmod qat_dh895xcc; rmmod intel_qat``.
234 Build and install the SRIOV-enabled QAT driver::
239 # Copy qatmux.l.2.3.0-34.tgz to this location
240 tar zxof qatmux.l.2.3.0-34.tgz
242 export ICP_WITHOUT_IOMMU=1
243 ./installer.sh install QAT1.6 host
245 You can use ``cat /proc/icp_dh895xcc_dev0/version`` to confirm the driver is correctly installed.
246 You can use ``lspci -d:443`` to confirm the of the 32 VF devices available per ``DH895xCC`` device.
248 To complete the installation - follow instructions in `Binding the available VFs to the DPDK UIO driver`_.
252 If using a later kernel and the build fails with an error relating to
253 ``strict_stroul`` not being available apply the following patch:
257 /QAT/QAT1.6/quickassist/utilities/downloader/Target_CoreLibs/uclo/include/linux/uclo_platform.h
258 + #if LINUX_VERSION_CODE >= KERNEL_VERSION(3,18,5)
259 + #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; if (kstrtoul((str), (base), (num))) printk("Error strtoull convert %s\n", str); }
261 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,38)
262 #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; if (strict_strtoull((str), (base), (num))) printk("Error strtoull convert %s\n", str); }
264 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,25)
265 #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; strict_strtoll((str), (base), (num));}
267 #define STR_TO_64(str, base, num, endPtr) \
271 *(num) = -(simple_strtoull((str+1), &(endPtr), (base))); \
273 *(num) = simple_strtoull((str), &(endPtr), (base)); \
283 If the build fails due to missing header files you may need to do following::
285 sudo yum install zlib-devel
286 sudo yum install openssl-devel
290 If the build or install fails due to mismatching kernel sources you may need to do the following::
292 sudo yum install kernel-headers-`uname -r`
293 sudo yum install kernel-src-`uname -r`
294 sudo yum install kernel-devel-`uname -r`
297 Binding the available VFs to the DPDK UIO driver
298 ------------------------------------------------
300 Unbind the VFs from the stock driver so they can be bound to the uio driver.
302 For an Intel(R) QuickAssist Technology DH895xCC device
303 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
305 The unbind command below assumes ``BDFs`` of ``03:01.00-03:04.07``, if your
306 VFs are different adjust the unbind command below::
308 for device in $(seq 1 4); do \
309 for fn in $(seq 0 7); do \
310 echo -n 0000:03:0${device}.${fn} > \
311 /sys/bus/pci/devices/0000\:03\:0${device}.${fn}/driver/unbind; \
315 For an Intel(R) QuickAssist Technology C62x device
316 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
318 The unbind command below assumes ``BDFs`` of ``1a:01.00-1a:02.07``,
319 ``3d:01.00-3d:02.07`` and ``3f:01.00-3f:02.07``, if your VFs are different
320 adjust the unbind command below::
322 for device in $(seq 1 2); do \
323 for fn in $(seq 0 7); do \
324 echo -n 0000:1a:0${device}.${fn} > \
325 /sys/bus/pci/devices/0000\:1a\:0${device}.${fn}/driver/unbind; \
327 echo -n 0000:3d:0${device}.${fn} > \
328 /sys/bus/pci/devices/0000\:3d\:0${device}.${fn}/driver/unbind; \
330 echo -n 0000:3f:0${device}.${fn} > \
331 /sys/bus/pci/devices/0000\:3f\:0${device}.${fn}/driver/unbind; \
335 For Intel(R) QuickAssist Technology C3xxx or D15xx device
336 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
338 The unbind command below assumes ``BDFs`` of ``01:01.00-01:02.07``, if your
339 VFs are different adjust the unbind command below::
341 for device in $(seq 1 2); do \
342 for fn in $(seq 0 7); do \
343 echo -n 0000:01:0${device}.${fn} > \
344 /sys/bus/pci/devices/0000\:01\:0${device}.${fn}/driver/unbind; \
348 Bind to the DPDK uio driver
349 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
351 Install the DPDK igb_uio driver, bind the VF PCI Device id to it and use lspci
352 to confirm the VF devices are now in use by igb_uio kernel driver,
353 e.g. for the C62x device::
355 cd to the top-level DPDK directory
357 insmod ./build/kmod/igb_uio.ko
358 echo "8086 37c9" > /sys/bus/pci/drivers/igb_uio/new_id
362 Another way to bind the VFs to the DPDK UIO driver is by using the
363 ``dpdk-devbind.py`` script::
365 cd to the top-level DPDK directory
366 ./usertools/dpdk-devbind.py -b igb_uio 0000:03:01.1