diff mbox series

[v3,3/3] doc: update ISA-L guide to reflect checksum support

Message ID 1544697752-156863-3-git-send-email-lee.daly@intel.com (mailing list archive)
State Superseded, archived
Delegated to: akhil goyal
Headers
Series [v3,1/3] compress/isal: enable checksum support in driver |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Daly, Lee Dec. 13, 2018, 10:42 a.m. UTC 
  This updates the ISA-L compression driver guide on how to enable and use
checksums.

This also updates the compression drivers features matrix.

V2:
Documentation Changes
V3:
Added Release note

Signed-off-by: Lee Daly <lee.daly@intel.com>
Acked-by: Fiona Trahe <fiona.trahe@intel.com>
---
 doc/guides/compressdevs/features/isal.ini |  2 ++
 doc/guides/compressdevs/isal.rst          | 30 ++++++++++++++++++++++++++++--
 doc/guides/rel_notes/release_19_02.rst    |  5 +++++
 3 files changed, 35 insertions(+), 2 deletions(-)

Comments

Varghese, Vipin Dec. 28, 2018, 5:04 a.m. UTC | #1 
Hi Lee,

A humble suggestion being shared for document update, Based on DPDK 19.02-rc1 release both code and associated document update is to be in single patch file.

Note: I am not fully sure how this is applicable to 'isal.ini and isal.rst'. It will be good to have a check.

Thanks
Vipin Varghese

> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Lee Daly
> Sent: Thursday, December 13, 2018 4:13 PM
> To: akhil.goyal@nxp.com
> Cc: dev@dpdk.org; Daly, Lee <lee.daly@intel.com>
> Subject: [dpdk-dev] [PATCH v3 3/3] doc: update ISA-L guide to reflect checksum
> support
> 
> This updates the ISA-L compression driver guide on how to enable and use
> checksums.
> 
> This also updates the compression drivers features matrix.
> 
> V2:
> Documentation Changes
> V3:
> Added Release note
> 
> Signed-off-by: Lee Daly <lee.daly@intel.com>
> Acked-by: Fiona Trahe <fiona.trahe@intel.com>
> ---
>  doc/guides/compressdevs/features/isal.ini |  2 ++
>  doc/guides/compressdevs/isal.rst          | 30 ++++++++++++++++++++++++++++-
> -
>  doc/guides/rel_notes/release_19_02.rst    |  5 +++++
>  3 files changed, 35 insertions(+), 2 deletions(-)
> 
> diff --git a/doc/guides/compressdevs/features/isal.ini
> b/doc/guides/compressdevs/features/isal.ini
> index 919cf70..e705031 100644
> --- a/doc/guides/compressdevs/features/isal.ini
> +++ b/doc/guides/compressdevs/features/isal.ini
> @@ -12,5 +12,7 @@ OOP SGL In SGL Out = Y  OOP SGL In LB  Out = Y  OOP LB  In
> SGL Out = Y
>  Deflate            = Y
> +Adler32            = Y
> +Crc32              = Y
>  Fixed              = Y
>  Dynamic            = Y
> diff --git a/doc/guides/compressdevs/isal.rst b/doc/guides/compressdevs/isal.rst
> index 3bc3022..af1f41f 100644
> --- a/doc/guides/compressdevs/isal.rst
> +++ b/doc/guides/compressdevs/isal.rst
> @@ -27,6 +27,33 @@ Window size support:
> 
>      * 32K
> 
> +Checksum:
> +
> +    * CRC32
> +    * ADLER32
> +
> +To enable a checksum in the driver, the compression and/or
> +decompression xform structure, rte_comp_xform, must be filled with
> +either of the CompressDev checksum flags supported. ::
> +
> + compress_xform->compress.chksum = RTE_COMP_CHECKSUM_CRC32
> +
> + decompress_xform->decompress.chksum = RTE_COMP_CHECKSUM_CRC32
> +
> +::
> +
> + compress_xform->compress.chksum = RTE_COMP_CHECKSUM_ADLER32
> +
> + decompress_xform->decompress.chksum = RTE_COMP_CHECKSUM_ADLER32
> +
> +If you request a checksum for compression or decompression, the
> +checksum field in the operation structure,  ``op->output_chksum``, will
> +be filled with the checksum.
> +
> +.. Note::
> +
> + For the compression case above, your output buffer will need to be large
> enough to hold the compressed data plus a scratchpad for the checksum at the
> end, the scratchpad is 8 bytes for CRC32 and 4 bytes for Adler32.
> +
>  Level guide:
> 
>  The ISA-L levels have been mapped to somewhat correspond to the same ZLIB
> level, @@ -75,13 +102,12 @@ As a result the level mappings from the API to the
> PMD are shown below.
>   The above table only shows mapping when API calls for dynamic compression.
>   For fixed compression, regardless of API level, internally ISA-L level 0 is always
> used.
> 
> +
>  Limitations
>  -----------
> 
>  * Compressdev level 0, no compression, is not supported.
> 
> -* Checksums will not be supported until future release.
> -
>  Installation
>  ------------
> 
> diff --git a/doc/guides/rel_notes/release_19_02.rst
> b/doc/guides/rel_notes/release_19_02.rst
> index a94fa86..3a4d264 100644
> --- a/doc/guides/rel_notes/release_19_02.rst
> +++ b/doc/guides/rel_notes/release_19_02.rst
> @@ -54,6 +54,11 @@ New Features
>       Also, make sure to start the actual text at the margin.
>       =========================================================
> 
> +   * **Enabled checksum support in the ISA-L compressdev driver.**
> +
> +     Added support for both adler and crc32 checksums in the ISA-L PMD.
> +     This aids data integrity across both compression and decompression.
> +
> 
>  Removed Items
>  -------------
> --
> 2.7.4
Daly, Lee Jan. 7, 2019, 10:37 a.m. UTC | #2 
Hi Vipin, thanks for your suggestion. 
I will send another version with the change.
/Lee.

