From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM02-BL2-obe.outbound.protection.outlook.com (mail-bl2nam02on0083.outbound.protection.outlook.com [104.47.38.83]) by dpdk.org (Postfix) with ESMTP id 3CEE85599 for ; Tue, 6 Dec 2016 18:35:47 +0100 (CET) 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; bh=vQ8lh21k22MVdij4OMi5fFjA6IdqLMEDHSuSl9uBZP0=; b=RYD8emaSnQTeHQbkGaImcxcAByUh0MLTQ9NCW6NNYFokPF7iNqgk2XLY6yTfR6ZsC975TPt2myE92uTfUpLZ0qFnoPo046Y5RblZACwVTe2v7lGxjOxZUyOEBYh/3/pHTJyObLBXg2CyeEwwDOkJEea7DCtICqzX2NRM3sShaNk= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=Zbigniew.Bodek@cavium.com; Received: from localhost.localdomain (31.172.191.173) by BLUPR07MB547.namprd07.prod.outlook.com (10.141.205.17) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P384) id 15.1.761.9; Tue, 6 Dec 2016 17:35:44 +0000 From: To: , CC: , Zbigniew Bodek Date: Tue, 6 Dec 2016 18:33:02 -0800 Message-ID: <1481077985-4224-10-git-send-email-zbigniew.bodek@caviumnetworks.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1481077985-4224-1-git-send-email-zbigniew.bodek@caviumnetworks.com> References: <1480851219-45071-1-git-send-email-zbigniew.bodek@caviumnetworks.com> <1481077985-4224-1-git-send-email-zbigniew.bodek@caviumnetworks.com> MIME-Version: 1.0 Content-Type: text/plain X-Originating-IP: [31.172.191.173] X-ClientProxiedBy: VI1PR01CA0023.eurprd01.prod.exchangelabs.com (10.162.116.33) To BLUPR07MB547.namprd07.prod.outlook.com (10.141.205.17) X-MS-Office365-Filtering-Correlation-Id: 0d305877-e690-4150-4447-08d41dfe4f50 X-Microsoft-Antispam: UriScan:;BCL:0;PCL:0;RULEID:(22001);SRVR:BLUPR07MB547; X-Microsoft-Exchange-Diagnostics: 1; BLUPR07MB547; 3:HrWc5HnE1qO8I08yLdQYKpVJodLbHAvQe7uTz1cnhONXTWYgL21YSJXDAllI2ESkMK1pHlHkBlhdNEjvXMFi0bcB5Ep8YLmGb/XI8zJw9Xt8iKoI0o56uJYWLQ4u+dUkQD1e6gmlpFN7f+jt874htXfeK3yABzY7p3FIPlLu8H+UObVCIt7quIaw31spfi5OLVUrR6OQ06XVmnSFWanf0kRCDH+VbgN5cEz4Oc2pO/E2NP/BeJ/Ob+rKsk/Iw73uzgGOqU4F6ow4TYi6RVZF3g== X-Microsoft-Exchange-Diagnostics: 1; BLUPR07MB547; 25:Zx9DlX4vVC4dN4sirmEnZrpULY3CxrALOeo+Pa6nn3stYSZ9WzeJ9lt9JUV/QMSH9ohKJtEaLLiIoPdcMFecr29jPYjVHeYtLSjJKsmTce2CEuuFlVyd6qS524Eu9v95i72jN8Z2r5grjQvG94ItceTYEEp5AuriHbus1TbmCt4O8/YTlX8mflmjCs3M5WVeVtCAzmXG8FgUcJcligTIWHaDzB9PMQvtkbdoP0wlJuYO9LksXKlJQmjHwTrzyZqh242RrsRXcUQ5TYtfyj/b1RL90h5nE1HJ8Dc3CjPKJGpCqVbktt2eNYoyt3mBeikGLaHK+qQCC2Y0yIvSQPTmcT0ufOMsVxWLZha2jVy2t4lpLB5dODPexELBVxPGxS2RqCVdMpxEq78/MLii2azG0ec7Av4oGLkqeC3O1OYtLWTGFjDtyvwRVU+rV7AMmUgMtHkczUSPhTuKIK23mWlwr6DT9h9EGnLEXhPl3foJlX+kDAGcoE1Gc0hC4jYLeyTe1Wbold16mA2Db39a1VdhcnAWyKQ3pLjdYqcm+Lv5AJNQ9Xn/q+9zCXTVQdSTMwOw0DYvi+BEA2kekAMpalmS3FLYmCIUHmmbihThMfXcl+X0JU7k8uWbwqW2Mvrc6y8O9tZJdS5PvzraVL2WdioCCnW49oc/JcFmzcU24VAja7VSQZQG4J/dGr/Uhydyj7csJqcYlda0I7hmlrw/Gt5ZFIX5cokN5JZzLb6Y6dD/dfkteXdGDTEn9eDbIgQ3G0uQBmr5OfsHn62cMuwOnTTmyRUnI0uj/yykJ/zizoXHgj7P5B1UGKo+a5DJT4pdPJKM X-Microsoft-Exchange-Diagnostics: 1; BLUPR07MB547; 31:y0DDJZq4YjNa1gw7gqiq1rxrUeNzu7vuVTOpw6+rLJTfhtxLB9jyznlsdmxwwXYLbs9Crs6c4cQuoqoqza6pUzdBOrcn7tHy8fV6O9B8Ijl5d5uMK5Vs0fMDwlGatrkNFbuKYkFyZgnnx52Hcb1n9mQluQlP9ux5bthFPzbEC8EmrKj+izRqwtQ3FBZ0ISWvDB9fBLTjUP1t/3ahw+MJ2y1FU6Bu8orux0d41R8N8ce/JktKVah1sWMp1eqM71tBhPU3LSBgli3N+VqhVMTN3w==; 20:j75grVsgTdKndzfdUFLk2hnmp518TOGM+AAIZAiOTBwlx9l4nH+g8XD2+XTqMDiCxudGvn3+wzEBGUdWqF51EbWC1IbSPfATGA/VLnEOUSGRvtKzFaOUnOlFaHcgWycxvlJXhF4gNvc3GYLUzWjTJTE9zqk0DLgaHKW0a9SMGuTu+1MsxPDxTNr7VJ2OduDFgl6quTJAGOs/pxMRkw6KV1d1EmuHdqGK0byEE7K2ib+JxkmbN9hALuGgzZEyN+phtxqdZ8ImrnUdqGGGReatbWr8yRamU2qVVfiMEao0NgRVzShZ56rwBMYOaN0G00RVLevJuvNMh+/CIUikNgG1N04qqrLA7F7VGthzGvkGcWC3ImVCbroYKbmIb8oo99tBo27KGaZWHcyHElg7MQgobFfzTlPGySGAN+Vszp1PjRfhVuUywlh/WUXkvgz28HwHE7Bi3V743Et+Citph7dWD36DZSKUWzTCvgkuhnTEx9BEVMw2l/eEy46+BD5GlZ6W/drimWa8NTPHGCF7ANBiQt9WB8lCsRx3pdiFdubgtPtDPbUITIGknIZOnE55wRE90TkgKnD4QskkozClezoErEurrWyh3V99keSuztr85PQ= X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:; X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(6040375)(601004)(2401047)(5005006)(8121501046)(3002001)(10201501046)(6041248)(20161123560025)(20161123562025)(20161123564025)(20161123555025)(6072148); SRVR:BLUPR07MB547; BCL:0; PCL:0; RULEID:; SRVR:BLUPR07MB547; X-Microsoft-Exchange-Diagnostics: 1; BLUPR07MB547; 4:2nZRd/0ckOm0hGCe9giWX3n3FggRZlsqx9ijFdP5b3eX/LU8CIEn9TLpm++npnSrxtI2eSSjRzhll5mb4w6TSOO5y+/7hyAgAWWz5I+A5yJsIAEQC83dPJoTVqi2B7o8TUiWu5AHwYfNaQjMsRrRvsh9YtX4jWyOHQ6H240XFhkwF5B0xna/uGdteZ1jLyPLlwjpLu24jgQ1y7UgKrF/x/yYh+W5FX5LK7BlAOIXhJod1Nh5WrtwgKlERskoB9I4kK4U0BU0g4TY/ISQ4rIIKYopgP6wuczyHoDXIV94xNxyusSIoUunV6JxbQv6kEk5fMNeYdKm4/LCdkKdlz3z0GQpphm06PvWBnKy2RTi1qlbi8+6rcQPmN6EuC8AdlR+TLyHTPBskl9guAMd2cchIpqxlDMT4dpnX0q2cNlQlE6BMKRKtwsbLtC731qwQ1ZOiE8o8A0kzlVykhIZYOAM3siQKiFX1suOFx8dm2Qrh1a3U73IQ5J6eTEOWuB0fR0JDaXX8eDNRT8yNXzy4wSRgXfrly2diKO8xs/Bn+suHL7cZYmpa5cDWRaM/TcucZSPcO7f2/3bfx/nymcSmejCgw== X-Forefront-PRVS: 01480965DA X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(4630300001)(6009001)(6069001)(7916002)(189002)(199003)(86152002)(33646002)(97736004)(5001770100001)(39450400002)(107886002)(4326007)(6506006)(6636002)(50466002)(6862003)(50226002)(6512006)(15650500001)(6486002)(4001430100002)(189998001)(39840400001)(39850400001)(2906002)(2950100002)(2876002)(6666003)(39410400001)(42882006)(5660300001)(733004)(68736007)(8676002)(81156014)(50986999)(3846002)(7736002)(76176999)(106356001)(81166006)(7846002)(92566002)(101416001)(105586002)(48376002)(36756003)(38730400001)(5003940100001)(47776003)(6116002)(42186005)(305945005)(66066001); DIR:OUT; SFP:1101; SCL:1; SRVR:BLUPR07MB547; H:localhost.localdomain; FPR:; SPF:None; PTR:InfoNoRecords; MX:1; A:1; LANG:en; Received-SPF: None (protection.outlook.com: cavium.com does not designate permitted sender hosts) X-Microsoft-Exchange-Diagnostics: =?us-ascii?Q?1; BLUPR07MB547; 23:fgkVAHQOHJHKwQVWLU+1Gzx6MAVYOkpnJxi2gWr2Qh?= =?us-ascii?Q?aYb5WphghYQz+KPhtVkXEBBHBrwWqSFljK6+1TLJV+83BqaiQfqIYXPex20n?= =?us-ascii?Q?tzGN+iO5VrtW050vZJUGeCnylQfb+Uk14VX18y8MAelg0wxV13wqH8iBUeRk?= =?us-ascii?Q?BxziIbtWs1bm3e31pl0aXdcQK4Axn+v7epv7aDwCMDhoJE/q4v1Z/NGAucwp?= =?us-ascii?Q?8LhNJfGB/8X8yH8tRpFD27v66yW+sMAsx8hlC0j2NyNxpBJlqrD8vis9FzjX?= =?us-ascii?Q?WDOb9k6s/MZVzU+p0YGDeSr4LwzgCbyAUPiuBOXwepeY53akHK+3ysfZSv2R?= =?us-ascii?Q?WhyqpqK7Grxhh8B4hNvjXgDhOMhAW/TMQOhz88OcsfvCtyAC406Fa8QN4dXH?= =?us-ascii?Q?bYo8iBPIpHMnJ+UT+cm/BI4LB2OHGjYHjRyldUolclecQIXwAoMo2+nvugP8?= =?us-ascii?Q?Wu4OMykKbqqlIQUAlRy1mNpZNfOX6BNWE+fZePJ0lD5dKwBbE6lG6frnE18v?= =?us-ascii?Q?Y8hcicbsJx2G9Y/n3gcsRJY1wpju3Dzkjcuq65cOGQufXNK0jTbFM1LvbgzA?= =?us-ascii?Q?RWd6h34ksB/w7jyKaHEJvy1LX0ukxCyXqi9Y/IAEA+Hxzx/urZaHKeKqTHQ4?= =?us-ascii?Q?NR1MpsCaT4EPZXemKdG7QZMIYocrxLRtcD+nFZikvOZcKApjv/oQRVKSeWWx?= =?us-ascii?Q?yXN+O5dSX65Z4HI7ztnSU1cNuXPUKS0oZAeupDGumJXQBac20sbmvjdZZrPu?= =?us-ascii?Q?c1UJcuZDqqWX/ybq4+qjBVszjt/hD6kIfeQUkWydHWxOLVnzTmHsPPuHf5HI?= =?us-ascii?Q?oIzvXcCfyowPgxsv30geqCPHiGyrsWKWeSyOsaOpc06YBdY2Z4yScGLTJyv0?= =?us-ascii?Q?fmakAYyhwpOsg+JvSPU+P8XOoRKexE+cTM4qZnkFgXxE9MMhLUsPd0h/04kL?= =?us-ascii?Q?+CiqhhqNKgn/5t8yDlGE+iOlmSp38X5GVvEKv1SzspC8fBI6sIRWG3YOxPmP?= =?us-ascii?Q?A28KeR3tVbsVi10fTnEdM439uFxlbuolJ5il/lxTv7DODgxJqC/SgM7nkdlY?= =?us-ascii?Q?r2M1g4/MNwUell21jamSbNDv6UoCUVJi7xkfDNkxFGTWr48Ulmj9HmUtagrD?= =?us-ascii?Q?ar43DnecCvvYuARemyRtagkNZW5bI0RgDISRSxOEV9oB9YRyxNbE016/hnBT?= =?us-ascii?Q?mJlwUZEWu7ay2A4wEQRBfEOOUqJnRTi79ro4COlyc5ZeiwX6oxUc3kFS+ePR?= =?us-ascii?Q?zwZgKe1tL0Ii+S2UPVq64+e7DYCG02hfgcfxz31sQ9tNIzUCedNjk2nZOHcx?= =?us-ascii?Q?ipxjxTnkJtvO606w1/ynYmVJ0CKyYjej5tsBJCt0U6?= X-Microsoft-Exchange-Diagnostics: 1; BLUPR07MB547; 6:LAtRd7V1FnFqxrObxnbDX3A7dbuhAL9AJQwThMpZo3v96lf64mY4NlJBEH77GQEbABFaeyo0b76VW2ojKkcDE7tM5jMW71s6FHKoUTWMJaP50V2qOkD3u46UL/1oBJa7iZE6QZFt78korZir2ZC+6su+kXReWYdpI6o8W+sbp7irZl6gYen6KUb53//zcRAU5BU7m+yOy4O2iEiDpbszpEeCCusKE2I57LnLS60eJmqDKiFrspubRxkiESfPnDHzsKz1Zs9lT5ZP7pOYNhPT86RVewHcsmJZ5AQsHnl1/oHbu3+InmUAERaJyvOjHDFk4RASjKwujQIjWjsh9H2qZCkLltV67cdMWWxsjjzOM1CmceCy9lt/FUyg0GtytPZ/rKBJw8XDMZOxgCiWC5LFCTwKuFO+MS/4gQzQWzqMu4Y=; 5:SyayY9vjq69BBJxOwopC0XrjdkQqgg89UumaZlg7B59KV44iXFiNX1TV83rhuJCMKkVwGbYtT5X7sEyrjz782VzD0i6Mxrgdc45gR9L06QOLmVxRXb7ElFYWXgltVHLmmNcSzwuBvMH+Em2+3MRO5Q==; 24:Vn4OscT1xW2VlB2MS/Si/4pqzLpZtgCm4oL9u5KYrQvu5Y8GX4dajJfLJLzJ/7X7iAxI0nbdqamdhtLjBDLxQtZ8Q9efJn85ob+RsooGp5s= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; BLUPR07MB547; 7:L/kyL/Kl8ow2ZlmhXH2zFLgScM21fMWuYHlT589leaaHbfUvBw36pNakdKEZYqLiOFiI7EOKee5A+is1kHDyqfAucDVumm2qvyGn5wztfegoVchp1nzZ8boDkmJxBd2t26jo2PkXNdMccpy6biC03z/zhyt4JkwXfuD0aDGKilP0t+eVKQGMLa71Yl2mL5j5AToJnUVGySbT2UaAr9PAk0kDTwofGYNH0GWeg5GSBh+lPY4CCQ7LlzfyM70oKb+/XutxA4xQhc2u6mQQuTZxAN7HqEIzGxhy5vCRjkCHS3b/LEaWH/L8mAKn6hl5SIoI1M++YT9qfCBmp/pK1oPW1Oq68oftaFCWglVE4p8CdtCN1DNVTUC0KDnpXRNMO3egmwrHnvUm5ZGJEdQlDT4RFy71nkXE+N9gzCDBujfynTuAkjEiL0QxZnrbCcZ9pqduV94bChcbTaCDWo3VUL3Wfw== X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 06 Dec 2016 17:35:44.9036 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-Transport-CrossTenantHeadersStamped: BLUPR07MB547 Subject: [dpdk-dev] [PATCH v2 09/12] doc/armv8: update documentation about crypto PMD 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: Tue, 06 Dec 2016 17:35:47 -0000 From: Zbigniew Bodek Add documentation about the driver and update release notes. Signed-off-by: Zbigniew Bodek --- doc/guides/cryptodevs/armv8.rst | 82 ++++++++++++++++++++++++++++++++++ doc/guides/cryptodevs/index.rst | 1 + doc/guides/rel_notes/release_17_02.rst | 5 +++ 3 files changed, 88 insertions(+) create mode 100644 doc/guides/cryptodevs/armv8.rst diff --git a/doc/guides/cryptodevs/armv8.rst b/doc/guides/cryptodevs/armv8.rst new file mode 100644 index 0000000..67d8bc3 --- /dev/null +++ b/doc/guides/cryptodevs/armv8.rst @@ -0,0 +1,82 @@ +.. BSD LICENSE + Copyright (C) Cavium networks Ltd. 2016. + + Redistribution and use in source and binary forms, with or without + modification, are permitted provided that the following conditions + are met: + + * Redistributions of source code must retain the above copyright + notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the + distribution. + * Neither the name of Cavium networks nor the names of its + contributors may be used to endorse or promote products derived + from this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + +ARMv8 Crypto Poll Mode Driver +================================ + +This code provides the initial implementation of the ARMv8 crypto PMD. +The driver uses ARMv8 cryptographic extensions to process chained crypto +operations in an optimized way. The core functionality is provided by +a low-level assembly code specific to all supported cipher and hash +combinations. + +Features +-------- + +ARMv8 Crypto PMD has support for the following algorithm pairs: + +Supported cipher algorithms: +* ``RTE_CRYPTO_CIPHER_AES_CBC`` + +Supported authentication algorithms: +* ``RTE_CRYPTO_AUTH_SHA1`` +* ``RTE_CRYPTO_AUTH_SHA256`` +* ``RTE_CRYPTO_AUTH_SHA1_HMAC`` +* ``RTE_CRYPTO_AUTH_SHA256_HMAC`` + +Installation +------------ + +To compile ARMv8 Crypto PMD, it has to be enabled in the config/common_base +file. No additional packages need to be installed. +The corresponding device can be created only if the following features +are supported by the CPU: + +* ``RTE_CPUFLAG_AES`` +* ``RTE_CPUFLAG_SHA1`` +* ``RTE_CPUFLAG_SHA2`` +* ``RTE_CPUFLAG_NEON`` + +Initialization +-------------- + +User can use app/test application to check how to use this PMD and to verify +crypto processing. + +Test name is cryptodev_sw_armv8_autotest. +For performance test cryptodev_sw_armv8_perftest can be used. + +Limitations +----------- + +* Maximum number of sessions is 2048. +* Only chained operations are supported. +* AES-128-CBC is the only supported cipher variant. +* Input data has to be a multiple of 16 bytes. diff --git a/doc/guides/cryptodevs/index.rst b/doc/guides/cryptodevs/index.rst index a6a9f23..06c3f6e 100644 --- a/doc/guides/cryptodevs/index.rst +++ b/doc/guides/cryptodevs/index.rst @@ -38,6 +38,7 @@ Crypto Device Drivers overview aesni_mb aesni_gcm + armv8 kasumi openssl null diff --git a/doc/guides/rel_notes/release_17_02.rst b/doc/guides/rel_notes/release_17_02.rst index 3b65038..c6c92b0 100644 --- a/doc/guides/rel_notes/release_17_02.rst +++ b/doc/guides/rel_notes/release_17_02.rst @@ -38,6 +38,11 @@ New Features Also, make sure to start the actual text at the margin. ========================================================= +* **Added armv8 crypto PMD.** + + A new crypto PMD has been added, which provides combined mode cryptografic + operations optimized for ARMv8 processors. The driver can be used to enhance + performance in processing chained operations such as cipher + HMAC. Resolved Issues --------------- -- 1.9.1