From patchwork Fri Oct 5 12:59:23 2018 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Anoob Joseph X-Patchwork-Id: 46167 X-Patchwork-Delegate: gakhil@marvell.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 53CEF1B1D6; Fri, 5 Oct 2018 15:02:55 +0200 (CEST) Received: from NAM01-BN3-obe.outbound.protection.outlook.com (mail-bn3nam01on0058.outbound.protection.outlook.com [104.47.33.58]) by dpdk.org (Postfix) with ESMTP id E1DA91B195 for ; Fri, 5 Oct 2018 15:02:53 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=CAVIUMNETWORKS.onmicrosoft.com; s=selector1-cavium-com; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=DChUzVxF5yp1opqqIwmGpoVFcckAhA2xsny7Qs5e2p8=; b=AVvEHLpz/0lQ+j2pvR+/vKxY5bnAH+7SPhCYXQ87q/ug6YNFTAKKpnmMGBvQS+6fATFV1EMK859KQx8YQ5bgELcRlPoQ74j8dn5cvQglTcxzBS2eITOw5zLGEn7Wx/vc8DNTPyLDLpjgcWL+jdNwRgTJTZxaEmV/HJ8EXl3lykw= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=Anoob.Joseph@cavium.com; Received: from ajoseph83.caveonetworks.com.com (115.113.156.2) by SN6PR07MB4910.namprd07.prod.outlook.com (2603:10b6:805:39::16) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.1207.21; Fri, 5 Oct 2018 13:02:48 +0000 From: Anoob Joseph To: Akhil Goyal , Pablo de Lara , Thomas Monjalon Cc: Anoob Joseph , Jerin Jacob , Narayana Prasad , dev@dpdk.org, Ankur Dwivedi , Murthy NSSR , Nithin Dabilpuram , Ragothaman Jayaraman , Srisivasubramanian S , Tejasree Kondoj Date: Fri, 5 Oct 2018 18:29:23 +0530 Message-Id: <1538744363-30340-33-git-send-email-anoob.joseph@caviumnetworks.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1538744363-30340-1-git-send-email-anoob.joseph@caviumnetworks.com> References: <1536033560-21541-1-git-send-email-ajoseph@caviumnetworks.com> <1538744363-30340-1-git-send-email-anoob.joseph@caviumnetworks.com> MIME-Version: 1.0 X-Originating-IP: [115.113.156.2] X-ClientProxiedBy: MA1PR0101CA0036.INDPRD01.PROD.OUTLOOK.COM (2603:1096:a00:22::22) To SN6PR07MB4910.namprd07.prod.outlook.com (2603:10b6:805:39::16) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 7118f927-468a-4f82-8060-08d62ac2dc1a X-Microsoft-Antispam: BCL:0; PCL:0; RULEID:(7020095)(4652040)(8989299)(4534185)(7168020)(4627221)(201703031133081)(201702281549075)(8990200)(5600074)(711020)(2017052603328)(7153060)(7193020); SRVR:SN6PR07MB4910; X-Microsoft-Exchange-Diagnostics: 1; SN6PR07MB4910; 3:1Ea2HaIqPD6E0ULwP5oi//XPYEbzOAIvjzSLFUHv+Fr7u1+mUuPr3xUKhCLx4pzE2hcgx7aR8+UhPO5/zWOVwQ1nghoiijFjfaS/w8diLS41JpU2mnoroskngXgSWpOziDmChZdum83oxrnmGhqG5HKeoeQstE1/iwPBBqtksIsqnmlUxgCafVAql2aNCYG05HNywQJaV8AEsI4YozrmgifnxvoR8D1+uJdZuzhVIVmYF8MlsUBo6m3/6sdMQeUE; 25:4pM9S82EVP3jVm7Hae2nm0tjZNSeV51zaFRZXGvioeWfZup1wEsbDd7GWZJi85od2L3GMhjMSqlQmErMBomDunjcP3P9HUA9lJNCPP2bsSsIaWYfgfrowoqUYhAGcAHRKsPXbiopd7+qiSjMwQcjTENnPauJ1HM2wJeiOo8PZrVOG4ceM2k867rD1g8+WqbCqK9bHofCvSszsC1TWmhgmJZBNUbOmzGSbzPqN37UwcMUNS4y1R38xRCYBvnqJIo/utSVHbpJk3zxPW7Ozf3JcqKqa8x4lwh7S0FvlboEKjeMVIZPFPZJKwZhANN/qfZeOwDRuyGgFiEj/FrvOQRa5g==; 31:myJjbnknsNMv2z58JjR8PMBqsoIk+GM8j73o5GdMTIXm7AzbGNOJs49uZzOoPf2eG8bP//r+EMaOfsZ4fzswhEsRHe6/5+QtqbHUtfW975iN9ibDpvql+c1/B4kDBfcW7zcwed2bDpac9nWDdOJ6dPNvLSqLCZzPpxDGLWa3M6/zjshpip3tGeMU7/BG9Dwk5MkXmro2Y7LgJh3SgumjxjA1Qm1HuuW9u9a/rckKVqg= X-MS-TrafficTypeDiagnostic: SN6PR07MB4910: X-Microsoft-Exchange-Diagnostics: 1; SN6PR07MB4910; 20:9g1WuLCuv3Gg5qVb3RF7mMp0KFfeb5k2qrq8MDVhxQGrdjrzG/qsfiQQsRfeBZQwvTe3DxUxkePv/UJF1m/aIJzYL3mIph+j2ja97yFQ+D9uHzN+xAcErWt7LGGYjeJm8MoC8x2Ee8i0EwyFmcdF8I+8ORo7n2efa4MGnDfky3I4NKZqUBIkwRD6AnxiM5omkLzsmdOlw4wsVGRTnf8KUfI08hXWxbo83LXVgP7eQZBLffaQJHktiwa+Fu0mJX9wC0Diqe2k4tmXEt1nKJIXEFrTJBnlT3S+F4SlaqVs6H9RM0EPVLhZt3k/IijV2lVhjlD4egnctwdDN5UuJolHxdpsyYVUCI8zjJgYexgoip5ApfRqkw1bi8QwojvLX5KqoxL+LX8NHPv2qtF3sEjXXeD5MbZTtweKPhN+945v0UZRQmGM7cidcB2TXoKHKkEt+I2ZxTzV9NYMHgX/8w103MrPUnoKBwYu4C8oL9HtB0wRJyU5hapzbC2SIbbvaELnHWfvC8Fooap6FV6QvG7n7thXm6mTVHdk7MoUW3Nmr688eH4BrtomuYfXtfJaLwDToyfX6zp91GpY5x/aMQQudEPoqx2WZxJsPoVI8+Svv1s= X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(228905959029699)(278428928389397); X-MS-Exchange-SenderADCheck: 1 X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(8211001083)(6040522)(2401047)(8121501046)(5005006)(3002001)(3231355)(944501410)(52105095)(10201501046)(93006095)(149066)(150057)(6041310)(20161123564045)(20161123558120)(20161123560045)(20161123562045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(201708071742011)(7699051); SRVR:SN6PR07MB4910; BCL:0; PCL:0; RULEID:; SRVR:SN6PR07MB4910; X-Microsoft-Exchange-Diagnostics: 1; SN6PR07MB4910; 4:Tb0+wVdrhoxiSYksRB9ZbnCBMgqywsYe6CRRuFCGokGnmeRVVw9Fm3wGQWPxxcmlc9WEAF6zWNCltmr1TEZkQWwQw7pPIYTwGhewMH0kwtKk2dC+9IKmqjNrok1OThT5eUgs2EPFV3FOj1wUJgi/0FJn+kXUFpwXhTPWMd79f/G4E9JFWfFHgmW3hhGe6J3mSELST3rmLiVhM9D+O6+CSa1k+C0XNO5lxFZIO5EyfEMtXVkEaY0yYI8hYsOwtisfjxkAzv1BMX6wer6KlYcfEDrGVu6ARqZw4EQ4Mamz2f0a0ieMQm8M8yhzkXBzZK2/Qw4dvK1qxaq2ace5wmONoV7S25y3SYuFervj+LaA5Eg= X-Forefront-PRVS: 0816F1D86E X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(376002)(39860400002)(346002)(136003)(396003)(366004)(199004)(189003)(76176011)(11346002)(50226002)(25786009)(8936002)(305945005)(186003)(16526019)(110136005)(6486002)(3846002)(446003)(52116002)(6116002)(23676004)(81156014)(8676002)(97736004)(5660300001)(50466002)(4326008)(956004)(42882007)(2616005)(68736007)(478600001)(54906003)(7736002)(81166006)(6666003)(107886003)(26005)(2870700001)(55236004)(66066001)(386003)(47776003)(6512007)(72206003)(44832011)(476003)(316002)(14444005)(36756003)(105586002)(106356001)(486006)(6506007)(2906002)(53936002); DIR:OUT; SFP:1101; SCL:1; SRVR:SN6PR07MB4910; H:ajoseph83.caveonetworks.com.com; FPR:; SPF:None; LANG:en; PTR:InfoNoRecords; A:1; MX:1; Received-SPF: None (protection.outlook.com: cavium.com does not designate permitted sender hosts) X-Microsoft-Exchange-Diagnostics: =?utf-8?q?1=3BSN6PR07MB4910=3B23=3Azknu?= =?utf-8?q?RwBaudwhmgFg646Pu52CdM3UIZXMx161SgvCD48PH2ftyznzdrSrLfYa?= =?utf-8?q?oZcdN8v2MWMJ3/wQDBFguJXiwkQcH3OtZoU0Xh6poCt/03ShA7vEl2Mn?= =?utf-8?q?r7g2ezrYA4dtffPOHYPaixDNBf3GSf3ApDR1Udqyl91hiGOc2J1J1N5G?= =?utf-8?q?n99nZQGhmuaO59jWNKo8DrgNb3iYuCbBG9RwL+3jSVq/gBjNPTfR3Zru?= =?utf-8?q?kKzlSyAauPK3mu4YJg6MzAHYk6qlaAolOgM30qo6aTXJEJK2+BUnKjT3?= =?utf-8?q?gwcV5MABOJbJX+cu0wxE1GX85inUmpYsDFZxqAwYLmBXlj5ncRQ/jyaO?= =?utf-8?q?tLToszfxjE/RZK6fmDKA9VzM+VD01tQkDDMIYWC/Zd1uLFAbW6WPTMlW?= =?utf-8?q?83H691Wtm27jZCChCC3vcPhVTG47oI6lIM+9Si6vhixaxW3UFnF/q8pd?= =?utf-8?q?DhSV2N87b6Uc96TkSzJRdzXSTRABLhg1GIfpIskNzGhgDgO9cHCweR5w?= =?utf-8?q?SRWO6T0NskSqRo5Y1RApnt3DUuLhsQ3kcKr68yu/EuHPMPtW6yNnKTy3?= =?utf-8?q?PS12WhuQupzjHj8Bk9t9DSi0KfuCBFlKpNRJNoW9dvbOgue3ZOZTdONb?= =?utf-8?q?bnXJQZehMvYY7tyOtBRI4qw9W2KYF2xlQWTDHSSG38sbpWTn4uTLsYc8?= =?utf-8?q?wZYb8ZNKRgXby2gicGzaG/P7Y2Y8ntLXY0UV4ZZJ4uNRXKIri7lvHg8i?= =?utf-8?q?4SpN+Lkhyvl5QW405vGaS6Mxe7sq8VtKTENZl87L71ELKvGPDwyteGc2?= =?utf-8?q?9LpiO79SM0dLrXdDchzMoI7y2N9BTtprVJlNDeVz2mFthFU1/ki/C0Z3?= =?utf-8?q?XiUl2CM/+fRIvoh6hfWN5wc0FJyeZmeVAo4gL44dJshcOwFy+9GTIHMG?= =?utf-8?q?+QeuCRHGPmGsxsnoEL+40GLOuLX+3EvQbRZ628yQQJorqC6GOXc6VycN?= =?utf-8?q?1Im1DOPf8m8Ps2eu5U3fJcqlpYPDHW+ES2eO0DMesMm63Bxw4OER5jIT?= =?utf-8?q?Jca8frIs4kNns+yendy0Er0SJ1jJ+PpjgKxancGpgCNaj9z7GIXmK/sF?= =?utf-8?q?dqXlIsbwJTNTeJiJfsnJjLRBwC7518jeDIO5jCYiGiZ7n7YV7VTdiF0R?= =?utf-8?q?9kYb8gpYVBrfddR61Z1unWfC8sMkn8OH7yNzrz17m773etpyP1wiwAv6?= =?utf-8?q?klUdGW0ra09RtEc10mv51TyjfpNI4R+/h6JpQIBdxpiuaZG7E5uw528N?= =?utf-8?q?d+D0X/J0moofs0RWyLRiG1gA7H+RqojWRSxVR2wrjC+v?= X-Microsoft-Antispam-Message-Info: nJ9L4JpaCGk900O5PFVHvRLhpi2M3HJJcfv0W/MMhf8GVTod6CcnyZgeqXSIKYn2NZg0yZ0TPMUcN1tEToyTPwtFA4pAafNoOowzYw7NaQDcfpXXfrANtR+dRcqTNb+e3pmRxHilXc7WyZvWNZfKMXxrN6ENXYki0WQ1CmhdlZsagrAK+2Ys5UWkMbk0zatWgoUJ7y84ncfYXxARkpDd28LcMm2ZJTONP9jA8Pgjwd4GA7Uhiv6Kd78z86xPxbellhHKvDhW5Slo8TplzyLaBCE8Mg/1l7vee0at652CHm3zRbYfijZXHLHHnXka9Mv7YO4zRz2Tvz9MOxQ+5tC98zqX1sDxuYmxdODifbhJN4Y= X-Microsoft-Exchange-Diagnostics: 1; SN6PR07MB4910; 6:xqzWDN9Pmc1t33vJ6RbP7J9YG7aPgBLx+8nAvgw+23/EgfGj5aoa/vIg0x4g2ngzHW3+WtsN1oKsnzPogdHLx8KcXNF3vfOFlyirpDN9/0NCZqnnDePXYKvKOR9/20ezXUCLevEEr3oBokkklS79u7YKJTykhy4JyapRSgev1tPmwKLbIA4GZSajsIZLef9/zmCIBn6FA/A33lDconyLXMnzruix7BSKur5GFbbL0cwJensEvImE8xSGAkqm77EeN0/mBj+CmS0w4rZkMYxjD+Vd4gEFgnCxdoeQT66UyQDwW+y045XQHzb2agdbsSed8OFKTsAK2wqcjHdxx7nIBIM20ucpb0MOEH+Xtpqtnvf5AUF4AmDcHqbLphQZVrciE/G1rjSNyKQWpvjUszZKtDHkRC4MSQaiBzDa3/ZLcM6n+h/9/Wr/+z0SRFeeZwJjMLMZ8jw1pK2WXJush5cQXg==; 5:XdsNh0PMQRCUXmmJKUJzecEbTzfeA/iHlIOq///zzdBaQ1QTPTf0K0z22Trquy+/3/H9w8sMF0XY4XyTalGqhd1cj5Z7fRn4PwY6DGzBu32eLceyEpv+BTZisxVMN/tNvAJTGls+CV5heANqkE20kTSoS4AOxqqZ5sECV0Q+tZs=; 7:hIjoX2IAs11eQxvcIeFeyETaEnGcvbOanPPfo4fVayLELk4Y2OK9E3zj6OVFUJVhRAkVMZ6xaFQkbXnp05aDKKNAijXclOS2K8D+7gKQuUGfrnxluUuK+hvKyoRCcLRmKgAxg1hETmjgMKotMfskRxja95v2n2xC74qODaxFNG70eKe2Tg1GkHGJUxst/FYN4haV3q5fbN6bWwuCY8zmdXDpi1yU4YHCYBBk/eSY2EpDgS+SxS00WtqTdc0MgjHT SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 05 Oct 2018 13:02:48.0838 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 7118f927-468a-4f82-8060-08d62ac2dc1a X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 711e4ccf-2e9b-4bcf-a551-4094005b6194 X-MS-Exchange-Transport-CrossTenantHeadersStamped: SN6PR07MB4910 Subject: [dpdk-dev] [PATCH v3 32/32] doc: adds doc file 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" This patch adds the features file and the document containing help to compile and use octeontx crypto. Signed-off-by: Ankur Dwivedi Signed-off-by: Anoob Joseph Signed-off-by: Murthy NSSR Signed-off-by: Nithin Dabilpuram Signed-off-by: Ragothaman Jayaraman Signed-off-by: Srisivasubramanian S Signed-off-by: Tejasree Kondoj --- MAINTAINERS | 2 + doc/guides/cryptodevs/features/octeontx.ini | 62 ++++++++++++++ doc/guides/cryptodevs/index.rst | 1 + doc/guides/cryptodevs/octeontx.rst | 128 ++++++++++++++++++++++++++++ 4 files changed, 193 insertions(+) create mode 100644 doc/guides/cryptodevs/features/octeontx.ini create mode 100644 doc/guides/cryptodevs/octeontx.rst diff --git a/MAINTAINERS b/MAINTAINERS index b38beb9..a8319d1 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -776,6 +776,8 @@ Cavium OCTEON TX M: Anoob Joseph F: drivers/common/cpt/ F: drivers/crypto/octeontx/ +F: doc/guides/cryptodevs/octeontx.rst +F: doc/guides/cryptodevs/features/octeontx.ini Crypto Scheduler M: Fan Zhang diff --git a/doc/guides/cryptodevs/features/octeontx.ini b/doc/guides/cryptodevs/features/octeontx.ini new file mode 100644 index 0000000..307ab88 --- /dev/null +++ b/doc/guides/cryptodevs/features/octeontx.ini @@ -0,0 +1,62 @@ +; +; Supported features of the 'octeontx' 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 +In Place SGL = Y +OOP SGL In LB Out = Y +OOP SGL In SGL Out = Y + +; +; Supported crypto algorithms of 'octeontx' crypto driver. +; +[Cipher] +NULL = Y +3DES CBC = Y +3DES ECB = Y +AES CBC (128) = Y +AES CBC (192) = Y +AES CBC (256) = Y +AES CTR (128) = Y +AES CTR (192) = Y +AES CTR (256) = Y +AES XTS (128) = Y +AES XTS (256) = Y +DES CBC = Y +KASUMI F8 = Y +SNOW3G UEA2 = Y +ZUC EEA3 = Y + +; +; Supported authentication algorithms of 'octeontx' crypto driver. +; +[Auth] +NULL = Y +AES GMAC = Y +KASUMI F9 = Y +MD5 = Y +MD5 HMAC = Y +SHA1 = Y +SHA1 HMAC = Y +SHA224 = Y +SHA224 HMAC = Y +SHA256 = Y +SHA256 HMAC = Y +SHA384 = Y +SHA384 HMAC = Y +SHA512 = Y +SHA512 HMAC = Y +SNOW3G UIA2 = Y +ZUC EIA3 = Y + +; +; Supported AEAD algorithms of 'octeontx' 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 e9928a4..bd15885 100644 --- a/doc/guides/cryptodevs/index.rst +++ b/doc/guides/cryptodevs/index.rst @@ -17,6 +17,7 @@ Crypto Device Drivers dpaa2_sec dpaa_sec kasumi + octeontx openssl mvsam null diff --git a/doc/guides/cryptodevs/octeontx.rst b/doc/guides/cryptodevs/octeontx.rst new file mode 100644 index 0000000..2673dd5 --- /dev/null +++ b/doc/guides/cryptodevs/octeontx.rst @@ -0,0 +1,128 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2018 Cavium, Inc + +Cavium OCTEONTX Crypto Poll Mode Driver +======================================= + +The OCTEONTX crypto poll mode driver provides support for offloading +cryptographic operations on cryptographic accelerator units on +**OCTEON TX** :sup:`®` family of processors (CN8XXX). The OCTEONTX crypto poll +mode driver enqueues the crypto request to this accelerator and dequeues the +response once the operation is completed. + +Supported Algorithms +-------------------- + +Cipher Algorithms +~~~~~~~~~~~~~~~~~ + +* ``RTE_CRYPTO_CIPHER_NULL`` +* ``RTE_CRYPTO_CIPHER_3DES_CBC`` +* ``RTE_CRYPTO_CIPHER_3DES_ECB`` +* ``RTE_CRYPTO_CIPHER_AES_CBC`` +* ``RTE_CRYPTO_CIPHER_AES_CTR`` +* ``RTE_CRYPTO_CIPHER_AES_XTS`` +* ``RTE_CRYPTO_CIPHER_DES_CBC`` +* ``RTE_CRYPTO_CIPHER_KASUMI_F8`` +* ``RTE_CRYPTO_CIPHER_SNOW3G_UEA2`` +* ``RTE_CRYPTO_CIPHER_ZUC_EEA3`` + +Hash Algorithms +~~~~~~~~~~~~~~~ + +* ``RTE_CRYPTO_AUTH_NULL`` +* ``RTE_CRYPTO_AUTH_AES_GMAC`` +* ``RTE_CRYPTO_AUTH_KASUMI_F9`` +* ``RTE_CRYPTO_AUTH_MD5`` +* ``RTE_CRYPTO_AUTH_MD5_HMAC`` +* ``RTE_CRYPTO_AUTH_SHA1`` +* ``RTE_CRYPTO_AUTH_SHA1_HMAC`` +* ``RTE_CRYPTO_AUTH_SHA224`` +* ``RTE_CRYPTO_AUTH_SHA224_HMAC`` +* ``RTE_CRYPTO_AUTH_SHA256`` +* ``RTE_CRYPTO_AUTH_SHA256_HMAC`` +* ``RTE_CRYPTO_AUTH_SHA384`` +* ``RTE_CRYPTO_AUTH_SHA384_HMAC`` +* ``RTE_CRYPTO_AUTH_SHA512`` +* ``RTE_CRYPTO_AUTH_SHA512_HMAC`` +* ``RTE_CRYPTO_AUTH_SNOW3G_UIA2`` +* ``RTE_CRYPTO_AUTH_ZUC_EIA3`` + +AEAD Algorithms +~~~~~~~~~~~~~~~ + +* ``RTE_CRYPTO_AEAD_AES_GCM`` + +Compilation +----------- + +The **OCTEON TX** :sup:`®` board must be running the linux kernel based on +sdk-6.2.0 patch 3. In this, the OCTEONTX crypto PF driver is already built in. + +For compiling the OCTEONTX crypto poll mode driver, please check if the +CONFIG_RTE_LIBRTE_PMD_OCTEONTX_CRYPTO setting is set to `y` in +config/common_base file. + +* ``CONFIG_RTE_LIBRTE_PMD_OCTEONTX_CRYPTO=y`` + +The following are the steps to compile the OCTEONTX crypto poll mode driver: + +.. code-block:: console + + cd + make config T=arm64-thunderx-linuxapp-gcc + make + +The example applications can be compiled using the following: + +.. code-block:: console + + cd + export RTE_SDK=$PWD + export RTE_TARGET=build + cd examples/ + make + +Execution +--------- + +The number of crypto VFs to be enabled can be controlled by setting sysfs entry, +`sriov_numvfs`, for the corresponding PF driver. + +.. code-block:: console + + echo > /sys/bus/pci/devices//sriov_numvfs + +The device bus ID, `dev_bus_id`, to be used in the above step can be found out +by using dpdk-devbind.py script. The OCTEONTX crypto PF device need to be +identified and the corresponding device number can be used to tune various PF +properties. + + +Once the required VFs are enabled, dpdk-devbind.py script can be used to +identify the VFs. To be accessible from DPDK, VFs need to be bound to vfio-pci +driver: + +.. code-block:: console + + cd + ./usertools/dpdk-devbind.py -u + ./usertools/dpdk-devbind.py -b vfio-pci + +Appropriate huge page need to be setup in order to run the DPDK example +applications. + +.. code-block:: console + + echo 8 > /sys/kernel/mm/hugepages/hugepages-524288kB/nr_hugepages + mkdir /mnt/huge + mount -t hugetlbfs nodev /mnt/huge + +Example applications can now be executed with crypto operations offloaded to +OCTEONTX crypto PMD. + +.. code-block:: console + + ./build/ipsec-secgw --log-level=8 -c 0xff -- -P -p 0x3 -u 0x2 --config + "(1,0,0),(0,0,0)" -f ep1.cfg +