567a1fc806301503ccec396607d2fd7caaba3f45
[dpdk.git] / 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 * ``Intel QuickAssist Technology DH895x``
13
14
15 Features
16 --------
17
18 QAT compression PMD has support for:
19
20 Compression/Decompression algorithm:
21
22     * DEFLATE - using Fixed and Dynamic Huffman encoding
23
24 Window size support:
25
26     * 32K
27
28 Checksum generation:
29
30     * CRC32, Adler and combined checksum
31
32 Limitations
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
39
40 Installation
41 ------------
42
43 The QAT compression PMD is built by default with a standard DPDK build.
44
45 It depends on a QAT kernel driver, see :ref:`building_qat`.