> -----Original Message-----
> From: Varghese, Vipin
> Sent: Friday, December 28, 2018 5:05 AM
> To: Daly, Lee <lee.daly@intel.com>; akhil.goyal@nxp.com
> Cc: dev@dpdk.org; Daly, Lee <lee.daly@intel.com>
> Subject: RE: [dpdk-dev] [PATCH v3 3/3] doc: update ISA-L guide to reflect
> checksum support
> 
> Hi Lee,
> 
> A humble suggestion being shared for document update, Based on DPDK
> 19.02-rc1 release both code and associated document update is to be in
> single patch file.
> 
> Note: I am not fully sure how this is applicable to 'isal.ini and isal.rst'. It will be
> good to have a check.
> 
> Thanks
> Vipin Varghese
> 
> > -----Original Message-----
> > From: dev <dev-bounces@dpdk.org> On Behalf Of Lee Daly
> > Sent: Thursday, December 13, 2018 4:13 PM
> > To: akhil.goyal@nxp.com
> > Cc: dev@dpdk.org; Daly, Lee <lee.daly@intel.com>
> > Subject: [dpdk-dev] [PATCH v3 3/3] doc: update ISA-L guide to reflect
> > checksum support
> >
> > This updates the ISA-L compression driver guide on how to enable and
> > use checksums.
> >
> > This also updates the compression drivers features matrix.
> >
> > V2:
> > Documentation Changes
> > V3:
> > Added Release note
> >
> > Signed-off-by: Lee Daly <lee.daly@intel.com>
> > Acked-by: Fiona Trahe <fiona.trahe@intel.com>
> > ---
> >  doc/guides/compressdevs/features/isal.ini |  2 ++
> >  doc/guides/compressdevs/isal.rst          | 30
> ++++++++++++++++++++++++++++-
> > -
> >  doc/guides/rel_notes/release_19_02.rst    |  5 +++++
> >  3 files changed, 35 insertions(+), 2 deletions(-)
> >
> > diff --git a/doc/guides/compressdevs/features/isal.ini
> > b/doc/guides/compressdevs/features/isal.ini
> > index 919cf70..e705031 100644
> > --- a/doc/guides/compressdevs/features/isal.ini
> > +++ b/doc/guides/compressdevs/features/isal.ini
> > @@ -12,5 +12,7 @@ OOP SGL In SGL Out = Y  OOP SGL In LB  Out = Y  OOP
> > LB  In SGL Out = Y
> >  Deflate            = Y
> > +Adler32            = Y
> > +Crc32              = Y
> >  Fixed              = Y
> >  Dynamic            = Y
> > diff --git a/doc/guides/compressdevs/isal.rst
> > b/doc/guides/compressdevs/isal.rst
> > index 3bc3022..af1f41f 100644
> > --- a/doc/guides/compressdevs/isal.rst
> > +++ b/doc/guides/compressdevs/isal.rst
> > @@ -27,6 +27,33 @@ Window size support:
> >
> >      * 32K
> >
> > +Checksum:
> > +
> > +    * CRC32
> > +    * ADLER32
> > +
> > +To enable a checksum in the driver, the compression and/or
> > +decompression xform structure, rte_comp_xform, must be filled with
> > +either of the CompressDev checksum flags supported. ::
> > +
> > + compress_xform->compress.chksum = RTE_COMP_CHECKSUM_CRC32
> > +
> > + decompress_xform->decompress.chksum =
> RTE_COMP_CHECKSUM_CRC32
> > +
> > +::
> > +
> > + compress_xform->compress.chksum =
> RTE_COMP_CHECKSUM_ADLER32
> > +
> > + decompress_xform->decompress.chksum =
> RTE_COMP_CHECKSUM_ADLER32
> > +
> > +If you request a checksum for compression or decompression, the
> > +checksum field in the operation structure,  ``op->output_chksum``,
> > +will be filled with the checksum.
> > +
> > +.. Note::
> > +
> > + For the compression case above, your output buffer will need to be
> > + large
> > enough to hold the compressed data plus a scratchpad for the checksum
> > at the end, the scratchpad is 8 bytes for CRC32 and 4 bytes for Adler32.
> > +
> >  Level guide:
> >
> >  The ISA-L levels have been mapped to somewhat correspond to the same
> > ZLIB level, @@ -75,13 +102,12 @@ As a result the level mappings from
> > the API to the PMD are shown below.
> >   The above table only shows mapping when API calls for dynamic
> compression.
> >   For fixed compression, regardless of API level, internally ISA-L
> > level 0 is always used.
> >
> > +
> >  Limitations
> >  -----------
> >
> >  * Compressdev level 0, no compression, is not supported.
> >
> > -* Checksums will not be supported until future release.
> > -
> >  Installation
> >  ------------
> >
> > diff --git a/doc/guides/rel_notes/release_19_02.rst
> > b/doc/guides/rel_notes/release_19_02.rst
> > index a94fa86..3a4d264 100644
> > --- a/doc/guides/rel_notes/release_19_02.rst
> > +++ b/doc/guides/rel_notes/release_19_02.rst
> > @@ -54,6 +54,11 @@ New Features
> >       Also, make sure to start the actual text at the margin.
> >
> =========================================================
> >
> > +   * **Enabled checksum support in the ISA-L compressdev driver.**
> > +
> > +     Added support for both adler and crc32 checksums in the ISA-L PMD.
> > +     This aids data integrity across both compression and decompression.
> > +
> >
> >  Removed Items
> >  -------------
> > --
> > 2.7.4
Varghese, Vipin Jan. 7, 2019, 1:31 p.m. UTC | #3 
Thanks Lee for understanding

