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