From: "Varghese, Vipin" <vipin.varghese@intel.com>
To: "Daly, Lee" <lee.daly@intel.com>,
"akhil.goyal@nxp.com" <akhil.goyal@nxp.com>
Cc: "dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH v3 3/3] doc: update ISA-L guide to reflect checksum support
Date: Mon, 7 Jan 2019 13:31:32 +0000 [thread overview]
Message-ID: <4C9E0AB70F954A408CC4ADDBF0F8FA7D4D2E0F7B@BGSMSX101.gar.corp.intel.com> (raw)
In-Reply-To: <F5C6929789601049BEB7272E26735598819E86@IRSMSX106.ger.corp.intel.com>
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
prev parent reply other threads:[~2019-01-07 13:31 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-10-09 16:21 [dpdk-dev] [PATCH 1/3] compress/isal: enable checksum support in driver Lee Daly
2018-10-09 16:21 ` [dpdk-dev] [PATCH 2/3] test/compress: add checksum tests Lee Daly
2018-10-11 10:37 ` Trahe, Fiona
2018-10-09 16:21 ` [dpdk-dev] [PATCH 3/3] doc: update ISA-L guide to reflect checksum support Lee Daly
2018-10-11 10:04 ` Trahe, Fiona
2018-11-28 10:41 ` [dpdk-dev] [PATCH v2 1/3] compress/isal: enable checksum support in driver Lee Daly
2018-11-28 10:41 ` [dpdk-dev] [PATCH v2 2/3] test/compress: add checksum tests Lee Daly
2018-12-05 13:57 ` Jozwiak, TomaszX
2018-12-12 0:25 ` Trahe, Fiona
2018-11-28 10:41 ` [dpdk-dev] [PATCH v2 3/3] doc: update ISA-L guide to reflect checksum support Lee Daly
2018-12-12 0:27 ` Trahe, Fiona
2018-12-12 0:10 ` [dpdk-dev] [PATCH v2 1/3] compress/isal: enable checksum support in driver Trahe, Fiona
2018-12-13 10:42 ` [dpdk-dev] [PATCH v3 " Lee Daly
2018-12-13 10:42 ` [dpdk-dev] [PATCH v3 2/3] test/compress: add checksum tests Lee Daly
2018-12-13 10:42 ` [dpdk-dev] [PATCH v3 3/3] doc: update ISA-L guide to reflect checksum support Lee Daly
2018-12-28 5:04 ` Varghese, Vipin
2019-01-07 10:37 ` Daly, Lee
2019-01-07 13:31 ` Varghese, Vipin [this message]
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=4C9E0AB70F954A408CC4ADDBF0F8FA7D4D2E0F7B@BGSMSX101.gar.corp.intel.com \
--to=vipin.varghese@intel.com \
--cc=akhil.goyal@nxp.com \
--cc=dev@dpdk.org \
--cc=lee.daly@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).