From patchwork Thu Aug 24 00:01:17 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Akhil Goyal X-Patchwork-Id: 27829 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 [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id 92A2A7D93; Thu, 24 Aug 2017 02:03:31 +0200 (CEST) Received: from NAM01-SN1-obe.outbound.protection.outlook.com (mail-sn1nam01on0067.outbound.protection.outlook.com [104.47.32.67]) by dpdk.org (Postfix) with ESMTP id 162727D82 for ; Thu, 24 Aug 2017 02:03:28 +0200 (CEST) Received: from CY4PR03CA0003.namprd03.prod.outlook.com (10.168.162.13) by DM5PR03MB3324.namprd03.prod.outlook.com (10.174.241.145) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.1.1385.9; Thu, 24 Aug 2017 00:03:26 +0000 Received: from BN1AFFO11FD005.protection.gbl (2a01:111:f400:7c10::189) by CY4PR03CA0003.outlook.office365.com (2603:10b6:903:33::13) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384_P256) id 15.1.1385.9 via Frontend Transport; Thu, 24 Aug 2017 00:03:26 +0000 Authentication-Results: spf=fail (sender IP is 192.88.168.50) smtp.mailfrom=nxp.com; nxp.com; dkim=none (message not signed) header.d=none;nxp.com; dmarc=fail action=none header.from=nxp.com; Received-SPF: Fail (protection.outlook.com: domain of nxp.com does not designate 192.88.168.50 as permitted sender) receiver=protection.outlook.com; client-ip=192.88.168.50; helo=tx30smr01.am.freescale.net; Received: from tx30smr01.am.freescale.net (192.88.168.50) by BN1AFFO11FD005.mail.protection.outlook.com (10.58.52.65) with Microsoft SMTP Server (version=TLS1_0, cipher=TLS_RSA_WITH_AES_256_CBC_SHA) id 15.1.1341.15 via Frontend Transport; Thu, 24 Aug 2017 00:03:25 +0000 Received: from netperf2.ap.freescale.net ([10.232.133.164]) by tx30smr01.am.freescale.net (8.14.3/8.14.0) with ESMTP id v7O03B0k026464; Wed, 23 Aug 2017 17:03:23 -0700 From: Akhil Goyal To: , CC: , , , Akhil Goyal Date: Thu, 24 Aug 2017 05:31:17 +0530 Message-ID: <20170824000117.32186-5-akhil.goyal@nxp.com> X-Mailer: git-send-email 2.9.3 In-Reply-To: <20170824000117.32186-1-akhil.goyal@nxp.com> References: <20170824000117.32186-1-akhil.goyal@nxp.com> MIME-Version: 1.0 X-EOPAttributedMessage: 0 X-Matching-Connectors: 131480066056437331; (91ab9b29-cfa4-454e-5278-08d120cd25b8); () X-Forefront-Antispam-Report: CIP:192.88.168.50; IPV:NLI; CTRY:US; EFV:NLI; SFV:NSPM; SFS:(10009020)(6009001)(336005)(39380400002)(39860400002)(2980300002)(1109001)(1110001)(339900001)(189002)(199003)(2950100002)(6666003)(50466002)(305945005)(23676002)(8656003)(106466001)(356003)(2906002)(47776003)(77096006)(8676002)(5660300001)(81166006)(104016004)(81156014)(189998001)(50226002)(8936002)(68736007)(36756003)(2870700001)(54906002)(6306002)(53936002)(626005)(105606002)(4326008)(5820100001)(97736004)(498600001)(85426001)(1076002)(33646002)(50986999)(86362001)(76176999)(575784001)(217873001); DIR:OUT; SFP:1101; SCL:1; SRVR:DM5PR03MB3324; H:tx30smr01.am.freescale.net; FPR:; SPF:Fail; PTR:InfoDomainNonexistent; MX:1; A:1; LANG:en; X-Microsoft-Exchange-Diagnostics: 1; BN1AFFO11FD005; 1:/00wd42SbfTitv4TCFSQh6BKnnqGbMG/7u0r+T7izWzOmPaRq/7AESeO3AUg+WYoobFFPoBAffU1gfHHatJU58R/wR5xP5rvKHt11HHbdPDqJ7tNMwDMGRcYAPtt+vjJ X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 8cf0a172-60d2-4a7d-5cf2-08d4ea838acb X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(300000500095)(300135000095)(300000501095)(300135300095)(300000502095)(300135100095)(22001)(300000503095)(300135400095)(2017052603191)(201703131430075)(201703131517081)(300000504095)(300135200095)(300000505095)(300135600095)(300000506095)(300135500095); SRVR:DM5PR03MB3324; X-Microsoft-Exchange-Diagnostics: 1; DM5PR03MB3324; 3:8PmwsklUJm+E0Kl/6wbwQh1ZgJ1oB59J+V20tVgVHfOPSCHKFN8lrjeL/E0/VbY5dIWIsCygdrBn1Ry2r2vd52zzvUA7iN/JrbC5Af387/QoNrfVlUWu4KVpEqZO3VMxEj9LYxnN6sOR+YzvSNHyMFcWmgPrjaOY3lW4It0N+fg0fNSqv1AIeJ4FTBAZ6ZHxQDVk8MiS7qCFltitWAp+w2tX0fP0rQwGhBNaFasV3evJJckTWKET1tgx9aUAVt20l8uhEE7XzvRdEUFlGq33J5C4JJc39hRKfVKsvLYEqagpoURiDGCe377G+7X3D2zT8PBdtPTdxgRUXRmbLwN+q33flq6Sb+FbH5FQ7hpH7hs=; 25:um42HIKuaGwD7BXMcXEmMzXT8MvioZkaAmJWYWdGQLiuaij1DKINix6QWhGjcwVCn4mLGl6MPIaaun7cYJzDcqq2C1dpdygJxkWjJgNUalH9zsTFFrLOxSJSGVfhzBZT8WAFV/x7P/iz6WUc0YPAgHHP7xW6RDfUDHlyeP5napJrtXG8hEEVOtApIv0SNqIxIi/vrgTepJZPG23e1FIK7mSkK1YtG7ahyC1QoGAOYU14Xh85tIl8XsdWkWpu6IPTDtANp6M2nu/Mrd/ZU2nLyVXsqWmPwKIB7owxeWh+mTl56MTeMN8E2k5NdjzoBhCSLdS1jQjjaR5Ee76x7Da0LA== X-MS-TrafficTypeDiagnostic: DM5PR03MB3324: X-Microsoft-Exchange-Diagnostics: 1; DM5PR03MB3324; 31:eUPn9QknQzsse15k5fenDJC1O6dQDU0n22KbOxJH0H+pc1s1hc2hR6iGe/s15mikC/ow4SWb2mtiFgbXxZO6yi/TFIm6zx38/tycaJYBLIyz9jeeXZs7yve2/jDQfW/3a8jNq+IBw+cxV6j8XToOjaXWtbWeuI/TJho4EWQwgPOE4sv3c1+vM3NEi0huK1J92/rU4t25UNMAPho1uuAKKP7ff7w/XIOdyZgfRqjegIo=; 4:YFIyV+G9ShVIdoO2kwWq7ktq8qja+DfDyRPU8UHcbB0t6udqsI3VRfUaifKs8NJSqajEhP6T7Izzje5d/2hIHMCTzvzYAQOmYtPOQJcgUu/fif1RlZGEH5XnKbl1R970i+EUQuUCTIganwD+Igg7aDkCUWACBWzCj8p6+tfcCzMWXQVPNcExzl1WZup0NQLBR0I1AWnsq7QD+SAKRB+sN2yW9eMZQb60OL8SCeFVGI1UX9MgqMNcN3YqydviS1PBEdRGv5D5hzzteWpeHSO2vLkDEJc2Qo1qLEh9p0WK9iVJqtNEzIzxeuScTROYo2jUU9aG9bvK2wlyp9AgOYsOI5IDMNnbPAOjFolK3dfSnMOHRs2lgOMm2beySLWM32Jyoc7zsen22EW1xK7j0qwviijJtVuwZ7PzXW3lhxaeYUEhAkT0xr1F5+vbSogtKlCh X-Exchange-Antispam-Report-Test: UriScan:(166708455590820)(192374486261705)(185117386973197)(227817650892897)(264314650089876); X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(100000700101)(100105000095)(100000701101)(100105300095)(100000702101)(100105100095)(6095135)(601004)(2401047)(8121501046)(13018025)(5005006)(13016025)(3002001)(93006095)(93001095)(100000703101)(100105400095)(10201501046)(6055026)(6096035)(20161123565025)(20161123559100)(20161123563025)(20161123561025)(201703131430075)(201703131433075)(201703131448075)(201703161259150)(201703151042153)(20161123556025)(201708071742011)(100000704101)(100105200095)(100000705101)(100105500095); SRVR:DM5PR03MB3324; BCL:0; PCL:0; RULEID:(100000800101)(100110000095)(100000801101)(100110300095)(100000802101)(100110100095)(100000803101)(100110400095)(400006)(100000804101)(100110200095)(100000805101)(100110500095); SRVR:DM5PR03MB3324; X-Forefront-PRVS: 04097B7F7F X-Microsoft-Exchange-Diagnostics: =?utf-8?q?1=3BDM5PR03MB3324=3B23=3AFZnz?= =?utf-8?q?st/7858VikUojTv7LqO+XSY7QkYFqC1E+WBKUuUnlzlPPPH9PsorN8zs?= =?utf-8?q?wKA+gTWyEqOYTXK4uOyHUkvETBfQD4/1lwX6TFOwUtbZ4CK4J33k9N2U?= =?utf-8?q?zVUdxO/wnf9iJ/6m3egHrLhr5qI7reS4g8EP1msuj41D5z8jqFGQ4Hh+?= =?utf-8?q?CA7rysGmMfHUq8/7Dgs4ZDiLyEsvfFOEXTOCB7oT/kxQN0W6lQBHyAbN?= =?utf-8?q?Dii7t4aMFwDOw1kxtm/nsq1pWAyFGHmljTKnoMW4/VXfqy8Y1D5gugK2?= =?utf-8?q?As0hq5RPlO9br89G8dEJoqtCFlc18vyszMzbfdkNV7bsk81PlkKKROfK?= =?utf-8?q?dP8gbp3RcFOkgZ0qKaQc8sLcQ/8rnO2X8+E3AEdbWBcXnFFS1xlr4wdC?= =?utf-8?q?ZsWQj0kWThvFjiwp9vVf5WT2PG6TbWmEfX2Uo33IkYslTmqsWfO4/vNH?= =?utf-8?q?bnw6J6C1c9GxNckYGrvd9fDbbcIV0YzJ2uQ441CX3Cg2UbMBsccnIb/5?= =?utf-8?q?6XVRfJetBpDJLaLB9i5fKSU0OQ+q+/VDJlsJo7NxnWe6xoGLoSu1DdEw?= =?utf-8?q?Y4/pJT14xP8TV9I2rI4rePah6Qsj+QJAShRML2q4973q329umBjrgQre?= =?utf-8?q?jLzILqwP8yLmRR6hguucApf8OBDp5bA0ODZ5ervgFfkxo+muEeZM3lzW?= =?utf-8?q?y/XD6s2uEYv0G4nzXZdIR1sBp4gk99hNELVvLEhlDGjdVrGb1/BhRUoJ?= =?utf-8?q?IPOBp6DRnxJZCSgcTC/4Ju0wKUL9zOIySM0utxoZg7b+L0bHva5zmgU5?= =?utf-8?q?UBAfj0qcCXhDnBxNkZuaL+Q86+L7jlknQ0RQr7UkljcVvS3EPoSsOf8h?= =?utf-8?q?MjddL3CF8MZwZBVDb/9psRM/oJrkmrThoNMtekpgbxY3lNOwCSQA56tp?= =?utf-8?q?r3TAM46kclTOeYjpYq3zpqJKp/s67WiNbKjTonAv0VtHHjuIwm9Lpu1t?= =?utf-8?q?zguIxNKojllmWaVl/r3Mtk8RVSZGW684giiNNz0WiPRNUm/n3SkQR52o?= =?utf-8?q?Q6XwiB61TMOB4DYTf0GuvuyUvk5F5ej9E8TBLVWHm3jIWDO6PwRAxeQS?= =?utf-8?q?oYx33/lK2lYE7IgBmMeJYby8uc9FToDoaDiywLLrnr3xuMzk6yj49v7X?= =?utf-8?q?dHem87i1DpsUIFQRKVHcWoW0vjGw6W8IU5cXe33X5bLArAfvHLKOtf6S?= =?utf-8?q?Gi5hINerQ3fuOHI=3D?= X-Microsoft-Exchange-Diagnostics: 1; DM5PR03MB3324; 6:bPLUWcRg1vVevq2tiuM0FtVRoXdbpottPnuy+OSC2EZL03GdTEegNNHoduzveo3ZypBpJvlLNy05fWrWkfW4eEGDX9ASmBOPyhSbVnsO/Nu9EyaCesSNAstdOK7FkAwr3eeDDZSLIm7xdnb5eQdQXymf8qxi1wJ/v3LKY3Ye1Enb46JYkTvyLHj05GgZt9rexXfkK1HdM2JyDzr8RizghZU6dLsl/NTpm5NNLzr6Sz4rFNNAUQH30UszvEmlzWvzfmP+vIhQlJnvuosK9R9rSQNT8P8348r+hSxxzk+EMx3BA3mXwz8FBilgFlRPBjxvVuOfEzmzlJLKQAvDgP1Kcg==; 5:UwPSZ1oRe4VY43P+QggQuqQk45vF6nWUT/K44tyS/5bzNXszduWW1Ki8AWlY0upSWcXbgqwand9MHfH7Lz/qZEgNewAWhkjOqfdBvLWWa9SqiLZnpHJa2G1jSKgCmEmAngm2ofQZZkdqC01p/75YxA==; 24:Y4eAiHcdEr4oXdWNyKPJAHBu4fi5MFMeh2kk20kEMULwVzEL6udXtLwBWDEKSz/VViCusgBLOANG4hOHetlwMyQpjnLvHhEAmIDOCNUePsU=; 7:vHyPzk2ZFkdqOBaC7deOWMsvggw6h5NIzkzgfGM0RM3FF1G4YeBgUVCaYYmdwbTA/ei6/Z+eggaQxfy4TKuZqHfl5OtFXdBhA5xaEdkdgQw/AF4q0aqOFCcCyH1oltqZx3fOguQ+My8YP2bW2f06dJT2Fy40Mi6BivK5LXiOeBUIi21LCUMiwPiS5i4fOZCdb8Q+gWa0zeN7nzxCubbNaEoDTSor8iHlQy+Kqw8iG4o= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-MS-Exchange-CrossTenant-OriginalArrivalTime: 24 Aug 2017 00:03:25.4565 (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.168.50]; Helo=[tx30smr01.am.freescale.net] X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: DM5PR03MB3324 Subject: [dpdk-dev] [PATCH 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" 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 + 5 files changed, 231 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 24b3b41..78a3b84 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -557,6 +557,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 170f4f9..6ac0de6 100644 --- a/doc/guides/rel_notes/release_17_11.rst +++ b/doc/guides/rel_notes/release_17_11.rst @@ -41,6 +41,12 @@ New Features Also, make sure to start the actual text at the margin. ========================================================= +* **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 ---------------