> -----Original Message-----
> From: Daly, Lee
> Sent: Monday, January 7, 2019 4:07 PM
> To: Varghese, Vipin <vipin.varghese@intel.com>; akhil.goyal@nxp.com
> Cc: dev@dpdk.org
> Subject: RE: [dpdk-dev] [PATCH v3 3/3] doc: update ISA-L guide to reflect
> checksum support
> 
> Hi Vipin, thanks for your suggestion.
> I will send another version with the change.
> /Lee.
> 
> > -----Original Message-----
> > From: Varghese, Vipin
> > Sent: Friday, December 28, 2018 5:05 AM
> > To: Daly, Lee <lee.daly@intel.com>; akhil.goyal@nxp.com
> > Cc: dev@dpdk.org; Daly, Lee <lee.daly@intel.com>
> > Subject: RE: [dpdk-dev] [PATCH v3 3/3] doc: update ISA-L guide to
> > reflect checksum support
> >
> > Hi Lee,
> >
> > A humble suggestion being shared for document update, Based on DPDK
> > 19.02-rc1 release both code and associated document update is to be in
> > single patch file.
> >
> > Note: I am not fully sure how this is applicable to 'isal.ini and
> > isal.rst'. It will be good to have a check.
> >
> > Thanks
> > Vipin Varghese
> >
> > > -----Original Message-----
> > > From: dev <dev-bounces@dpdk.org> On Behalf Of Lee Daly
> > > Sent: Thursday, December 13, 2018 4:13 PM
> > > To: akhil.goyal@nxp.com
> > > Cc: dev@dpdk.org; Daly, Lee <lee.daly@intel.com>
> > > Subject: [dpdk-dev] [PATCH v3 3/3] doc: update ISA-L guide to
> > > reflect checksum support
> > >
> > > This updates the ISA-L compression driver guide on how to enable and
> > > use checksums.
> > >
> > > This also updates the compression drivers features matrix.
> > >
> > > V2:
> > > Documentation Changes
> > > V3:
> > > Added Release note
> > >
> > > Signed-off-by: Lee Daly <lee.daly@intel.com>
> > > Acked-by: Fiona Trahe <fiona.trahe@intel.com>
> > > ---
> > >  doc/guides/compressdevs/features/isal.ini |  2 ++
> > >  doc/guides/compressdevs/isal.rst          | 30
> > ++++++++++++++++++++++++++++-
> > > -
> > >  doc/guides/rel_notes/release_19_02.rst    |  5 +++++
> > >  3 files changed, 35 insertions(+), 2 deletions(-)
> > >
> > > diff --git a/doc/guides/compressdevs/features/isal.ini
> > > b/doc/guides/compressdevs/features/isal.ini
> > > index 919cf70..e705031 100644
> > > --- a/doc/guides/compressdevs/features/isal.ini
> > > +++ b/doc/guides/compressdevs/features/isal.ini
> > > @@ -12,5 +12,7 @@ OOP SGL In SGL Out = Y  OOP SGL In LB  Out = Y
> > > OOP LB  In SGL Out = Y
> > >  Deflate            = Y
> > > +Adler32            = Y
> > > +Crc32              = Y
> > >  Fixed              = Y
> > >  Dynamic            = Y
> > > diff --git a/doc/guides/compressdevs/isal.rst
> > > b/doc/guides/compressdevs/isal.rst
> > > index 3bc3022..af1f41f 100644
> > > --- a/doc/guides/compressdevs/isal.rst
> > > +++ b/doc/guides/compressdevs/isal.rst
> > > @@ -27,6 +27,33 @@ Window size support:
> > >
> > >      * 32K
> > >
> > > +Checksum:
> > > +
> > > +    * CRC32
> > > +    * ADLER32
> > > +
> > > +To enable a checksum in the driver, the compression and/or
> > > +decompression xform structure, rte_comp_xform, must be filled with
> > > +either of the CompressDev checksum flags supported. ::
> > > +
> > > + compress_xform->compress.chksum = RTE_COMP_CHECKSUM_CRC32
> > > +
> > > + decompress_xform->decompress.chksum =
> > RTE_COMP_CHECKSUM_CRC32
> > > +
> > > +::
> > > +
> > > + compress_xform->compress.chksum =
> > RTE_COMP_CHECKSUM_ADLER32
> > > +
> > > + decompress_xform->decompress.chksum =
> > RTE_COMP_CHECKSUM_ADLER32
> > > +
> > > +If you request a checksum for compression or decompression, the
> > > +checksum field in the operation structure,  ``op->output_chksum``,
> > > +will be filled with the checksum.
> > > +
> > > +.. Note::
> > > +
> > > + For the compression case above, your output buffer will need to be
> > > + large
> > > enough to hold the compressed data plus a scratchpad for the
> > > checksum at the end, the scratchpad is 8 bytes for CRC32 and 4 bytes for
> Adler32.
> > > +
> > >  Level guide:
> > >
> > >  The ISA-L levels have been mapped to somewhat correspond to the
> > > same ZLIB level, @@ -75,13 +102,12 @@ As a result the level mappings
> > > from the API to the PMD are shown below.
> > >   The above table only shows mapping when API calls for dynamic
> > compression.
> > >   For fixed compression, regardless of API level, internally ISA-L
> > > level 0 is always used.
> > >
> > > +
> > >  Limitations
> > >  -----------
> > >
> > >  * Compressdev level 0, no compression, is not supported.
> > >
> > > -* Checksums will not be supported until future release.
> > > -
> > >  Installation
> > >  ------------
> > >
> > > diff --git a/doc/guides/rel_notes/release_19_02.rst
> > > b/doc/guides/rel_notes/release_19_02.rst
> > > index a94fa86..3a4d264 100644
> > > --- a/doc/guides/rel_notes/release_19_02.rst
> > > +++ b/doc/guides/rel_notes/release_19_02.rst
> > > @@ -54,6 +54,11 @@ New Features
> > >       Also, make sure to start the actual text at the margin.
> > >
> > =========================================================
> > >
> > > +   * **Enabled checksum support in the ISA-L compressdev driver.**
> > > +
> > > +     Added support for both adler and crc32 checksums in the ISA-L PMD.
> > > +     This aids data integrity across both compression and decompression.
> > > +
> > >
> > >  Removed Items
> > >  -------------
> > > --
> > > 2.7.4
diff mbox series

