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 Limitations
  33 -----------
  34
  35 * Compressdev level 0, no compression, is not supported.
  36 * Queue pairs are not thread-safe (that is, within a single queue pair, RX and TX from different lcores is not supported).
  37 * No BSD support as BSD QAT kernel driver not available.
  38 * Number of segments in mbuf chains in the op must be <= RTE_PMD_QAT_COMP_SGL_MAX_SEGMENTS from the config file.
  39 * When using Deflate dynamic huffman encoding for compression, the input size (op.src.length)
  40   must be < CONFIG_RTE_PMD_QAT_COMP_IM_BUFFER_SIZE from the config file,
  41   see :ref:`building_qat_config` for more details.
  42
  43
  44 Installation
  45 ------------
  46
  47 The QAT compression PMD is built by default with a standard DPDK build.
  48
  49 It depends on a QAT kernel driver, see :ref:`building_qat`.