xref: /dpdk/doc/guides/cryptodevs/qat.rst (revision fb70b33b05bb28c822024ea6a789cc645e7d84ee)
1..  SPDX-License-Identifier: BSD-3-Clause
2    Copyright(c) 2015-2019 Intel Corporation.
3
4Intel(R) QuickAssist (QAT) Crypto Poll Mode Driver
5==================================================
6
7QAT documentation consists of three parts:
8
9* Details of the symmetric crypto service below.
10* Details of the `compression service <http://doc.dpdk.org/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.
14
15
16Symmetric Crypto Service on QAT
17-------------------------------
18
19The QAT crypto PMD provides poll mode crypto driver support for the following
20hardware accelerator devices:
21
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``
27
28
29Features
30~~~~~~~~
31
32The QAT PMD has support for:
33
34Cipher algorithms:
35
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_AES_XTS``
45* ``RTE_CRYPTO_CIPHER_SNOW3G_UEA2``
46* ``RTE_CRYPTO_CIPHER_NULL``
47* ``RTE_CRYPTO_CIPHER_KASUMI_F8``
48* ``RTE_CRYPTO_CIPHER_DES_CBC``
49* ``RTE_CRYPTO_CIPHER_AES_DOCSISBPI``
50* ``RTE_CRYPTO_CIPHER_DES_DOCSISBPI``
51* ``RTE_CRYPTO_CIPHER_ZUC_EEA3``
52
53Hash algorithms:
54
55* ``RTE_CRYPTO_AUTH_SHA1_HMAC``
56* ``RTE_CRYPTO_AUTH_SHA224_HMAC``
57* ``RTE_CRYPTO_AUTH_SHA256_HMAC``
58* ``RTE_CRYPTO_AUTH_SHA384_HMAC``
59* ``RTE_CRYPTO_AUTH_SHA512_HMAC``
60* ``RTE_CRYPTO_AUTH_AES_XCBC_MAC``
61* ``RTE_CRYPTO_AUTH_SNOW3G_UIA2``
62* ``RTE_CRYPTO_AUTH_MD5_HMAC``
63* ``RTE_CRYPTO_AUTH_NULL``
64* ``RTE_CRYPTO_AUTH_KASUMI_F9``
65* ``RTE_CRYPTO_AUTH_AES_GMAC``
66* ``RTE_CRYPTO_AUTH_ZUC_EIA3``
67* ``RTE_CRYPTO_AUTH_AES_CMAC``
68
69Supported AEAD algorithms:
70
71* ``RTE_CRYPTO_AEAD_AES_GCM``
72* ``RTE_CRYPTO_AEAD_AES_CCM``
73
74
75Limitations
76~~~~~~~~~~~
77
78* Only supports the session-oriented API implementation (session-less APIs are not supported).
79* SNOW 3G (UEA2), KASUMI (F8) and ZUC (EEA3) supported only if cipher length and offset fields are byte-multiple.
80* SNOW 3G (UIA2) and ZUC (EIA3) supported only if hash length and offset fields are byte-multiple.
81* No BSD support as BSD QAT kernel driver not available.
82* ZUC EEA3/EIA3 is not supported by dh895xcc devices
83* Maximum additional authenticated data (AAD) for GCM is 240 bytes long and must be passed to the device in a buffer rounded up to the nearest block-size multiple (x16) and padded with zeros.
84* Queue pairs are not thread-safe (that is, within a single queue pair, RX and TX from different lcores is not supported).
85
86Extra notes on KASUMI F9
87~~~~~~~~~~~~~~~~~~~~~~~~
88
89When using KASUMI F9 authentication algorithm, the input buffer must be
90constructed 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),
93FRESH (4 bytes), MESSAGE and DIRECTION (1 bit) concatenated. After the DIRECTION
94bit, a single '1' bit is appended, followed by between 0 and 7 '0' bits, so that
95the total length of the buffer is multiple of 8 bits. Note that the actual
96message can be any length, specified in bits.
97
98Once this buffer is passed this way, when creating the crypto operation,
99length of data to authenticate "op.sym.auth.data.length" must be the length
100of all the items described above, including the padding at the end.
101Also, offset of data to authenticate "op.sym.auth.data.offset"
102must be such that points at the start of the COUNT bytes.
103
104Asymmetric Crypto Service on QAT
105--------------------------------
106
107The QAT Asym PMD has support for:
108
109* ``Modular exponentiation``
110
111Limitations
112~~~~~~~~~~~
113
114.. _building_qat:
115
116Building PMDs on QAT
117--------------------
118
119A QAT device can host multiple acceleration services:
120
121* symmetric cryptography
122* data compression
123* asymmetric cryptography
124
125These services are provided to DPDK applications via PMDs which register to
126implement the corresponding cryptodev and compressdev APIs. The PMDs use
127common QAT driver code which manages the QAT PCI device. They also depend on a
128QAT kernel driver being installed on the platform, see :ref:`qat_kernel` below.
129
130
131Configuring and Building the DPDK QAT PMDs
132~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
133
134
135Further information on configuring, building and installing DPDK is described
136`here <http://doc.dpdk.org/guides/linux_gsg/build_dpdk.html>`_.
137
138
139Quick instructions for QAT cryptodev PMD are as follows:
140
141.. code-block:: console
142
143	cd to the top-level DPDK directory
144	make defconfig
145	sed -i 's,\(CONFIG_RTE_LIBRTE_PMD_QAT_SYM\)=n,\1=y,' build/.config
146	make
147
148Quick instructions for QAT compressdev PMD are as follows:
149
150.. code-block:: console
151
152	cd to the top-level DPDK directory
153	make defconfig
154	make
155
156
157.. _building_qat_config:
158
159Build Configuration
160~~~~~~~~~~~~~~~~~~~
161
162These are the build configuration options affecting QAT, and their default values:
163
164.. code-block:: console
165
166	CONFIG_RTE_LIBRTE_PMD_QAT=y
167	CONFIG_RTE_LIBRTE_PMD_QAT_SYM=n
168	CONFIG_RTE_PMD_QAT_MAX_PCI_DEVICES=48
169	CONFIG_RTE_PMD_QAT_COMP_SGL_MAX_SEGMENTS=16
170	CONFIG_RTE_PMD_QAT_COMP_IM_BUFFER_SIZE=65536
171
172CONFIG_RTE_LIBRTE_PMD_QAT must be enabled for any QAT PMD to be built.
173
174The QAT cryptodev PMD has an external dependency on libcrypto, so is not
175built by default. CONFIG_RTE_LIBRTE_PMD_QAT_SYM should be enabled to build it.
176
177The QAT compressdev PMD has no external dependencies, so needs no configuration
178options and is built by default.
179
180The number of VFs per PF varies - see table below. If multiple QAT packages are
181installed on a platform then CONFIG_RTE_PMD_QAT_MAX_PCI_DEVICES should be
182adjusted to the number of VFs which the QAT common code will need to handle.
183Note, there are separate config items for max cryptodevs CONFIG_RTE_CRYPTO_MAX_DEVS
184and max compressdevs CONFIG_RTE_COMPRESS_MAX_DEVS, if necessary these should be
185adjusted to handle the total of QAT and other devices which the process will use.
186
187QAT allocates internal structures to handle SGLs. For the compression service
188CONFIG_RTE_PMD_QAT_COMP_SGL_MAX_SEGMENTS can be changed if more segments are needed.
189An extra (max_inflight_ops x 16) bytes per queue_pair will be used for every increment.
190
191QAT compression PMD needs intermediate buffers to support Deflate compression
192with Dynamic Huffman encoding. CONFIG_RTE_PMD_QAT_COMP_IM_BUFFER_SIZE
193specifies the size of a single buffer, the PMD will allocate a multiple of these,
194plus some extra space for associated meta-data. For GEN2 devices, 20 buffers are
195allocated while for GEN1 devices, 12 buffers are allocated, plus 1472 bytes overhead.
196
197.. Note::
198
199	If the compressed output of a Deflate operation using Dynamic Huffman
200        Encoding is too big to fit in an intermediate buffer, then the
201	operation will fall back to fixed compression rather than failing the operation.
202	To avoid this less performant case, applications should configure
203	the intermediate buffer size to be larger than the expected input data size
204	(compressed output size is usually unknown, so the only option is to make
205	larger than the input size).
206
207
208Device and driver naming
209~~~~~~~~~~~~~~~~~~~~~~~~
210
211* The qat cryptodev driver name is "crypto_qat".
212  The "rte_cryptodev_devices_get()" returns the devices exposed by this driver.
213
214* Each qat crypto device has a unique name, in format
215  "<pci bdf>_<service>", e.g. "0000:41:01.0_qat_sym".
216  This name can be passed to "rte_cryptodev_get_dev_id()" to get the device_id.
217
218.. Note::
219
220	The qat crypto driver name is passed to the dpdk-test-crypto-perf tool in the "-devtype" parameter.
221
222	The qat crypto device name is in the format of the slave parameter passed to the crypto scheduler.
223
224* The qat compressdev driver name is "compress_qat".
225  The rte_compressdev_devices_get() returns the devices exposed by this driver.
226
227* Each qat compression device has a unique name, in format
228  <pci bdf>_<service>, e.g. "0000:41:01.0_qat_comp".
229  This name can be passed to rte_compressdev_get_dev_id() to get the device_id.
230
231.. _qat_kernel:
232
233Dependency on the QAT kernel driver
234~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
235
236To use QAT an SRIOV-enabled QAT kernel driver is required. The VF
237devices created and initialised by this driver will be used by the QAT PMDs.
238
239Instructions for installation are below, but first an explanation of the
240relationships between the PF/VF devices and the PMDs visible to
241DPDK applications.
242
243Each QuickAssist PF device exposes a number of VF devices. Each VF device can
244enable one cryptodev PMD and/or one compressdev PMD.
245These QAT PMDs share the same underlying device and pci-mgmt code, but are
246enumerated independently on their respective APIs and appear as independent
247devices to applications.
248
249.. Note::
250
251   Each VF can only be used by one DPDK process. It is not possible to share
252   the same VF across multiple processes, even if these processes are using
253   different acceleration services.
254
255   Conversely one DPDK process can use one or more QAT VFs and can expose both
256   cryptodev and compressdev instances on each of those VFs.
257
258
259Available kernel drivers
260~~~~~~~~~~~~~~~~~~~~~~~~
261
262Kernel drivers for each device for each service are listed in the following table. (Scroll right
263to see the full table)
264
265
266.. _table_qat_pmds_drivers:
267
268.. table:: QAT device generations, devices and drivers
269
270   +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
271   | S   | A   | C   | Gen | Device   | Driver/ver    | Kernel Module | Pci Driver | PF Did | #PFs | VF Did | VFs/PF |
272   +=====+=====+=====+=====+==========+===============+===============+============+========+======+========+========+
273   | Yes | No  | No  | 1   | DH895xCC | linux/4.4+    | qat_dh895xcc  | dh895xcc   | 435    | 1    | 443    | 32     |
274   +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
275   | Yes | No  | No  | "   | "        | 01.org/4.2.0+ | "             | "          | "      | "    | "      | "      |
276   +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
277   | Yes | No  | Yes | "   | "        | 01.org/4.3.0+ | "             | "          | "      | "    | "      | "      |
278   +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
279   | Yes | No  | No  | 2   | C62x     | linux/4.5+    | qat_c62x      | c6xx       | 37c8   | 3    | 37c9   | 16     |
280   +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
281   | Yes | No  | Yes | "   | "        | 01.org/4.2.0+ | "             | "          | "      | "    | "      | "      |
282   +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
283   | Yes | No  | No  | 2   | C3xxx    | linux/4.5+    | qat_c3xxx     | c3xxx      | 19e2   | 1    | 19e3   | 16     |
284   +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
285   | Yes | No  | Yes | "   | "        | 01.org/4.2.0+ | "             | "          | "      | "    | "      | "      |
286   +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
287   | Yes | No  | No  | 2   | D15xx    | p             | qat_d15xx     | d15xx      | 6f54   | 1    | 6f55   | 16     |
288   +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
289   | Yes | No  | No  | 3   | C4xxx    | p             | qat_c4xxx     | c4xxx      | 18a0   | 1    | 18a1   | 128    |
290   +-----+-----+-----+-----+----------+---------------+---------------+------------+--------+------+--------+--------+
291
292The first 3 columns indicate the service:
293
294* S = Symmetric crypto service (via cryptodev API)
295* A = Asymmetric crypto service  (via cryptodev API)
296* C = Compression service (via compressdev API)
297
298The ``Driver`` column indicates either the Linux kernel version in which
299support for this device was introduced or a driver available on Intel's 01.org
300website. There are both linux in-tree and 01.org kernel drivers available for some
301devices. p = release pending.
302
303If you are running on a kernel which includes a driver for your device, see
304`Installation using kernel.org driver`_ below. Otherwise see
305`Installation using 01.org QAT driver`_.
306
307
308Installation using kernel.org driver
309~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
310
311The examples below are based on the C62x device, if you have a different device
312use the corresponding values in the above table.
313
314In BIOS ensure that SRIOV is enabled and either:
315
316* Disable VT-d or
317* Enable VT-d and set ``"intel_iommu=on iommu=pt"`` in the grub file.
318
319Check that the QAT driver is loaded on your system, by executing::
320
321    lsmod | grep qa
322
323You should see the kernel module for your device listed, e.g.::
324
325    qat_c62x               5626  0
326    intel_qat              82336  1 qat_c62x
327
328Next, you need to expose the Virtual Functions (VFs) using the sysfs file system.
329
330First find the BDFs (Bus-Device-Function) of the physical functions (PFs) of
331your device, e.g.::
332
333    lspci -d:37c8
334
335You should see output similar to::
336
337    1a:00.0 Co-processor: Intel Corporation Device 37c8
338    3d:00.0 Co-processor: Intel Corporation Device 37c8
339    3f:00.0 Co-processor: Intel Corporation Device 37c8
340
341Enable the VFs for each PF by echoing the number of VFs per PF to the pci driver::
342
343     echo 16 > /sys/bus/pci/drivers/c6xx/0000:1a:00.0/sriov_numvfs
344     echo 16 > /sys/bus/pci/drivers/c6xx/0000:3d:00.0/sriov_numvfs
345     echo 16 > /sys/bus/pci/drivers/c6xx/0000:3f:00.0/sriov_numvfs
346
347Check that the VFs are available for use. For example ``lspci -d:37c9`` should
348list 48 VF devices available for a ``C62x`` device.
349
350To complete the installation follow the instructions in
351`Binding the available VFs to the DPDK UIO driver`_.
352
353.. Note::
354
355   If the QAT kernel modules are not loaded and you see an error like ``Failed
356   to load MMP firmware qat_895xcc_mmp.bin`` in kernel logs, this may be as a
357   result of not using a distribution, but just updating the kernel directly.
358
359   Download firmware from the `kernel firmware repo
360   <http://git.kernel.org/cgit/linux/kernel/git/firmware/linux-firmware.git/tree/>`_.
361
362   Copy qat binaries to ``/lib/firmware``::
363
364      cp qat_895xcc.bin /lib/firmware
365      cp qat_895xcc_mmp.bin /lib/firmware
366
367   Change to your linux source root directory and start the qat kernel modules::
368
369      insmod ./drivers/crypto/qat/qat_common/intel_qat.ko
370      insmod ./drivers/crypto/qat/qat_dh895xcc/qat_dh895xcc.ko
371
372
373.. Note::
374
375   If you see the following warning in ``/var/log/messages`` it can be ignored:
376   ``IOMMU should be enabled for SR-IOV to work correctly``.
377
378
379Installation using 01.org QAT driver
380~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
381
382Download the latest QuickAssist Technology Driver from `01.org
383<https://01.org/packet-processing/intel%C2%AE-quickassist-technology-drivers-and-patches>`_.
384Consult the *Getting Started Guide* at the same URL for further information.
385
386The steps below assume you are:
387
388* Building on a platform with one ``C62x`` device.
389* Using package ``qat1.7.l.4.2.0-000xx.tar.gz``.
390* On Fedora26 kernel ``4.11.11-300.fc26.x86_64``.
391
392In the BIOS ensure that SRIOV is enabled and VT-d is disabled.
393
394Uninstall any existing QAT driver, for example by running:
395
396* ``./installer.sh uninstall`` in the directory where originally installed.
397
398
399Build and install the SRIOV-enabled QAT driver::
400
401    mkdir /QAT
402    cd /QAT
403
404    # Copy the package to this location and unpack
405    tar zxof qat1.7.l.4.2.0-000xx.tar.gz
406
407    ./configure --enable-icp-sriov=host
408    make install
409
410You 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.
411You can use ``lspci -d:37c9`` to confirm the presence of the 16 VF devices available per ``C62x`` PF.
412
413Confirm the driver is correctly installed and is using firmware version 4.2.0::
414
415    cat /sys/kernel/debug/qat<your device type and bdf>/version/fw
416
417
418Confirm the presence of 48 VF devices - 16 per PF::
419
420    lspci -d:37c9
421
422
423To complete the installation - follow instructions in `Binding the available VFs to the DPDK UIO driver`_.
424
425.. Note::
426
427   If using a later kernel and the build fails with an error relating to
428   ``strict_stroul`` not being available apply the following patch:
429
430   .. code-block:: diff
431
432      /QAT/QAT1.6/quickassist/utilities/downloader/Target_CoreLibs/uclo/include/linux/uclo_platform.h
433      + #if LINUX_VERSION_CODE >= KERNEL_VERSION(3,18,5)
434      + #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; if (kstrtoul((str), (base), (num))) printk("Error strtoull convert %s\n", str); }
435      + #else
436      #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,38)
437      #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; if (strict_strtoull((str), (base), (num))) printk("Error strtoull convert %s\n", str); }
438      #else
439      #if LINUX_VERSION_CODE >= KERNEL_VERSION(2,6,25)
440      #define STR_TO_64(str, base, num, endPtr) {endPtr=NULL; strict_strtoll((str), (base), (num));}
441      #else
442      #define STR_TO_64(str, base, num, endPtr)                                 \
443           do {                                                               \
444                 if (str[0] == '-')                                           \
445                 {                                                            \
446                      *(num) = -(simple_strtoull((str+1), &(endPtr), (base))); \
447                 }else {                                                      \
448                      *(num) = simple_strtoull((str), &(endPtr), (base));      \
449                 }                                                            \
450           } while(0)
451      + #endif
452      #endif
453      #endif
454
455
456.. Note::
457
458   If the build fails due to missing header files you may need to do following::
459
460      sudo yum install zlib-devel
461      sudo yum install openssl-devel
462      sudo yum install libudev-devel
463
464.. Note::
465
466   If the build or install fails due to mismatching kernel sources you may need to do the following::
467
468      sudo yum install kernel-headers-`uname -r`
469      sudo yum install kernel-src-`uname -r`
470      sudo yum install kernel-devel-`uname -r`
471
472
473Binding the available VFs to the DPDK UIO driver
474~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
475
476Unbind the VFs from the stock driver so they can be bound to the uio driver.
477
478For an Intel(R) QuickAssist Technology DH895xCC device
479^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
480
481The unbind command below assumes ``BDFs`` of ``03:01.00-03:04.07``, if your
482VFs are different adjust the unbind command below::
483
484    for device in $(seq 1 4); do \
485        for fn in $(seq 0 7); do \
486            echo -n 0000:03:0${device}.${fn} > \
487            /sys/bus/pci/devices/0000\:03\:0${device}.${fn}/driver/unbind; \
488        done; \
489    done
490
491For an Intel(R) QuickAssist Technology C62x device
492^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
493
494The unbind command below assumes ``BDFs`` of ``1a:01.00-1a:02.07``,
495``3d:01.00-3d:02.07`` and ``3f:01.00-3f:02.07``, if your VFs are different
496adjust the unbind command below::
497
498    for device in $(seq 1 2); do \
499        for fn in $(seq 0 7); do \
500            echo -n 0000:1a:0${device}.${fn} > \
501            /sys/bus/pci/devices/0000\:1a\:0${device}.${fn}/driver/unbind; \
502
503            echo -n 0000:3d:0${device}.${fn} > \
504            /sys/bus/pci/devices/0000\:3d\:0${device}.${fn}/driver/unbind; \
505
506            echo -n 0000:3f:0${device}.${fn} > \
507            /sys/bus/pci/devices/0000\:3f\:0${device}.${fn}/driver/unbind; \
508        done; \
509    done
510
511For Intel(R) QuickAssist Technology C3xxx or D15xx device
512^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
513
514The unbind command below assumes ``BDFs`` of ``01:01.00-01:02.07``, if your
515VFs are different adjust the unbind command below::
516
517    for device in $(seq 1 2); do \
518        for fn in $(seq 0 7); do \
519            echo -n 0000:01:0${device}.${fn} > \
520            /sys/bus/pci/devices/0000\:01\:0${device}.${fn}/driver/unbind; \
521        done; \
522    done
523
524Bind to the DPDK uio driver
525^^^^^^^^^^^^^^^^^^^^^^^^^^^
526
527Install the DPDK igb_uio driver, bind the VF PCI Device id to it and use lspci
528to confirm the VF devices are now in use by igb_uio kernel driver,
529e.g. for the C62x device::
530
531    cd to the top-level DPDK directory
532    modprobe uio
533    insmod ./build/kmod/igb_uio.ko
534    echo "8086 37c9" > /sys/bus/pci/drivers/igb_uio/new_id
535    lspci -vvd:37c9
536
537
538Another way to bind the VFs to the DPDK UIO driver is by using the
539``dpdk-devbind.py`` script::
540
541    cd to the top-level DPDK directory
542    ./usertools/dpdk-devbind.py -b igb_uio 0000:03:01.1
543
544Testing
545~~~~~~~
546
547QAT crypto PMD can be tested by running the test application::
548
549    make defconfig
550    make -j
551    cd ./build/app
552    ./test -l1 -n1 -w <your qat bdf>
553    RTE>>cryptodev_qat_autotest
554
555QAT compression PMD can be tested by running the test application::
556
557    make defconfig
558    sed -i 's,\(CONFIG_RTE_COMPRESSDEV_TEST\)=n,\1=y,' build/.config
559    make -j
560    cd ./build/app
561    ./test -l1 -n1 -w <your qat bdf>
562    RTE>>compressdev_autotest
563
564
565Debugging
566~~~~~~~~~
567
568There are 2 sets of trace available via the dynamic logging feature:
569
570* pmd.qat_dp exposes trace on the data-path.
571* pmd.qat_general exposes all other trace.
572
573pmd.qat exposes both sets of traces.
574They can be enabled using the log-level option (where 8=maximum log level) on
575the process cmdline, e.g. using any of the following::
576
577    --log-level="pmd.qat_general,8"
578    --log-level="pmd.qat_dp,8"
579    --log-level="pmd.qat,8"
580
581.. Note::
582
583    The global RTE_LOG_DP_LEVEL overrides data-path trace so must be set to
584    RTE_LOG_DEBUG to see all the trace. This variable is in config/rte_config.h
585    for meson build and config/common_base for gnu make.
586    Also the dynamic global log level overrides both sets of trace, so e.g. no
587    QAT trace would display in this case::
588
589	--log-level="7" --log-level="pmd.qat_general,8"
590