From patchwork Fri Oct 12 14:40:55 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Gagandeep Singh X-Patchwork-Id: 148783 Delivered-To: patch@linaro.org Received: by 2002:a2e:8595:0:0:0:0:0 with SMTP id b21-v6csp820466lji; Fri, 12 Oct 2018 07:43:57 -0700 (PDT) X-Google-Smtp-Source: ACcGV60zrVorwxuAMhi5lMo6m4r4JfuZRYSYra4yoTcxUUpSh2+YjZEMfDemBSpKvuFYva/gcbK6 X-Received: by 2002:adf:91a4:: with SMTP id 33-v6mr5560036wri.37.1539355437124; Fri, 12 Oct 2018 07:43:57 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1539355437; cv=none; d=google.com; s=arc-20160816; b=L94ihGaQnozoMZ0glJIXtTdE9wfrWowp2o+zNZaiFwRvA6EgiuLxmebVD76gdD+nw7 qWWZAeWViCp/GVUFnVbxasv0FTZCzOOLovUK0dFaHR120RNsGDvcFziGAXxSyZ2n+Gg3 M1yfq+Se/ZvgizMgqg48VP+uA2ZOviBpCtlDJ/hLdpkNT1IeJRb2zktBWAgE5GT+1M8L Ci7L+mEVwMVLdWDWDJY9uKAqfi655yAGqcYnN3s/C4neRduVHjy+veiwB5TdlJd0vGGz IWZSnq8bT3TjE/9fFtxQ8pFzffTT8J9NA6NXgOazjlEHLgeSxrXuxZZeguteQT59OVhf yw4g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=sender:errors-to:list-subscribe:list-help:list-post:list-archive :list-unsubscribe:list-id:precedence:subject:spamdiagnosticmetadata :spamdiagnosticoutput:content-transfer-encoding:mime-version :references:in-reply-to:message-id:date:cc:to:from:dkim-signature; bh=e2tGKKnfVDihlE+j6sds8gVTdrPzAQ0X0seZREjhW/E=; b=OK/Y04XQ5QJqs6o4vhfUl5qK7Ey4GT0L5RmGo5T4FCHsrxSPhh4mvS7mpvVCS/NeNN qEyqjFuOx9UreyzrlnZ3YaKEQ2U3bZQ6DmVP1zpP6YaptmeO9QvLFbL1ZfdCU3hneeFg 2kBsfiNb4qbLX2gfSiS9HhDtFvMM9k9gQJZ/QoIqkxWpB+Wmz00XifFC6RsiBLJFU4Qq bukfgQxbV+LI7O1/Rb5fgbv93A5+7nihxIPRK8JyoAk+3I1C5bCimW8AAD2eTHJAzmlU TDckZAiwxHQL3Z+DsSMXbiJTYD1dF40PMBcL/Hq0hBh7YemWz3ywsDFX2y9/8qwcz4FZ xKvg== ARC-Authentication-Results: i=1; mx.google.com; dkim=fail header.i=@nxp.com header.s=selector1 header.b=K+88kSGS; spf=pass (google.com: domain of dev-bounces@dpdk.org designates 92.243.14.124 as permitted sender) smtp.mailfrom=dev-bounces@dpdk.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=nxp.com Return-Path: Received: from dpdk.org (dpdk.org. [92.243.14.124]) by mx.google.com with ESMTP id x131-v6si1274363wmb.93.2018.10.12.07.43.56; Fri, 12 Oct 2018 07:43:57 -0700 (PDT) Received-SPF: pass (google.com: domain of dev-bounces@dpdk.org designates 92.243.14.124 as permitted sender) client-ip=92.243.14.124; Authentication-Results: mx.google.com; dkim=fail header.i=@nxp.com header.s=selector1 header.b=K+88kSGS; spf=pass (google.com: domain of dev-bounces@dpdk.org designates 92.243.14.124 as permitted sender) smtp.mailfrom=dev-bounces@dpdk.org; dmarc=fail (p=NONE sp=NONE dis=NONE) header.from=nxp.com Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 83D941B9E3; Fri, 12 Oct 2018 16:42:10 +0200 (CEST) Received: from EUR03-VE1-obe.outbound.protection.outlook.com (mail-eopbgr50082.outbound.protection.outlook.com [40.107.5.82]) by dpdk.org (Postfix) with ESMTP id 802CE1B9B0 for ; Fri, 12 Oct 2018 16:41:59 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=nxp.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=e2tGKKnfVDihlE+j6sds8gVTdrPzAQ0X0seZREjhW/E=; b=K+88kSGSWWol0qh3bd045xfgeAKsyoaD3Cv/xohsmZj0lJr3qUJQndLJTrN9/mf5JDWoijBUlJ5zPzrbW3bpDNHTc1guyNlfvOCTHNOpos6ygCekCo0DfSWXUb2gI0VDfGfUB1kskP/r6/zfArq86Um6IQ0BlJzzolj+w6Pchrg= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=G.Singh@nxp.com; Received: from Tophie.ap.freescale.net (14.142.187.166) by HE1PR04MB1530.eurprd04.prod.outlook.com (2a01:111:e400:59a8::20) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.1207.23; Fri, 12 Oct 2018 14:41:56 +0000 From: Gagandeep Singh To: dev@dpdk.org, akhil.goyal@nxp.com Cc: Hemant Agrawal Date: Fri, 12 Oct 2018 20:10:55 +0530 Message-Id: <20181012144055.9461-15-g.singh@nxp.com> X-Mailer: git-send-email 2.17.1 In-Reply-To: <20181012144055.9461-1-g.singh@nxp.com> References: <20180913060846.29930-1-g.singh@nxp.com> <20181012144055.9461-1-g.singh@nxp.com> MIME-Version: 1.0 X-Originating-IP: [14.142.187.166] X-ClientProxiedBy: PN1PR0101CA0039.INDPRD01.PROD.OUTLOOK.COM (2603:1096:c00:c::25) To HE1PR04MB1530.eurprd04.prod.outlook.com (2a01:111:e400:59a8::20) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 42c077c6-e4ac-4595-beca-08d63050dcb2 X-MS-Office365-Filtering-HT: Tenant X-Microsoft-Antispam: BCL:0; PCL:0; RULEID:(7020095)(4652040)(8989299)(4534185)(7168020)(4627221)(201703031133081)(201702281549075)(8990200)(5600074)(711020)(4618075)(2017052603328)(7153060)(7193020); SRVR:HE1PR04MB1530; X-Microsoft-Exchange-Diagnostics: 1; HE1PR04MB1530; 3:YgiCp3cAPiLT48qeylgwTO5YBE7JghMV0O8ZRmcllIJPP+m5pV402cNdGC49WHnd7lO/SvsVlPuJmGJwojubaNDqgq9z+eixYp0WFszQXkHE+INZrYt4MDlCWp+UUODW00AEzAXZ4FY5XwJMwnoBHz0xuzm+gBWMEezAHPf/MGU9CPsZ6jDrwVFGso83ivDhixRQ1j/ZNFIsJT7FLTK6V8yuATVydDi8Pfz/l7RunGbvtJLEkumM2dlNNFhYPHa0; 25:/VWqyfMOViCurlJ89hbkr7zs82kvXDsTIrOX9FUz3VNgJ/NGejGo2fbxBx4grAQqWhWBsKQ0MbMEsDDpOhfNkp4Lrkb2iw/NHdzMIfyeeG6hVqmNQFWs4Uwt4bLR3vJvZ5LrliX/YL97m6Sj7iM6UuzTfYUm7R6WUXmqeQSlwcUp8fu3slQJu97Wuws3t0pRvrUM/T3wjeBNTBIYUF7QJplCaiO8EIXAlrEGzscAAIOZHJmEjbxorlqDkwVFFM4HjmY1ELHSvzz/R5OLipgzNORw5cdVLsbowA1bKOi0HUi2gmcO4s7dTMw3Y0cbLPyOL+JQZwXx7vccn6BjAW+X1A==; 31:4VzC1XbN0mm8+ZdqL9ejxHHV2NJqVsvqkWpr247gNs78VZ099rBr2LR935uDYIiXxfG1s+wJwkdjZJ/MJVKlltEp8NvwId5PjnfMb/iH8qzxQ6b9HfsA3OYrmfuxm4VZ6lM7WLXvK2g0YBWPxss9M+B8ilsEML4hS7dnL0iJnRI+8K8MuNYMZx4jVoZY7UFdpZCVHaMFJqZbYTfPdh+sszfuVF0TnqnzjvCogD6z5IA= X-MS-TrafficTypeDiagnostic: HE1PR04MB1530: X-Microsoft-Exchange-Diagnostics: 1; HE1PR04MB1530; 20:nEWqsCLkuMz430+AgDH8CSxzfGAIJMd4a0mr7MpsgOWKqKPrlcg6BGpWG1tl3D1hTdF9/eN+QtU5Pzx11FSeS7p2uZXQEJ6498fPY9G7XWpcjN3PH4DO7taaTqfZgfAqmIDbw2TnTJMoUZM9pANCV/muQ1v6sL4WfTg7+je8uJR2ouiZ+3lJxWG/JryUbYfYx+ex6HRuwo73rL4QhzQHPmQR/7xNdldpsMa6/T1uC5GomdhWvZoRTvVLt5Mmfwz6ZzdQ2j5FFnosouU7jTkEHes4qiIIItn67SHLkOuUrMCf962LUfqvy1LEKZnUT5QwXW+jXFF2n4Pd8FakRLBJcGfnQLCARWcsvFz82ju/yDHg5OcTC9dtP+a8egqdqazkqTTvcol9yEbtpE+YnypD3AVnqDP/7OUeW+q/U0SBJIpenBiV2yChHM/K4pwaeP60omTmy8N0ps6VIoie+VJfv3czZXp5Xbwxvr55pmew3ak8x+EFNDsIw75noo8BjGnt X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(185117386973197)(264314650089876)(278428928389397)(192374486261705)(35073007944872); X-MS-Exchange-SenderADCheck: 1 X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(8211001083)(6040522)(2401047)(8121501046)(5005006)(3002001)(3231355)(944501410)(4982022)(52105095)(10201501046)(93006095)(93001095)(6055026)(149066)(150057)(6041310)(20161123564045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123560045)(20161123558120)(20161123562045)(201708071742011)(7699051); SRVR:HE1PR04MB1530; BCL:0; PCL:0; RULEID:; SRVR:HE1PR04MB1530; X-Microsoft-Exchange-Diagnostics: 1; HE1PR04MB1530; 4:okuD0S5/2lbws9NewfuxH67IrNm5StBZUDVnNfV2ZqCrheLAPzMNyJNo5EGmN7kGO43OCFkgmcpWoRivmhzaqQ8SJXDtYT49OK+h0+UvneCJelYEiDrMwtJkuVYkr4tCO35ZuwAoQBBadHlJA7kyOJANZpL678rWHF29nOGHnxpQot4lk4JbMNsoSzAJEGslvl86h6SNk9lesr37CrSPoNbVqAIPBesRg3Utw+y7K7pH4xSPZZoLx5ZHVqQlC88eH8RGuixvYF8um80KYA/kzEt8NAHsMnB4+0k0OpDHr2Eraw0dR4urCQrl9ecY5erFHX78JcBne4AYvZzEot4Nr74dcwYnu0pSPf5hkoAW/kfaRul7wn3psAgVXlTSpe0RRykQAfQO1wOH/QVw6eKCRCWXc0sMokRgEEwXUrDXYznKPYBWKcCaNSblBdX29oPPWMZVgItLT7Wfjd+BYDIzLw== X-Forefront-PRVS: 0823A5777B X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(346002)(376002)(366004)(396003)(136003)(39860400002)(189003)(199004)(316002)(305945005)(8936002)(386003)(55236004)(6636002)(6506007)(106356001)(25786009)(36756003)(5660300001)(72206003)(52116002)(6306002)(53936002)(26005)(6512007)(23676004)(478600001)(68736007)(186003)(16526019)(50226002)(7736002)(105586002)(97736004)(76176011)(78486009)(3846002)(2906002)(66066001)(1076002)(4326008)(956004)(446003)(2616005)(47776003)(11346002)(1006002)(6116002)(486006)(2870700001)(14444005)(476003)(8676002)(50466002)(81156014)(86362001)(81166006)(6486002)(110426005); DIR:OUT; SFP:1101; SCL:1; SRVR:HE1PR04MB1530; H:Tophie.ap.freescale.net; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; MX:1; A:1; Received-SPF: None (protection.outlook.com: nxp.com does not designate permitted sender hosts) X-Microsoft-Exchange-Diagnostics: =?utf-8?q?1=3BHE1PR04MB1530=3B23=3A1iqs?= =?utf-8?q?8nq4xRbYItnAYJVpFvO496+uZJOteIra5yXoaFQidtHG6ZGTDEnLf5Wl?= =?utf-8?q?0KdtByzSB0Of6wIfP3tBsLz2GtNH4tfaORD3YoL2171oyQwdE7J9/xOY?= =?utf-8?q?iW8KcrErY0K0wcQKmEHemFzToWoljn7JxUKUjLYpV1H/WzSFlgFeqvJ/?= =?utf-8?q?JFQtXV2EkHKre/tVKbj02DtJQXwhgYJKTLp+pVwXlQ7bx59gd9k7bV4X?= =?utf-8?q?ZQxkDULD37IvLiZRUKK5OKynAAbTQ+7ovJJhb0nL9kj81Ie0KnH1AfkD?= =?utf-8?q?9i7EOriIZnEjjxJDZY2v96NRueMph8YydwgAyzgfCWR18gNAMxQj+Wz9?= =?utf-8?q?vuKWlWM1nJl5MZpJJAuRPy1HR+rP3QcWrTUo2qs5NQyYHjej4pkjPm+f?= =?utf-8?q?CMK+ntZjEF2MvQSvV2Rc83nKstdgx1w1KmadSnNMTwZQ8j0Q/j6qzUgL?= =?utf-8?q?014jpv9Lq3pa2qChlzARnXb9waMK3MsM7V9UmxTTIJ8rOx/cf8Nxx25+?= =?utf-8?q?buk/BOCA4eRz5anMUvlwLVsL227IIFhQ3mLosUnt2qsZWmhYggE9L5gV?= =?utf-8?q?eSMBEOoPdkSGgH+AkLKK1EcVoCUXsmQbztMglsTXUr7fwlr8zdJ59fR+?= =?utf-8?q?p0HY/9q9levJtOMwIifSLW65D2x02240yFejVC7IT2TYJjf6kQSeDU4D?= =?utf-8?q?E0sJeAWLR4XsJIPw3J/1xFz+3VH+C853iuScjhrdAFIuX7c/xIVPgZE5?= =?utf-8?q?zEICCC09EexYl81MpnRf4sp7YycscLHF7DbalgsGJsiXEQIAZa6rV6fT?= =?utf-8?q?/jSfD2PdwXfAwZukiI1dVJEr7AAkLff4+tzhnNm/aBTwapNuM58OQmi0?= =?utf-8?q?S0q8TY03Z/csq4ptp2VSA546o3WtR2yV0/p6xU4ujruo6AhQJPohM7uo?= =?utf-8?q?95FtNGWeUiFB1vWnSFWqvv+/dYFJvCaei34kWRL38rkl96TxzrJbIr1p?= =?utf-8?q?IiDBdhOXPkZKf0sBcbkou5LaU7ss9HTfolmVKfPb0eFciA7woixROJCB?= =?utf-8?q?aaqTc9jjRhKTPJD9XwNhGzEYPVqfBNf9sl+8klSbzQw+W+VQJPh9iuyb?= =?utf-8?q?12+Z/mVMXmPmc7iq7Gdh/51aYTWc3GgFFfPfiIFSfGAM7q4pxHdO37TK?= =?utf-8?q?qo1Yp41mzpUJMGSUMPQhj4e+/twF2hsf24m0yzSCbQEK0oiJHWCE7ELr?= =?utf-8?q?fqHWOJ8okb+qmOR4DsibiRX1HLplimXrUOSvfZaUIJ/x14xjejplRZpn?= =?utf-8?q?A5RqJd2LwuUHMbtjyb29UhRumwzM+goIIUhaI3+qRPoCxZUM7bVxXlEO?= =?utf-8?q?yS6OwAFowg=3D=3D?= X-Microsoft-Antispam-Message-Info: Br8WF/UZetK2c1JKI+wSEonUicd1KbQG5xxMgtMYoJtISu3s5aHiMEDEkZzgEDmDOZykZN/InByqDRcvUZEX5M88VT2TzqurN6ow7MFZ2E9q/JNqWjQ1/VaYWg20ql36Zvfoq1PNXQceBT/OSEj2873vDAks/l0uO/TBYblWGQ/Y+HTwVWzbSrOamKCK/3X6I3hKD8N0JYIPCMYrheZAB7mZ4ZfzpWLCU4R7p3TqtNM1/XOHc9vhHLZlUpX4UzzZQOTjETR68lfHvc6NeSlC2+LMTSL9Ra0Z8eL/yvitR6976WyMUeIcis0rN/7ZhHUWgDpy84A0vxu/qrXLO8X+DCKzJk8omW/cxrgVUXs4Sqk= X-Microsoft-Exchange-Diagnostics: 1; HE1PR04MB1530; 6:H0YK/zKSsneZq9B8v7hPEcJCrZOK1jeElZgpjP06BHvjrcX7O6DuCCHhs3pcU0+BtWwWLdz1vdaLMTrD5JP7XRN1tKd7dlJ7sfaA7m+p4jUa80PvqJaEgg/11vKw4hSIGGaOgSDyhE57hhqjWjJo+Jhvb0tlfCbyJFeGjq+RFBnORfUaLD1eQf5RNDKPgdtCN26DKSPOtMEnPiLwho56uItCby+zHvQ0/zhhyZ07x+QVSvjYtL6ux1lqMogOkX3Ea6Iw+ecr03T5WifEThdVNRsVvifwDHwoaOr2Ssq5pk1NxFxRW9+q6qnAaWiw5g+nXBHOYswhAwl/gF9ZrxFX08yJyk7moxlb5DDwUnYIToZsDkLRFYVFb6SCC+0yu1hh3WMWVWERERUPEZf0hH6iq0vGabp4vxT1Z9Y+wXXkBbAbXBBD01K4qnEOtT5Xh4qpC+uvTlJQsdBPZiMWPXgnkA==; 5:422jIn4pL2Je+m0e+4epwZqWc4CHUvUkNyRml6k7WfJTnW81xi4jJOQHRQTnz+CtLmx59KN9pZIIXGivPtxWHmp5rXEC46Y6bahqVmikf87/QGjDrqOJD9jD9Sfyun5F9SdNawiJUVkO89QEmRnNSJGhJVChMEiA73poIEizPr8=; 7:wuVFUJWePrWND6UVj55Nk9+xk+XBAhFEiIB2Zm7dvGYdx0mQhLu+rEegwDD/lGsODfJFeq6/uqTaltUzyffjk1s8kK74P22IRvxnlNFneE3ik6IMqHKJu+yoXbeBneJZYgNY7UwGBdCyh8/m/U+IlDYi40EGCgaPhzmBLfCGdGnOK7gsxRB2GfuFqtI2+aKW3i6lxsvBFY74sBD4Kx9lg8MA37PhhI8ewK5K3ZbuxXTLZp/gjbQeFXU+hFejLjTR SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: nxp.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 12 Oct 2018 14:41:56.7409 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 42c077c6-e4ac-4595-beca-08d63050dcb2 X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635 X-MS-Exchange-Transport-CrossTenantHeadersStamped: HE1PR04MB1530 Subject: [dpdk-dev] [PATCH v2 14/14] doc: add caam jr cryptodev details 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: Hemant Agrawal add caam jr driver details, supported features and algorithms in the document. release note and MAINTAINERS are also updated. Signed-off-by: Hemant Agrawal --- MAINTAINERS | 7 + doc/guides/cryptodevs/caam_jr.rst | 150 +++++++++++++++++++++ doc/guides/cryptodevs/features/caam_jr.ini | 46 +++++++ doc/guides/cryptodevs/index.rst | 1 + doc/guides/rel_notes/release_18_11.rst | 5 + 5 files changed, 209 insertions(+) create mode 100644 doc/guides/cryptodevs/caam_jr.rst create mode 100644 doc/guides/cryptodevs/features/caam_jr.ini -- 2.17.1 diff --git a/MAINTAINERS b/MAINTAINERS index b5294cbea..f50c6cae0 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -850,6 +850,13 @@ F: drivers/crypto/null/ F: doc/guides/cryptodevs/null.rst F: doc/guides/cryptodevs/features/null.ini +NXP CAAM JR +M: Gagandeep Singh +M: Hemant Agrawal +F: drivers/crypto/caam_jr/ +F: doc/guides/cryptodevs/caam_jr.rst +F: doc/guides/cryptodevs/features/caam_jr.ini + NXP DPAA_SEC M: Akhil Goyal M: Hemant Agrawal diff --git a/doc/guides/cryptodevs/caam_jr.rst b/doc/guides/cryptodevs/caam_jr.rst new file mode 100644 index 000000000..e87ff0915 --- /dev/null +++ b/doc/guides/cryptodevs/caam_jr.rst @@ -0,0 +1,150 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright 2018 NXP + + +NXP CAAM JOB RING (caam_jr) +=========================== + +The caam_jr PMD provides poll mode crypto driver support for NXP SEC 4.x+ (CAAM) +hardware accelerator. More information is available at: + +`NXP Cryptographic Acceleration Technology `_. + +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. + +SEC HW accelerator above 4.x+ version are also known as CAAM. + +caam_jr PMD is one of DPAA drivers which uses uio interface to interact with +Linux kernel for configure and destroy the device instance (ring). + + +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. + +Note that one physical Job Ring represent one caam_jr device. + +Features +-------- + +The CAAM_JR 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 +* LS1028A +* LS1012A + +Limitations +----------- + +* Hash followed by Cipher mode is not supported +* Only supports the session-oriented API implementation (session-less APIs are not supported). + +Prerequisites +------------- + +caam_jr driver has 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 `_. + +Currently supported by DPDK: + +* NXP SDK **18.09+**. +* 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 +~~~~~~~~~~~~~~~~~~~ + +The following options can be modified in the ``config`` file +to enable caam_jr PMD. + +Please note that enabling debugging options may affect system performance. + +* ``CONFIG_RTE_LIBRTE_PMD_CAAM_JR`` (default ``n``) + By default it is only enabled in common_linuxapp config. + Toggle compilation of the ``librte_pmd_caam_jr`` driver. + +* ``CONFIG_RTE_LIBRTE_PMD_CAAM_JR_BE`` (default ``n``) + By default it is disabled. + It can be used when the underlying hardware supports the CAAM in BE mode. + e.g. LS1043A, LS1046A supports CAAM in BE mode. + BE mode is enabled by default in defconfig-arm64-dpaa-linuxapp-gcc. + +Installations +------------- +To compile the caam_jr PMD for Linux arm64 gcc target, run the +following ``make`` command: + +.. code-block:: console + + cd + make config T=arm64-armv8a-linuxapp-gcc install + +Enabling logs +------------- + +For enabling logs, use the following EAL parameter: + +.. code-block:: console + + ./your_crypto_application --log-level=pmd.crypto.caam, diff --git a/doc/guides/cryptodevs/features/caam_jr.ini b/doc/guides/cryptodevs/features/caam_jr.ini new file mode 100644 index 000000000..68f8d8195 --- /dev/null +++ b/doc/guides/cryptodevs/features/caam_jr.ini @@ -0,0 +1,46 @@ +; +; Supported features of the 'caam_jr' 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 +Protocol offload = Y +In Place SGL = Y +OOP SGL In SGL Out = Y +OOP SGL In LB Out = Y +OOP LB In SGL Out = Y +OOP LB In LB Out = Y + +; +; Supported crypto algorithms of the 'dpaa2_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 '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 'dpaa2_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 bd1588537..83610e64f 100644 --- a/doc/guides/cryptodevs/index.rst +++ b/doc/guides/cryptodevs/index.rst @@ -13,6 +13,7 @@ Crypto Device Drivers aesni_mb aesni_gcm armv8 + caam_jr ccp dpaa2_sec dpaa_sec diff --git a/doc/guides/rel_notes/release_18_11.rst b/doc/guides/rel_notes/release_18_11.rst index 56bc435ed..fba349a48 100644 --- a/doc/guides/rel_notes/release_18_11.rst +++ b/doc/guides/rel_notes/release_18_11.rst @@ -174,6 +174,11 @@ New Features The AESNI MB PMD has been updated with additional support for AES-GCM algorithm support. +* **Added NXP CAAM JR PMD.** + + Added the new caam job ring driver for NXP platforms. See the + "NXP CAAM JOB RING (caam_jr)" document for more details on this new driver. + API Changes -----------