From patchwork Mon Jul 23 14:51:14 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Shally Verma X-Patchwork-Id: 43281 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 3A44F4C9B; Mon, 23 Jul 2018 16:52:01 +0200 (CEST) Received: from NAM05-DM3-obe.outbound.protection.outlook.com (mail-eopbgr730064.outbound.protection.outlook.com [40.107.73.64]) by dpdk.org (Postfix) with ESMTP id 051694C94 for ; Mon, 23 Jul 2018 16:51:58 +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=Z8NRYmHvCVcnY3JGtrBpy8cDmkoJkALHYDzHH5jVDw+NBSMkxhQY8unEo0QHOeWBMT/X100mN8UomcjhS7A4RY2i+ZxbR1xAqg/dIre8EQc+4K57BHdAw5u5W44eX/G2ryux0MwTnzIasrUp+8CQdjktQv9QPll6kg6YDmPT7VM= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=Shally.Verma@cavium.com; Received: from hyd1sverma-dt.caveonetworks.com (115.113.156.2) by MWHPR0701MB3641.namprd07.prod.outlook.com (2603:10b6:301:7d::34) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.973.16; Mon, 23 Jul 2018 14:51:55 +0000 From: Shally Verma To: pablo.de.lara.guarch@intel.com Cc: dev@dpdk.org, pathreya@caviumnetworks.com, mchalla@caviumnetworks.com, Sunila Sahu , Ashish Gupta Date: Mon, 23 Jul 2018 20:21:14 +0530 Message-Id: <1532357474-9544-6-git-send-email-shally.verma@caviumnetworks.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1532357474-9544-1-git-send-email-shally.verma@caviumnetworks.com> References: <1532357474-9544-1-git-send-email-shally.verma@caviumnetworks.com> MIME-Version: 1.0 X-Originating-IP: [115.113.156.2] X-ClientProxiedBy: PN1PR0101CA0041.INDPRD01.PROD.OUTLOOK.COM (2603:1096:c00:c::27) To MWHPR0701MB3641.namprd07.prod.outlook.com (2603:10b6:301:7d::34) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 38e31763-f4fb-4450-ef07-08d5f0abd685 X-Microsoft-Antispam: BCL:0; PCL:0; RULEID:(7020095)(4652040)(8989117)(5600073)(711020)(4534165)(7168020)(4627221)(201703031133081)(201702281549075)(8990107)(2017052603328)(7153060)(7193020); SRVR:MWHPR0701MB3641; X-Microsoft-Exchange-Diagnostics: 1; MWHPR0701MB3641; 3:gwMTvZr9ZKBy8C/LSWftqFlOhMI0f4QUztcIns9aOOQoBaACOkVs+VQNK8i/gjeKzeueAmvK9tj5mnvm1kQzu40YGaCeV7sW5exf10xmEyjPuJalu2EsBpWzsRonbUFR3w2ByurEWdcJW3gmW3FNq1ss0DZzATkzgicB4eHpDekwouGjOrCeD7tZZrM4+hBtvDFOOLsDN09WjfSlKl9ZOgA3yXwnudJaNmUVT2TVDOD/Z1xyZgZJ4whGdxjIDQHo; 25:pin3cYKjPncGMQ+suGX8Sqb6X97K9+h0R/YXlZDsglLc8upFe5KBByL0ZlbvM17bw26jy7w9T/epyxfoPXGEfDi3K8Dkcm8Yi6KgMajDPUdajhKYl05ajXNgjUwFaKukd3JazOHUa4H8MEOe1esfDsRyhcgTbDbQKKPu0Q97Dnby77+RnAixpFdgrXUxRRqHV8q1wiKnhNeK5YfynJlV3MrggPyiON18dRaKeYwMIkqR8DdMq6pP3kgHHfqtbFAFu9igwsCpUAtPs6WkDC3Sc/GSu6at2M9PPX7wR4zFl/FYlIn6u2XXP+cV42b1EZxDggGxhY4HwRGhGenRs7YRtw==; 31:QO/QhyQHvNxSD+uD8SMNjq/wUVviO+elRg0xBD28iS+txkzdduGmzBdlo1FA/cbPvX7Vpc9TJb57bIjEJRgg8LlU6k+asgHCUQvvf3GeU/S9VYbqC74sTi+B4L6cHSYj8Qy5FoSvokqXCXaARVAE7VcM7MVux2sfyoO73GXTA7JiiK2nboTuLSB0rTbPopmkQ/lznXx55POeijoiR6c/nDz2OWeQRQ1oZDtmutg/BIE= X-MS-TrafficTypeDiagnostic: MWHPR0701MB3641: X-Microsoft-Exchange-Diagnostics: 1; MWHPR0701MB3641; 20:AekDmcSkm9ee0GvDs17l6M1bzeSlAEs4FL+JytviiS+W2NGoO9d39j7BEyFR6f7iuTiteZ64MS2F+sMa9Z8hHkpQf1J9NEwNzqs/zxzsInCZoy6dtfoZoDtZ4rpJCILXiNU92MrsqANtxfs2vuU7oZrmb7u95SJ6GjL1Wu/lUQBxkIDnBEhn/vLiunxGxYNS/ZSGpkAML+KjLB5dBqvRCNgotUy3WE/SKqwvYhkZ5nUJZ040IgcmWkyxYzzchThySSlF2gP+7G4uFgSvC1dO8GMQZ36JtZ3U/jCEMQuQlANwRoppZonRehJTf1dpjm0CcR91Pk03+TfbAfEATHUzWgKt5tyyrtHqScbh+6bmbcAkJSv1EVnn02ScLRcgHnoVlWkTAt73KGTynuRqwNeexMcVvV0XpVYuQ4yvapKqTWKF30wtssGcJPLHQdmmIJbEwrSiiICO4Vq0RypZihzR+OO+kxN0qZB4Rg3VjxEugoUtOfj8JhfUmLiDpnwhh6fuNiPXFBNADd7UXmiHnwwltyNJ0+Diz9VjoQ9Lyw/tAISepn3G+faQeFaPdoSux/CX2qFeu0n2xzoEtabRLGMY8GAXx1Rd9lh/P0NrwOXqRyM=; 4:vL91fsZ6jSwPEXzz4j17L50Nvn/wUaAa2UhALXXtM1PS8srfMUgPg/b9i/nkFOsqmEi8LPUq+71a5bNFc4ue0rP8aUtHg/JWRt3Tprcz6cexYQvHR9x5wWzIfvgYkNnhuL6sGu/wtNPqIhkAYCp0Y+rKQj6dhFArhIqpSGhvENVX0BG7Z2IRx+PsKwPb5RYginYiQtL/MPMhuZc+ayoP6WZWiugHGClwBgPuLf2zp+zg0sRLf923Y+4l2IqHTtbpbVJ1kVly5+OQf19oLF7G9A== 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)(5005006)(8121501046)(3231311)(944501410)(52105095)(3002001)(10201501046)(93006095)(149027)(150027)(6041310)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123560045)(20161123564045)(20161123558120)(20161123562045)(6072148)(201708071742011)(7699016); SRVR:MWHPR0701MB3641; BCL:0; PCL:0; RULEID:; SRVR:MWHPR0701MB3641; X-Forefront-PRVS: 0742443479 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(396003)(366004)(39860400002)(136003)(346002)(376002)(199004)(189003)(6512007)(25786009)(53936002)(53376002)(48376002)(107886003)(47776003)(66066001)(50466002)(14444005)(50226002)(2351001)(69596002)(55236004)(4326008)(36756003)(446003)(42882007)(7736002)(305945005)(966005)(5660300001)(3846002)(478600001)(6116002)(72206003)(11346002)(316002)(8676002)(97736004)(44832011)(76176011)(16586007)(81156014)(68736007)(81166006)(52116002)(476003)(956004)(2616005)(486006)(217873002)(51416003)(26005)(2906002)(386003)(6506007)(2361001)(6486002)(105586002)(6306002)(6916009)(53416004)(186003)(6666003)(54906003)(16526019)(106356001)(8936002); DIR:OUT; SFP:1101; SCL:1; SRVR:MWHPR0701MB3641; 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; MWHPR0701MB3641; 23:cTraQPtDrpuOvxDgHSj+lqT05I0xIf0g38Git8T?= Ol/HMJEUX76OlELXlwQYT5k0mAv9W/PmAaBaEmWFsh+09haTyeRaIfeUKmcg4Daj29v3x3pGWPSY+JAjwKTtWIaAG/2KZSADPbCjCbTrCOSEcPDFC56dQOv3VepzidpfM7WsuX8+ZPfSr85hxOWURluw/+oaR4/FcSl3al+KLwK0LKkiWdVNxVzhjVFJgE9mid5X+W/9rmb4Z3MQKSHHCHg3G3qjsemYX8z0GuTA+mnXgP6pU94DAfKYRuOWAo4CQo3PMeJrRhptA96Kg1mpA2WmriNyX9+o27r0mwTqOvGCNC+VxkOB43lEUndBsoskwQEpNIlGffI4C+FRG19fzVVATeyPKn+vxsZ1WYefn7Km9r8094BoA3MK3icegUb8XCS4SLZIbJAG2vgfVVDxvsObeQX1aldjZArPWbYTYEdWyukIcaKgwSsTuPDP7nObtElVg/o4lE27h6g44Whn/O77VBIcF7X77j52rEYV1oA+3ZfU9b1TVKQgb5Ac1JunMZGYYwQK2YD8lUOMKfSFqEP6sI8O61H0EzqCsWA1eL+J2jGQ15VwHxXy5HIPLAGTS4NBJtsZoXdC8nix6+ob8tlPwhsMrC6dvBMXbKuHkfb7CxUGDTU1b9IDlC5GlC0XpMJEF0CM6FmGfAcsZ7cIokSdy7dRZcYJdyKXlPNMixis/TcuKwKXl5MQrhRk/TmnoUEueLvpS06tefeqOgPZUf//aARZMnRG/f3G2V2zIkF/YD9k/lop3vbY7RxXKYaRE4joAI9v1amNSANfW6pEuiQDeW2Y1tnlGha+4fRzs1sRLcW7oReFCCDVdE3Nsx+h9PPhR8dDTIXEQaajwB75xzm1YRyrdSDhPCo5JhLNxVTGcIh+ggWrKA4DkAGA3PCvtAk4aS4GGFup16iV9eOssqJ1DMBeOnHRD4tKrCLxJmFLvtgS5v76WqgUC5nsddsWXiN/kb/AueujxZPdZDNHFE+U6IuItb0LyFW8meRoP5E/k1UtP32uuze6Zi0IuxMq0TzqYGWc7cUb2Xo52h0ojS3rD83hL/KRLoQXB4yGGwWIl6y8miPMgtxtLIXGsudfLxBYVztY7f+sAeEEAhmcFnRGCtcqDti75CeJxWm85zu54ruWxXYDKI6ZPceylY6x6jlwR/UpMVCycmjjz7CmObuI9tOBZg8o6VOmMNboxSPgoQVXWISrx6b/AMa8wlygjHc228zTjw+tUZETQoUsPAAkErLn4N0tC+R6pAUWsylYXEujKQdek+H8f7ZkToRS4G2ku1CtSOARoWh2neM7KGp7wfjprgvd+fdCS0O8KJBF1i3XczoPVdMd7zf7PmcRj1r+PdWoqSrE/IcyiEk5h35uzHP4HJcsScDSB4+2nDos+O/AhxP1cC4p18yYGjpjLzCU= X-Microsoft-Antispam-Message-Info: i2n+0c1FtE8KP9DnC4yJluH3GmC/4P+fVxQ2/ffcEWkyF7TOZAJef2+zse7T7p2A2IAhlrkmqCA3I5jC3o5XcyC/HA81NAQtc1KGb7TOYxRNB2/SkJMl5oXrm5cHrncC9/FpJO9xbsxWrp+qxVRFUNwBmSmZxe8EnjOhar8N0lWQM/OXLb3RZXKr3dbapfBGAHBSFv31kycZrkOXgm0pXocS2KBsJvjrFA+z0d+DlSvF1AQjiUjFL5tSiTeOEr5SJoRGwy+kYNcj+E+uDFK9LFBsIv64EQVZ8Pnw11kjgFuua0Y+9HWgJ0vwExqXBu8FaywY5JchFnNQekQOt381W/NAdY7XpCYKI3i3NA068vs= X-Microsoft-Exchange-Diagnostics: 1; MWHPR0701MB3641; 6:fAR3pbTc7eFxb9cIjobbML6B/oOmMWKHld5gJVLkwUqXiPfI8RYhu63HsEcQS/KMzu31hrqwVDrDqeaoEtuB3Z+H3bIc+LTw0at8W7qyDQJXMQvbtV3VG8310ExD/CUWUh4UwMTVngl27YTRvsO9e5q0wFWULK26+jQQtq5CY13EorT0DPxgG3Uy4HVz8TIrijB4OFCxk73teeT0+D+uSn8esDpkGLe/uf4+THV5dR7ubmb/ptoJikl9SwuND8i8/QTqLrAgR90x8KwsXKW5/1AJED09ieT2SPGzhSR/2DM6saOLQWEuUbPSz46W0wfaYjD/7+yQXPrC+8ecasNQzEhzqgOtGimpSLtLHuDH6YNiXqeMuyf24Pn4/TKcP1iTNTPeCe1/PBfdqr8AMl5bFkWqXak3PYKZ1wvoqKrdgwG/qbvNRZ9W8maAva7JOz3poNlJ7Koum2Xfl91l1fjejQ==; 5:i8kMbzlucufM6751+L7suQumtaKIHcFCcLANC7dZHa1l0eleZquDLraPPexSujiAwve6BGF2aQCc1NIo+CuIi7/t9IJCaYgVbo0FywlVfQ+oujFtW6RLbgHG1dRL6loceZCeXJKPPNh2rHn0bjcIaXu4AMi73edUlCN7yGLLfhU=; 7:8ObhGErUtix6MhLWGmgBiVCtfaGIyDqNJ14cokRr/3tYWzJwEzGfkiVNmcBEnLPMA3aUI8K5cSuupHrGgCOHF6Ipirf7ReX6M23W/dXzLcLEkrjt/8SQ56/jiA1J++tvl9gVBGm5xsbJl3RK92bv9Dxt4hpgAk2K38yhky8rjPOicjd8ezSXnVqpppILxUxis8Jy/lzJ0w4ADjyuPVSSIbQqpj0B4bJ7JKClmsIsnN09SiGn/Z0yeegfNvyGd1ES SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 23 Jul 2018 14:51:55.1812 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 38e31763-f4fb-4450-ef07-08d5f0abd685 X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 711e4ccf-2e9b-4bcf-a551-4094005b6194 X-MS-Exchange-Transport-CrossTenantHeadersStamped: MWHPR0701MB3641 Subject: [dpdk-dev] [PATCH v4 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).