From patchwork Thu Oct 5 13:33:23 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Akhil Goyal X-Patchwork-Id: 29744 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 C88191B254; Thu, 5 Oct 2017 15:36:15 +0200 (CEST) Received: from NAM02-CY1-obe.outbound.protection.outlook.com (mail-cys01nam02on0047.outbound.protection.outlook.com [104.47.37.47]) by dpdk.org (Postfix) with ESMTP id 807321B22D for ; Thu, 5 Oct 2017 15:36:11 +0200 (CEST) Received: from BN6PR03CA0065.namprd03.prod.outlook.com (10.173.137.27) by DM5PR03MB2697.namprd03.prod.outlook.com (10.168.197.135) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.77.7; Thu, 5 Oct 2017 13:36:10 +0000 Received: from BN1BFFO11FD047.protection.gbl (2a01:111:f400:7c10::1:121) by BN6PR03CA0065.outlook.office365.com (2603:10b6:404:4c::27) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.20.56.11 via Frontend Transport; Thu, 5 Oct 2017 13:36:09 +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 BN1BFFO11FD047.mail.protection.outlook.com (10.58.145.2) with Microsoft SMTP Server (version=TLS1_0, cipher=TLS_RSA_WITH_AES_256_CBC_SHA) id 15.20.77.10 via Frontend Transport; Thu, 5 Oct 2017 13:36:09 +0000 Received: from netperf2.ap.freescale.net ([10.232.133.164]) by az84smr01.freescale.net (8.14.3/8.14.0) with ESMTP id v95DZr40030365; Thu, 5 Oct 2017 06:36:06 -0700 From: To: CC: , , , Date: Thu, 5 Oct 2017 19:03:23 +0530 Message-ID: <20171005133323.19886-5-akhil.goyal@nxp.com> X-Mailer: git-send-email 2.9.3 In-Reply-To: <20171005133323.19886-1-akhil.goyal@nxp.com> References: <20171003094019.562-1-akhil.goyal@nxp.com> <20171005133323.19886-1-akhil.goyal@nxp.com> MIME-Version: 1.0 X-EOPAttributedMessage: 0 X-Matching-Connectors: 131516841699663143; (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)(7966004)(39860400002)(346002)(39380400002)(376002)(2980300002)(1110001)(1109001)(339900001)(199003)(189002)(23676002)(575784001)(6666003)(2870700001)(6916009)(2906002)(2950100002)(50226002)(305945005)(53936002)(106466001)(316002)(47776003)(8936002)(69596002)(68736007)(356003)(2351001)(105606002)(5820100001)(33646002)(81156014)(8676002)(81166006)(77096006)(8656003)(86152003)(189998001)(76176999)(5660300001)(104016004)(86362001)(6306002)(1076002)(85426001)(97736004)(2876002)(4326008)(36756003)(50466002)(54906003)(50986999)(498600001)(217873001); DIR:OUT; SFP:1101; SCL:1; SRVR:DM5PR03MB2697; H:az84smr01.freescale.net; FPR:; SPF:Fail; PTR:InfoDomainNonexistent; A:1; MX:1; LANG:en; X-Microsoft-Exchange-Diagnostics: 1; BN1BFFO11FD047; 1:lE4nUtDn6RNWxuJXH8YGzcYHLPr5YX7gGLj14iPzA2KfGC76fP6N1UGBkD8NVgmX29EcVQBCKpRfW9M6cP6C7H25uxdYKCf1bugzfeqfVnd8HQY16V8n8C4NR7UngNs1 X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 561bbfa2-c119-4ddb-523f-08d50bf609e1 X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(22001)(2017052603199)(201703131430075)(201703131517081); SRVR:DM5PR03MB2697; X-Microsoft-Exchange-Diagnostics: 1; DM5PR03MB2697; 3:Lzfn9CV4JDxxc1oDFVT+r0i80TWl+RMkvDdNS2rWtIcZV/JnbVehOKYz7T2dwzb6KUiD5vDhRyW/CtzdcC28RTScvrdvpOTnWCyrFNcb4M5kf+Y4rH7HwbnicizIfQDG/q8dJMvkaIojYogfQK4KiAjuzuDnduFrmiLl2jxBe8/zjnfwgt/a/s83aynI9ghsWR9+c8Z62aL04UO1bnTeBFlmcF4NgBsFeiAr1rWV+T6MA6m2J2kcwKjckGWr1/R6dAZhWTatn4Ql9LNJv4rDjs8YuzTboxd+6auDR9Rjbd7jAJEeySLritUee6yFcATYOT9lPjSS5Gs7hAe3Y9fwAdMAifU9zwXtlel19ncAlZ0=; 25:n52xETXqVG0xPE467S/8ezz9fZ0RdJxVYzM9a4NJMP5MeySTMZfH0SCjfWEQ5qnnNcc+RjVpVOa6FVO4LhSADv3J35DvyUeXjTPRw084s+sic48AtyGv+g1Y09HYpQduBJF5jTjozUXcQCkrcXt2m7kzuq6rt0ihElN5Sr1UOmqwWlhv8NtW4Ydimy8gA2c0Tm5UxwqySBN5pEUg6EOmwssHYPnmc/M6X8Se2dJLr6rxCEBxiO21FpAErBOgwI2iPXNaJRW2ZHA26nfg+fg1UXoimMGFlTE9fAny8rlPgaD1HVTddxGQwz9NM/UlJdR1W1LvkM/fdZidgjp72YAiNw== X-MS-TrafficTypeDiagnostic: DM5PR03MB2697: X-Microsoft-Exchange-Diagnostics: 1; DM5PR03MB2697; 31:5SllPVPz3Q8AGjX+YJEtnxdChH7a5siguWyiMDl7V00GeoH8DCjQgHqdO8ZudNK/0dP2AmzRec4xOqi2gBVYvh/uqCYrHwJEoQoyFcQZ8bo+pTizkbf7sK0GBNPS97AYczT3xvNKSiQbOKSkV1BW3AscrG2x+7SF2I40AlxFgkS89XR5nSrcg2rMFtnQRRuaVWD33N10fgUYBdllMImUFnfIsyfBC8a5JFgAQwAXknE=; 4:zQMGxIyNV2AWO2IgU79vlGW0aMtrELNEBRi6bb00L96X1bB3VKELDqEw1mWaZCveQ+R6xN1pJ/74ceHM0+cSTV7bM0/bfvDvo4Hss2LqmbiWLO//uIJbMl7yNZAfcnwYuFBC5r4+mNU5JuEcoJp0DO92r1pKbMIkWCx4uCfQBALpT8VshBVm6y4TVhW5AjnKrLK6zVQTIDgWqOGG0K5x7gxbNgKnaEUx4NJ9vQs/7EP4IMHNPaXbcSFsJWuouzGQFl2l3wfC50w3u761PK0Cjd/l6zLTSk1h92oVdQXr8l8If0jBvHJnv/5oR53tkVeiKYwi1JUIyY758EjkEN1d5CS8wRbGMA4mDdmTaoDHhWcKQ7BzpsZgySWVk83Xm9scu5cvJknuG+qeR9szGk8OVn0sDecsXFubFuq+i3fYs6ew44rhkX2BMGd97QFQkK+U4th/X2e+zA+psUGAuA4wyw== 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)(10201501046)(3002001)(100000703101)(100105400095)(6055026)(6096035)(20161123559100)(201703131430075)(201703131433075)(201703131441075)(201703131448075)(201703161259150)(20161123561025)(20161123565025)(20161123556025)(20161123563025)(201708071742011)(100000704101)(100105200095)(100000705101)(100105500095); SRVR:DM5PR03MB2697; BCL:0; PCL:0; RULEID:(100000800101)(100110000095)(100000801101)(100110300095)(100000802101)(100110100095)(100000803101)(100110400095)(400006)(100000804101)(100110200095)(100000805101)(100110500095); SRVR:DM5PR03MB2697; X-Forefront-PRVS: 04519BA941 X-Microsoft-Exchange-Diagnostics: =?utf-8?q?1=3BDM5PR03MB2697=3B23=3AB4St?= =?utf-8?q?fkofigI8pwyzJJm+hLZCkJrjZR3F/z/ZUsbC4jU8ZEyB7vKjE1JJUx69?= =?utf-8?q?TnyVTWOt2DL1mIvYz1hPRvs6Okr92dcEJ1YIIXJUI5C2K1USti6kvg43?= =?utf-8?q?fwJ8BFsM14hiayNqCzQZpILSm3ggRbkAs71MdlWjpthP3ZgGvgJTwlGS?= =?utf-8?q?qoxDBeRVX2gqngPord5YNYJ1PdAwB6+uNKYLnexg6iw6n1PqLD40yULy?= =?utf-8?q?qrCbqsyt4xTRxHfyxEjQLhf4aDCN+X2OqtPb64UghL4S738YLyLeoS/J?= =?utf-8?q?nwZRCwr84w4wZcZHH4pjJnEKvr+bFsHTRAriogFzAzdVkq+n62I0wT02?= =?utf-8?q?nBKvegqWtzIg7Fu65MsjiC6tARJc72fPL4O/vGpfuhRMbrPdxisRjrJH?= =?utf-8?q?+BErMWwlV+QqcUjGgwdnYSz8Cnv8LNmZlqfVr9prNalpCDhJTi96J6G0?= =?utf-8?q?Y7DZjVyfqDA4yvcUfa/Qi0EIhLpqUB33+ckKr2OBY0nBP2C1uvYJDBhl?= =?utf-8?q?Fdpb9Mx+mo9PjRWlNXvoAY8NFhP5avLoJyuJ6zb/VYLNzmB8BOa1bUyq?= =?utf-8?q?2x2f/a4M6HkcrMNP20cFGNaY8atHh+PjtMO+TculA1lxiTGCUF+10huq?= =?utf-8?q?drgKYjVcNEwl8FHjvs36722edwdLdDjkxea8+dOnhKgZ04fWLXLtjWxi?= =?utf-8?q?3N2O1rO98obiSMUeABuare+9+6CS7VOTu37VOIY3mpqQbBX8iMrDRzlL?= =?utf-8?q?IK5kWkB8EGKi9Fd2pfaLvlWZbmQn1lT0LUBuVuC3K2hSMOOQy3AXNlxc?= =?utf-8?q?dPlli+arkWXQu2lh8tDs84vVQ3NJcQt9A7yjgXPAePea4u7roYIz7pcl?= =?utf-8?q?BjoM5ITJc6cEPH/Rk3MfzqkD959TA+l0pLVszG99oe9KzzIvMiX+rqgz?= =?utf-8?q?LKR9OuiLgQ7KGloi9OTfE4f8qm6hJ5S8ciuOJcQyeV7Ja/qbeR2AyPEb?= =?utf-8?q?Qakr2QB/q9zLZLSQFd9myQnJoQ5C0YrSv6YyqxOsx96p8sXdJwODAYLP?= =?utf-8?q?YO/FUsbf7vp7QcZLJY0uiYaYc593dPlongFo96zbnAExtbPNjoETUjKO?= =?utf-8?q?SDvYyDI/biLdiKCbqC0Qn+95FpE0Lvps3QLWbe5bX5c1rGEAaxs5pLDb?= =?utf-8?q?XY2y+5fM9fIdvnqaelqKDnTIIay+3oBu2MJn0vKL3ieS7kJJf9mtFQjB?= =?utf-8?q?c1faqU2sr8OJpi5/8Mo/OL+yXW5UXiayGHiUH74eHQLosurx9Obb8YzQ?= =?utf-8?q?LTKFuKWdWqRoBkUxh3ZkIFDvdZVcY9DYTM1YWdmCl3/V5R/ONnpqlt7z?= =?utf-8?q?mtsH3A2SgX/t6p5ygzE+OzmUijisPXk4w9KHI5zdOFhlzfD5DY1w?= X-Microsoft-Exchange-Diagnostics: 1; DM5PR03MB2697; 6:GDmYwV+j6NEIJ05Qpbo2zSnX1ENxrHgqzI5iDmC7DpWaORC8ZoZtyYyqRNtJeK7+X8xM6rk4y0zhzdKgi7arowaE9Fi0nUWEjDkIhs4vd26PkLFIylCBPLAYUMnxX31DgBkFyaQYdpVyqRPPnLbrgiAIeVJuA0ystJDBroskcNTi/plL9p9DOeJ1usZP33bAG+nbpmqH8A/Nl1bh9Rll4Q6ilO66dypvJIQHkjhmxQ9PMVYbJ2Hfjs5e9au46MoTnAMG3/q5vvnnM4OnI4Yb0lWkaLIX8WOgY56ITXyw4O1e/XwTcdxlSAUQfIymriwd8Ldx9NMZBFuCwZAZWl14Tw==; 5:lxdEY5JK+8jGPNPNHWa+z+xQudZilf03TgMrj+issAfFL2YqnyYl//GNlwjAmtTYZQ2HL2EdmGBdM/foV2kJGMWHfthCCP2Jun3hXyTFiMxNdqHndx208217zc/2VA70WUTdCbPB+viqej3Rm1wPCQ==; 24:TKXOMfPkJ9n4aDy4XA520K3y70nO64MCeWVyVd48a5yA5oabdtF5wZsUnwKYR81Az21TwtRB9Y21Ltlo1PwoLn++U1aw3sLMMOSowwBoFr0=; 7:3biF30x0EYY0F+dO2+0dYsPQ7+S7qcytLAnYM3g68mmPKtalyWn90vhMaGQOhXSV1nNN0wnj/vByPnL//h8gQG+HW87Q1IKKgpF9OXGmO12HIMhQkJyQdbjqfUruglaoE4vMgcOtot2Uczyk7CRsoBsH3c3S+qiM+2J2XJ/AkoR4LBPW9e3bwh1uTU1M4Rnn3JtFd0nzARgFva5yWhaaumq2N/H3VBZOAA1hTyfZnvU= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Oct 2017 13:36:09.5919 (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: DM5PR03MB2697 Subject: [dpdk-dev] [PATCH v4 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