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 D15xx`` 11* ``Intel QuickAssist Technology 200xx`` 12* ``Intel QuickAssist Technology C4xxx`` 13* ``Intel QuickAssist Technology 4xxx`` 14* ``Intel QuickAssist Technology C62x`` 15* ``Intel QuickAssist Technology C3xxx`` 16* ``Intel QuickAssist Technology DH895x`` 17* ``Intel QuickAssist Technology 300xx`` 18 19 20Features 21-------- 22 23QAT compression PMD has support for: 24 25Compression/Decompression algorithm: 26 27 * DEFLATE - using Fixed and Dynamic Huffman encoding 28 29Window size support: 30 31 * 32K 32 33Checksum generation: 34 35 * CRC32, Adler and combined checksum 36 37Stateful operation: 38 39 * Decompression only 40 41Limitations 42----------- 43 44* Compressdev level 0, no compression, is not supported. 45* Queue-pairs are thread-safe on Intel CPUs but Queues are not (that is, within a single 46 queue-pair all enqueues to the TX queue must be done from one thread and all dequeues 47 from the RX queue must be done from one thread, but enqueues and dequeues may be done 48 in different threads.) 49* No BSD support as BSD QAT kernel driver not available. 50* Stateful compression is not supported. 51 52 53Installation 54------------ 55 56The QAT compression PMD is built by default with a standard DPDK build. 57 58It depends on a QAT kernel driver, see :ref:`building_qat`. 59