New upstream version 18.11-rc1
[deb_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 - using Fixed and Dynamic Huffman encoding
22
23 Window size support:
24
25     * 32K
26
27 Checksum generation:
28
29     * CRC32, Adler and combined checksum
30
31 Limitations
32 -----------
33
34 * Compressdev level 0, no compression, is not supported.
35 * Queue pairs are not thread-safe (that is, within a single queue pair, RX and TX from different lcores is not supported).
36 * No BSD support as BSD QAT kernel driver not available.
37
38
39 Installation
40 ------------
41
42 The QAT compression PMD is built by default with a standard DPDK build.
43
44 It depends on a QAT kernel driver, see :ref:`building_qat`.