Patch Detail
get:
Show a patch.
patch:
Update a patch.
put:
Update a patch.
GET /api/patches/48840/?format=api
{ "id": 48840, "url": "https://patches.dpdk.org/api/patches/48840/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/patch/1544781564-63598-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": "<1544781564-63598-3-git-send-email-lee.daly@intel.com>", "list_archive_url": "https://inbox.dpdk.org/dev/1544781564-63598-3-git-send-email-lee.daly@intel.com", "date": "2018-12-14T09:59:24", "name": "[v4,3/3] doc: update ISA-L guide to reflect checksum support", "commit_ref": null, "pull_url": null, "state": "superseded", "archived": true, "hash": "8e09cef20f7c871834632d4e496cce01a6bdc368", "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/1544781564-63598-3-git-send-email-lee.daly@intel.com/mbox/", "series": [ { "id": 2773, "url": "https://patches.dpdk.org/api/series/2773/?format=api", "web_url": "https://patches.dpdk.org/project/dpdk/list/?series=2773", "date": "2018-12-14T09:59:22", "name": "[v4,1/3] compress/isal: enable checksum support in driver", "version": 4, "mbox": "https://patches.dpdk.org/series/2773/mbox/" } ], "comments": "https://patches.dpdk.org/api/patches/48840/comments/", "check": "success", "checks": "https://patches.dpdk.org/api/patches/48840/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 DBBA81B9EB;\n\tFri, 14 Dec 2018 10:59:34 +0100 (CET)", "from mga04.intel.com (mga04.intel.com [192.55.52.120])\n\tby dpdk.org (Postfix) with ESMTP id 53E291B9E2\n\tfor <dev@dpdk.org>; Fri, 14 Dec 2018 10:59:32 +0100 (CET)", "from orsmga003.jf.intel.com ([10.7.209.27])\n\tby fmsmga104.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384;\n\t14 Dec 2018 01:59:31 -0800", "from silpixa00399501.ir.intel.com ([10.237.223.69])\n\tby orsmga003.jf.intel.com with ESMTP; 14 Dec 2018 01:59:30 -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,352,1539673200\"; d=\"scan'208\";a=\"110349980\"", "From": "Lee Daly <lee.daly@intel.com>", "To": "akhil.goyal@nxp.com", "Cc": "dev@dpdk.org,\n\tLee Daly <lee.daly@intel.com>", "Date": "Fri, 14 Dec 2018 09:59:24 +0000", "Message-Id": "<1544781564-63598-3-git-send-email-lee.daly@intel.com>", "X-Mailer": "git-send-email 2.7.4", "In-Reply-To": "<1544781564-63598-1-git-send-email-lee.daly@intel.com>", "References": "<11544697752-156863-1-git-send-email-lee.daly@intel.com>\n\t<1544781564-63598-1-git-send-email-lee.daly@intel.com>", "Subject": "[dpdk-dev] [PATCH v4 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.\n\nThis also updates the compression drivers features matrix.\n\nV2:\nDocumentation Changes\nV3:\nAdded Release note\nV4:\nRemoved depedency on offset unit test\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 | 5 +++++\n 3 files changed, 35 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 a94fa86..3a4d264 100644\n--- a/doc/guides/rel_notes/release_19_02.rst\n+++ b/doc/guides/rel_notes/release_19_02.rst\n@@ -54,6 +54,11 @@ New Features\n Also, make sure to start the actual text at the margin.\n =========================================================\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 \n Removed Items\n -------------\n", "prefixes": [ "v4", "3/3" ] }