xref: /dpdk/doc/guides/compressdevs/qat_comp.rst (revision e9fd1ebf981f361844aea9ec94e17f4bda5e1479)
1..  SPDX-License-Identifier: BSD-3-Clause
2    Copyright(c) 2018 Intel Corporation.
3
4Intel(R) QuickAssist (QAT) Compression Poll Mode Driver
5=======================================================
6
7The QAT compression PMD provides poll mode compression & decompression driver
8support for the following hardware accelerator devices:
9
10* ``Intel QuickAssist Technology C62x``
11* ``Intel QuickAssist Technology C3xxx``
12* ``Intel QuickAssist Technology DH895x``
13* ``Intel QuickAssist Technology 300xx``
14
15
16Features
17--------
18
19QAT compression PMD has support for:
20
21Compression/Decompression algorithm:
22
23    * DEFLATE - using Fixed and Dynamic Huffman encoding
24
25Window size support:
26
27    * 32K
28
29Checksum generation:
30
31    * CRC32, Adler and combined checksum
32
33Stateful operation:
34
35    * Decompression only
36
37Limitations
38-----------
39
40* Compressdev level 0, no compression, is not supported.
41* Queue-pairs are thread-safe on Intel CPUs but Queues are not (that is, within a single
42  queue-pair all enqueues to the TX queue must be done from one thread and all dequeues
43  from the RX queue must be done from one thread, but enqueues and dequeues may be done
44  in different threads.)
45* No BSD support as BSD QAT kernel driver not available.
46* Stateful compression is not supported.
47
48
49Installation
50------------
51
52The QAT compression PMD is built by default with a standard DPDK build.
53
54It depends on a QAT kernel driver, see :ref:`building_qat`.
55