From patchwork Thu Apr 20 05:44:24 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Akhil Goyal X-Patchwork-Id: 23771 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 5EA0E7EC3; Thu, 20 Apr 2017 07:45:26 +0200 (CEST) Received: from NAM02-CY1-obe.outbound.protection.outlook.com (mail-cys01nam02on0048.outbound.protection.outlook.com [104.47.37.48]) by dpdk.org (Postfix) with ESMTP id 653A558FA for ; Thu, 20 Apr 2017 07:45:07 +0200 (CEST) Received: from BN3PR03CA0075.namprd03.prod.outlook.com (10.167.1.163) by DM2PR0301MB0608.namprd03.prod.outlook.com (10.160.95.24) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.1034.10; Thu, 20 Apr 2017 05:45:05 +0000 Received: from BY2FFO11FD040.protection.gbl (2a01:111:f400:7c0c::103) by BN3PR03CA0075.outlook.office365.com (2a01:111:e400:7a4d::35) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.1034.10 via Frontend Transport; Thu, 20 Apr 2017 05:45:05 +0000 Authentication-Results: spf=fail (sender IP is 192.88.158.2) 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.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 BY2FFO11FD040.mail.protection.outlook.com (10.1.14.225) with Microsoft SMTP Server (version=TLS1_0, cipher=TLS_RSA_WITH_AES_256_CBC_SHA) id 15.1.1019.14 via Frontend Transport; Thu, 20 Apr 2017 05:45:05 +0000 Received: from bf-netperf1.ap.freescale.net (bf-netperf1.ap.freescale.net [10.232.134.28]) by az84smr01.freescale.net (8.14.3/8.14.0) with ESMTP id v3K5iavg015982; Wed, 19 Apr 2017 22:45:03 -0700 From: To: CC: , , , Date: Thu, 20 Apr 2017 11:14:24 +0530 Message-ID: <1492667067-21968-11-git-send-email-akhil.goyal@nxp.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1492667067-21968-1-git-send-email-akhil.goyal@nxp.com> References: <1492616268-6307-1-git-send-email-akhil.goyal@nxp.com> <1492667067-21968-1-git-send-email-akhil.goyal@nxp.com> MIME-Version: 1.0 X-EOPAttributedMessage: 0 X-Matching-Connectors: 131371407051778142; (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)(39450400003)(39840400002)(39400400002)(39410400002)(39850400002)(39860400002)(39380400002)(2980300002)(1109001)(1110001)(339900001)(189002)(199003)(9170700003)(305945005)(6666003)(2950100002)(6916009)(2876002)(81166006)(2351001)(106466001)(189998001)(105606002)(50226002)(8936002)(2906002)(50986999)(8676002)(76176999)(38730400002)(2870700001)(110136004)(33646002)(53936002)(6306002)(4326008)(23676002)(47776003)(86152003)(8656002)(50466002)(36756003)(85426001)(54906002)(69596002)(77096006)(104016004)(86362001)(5820100001)(575784001)(356003)(5660300001); DIR:OUT; SFP:1101; SCL:1; SRVR:DM2PR0301MB0608; H:az84smr01.freescale.net; FPR:; SPF:Fail; MLV:ovrnspm; MX:1; A:1; PTR:InfoDomainNonexistent; LANG:en; X-Microsoft-Exchange-Diagnostics: 1; BY2FFO11FD040; 1:ZHjqC130nrbptvdQboh8tFiEGiccijaf+VZf5nWFkKH8pUf37wG/TtHMURLigIR2dunfZwKXzpLXbVXAP1oFTwwpoWfsDrYWdW+xFLT1HXxHzMfehuegK9SbkOpkJUY4MorrRl150W7Lo7VohRx+SZFCAizCUKpmlhnQ1fNk/E7Q4mVCJuXTv9IhhOaZA38peM4T3lFX+LkCGyKW/qxVeRno+SdO0yWuQC4hdrDvz5z0ja856ea/Iyjr1JeBvXLe070pw+vyyO1hLDt0V/OK4W53UEX2Qo5vyOy9E7ydvwih5GEwx9T5NPJCFhD8kanZMG/SoDut2AzKVIRxTtCgSgTbDH4o8S7yGn6uelb7fAdHKUAZ5oBaRcaHn4tOLK1hZPk6+iH9AO4ute2PNWOTdWapWIvHHX2UCgmNhMNVUehl6wMPC7/B8k6rIcLosvVs6Z0+qDmcbyEMZWgxJIgIHVTl1BpKBQcGg5GtLyXYSC3Mypmqlr8zCVvEbGFJyC1/L86Fx0KwKrj7f4FMqk1YoMYK8FOxXfnvCy5iFeF5in71AKOnEJnxHWqZ9H5q6C+CdI+uSS/U7wPv5WOZA3kw/h6mqdgUQ3JAuw/3n8LS3Wi08fg88gRdJIVvBvNco/K/rNIYPl6RSnFkjyz70LncU/s83QJvl/aNToO12mMjREVblY2s03H71/kv4k4KNtxKCfkAccvrPem6xRQCTrnXrwZMPugKFa/RF4JtIhTGy/oldkwCT2bVK1nTw+vtoaroEpLE+su6qJo7rfngqAYOWg== X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 8462c7b3-a1a8-4568-86fd-08d487b0656b X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(22001)(201703131430075)(201703131517081); SRVR:DM2PR0301MB0608; X-Microsoft-Exchange-Diagnostics: 1; DM2PR0301MB0608; 3:B6Mazeb3chXfy8bXbYZ4oaCuhY0C9o0/8mbfnb6aR/DlNsXNhvJHpkgnsS6bVa3SX1ZYWT0vDuRiEjH8hJZq52+q3Wpygfr3/RHfDzKpgLOxnXt0Q9TMxYSmEi9Txrm91dAGmlZzve0T6qTf8/LVySTE/eRZew6WA6QQcbYxGhoramXc9NopfA5eS4CWjIX9DEBmdlfsTSHYvGb6mo6evZXyuIJthXhxh9UGmUsGm7R3mSpWyEMKF90DOgO1jyUZdzK4SIHzlxeFwgKBrLrcC3C9wXapkqaCOj3VwM1NpX3M4vao3fgKzQwrPehTEd5IJ99OOy7jO3CwiwpYkNbuM/zQwXuSiiHMOYNI4MaRmThVQDNdRks5YhcdFbvgiMxgbLfcldigCfx1x0z8SI9S7fL5uxF7KIe9sShzAGfM6wqtBjXcH7HuYjcZA92t+ahz; 25:awuUfS/vCjwaHDX5Zycmsqs/9eLgfaY5HfuwLeycZ0KL/NIKzOd/hvU1sapdJgHbrdqKQJN7d2KqkNTyUoFByT0aNKQBEcbpnrK7gyx0x5XIVuIqHD0sgxSUYFNb0QhnOb43dLkICOB5mOj+L4r6cERQf4j+Xj6SdMd9x/9iRhPPGBjW3VnjXatm2VD43JH0KYVw4552y3AxHAKa5Tw5vsoRQT+4wcy0+5CfFFEipEPjhyAD0Iy5Y/lVFJXhrwra7asKTSk+eXIiN0CCWjypWLJwtw4r0hfFhp5cWKFEGwCvWbcMKqkXoJp/bndLYfp0tMTnN3IPhib6hnW36gbPAfFvzksHfuPcPI7RJYqAzqC9MOFzxOeL9ASj72IbdQNs9DoDxivKDQtZ+bFue13VwuCC/kRN8ocOXR4xUHzCuXj05KuxrV0+aUcGIzj4HiBkEJ6Uj0sau+mLwLlPKP2hww== X-Microsoft-Exchange-Diagnostics: 1; DM2PR0301MB0608; 31:xHOT8MLMTJMtEWM3+xG78f9Lg+V+nhznieT6wIh4KZQgolH/z+wAlajMn/vv3xY26AvA7r38nPZxmMcJltRYgf0bz5NmkSnsPhy8l5yMGFdtORNN844nORDjstkXCPZxpWBEUfzsujffaMlkGvkIjoXxRi77xspxOXSAEwTVm3KcNgyD890lRNXxLmw25XU3C2Z9ObpVzXlJLNFcA5EgHxKSt4AUT9iQW6OxFOXgv2WDccjIn9tc/Q9G0DJXCb/OGaP9PFkXKO0e9vHki3YdvA== X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(166708455590820)(192374486261705)(185117386973197)(227817650892897)(21532816269658)(264314650089876)(228905959029699); X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(6095135)(601004)(2401047)(13024025)(13023025)(13018025)(8121501046)(13017025)(13015025)(5005006)(93006095)(93001095)(10201501046)(3002001)(6055026)(6096035)(201703131430075)(201703131433075)(201703131448075)(201703161259150)(20161123565025)(20161123556025)(20161123563025)(20161123561025); SRVR:DM2PR0301MB0608; BCL:0; PCL:0; RULEID:(400006); SRVR:DM2PR0301MB0608; X-Microsoft-Exchange-Diagnostics: =?utf-8?q?1=3BDM2PR0301MB0608=3B4=3AVi7?= =?utf-8?q?SxFGxRx3CEe9V71MAvXwMO/uRQiOJ8oM2wKBHHnu/sIPIISvhQOuEzo9?= =?utf-8?q?yc4iqdQG2yBr+iyb+817n99Cv/NRlTTR/n6HGT38eZar8+FP39IzfGTj?= =?utf-8?q?YPx14VrlvB0+GRMuH6aYkVLuYj4F2S7kn7DnZbhzBEP5Pkbf7qpXFltZ?= =?utf-8?q?2m1caaKrC08IwMm0IDY++77ia8dpRFPkHO33EswpvE6xAeiXeS32kGbh?= =?utf-8?q?PSHzpwo1POE16KRwzhkoNCdsZz40L04nH9zjAnbn+heuzysazn1DhI7s?= =?utf-8?q?qFAx6MCS44wfK7++F7LCNsWDDT2unDItAJEdAzlmEXYpOpr562i5UsoC?= =?utf-8?q?NKzHYWnBYmRmqUwItW8rlDbDdw/ozaj/qFw7zqvabBplmIUeV5DZ1Z6D?= =?utf-8?q?i/HlOYbU83CW986YQIa913pTAhjuiq2QiBL8YAQKj1iz5pUdq5o2QMrB?= =?utf-8?q?6Kj3Z41yAJnqNH8wyraQ3lM0jYFBJMjXPbBRNH5mjq0FCtsXiE+jpShn?= =?utf-8?q?+KXRl5x0exVBmBZfVODqJAWRfjgx8/oNFBE4vKrrfYH27YsuCVsh3NeN?= =?utf-8?q?xGQ8SZ94EMOXAKJGL+k5rkfyHKesuDl02pxPuN3dq2SmBOO5wwXIE+d5?= =?utf-8?q?Z7ev4Akdxn29c1xiav+NEj/oVYTmdUsTnJZpsRGrazd+oUEfh6+R46DU?= =?utf-8?q?4xvVyOR/HVrtYrbl8QNmV8vgSa35CZ+1pR/dMtEcj2YByIcPgC3G4jxX?= =?utf-8?q?PKTDaNBjjyesyC9vNYnzNFZlP6eqWBrQiBCb85GYcvxPT8kztBI0yyVQ?= =?utf-8?q?fNjQUfZ+VHvdL1hB3abk1Z8o1gArkXAZUdGL269dv1rv8oLQQiswdqa1?= =?utf-8?q?sm0kGgw7onR2V2gThRk9fK6FWf+6Nuc787CKLgIC/ATA6dJquf5dxc/w?= =?utf-8?q?CBs3zPjOdhlinyBI77MjB0FwwfnwCZNaoQmy4vOy+tFs/Qd3Dh1ZRtB3?= =?utf-8?q?01XDggr5ZAWGYWpPZRxw3M5Ffn6+D/rmUr53ESAVUDsEusT2EazdNbCk?= =?utf-8?q?d5J9jriNaZHofxpUECAEQBnzS75BKz/3Gjt1RphVN+r0egGkDc3u/qpb?= =?utf-8?q?PvOo3imJ53kQEDo3wS3OvYd5qGwSSaOg8HKr1J5cxiQ=3D=3D?= X-Forefront-PRVS: 02830F0362 X-Microsoft-Exchange-Diagnostics: =?utf-8?q?1=3BDM2PR0301MB0608=3B23=3AeW?= =?utf-8?q?Ln4nXVyO9YT7Aqz5jCT0WFmcnJUjeI0fo8GPmJ/cbwwYU9NZb3hSoHHq?= =?utf-8?q?AeEqjP5kDLsf0Bmq8hQekvLbiOciUPGdF9geyn9TKXOhpxA7uTX+raYZ?= =?utf-8?q?p/AqQz2i6v4BYl3HBdsi9E5BE4Vw4rR1I1YG3a6XO4EfmPeoYFH9Ph7h?= =?utf-8?q?EkhyD3UnqPm3wPRewE+Rhatd777UMWJgborfo56WJuTaf6bWxnSDGdzi?= =?utf-8?q?Xlcrqskn7q8btJ1TO494dHduQfxHyKn0IVXbBUzJiBzDSF9OssWBaC9I?= =?utf-8?q?qPcScy/sVchDHsC/uUIut+6F9KaXGCddeobWNllaskSf7l1xT0WOvT4n?= =?utf-8?q?n0cL11Z+A+jOVwTyKf0ZeieOJ00zfcDLyRgggx+dquwPpyTvpqt4WX4Z?= =?utf-8?q?LMMZJ2Gh+m/iqRnHMB7HD1ARbLOqHIzf7oaAzg5ci7meblenWlv6CJlF?= =?utf-8?q?Wln0dl0sVis8qSO6HNxswggtV6ykXUKVLLAYX+s6vxz5XLvgtNneLRhj?= =?utf-8?q?T3K5D3YQheJgQFcdcvBnryHd43O6gSOgzIBfjVTBVi5CQVjKrl+bplvI?= =?utf-8?q?V1e16X8qBqlfekZ3efqJ4RCfAzOfVC7vcPZBe30R0ZRJASGLid4QJdbr?= =?utf-8?q?2thRb8ywYB18kKhXJM7GWVMXKA7SxbcznJKitikahNEMrY8iVyc4jOss?= =?utf-8?q?SMdMS0wvFhK0uv3yfUHnnfJlzh1JX1zlOwGWm1sew8RwEuIr4YnHWvUx?= =?utf-8?q?G4raeqblYazPqz792LNlGBHyok9eoGXoKffYKgKrN9pXSnX/hJjskhKN?= =?utf-8?q?V3n7dex8vjihCPG8+cDPiLGTlpsE6p4htv/pmud2qVMrV8JxeDqmHFPP?= =?utf-8?q?XAUWsXYcgN8mG711Oej/zILQJPjhxesDOGU3jXZUADkDqlFD2ONlyqLs?= =?utf-8?q?xI4/4toKHb5/UmZZbPdPDuYJvjp7xS1q17b/3U43InVgN+kvx4xDITLb?= =?utf-8?q?VcwlChDtwCr43fqpy6ECT5qEMWXbMwkHPmNSk+6hv9/DEUlOpew/GyJn?= =?utf-8?q?0HVqxeC5viTbuhTzEoumTbJW1tfavfmGo+v8eOfjK+9x94hYKMsJb4Ed?= =?utf-8?q?boXtE60aHJypXCgh35HFTNmQAVC8kSgse1Pbx+frtetSZMgeJ7JV4J03?= =?utf-8?q?ShxLZgNb5dq77U1Ib0FD4cJSkp97LK0f8QT8PKiSfhJNpBNE+RCffRGI?= =?utf-8?q?W81Rx4AUnjNc7PQ9ZHTldDPRx9tLtsUvtfMk2U7NIAkYgG6XBKX9Rh44?= =?utf-8?q?EOIFDtLlDUCQrqn0H0IirCxmlxRAwsJcE6duDnXTHZgsFDcFKjyYiXub?= =?utf-8?q?aZ0HCiU84uYkJoA31ChJQFxBekLDPppi6WyL4cVB/hVJ1Mjdg/lyoy?= X-Microsoft-Exchange-Diagnostics: 1; DM2PR0301MB0608; 6:IjiHkRFpJB+29g+I3LvvZ9z34DYeYvvNq5+4R+5fnOjv4ploPpP7EZmJAvT44M6jlWqZAOMh5fcKveI5DuALBz9XQyajbPh1kKnukrFcP7d8thr4G9vzggL2xGqecugTtss1zABgv7g4EgJz0Ig6ajSw5vEgmgrghY845jx0BLf6agM5EVKkIUdpIxgSJ1vR487kxKjl4XiQJvqHWuKQtt4XJhrZCyDGJdbPthfhvNvfhWmruR3s2HnrLyrMmZ4xFSXPsG4E5tTolS7JHU4AAWO9/Kn/F5fVKvQTKV4/JppnDWbGKv/HFWA/u749OcRaFGRAON7JCp0Azy7ElKDXxYbYxwy9OjICgYN7njF4PoqbufEXMomK/25tCmvctBNVZl98MyW2VWWxMk9X1Enp2sqCKtsj0Rgnjl9VDzuxVSsu/LtPI8cMTi67Cgr72EcFzfHlhaEApTj1JwOTkBAWVAFQJ+0a/h7INVfiYs5ms2OIvuFlmItF84rNca4GdIVF; 5:dxFiI2M53/vrcj9xa/FlH9zJf6wXjjFOnHMJLQSudndb8Ylwm7REszMuMJ8jbeIYen4DM5jW9io0WWsoOw/8/F/oG/qMowOb0ben7qG8sR/ix/pIACZuZLsCBKjyw3dcYA2pN9jLZs4+4ziDy/19J2QcIloUxiaTL1hhzwKwXfogYN6PUmars0k+GFRgGn5C; 24:klQ1jcHrDlrLtVqP0XqhGGdycw+6DctEp+jPxY56ZRIK0JCY6IXDPkbmv5VL6HXUWF6kP82BfVhr3Q65Ag8/5hdEWKT24VP3CNg6bZYILT0= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; DM2PR0301MB0608; 7:gKEg3sQ7SRGBJmElhM5tYFWvsXEmlRkL861aZM5hr547gf2mVzGXUG7YwtBsoJh95jdjj1v6dN8RSmB7pVuQaslnC6p6/f0ctOQaAX1KgTVrSHPXN5LzGBuQTWiNX2Gd5gc1vYaUg/6sG3IG/zF4gI+jvSZeFTVyvmB3rZGaNosu/t5ldsEFOuca/kLlfzYePfrrenmNsOuwswfQZqImBzM4Cnyv1iI1ZRLlW4Tys7HCGPoXnw85qHLtwOWTLzwzrGFXRMZmhRH/Ezs89coKyyNQomb1SJNFPVg47NSU1BOTODiwLbdJ5bkEEvaqz0pH+cKkP0ZZKpkTrA9MuIT/WA== X-MS-Exchange-CrossTenant-OriginalArrivalTime: 20 Apr 2017 05:45:05.0530 (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: DM2PR0301MB0608 Subject: [dpdk-dev] [PATCH v9 10/13] doc: add NXP dpaa2 sec in cryptodev 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: Akhil Goyal Reviewed-by: Hemant Agrawal Acked-by: John McNamara --- doc/guides/cryptodevs/dpaa2_sec.rst | 232 +++++++++++++++++++++++++++ doc/guides/cryptodevs/features/dpaa2_sec.ini | 34 ++++ doc/guides/cryptodevs/index.rst | 1 + doc/guides/nics/dpaa2.rst | 2 + 4 files changed, 269 insertions(+) create mode 100644 doc/guides/cryptodevs/dpaa2_sec.rst create mode 100644 doc/guides/cryptodevs/features/dpaa2_sec.ini diff --git a/doc/guides/cryptodevs/dpaa2_sec.rst b/doc/guides/cryptodevs/dpaa2_sec.rst new file mode 100644 index 0000000..becb910 --- /dev/null +++ b/doc/guides/cryptodevs/dpaa2_sec.rst @@ -0,0 +1,232 @@ +.. BSD LICENSE + Copyright(c) 2016 NXP. All rights reserved. + + 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 DPAA2 CAAM (DPAA2_SEC) +========================== + +The DPAA2_SEC PMD provides poll mode crypto driver support for NXP DPAA2 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. + +DPAA2_SEC is one of the hardware resource in DPAA2 Architecture. More information +on DPAA2 Architecture is described in :ref:`dpaa2_overview`. + +DPAA2_SEC PMD is one of DPAA2 drivers which interacts with Management Complex (MC) +portal to access the hardware object - DPSECI. The MC provides access to create, +discover, connect, configure and destroy dpseci objects in DPAA2_SEC PMD. + +DPAA2_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. + +DPSECI objects are detected by PMD using a resource container called DPRC (like +in :ref:`dpaa2_overview`). + +For example: + +.. code-block:: console + + DPRC.1 (bus) + | + +--+--------+-------+-------+-------+---------+ + | | | | | | + DPMCP.1 DPIO.1 DPBP.1 DPNI.1 DPMAC.1 DPSECI.1 + DPMCP.2 DPIO.2 DPNI.2 DPMAC.2 DPSECI.2 + DPMCP.3 + +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. + +A block diagram similar to dpaa2 NIC is shown below to show where DPAA2_SEC +fits in the DPAA2 Bus model + +.. code-block:: console + + + +----------------+ + | DPDK DPAA2_SEC | + | PMD | + +----------------+ +------------+ + | MC SEC object |.......| Mempool | + . . . . . . . . . | (DPSECI) | | (DPBP) | + . +---+---+--------+ +-----+------+ + . ^ | . + . | | . + . | | . + . +---+---V----+ . + . . . . . . . . . . .| DPIO driver| . + . . | (DPIO) | . + . . +-----+------+ . + . . | QBMAN | . + . . | Driver | . + +----+------+-------+ +-----+----- | . + | dpaa2 bus | | . + | VFIO fslmc-bus |....................|......................... + | | | + | /bus/fslmc | | + +-------------------+ | + | + ========================== HARDWARE =====|======================= + DPIO + | + DPSECI---DPBP + =========================================|======================== + + + +Features +-------- + +The DPAA2 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`` + +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`` + +Supported DPAA2 SoCs +-------------------- + +* LS2080A/LS2040A +* LS2084A/LS2044A +* LS2088A/LS2048A +* LS1088A/LS1048A + +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 +------------- + +DPAA2_SEC driver has similar pre-requisites as described in :ref:`dpaa2_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 Helper Scripts** + + DPAA2 based resources can be configured easily with the help of ready scripts + as provided in the DPDK helper repository. + + `DPDK Helper Scripts `_. + +Currently supported by DPDK: + +* NXP SDK **2.0+**. +* MC Firmware version **10.0.0** and higher. +* 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 DPAA2 config file options are described in :ref:`dpaa2_overview`. +In addition to those, the following options can be modified in the ``config`` file +to enable DPAA2_SEC PMD. + +Please note that enabling debugging options may affect system performance. + +* ``CONFIG_RTE_LIBRTE_PMD_DPAA2_SEC`` (default ``n``) + By default it is only enabled in defconfig_arm64-dpaa2-* config. + Toggle compilation of the ``librte_pmd_dpaa2_sec`` driver. + +* ``CONFIG_RTE_LIBRTE_DPAA2_SEC_DEBUG_INIT`` (default ``n``) + Toggle display of initialization related driver messages + +* ``CONFIG_RTE_LIBRTE_DPAA2_SEC_DEBUG_DRIVER`` (default ``n``) + Toggle display of driver runtime messages + +* ``CONFIG_RTE_LIBRTE_DPAA2_SEC_DEBUG_RX`` (default ``n``) + Toggle display of receive fast path run-time message + +* ``CONFIG_RTE_DPAA2_SEC_PMD_MAX_NB_SESSIONS`` + By default it is set as 2048 in defconfig_arm64-dpaa2-* config. + It indicates Number of sessions to create in the session memory pool + on a single DPAA2 SEC device. + +Installations +------------- +To compile the DPAA2_SEC PMD for Linux arm64 gcc target, run the +following ``make`` command: + +.. code-block:: console + + cd + make config T=arm64-dpaa2-linuxapp-gcc install diff --git a/doc/guides/cryptodevs/features/dpaa2_sec.ini b/doc/guides/cryptodevs/features/dpaa2_sec.ini new file mode 100644 index 0000000..db0ea4f --- /dev/null +++ b/doc/guides/cryptodevs/features/dpaa2_sec.ini @@ -0,0 +1,34 @@ +; +; Supported features of the 'dpaa2_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 'dpaa2_sec' crypto driver. +; +[Cipher] +AES CBC (128) = Y +AES CBC (192) = Y +AES CBC (256) = Y +3DES CBC = Y + +; +; Supported authentication algorithms of the 'dpaa2_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 'openssl' crypto driver. +; +[AEAD] diff --git a/doc/guides/cryptodevs/index.rst b/doc/guides/cryptodevs/index.rst index 0b50600..361b82d 100644 --- a/doc/guides/cryptodevs/index.rst +++ b/doc/guides/cryptodevs/index.rst @@ -39,6 +39,7 @@ Crypto Device Drivers aesni_mb aesni_gcm armv8 + dpaa2_sec kasumi openssl null diff --git a/doc/guides/nics/dpaa2.rst b/doc/guides/nics/dpaa2.rst index 9e7dd4d..1ca27d4 100644 --- a/doc/guides/nics/dpaa2.rst +++ b/doc/guides/nics/dpaa2.rst @@ -49,6 +49,8 @@ Contents summary - Overview of DPAA2 objects - DPAA2 driver architecture overview +.. _dpaa2_overview: + DPAA2 Overview ~~~~~~~~~~~~~~