From patchwork Sat Jul 21 18:17:49 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Shally Verma X-Patchwork-Id: 43256 X-Patchwork-Delegate: pablo.de.lara.guarch@intel.com Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 320F03238; Sat, 21 Jul 2018 20:22:24 +0200 (CEST) Received: from NAM02-BL2-obe.outbound.protection.outlook.com (mail-bl2nam02on0087.outbound.protection.outlook.com [104.47.38.87]) by dpdk.org (Postfix) with ESMTP id B79862C24 for ; Sat, 21 Jul 2018 20:22:18 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=CAVIUMNETWORKS.onmicrosoft.com; s=selector1-cavium-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=8bHIEcUViukDwMGWHiNOYwwgqTnJBZoLBu4BL8tM/OM=; b=SGkn2VnlgeukDMcSvJSSCSGPTZMQNma3vWhxRvCuwfHx6Oz2cwB83M5s41bmNZkW2h9Kqb5bgH6lCIQDknP9XDAq4f6EaccfbXsiW3B8VKURIcp6zvx2chAGYd72cfbksg+B6MZuIirLi4VtX56NMb318KHhuDFyG6OgCY4V6Y0= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=Shally.Verma@cavium.com; Received: from hyd1sverma-dt.caveonetworks.com (115.113.156.2) by CY4PR0701MB3634.namprd07.prod.outlook.com (2603:10b6:910:92::36) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.973.21; Sat, 21 Jul 2018 18:18:32 +0000 From: Shally Verma To: pablo.de.lara.guarch@intel.com Cc: dev@dpdk.org, pathreya@caviumnetworks.com, mchalla@caviumnetworks.com, ashish.gupta@caviumnetworks.com, sunila.sahu@caviumnetworks.com Date: Sat, 21 Jul 2018 23:47:49 +0530 Message-Id: <1532197069-24224-6-git-send-email-shally.verma@caviumnetworks.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1532197069-24224-1-git-send-email-shally.verma@caviumnetworks.com> References: <1532197069-24224-1-git-send-email-shally.verma@caviumnetworks.com> MIME-Version: 1.0 X-Originating-IP: [115.113.156.2] X-ClientProxiedBy: MA1PR01CA0103.INDPRD01.PROD.OUTLOOK.COM (2603:1096:a00:1::19) To CY4PR0701MB3634.namprd07.prod.outlook.com (2603:10b6:910:92::36) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: dcb28d8f-babd-4f0e-8732-08d5ef365eee X-Microsoft-Antispam: BCL:0; PCL:0; RULEID:(7020095)(4652040)(8989117)(5600073)(711020)(4534165)(7168020)(4627221)(201703031133081)(201702281549075)(8990107)(2017052603328)(7153060)(7193020); SRVR:CY4PR0701MB3634; X-Microsoft-Exchange-Diagnostics: 1; CY4PR0701MB3634; 3:vnlIw/g5MCuznnGycKGF0psksBa/x7sAgarZ4fJVoXHv+ogdmTVB7oaLTxncQ22PSlhAYJloocga5djQ+mi7WrtAMLX7XLOc6Yh6wBEkgeI4Md2OknhnGFjyyztt1LjO7WOKLmmK3QMqzqIJBv0AvSdQ41EDd7mOzb4ozyRh/gMsYlrenfSR/ETm7/aa+yrhj32v47Zp/nBl/SdKupgQCK0AavPvZCpBuDmaUsljXPP8F4WbwFPq1qn3L6LHJBS5; 25:nSZNnL/Tdf3Y0j1ULeuPJVjdOLiKdB8YhrUreBffnUSBGJVaS5LcLxChDgmR5s1qOSfpg/ir7P8Ts3X5G7D34tcXSFDLzc4sfpm10O7RvMkt5cV5JD1CtYOkmh9PNWThliIKZIdTtJVlQNw/XchcGzsu4aK1ZJJOQ5aBYwNNbw3l69VoWdxAtB7dw4Kc4h3RVJJ+TLf5mJViNLrdirR1I1jtvi3RWDYOwbupggig0RcKuvp4UYGI3u8XI3NoQ9rHfwaFCGK88roIbzilOLb0F4jQSSa3ACEZ6KLCz+BC/3Wpb8J5RILzVsJNfdM10ijaOg/fNLwlYa0OUsYitDmDEw==; 31:1j/wc2iWzKw+jkfZRKz8jrZh69j2H02VDDESupika+ZyABJn9khSFwV9hM3kcxjybrhXgz7mFuTPLvaJoqiZpkVnyAPr144I08Yo27QqjLgsgOhMIDIVcL0XBVzKxaml4F4ClGhoD25F06OL+AtJYZ9FXIDmZcEvyps6OfEol+bhntJ6TLtGNLKijMmbtYxwQ566UApP8EuOM5waTAHG8PAugOyLYgxuaZXOh/Fe08A= X-MS-TrafficTypeDiagnostic: CY4PR0701MB3634: X-Microsoft-Exchange-Diagnostics: 1; CY4PR0701MB3634; 20:bnnKjwjdCccFmgKno9qfYZDFaj3B1rfk5+VhAnId8itLFct6KwO37YRhmytjhGSXi3Y3/HNt45SIsI5u95dj2u0Uv+yv1WES3HETcKRGQRZwG8msyJfaEsEtZGsn7xg0z3N0sp+A8HT0BcSzbuRO42t0qfWDHqo78LelUXPXDgtnpaaEPyGXufHLtaItJi+7DZ4YtGOQghDRDcw9y+MF31jMNwGs7lZeMhPS9OqxZgq+Qd50LtSAoGRhDo0uoxE5HZhDH8qPWICIHpZTD1k+MG8QgHSJ+K3yH4OgtextY6ktSDynVMwWP48ctp1L1WLBtohqi+G7leaasU27sGDRFJUTibSSjbV49+79UMsZYtHtwDQiENx+YS/bSkcORsfaLXQ/kIZFyxxPI1bh09+b0EtHeDA/aDH3jdlz4ZuUNBjHbpfzw1zwZF3TWpR/mNxX1a7kRxsI9A1QH/VCWrDohwRsGrT9gVn+rTeYUJSHzfImQaFc06rT3LbjTJDfGr6sSWOa3jrCJpD1cLi6UDdIN7/dkyz9n1SDwamrKB/8zip8rShXDh+2w1HUJEkgjcHzbhSrCJoy1rQmDElytJ6gj0/rrMhnycFxLSB2bw9FbAk=; 4:3xdNWwX0BYTDo5MoL0iWovC+HH5oal+6N45wd0HDXB1LJvV+mhg5/79N8evX+ZSAaOEX4k2rEyo1Z6fcO4juUdmM9tilnjAmpv8BtFKKbEJUY1ht5gniRyktcAzTI3CLW+2bFuHnaljveqagg3uVYw0nSIXAL7UHhwO4z8xCsuMTz22DTiFtaaqv/9GFJwNZ+w+JmkUMYKVN3a7NlIUgtCqwLIdmuy3zkI4Aa21NdJi0LhHWPIKPl66frjYq5sAknjDn/rLjxXuaWgW6WPasjg== X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:; X-MS-Exchange-SenderADCheck: 1 X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(8211001083)(6040522)(2401047)(8121501046)(5005006)(10201501046)(3002001)(93006095)(3231311)(944501410)(52105095)(149027)(150027)(6041310)(20161123564045)(20161123562045)(20161123558120)(20161123560045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(6072148)(201708071742011)(7699016); SRVR:CY4PR0701MB3634; BCL:0; PCL:0; RULEID:; SRVR:CY4PR0701MB3634; X-Forefront-PRVS: 074040B844 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(366004)(136003)(346002)(396003)(39850400004)(376002)(199004)(189003)(69596002)(25786009)(6512007)(6306002)(316002)(6116002)(3846002)(55236004)(7736002)(305945005)(26005)(4326008)(53376002)(107886003)(53936002)(16526019)(186003)(16586007)(97736004)(478600001)(966005)(6486002)(72206003)(2351001)(48376002)(8676002)(47776003)(2361001)(66066001)(50466002)(36756003)(106356001)(81156014)(81166006)(53416004)(105586002)(11346002)(486006)(68736007)(5660300001)(446003)(476003)(2616005)(956004)(217873002)(14444005)(44832011)(42882007)(76176011)(6506007)(6666003)(6916009)(8936002)(386003)(51416003)(50226002)(2906002)(52116002); DIR:OUT; SFP:1101; SCL:1; SRVR:CY4PR0701MB3634; H:hyd1sverma-dt.caveonetworks.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; A:1; MX:1; Received-SPF: None (protection.outlook.com: cavium.com does not designate permitted sender hosts) X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; CY4PR0701MB3634; 23:bb8O/6AT4RDyWEsX0cdQZzjaoaJOZRwe5JTQlnJ?= wiaArhOns9EjMVi9CYE+L3schpYfg1my538xovxkNXaOR3yCC0HpeWeA4EuTiLDgK3AxnQJKC9WFwBlSkUH9DVKJsAvOK+v+oNo9lWi3KvHkirsE9XvZSF7zqj/Jgsm11a0EXvZgsDuGhZvsrTFIr28beFQ7KZoZC2zHq8wpPJlhrnpGeXnDg3m7LL00iK4wDBeqt3Dj9FGEOzK/BQYLL3UpRQCt54S7GZgv87apSf4qBWggYO30edKI+4NpIs95XKwOoVhPyvUjFGAu0M5ULU23PkOsdbQhfrX0xlQa2W2rF3ASt7k9/4NPYYf+dOCiPITIBGWw0kBUvijrWt4q0u6SGoCW2NRFFZ186V8HEx+O4Vo/2JjkbAjdktlJT46UJ1SKrAwgZWR0q5ncpBtNlZjnYXUWyqRXuZbYhD5JJy/+pHJB44/AOK9l4eX0QtzT0mNInlBTM1l1MH5eAvOce8Tf6yrLaGe+RzhND9BVDiC4GzMKiDpHX1yml5EmsQni4QLfJjF8XsxYtTO1ZSzEe3JrH5gny2ylNhjb3NVcWE/Nj4E9bUmeAwkIGrmsRuL5+UkcNHme0nFZURdrQ3hCV3Fud5hRx/uFmijIgfdPbDq7lB+62sfSCRnPc3whIj46eRXBZOiXgsfBkGk8RTGwRmP0hUsmzdRE9maL1WSgaB2XOk2bO5aZlWhInDhdjenrLr6aI9R51Az98ITGUSqvlFFIui2b1M9fmAhX0L0B2S/ZwXFf+TU6COB1Xxd1CMyWWfIolbAhPkICvPW+OiUIe/MVrMR8CnB47Z175h2YcdAjWrB+GYUL39qw2ghC4bW2AoqR6gHiP07KhY7/jTVa++CfagbNgH+ssXehLLjR6q6iqdwcKWRSTpJ+ccy9IcUDyIIb1db8dsAEJGc40RL43o3goj7r+5neQW7OQWufhX81STEdVOExca5Z0gJGCuENM5yzan7A+2bHFIbHMZC+wPyYGGbPrsvzvp6ZDtVaGxiFotMbzRMB5dDvWkvdBDbi62F6rPBQv2cLbaEuSCPwgud1+mSBE632Z6S3ozyDMEm+0J6KPr2AUQVldbuwRWAS+5zISlP32z3I24ig/7bDz05xFJnsK+/UFAAsh0nXq1GCuf/Qvkj9yoPbHi5Vk7j+zZXl7YmXUe4iN76j6PgU3RdqKkZk27q6Kbtqkm27n710Cjm3qdbRW9GZ9gPBCST1us7woX3KCxWih7uOvsiWPwc4JZVIIkx985rcsg7HWsN7iAH6U9lne2nMxND7CuWPFUZro7stIGNzZkTYkSyfU0gj743qbjNHe/ob69urwWGAtyTTQtZU/vlRX8WL9LjG1LUwqjS7h4sWB2sNmq+kp3+KA0G+yc8M+nSA2epIxGwQMiw== X-Microsoft-Antispam-Message-Info: 0KTV6ipxI7r7JyAyLmLqe+S6sbQqRvYcDdrxkC0OTWKSBMVG36xGSmq8e61LgSbRhGQ79KbthqVTN8QSIyq01b6vB4Czv+dMpUu2GBOuDIP2Bt3/JUS3ytqAxJ/B0YIVQdrtgH1yRkGK7M3NKCNBnZy49aRNLeTSJp3jTcKX/YBzggiSbTgebs5+4AWsHwNV/N1rGML5LoRMTk9mqh5BH0Q/zou5ZJ77i1riqZDwdkVS9KYCMotj4Fm0Gpg69mUUCvgi4/WU0ycOj6p4mw+8VtEaAkVXGhT8PSKGr/nli150mrdKVH/FEWHBA24eRbuQNgQx4zJfFq5wwnW0fWpTGRI38vnuW0U84tFkdj8ukVY= X-Microsoft-Exchange-Diagnostics: 1; CY4PR0701MB3634; 6:xI9wVdYdCbuEp7P4rFyLgx+QYzoT0H3pkbFC3sQVz9pbvWKQ1pbPH7tcwFe/wa10y7vr0h2DUH3uxhJoLI8UzohK8k9ojbmDwFra4hkmBb7LRjcmU1iVT5NCESXkorUawtwzNLo0fHblNuTgDmJNOwOAnHwO9DdKK8ohCV1W4kCDq/7PM5f5mmcUcCgsRF8HaLpWkEbsDKLV5VLJpXc8CKu/xdiXAM5jME/OmN+gAiUjH4+YJDvQT+OilIFnOdOlDC3iZhNQEMMxD3QV+kDjXHjFXl/PnjB2316m6vKMdvj1+zkfBk2eiE28driun/hHSI0q7fXibs7+jD9SLw5LwCgz7E9jcWTM3T0+tCCHw6VDe5ZR9ASb0+iy0bZXNzgeysF5MQHiC988Y76fiBZlfveWFPsGu95c86deg40fwRCrqRX7vRMn43VGAtntL+a50Ttwl0ZNdsXIr8yLA3XlcA==; 5:d2xNCxSWsisK0M+GjcDTSJwSmUiA6e8HeQwtpyNVWk4mvu3zZ6u5Wv2aKy3N7JI91we4iFNEk/UMpg80Kji8DwFeXHKM4xnGHE+nKN2JkwZ6NfI00icBTWixR5q2/6dnTDntwASqygAvS1I5HZhnWjCCs0uGEQq/UB5hBs7YBpY=; 7:5fpOOw24SBLtHYfTfR3CUmet17asy2XsfdngcbaCp+W9r6JswMXC6XQKK1a8Yebq8EuGxSx2nK5ALzPEn/eTY6TMt7FZc56r0dwRw5QtQ6k3NZ1nIkiin31CDW5hwCYi7TAMCz124usW67QuKkwsVd3exPQ75j9I6E8as8rH/z6DsiRxFReZLhg9kWzMK1q//H3RFdCvV9w2arG79P0trbNIpy+NK94TeKdajM8thRKOgSBpQXX4GvoC8t6yih6w SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 21 Jul 2018 18:18:32.2851 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: dcb28d8f-babd-4f0e-8732-08d5ef365eee X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 711e4ccf-2e9b-4bcf-a551-4094005b6194 X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY4PR0701MB3634 Subject: [dpdk-dev] [PATCH v3 5/5] doc: add ZLIB PMD guide 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: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Add zlib pmd feature support and user guide with build and run instructions Signed-off-by: Sunila Sahu Signed-off-by: Shally Verma Signed-off-by: Ashish Gupta --- MAINTAINERS | 2 + doc/guides/compressdevs/features/zlib.ini | 11 +++++ doc/guides/compressdevs/index.rst | 1 + doc/guides/compressdevs/zlib.rst | 69 +++++++++++++++++++++++++++++++ 4 files changed, 83 insertions(+) diff --git a/MAINTAINERS b/MAINTAINERS index ca27c6f..7e3c450 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -875,6 +875,8 @@ F: drivers/common/qat/ ZLIB M: Sunila Sahu F: drivers/compress/zlib/ +F: doc/guides/compressdevs/zlib.rst +F: doc/guides/compressdevs/features/zlib.ini Eventdev Drivers ---------------- diff --git a/doc/guides/compressdevs/features/zlib.ini b/doc/guides/compressdevs/features/zlib.ini new file mode 100644 index 0000000..c794643 --- /dev/null +++ b/doc/guides/compressdevs/features/zlib.ini @@ -0,0 +1,11 @@ +; +; Refer to default.ini for the full list of available PMD features. +; +; Supported features of 'ZLIB' compression driver. +; +[Features] +Pass-through = Y +Deflate = Y +Fixed = Y +Dynamic = Y +OOP SGL In SGL Out = Y diff --git a/doc/guides/compressdevs/index.rst b/doc/guides/compressdevs/index.rst index 4228768..6ba6641 100644 --- a/doc/guides/compressdevs/index.rst +++ b/doc/guides/compressdevs/index.rst @@ -12,3 +12,4 @@ Compression Device Drivers overview isal qat_comp + zlib diff --git a/doc/guides/compressdevs/zlib.rst b/doc/guides/compressdevs/zlib.rst new file mode 100644 index 0000000..c020792 --- /dev/null +++ b/doc/guides/compressdevs/zlib.rst @@ -0,0 +1,69 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2018 Cavium Networks. + +ZLIB Compression Poll Mode Driver +================================== + +The ZLIB PMD (**librte_pmd_zlib**) provides poll mode compression & +decompression driver based on SW zlib library, + +Features +-------- + +ZLIB PMD has support for: + +Compression/Decompression algorithm: + +* DEFLATE + +Huffman code type: + +* FIXED +* DYNAMIC + +Window size support: + +* Min - 256 bytes +* Max - 32K + +Limitations +----------- + +* Stateful not supported. + +Installation +------------ + +* To build DPDK with ZLIB library, the user is required to download the ``libz`` library. +* Use following command for installation. + +* For Fedora users:: + sudo yum install zlib-devel +* For Ubuntu users:: + sudo apt-get install zlib1g-dev + +* Once downloaded, the user needs to build the library. + +* To build from sources + download zlib sources from http://zlib.net/ and do following before building DPDK:: + + make + sudo make install + +Initialization +-------------- + +In order to enable this virtual compression PMD, user must: + +* Set ``CONFIG_RTE_LIBRTE_PMD_ZLIB=y`` in config/common_base. + +To use the PMD in an application, user must: + +* Call ``rte_vdev_init("compress_zlib")`` within the application. + +* Use ``--vdev="compress_zlib"`` in the EAL options, which will call ``rte_vdev_init()`` internally. + +The following parameter (optional) can be provided in the previous two calls: + +* ``socket_id:`` Specify the socket where the memory for the device is going to be allocated + (by default, socket_id will be the socket where the core that is creating the PMD is running on).