doc: add QAT compression guide
[dpdk.git] / doc / guides / compressdevs / qat_comp.rst
1 ..  SPDX-License-Identifier: BSD-3-Clause
2     Copyright(c) 2018 Intel Corporation.
3
4 Intel(R) QuickAssist (QAT) Compression Poll Mode Driver
5 =======================================================
6
7 The QAT compression PMD provides poll mode compression & decompression driver
8 support for the following hardware accelerator devices:
9
10 * ``Intel QuickAssist Technology C62x``
11 * ``Intel QuickAssist Technology C3xxx``
12
13
14 Features
15 --------
16
17 QAT compression PMD has support for:
18
19 Compression/Decompression algorithm:
20
21     * DEFLATE
22
23 Huffman code type:
24
25     * FIXED
26
27 Window size support:
28
29     * 32K
30
31 Checksum generation:
32
33     * CRC32, Adler and combined checksum
34
35 Limitations
36 -----------
37
38 * Chained mbufs are not yet supported, therefore max data size which can be passed to the PMD in a single mbuf is 64K - 1. If data is larger than this it will need to be split up and sent as multiple operations.
39
40 * Compressdev level 0, no compression, is not supported.
41
42 * Dynamic Huffman encoding is not yet supported.
43
44 Installation
45 ------------
46
47 The QAT compression PMD is built by default with a standard DPDK build.
48
49 It depends on a QAT kernel driver, see :ref:`qat_kernel_installation`.