From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga04.intel.com (mga04.intel.com [192.55.52.120]) by dpdk.org (Postfix) with ESMTP id D8D351B457 for ; Mon, 7 Jan 2019 11:37:34 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by fmsmga104.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 07 Jan 2019 02:37:34 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.56,450,1539673200"; d="scan'208";a="114730358" Received: from irsmsx102.ger.corp.intel.com ([163.33.3.155]) by fmsmga008.fm.intel.com with ESMTP; 07 Jan 2019 02:37:33 -0800 Received: from irsmsx106.ger.corp.intel.com ([169.254.8.161]) by IRSMSX102.ger.corp.intel.com ([169.254.2.65]) with mapi id 14.03.0415.000; Mon, 7 Jan 2019 10:37:13 +0000 From: "Daly, Lee" To: "Varghese, Vipin" , "akhil.goyal@nxp.com" CC: "dev@dpdk.org" Thread-Topic: [dpdk-dev] [PATCH v3 3/3] doc: update ISA-L guide to reflect checksum support Thread-Index: AQHUnmrX8tCyPpofD0m4oiYs2ie8H6WjrNsw Date: Mon, 7 Jan 2019 10:37:12 +0000 Message-ID: References: <1543401707-87314-1-git-send-email-lee.daly@intel.com> <1544697752-156863-1-git-send-email-lee.daly@intel.com> <1544697752-156863-3-git-send-email-lee.daly@intel.com> <4C9E0AB70F954A408CC4ADDBF0F8FA7D4D2DF881@BGSMSX101.gar.corp.intel.com> In-Reply-To: <4C9E0AB70F954A408CC4ADDBF0F8FA7D4D2DF881@BGSMSX101.gar.corp.intel.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: dlp-product: dlpe-windows dlp-version: 11.0.400.15 dlp-reaction: no-action x-ctpclassification: CTP_NT x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiMzEzMDQ2NGUtOTIyMy00NWNiLWFjMzEtNWRhMjg3YmRlOGMxIiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjEwLjE4MDQuNDkiLCJUcnVzdGVkTGFiZWxIYXNoIjoidjBoTGxPcW96SU1LcXJhZnF5cG5GZGVLcHFZQ2RjXC9PbDYyTlJmZG9qY0hQcmZDV3dJb2owYlFkRDVNQ1wvVGRMIn0= x-originating-ip: [163.33.239.180] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH v3 3/3] doc: update ISA-L guide to reflect checksum support X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 07 Jan 2019 10:37:35 -0000 Hi Vipin, thanks for your suggestion.=20 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 ; akhil.goyal@nxp.com > Cc: dev@dpdk.org; Daly, Lee > Subject: RE: [dpdk-dev] [PATCH v3 3/3] doc: update ISA-L guide to reflect > checksum support >=20 > Hi Lee, >=20 > 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. >=20 > Note: I am not fully sure how this is applicable to 'isal.ini and isal.rs= t'. It will be > good to have a check. >=20 > Thanks > Vipin Varghese >=20 > > -----Original Message----- > > From: dev On Behalf Of Lee Daly > > Sent: Thursday, December 13, 2018 4:13 PM > > To: akhil.goyal@nxp.com > > Cc: dev@dpdk.org; Daly, Lee > > 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 > > Acked-by: Fiona Trahe > > --- > > 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 =3D Y OOP SGL In LB Out =3D Y O= OP > > LB In SGL Out =3D Y > > Deflate =3D Y > > +Adler32 =3D Y > > +Crc32 =3D Y > > Fixed =3D Y > > Dynamic =3D 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 =3D RTE_COMP_CHECKSUM_CRC32 > > + > > + decompress_xform->decompress.chksum =3D > RTE_COMP_CHECKSUM_CRC32 > > + > > +:: > > + > > + compress_xform->compress.chksum =3D > RTE_COMP_CHECKSUM_ADLER32 > > + > > + decompress_xform->decompress.chksum =3D > 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. > > > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D > > > > + * **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 decompressio= n. > > + > > > > Removed Items > > ------------- > > -- > > 2.7.4