Patch

diff --git a/doc/guides/compressdevs/features/isal.ini b/doc/guides/compressdevs/features/isal.ini
index 919cf70..e705031 100644
--- a/doc/guides/compressdevs/features/isal.ini
+++ b/doc/guides/compressdevs/features/isal.ini
@@ -12,5 +12,7 @@  OOP SGL In SGL Out = Y
 OOP SGL In LB  Out = Y
 OOP LB  In SGL Out = Y
 Deflate            = Y
+Adler32            = Y
+Crc32              = Y
 Fixed              = Y
 Dynamic            = Y
diff --git a/doc/guides/compressdevs/isal.rst b/doc/guides/compressdevs/isal.rst
index 3bc3022..af1f41f 100644
--- a/doc/guides/compressdevs/isal.rst
+++ b/doc/guides/compressdevs/isal.rst
@@ -27,6 +27,33 @@  Window size support:
 
     * 32K
 
+Checksum:
+
+    * CRC32
+    * ADLER32
+
+To enable a checksum in the driver, the compression and/or decompression xform
+structure, rte_comp_xform, must be filled with either of the CompressDev
+checksum flags supported. ::
+
+ compress_xform->compress.chksum = RTE_COMP_CHECKSUM_CRC32
+
+ decompress_xform->decompress.chksum = RTE_COMP_CHECKSUM_CRC32
+
+::
+
+ compress_xform->compress.chksum = RTE_COMP_CHECKSUM_ADLER32
+
+ decompress_xform->decompress.chksum = RTE_COMP_CHECKSUM_ADLER32
+
+If you request a checksum for compression or decompression,
+the checksum field in the operation structure,  ``op->output_chksum``,
+will be filled with the checksum.
+
+.. Note::
+
+ For the compression case above, your output buffer will need to be large enough to hold the compressed data plus a scratchpad for the checksum at the end, the scratchpad is 8 bytes for CRC32 and 4 bytes for Adler32.
+
 Level guide:
 
 The ISA-L levels have been mapped to somewhat correspond to the same ZLIB level,
@@ -75,13 +102,12 @@  As a result the level mappings from the API to the PMD are shown below.
  The above table only shows mapping when API calls for dynamic compression.
  For fixed compression, regardless of API level, internally ISA-L level 0 is always used.
 
+
 Limitations
 -----------
 
 * Compressdev level 0, no compression, is not supported.
 
-* Checksums will not be supported until future release.
-
 Installation
 ------------
 
diff --git a/doc/guides/rel_notes/release_19_02.rst b/doc/guides/rel_notes/release_19_02.rst
index a94fa86..3a4d264 100644
--- a/doc/guides/rel_notes/release_19_02.rst
+++ b/doc/guides/rel_notes/release_19_02.rst
@@ -54,6 +54,11 @@  New Features
      Also, make sure to start the actual text at the margin.
      =========================================================
 
+   * **Enabled checksum support in the ISA-L compressdev driver.**
+
+     Added support for both adler and crc32 checksums in the ISA-L PMD.
+     This aids data integrity across both compression and decompression.
+
 
 Removed Items
 -------------