xref: /dpdk/doc/guides/compressdevs/qat_comp.rst (revision c96e9ca312d9b32637bbdcfbfc1bca93a8629faa)
1bb44fb6fSFiona Trahe..  SPDX-License-Identifier: BSD-3-Clause
2bb44fb6fSFiona Trahe    Copyright(c) 2018 Intel Corporation.
3bb44fb6fSFiona Trahe
4bb44fb6fSFiona TraheIntel(R) QuickAssist (QAT) Compression Poll Mode Driver
5bb44fb6fSFiona Trahe=======================================================
6bb44fb6fSFiona Trahe
7bb44fb6fSFiona TraheThe QAT compression PMD provides poll mode compression & decompression driver
8bb44fb6fSFiona Trahesupport for the following hardware accelerator devices:
9bb44fb6fSFiona Trahe
10*c96e9ca3SSivaramakrishnan Venkat* ``Intel QuickAssist Technology D15xx``
11*c96e9ca3SSivaramakrishnan Venkat* ``Intel QuickAssist Technology 200xx``
12*c96e9ca3SSivaramakrishnan Venkat* ``Intel QuickAssist Technology C4xxx``
13*c96e9ca3SSivaramakrishnan Venkat* ``Intel QuickAssist Technology 4xxx``
14bb44fb6fSFiona Trahe* ``Intel QuickAssist Technology C62x``
15bb44fb6fSFiona Trahe* ``Intel QuickAssist Technology C3xxx``
16e2e35849STomasz Jozwiak* ``Intel QuickAssist Technology DH895x``
17f925068aSCiara Power* ``Intel QuickAssist Technology 300xx``
18bb44fb6fSFiona Trahe
19bb44fb6fSFiona Trahe
20bb44fb6fSFiona TraheFeatures
21bb44fb6fSFiona Trahe--------
22bb44fb6fSFiona Trahe
23bb44fb6fSFiona TraheQAT compression PMD has support for:
24bb44fb6fSFiona Trahe
25bb44fb6fSFiona TraheCompression/Decompression algorithm:
26bb44fb6fSFiona Trahe
27a124830aSFiona Trahe    * DEFLATE - using Fixed and Dynamic Huffman encoding
28bb44fb6fSFiona Trahe
29bb44fb6fSFiona TraheWindow size support:
30bb44fb6fSFiona Trahe
31bb44fb6fSFiona Trahe    * 32K
32bb44fb6fSFiona Trahe
33bb44fb6fSFiona TraheChecksum generation:
34bb44fb6fSFiona Trahe
35bb44fb6fSFiona Trahe    * CRC32, Adler and combined checksum
36bb44fb6fSFiona Trahe
3782822753SAdam DybkowskiStateful operation:
3882822753SAdam Dybkowski
3982822753SAdam Dybkowski    * Decompression only
4082822753SAdam Dybkowski
41bb44fb6fSFiona TraheLimitations
42bb44fb6fSFiona Trahe-----------
43bb44fb6fSFiona Trahe
44bb44fb6fSFiona Trahe* Compressdev level 0, no compression, is not supported.
45026f21c0SFiona Trahe* Queue-pairs are thread-safe on Intel CPUs but Queues are not (that is, within a single
46026f21c0SFiona Trahe  queue-pair all enqueues to the TX queue must be done from one thread and all dequeues
47026f21c0SFiona Trahe  from the RX queue must be done from one thread, but enqueues and dequeues may be done
48026f21c0SFiona Trahe  in different threads.)
49d2054aadSFiona Trahe* No BSD support as BSD QAT kernel driver not available.
5082822753SAdam Dybkowski* Stateful compression is not supported.
51d2054aadSFiona Trahe
52bb44fb6fSFiona Trahe
53bb44fb6fSFiona TraheInstallation
54bb44fb6fSFiona Trahe------------
55bb44fb6fSFiona Trahe
56bb44fb6fSFiona TraheThe QAT compression PMD is built by default with a standard DPDK build.
57bb44fb6fSFiona Trahe
5859ad25feSFiona TraheIt depends on a QAT kernel driver, see :ref:`building_qat`.
59