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 QAT documentation consists of three parts:
9 * Details of the symmetric crypto service below.
10 * Details of the `compression service <http://dpdk.org/doc/guides/compressdevs/qat_comp.html>`_
11 in the compressdev drivers section.
12 * Details of building the common QAT infrastructure and the PMDs to support the
13 above services. See :ref:`building_qat` below.
16 Symmetric Crypto Service on QAT
17 -------------------------------
19 The QAT crypto PMD provides poll mode crypto driver support for the following
20 hardware accelerator devices:
22 * ``Intel QuickAssist Technology DH895xCC``
23 * ``Intel QuickAssist Technology C62x``
24 * ``Intel QuickAssist Technology C3xxx``
25 * ``Intel QuickAssist Technology D15xx``
26 * ``Intel QuickAssist Technology C4xxx``
32 The QAT PMD has support for:
36 * ``RTE_CRYPTO_CIPHER_3DES_CBC``
37 * ``RTE_CRYPTO_CIPHER_3DES_CTR``
38 * ``RTE_CRYPTO_CIPHER_AES128_CBC``
39 * ``RTE_CRYPTO_CIPHER_AES192_CBC``
40 * ``RTE_CRYPTO_CIPHER_AES256_CBC``
41 * ``RTE_CRYPTO_CIPHER_AES128_CTR``
42 * ``RTE_CRYPTO_CIPHER_AES192_CTR``
43 * ``RTE_CRYPTO_CIPHER_AES256_CTR``
44 * ``RTE_CRYPTO_CIPHER_SNOW3G_UEA2``
45 * ``RTE_CRYPTO_CIPHER_NULL``
46 * ``RTE_CRYPTO_CIPHER_KASUMI_F8``
47 * ``RTE_CRYPTO_CIPHER_DES_CBC``
48 * ``RTE_CRYPTO_CIPHER_AES_DOCSISBPI``
49 * ``RTE_CRYPTO_CIPHER_DES_DOCSISBPI``
50 * ``RTE_CRYPTO_CIPHER_ZUC_EEA3``
54 * ``RTE_CRYPTO_AUTH_SHA1_HMAC``
55 * ``RTE_CRYPTO_AUTH_SHA224_HMAC``
56 * ``RTE_CRYPTO_AUTH_SHA256_HMAC``
57 * ``RTE_CRYPTO_AUTH_SHA384_HMAC``
58 * ``RTE_CRYPTO_AUTH_SHA512_HMAC``
59 * ``RTE_CRYPTO_AUTH_AES_XCBC_MAC``
60 * ``RTE_CRYPTO_AUTH_SNOW3G_UIA2``
61 * ``RTE_CRYPTO_AUTH_MD5_HMAC``
62 * ``RTE_CRYPTO_AUTH_NULL``
63 * ``RTE_CRYPTO_AUTH_KASUMI_F9``
64 * ``RTE_CRYPTO_AUTH_AES_GMAC``
65 * ``RTE_CRYPTO_AUTH_ZUC_EIA3``
66 * ``RTE_CRYPTO_AUTH_AES_CMAC``
68 Supported AEAD algorithms:
70 * ``RTE_CRYPTO_AEAD_AES_GCM``
71 * ``RTE_CRYPTO_AEAD_AES_CCM``
77 * Only supports the session-oriented API implementation (session-less APIs are not supported).
78 * SNOW 3G (UEA2), KASUMI (F8) and ZUC (EEA3) supported only if cipher length and offset fields are byte-multiple.
79 * SNOW 3G (UIA2) and ZUC (EIA3) supported only if hash length and offset fields are byte-multiple.
80 * No BSD support as BSD QAT kernel driver not available.
81 * ZUC EEA3/EIA3 is not supported by dh895xcc devices
82 * Maximum additional authenticated data (AAD) for GCM is 240 bytes long.
83 * Queue pairs are not thread-safe (that is, within a single queue pair, RX and TX from different lcores is not supported).
86 Extra notes on KASUMI F9
87 ~~~~~~~~~~~~~~~~~~~~~~~~
89 When using KASUMI F9 authentication algorithm, the input buffer must be
90 constructed according to the
91 `3GPP KASUMI specification <http://cryptome.org/3gpp/35201-900.pdf>`_
92 (section 4.4, page 13). The input buffer has to have COUNT (4 bytes),
93 FRESH (4 bytes), MESSAGE and DIRECTION (1 bit) concatenated. After the DIRECTION
94 bit, a single '1' bit is appended, followed by between 0 and 7 '0' bits, so that
95 the total length of the buffer is multiple of 8 bits. Note that the actual
96 message can be any length, specified in bits.
98 Once this buffer is passed this way, when creating the crypto operation,
99 length of data to authenticate "op.sym.auth.data.length" must be the length
100 of all the items described above, including the padding at the end.
101 Also, offset of data to authenticate "op.sym.auth.data.offset"
102 must be such that points at the start of the COUNT bytes.
111 A QAT device can host multiple acceleration services:
113 * symmetric cryptography
116 These services are provided to DPDK applications via PMDs which register to
117 implement the corresponding cryptodev and compressdev APIs. The PMDs use
118 common QAT driver code which manages the QAT PCI device. They also depend on a
119 QAT kernel driver being installed on the platform, see :ref:`qat_kernel` below.
122 Configuring and Building the DPDK QAT PMDs
123 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
126 Further information on configuring, building and installing DPDK is described
127 `here <http://dpdk.org/doc/guides/linux_gsg/build_dpdk.html>`_.
130 Quick instructions for QAT cryptodev PMD are as follows:
132 .. code-block:: console
134 cd to the top-level DPDK directory
136 sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_QAT_SYM\)=n,\1=y,' build/.config
139 Quick instructions for QAT compressdev PMD are as follows:
141 .. code-block:: console
143 cd to the top-level DPDK directory
151 These are the build configuration options affecting QAT, and their default values:
153 .. code-block:: console
155 CONFIG_RTE_LIBRTE_PMD_QAT=y
156 CONFIG_RTE_LIBRTE_PMD_QAT_SYM=n
157 CONFIG_RTE_PMD_QAT_MAX_PCI_DEVICES=48
158 CONFIG_RTE_PMD_QAT_COMP_SGL_MAX_SEGMENTS=16
160 CONFIG_RTE_LIBRTE_PMD_QAT must be enabled for any QAT PMD to be built.
162 The QAT cryptodev PMD has an external dependency on libcrypto, so is not
163 built by default. CONFIG_RTE_LIBRTE_PMD_QAT_SYM should be enabled to build it.
165 The QAT compressdev PMD has no external dependencies, so needs no configuration
166 options and is built by default.
168 The number of VFs per PF varies - see table below. If multiple QAT packages are
169 installed on a platform then CONFIG_RTE_PMD_QAT_MAX_PCI_DEVICES should be
170 adjusted to the number of VFs which the QAT common code will need to handle.
171 Note, there is a separate config item for max cryptodevs CONFIG_RTE_CRYPTO_MAX_DEVS,
172 if necessary this should be adjusted to handle the total of QAT and other devices
173 which the process will use.
175 QAT allocates internal structures to handle SGLs. For the compression service
176 CONFIG_RTE_PMD_QAT_COMP_SGL_MAX_SEGMENTS can be changed if more segments are needed.
177 An extra (max_inflight_ops x 16) bytes per queue_pair will be used for every increment.
180 Device and driver naming
181 ~~~~~~~~~~~~~~~~~~~~~~~~
183 * The qat cryptodev driver name is "crypto_qat".
184 The "rte_cryptodev_devices_get()" returns the devices exposed by this driver.
186 * Each qat crypto device has a unique name, in format
187 "<pci bdf>_<service>", e.g. "0000:41:01.0_qat_sym".
188 This name can be passed to "rte_cryptodev_get_dev_id()" to get the device_id.
192 The qat crypto driver name is passed to the dpdk-test-crypto-perf tool in the "-devtype" parameter.
194 The qat crypto device name is in the format of the slave parameter passed to the crypto scheduler.
196 * The qat compressdev driver name is "compress_qat".
197 The rte_compressdev_devices_get() returns the devices exposed by this driver.
199 * Each qat compression device has a unique name, in format
200 <pci bdf>_<service>, e.g. "0000:41:01.0_qat_comp".
201 This name can be passed to rte_compressdev_get_dev_id() to get the device_id.
205 Dependency on the QAT kernel driver
206 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
208 To use QAT an SRIOV-enabled QAT kernel driver is required. The VF
209 devices created and initialised by this driver will be used by the QAT PMDs.
211 Instructions for installation are below, but first an explanation of the
212 relationships between the PF/VF devices and the PMDs visible to
215 Each QuickAssist PF device exposes a number of VF devices. Each VF device can
216 enable one cryptodev PMD and/or one compressdev PMD.
217 These QAT PMDs share the same underlying device and pci-mgmt code, but are
218 enumerated independently on their respective APIs and appear as independent
219 devices to applications.
223 Each VF can only be used by one DPDK process. It is not possible to share
224 the same VF across multiple processes, even if these processes are using
225 different acceleration services.
227 Conversely one DPDK process can use one or more QAT VFs and can expose both
228 cryptodev and compressdev instances on each of those VFs.
231 Available kernel drivers
232 ~~~~~~~~~~~~~~~~~~~~~~~~
234 Kernel drivers for each device are listed in the following table. Scroll right
235 to check that the driver and device supports the service you require.
238 .. _table_qat_pmds_drivers:
240 .. table:: QAT device generations, devices and drivers
242 +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
243 | Gen | Device | Driver/ver | Kernel Module | Pci Driver | PF Did | #PFs | VF Did | VFs/PF | cryptodev | compressdev |
244 +=====+==========+===============+===============+============+========+======+========+========+===========+=============+
245 | 1 | DH895xCC | linux/4.4+ | qat_dh895xcc | dh895xcc | 435 | 1 | 443 | 32 | Yes | No |
246 +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
247 | " | " | 01.org/4.2.0+ | " | " | " | " | " | " | Yes | No |
248 +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
249 | 2 | C62x | linux/4.5+ | qat_c62x | c6xx | 37c8 | 3 | 37c9 | 16 | Yes | No |
250 +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
251 | " | " | 01.org/4.2.0+ | " | " | " | " | " | " | Yes | Yes |
252 +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
253 | 2 | C3xxx | linux/4.5+ | qat_c3xxx | c3xxx | 19e2 | 1 | 19e3 | 16 | Yes | No |
254 +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
255 | " | " | 01.org/4.2.0+ | " | " | " | " | " | " | Yes | Yes |
256 +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
257 | 2 | D15xx | p | qat_d15xx | d15xx | 6f54 | 1 | 6f55 | 16 | Yes | No |
258 +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
259 | 3 | C4xxx | p | qat_c4xxx | c4xxx | 18a0 | 1 | 18a1 | 128 | Yes | No |
260 +-----+----------+---------------+---------------+------------+--------+------+--------+--------+-----------+-------------+
263 The ``Driver`` column indicates either the Linux kernel version in which
264 support for this device was introduced or a driver available on Intel's 01.org
265 website. There are both linux and 01.org kernel drivers available for some
266 devices. p = release pending.
268 If you are running on a kernel which includes a driver for your device, see
269 `Installation using kernel.org driver`_ below. Otherwise see
270 `Installation using 01.org QAT driver`_.
273 Installation using kernel.org driver
274 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
276 The examples below are based on the C62x device, if you have a different device
277 use the corresponding values in the above table.
279 In BIOS ensure that SRIOV is enabled and either:
282 * Enable VT-d and set ``"intel_iommu=on iommu=pt"`` in the grub file.
284 Check that the QAT driver is loaded on your system, by executing::
288 You should see the kernel module for your device listed, e.g.::
291 intel_qat 82336 1 qat_c62x
293 Next, you need to expose the Virtual Functions (VFs) using the sysfs file system.
295 First find the BDFs (Bus-Device-Function) of the physical functions (PFs) of
300 You should see output similar to::
302 1a:00.0 Co-processor: Intel Corporation Device 37c8
303 3d:00.0 Co-processor: Intel Corporation Device 37c8
304 3f:00.0 Co-processor: Intel Corporation Device 37c8
306 Enable the VFs for each PF by echoing the number of VFs per PF to the pci driver::
308 echo 16 > /sys/bus/pci/drivers/c6xx/0000:1a:00.0/sriov_numvfs
309 echo 16 > /sys/bus/pci/drivers/c6xx/0000:3d:00.0/sriov_numvfs
310 echo 16 > /sys/bus/pci/drivers/c6xx/0000:3f:00.0/sriov_numvfs
312 Check that the VFs are available for use. For example ``lspci -d:37c9`` should
313 list 48 VF devices available for a ``C62x`` device.
315 To complete the installation follow the instructions in
316 `Binding the available VFs to the DPDK UIO driver`_.
320 If the QAT kernel modules are not loaded and you see an error like ``Failed
321 to load MMP firmware qat_895xcc_mmp.bin`` in kernel logs, this may be as a
322 result of not using a distribution, but just updating the kernel directly.
324 Download firmware from the `kernel firmware repo
325 <http://git.kernel.org/cgit/linux/kernel/git/firmware/linux-firmware.git/tree/>`_.
327 Copy qat binaries to ``/lib/firmware``::
329 cp qat_895xcc.bin /lib/firmware
330 cp qat_895xcc_mmp.bin /lib/firmware
332 Change to your linux source root directory and start the qat kernel modules::
334 insmod ./drivers/crypto/qat/qat_common/intel_qat.ko
335 insmod ./drivers/crypto/qat/qat_dh895xcc/qat_dh895xcc.ko
340 If you see the following warning in ``/var/log/messages`` it can be ignored:
341 ``IOMMU should be enabled for SR-IOV to work correctly``.
344 Installation using 01.org QAT driver
345 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
347 Download the latest QuickAssist Technology Driver from `01.org
348 <https://01.org/packet-processing/intel%C2%AE-quickassist-technology-drivers-and-patches>`_.
349 Consult the *Getting Started Guide* at the same URL for further information.
351 The steps below assume you are:
353 * Building on a platform with one ``C62x`` device.
354 * Using package ``qat1.7.l.4.2.0-000xx.tar.gz``.
355 * On Fedora26 kernel ``4.11.11-300.fc26.x86_64``.
357 In the BIOS ensure that SRIOV is enabled and VT-d is disabled.
359 Uninstall any existing QAT driver, for example by running:
361 * ``./installer.sh uninstall`` in the directory where originally installed.
364 Build and install the SRIOV-enabled QAT driver::
369 # Copy the package to this location and unpack
370 tar zxof qat1.7.l.4.2.0-000xx.tar.gz
372 ./configure --enable-icp-sriov=host
375 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.
376 You can use ``lspci -d:37c9`` to confirm the presence of the 16 VF devices available per ``C62x`` PF.
378 Confirm the driver is correctly installed and is using firmware version 4.2.0::
380 cat /sys/kernel/debug/qat<your device type and bdf>/version/fw
383 Confirm the presence of 48 VF devices - 16 per PF::
388 To complete the installation - follow instructions in `Binding the available VFs to the DPDK UIO driver`_.
392 If using a later kernel and the build fails with an error relating to
393 ``strict_stroul`` not being available apply the following patch:
397 /QAT/QAT1.6/quickassist/utilities/downloader/Target_CoreLibs/uclo/include/linux/uclo_platform.h
398 + #if LINUX_VERSION_CODE >= KERNEL_VERSION(3,18,5)
399 + #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; if (kstrtoul((str), (base), (num))) printk("Error strtoull convert %s\n", str); }
401 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,38)
402 #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; if (strict_strtoull((str), (base), (num))) printk("Error strtoull convert %s\n", str); }
404 #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,25)
405 #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; strict_strtoll((str), (base), (num));}
407 #define STR_TO_64(str, base, num, endPtr) \
411 *(num) = -(simple_strtoull((str+1), &(endPtr), (base))); \
413 *(num) = simple_strtoull((str), &(endPtr), (base)); \
423 If the build fails due to missing header files you may need to do following::
425 sudo yum install zlib-devel
426 sudo yum install openssl-devel
427 sudo yum install libudev-devel
431 If the build or install fails due to mismatching kernel sources you may need to do the following::
433 sudo yum install kernel-headers-`uname -r`
434 sudo yum install kernel-src-`uname -r`
435 sudo yum install kernel-devel-`uname -r`
438 Binding the available VFs to the DPDK UIO driver
439 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
441 Unbind the VFs from the stock driver so they can be bound to the uio driver.
443 For an Intel(R) QuickAssist Technology DH895xCC device
444 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
446 The unbind command below assumes ``BDFs`` of ``03:01.00-03:04.07``, if your
447 VFs are different adjust the unbind command below::
449 for device in $(seq 1 4); do \
450 for fn in $(seq 0 7); do \
451 echo -n 0000:03:0${device}.${fn} > \
452 /sys/bus/pci/devices/0000\:03\:0${device}.${fn}/driver/unbind; \
456 For an Intel(R) QuickAssist Technology C62x device
457 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
459 The unbind command below assumes ``BDFs`` of ``1a:01.00-1a:02.07``,
460 ``3d:01.00-3d:02.07`` and ``3f:01.00-3f:02.07``, if your VFs are different
461 adjust the unbind command below::
463 for device in $(seq 1 2); do \
464 for fn in $(seq 0 7); do \
465 echo -n 0000:1a:0${device}.${fn} > \
466 /sys/bus/pci/devices/0000\:1a\:0${device}.${fn}/driver/unbind; \
468 echo -n 0000:3d:0${device}.${fn} > \
469 /sys/bus/pci/devices/0000\:3d\:0${device}.${fn}/driver/unbind; \
471 echo -n 0000:3f:0${device}.${fn} > \
472 /sys/bus/pci/devices/0000\:3f\:0${device}.${fn}/driver/unbind; \
476 For Intel(R) QuickAssist Technology C3xxx or D15xx device
477 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
479 The unbind command below assumes ``BDFs`` of ``01:01.00-01:02.07``, if your
480 VFs are different adjust the unbind command below::
482 for device in $(seq 1 2); do \
483 for fn in $(seq 0 7); do \
484 echo -n 0000:01:0${device}.${fn} > \
485 /sys/bus/pci/devices/0000\:01\:0${device}.${fn}/driver/unbind; \
489 Bind to the DPDK uio driver
490 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
492 Install the DPDK igb_uio driver, bind the VF PCI Device id to it and use lspci
493 to confirm the VF devices are now in use by igb_uio kernel driver,
494 e.g. for the C62x device::
496 cd to the top-level DPDK directory
498 insmod ./build/kmod/igb_uio.ko
499 echo "8086 37c9" > /sys/bus/pci/drivers/igb_uio/new_id
503 Another way to bind the VFs to the DPDK UIO driver is by using the
504 ``dpdk-devbind.py`` script::
506 cd to the top-level DPDK directory
507 ./usertools/dpdk-devbind.py -b igb_uio 0000:03:01.1
512 QAT crypto PMD can be tested by running the test application::
517 ./test -l1 -n1 -w <your qat bdf>
518 RTE>>cryptodev_qat_autotest
520 QAT compression PMD can be tested by running the test application::
523 sed -i 's,\(CONFIG_RTE_COMPRESSDEV_TEST\)=n,\1=y,' build/.config
526 ./test -l1 -n1 -w <your qat bdf>
527 RTE>>compressdev_autotest
533 There are 2 sets of trace available via the dynamic logging feature:
535 * pmd.qat_dp exposes trace on the data-path.
536 * pmd.qat_general exposes all other trace.
538 pmd.qat exposes both sets of traces.
539 They can be enabled using the log-level option (where 8=maximum log level) on
540 the process cmdline, e.g. using any of the following::
542 --log-level="pmd.qat_general,8"
543 --log-level="pmd.qat_dp,8"
544 --log-level="pmd.qat,8"
548 The global RTE_LOG_DP_LEVEL overrides data-path trace so must be set to
549 RTE_LOG_DEBUG to see all the trace. This variable is in config/rte_config.h
550 for meson build and config/common_base for gnu make.
551 Also the dynamic global log level overrides both sets of trace, so e.g. no
552 QAT trace would display in this case::
554 --log-level="7" --log-level="pmd.qat_general,8"