From patchwork Tue Oct 3 09:40:19 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Akhil Goyal X-Patchwork-Id: 29520 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 3E8191B336; Tue, 3 Oct 2017 11:43:10 +0200 (CEST) Received: from NAM01-BY2-obe.outbound.protection.outlook.com (mail-by2nam01on0068.outbound.protection.outlook.com [104.47.34.68]) by dpdk.org (Postfix) with ESMTP id 8238C1B321 for ; Tue, 3 Oct 2017 11:43:07 +0200 (CEST) Received: from BLUPR0301CA0017.namprd03.prod.outlook.com (10.162.113.155) by CO2PR03MB2360.namprd03.prod.outlook.com (10.166.93.20) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.77.7; Tue, 3 Oct 2017 09:43:05 +0000 Received: from BN1AFFO11FD024.protection.gbl (2a01:111:f400:7c10::195) by BLUPR0301CA0017.outlook.office365.com (2a01:111:e400:5259::27) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.56.9 via Frontend Transport; Tue, 3 Oct 2017 09:43:05 +0000 Authentication-Results: spf=fail (sender IP is 192.88.158.2) smtp.mailfrom=nxp.com; NXP1.onmicrosoft.com; dkim=none (message not signed) header.d=none;NXP1.onmicrosoft.com; dmarc=fail action=none header.from=nxp.com; Received-SPF: Fail (protection.outlook.com: domain of nxp.com does not designate 192.88.158.2 as permitted sender) receiver=protection.outlook.com; client-ip=192.88.158.2; helo=az84smr01.freescale.net; Received: from az84smr01.freescale.net (192.88.158.2) by BN1AFFO11FD024.mail.protection.outlook.com (10.58.52.84) with Microsoft SMTP Server (version=TLS1_0, cipher=TLS_RSA_WITH_AES_256_CBC_SHA) id 15.20.77.10 via Frontend Transport; Tue, 3 Oct 2017 09:43:04 +0000 Received: from netperf2.ap.freescale.net ([10.232.133.164]) by az84smr01.freescale.net (8.14.3/8.14.0) with ESMTP id v939gliK010009; Tue, 3 Oct 2017 02:43:02 -0700 From: To: CC: , , , Date: Tue, 3 Oct 2017 15:10:19 +0530 Message-ID: <20171003094019.562-5-akhil.goyal@nxp.com> X-Mailer: git-send-email 2.9.3 In-Reply-To: <20171003094019.562-1-akhil.goyal@nxp.com> References: <20170824000117.32186-1-akhil.goyal@nxp.com> <20171003094019.562-1-akhil.goyal@nxp.com> MIME-Version: 1.0 X-EOPAttributedMessage: 0 X-Matching-Connectors: 131514973852479975; (91ab9b29-cfa4-454e-5278-08d120cd25b8); () X-Forefront-Antispam-Report: CIP:192.88.158.2; IPV:NLI; CTRY:US; EFV:NLI; SFV:NSPM; SFS:(10009020)(6009001)(7966004)(336005)(376002)(346002)(39860400002)(39380400002)(2980300002)(1109001)(1110001)(339900001)(199003)(189002)(68736007)(23676002)(104016004)(6306002)(50986999)(76176999)(189998001)(356003)(2870700001)(50226002)(6666003)(4326008)(8656003)(54906003)(85426001)(2876002)(33646002)(305945005)(36756003)(50466002)(498600001)(5820100001)(86362001)(575784001)(2906002)(2351001)(105606002)(81156014)(86152003)(316002)(81166006)(5660300001)(8936002)(77096006)(1076002)(8676002)(97736004)(2950100002)(53936002)(6916009)(106466001)(69596002)(47776003)(217873001); DIR:OUT; SFP:1101; SCL:1; SRVR:CO2PR03MB2360; H:az84smr01.freescale.net; FPR:; SPF:Fail; PTR:InfoDomainNonexistent; A:1; MX:1; LANG:en; X-Microsoft-Exchange-Diagnostics: 1; BN1AFFO11FD024; 1:yV8dZNYtshxwE3hqcryy6iiPSIRLSk/7PptaUYLfG+A90U8y75cGFV2o5bDC216hSY69aOwUcGxQzQobiz1nqXNAtfGb7YDi6AzaHcIqCOEotI+yVeuC/QaMhnYqhX2o X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 6a57568f-4a96-4e10-d086-08d50a432593 X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(22001)(2017052603199)(201703131430075)(201703131517081); SRVR:CO2PR03MB2360; X-Microsoft-Exchange-Diagnostics: 1; CO2PR03MB2360; 3:W2+VYTKY5SHa7HG71d7GeRLXAyt/ZYtg0RvBIWhvv0uGfbVy7R/KIAgzYIV4+R5Jb1TkLSCydliQmzNP8HEpdurocNqjI+UV50mDcYEQDroDnrzhTd9uBGU+Mx1zQ/hUEe1PMYvXvRAEqW+uHkz12R9qQ69o+AO2GXdnAz6ae9elxg1kXHaP132HF5DypJSHCDZ8mIiyzoo5JDN4gUKGU8RYkpdWCw/AwQ/SXwtfV3nHNBeFdeY2lujKSfEFiwKyUMyPbfHeGNyKvbC441Bp1aTLWk965C0JKm9p/UDAGKkhvasJwLmpH2RNNV+jGfvXzLXULF8BaZnPAHamugT8G7cyikHI4ikP2T0dm4wgdrU=; 25:Z5aTzdyvFF8js8uCv6g9UdKO7gck508XZoRpvXDrwBnpErtj5bNwE7i22Lly3RtOaVM03/MUlR7xzkyjaoI4zyMM5hjszqzPJoeJc+41B+mTbEAscC4dNFVzNaB1ogQFyyzKXWqii1a07JiEmopLC9/uq91Db9Qi/a9LlblsIxUAr09D4rSklt+8jYo1hbaKDfcJ7PBL5eThZNi4HRD94b9Kb7HHehulJcuMpLbCMHCb3jP05gb1G6D1LKsdCinC2fpxVeSMPsH3v1N7sxYArVQJ7cDUnzDpkaqRsIsBlOI25qXFp079gXcJn3a4HBySBajkiMVvkVCNFrhn1tBIhw== X-MS-TrafficTypeDiagnostic: CO2PR03MB2360: X-Microsoft-Exchange-Diagnostics: 1; CO2PR03MB2360; 31:xBjhn1pl9n2nWHw5Apcl4aiNO8OMffDeSyGf38f8KEMNI2Ggubucm5PgGzV6XCaCbwnQFzPqEwHmK5ZGwDvZ73sOj3ZbUWJAquNTUenTFubp4SOSSjXWoohaJHG4hYnxBb6mx8a9UURRZ9a72HBMoqv3CyVJTjJcF51A1qRO90baEdaE9C0O8ZG5+RIVjZlyXTAEuVGzU5ARs3VgOQXa5elFs29tjSC0oBmMNLKrHv0=; 4:em0FFgNoA29nYCodwiH5yovaO1jh6dsjXlDnCA79o83Z9NoI9OVi7dIPgGFmLsi9BJc8EDc9kLHKkbO07NQg1B6H8FIHwXhP2SVU8gea7gtzLO/xBxFLAmRWj188R68QbghKnSsC0yZ7nxh+b6Qxm47njGzB0FwVGJ+pnlnCvWOvJOffgCUCYNfFyIoGjzKiaZh9OE6JOXaENjC3JfO/nLBfHmcGKZRAIsEH7Fy+AlVwObb9C8Rl2QmK/Rk1oALvqRdqsHtcbnQrjRSjS6eN2ASTTFYiOpl4a6W20ywdM4jDvDLH/CXm9x876HS9nc4MLPe9OUJa15u54cLx2VhPRuQKyNa7btdi1nVC6RGePWhoSvHqP4waUzaHGNmEWfZFzbiw33trL6Wl46kCcwAhgbLbZ+n6Zjy47D7Zjl9XUCj8cxBMXmcq+d428eiFURB6frVKNT6QZjS4wi2qfCB3Vg== X-Exchange-Antispam-Report-Test: UriScan:(166708455590820)(192374486261705)(185117386973197)(227817650892897)(264314650089876)(228905959029699); X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(100000700101)(100105000095)(100000701101)(100105300095)(100000702101)(100105100095)(6095135)(2401047)(5005006)(8121501046)(93006095)(93001095)(100000703101)(100105400095)(10201501046)(3002001)(6055026)(6096035)(20161123561025)(20161123556025)(20161123559100)(201703131430075)(201703131441075)(201703131448075)(201703131433075)(201703161259150)(20161123565025)(20161123563025)(201708071742011)(100000704101)(100105200095)(100000705101)(100105500095); SRVR:CO2PR03MB2360; BCL:0; PCL:0; RULEID:(100000800101)(100110000095)(100000801101)(100110300095)(100000802101)(100110100095)(100000803101)(100110400095)(400006)(100000804101)(100110200095)(100000805101)(100110500095); SRVR:CO2PR03MB2360; X-Forefront-PRVS: 044968D9E1 X-Microsoft-Exchange-Diagnostics: =?utf-8?q?1=3BCO2PR03MB2360=3B23=3ATdxn?= =?utf-8?q?FUQbarXxBGuAqbXWLiQ2yrvxltFtjvIHZURVV/e0fJElItsZ06bNRrWy?= =?utf-8?q?8SJ9UnUvu1Dn8M5LQdO32j7VkVl2aIkz1M9r+ZMVROhFgXmTV/Ler9NY?= =?utf-8?q?N7UIKkgFPMxFs8+tjvt4U3viIdSCn7Q0ULpbgEf66+a9GFeDn0kk8YHM?= =?utf-8?q?ogIialuroOkTRBPvYS60kceJSo75GP9R+b3ZPg2Wj9Fvhwf11bEeSMsf?= =?utf-8?q?78x/99zJOXNiG7XghCt/B4+XHSx/GshtudrkIUzadAWFw5/mDhcDCKqr?= =?utf-8?q?u5K7lLwjfxWCgyBvYFE3cR+CGzR8uJ53uLa3sEiCLg+M/uLAl/SfXPWa?= =?utf-8?q?jq5ZzDk5H1YOORsUytULAWIZu62iv81mf5VWez6j2iaI+vQzInUo53kx?= =?utf-8?q?diUzhnXZ9/2SNtHNq9pNEhJIVyeEqZqLZDylWW2sWynm+icnG97lQmNE?= =?utf-8?q?6eMKyrMsnwIL8WQp/a/buDyj5EyFmSX/rWmSlUpbpJ9frsErKDTgMWTz?= =?utf-8?q?IVk2qFYukmYOh7SQFsZAhxPBr5yf0pzJCJn+r3vkq3AHONCG/c/q5J6f?= =?utf-8?q?/MI5pw1wDqQDmjrXtecDKS5hd8OJD0w6n40mZdBU2SVTOrwKb2JXLBsU?= =?utf-8?q?XCU6nzOunQdBbmKqe7Su3fU/QyDnfj5i9TTqaWOa4NkTJ3M8QxV2LgoR?= =?utf-8?q?b/YKQN2SGHB8GSe5Pe2lSxAMA+Io/0hryxC3zdyMIHvKUV6Gs3T2qXJ7?= =?utf-8?q?o15l/tI9lyUfwLziymy0zmBxZnKQ1yhOfINCu4hZhbk5nmNcHTfaz7cr?= =?utf-8?q?cuTQkWGGSkMcjxJGMs6ZLx/mGBZTyeTGI/jwhgtxGMue2uidMwPInX3b?= =?utf-8?q?O/TwKz7vT5RPOeyQAT754vk7PQyFIgqhxnl/tAYYoi35JU8/En9lX5kO?= =?utf-8?q?cdsbdYvikqxkfrklQetyZyXJy1z9EILMQaDqsRSueVSvEhB9uy81rLny?= =?utf-8?q?0SFc/AcPwiKjgqkTffJ94YN/RjRqUbRFzy1ml8yA8jyurX1xPgQ1+f0B?= =?utf-8?q?qEE41ulKCcE2TjQQoOFxQLT/AAosT6V5UL8UMoUVpED9/jbncfXuGpN0?= =?utf-8?q?aQfqs5D/JWVtKgo5NBlA3ryBVQafrjEkEaPVhKIkMs1+RSkzQ7dNv7/p?= =?utf-8?q?hWAXUZ0qPVKDIP8phpmEDcX+KSnkuC62IeAy+HVtgmEHCCGS8iC3Ua9i?= =?utf-8?q?ve6Zy3prVwLpejNPC5U6Jl/XvUtzhvNVxpLfIuVxNq2W2V8BGO9w/+xO?= =?utf-8?q?BH0zRCoHrIbK4njt62yBshgfdM0d4el/ZZU0p0dJ4S0LIhJQYHk3VGWG?= =?utf-8?q?pMiVeCvxVRe4ZPEsMskAxUK7Al5qXK4mdGHC4b9PGSdgAwWR4Fw4?= X-Microsoft-Exchange-Diagnostics: 1; CO2PR03MB2360; 6:DDU9GhxPa8vv2JLyRitWuCs+mqZOGWc69wge7LUa57Rv0qRASYfgT6H7WMOFqv1Sd98R2Y09j+wTMw0WoByzDvMZNTYlWuaiyk2MTRThJAhj4loEBYP+AGdDN9VJ7x7cNjaj7B6NGnQ05+eyNofdpglHFMnUfdHgostUFxxIX16RoioRjQXR5KtcgnWuDR7oqob6gg3YBiYLPdLzNnG5LbqrKF6qZx090Kc85Ye61ouYFxP8wPnLC/diXd/yboVWkIAqNbhknM+NDcZvxLVn5VXu7SNDqzHAjZM/kLeKua4aGFgp3nuMFn5xebApxB0RdmST73CoF1X19Eibftuojw==; 5:VtolIKgqMCP7XVpYeGqIAulHkBhcy0BHN9HaTBjvWLeY56MqO78XXZO6DFOijUgcWsz8uBIk/I2zYGZD3qiXJ7vI0hmIsclasbpY2gl2k/XOaLNo/ATrWPv4Pp9XaG1zmR7lUrBBUx8vRIFJ0CbmZQ==; 24:FkUcWEPh6uhjvlJfMRsevQUQJ3KU2H3Sd0D9vUiXht5v76Z7yj7ElD3VkMVP5QqmlKt2XMBjJ8VDGbzG7RjK9Qnv67mYTn+Z69lEcQYeAVA=; 7:9kZtIrOPrlUKKj32btCMTIys0GMwfHj83hgnjUFw7OeA6H6VVAujrAO5V/Gl99gWNTDHJ3AQaVmz1zmcpXyMfEvwf6tH2a8d57KbunLdIE1FgvgUrmQm4lt8ZQlEPLd73b9w1P1DtGd4sdUHL7gIRcWJMgdNnWSEmBcNzEq06TytQu1jaxtLy1Twkz/VdOkU2CakXXNikvuHjR8mhisuSFnRQ+/SujdTbKvPTcn3ioY= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-MS-Exchange-CrossTenant-OriginalArrivalTime: 03 Oct 2017 09:43:04.9983 (UTC) X-MS-Exchange-CrossTenant-Id: 5afe0b00-7697-4969-b663-5eab37d5f47e X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=5afe0b00-7697-4969-b663-5eab37d5f47e; Ip=[192.88.158.2]; Helo=[az84smr01.freescale.net] X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: CO2PR03MB2360 Subject: [dpdk-dev] [PATCH v3 4/4] doc: add NXP DPAA SEC 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" From: Akhil Goyal Signed-off-by: Hemant Agrawal Signed-off-by: Akhil Goyal Acked-by: John McNamara --- MAINTAINERS | 2 + doc/guides/cryptodevs/dpaa_sec.rst | 182 ++++++++++++++++++++++++++++ doc/guides/cryptodevs/features/dpaa_sec.ini | 40 ++++++ doc/guides/cryptodevs/index.rst | 1 + doc/guides/rel_notes/release_17_11.rst | 6 + doc/guides/tools/cryptoperf.rst | 1 + 6 files changed, 232 insertions(+) create mode 100644 doc/guides/cryptodevs/dpaa_sec.rst create mode 100644 doc/guides/cryptodevs/features/dpaa_sec.ini diff --git a/MAINTAINERS b/MAINTAINERS index 9ed3115..97324a0 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -560,6 +560,8 @@ NXP DPAA_SEC M: Akhil Goyal M: Hemant Agrawal F: drivers/crypto/dpaa_sec/ +F: doc/guides/cryptodevs/dpaa_sec.rst +F: doc/guides/cryptodevs/features/dpaa_sec.ini NXP DPAA2_SEC M: Akhil Goyal diff --git a/doc/guides/cryptodevs/dpaa_sec.rst b/doc/guides/cryptodevs/dpaa_sec.rst new file mode 100644 index 0000000..d3438cc --- /dev/null +++ b/doc/guides/cryptodevs/dpaa_sec.rst @@ -0,0 +1,182 @@ +.. BSD LICENSE + Copyright 2017 NXP. + + 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 NXP 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. + + +NXP DPAA CAAM (DPAA_SEC) +======================== + +The DPAA_SEC PMD provides poll mode crypto driver support for NXP DPAA CAAM +hardware accelerator. + +Architecture +------------ + +SEC is the SOC's security engine, which serves as NXP's latest cryptographic +acceleration and offloading hardware. It combines functions previously +implemented in separate modules to create a modular and scalable acceleration +and assurance engine. It also implements block encryption algorithms, stream +cipher algorithms, hashing algorithms, public key algorithms, run-time +integrity checking, and a hardware random number generator. SEC performs +higher-level cryptographic operations than previous NXP cryptographic +accelerators. This provides significant improvement to system level performance. + +DPAA_SEC is one of the hardware resource in DPAA Architecture. More information +on DPAA Architecture is described in :ref:`dpaa_overview`. + +DPAA_SEC PMD is one of DPAA drivers which interacts with QBMAN to create, +configure and destroy the device instance using queue pair with CAAM portal. + +DPAA_SEC PMD also uses some of the other hardware resources like buffer pools, +queues, queue portals to store and to enqueue/dequeue data to the hardware SEC. + +Implementation +-------------- + +SEC provides platform assurance by working with SecMon, which is a companion +logic block that tracks the security state of the SOC. SEC is programmed by +means of descriptors (not to be confused with frame descriptors (FDs)) that +indicate the operations to be performed and link to the message and +associated data. SEC incorporates two DMA engines to fetch the descriptors, +read the message data, and write the results of the operations. The DMA +engine provides a scatter/gather capability so that SEC can read and write +data scattered in memory. SEC may be configured by means of software for +dynamic changes in byte ordering. The default configuration for this version +of SEC is little-endian mode. + +Features +-------- + +The DPAA PMD has support for: + +Cipher algorithms: + +* ``RTE_CRYPTO_CIPHER_3DES_CBC`` +* ``RTE_CRYPTO_CIPHER_AES128_CBC`` +* ``RTE_CRYPTO_CIPHER_AES192_CBC`` +* ``RTE_CRYPTO_CIPHER_AES256_CBC`` +* ``RTE_CRYPTO_CIPHER_AES128_CTR`` +* ``RTE_CRYPTO_CIPHER_AES192_CTR`` +* ``RTE_CRYPTO_CIPHER_AES256_CTR`` + +Hash algorithms: + +* ``RTE_CRYPTO_AUTH_SHA1_HMAC`` +* ``RTE_CRYPTO_AUTH_SHA224_HMAC`` +* ``RTE_CRYPTO_AUTH_SHA256_HMAC`` +* ``RTE_CRYPTO_AUTH_SHA384_HMAC`` +* ``RTE_CRYPTO_AUTH_SHA512_HMAC`` +* ``RTE_CRYPTO_AUTH_MD5_HMAC`` + +AEAD algorithms: + +* ``RTE_CRYPTO_AEAD_AES_GCM`` + +Supported DPAA SoCs +-------------------- + +* LS1046A/LS1026A +* LS1043A/LS1023A + +Limitations +----------- + +* Chained mbufs are not supported. +* Hash followed by Cipher mode is not supported +* Only supports the session-oriented API implementation (session-less APIs are not supported). + +Prerequisites +------------- + +DPAA_SEC driver has similar pre-requisites as described in :ref:`dpaa_overview`. +The following dependencies are not part of DPDK and must be installed separately: + +* **NXP Linux SDK** + + NXP Linux software development kit (SDK) includes support for the family + of QorIQ® ARM-Architecture-based system on chip (SoC) processors + and corresponding boards. + + It includes the Linux board support packages (BSPs) for NXP SoCs, + a fully operational tool chain, kernel and board specific modules. + + SDK and related information can be obtained from: `NXP QorIQ SDK `_. + +* **DPDK Extras Scripts** + + DPAA based resources can be configured easily with the help of ready scripts + as provided in the DPDK Extras repository. + + `DPDK Extras Scripts `_. + +Currently supported by DPDK: + +* NXP SDK **2.0+**. +* Supported architectures: **arm64 LE**. + +* Follow the DPDK :ref:`Getting Started Guide for Linux ` to setup the basic DPDK environment. + +Pre-Installation Configuration +------------------------------ + +Config File Options +~~~~~~~~~~~~~~~~~~~ + +Basic DPAA config file options are described in :ref:`dpaa_overview`. +In addition to those, the following options can be modified in the ``config`` file +to enable DPAA_SEC PMD. + +Please note that enabling debugging options may affect system performance. + +* ``CONFIG_RTE_LIBRTE_PMD_DPAA_SEC`` (default ``n``) + By default it is only enabled in defconfig_arm64-dpaa-* config. + Toggle compilation of the ``librte_pmd_dpaa_sec`` driver. + +* ``CONFIG_RTE_LIBRTE_DPAA_SEC_DEBUG_INIT`` (default ``n``) + Toggle display of initialization related driver messages + +* ``CONFIG_RTE_LIBRTE_DPAA_SEC_DEBUG_DRIVER`` (default ``n``) + Toggle display of driver runtime messages + +* ``CONFIG_RTE_LIBRTE_DPAA_SEC_DEBUG_RX`` (default ``n``) + Toggle display of receive fast path run-time message + +* ``CONFIG_RTE_DPAA_SEC_PMD_MAX_NB_SESSIONS`` + By default it is set as 2048 in defconfig_arm64-dpaa-* config. + It indicates Number of sessions to create in the session memory pool + on a single DPAA SEC device. + +Installations +------------- +To compile the DPAA_SEC PMD for Linux arm64 gcc target, run the +following ``make`` command: + +.. code-block:: console + + cd + make config T=arm64-dpaa-linuxapp-gcc install diff --git a/doc/guides/cryptodevs/features/dpaa_sec.ini b/doc/guides/cryptodevs/features/dpaa_sec.ini new file mode 100644 index 0000000..0e8f5b2 --- /dev/null +++ b/doc/guides/cryptodevs/features/dpaa_sec.ini @@ -0,0 +1,40 @@ +; +; Supported features of the 'dpaa_sec' crypto driver. +; +; Refer to default.ini for the full list of available PMD features. +; +[Features] +Symmetric crypto = Y +Sym operation chaining = Y +HW Accelerated = Y + +; +; Supported crypto algorithms of the 'dpaa_sec' crypto driver. +; +[Cipher] +AES CBC (128) = Y +AES CBC (192) = Y +AES CBC (256) = Y +AES CTR (128) = Y +AES CTR (192) = Y +AES CTR (256) = Y +3DES CBC = Y + +; +; Supported authentication algorithms of the 'dpaa_sec' crypto driver. +; +[Auth] +MD5 HMAC = Y +SHA1 HMAC = Y +SHA224 HMAC = Y +SHA256 HMAC = Y +SHA384 HMAC = Y +SHA512 HMAC = Y + +; +; Supported AEAD algorithms of the 'dpaa_sec' crypto driver. +; +[AEAD] +AES GCM (128) = Y +AES GCM (192) = Y +AES GCM (256) = Y diff --git a/doc/guides/cryptodevs/index.rst b/doc/guides/cryptodevs/index.rst index 361b82d..3a39a2d 100644 --- a/doc/guides/cryptodevs/index.rst +++ b/doc/guides/cryptodevs/index.rst @@ -40,6 +40,7 @@ Crypto Device Drivers aesni_gcm armv8 dpaa2_sec + dpaa_sec kasumi openssl null diff --git a/doc/guides/rel_notes/release_17_11.rst b/doc/guides/rel_notes/release_17_11.rst index 801f37f..7e8a0c2 100644 --- a/doc/guides/rel_notes/release_17_11.rst +++ b/doc/guides/rel_notes/release_17_11.rst @@ -51,6 +51,12 @@ New Features NFP 4000 devices are also now supported along with previous 6000 devices. +* **Added NXP DPAA SEC crypto PMD.** + + A new "dpaa_sec" hardware based crypto PMD for NXP DPAA devices has been + added. See the "Crypto Device Drivers" document for more details on this + driver. + * **Updated bnxt PMD.** diff --git a/doc/guides/tools/cryptoperf.rst b/doc/guides/tools/cryptoperf.rst index 457f817..6397c9e 100644 --- a/doc/guides/tools/cryptoperf.rst +++ b/doc/guides/tools/cryptoperf.rst @@ -186,6 +186,7 @@ The following are the appication command-line options: crypto_snow3g crypto_kasumi crypto_zuc + crypto_dpaa_sec crypto_dpaa2_sec crypto_armv8 crypto_scheduler