numam-dpdk/doc/guides/compressdevs/qat_comp.rst

..  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

Stateful operation:

    * Decompression only

Limitations
-----------

* Compressdev level 0, no compression, is not supported.
* Queue-pairs are thread-safe on Intel CPUs but Queues are not (that is, within a single
  queue-pair all enqueues to the TX queue must be done from one thread and all dequeues
  from the RX queue must be done from one thread, but enqueues and dequeues may be done
  in different threads.)
* No BSD support as BSD QAT kernel driver not available.
* Stateful compression is not supported.


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`.
doc: add QAT compression guide Extend QAT guide to cover crypto and compression and common information, particularly about kernel driver dependency. Update release note. Update compression feature list for qat. Signed-off-by: Fiona Trahe <fiona.trahe@intel.com> 2018-07-13 02:28:25 +00:00			`.. 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``
compress/qat: add compression on DH895x This patch enables compression on DH895x HW series and updates supported hardware accelerator devices list. Signed-off-by: Tomasz Jozwiak <tomaszx.jozwiak@intel.com> Acked-by: Fiona Trahe <fiona.trahe@intel.com> 2018-12-21 09:15:22 +00:00			* ``Intel QuickAssist Technology DH895x``
doc: add QAT compression guide Extend QAT guide to cover crypto and compression and common information, particularly about kernel driver dependency. Update release note. Update compression feature list for qat. Signed-off-by: Fiona Trahe <fiona.trahe@intel.com> 2018-07-13 02:28:25 +00:00

			`Features`
			`--------`

			`QAT compression PMD has support for:`

			`Compression/Decompression algorithm:`

compress/qat: enable dynamic huffman encoding Enable dynamic huffman encoding in the QAT comp PMD. Signed-off-by: Tomasz Jozwiak <tomaszx.jozwiak@intel.com> Signed-off-by: Fiona Trahe <fiona.trahe@intel.com> Acked-by: Arek Kusztal <arkadiuszx.kusztal@intel.com> 2018-10-26 18:18:30 +00:00			`* DEFLATE - using Fixed and Dynamic Huffman encoding`
doc: add QAT compression guide Extend QAT guide to cover crypto and compression and common information, particularly about kernel driver dependency. Update release note. Update compression feature list for qat. Signed-off-by: Fiona Trahe <fiona.trahe@intel.com> 2018-07-13 02:28:25 +00:00
			`Window size support:`

			`* 32K`

			`Checksum generation:`

			`* CRC32, Adler and combined checksum`

compress/qat: add stateful decompression This patch adds the stateful decompression feature to the DPDK QAT PMD. Signed-off-by: Adam Dybkowski <adamx.dybkowski@intel.com> Acked-by: Fiona Trahe <fiona.trahe@intel.com> 2019-09-20 20:06:27 +00:00			`Stateful operation:`

			`* Decompression only`

doc: add QAT compression guide Extend QAT guide to cover crypto and compression and common information, particularly about kernel driver dependency. Update release note. Update compression feature list for qat. Signed-off-by: Fiona Trahe <fiona.trahe@intel.com> 2018-07-13 02:28:25 +00:00			`Limitations`
			`-----------`

			`* Compressdev level 0, no compression, is not supported.`
common/qat: support dual threads for enqueue/dequeue Remove the limitation whereby enqueue and dequeue must be done in same thread. The inflight calculation is reworked to be thread-safe for 2 threads - note this is not general multi-thread support, i.e all enqueues to a qp must still be done in one thread and all dequeues must be done in one thread, but enqueues and dequeues may be in separate threads. Documentation updated. Signed-off-by: Fiona Trahe <fiona.trahe@intel.com> Signed-off-by: Arek Kusztal <arkadiuszx.kusztal@intel.com> 2020-01-15 14:32:10 +00:00			`* Queue-pairs are thread-safe on Intel CPUs but Queues are not (that is, within a single`
			`queue-pair all enqueues to the TX queue must be done from one thread and all dequeues`
			`from the RX queue must be done from one thread, but enqueues and dequeues may be done`
			`in different threads.)`
doc: add limitations to qat compressdev guide Add two missing limitations to QAT compressdev documentation. Signed-off-by: Fiona Trahe <fiona.trahe@intel.com> Acked-by: Tomasz Jozwiak <tomaszx.jozwiak@intel.com> 2018-08-10 14:10:48 +00:00			`* No BSD support as BSD QAT kernel driver not available.`
compress/qat: add stateful decompression This patch adds the stateful decompression feature to the DPDK QAT PMD. Signed-off-by: Adam Dybkowski <adamx.dybkowski@intel.com> Acked-by: Fiona Trahe <fiona.trahe@intel.com> 2019-09-20 20:06:27 +00:00			`* Stateful compression is not supported.`
doc: add limitations to qat compressdev guide Add two missing limitations to QAT compressdev documentation. Signed-off-by: Fiona Trahe <fiona.trahe@intel.com> Acked-by: Tomasz Jozwiak <tomaszx.jozwiak@intel.com> 2018-08-10 14:10:48 +00:00
doc: add QAT compression guide Extend QAT guide to cover crypto and compression and common information, particularly about kernel driver dependency. Update release note. Update compression feature list for qat. Signed-off-by: Fiona Trahe <fiona.trahe@intel.com> 2018-07-13 02:28:25 +00:00
			`Installation`
			`------------`

			`The QAT compression PMD is built by default with a standard DPDK build.`

doc: add overview of qat guide Add overview of QAT doc sections and link between them. Indent to next level all sections within the crypto and common sections. Signed-off-by: Fiona Trahe <fiona.trahe@intel.com> Acked-by: Tomasz Jozwiak <tomaszx.jozwiak@intel.com> 2018-08-10 14:10:51 +00:00			It depends on a QAT kernel driver, see :ref:`building_qat`.