From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM03-BY2-obe.outbound.protection.outlook.com (mail-by2nam03on0058.outbound.protection.outlook.com [104.47.42.58]) by dpdk.org (Postfix) with ESMTP id 2C441326D for ; Fri, 20 Jul 2018 20:42:55 +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=JBxT8BNdTohJNQGYqTWcAajS0RG1aAa74QQQBcoj7QE=; b=RgPgCGgTjCNkgFg1jJddg6yLAPVrADuW9kChi52AhEr1d+u6gvGvhyrFAaKD0HVLth8D7BUT/zFjJU6emt9vD80IZvHGGSbdSMTiR2h4LSIhhuagqfou40RuyKziAuc47m2oFTI1L35pzbqk69NtmI7RQtaFxAYkzD4GnakJjRw= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=Ashish.Gupta@cavium.com; Received: from hyd1agupta-dt.caveonetworks.com (115.113.156.2) by BN6PR07MB3057.namprd07.prod.outlook.com (2603:10b6:404:a8::11) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.973.16; Fri, 20 Jul 2018 18:42:51 +0000 From: Ashish Gupta To: pablo.de.lara.guarch@intel.com Cc: dev@dpdk.org, narayanaprasad.athreya@cavium.com, mahipal.challa@cavium.com, Ashish Gupta , Shally Verma , Sunila Sahu Date: Sat, 21 Jul 2018 00:34:46 +0530 Message-Id: <20180720190447.7979-6-Ashish.Gupta@caviumnetworks.com> X-Mailer: git-send-email 2.14.3 In-Reply-To: <20180720190447.7979-1-Ashish.Gupta@caviumnetworks.com> References: <20180720190447.7979-1-Ashish.Gupta@caviumnetworks.com> MIME-Version: 1.0 Content-Type: text/plain X-Originating-IP: [115.113.156.2] X-ClientProxiedBy: BM1PR01CA0083.INDPRD01.PROD.OUTLOOK.COM (2603:1096:b00:1::23) To BN6PR07MB3057.namprd07.prod.outlook.com (2603:10b6:404:a8::11) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: bad2507a-5a1f-494f-50fc-08d5ee709a01 X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(7020095)(4652040)(8989117)(4534165)(7168020)(4627221)(201703031133081)(201702281549075)(8990107)(5600053)(711020)(2017052603328)(7153060)(7193020); SRVR:BN6PR07MB3057; X-Microsoft-Exchange-Diagnostics: 1; BN6PR07MB3057; 3:2I26rfucL5Ku/TRxCOUJVwhTeT0jVTFJ9+yfEq6Q6AOoTQ6MHTZQBxBn8As+w80BO+qyXUNA9borF/Yt7hC9qXaIY9TkLB6d0UBbsx6QQ77QJn2QFSZJKDctsMIW2gAmsLO6ZhON69kbIrCzJxfUKUKmnfdUHJL3o0xLoemerOjHeZ243B4gmh8w2uVBgIS4bzqXPvP6rUlI8XjEo80silkksVJTYdb8vKkerb2SxbcmchT7NwVGFbtA8YUug65s; 25:In+W4GkEF8WIvJ8nsgLkzJxlo9rGyqW+MsAOMa67+YCTeHqAJk+hyJCi2TCPZbrEwmFpuIuJeesdrz/Ooe118WsEtKtJ/wy0q5R9yy7iK9pZ779/At8lVcRdA4nBcP3QCzo/k8x8h9TTfzq6eYCF1Mse5oLyb1/+vDvw7c5edz/vbLJrnUU8r6uNin681keY3hlVwZ5MKqIY/E44GJop7kuzpSBXvJ5PERI+UFy4wtBykx6EiPclsPA5QiNjIbZUEzGpYZOn++wvdwqyng4zMUiWcE/f0eeL952ANNEpiKZWE/HRZrOKX40SlzExz53tRImymrbITueGtnfLRBFSpg==; 31:TMcohk4HPPbVOt6RFhqalJRvbhUH7XW6cVNvMV0AKWIyM2Maw6YLmIQD6Vzb/o9wN94sGzjt0IRtsCMtilGwZOgRzsJAzrun5mkBlYJva0sw2NtGzaxz24N8rbxA9NJ7hmZJzOnPJPboRxufZ8uiqwCDoECOVfWgtoxy7y7g1c3q0lmpNzF/KGCc7TXTv35YS7r3IwVDS+yyf61DbZ2D8DYXvCdg+c7sfNhlxjkfDIM= X-MS-TrafficTypeDiagnostic: BN6PR07MB3057: X-Microsoft-Exchange-Diagnostics: 1; BN6PR07MB3057; 20:/VuHFfd8SFVfFEcw7PFUH9LUKudwfbZQNWv2giaAZbD+WntoQuGQnCII70xwOMfxFjdyjvgXVPll2RP9wYF80ljtgnss8qL657rhJlsWa0F7TmaNm8bEzrroSuMKW1nlDXRIJqQNAN3U1ERbiomZJ7HcRWRi8ZExOT3JWE/GTzfwSqni7sYl2RP9nALvL0Cjgota38WoXwnf1lL3NFWRGxpD4FavmoEnODlkvLsCmOn0B5toDlI96zB7GRlcQEItPcKKD/UOk9fcL9YjWOurUoRFRhRnnJQYoHhSP/0IvIyvnKa6GZ35hhO9pkn2rjWVmapnbEVQH4ibftwTT7UzZVyjWlxZZcrtf3YXIfG4ccbmylhz34KxMgrrpqJirkoDLH5JPzd5dJ9f0v9J2ou+1LSp2Zs79EkdXDhNeFnJ5jJKH+jD4yHHE3F3ve8stDQZraItyXvGExDabZVmtdFTqj6TIX6Kcwlky5RyS6/ZNuLBePakh74dPYs1u0/cXVy7KY1GGg4NLJlTqBenCihB0hsco6sLQ+Rczk/KUkQZnHmmTYmlVF07mM2Da/LyFpuvXYkuaTMs5DRV4vCcOGHW35Ex447ZGZ4hDAvtM5QYMFw=; 4:AC1cLwrt/J2teZdf/1o6DRIaHvtkhpqD2Cw2Ub4nR+0qhMzvtIXCCLGC9EdS5rLqOsZksrKwm6PvLYwVYcLcSg7w98KeDEP+60E3Qp5oE11nEbGMH5w+Mr5xmGtxDl9AkFvXltUU0eKgtmriKoNzshAjH3ysYNJiFkdZDmYofFK6B+zx+uqZrRdZFo3hhhd1hveOsRMUOdWjcYVOkQ/sB5vNxeERTwW5i1Ydg0JgOPJ45n2hpmgj742Ijtr/Ud8E+8vcbOOI4HtNzE0a9TmiBA== 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)(3231311)(944501410)(52105095)(3002001)(93006095)(10201501046)(149027)(150027)(6041310)(20161123564045)(20161123558120)(20161123562045)(20161123560045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(6072148)(201708071742011)(7699016); SRVR:BN6PR07MB3057; BCL:0; PCL:0; RULEID:; SRVR:BN6PR07MB3057; X-Forefront-PRVS: 073966E86B X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(136003)(366004)(346002)(396003)(39860400002)(376002)(199004)(189003)(186003)(6306002)(486006)(107886003)(956004)(476003)(2616005)(26005)(6512007)(446003)(16526019)(8936002)(81156014)(97736004)(81166006)(55236004)(7736002)(11346002)(8676002)(72206003)(48376002)(575784001)(4326008)(2351001)(2361001)(25786009)(6486002)(16586007)(54906003)(53416004)(50466002)(316002)(105586002)(36756003)(106356001)(42882007)(478600001)(68736007)(69596002)(5660300001)(6666003)(6916009)(66066001)(50226002)(47776003)(305945005)(76176011)(1076002)(6506007)(2906002)(6116002)(386003)(53936002)(52116002)(3846002)(51416003); DIR:OUT; SFP:1101; SCL:1; SRVR:BN6PR07MB3057; H:hyd1agupta-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; BN6PR07MB3057; 23:T+guRLvS8INiJ8nG6qoQg7oJ7WlA5GaNNOO9GCFM4?= =?us-ascii?Q?30Or+aGFPyHpzrwG5u0Fjf1PtSptlENzwMu5yL6OG/w0Kn8C18t4BDBKSmea?= =?us-ascii?Q?DaK2ziBLSHXa5O4ujVfmBoI1F4GQHNQJ/Fx4PW5fyUW8le+uCwmzYALX6Nnw?= =?us-ascii?Q?HqizfkxX1UvQjIe6mF1IB0MVPoNF21f4b33q1gwRmH1R0j1R7gLQ9i1sc/2F?= =?us-ascii?Q?Ic7Ct6XqCkzwoqhLSjn1gIcPWln+0xjXU/jTnZ8ydjF+hLTAB/Ko6kHA7pVX?= =?us-ascii?Q?FEaiECvDo8ZUW98yYuZJSCh90o5+CUevAW1mpIQfEWkgshFDveDLXrGRmNsz?= =?us-ascii?Q?DkmBSb6CUBpzdTQOMQFtSf1mymCs269RUawwt48dwaMIrgtEl03EDihwN7sR?= =?us-ascii?Q?qZ50TpsA0uy6xAjtaVYtGfnZhLLT7bR8smc0x0Gr/FAAuIrx5WG2tgY15XFy?= =?us-ascii?Q?2WGzHupXRgkwpwc09C1bJ1PUN9D6UaPTEiMoA3St+7087crO1hrCaMUlAwqr?= =?us-ascii?Q?wS14PYh7rGZPbT0qy981yI/mBguhlQEdj5xOIj/22GcZImzj0xLtZtrlxPCW?= =?us-ascii?Q?wWGYM5id0m7jSlaIvL44bzTSHlPNgaZZAPHLwERDL1KbRRl/mjYR6d4GbWnk?= =?us-ascii?Q?fXCcSNfR8AlA5pCRdBYLFlFIWWeT0wCV/U38TzsjIXYtepEQlBDvdl9dKXor?= =?us-ascii?Q?+CNvZwKj0zfmA3mkoNT/L55NOFVu9+IoI6LIdJFIyG7B4hiiGKmqCm3bDiGj?= =?us-ascii?Q?OJuZ5fEEL/bNzQI0EMWnMZfaA0Bok8zjHAPfSo4gzi22DRc0KH6ULK4LOQZl?= =?us-ascii?Q?6w1GICdNzj/xyqfRQiy83eSXQDMJWIDKTO9LsmrKs+ElfZqJWqLx7McFtBjk?= =?us-ascii?Q?wXqAX/vDy6Bjvi9Z1Vb1Gt204L9HNBR5JMlZB2FZotZ+U9wlfFhQOeQL5ZvP?= =?us-ascii?Q?ALgHs/Z3KxMDryVTtj6lmXr2n1S+Sy5oCubIl7p/iYjXJWIHyz4IjxmNUuyQ?= =?us-ascii?Q?D4Z86QT6v+u00OXZt4uSwzKvXS8MQMR+LgY1b8WDPbPU7UEIAYsBO2ZR6Ltb?= =?us-ascii?Q?gPovDXhaIjLEWqGEa2re1eFePjko8xGrcZJQc2TIAuKGIZI/lad07c2AqGky?= =?us-ascii?Q?7x8gk5vmsLc9s8R0KNE9AD4TR/G+LI/eis5+loxAenBfhKT/7SZ7sAc0sPeO?= =?us-ascii?Q?XbMBjvgNql71VgunS3h7L/uGqkIlcA3ZCzggNOTR1zWm5n6mGM4/u27rYHzl?= =?us-ascii?Q?/51T4eyg8kUMep/B8ZvxxSmSXtmDjCE59tlJnRRNFG0fokKryueLfrvomfX5?= =?us-ascii?Q?AlZBzfpB0bUW15ezj/+bjS1PxyQz6cs9dirxQ9BOYArKoREPztuwa47pYakK?= =?us-ascii?Q?4z93V9qfqdH2HDQRfeCKcZ68wTPhem/Ct04ZomOjXV/rY9l?= X-Microsoft-Antispam-Message-Info: zdOwAoftebs5yEsYnYdn2YCNR/oWjGX4XLE7N7XiMsitpNCGGedyRBqZgfaerT8K90Q4IFT7RyimgsJeCjrErTv5Mp2y5P7lFfhPacjf6hfyvaZsxAmM81IQGgECOXa/UdtLnrCMeb4qfWo6fHB3tzlmdWTHqL54RvNH7iMFU9x+8bMaBocpQGOE9NOwd8zSkzG1Ukui3duEGPVjYM9gjcqg3LJkGJCydAgpmJS/mbuStlh4crGXBROyJ9Z5dUVX68FC+/Fzj2+24R288fBdIuLfhMpL5GJEC7XmqR5ZJ83akOIeWTDc24GfIrI9pmin5G4oxmgVaaKONPE4rcERqhLgfZSvr47ZTbRMwBmU2DA= X-Microsoft-Exchange-Diagnostics: 1; BN6PR07MB3057; 6:t71liyq9c542AvA+nejHDiFgDPowWJ41pHSqtK0q1aD37853iPz1vNMwV6QxU+yatp5sqlH/xCv6oST6/4M6eXS/dvE1d9EVfcV47TB4C9qy5f7oVXeR9918X93WqOhJkMgTq/gFoW6yIpzRFBBY3vBpeuif4HBkD4psmYMy58s21bMXZW2wR/oD/nMMZCuh4Gq8OP3HqgbWFbyGi0tYXQLmUWwB13trKR+0uh92JCRTqOyThYQzP5zoCg25KQha1v4ONxfuVh+LT5xLj2pFwtgDJLlDKjQxqdrionrRVehyOkPkIxiEGYQRbFuw0UAOeHhFW3URvClHiBNhS7AVyu1ghh5pq5IQHkWdaNdgtFfOA7AcVaePWw8vfDbgZruA3IklwR8TRww8cgq200AP2z1VOY7jPTR0PT+DX0jvG1HAzz5X5bbSzPlIepK1l5/UUaG6KCzXYkvDkh0JA9tuXg==; 5:d/MBXvOWvMpz6qAswn7DDmtS9tpRgStVWc89h3UMS8I7w+TBuPKsewug/Ahmhh57noq4nKJbatX1FeK03XFMyyUgQ7/OFNl6wKxPT3thVP5hKe7Di06jozyu+YUH0zJb770UyBOWRHrYOFrzs/C+eDfpdLrvqK0iCUPa+irG8WQ=; 7:nE+0L369W+TJ27Y3QGgqAWj0+ZeK77YPUEUO7VDTh9SOZ/iRTcPvpVNOhdNhXPc3ncHRQvMfjt4EcwiV6IBtUsofShl/MviLIXIWSmGFGf4UrqyCMjFQi4Xe+1mvQJo0vIY0M1hhVoSW+GaYwU7LzR4LKe/xj2xhFNCLYe1JEkfKuXbCGtXIFth3hPQyctk9n0tXefDoS1l+bDTn4XpKMQpYq2iX7IfhRBmORflJVjUjq0H6NxyKTuga/ajM8MR+ SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 20 Jul 2018 18:42:51.1724 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: bad2507a-5a1f-494f-50fc-08d5ee709a01 X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 711e4ccf-2e9b-4bcf-a551-4094005b6194 X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN6PR07MB3057 Subject: [dpdk-dev] [PATCH v3 5/6] doc: add Octeonx zip 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: , X-List-Received-Date: Fri, 20 Jul 2018 18:42:55 -0000 Add Octeontx ZIP PMD feature support and user guide with build and run instructions. Signed-off-by: Ashish Gupta Signed-off-by: Shally Verma Signed-off-by: Sunila Sahu --- MAINTAINERS | 2 + doc/guides/compressdevs/features/octeontx.ini | 10 +++ doc/guides/compressdevs/index.rst | 1 + doc/guides/compressdevs/octeontx.rst | 107 ++++++++++++++++++++++++++ 4 files changed, 120 insertions(+) diff --git a/MAINTAINERS b/MAINTAINERS index 852f4f726..c1496cd7a 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -858,6 +858,8 @@ F: doc/guides/cryptodevs/features/zuc.ini Cavium OCTEONTX zipvf M: Ashish Gupta F: drivers/compress/octeontx +F: doc/guides/compressdevs/octeontx.rst +F: doc/guides/compressdevs/features/octeontx.ini Compression Drivers ------------------- diff --git a/doc/guides/compressdevs/features/octeontx.ini b/doc/guides/compressdevs/features/octeontx.ini new file mode 100644 index 000000000..884a8b073 --- /dev/null +++ b/doc/guides/compressdevs/features/octeontx.ini @@ -0,0 +1,10 @@ +; +; Refer to default.ini for the full list of available PMD features. +; +; Supported features of 'OCTEONTX ZIP' compression driver. +; +[Features] +HW Accelerated = Y +Deflate = Y +Fixed = Y +Dynamic = Y diff --git a/doc/guides/compressdevs/index.rst b/doc/guides/compressdevs/index.rst index 422876873..094baf8bb 100644 --- a/doc/guides/compressdevs/index.rst +++ b/doc/guides/compressdevs/index.rst @@ -11,4 +11,5 @@ Compression Device Drivers overview isal + octeontx qat_comp diff --git a/doc/guides/compressdevs/octeontx.rst b/doc/guides/compressdevs/octeontx.rst new file mode 100644 index 000000000..0b53f9b0d --- /dev/null +++ b/doc/guides/compressdevs/octeontx.rst @@ -0,0 +1,107 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2018 Cavium Networks. + +Octeontx ZIP Compression Poll Mode Driver +========================================= + +The Octeontx ZIP PMD (**librte_pmd_octeontx_zip**) provides poll mode +compression & decompression driver for ZIP HW offload device, found in +**Cavium OCTEONTX** SoC family. + +More information can be found at `Cavium, Inc Official Website +`_. + +Features +-------- + +Octeontx ZIP PMD has support for: + +Compression/Decompression algorithm: + +* DEFLATE + +Huffman code type: + +* FIXED +* DYNAMIC + +Window size support: + +* 2 to 2^14 + +Limitations +----------- + +* Chained mbufs are not supported. + +Supported OCTEONTX SoCs +----------------------- + +- CN83xx + +Steps To Setup Platform +----------------------- + + Octeontx SDK includes kernel image which provides Octeontx ZIP PF + driver to manage configuration of ZIPVF device + Required version of SDK is "OCTEONTX-SDK-6.2.0-build35" or above. + + SDK can be install by using below command. + #rpm -ivh CTEONTX-SDK-6.2.0-build35.x86_64.rpm --force --nodeps + It will install OCTEONTX-SDK at following default location + /usr/local/Cavium_Networks/OCTEONTX-SDK/ + + For more information on building and booting linux kernel on OCTEONTX + please refer /usr/local/Cavium_Networks/OCTEONTX-SDK/docs/OcteonTX-SDK-UG_6.2.0.pdf. + + SDK and related information can be obtained from: `Cavium support site `_. + +Installation +------------ + +Driver Compilation +~~~~~~~~~~~~~~~~~~ + +To compile the OCTEONTX ZIP PMD for Linux arm64 gcc target, run the +following ``make`` command: + + .. code-block:: console + + cd + make config T=arm64-thunderx-linuxapp-gcc install + + +Initialization +-------------- + +The octeontx zip is exposed as pci device which consists of a set of +PCIe VF devices. On EAL initialization, ZIP PCIe VF devices will be +probed. To use the PMD in an application, user must: + +* run dev_bind script to bind eight ZIP PCIe VFs to the ``vfio-pci`` driver: + + .. code-block:: console + + ./usertools/dpdk-devbind.py -b vfio-pci 0001:04:00.1 + ./usertools/dpdk-devbind.py -b vfio-pci 0001:04:00.2 + ./usertools/dpdk-devbind.py -b vfio-pci 0001:04:00.3 + ./usertools/dpdk-devbind.py -b vfio-pci 0001:04:00.4 + ./usertools/dpdk-devbind.py -b vfio-pci 0001:04:00.5 + ./usertools/dpdk-devbind.py -b vfio-pci 0001:04:00.6 + ./usertools/dpdk-devbind.py -b vfio-pci 0001:04:00.7 + ./usertools/dpdk-devbind.py -b vfio-pci 0001:04:01.0 + +* The unit test cases can be tested as below: + + .. code-block:: console + + reserve enough huge pages + cd to the top-level DPDK directory + export RTE_TARGET=arm64-thunderx-linuxapp-gcc + export RTE_SDK=`pwd` + cd to test/test + type the command "make" to compile + run the tests with "./test" + type the command "compressdev_autotest" to test + + -- 2.14.3