[dpdk-dev] [PATCH v1 6/6] doc: add ZLIB PMD documentation

[Daly, Lee]

Hi, Comments inline.

> -----Original Message-----
> From: dev [mailto:dev-bounces at dpdk.org] On Behalf Of Shally Verma
> Sent: Tuesday, May 15, 2018 11:32 AM
> To: De Lara Guarch, Pablo <pablo.de.lara.guarch at intel.com>
> Cc: Trahe, Fiona <fiona.trahe at intel.com>; dev at dpdk.org;
> pathreay at caviumnetworks.com; Sunila Sahu
> <sunila.sahu at caviumnetworks.com>; Ashish Gupta
> <ashish.gupta at caviumnetworks.com>
> Subject: [dpdk-dev] [PATCH v1 6/6] doc: add ZLIB PMD documentation
> 
> add zlib pmd feature specification and overview documentation
> 
> Signed-off-by: Sunila Sahu <sunila.sahu at caviumnetworks.com>
> Signed-off-by: Shally Verma <shally.verma at caviumnetworks.com>
> Signed-off-by: Ashish Gupta <ashish.gupta at caviumnetworks.com>
> ---
>  doc/guides/compressdevs/features/zlib.ini | 22 ++++++++++
>  doc/guides/compressdevs/zlib.rst          | 72
> +++++++++++++++++++++++++++++++
>  2 files changed, 94 insertions(+)
> 
> diff --git a/doc/guides/compressdevs/features/zlib.ini
> b/doc/guides/compressdevs/features/zlib.ini
> new file mode 100644
> index 0000000..10e758b
> --- /dev/null
> +++ b/doc/guides/compressdevs/features/zlib.ini
> @@ -0,0 +1,22 @@
> +;
> +; Refer to default.ini for the full list of available PMD features.
> +;
> +; Supported features of 'ZLIB' compression driver.
> +;
> +[Features]
> +HW Accelerated =
> +CPU SSE        =
> +CPU AVX        =
> +CPU AVX2       =
> +CPU AVX512     =
> +CPU NEON       =
> +Stateful       =
> +By-Pass        =
> +Chained mbufs  =
> +Deflate        = Y
> +LZS            =
> +Adler32        = Y
> +Crc32          = Y
[Lee] here you say you support both adler and crc checksums, in the feature flags of the PMD it is says only adler32, but I see no implementation of any checksums in the PMD? 
Note* the checksum of the data will need to be put in the op->input_chksum & op->output_chksum.

> +Adler32&Crc32  =
> +Fixed          = Y
> +Dynamic        = Y
> diff --git a/doc/guides/compressdevs/zlib.rst
> b/doc/guides/compressdevs/zlib.rst
> new file mode 100644
> index 0000000..130750b
> --- /dev/null
> +++ b/doc/guides/compressdevs/zlib.rst
> @@ -0,0 +1,72 @@
> +..  SPDX-License-Identifier: BSD-3-Clause
> +    Copyright(c) 2018 Cavium Networks.
> +
> +ZLIB Compression Poll Mode Driver
> +==================================
> +
> +The ZLIB PMD (**librte_pmd_zlib**) provides poll mode compression &
> +decompression driver based on SW zlib library,
> +
> +Features
> +--------
> +
> +ZLIB PMD has support for:
> +
> +Compression/Decompression algorithm:
> +
> +* DEFLATE
> +
> +Huffman code type:
> +
> +* FIXED
> +* DYNAMIC
> +
> +Checksum support:
> +
> +* Adler32
> +* CRC32
[Lee] see comment above.

> +
> +Window size support:
> +
> +* 32K
[Lee] Say only 32K window size support here but in the capabilities of the PMD you have a window_size ranging from 8(256) to 15(32k). You also have increments of 2, which wouldn't allow 15 as max.

Thanks for the work,
Lee.