1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright(c) 2015-2016 Intel Corporation.
4 Intel(R) QuickAssist (QAT) Crypto Poll Mode Driver
5 ==================================================
7 The QAT PMD provides poll mode crypto driver support for the following
8 hardware accelerator devices:
10 * ``Intel QuickAssist Technology DH895xCC``
11 * ``Intel QuickAssist Technology C62x``
12 * ``Intel QuickAssist Technology C3xxx``
13 * ``Intel QuickAssist Technology D15xx``
19 The QAT PMD has support for:
23 * ``RTE_CRYPTO_CIPHER_3DES_CBC``
24 * ``RTE_CRYPTO_CIPHER_3DES_CTR``
25 * ``RTE_CRYPTO_CIPHER_AES128_CBC``
26 * ``RTE_CRYPTO_CIPHER_AES192_CBC``
27 * ``RTE_CRYPTO_CIPHER_AES256_CBC``
28 * ``RTE_CRYPTO_CIPHER_AES128_CTR``
29 * ``RTE_CRYPTO_CIPHER_AES192_CTR``
30 * ``RTE_CRYPTO_CIPHER_AES256_CTR``
31 * ``RTE_CRYPTO_CIPHER_SNOW3G_UEA2``
32 * ``RTE_CRYPTO_CIPHER_NULL``
33 * ``RTE_CRYPTO_CIPHER_KASUMI_F8``
34 * ``RTE_CRYPTO_CIPHER_DES_CBC``
35 * ``RTE_CRYPTO_CIPHER_AES_DOCSISBPI``
36 * ``RTE_CRYPTO_CIPHER_DES_DOCSISBPI``
37 * ``RTE_CRYPTO_CIPHER_ZUC_EEA3``
41 * ``RTE_CRYPTO_AUTH_SHA1_HMAC``
42 * ``RTE_CRYPTO_AUTH_SHA224_HMAC``
43 * ``RTE_CRYPTO_AUTH_SHA256_HMAC``
44 * ``RTE_CRYPTO_AUTH_SHA384_HMAC``
45 * ``RTE_CRYPTO_AUTH_SHA512_HMAC``
46 * ``RTE_CRYPTO_AUTH_AES_XCBC_MAC``
47 * ``RTE_CRYPTO_AUTH_SNOW3G_UIA2``
48 * ``RTE_CRYPTO_AUTH_MD5_HMAC``
49 * ``RTE_CRYPTO_AUTH_NULL``
50 * ``RTE_CRYPTO_AUTH_KASUMI_F9``
51 * ``RTE_CRYPTO_AUTH_AES_GMAC``
52 * ``RTE_CRYPTO_AUTH_ZUC_EIA3``
54 Supported AEAD algorithms:
56 * ``RTE_CRYPTO_AEAD_AES_GCM``
62 * Only supports the session-oriented API implementation (session-less APIs are not supported).
63 * SNOW 3G (UEA2), KASUMI (F8) and ZUC (EEA3) supported only if cipher length and offset fields are byte-multiple.
64 * SNOW 3G (UIA2) and ZUC (EIA3) supported only if hash length and offset fields are byte-multiple.
65 * No BSD support as BSD QAT kernel driver not available.
66 * ZUC EEA3/EIA3 is not supported by dh895xcc devices
67 * Maximum additional authenticated data (AAD) for GCM is 240 bytes long.
68 * Queue pairs are not thread-safe (that is, within a single queue pair, RX and TX from different lcores is not supported).
71 Extra notes on KASUMI F9
72 ------------------------
74 When using KASUMI F9 authentication algorithm, the input buffer must be
75 constructed according to the
76 `3GPP KASUMI specification <http://cryptome.org/3gpp/35201-900.pdf>`_
77 (section 4.4, page 13). The input buffer has to have COUNT (4 bytes),
78 FRESH (4 bytes), MESSAGE and DIRECTION (1 bit) concatenated. After the DIRECTION
79 bit, a single '1' bit is appended, followed by between 0 and 7 '0' bits, so that
80 the total length of the buffer is multiple of 8 bits. Note that the actual
81 message can be any length, specified in bits.
83 Once this buffer is passed this way, when creating the crypto operation,
84 length of data to authenticate "op.sym.auth.data.length" must be the length
85 of all the items described above, including the padding at the end.
86 Also, offset of data to authenticate "op.sym.auth.data.offset"
87 must be such that points at the start of the COUNT bytes.
90 Building the DPDK QAT cryptodev PMD
91 -----------------------------------
94 To enable QAT crypto in DPDK, follow the instructions for modifying the compile-time
95 configuration file as described `here <http://dpdk.org/doc/guides/linux_gsg/build_dpdk.html>`_.
98 Quick instructions are as follows:
100 .. code-block:: console
102 cd to the top-level DPDK directory
103 make config T=x86_64-native-linuxapp-gcc
104 sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_QAT\)=n,\1=y,' build/.config
105 sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_QAT_SYM\)=n,\1=y,' build/.config
109 .. _qat_kernel_installation:
111 Dependency on the QAT kernel driver
112 -----------------------------------
114 To use the QAT PMD an SRIOV-enabled QAT kernel driver is required. The VF
115 devices created and initialised by this driver will be used by the QAT PMD.
117 Instructions for installation are below, but first an explanation of the
118 relationships between the PF/VF devices and the PMDs visible to
122 Acceleration services - cryptography and compression - are provided to DPDK
123 applications via PMDs which register to implement the corresponding
124 cryptodev and compressdev APIs.
126 Each QuickAssist VF device can expose one cryptodev PMD and/or one compressdev PMD.
127 These QAT PMDs share the same underlying device and pci-mgmt code, but are
128 enumerated independently on their respective APIs and appear as independent
129 devices to applications.
133 Each VF can only be used by one DPDK process. It is not possible to share
134 the same VF across multiple processes, even if these processes are using
135 different acceleration services.
137 Conversely one DPDK process can use one or more QAT VFs and can expose both
138 cryptodev and compressdev instances on each of those VFs.
142 Device and driver naming
143 ------------------------
145 * The qat cryptodev driver name is "crypto_qat".
146 The "rte_cryptodev_devices_get()" returns the devices exposed by this driver.
148 * Each qat crypto device has a unique name, in format
149 "<pci bdf>_<service>", e.g. "0000:41:01.0_qat_sym".
150 This name can be passed to "rte_cryptodev_get_dev_id()" to get the device_id.
154 The qat crypto driver name is passed to the dpdk-test-crypto-perf tool in the "-devtype" parameter.
156 The qat crypto device name is in the format of the slave parameter passed to the crypto scheduler.
158 * The qat compressdev driver name is "qat".
159 The rte_compressdev_devices_get() returns the devices exposed by this driver.
161 * Each qat compression device has a unique name, in format
162 <pci bdf>_<service>, e.g. "0000:41:01.0_qat_comp".
163 This name can be passed to rte_compressdev_get_dev_id() to get the device_id.
166 Available kernel drivers
167 ------------------------
169 Kernel drivers for each device are listed in the following table. Scroll right
170 to check that the driver and device supports the service you require.
173 .. _table_qat_pmds_drivers:
175 .. table:: QAT device generations, devices and drivers
177 +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
178 | Gen | Device | Driver/ver | Kernel Module | Pci Driver | PF Did | #PFs | VF Did | VFs/PF | cryptodev | compressdev |
179 +=====+==========+===============+===============+============+========+======+========+========+===========+=============+
180 | 1 | DH895xCC | linux/4.4+ | qat_dh895xcc | dh895xcc | 435 | 1 | 443 | 32 | Yes | No |
181 +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
182 | " | " | 01.org/4.2.0+ | " | " | " | " | " | " | Yes | No |
183 +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
184 | 2 | C62x | linux/4.5+ | qat_c62x | c6xx | 37c8 | 3 | 37c9 | 16 | Yes | No |
185 +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
186 | " | " | 01.org/4.2.0+ | " | " | " | " | " | " | Yes | Yes |
187 +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
188 | 2 | C3xxx | linux/4.5+ | qat_c3xxx | c3xxx | 19e2 | 1 | 19e3 | 16 | Yes | No |
189 +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
190 | " | " | 01.org/4.2.0+ | " | " | " | " | " | " | Yes | Yes |
191 +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
192 | 2 | D15xx | p | qat_d15xx | d15xx | 6f54 | 1 | 6f55 | 16 | Yes | No |
193 +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
196 The ``Driver`` column indicates either the Linux kernel version in which
197 support for this device was introduced or a driver available on Intel's 01.org
198 website. There are both linux and 01.org kernel drivers available for some
199 devices. p = release pending.
201 If you are running on a kernel which includes a driver for your device, see
202 `Installation using kernel.org driver`_ below. Otherwise see
203 `Installation using 01.org QAT driver`_.
206 Installation using kernel.org driver
207 ------------------------------------
209 The examples below are based on the C62x device, if you have a different device
210 use the corresponding values in the above table.
212 In BIOS ensure that SRIOV is enabled and either:
215 * Enable VT-d and set ``"intel_iommu=on iommu=pt"`` in the grub file.
217 Check that the QAT driver is loaded on your system, by executing::
221 You should see the kernel module for your device listed, e.g.::
224 intel_qat 82336 1 qat_c62x
226 Next, you need to expose the Virtual Functions (VFs) using the sysfs file system.
228 First find the BDFs (Bus-Device-Function) of the physical functions (PFs) of
233 You should see output similar to::
235 1a:00.0 Co-processor: Intel Corporation Device 37c8
236 3d:00.0 Co-processor: Intel Corporation Device 37c8
237 3f:00.0 Co-processor: Intel Corporation Device 37c8
239 Enable the VFs for each PF by echoing the number of VFs per PF to the pci driver::
241 echo 16 > /sys/bus/pci/drivers/c6xx/0000:1a:00.0/sriov_numvfs
242 echo 16 > /sys/bus/pci/drivers/c6xx/0000:3d:00.0/sriov_numvfs
243 echo 16 > /sys/bus/pci/drivers/c6xx/0000:3f:00.0/sriov_numvfs
245 Check that the VFs are available for use. For example ``lspci -d:37c9`` should
246 list 48 VF devices available for a ``C62x`` device.
248 To complete the installation follow the instructions in
249 `Binding the available VFs to the DPDK UIO driver`_.
253 If the QAT kernel modules are not loaded and you see an error like ``Failed
254 to load MMP firmware qat_895xcc_mmp.bin`` in kernel logs, this may be as a
255 result of not using a distribution, but just updating the kernel directly.
257 Download firmware from the `kernel firmware repo
258 <http://git.kernel.org/cgit/linux/kernel/git/firmware/linux-firmware.git/tree/>`_.
260 Copy qat binaries to ``/lib/firmware``::
262 cp qat_895xcc.bin /lib/firmware
263 cp qat_895xcc_mmp.bin /lib/firmware
265 Change to your linux source root directory and start the qat kernel modules::
267 insmod ./drivers/crypto/qat/qat_common/intel_qat.ko
268 insmod ./drivers/crypto/qat/qat_dh895xcc/qat_dh895xcc.ko
273 If you see the following warning in ``/var/log/messages`` it can be ignored:
274 ``IOMMU should be enabled for SR-IOV to work correctly``.
277 Installation using 01.org QAT driver
278 ------------------------------------
280 Download the latest QuickAssist Technology Driver from `01.org
281 <https://01.org/packet-processing/intel%C2%AE-quickassist-technology-drivers-and-patches>`_.
282 Consult the *Getting Started Guide* at the same URL for further information.
284 The steps below assume you are:
286 * Building on a platform with one ``C62x`` device.
287 * Using package ``qat1.7.l.4.2.0-000xx.tar.gz``.
288 * On Fedora26 kernel ``4.11.11-300.fc26.x86_64``.
290 In the BIOS ensure that SRIOV is enabled and VT-d is disabled.
292 Uninstall any existing QAT driver, for example by running:
294 * ``./installer.sh uninstall`` in the directory where originally installed.
297 Build and install the SRIOV-enabled QAT driver::
302 # Copy the package to this location and unpack
303 tar zxof qat1.7.l.4.2.0-000xx.tar.gz
305 ./configure --enable-icp-sriov=host
308 You can use ``cat /sys/kernel/debug/qat<your device type and bdf>/version/fw`` to confirm the driver is correctly installed and is using firmware version 4.2.0.
309 You can use ``lspci -d:37c9`` to confirm the presence of the 16 VF devices available per ``C62x`` PF.
311 Confirm the driver is correctly installed and is using firmware version 4.2.0::
313 cat /sys/kernel/debug/qat<your device type and bdf>/version/fw
316 Confirm the presence of 48 VF devices - 16 per PF::
321 To complete the installation - follow instructions in `Binding the available VFs to the DPDK UIO driver`_.
325 If using a later kernel and the build fails with an error relating to
326 ``strict_stroul`` not being available apply the following patch:
330 /QAT/QAT1.6/quickassist/utilities/downloader/Target_CoreLibs/uclo/include/linux/uclo_platform.h
331 + #if LINUX_VERSION_CODE >= KERNEL_VERSION(3,18,5)
332 + #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; if (kstrtoul((str), (base), (num))) printk("Error strtoull convert %s\n", str); }
334 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,38)
335 #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; if (strict_strtoull((str), (base), (num))) printk("Error strtoull convert %s\n", str); }
337 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,25)
338 #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; strict_strtoll((str), (base), (num));}
340 #define STR_TO_64(str, base, num, endPtr) \
344 *(num) = -(simple_strtoull((str+1), &(endPtr), (base))); \
346 *(num) = simple_strtoull((str), &(endPtr), (base)); \
356 If the build fails due to missing header files you may need to do following::
358 sudo yum install zlib-devel
359 sudo yum install openssl-devel
360 sudo yum install libudev-devel
364 If the build or install fails due to mismatching kernel sources you may need to do the following::
366 sudo yum install kernel-headers-`uname -r`
367 sudo yum install kernel-src-`uname -r`
368 sudo yum install kernel-devel-`uname -r`
371 Binding the available VFs to the DPDK UIO driver
372 ------------------------------------------------
374 Unbind the VFs from the stock driver so they can be bound to the uio driver.
376 For an Intel(R) QuickAssist Technology DH895xCC device
377 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
379 The unbind command below assumes ``BDFs`` of ``03:01.00-03:04.07``, if your
380 VFs are different adjust the unbind command below::
382 for device in $(seq 1 4); do \
383 for fn in $(seq 0 7); do \
384 echo -n 0000:03:0${device}.${fn} > \
385 /sys/bus/pci/devices/0000\:03\:0${device}.${fn}/driver/unbind; \
389 For an Intel(R) QuickAssist Technology C62x device
390 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
392 The unbind command below assumes ``BDFs`` of ``1a:01.00-1a:02.07``,
393 ``3d:01.00-3d:02.07`` and ``3f:01.00-3f:02.07``, if your VFs are different
394 adjust the unbind command below::
396 for device in $(seq 1 2); do \
397 for fn in $(seq 0 7); do \
398 echo -n 0000:1a:0${device}.${fn} > \
399 /sys/bus/pci/devices/0000\:1a\:0${device}.${fn}/driver/unbind; \
401 echo -n 0000:3d:0${device}.${fn} > \
402 /sys/bus/pci/devices/0000\:3d\:0${device}.${fn}/driver/unbind; \
404 echo -n 0000:3f:0${device}.${fn} > \
405 /sys/bus/pci/devices/0000\:3f\:0${device}.${fn}/driver/unbind; \
409 For Intel(R) QuickAssist Technology C3xxx or D15xx device
410 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
412 The unbind command below assumes ``BDFs`` of ``01:01.00-01:02.07``, if your
413 VFs are different adjust the unbind command below::
415 for device in $(seq 1 2); do \
416 for fn in $(seq 0 7); do \
417 echo -n 0000:01:0${device}.${fn} > \
418 /sys/bus/pci/devices/0000\:01\:0${device}.${fn}/driver/unbind; \
422 Bind to the DPDK uio driver
423 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
425 Install the DPDK igb_uio driver, bind the VF PCI Device id to it and use lspci
426 to confirm the VF devices are now in use by igb_uio kernel driver,
427 e.g. for the C62x device::
429 cd to the top-level DPDK directory
431 insmod ./build/kmod/igb_uio.ko
432 echo "8086 37c9" > /sys/bus/pci/drivers/igb_uio/new_id
436 Another way to bind the VFs to the DPDK UIO driver is by using the
437 ``dpdk-devbind.py`` script::
439 cd to the top-level DPDK directory
440 ./usertools/dpdk-devbind.py -b igb_uio 0000:03:01.1
445 QAT crypto PMD can be tested by running the test application::
450 ./test -l1 -n1 -w <your qat bdf>
451 RTE>>cryptodev_qat_autotest
453 QAT compression PMD can be tested by running the test application::
456 sed -i 's,\(CONFIG_RTE_COMPRESSDEV_TEST\)=n,\1=y,' build/.config
459 ./test -l1 -n1 -w <your qat bdf>
460 RTE>>compressdev_autotest
464 ----------------------------------------
466 There are 2 sets of trace available via the dynamic logging feature:
468 * pmd.qat_dp exposes trace on the data-path.
469 * pmd.qat_general exposes all other trace.
471 pmd.qat exposes both sets of traces.
472 They can be enabled using the log-level option (where 8=maximum log level) on
473 the process cmdline, e.g. using any of the following::
475 --log-level="pmd.qat_general,8"
476 --log-level="pmd.qat_dp,8"
477 --log-level="pmd.qat,8"
481 The global RTE_LOG_DP_LEVEL overrides data-path trace so must be set to
482 RTE_LOG_DEBUG to see all the trace. This variable is in config/rte_config.h
483 for meson build and config/common_base for gnu make.
484 Also the dynamic global log level overrides both sets of trace, so e.g. no
485 QAT trace would display in this case::
487 --log-level="7" --log-level="pmd.qat_general,8"