app/testpmd: add flow table management
[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 * ``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 Stateful operation:
33
34     * Decompression only
35
36 Limitations
37 -----------
38
39 * Compressdev level 0, no compression, is not supported.
40 * Queue-pairs are thread-safe on Intel CPUs but Queues are not (that is, within a single
41   queue-pair all enqueues to the TX queue must be done from one thread and all dequeues
42   from the RX queue must be done from one thread, but enqueues and dequeues may be done
43   in different threads.)
44 * No BSD support as BSD QAT kernel driver not available.
45 * Stateful compression is not supported.
46
47
48 Installation
49 ------------
50
51 The QAT compression PMD is built by default with a standard DPDK build.
52
53 It depends on a QAT kernel driver, see :ref:`building_qat`.