[dpdk-dev] [PATCH 4/4] doc/guides: add stateful feature in QAT

[Akhil Goyal]

Hi Adam,
> 
> This patch adds the information about stateful decompression
> feature in QAT PMD.
> 
Could you please squash this documentation patch with the patch where the
Functionality is added. If multiple functionality/patches split this patch and merge
In the relevant feature patch.

> Signed-off-by: Adam Dybkowski <adamx.dybkowski at intel.com>
> ---
>  doc/guides/compressdevs/features/default.ini | 37 ++++++++++----------
>  doc/guides/compressdevs/features/qat.ini     | 21 +++++------
>  doc/guides/compressdevs/qat_comp.rst         |  5 +++
>  doc/guides/rel_notes/release_19_11.rst       |  4 +++
>  4 files changed, 39 insertions(+), 28 deletions(-)
> 
> diff --git a/doc/guides/compressdevs/features/default.ini
> b/doc/guides/compressdevs/features/default.ini
> index 829e4df61..5b783b842 100644
> --- a/doc/guides/compressdevs/features/default.ini
> +++ b/doc/guides/compressdevs/features/default.ini
> @@ -6,21 +6,22 @@
>  ; the features table in the documentation.
>  ;
>  [Features]
> -HW Accelerated      =
> -CPU SSE             =
> -CPU AVX             =
> -CPU AVX2            =
> -CPU AVX512          =
> -CPU NEON            =
> -Stateful            =
> -Pass-through        =
> -OOP SGL In SGL Out  =
> -OOP SGL In LB  Out  =
> -OOP LB  In SGL Out  =
> -Deflate             =
> -LZS                 =
> -Adler32             =
> -Crc32               =
> -Adler32&Crc32       =
> -Fixed               =
> -Dynamic             =
> +HW Accelerated         =
> +Stateful Decompression =
> +CPU SSE                =
> +CPU AVX                =
> +CPU AVX2               =
> +CPU AVX512             =
> +CPU NEON               =
> +Stateful               =
> +Pass-through           =
> +OOP SGL In SGL Out     =
> +OOP SGL In LB  Out     =
> +OOP LB  In SGL Out     =
> +Deflate                =
> +LZS                    =
> +Adler32                =
> +Crc32                  =
> +Adler32&Crc32          =
> +Fixed                  =
> +Dynamic                =
> diff --git a/doc/guides/compressdevs/features/qat.ini
> b/doc/guides/compressdevs/features/qat.ini
> index 6b1e7f935..bced8f9cf 100644
> --- a/doc/guides/compressdevs/features/qat.ini
> +++ b/doc/guides/compressdevs/features/qat.ini
> @@ -4,13 +4,14 @@
>  ; Supported features of 'QAT' compression driver.
>  ;
>  [Features]
> -HW Accelerated      = Y
> -OOP SGL In SGL Out  = Y
> -OOP SGL In LB  Out  = Y
> -OOP LB  In SGL Out  = Y
> -Deflate             = Y
> -Adler32             = Y
> -Crc32               = Y
> -Adler32&Crc32       = Y
> -Fixed               = Y
> -Dynamic             = Y
> +HW Accelerated         = Y
> +Stateful Decompression = Y
> +OOP SGL In SGL Out     = Y
> +OOP SGL In LB  Out     = Y
> +OOP LB  In SGL Out     = Y
> +Deflate                = Y
> +Adler32                = Y
> +Crc32                  = Y
> +Adler32&Crc32          = Y
> +Fixed                  = Y
> +Dynamic                = Y
> diff --git a/doc/guides/compressdevs/qat_comp.rst
> b/doc/guides/compressdevs/qat_comp.rst
> index 6f583a460..6421f767c 100644
> --- a/doc/guides/compressdevs/qat_comp.rst
> +++ b/doc/guides/compressdevs/qat_comp.rst
> @@ -29,6 +29,10 @@ Checksum generation:
> 
>      * CRC32, Adler and combined checksum
> 
> +Stateful operation:
> +
> +    * Decompression only
> +
>  Limitations
>  -----------
> 
> @@ -38,6 +42,7 @@ Limitations
>  * 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.
> +* Stateful compression is not supported.
> 
> 
>  Installation
> diff --git a/doc/guides/rel_notes/release_19_11.rst
> b/doc/guides/rel_notes/release_19_11.rst
> index 8490d897c..16775f9ac 100644
> --- a/doc/guides/rel_notes/release_19_11.rst
> +++ b/doc/guides/rel_notes/release_19_11.rst
> @@ -56,6 +56,10 @@ New Features
>       Also, make sure to start the actual text at the margin.
>       =========================================================
> 
> +* **Updated the Intel QuickAssist Technology (QAT) compression PMD.**
> +
> +  Added stateful decompression support in the Intel QuickAssist Technology
> PMD.
> +  Please note that stateful compression is not supported.
> 
>  Removed Items
>  -------------
> --
> 2.17.1