diff options
Diffstat (limited to 'src/seastar/dpdk/doc/guides/compressdevs/qat_comp.rst')
| -rw-r--r-- | src/seastar/dpdk/doc/guides/compressdevs/qat_comp.rst | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/src/seastar/dpdk/doc/guides/compressdevs/qat_comp.rst b/src/seastar/dpdk/doc/guides/compressdevs/qat_comp.rst new file mode 100644 index 000000000..6f583a460 --- /dev/null +++ b/src/seastar/dpdk/doc/guides/compressdevs/qat_comp.rst @@ -0,0 +1,48 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2018 Intel Corporation. + +Intel(R) QuickAssist (QAT) Compression Poll Mode Driver +======================================================= + +The QAT compression PMD provides poll mode compression & decompression driver +support for the following hardware accelerator devices: + +* ``Intel QuickAssist Technology C62x`` +* ``Intel QuickAssist Technology C3xxx`` +* ``Intel QuickAssist Technology DH895x`` + + +Features +-------- + +QAT compression PMD has support for: + +Compression/Decompression algorithm: + + * DEFLATE - using Fixed and Dynamic Huffman encoding + +Window size support: + + * 32K + +Checksum generation: + + * CRC32, Adler and combined checksum + +Limitations +----------- + +* Compressdev level 0, no compression, is not supported. +* Queue pairs are not thread-safe (that is, within a single queue pair, RX and TX from different lcores is not supported). +* No BSD support as BSD QAT kernel driver not available. +* When using Deflate dynamic huffman encoding for compression, the input size (op.src.length) + must be < CONFIG_RTE_PMD_QAT_COMP_IM_BUFFER_SIZE from the config file, + see :ref:`building_qat_config` for more details. + + +Installation +------------ + +The QAT compression PMD is built by default with a standard DPDK build. + +It depends on a QAT kernel driver, see :ref:`building_qat`. |