Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/49129/?format=api
{ "id": 49129, "url": "https://patches.dpdk.org/api/patches/49129/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/1545234488-86585-3-git-send-email-lee.daly@intel.com/", "project": { "id": 1, "url": "https://patches.dpdk.org/api/projects/1/?format=api", "name": "DPDK", "link_name": "dpdk", "list_id": "dev.dpdk.org", "list_email": "dev@dpdk.org", "web_url": "http://core.dpdk.org", "scm_url": "git://dpdk.org/dpdk", "webscm_url": "http://git.dpdk.org/dpdk", "list_archive_url": "https://inbox.dpdk.org/dev", "list_archive_url_format": "https://inbox.dpdk.org/dev/{}", "commit_url_format": "" }, "msgid": "<1545234488-86585-3-git-send-email-lee.daly@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/1545234488-86585-3-git-send-email-lee.daly@intel.com", "date": "2018-12-19T15:48:08", "name": "[v5,3/3] doc: update ISA-L guide to reflect checksum support", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "e61d324ed54839ec933a0c5748a50790f64299ce", "submitter": { "id": 825, "url": "https://patches.dpdk.org/api/people/825/?format=api", "name": "Daly, Lee", "email": "lee.daly@intel.com" }, "delegate": { "id": 6690, "url": "https://patches.dpdk.org/api/users/6690/?format=api", "username": "akhil", "first_name": "akhil", "last_name": "goyal", "email": "gakhil@marvell.com" }, "mbox": "https://patches.dpdk.org/project/dpdk/patch/1545234488-86585-3-git-send-email-lee.daly@intel.com/mbox/", "series": [ { "id": 2873, "url": "https://patches.dpdk.org/api/series/2873/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/list/?series=2873", "date": "2018-12-19T15:48:06", "name": "[v5,1/3] compress/isal: enable checksum support in driver", "version": 5, "mbox": "https://patches.dpdk.org/series/2873/mbox/" } ], "comments": "https://patches.dpdk.org/api/patches/49129/comments/", "check": "success", "checks": "https://patches.dpdk.org/api/patches/49129/checks/", "tags": {}, "related": [], "headers": { "Return-Path": "<dev-bounces@dpdk.org>", "X-Original-To": "patchwork@dpdk.org", "Delivered-To": "patchwork@dpdk.org", "Received": [ "from [92.243.14.124] (localhost [127.0.0.1])\n\tby dpdk.org (Postfix) with ESMTP id C90F61B950;\n\tWed, 19 Dec 2018 16:48:20 +0100 (CET)", "from mga17.intel.com (mga17.intel.com [192.55.52.151])\n\tby dpdk.org (Postfix) with ESMTP id 133691B59A\n\tfor <dev@dpdk.org>; Wed, 19 Dec 2018 16:48:14 +0100 (CET)", "from fmsmga008.fm.intel.com ([10.253.24.58])\n\tby fmsmga107.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;\n\t19 Dec 2018 07:48:14 -0800", "from silpixa00399501.ir.intel.com ([10.237.223.69])\n\tby fmsmga008.fm.intel.com with ESMTP; 19 Dec 2018 07:48:13 -0800" ], "X-Amp-Result": "SKIPPED(no attachment in message)", "X-Amp-File-Uploaded": "False", "X-ExtLoop1": "1", "X-IronPort-AV": "E=Sophos;i=\"5.56,373,1539673200\"; d=\"scan'208\";a=\"110677902\"", "From": "Lee Daly <lee.daly@intel.com>", "To": "akhil.goyal@nxp.com", "Cc": "dev@dpdk.org,\n\tvipin.varghese@intel.com,\n\tLee Daly <lee.daly@intel.com>", "Date": "Wed, 19 Dec 2018 15:48:08 +0000", "Message-Id": "<1545234488-86585-3-git-send-email-lee.daly@intel.com>", "X-Mailer": "git-send-email 2.7.4", "In-Reply-To": "<1545234488-86585-1-git-send-email-lee.daly@intel.com>", "References": "<1544781564-63598-1-git-send-email-lee.daly@intel.com>\n\t<1545234488-86585-1-git-send-email-lee.daly@intel.com>", "Subject": "[dpdk-dev] [PATCH v5 3/3] doc: update ISA-L guide to reflect\n\tchecksum support", "X-BeenThere": "dev@dpdk.org", "X-Mailman-Version": "2.1.15", "Precedence": "list", "List-Id": "DPDK patches and discussions <dev.dpdk.org>", "List-Unsubscribe": "<https://mails.dpdk.org/options/dev>,\n\t<mailto:dev-request@dpdk.org?subject=unsubscribe>", "List-Archive": "<http://mails.dpdk.org/archives/dev/>", "List-Post": "<mailto:dev@dpdk.org>", "List-Help": "<mailto:dev-request@dpdk.org?subject=help>", "List-Subscribe": "<https://mails.dpdk.org/listinfo/dev>,\n\t<mailto:dev-request@dpdk.org?subject=subscribe>", "Errors-To": "dev-bounces@dpdk.org", "Sender": "\"dev\" <dev-bounces@dpdk.org>" }, "content": "This updates the ISA-L compression driver guide on how to enable and use\nchecksums and release notes.\n\nSigned-off-by: Lee Daly <lee.daly@intel.com>\nAcked-by: Fiona Trahe <fiona.trahe@intel.com>\n---\n doc/guides/compressdevs/features/isal.ini | 2 ++\n doc/guides/compressdevs/isal.rst | 30 ++++++++++++++++++++++++++++--\n doc/guides/rel_notes/release_19_02.rst | 4 ++++\n 3 files changed, 34 insertions(+), 2 deletions(-)", "diff": "diff --git a/doc/guides/compressdevs/features/isal.ini b/doc/guides/compressdevs/features/isal.ini\nindex 919cf70..e705031 100644\n--- a/doc/guides/compressdevs/features/isal.ini\n+++ b/doc/guides/compressdevs/features/isal.ini\n@@ -12,5 +12,7 @@ OOP SGL In SGL Out = Y\n OOP SGL In LB Out = Y\n OOP LB In SGL Out = Y\n Deflate = Y\n+Adler32 = Y\n+Crc32 = Y\n Fixed = Y\n Dynamic = Y\ndiff --git a/doc/guides/compressdevs/isal.rst b/doc/guides/compressdevs/isal.rst\nindex 3bc3022..af1f41f 100644\n--- a/doc/guides/compressdevs/isal.rst\n+++ b/doc/guides/compressdevs/isal.rst\n@@ -27,6 +27,33 @@ Window size support:\n \n * 32K\n \n+Checksum:\n+\n+ * CRC32\n+ * ADLER32\n+\n+To enable a checksum in the driver, the compression and/or decompression xform\n+structure, rte_comp_xform, must be filled with either of the CompressDev\n+checksum flags supported. ::\n+\n+ compress_xform->compress.chksum = RTE_COMP_CHECKSUM_CRC32\n+\n+ decompress_xform->decompress.chksum = RTE_COMP_CHECKSUM_CRC32\n+\n+::\n+\n+ compress_xform->compress.chksum = RTE_COMP_CHECKSUM_ADLER32\n+\n+ decompress_xform->decompress.chksum = RTE_COMP_CHECKSUM_ADLER32\n+\n+If you request a checksum for compression or decompression,\n+the checksum field in the operation structure, ``op->output_chksum``,\n+will be filled with the checksum.\n+\n+.. Note::\n+\n+ 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.\n+\n Level guide:\n \n The ISA-L levels have been mapped to somewhat correspond to the same ZLIB level,\n@@ -75,13 +102,12 @@ As a result the level mappings from the API to the PMD are shown below.\n The above table only shows mapping when API calls for dynamic compression.\n For fixed compression, regardless of API level, internally ISA-L level 0 is always used.\n \n+\n Limitations\n -----------\n \n * Compressdev level 0, no compression, is not supported.\n \n-* Checksums will not be supported until future release.\n-\n Installation\n ------------\n \ndiff --git a/doc/guides/rel_notes/release_19_02.rst b/doc/guides/rel_notes/release_19_02.rst\nindex 8deb68b..286c060 100644\n--- a/doc/guides/rel_notes/release_19_02.rst\n+++ b/doc/guides/rel_notes/release_19_02.rst\n@@ -60,6 +60,10 @@ New Features\n * Added the handler to get firmware version string.\n * Added support for multicast filtering.\n \n+ * **Enabled checksum support in the ISA-L compressdev driver.**\n+\n+ Added support for both adler and crc32 checksums in the ISA-L PMD.\n+ This aids data integrity across both compression and decompression.\n \n Removed Items\n -------------\n", "prefixes": [ "v5", "3/3" ] }