From patchwork Mon Oct 9 14:21:42 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Akhil Goyal X-Patchwork-Id: 29954 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 0C5EB1B204; Mon, 9 Oct 2017 16:24:42 +0200 (CEST) Received: from NAM01-BY2-obe.outbound.protection.outlook.com (mail-by2nam01on0059.outbound.protection.outlook.com [104.47.34.59]) by dpdk.org (Postfix) with ESMTP id 73C481B1EB for ; Mon, 9 Oct 2017 16:24:35 +0200 (CEST) Received: from CY4PR03CA0098.namprd03.prod.outlook.com (10.171.242.167) by MWHPR03MB2704.namprd03.prod.outlook.com (10.168.207.138) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.77.7; Mon, 9 Oct 2017 14:24:33 +0000 Received: from BY2FFO11FD045.protection.gbl (2a01:111:f400:7c0c::100) by CY4PR03CA0098.outlook.office365.com (2603:10b6:910:4d::39) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.77.7 via Frontend Transport; Mon, 9 Oct 2017 14:24:33 +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 BY2FFO11FD045.mail.protection.outlook.com (10.1.15.177) with Microsoft SMTP Server (version=TLS1_0, cipher=TLS_RSA_WITH_AES_256_CBC_SHA) id 15.20.77.10 via Frontend Transport; Mon, 9 Oct 2017 14:24:32 +0000 Received: from netperf2.ap.freescale.net ([10.232.133.164]) by az84smr01.freescale.net (8.14.3/8.14.0) with ESMTP id v99EOGQb001503; Mon, 9 Oct 2017 07:24:29 -0700 From: To: CC: , , , Date: Mon, 9 Oct 2017 19:51:42 +0530 Message-ID: <20171009142142.23067-5-akhil.goyal@nxp.com> X-Mailer: git-send-email 2.9.3 In-Reply-To: <20171009142142.23067-1-akhil.goyal@nxp.com> References: <20171005133323.19886-1-akhil.goyal@nxp.com> <20171009142142.23067-1-akhil.goyal@nxp.com> MIME-Version: 1.0 X-EOPAttributedMessage: 0 X-Matching-Connectors: 131520326727971290; (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)(336005)(376002)(346002)(39380400002)(39860400002)(2980300002)(1109001)(1110001)(339900001)(199003)(189002)(498600001)(97736004)(356003)(68736007)(2870700001)(6666003)(305945005)(8936002)(5660300001)(2906002)(316002)(2876002)(105606002)(8676002)(86362001)(106466001)(50226002)(33646002)(47776003)(53936002)(2351001)(77096006)(50466002)(76176999)(81156014)(81166006)(6916009)(5820100001)(189998001)(23676002)(86152003)(6306002)(69596002)(85426001)(54906003)(50986999)(2950100002)(36756003)(8656003)(1076002)(104016004)(575784001)(4326008)(217873001); DIR:OUT; SFP:1101; SCL:1; SRVR:MWHPR03MB2704; H:az84smr01.freescale.net; FPR:; SPF:Fail; PTR:InfoDomainNonexistent; A:1; MX:1; LANG:en; X-Microsoft-Exchange-Diagnostics: 1; BY2FFO11FD045; 1:VJ1fdt/Ny2cKUUhwxjunHlrE1i0SgEbsE9Vh7PKEYViX4V2jsKmz6O3KYn/u5QwQ1PgwoR9d1/u/HOoK4GbAQW5Jr5xqxCcTMnBtcuQJMzgCOvQ6xx3DCKhL4iFuxhwX X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 2c952fc1-268d-4521-d07b-08d50f2175d1 X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(22001)(2017052603199)(201703131430075)(201703131517081); SRVR:MWHPR03MB2704; X-Microsoft-Exchange-Diagnostics: 1; MWHPR03MB2704; 3:+LoWUq7pHOvLcEpSCYOwleM+NBQlyvXCexEHJrDSRHagFKkRxZma9pBl6r3M/lzKVEJTh5Dpm6C6RW0riOB/BM/x1KnXKHTZGxwlFAtBdcQOJVqqZ4mQzSbWof46AalxqZtsVvjY50bdGMoEk3X7ceUlyssGkTEosXHajp5KFvDEcnHUHurjCNmHhyAmiRauZBLgDtGp/tWeMjQO2zbBMDLGZxzV9L1wwmhjtcA7cVozKPNbPg6YiKfPOn+x10Vy8zBPMqMxBhi+5o4ZDOT0IFQctbvF6/CZw0/qlMJ4wVn3nnJYd+eib+7YP5qI9iOKCqcO6nKsOC6Z78/WSeZRklvyh7P8aCZ8soWh+cVhI1k=; 25:E30xjJBgJgrwGFf6sWhm594XUXZ33QGPP4R7ONfhDTDqxcq8U7owPKkINLM3Tk4XBJSxxznFkR5RfS0O1jyPbujkwjCmGd0UBbKEJjlInHOBFStzGnrxDKYHtvA/TEoR8RSeujmMRpurmAi7HhcNio0CXHrxr9rrBJWVNYXgZv4NqyWlf7/k/fQT9PQBynr2O1UNd5lPzBVkb/cDMViFjTNqndTgh1wwa78a8U4vJnnmx+VUyIuHMj8HEVETL0RjhpXbIak5XjTE4KkEutWCm7TRRxyRgkpIyDlL5zm+G7rmC9EHwg6sPfAD1i4Hvsn7mSNZOCJr/gb+tOBLebBSag== X-MS-TrafficTypeDiagnostic: MWHPR03MB2704: X-Microsoft-Exchange-Diagnostics: 1; MWHPR03MB2704; 31:Kcw/J97nBPl8V1XZ6l3za8X1YXihQNmGADo7K/ryqxgiyEDWsvpnvtmRbLHlkRpIk87SFGxseucu5qEL+/OgpEodh7ylO+iZIs0bJ5tZJvJm2M1hgqmfjWK8DmuydBka29LRnvTAR3jBQK16gHDi0qbrWPPB3ZCCbdo5SPgj6rWubzy62mWbm+au5Vh7v4SLaYShUz5JO4ooHbDZT6deEmrp/C3ukk0EGrad6ZCXTZU=; 4:nVrilIj1pmZesFKlIH7neOihodRUN3DXpBkgyFSiuL1CRt718+DAol2aAZBFPWdhLDd4dUsX8Smw4xBT+7znK+WhCcBYZlMxsYJkYf5OsY9c1hOIvzEz8gy3WVvMHmBamqDgejf9mZRV2s2OS8mAUM1fNhPB1UohxxFzjZSvEKARD7xoY6crRb4GT0HOqAyzV2hJz/fJZCkyuQbqeV0lMNXTKpCV4dNj/hDlr9SAevRRrBrXP/zh+3WydenxLEe3zBygNTR1RVHtrozHgQsxiKouvo2fy2iPtquk7lV3a/jDEKsQcS0HQUkUGdAyG9FAahGETyiwPn7vJkifmrvD31MsHjaKgmrOBNVYRMN9c0wVXnK4siQO6FVS2K6bxOXJY6oxSwjJuhia91k2J+asDbB7PCbz5QIpIuFyh5bs6u7IlWTCN1tuCBcFZCvHAPwdpb2nVlAWj58CrqrS7KgYFw== 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)(8121501046)(5005006)(100000703101)(100105400095)(93006095)(93001095)(3002001)(10201501046)(6055026)(6096035)(201703131430075)(201703131448075)(201703131433075)(201703161259150)(201703151042153)(20161123563025)(20161123561025)(20161123559100)(20161123556025)(20161123565025)(201708071742011)(100000704101)(100105200095)(100000705101)(100105500095); SRVR:MWHPR03MB2704; BCL:0; PCL:0; RULEID:(100000800101)(100110000095)(100000801101)(100110300095)(100000802101)(100110100095)(100000803101)(100110400095)(400006)(100000804101)(100110200095)(100000805101)(100110500095); SRVR:MWHPR03MB2704; X-Forefront-PRVS: 045584D28C X-Microsoft-Exchange-Diagnostics: =?utf-8?q?1=3BMWHPR03MB2704=3B23=3AnS97?= =?utf-8?q?eTtUtpoOGhDMULJon3HrW9EYfJ92COl3ei+MPEQ6WeNFR4fdriN9sCtq?= =?utf-8?q?Pmj4gHvCHBqSq1FPtLcljkJnvbmMDVyrE7OOyz8vIdIC1h/mA6ztiwFb?= =?utf-8?q?Gz9Fqnp59jG08hH9LUnqHt11/moUWLHVEiIWvoNTM/b67cMEaNnbWp9Q?= =?utf-8?q?tWjC8ka3WWDMM8p/QSa5b4RV207OjMeJX+9pMGraR36dPfn3u8Gv0RkD?= =?utf-8?q?8vH55HLhC9JCA4Y3va0yX6+4R+N4n37AL7q/Z6J3FOFSu5hj9pGNpfX+?= =?utf-8?q?GVw0rPROXCUeHGzj2qat8Z9uiIzexBOBKr2RCSzgJ5GXOcl2gZ5vHZYV?= =?utf-8?q?XRDdNl0Uh/BCa5xDCOskv2n/YMOIodnpYl1UlubPjC/SpsPAXbB/v1Qw?= =?utf-8?q?ErBfB32h/qzdKfCnqiMrAINfrx69YKHj4P64QqC58LeaMv4tElTaI2sa?= =?utf-8?q?oBw70PDLR/i6pHDROfug++7qzYkN2/O4DGgVMLny6rUOnWE8qa478SZb?= =?utf-8?q?HXpdN8gjUrAHWoByUT9HH8Du1oeluYBVtAvI8RRJ1NWcKsk//iM81aa4?= =?utf-8?q?BwjnegkoRLYtpDfOh0Hr3VATJ+Vm2XGOJ4CjvxEz8XOkTEa1ZWA03xQy?= =?utf-8?q?wjxdDkRB53b15nl2O8hXV7TiWzOxx8rSrCeAMCnn3tSPA3SRoPiU1gU9?= =?utf-8?q?H49EF4gg1jNKCEHXnrrj18uaaUSgDK56MT44v6R9otL+BDDbpWpvIQVJ?= =?utf-8?q?mdEyqs+jEcLr8eFRdjdfYtWFAP7FR28HK2mmSlA4HTG+fFoJrk3irO4e?= =?utf-8?q?zz7i0absVkP5nIDKOx+hRSDbp3aNQ/Wsk4l5HhEsJYFvbLC737e2X8U9?= =?utf-8?q?GhdV4dZLiTjds5Kw7kT5HBW5eVzQoh5OZWrYFoX0yGW3Pk7RSY7IzLb+?= =?utf-8?q?b+hjI9A4PGdoi3Vcj/KyQbmwTKhD8UiZaifDxb64zy1phMwzRs8s+LnL?= =?utf-8?q?g1WfMxwRO+YrPpG6DNIC+OteXWFDkccbPb1jXe6h2X2RWG2bzKol8YkM?= =?utf-8?q?fBjrn0bW0o6OdD3nvgTHE/ILr5le4eO507nqdWtYXPb+/4J1yE0ledUK?= =?utf-8?q?8I+1/lkgxaW3a868+awhKseXKTNkKaM17sA5GKNZHwqhZqKpvbpZsmNO?= =?utf-8?q?R8RC1amAKmgtbyegF64vNyIWEtRx7xPShXLb33YZSLZlPzPOoNTvyGB1?= =?utf-8?q?LTY2XmrfZNXAMdqriLbqDF8BeniscgfWFK37qZKVcO7CXoeqCm322iNm?= =?utf-8?q?sqd+QV9a0gx/1gvuTcopGEshcH7n19dA4GQsQRlt8641lEAovVq1xiHl?= =?utf-8?q?gwuy1Lwt0wcTnHnXnDyVMxOf2fcZ0wc=3D?= X-Microsoft-Exchange-Diagnostics: 1; MWHPR03MB2704; 6:b58kkvkOe93WaxJhmVAFo0Wr+mjVdm8sbz/DRYqB89YNMN+3H1Kums13GibHGd86zLaQPe3bIFqqQGRCdnbKT+9MnhLc3QCz2ieLyLYI/d2jSZx7qUNE3yIyCSN+mYLd+jFu61i+LrDqUPSU5wFuOehmZ253zYC+Mo45mRFSRYnneA1t9TkyJ1NdR/B/FBnTAD6vWA5f3bMzSiGXHq1IyMm3A+QoQlBX1ST0vYB1MkQ3buIiZQ+ncelQGT1op2SnpeJwYhCSYk9GVKEqd+TOC0XDSdtqIpTX2n/vD4txt7idpQMb62x/tREvqNcdtT0I3Qgi8Kps18hSeVefmTTNuQ==; 5:PjGGAPbgYm6nbXlyZsMcfIkBCMH5Ek7ucS6W0inlY9/GC66Z2fOjAS43gOGV4ivZOqGwezahwuYiUGV8iom3DVp6GFCMU7ot+PNzcgw4s70VKN/O0VZ1XQ4vl0lWyF/hSnYjv+EtfmJ6HYYjMjC8Lg==; 24:yVs+PvdfjS9tSF+Tlp02vaGGYJ7K8s24fnQMwV28BFog/vVkgoUfsj/qX3vVgPfrkbl+7M+HzOTJK2bV2Hs+LR5oVRw4AnxVvblJAw5iaco=; 7:DZswLV5NgJqBm0qslGLzMQQkqLDRW19M4G1wVm521akmJUZGJWthkuWN6+rafo79GlNY7hlTy8elOW+JxkBflE5M0wulvm8au7Lsi3LvsoiDEsdjBgHmldLdZq/tP6+Y0D4IZizHjdwlryU9QzHggBwzEUzQICqBc88an3VrMaGROu5gja5lZD5Og9nufyu6h5mmUsPK3OeO9pIpmx2lM53t3fIMCP+mGjpnpRbUrYs= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-MS-Exchange-CrossTenant-OriginalArrivalTime: 09 Oct 2017 14:24:32.6099 (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: MWHPR03MB2704 Subject: [dpdk-dev] [PATCH v5 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 b051892..fb16711 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -556,6 +556,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 f133ebf..f452f0b 100644 --- a/doc/guides/rel_notes/release_17_11.rst +++ b/doc/guides/rel_notes/release_17_11.rst @@ -116,6 +116,12 @@ New Features that displays more detailed breakdown of CPU cycles used by hardware acceleration. +* **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. + Resolved Issues --------------- diff --git a/doc/guides/tools/cryptoperf.rst b/doc/guides/tools/cryptoperf.rst index d587c20..2b3a5b6 100644 --- a/doc/guides/tools/cryptoperf.rst +++ b/doc/guides/tools/cryptoperf.rst @@ -190,6 +190,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