xref: /dpdk/doc/guides/compressdevs/qat_comp.rst (revision 200bc52e5aa0d72e70464c9cd22b55cf536ed13c)
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
14
15Features
16--------
17
18QAT compression PMD has support for:
19
20Compression/Decompression algorithm:
21
22    * DEFLATE - using Fixed and Dynamic Huffman encoding
23
24Window size support:
25
26    * 32K
27
28Checksum generation:
29
30    * CRC32, Adler and combined checksum
31
32Limitations
33-----------
34
35* Compressdev level 0, no compression, is not supported.
36* Queue pairs are not thread-safe (that is, within a single queue pair, RX and TX from different lcores is not supported).
37* No BSD support as BSD QAT kernel driver not available.
38* When using Deflate dynamic huffman encoding for compression, the input size (op.src.length)
39  must be < CONFIG_RTE_PMD_QAT_COMP_IM_BUFFER_SIZE from the config file,
40  see :ref:`building_qat_config` for more details.
41
42
43Installation
44------------
45
46The QAT compression PMD is built by default with a standard DPDK build.
47
48It depends on a QAT kernel driver, see :ref:`building_qat`.
49