From patchwork Wed Apr 19 15:37:48 2017 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Akhil Goyal X-Patchwork-Id: 23758 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 F2583CF9E; Wed, 19 Apr 2017 17:38:59 +0200 (CEST) Received: from NAM02-CY1-obe.outbound.protection.outlook.com (mail-cys01nam02on0082.outbound.protection.outlook.com [104.47.37.82]) by dpdk.org (Postfix) with ESMTP id 36EB25905 for ; Wed, 19 Apr 2017 17:38:29 +0200 (CEST) Received: from DM5PR03CA0027.namprd03.prod.outlook.com (10.174.189.144) by SN2PR03MB2287.namprd03.prod.outlook.com (10.166.210.20) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.1034.10; Wed, 19 Apr 2017 15:38:28 +0000 Received: from BL2FFO11FD007.protection.gbl (2a01:111:f400:7c09::147) by DM5PR03CA0027.outlook.office365.com (2603:10b6:4:3b::16) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256_P256) id 15.1.1047.13 via Frontend Transport; Wed, 19 Apr 2017 15:38:28 +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 BL2FFO11FD007.mail.protection.outlook.com (10.173.161.3) with Microsoft SMTP Server (version=TLS1_0, cipher=TLS_RSA_WITH_AES_256_CBC_SHA) id 15.1.1019.14 via Frontend Transport; Wed, 19 Apr 2017 15:38:27 +0000 Received: from bf-netperf1.ap.freescale.net (bf-netperf1.ap.freescale.net [10.232.134.28]) by tx30smr01.am.freescale.net (8.14.3/8.14.0) with ESMTP id v3JFbvDa023764; Wed, 19 Apr 2017 08:38:26 -0700 From: To: CC: , , Date: Wed, 19 Apr 2017 21:07:48 +0530 Message-ID: <1492616268-6307-14-git-send-email-akhil.goyal@nxp.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1492616268-6307-1-git-send-email-akhil.goyal@nxp.com> References: <20170410123108.26305-1-akhil.goyal@nxp.com> <1492616268-6307-1-git-send-email-akhil.goyal@nxp.com> MIME-Version: 1.0 X-EOPAttributedMessage: 0 X-Matching-Connectors: 131370899081206475; (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)(39860400002)(39400400002)(39840400002)(39850400002)(39410400002)(39380400002)(39450400003)(2980300002)(1109001)(1110001)(339900001)(189002)(199003)(9170700003)(2906002)(2876002)(4326008)(6916009)(81166006)(6666003)(2950100002)(2870700001)(85426001)(104016004)(86362001)(8676002)(575784001)(356003)(8936002)(50226002)(38730400002)(110136004)(47776003)(189998001)(54906002)(36756003)(5820100001)(53936002)(23676002)(86152003)(6306002)(105606002)(106466001)(50466002)(8656002)(305945005)(50986999)(2351001)(76176999)(5660300001)(77096006)(33646002); DIR:OUT; SFP:1101; SCL:1; SRVR:SN2PR03MB2287; H:tx30smr01.am.freescale.net; FPR:; SPF:Fail; MLV:ovrnspm; MX:1; A:1; PTR:InfoDomainNonexistent; LANG:en; X-Microsoft-Exchange-Diagnostics: 1; BL2FFO11FD007; 1:yNoa0W1wEeemNAectZf1rurnbiWkUtATg00LVAIDhus9jXLGdhKcTX6Q47zvC+Ke1sWHtWMOhYDcKuz8ec7UtH7Ss+Udb2p4LVN9Yl/kijzEqK5lSUK/0KiB/eX4nwRPHCZSc8uPpKyHiXxYYANceY/zV7EDd79lPpmHQd+BA/mhlEuL5Xb13tuvJsD/M4biUCXXf9/N0DonHEM26Y4XGgPMhHBkJx3jjkr5aE4ErID4YQu/sJyn3AuV0zSpfUACGmZNOOUjdeVMyGH/JrzgDSYQ7iTAy9wX8r+ZS2d0fED5TcwbaQ1oPmhSXHJsseexKpn2nepziC93YccS20mFmjYAP3FHVeAjv6d5d6y4lZf2tiDjhVESSmp595O2/Kn8Cp4zJwI5iPx9kaDjudKrC0zdrvERGTk6BVha1GY9tUYaZfvjdeYzMmhJhWf4Itdqx5ITTqK/Afep5UFL/2gthrh8LGL14Gvw89FGJOnv/ZADbP4gwC8YI0y+9iNaywWVuwWXEre4KmmirUGBEJTY3gYljMRt/2Y15caNt4FKQ7uFTKHTajuGsjb7ZSKraMqyyUdPJY4a5k+8qDNMNGN6TUjyfcU/5II+a2n4Izh7OSLTGhqntD+GHZ/pNs81WqnTN3gO5rgy82bPjEW8UbmwhBhB4y8aEnAKc2M23QsmHbmIX6eXmUrX4lowqTnZtWeqCqRQ5lVggy2qFXqHbIdTD0bFaOWnd/FYVDeK/k6hci2MSz0YA8ZWWQ1G2JcJgIiotPW8b93S7PAO27JVG190uA== X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 4cf0eb45-355a-4504-b970-08d4873a2003 X-Microsoft-Antispam: UriScan:; BCL:0; PCL:0; RULEID:(22001)(201703131430075)(201703131517081); SRVR:SN2PR03MB2287; X-Microsoft-Exchange-Diagnostics: 1; SN2PR03MB2287; 3:78z6zzwCgfKSxqEOdrirr0MoAz5BgDGvW+U1iR1nY7BTWQSOynKUNdd5TAtWiQEUroTosZAdYMYNfZggx90XSG6wvcYcOnzYvcu5cMVJreb4NnVCsdcBBUxluxfgU04nngOa7AryrRpswRjMfnYSV721vqmWs49LEXUfCwABy3Aauh0SbQVpLEfkAEBeqnQsRsUVmEn3Bz/ebDDjC4LiS3t41F/aGn0Ds+fD6BZYW/8BVXScqOcrG/gvnAUKNgzdpFAT+Ac4N8IQWmJ22O5DFjaXPyAnz+Re3oQvJRTM7gQyTww6Yr61m0J7kJSTZXhqfcvmsNYdzAAPZykFkWV2vjwJZzRhxw2+LP4+P1BxjoV8caSi2S6y7oo+LXY6WAVtvBaleN3I2qncOIIfCyqOKH9GDwSGnAc161sZlFYZkN8KwxitTTvP4ANKBTJa6KAw; 25:KdA63OcGGw5zf3nXrzoIYgJU2tnh8cUr/eUSCYOp22P/kUjiRYjyuJ3fCsL2hBbYfoVqxxBjd9UWXjD4Axts4Kzh/sRs+XGeANoI4deV9FzKLcK0twbj3IcQsAOnfseoBl60NAvHwemIb1wd7LXfAMDwCNWfmokLOUBNEJR4nKQYb67AY+kn3hOTnjE0lmFL1NjkXGwms5UTQLvh/gJdI+JETuqJV0QOJwPGYseHEa02AtFykLbYZ/4FZw75uwFRg+G2q6lDUDGPJ1fmAyLgFpu6pk1ejiAvofs8zVvPbxbpl6625OF5sAnIGHugtiI0wix1KxonbdS9UBFRuIwWMsLukm9d3MQ2J/efVjY7F+p2vVVzmSOL/SfH2txc6rPitTnIEF14q+QGd17RYDia+1Tk7XRLJFjHwTnmvAUHhPXORZmooFbMYevPJGI1kb4thqxxTINruqaFUjTxQFERBw== X-Microsoft-Exchange-Diagnostics: 1; SN2PR03MB2287; 31:fpXSsm+oCruao4ptFj3FFnmPgyBd5gWoojDZ1sj7O12R8Tt+MJ1SHbcVaCDrIpbB56kl+YasZ3Su/JgAnwbaE973rM15BuokSWeCjAjgVE/nMpL/9BXix5759dN1hJ/qoRGQ3m0GuemHzEIHTIT7c0CVTGbaZc2Gi9X8fW0f1KFnZsOz/FgiqVUHZUJX9rplkEp9hQJ9cBxTVVxQoVZZE+LrWLqA1HGumG4ObwtYq0Q1fx3xeO0L7AGlKfWxwAaeugJK+mIbh3sWxOxpk6cebA== 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)(13023025)(13018025)(13024025)(8121501046)(13017025)(13015025)(5005006)(93006095)(93001095)(3002001)(10201501046)(6055026)(6096035)(201703131430075)(201703131433075)(201703131448075)(201703161259150)(20161123565025)(20161123556025)(20161123563025)(20161123561025); SRVR:SN2PR03MB2287; BCL:0; PCL:0; RULEID:(400006); SRVR:SN2PR03MB2287; X-Microsoft-Exchange-Diagnostics: =?utf-8?q?1=3BSN2PR03MB2287=3B4=3A3yy5x?= =?utf-8?q?1HEFUU+narz7e+iWfGcwQ2J2kvkCuFzmluZ9QvaNlXtkUKBkS7ghCy1k?= =?utf-8?q?wkZ6GUlWAYCZ6MfMQXk59gi/QGgDpzoSqK282uR4h5U/Q0pqwoKXlUTy?= =?utf-8?q?AW4DTyK5jLBuwvwJYLZeSvp9L1RYpxD51VtwyrkZ5ZMcuMqQTk+FlW9F?= =?utf-8?q?HE55u6ik5eRxM0MqRqJteWOG0oOcGH3ypCM9FhmSArN0pbugnmRAukrF?= =?utf-8?q?tfh2oRwczcnCWR9fFV2CWGuwtYUwm86mvT871esAFkPVyq6pvsLspUIl?= =?utf-8?q?4AKBH3aeEvDeZf99u/TPg+vygX3Jv7PxePpcDV0n24miQDSi8kQCQugz?= =?utf-8?q?EYYoJbE2ReJ15lkPtLhyC1rLTsURB5t3i8Cv6mpjmxKzkahaPBTjgUMx?= =?utf-8?q?wRgJg+jO84R2indRNwuhj47Kopw3R3wIkYPhFUw1CRYEatPcwlwEDyLz?= =?utf-8?q?5ZQWfHZI4lXxoPa7sMEa6ru48GxqF+aPVmd+gREsfuFPCRisgtoh47ti?= =?utf-8?q?hMeIZUMDcMySJYstmBDvSZFWP0yXLyURyEQ/Pp5vm62PxF/N0LiwQOBD?= =?utf-8?q?xQhcMfNV5ybyyhkupvh9IGPFf9x1XxfEcc6cnqGxAtkTgDnqo5Ryh1TP?= =?utf-8?q?XaEgzg3GTA9AZSz4fymm9STZuJ9GJ+KaXzbDiRNpynry+ldUQtb41ED+?= =?utf-8?q?oi6TO81YXuPbSNaMJ3rK1jCViugOrv/5HJ+WWJqrrK1/r7lXx9P+LzGU?= =?utf-8?q?F55HFm5y/+vFucVgne/xGWSs6HpfHkveSa43L9IO07XlEM4QINSMOm3z?= =?utf-8?q?zjCLk6bSjP/h9ihyN1LetT9SJ7pZCbQu+a9DLZajTaQOqlHkAd5R/IIs?= =?utf-8?q?pOER7hV9fxIhhg1wu9QL9IsqLSAUqin54nPQUXC3UlA4QBS25A/N3iIR?= =?utf-8?q?a8ZVUQMOWgBrabLdz2xLTE62eg2eJTVqfr+VMCEYQWeUs1ztGQzVSTt8?= =?utf-8?q?UEKS9Uqf2LvK7NQv82yTWmGRNhdGU2NLLVYAl9+gFGdONXUUdRoG5c/j?= =?utf-8?q?DEmfKkPJz+yM/cAuZv+cixvm50BgfOjbUWkSbCEkkv6ZcFDlD9eX6VZP?= =?utf-8?q?3+HHOX66SfK+tNrqLEPMdSZ1bpRGBhuJJgNX63E8w=3D=3D?= X-Forefront-PRVS: 028256169F X-Microsoft-Exchange-Diagnostics: =?utf-8?q?1=3BSN2PR03MB2287=3B23=3AZrdV?= =?utf-8?q?7vBbbJO4gTUAHPFyItBsqKHqNci92ho8p1rTbi+t+KqzJ7iJfQB3sTUC?= =?utf-8?q?LBrCR/xtRvVF1mAA6swJCxE2ws7WtWXqzYJJAcD++qQSu9n06Pe5iEyI?= =?utf-8?q?Nl4HkHs13b4UroWGRfcXZUwp4AkQxPW9BRVBQ9kq32UuQ8Gn7hRuCbw4?= =?utf-8?q?u35kxBsyoF/KyNzgzJ7qmB51ubFbHAjPMmc4J1vmRWq3m8aq/aviA2Br?= =?utf-8?q?eW3G0Jboh8rglZBEYlbtjcm7v7IE+WteaIBjuESxKYwlHzrd/ZxIfl0X?= =?utf-8?q?+W3j78aR+RPIShVUDWjeGwVwmTx/nwYnX1qnhp3aTlb2m2B1ExI4d98g?= =?utf-8?q?yGcU1bK1G81Hu2dXXTTfpUm2cB9zi/ikC8NqjDJ968l7y0uEz2oxVhIa?= =?utf-8?q?Uk/3rqYracLPnoV2tlO311uJcchA64ZQbdSJQ7xzZq91SntNsry1z3u1?= =?utf-8?q?U3w7hajY5g70kxaXjZQgSOfMBJvFxTU0iKPxe4nwZZ4ajLj+AUC5KHN8?= =?utf-8?q?0U4Py21pH2bohlQAck70mZ4bEumxiC8hyIdLbuct96TYQb3w9WDMUHBC?= =?utf-8?q?rzbdt3NrZl1Zg5Od0LF1tRJkZO79qzKNJFApljk/cYyQ8zFXQbkbWsqQ?= =?utf-8?q?7idj6Mo9sAWxB8IZL2piMlhKydi6mqdaaXxuItVm5v6FF+7wcF2iOX/0?= =?utf-8?q?xc5olbJg0pfGnII0vj4dh0y1D1pYmzGwiniCgi7LG130l4GPvXFMe9/5?= =?utf-8?q?SDBluBAqiUfO6CtJnoGe9pdJXA+WNMIq6ezwo20YtRGrn/c7iMMuZVjn?= =?utf-8?q?Jq5fX9VPo0myvFXoKJS6sLFZ5RTW0uo9TAet7/5R8aAGxLpgHDivp3NO?= =?utf-8?q?sAJ5pIKrTTN7U1pCJSdwdeEJITZrdLzR6NiStSsSAVOZCNMvvI1PdD9F?= =?utf-8?q?m9fw6ELmbC1JhBxJct0tAkStjpqvbc49dnzmdjvWX3CRZlh3f5N+63nZ?= =?utf-8?q?0SLheCZYByzTDDNkTqExkfpPzaZRzIOTFpEXNHgINfanZVzoPLlzBUnL?= =?utf-8?q?tK0iWI8D6WOwOD4J8n9NedOPsDhYmXRVsKg6XxAuubmUVubj36I0or65?= =?utf-8?q?YXLItgXUmrci5tPK9URzazK/sd2bIaX4e4BLkmsMJQ6AjwbTPpQ9qpaU?= =?utf-8?q?CCmGxwIHeEfChqse7+Wr230kESfN0mM85CAyR3GFZ0RLqGwDqvOQki/C?= =?utf-8?q?5oKEJ7J/JUqavDxfA/n/esz+XqhxldmfeqIxRJwebMxgTsLZjZhXvk/r?= =?utf-8?q?D0j5HckYSkypE6eeD5zMvOMVaGMA5rjuBxsI8VeKV0OUV9jJYaiL7JMu?= =?utf-8?q?Sw3AkI8wDCeQ3O4f6L0eJw+62DTG8D0=3D?= X-Microsoft-Exchange-Diagnostics: 1; SN2PR03MB2287; 6:h627Vjq8qsS9kn4UBr0IZpeBD/1GxP01pVUW1LVwKwcRfgLQN5zCQkxpS4RNzAdeGkS1qsIF0gBDAF4Slh7an77sDPY33mgBS+aQEokEusO0EPCGcUCf4nXDLYbjfLRng6Z1dHnS6RIkqnjUL8DcHivIfNdmfI6vbWJAo96m8iXKrd4kIr311pin2k/LZ24r65TWuVfKwx5zyJWC06Kk6yqSxM2dgCoKIF0GdeuusOmE//uFv5LFSMAYBpeyX2V8RkpBue1WZrk8mWgsheqWjxHh1umz+ARlzkHJIneRXt6rwL1E1wWkjph2xBjlVCfjsRhmohjQj7QD34LoZV5AmgmRL+TwXksDkJawRRgvq1Qe8dQlRlUc0EkuFZDUYRCbwlWkg+DT14f3LZJ9zzoviZCMnpdyZ0B3cyWY7whDe4AjUhBQA2uBULz6W0K2gooORlDAWvym74/KvNdRaA3zH03fqgxOG8sMIqKjppZj61UpBdzTl+wU42ChWBfoXtIx; 5:enND3IDFpvKEac4ELQaKN66/A4b1z5Ls9y+TDQUOB+C3zYfMZ/PTwMwXQLL+/2gH2ftPPpAu2PxvrspyTn0doWDtTh6g+2UcTEofqsak6bk2VB9x2roKBxhkS3ZdHetHk3n1lw7r9WM3dqCQmnW+RnrX3Oz9l2O9boVbyovYLCq82AEc1JF0dhXNcTu8mOlv; 24:EVIcWQYKrYcERO3HW0dNs+HGY12gpXoAFjQmAZDvlFVLDd37W7JVMI/utuL5XqOVGJ3e38T1BSMKmKPnh+ymxrFubtiFPu4hFeClzJfYG7w= SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-Microsoft-Exchange-Diagnostics: 1; SN2PR03MB2287; 7:Ihr/m8IlLet6K+SsNZ8JJ3xUllMiIDheca7eb3WiQRqmca+rx8f9e+tU4e5F00Y/3hU5YJLfw1tKkwrcQv9Jph5FWgTbpzbNmWkWmGWbvZSOZngLD8moKRSkJILtsnDdXRVzBNEgcogT1+Oqudu+439OQd+vg6LTPKb7Zh/yoItrUfiUAkkJlZJMPpq9vY6Gp0Q6VTWWWciOWGHGhQZPQmZAKQNEePAqqbkAgAY0HI5HUt2LsS3oWGrB5UI4TEzQp068EIIUjBoxDh5LPwnkeMWDCKGLEsBTm5i4AlumJEI7rVvA/KZeB/EJoCnvtkAFVVUxlTXvB6vSReyUawdFIg== X-MS-Exchange-CrossTenant-OriginalArrivalTime: 19 Apr 2017 15:38:27.9490 (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: SN2PR03MB2287 Subject: [dpdk-dev] [PATCH v8 13/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 46225b6..3476626 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 ~~~~~~~~~~~~~~