From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM02-CY1-obe.outbound.protection.outlook.com (mail-cys01nam02on0041.outbound.protection.outlook.com [104.47.37.41]) by dpdk.org (Postfix) with ESMTP id 3BBDF2862 for ; Tue, 4 Sep 2018 06:09:15 +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=Kt89N3Z+0p46V1Qg+vDTO5m6UwdJLEqLVDZr67gqUvs=; b=jfk03IP//W6QzMbFAQKn3rFKgr/tbSBGSpBBesp+1geBdp05lxwOQcpxyGfIBAOOEiB3m8Hy8FRA1+LQWgqIRXpH5jhl+8hvi3dYD0hdRNJ9W/kGX4jiff0NP/xH/kdNDo0dnRS0w61zdJ2EbWmQWEbar0/vSzNEeD9cZs01N6o= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=Anoob.Joseph@cavium.com; Received: from ajoseph83.caveonetworks.com.com (115.113.156.2) by BYAPR07MB4902.namprd07.prod.outlook.com (2603:10b6:a02:ef::25) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.1101.15; Tue, 4 Sep 2018 04:04:10 +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: Tue, 4 Sep 2018 09:29:20 +0530 Message-Id: <1536033560-21541-34-git-send-email-ajoseph@caviumnetworks.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1536033560-21541-1-git-send-email-ajoseph@caviumnetworks.com> References: <1528476325-15585-1-git-send-email-anoob.joseph@caviumnetworks.com> <1536033560-21541-1-git-send-email-ajoseph@caviumnetworks.com> MIME-Version: 1.0 Content-Type: text/plain X-Originating-IP: [115.113.156.2] X-ClientProxiedBy: BMXPR01CA0023.INDPRD01.PROD.OUTLOOK.COM (2603:1096:b00:d::33) To BYAPR07MB4902.namprd07.prod.outlook.com (2603:10b6:a02:ef::25) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: e5457248-08b2-4f42-2260-08d6121b7a69 X-Microsoft-Antispam: BCL:0; PCL:0; RULEID:(7020095)(4652040)(8989137)(4534165)(4627221)(201703031133081)(201702281549075)(8990107)(5600074)(711020)(2017052603328)(7153060)(7193020); SRVR:BYAPR07MB4902; X-Microsoft-Exchange-Diagnostics: 1; BYAPR07MB4902; 3:N4wG6sjK9Gms6LISCEg7vzpZ3Oex9uMDYYF0lxYvG0hKaYb0rnqRJv9OIbm8QqkxH6Oc7etGxLPomU8ailAhR/GlMPhg/iGSx5lBDCzZZ1S4L+mjnPuCP5HFjfHk7CUD79fX0DedUBcTZ4xY9oN73kLxMLRJxS3EditCEgTkN/8tpx1j5W9MSNr61m4GNyOXlVXStzOW1XzbGuBXec036mwnwdUvbOx0LKiqNxpIH9AzBOFLd4GgTjXA2kr2HMJh; 25:Ra5Vnksh+h/AcUFIzWvg9SplJG3399w4u1VhRy0GMw1omUBQG/AcDJ9HUMTplr2Thmv2TpHhXpkI4v1E8Twhv0toGVeq5VZl7OfjJt72BeyrEdesxnIvSbm3MOJOlflffI48Yssa2z54wRwFPGFhikOwxXG4eUhxva2AB5bOlVKzraGMmp0V22Omf9fcGBj3qazt2NL6AVzhcTFFpjdCQhSNsPhS4cLsadsSR1b7JbJMOougWggVAwE5ukyjAZHYczDr1VksZSvblkfrfft+HxK+BZvMUMUHwYDAYiGirt/8DXPiFYgdb+wyKTw9uuJ6NvPBdr0ubI7fm6vfyglpOA==; 31:KgjD340hBSvFPVYev4csWjIP31yt23GbG7XNyH2lHj3Dh7LmWKFJVNqbzgvfSvCkx/RiBOkovjUUZUZtDu/Ceq9TnAOPNbGfZMkIT5hsYT0mbhfLQq7ey3GdQ5vd1jvIptnDTOaH19EbsHG4glffrYUK8uxk5B6BY4g2+hUU43xKnThwdro/jwuFe2bhtjmqTNaEIBi6teRsxFQO8F1+7odwY5mAsLvBqzJAEWzjBKo= X-MS-TrafficTypeDiagnostic: BYAPR07MB4902: X-Microsoft-Exchange-Diagnostics: 1; BYAPR07MB4902; 20:K3xMoXnN+OVvuYG/CiaYiRcCBSAgVCbN5WkF0Ul82za3a8jSJDY/SlQA52fjRJ+QWmlmGN029VFQ2LwtDwCwiXNUhkpwxjERogGJPiIKAonDqQ5J6aywErYk96kEBs40NbyhQ/5TlZyod415AwT4+0IhiEXAC51nKFoDp+X9C/iC+62SxKNHpDsHGAJrZqbFri7mIFyj9fv/re2b0nDMRKHWHWf4YcADTR7aMaKgOLWgrXVaCPgqoQoQZ4PjsUpmYy6Q8cSZM6XHwMF1bKSZbPFw4PMKx1VgYbmxFMpmatROGWw8ZcP0Itpv9gWVnWn0/iitfX1c7gyj9C7RMCPuaSfgi89kDKP7WvLpWDfSTcMn6rlyW/nuaNg8DW3bfzk6RASSMssVXEP87373T6O6BJdouLY82/7AdTbF6ND26NHCLzPzeORSm7Gtucykdmw6aViCmgfhzm477BnfCxH1yq9Iz8mDCnUFQOItrDGDyVeqnNaVIYVWqyDwbiUmEje4FHbNlOC/FN51AZ5NkoYpoRMKIkqm+x4yPAbmmfQ4YOiLJfYCsGi+kHe7Fvp2VMfMK7SBwy0eMiZRLR8iCyVAPzu+kYb6KE4QsQ9n8VqSYYA=; 4:wFJS7EMDbcNA1wRv0Tp/1s2oro6g3jQE+knjJlfmqMOnvbnahw2AyeNkSJY6Sl6sOO/dAl3MsEky++vAL8dUZvcN90CjWoYNHx/S89EDzpidoAIqBY+slFowIkYd0mEKY7aPqYaVZaFrBQfdValnuHOYvtZXQYWVocjUhDKoPOik6OkNLvwxT9B9zPjTyfL1kCA0F0ZZmfQy6Wwzr4fNCVUncg8j2iKNT7Tb3+5WUVvoLcPTxaKZsV6uVv0mSH5N/CQoPD2tLvQyjzlCm5fx+sGfYQL1zBAeo2bHosHagg8MwgPOF1XqxLyGXg6t/+ei X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(278428928389397); X-MS-Exchange-SenderADCheck: 1 X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(8211001083)(6040522)(2401047)(8121501046)(5005006)(10201501046)(93006095)(3231311)(944501410)(52105095)(3002001)(149027)(150027)(6041310)(20161123562045)(20161123564045)(20161123560045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123558120)(201708071742011)(7699016); SRVR:BYAPR07MB4902; BCL:0; PCL:0; RULEID:; SRVR:BYAPR07MB4902; X-Forefront-PRVS: 0785459C39 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(366004)(396003)(136003)(346002)(376002)(39860400002)(199004)(189003)(26005)(51416003)(52116002)(76176011)(81166006)(305945005)(81156014)(7736002)(105586002)(316002)(6506007)(106356001)(6512007)(8936002)(446003)(54906003)(25786009)(6666003)(68736007)(50226002)(110136005)(53936002)(16586007)(42882007)(386003)(5660300001)(2906002)(72206003)(50466002)(6486002)(36756003)(6116002)(107886003)(2616005)(14444005)(186003)(3846002)(478600001)(66066001)(476003)(8676002)(47776003)(486006)(956004)(48376002)(11346002)(4326008)(97736004)(16526019); DIR:OUT; SFP:1101; SCL:1; SRVR:BYAPR07MB4902; 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: =?us-ascii?Q?1; BYAPR07MB4902; 23:yAT3TR2LV8xLSWHXlCdbWWJUWbtC8vBNJqH+0k4r/?= =?us-ascii?Q?MRtlXFCpuIw8PT1b8zG80qalmDa4S8LS9p9pdZNja0X0nhoHfbGFd/EOp+Md?= =?us-ascii?Q?D4hsbNPBsG+Fi7PxaCon1p8rXuySZIj/Iogr4XUPVGo+grlnvF0PAXQegBKh?= =?us-ascii?Q?zMTKdQbBkR2EdPred2qYjrMKPo3afpPBc9cdwiKwxk63HTHq0+EdL8JT0BIq?= =?us-ascii?Q?RyiaH8HYHO0kKn2UhIs8oJBxQi6Ok0l7leP8acCk6c7Hz/iSZQFKdm5BtEjj?= =?us-ascii?Q?FiOoJQl0A9AjIlHx0LIPGyt8rY9DAgejWSWjEcCRx5EwmiEh1Fraw1w3wnuy?= =?us-ascii?Q?Z948Xgfv6K7ZCS6RXtW/yMsNmAiGD1Odl8eibNPQy5gXqjvVhCkLhfuK81va?= =?us-ascii?Q?0/GuvgVD7RORTKJDOTROe65pcnPcdz8CZ8aALq8H/eR+HK/mp/SarJ/sq95j?= =?us-ascii?Q?rNBIhMJjMVlRxc0ab4Ni2w17pnQzqU4YC42c0APWYN97v9YhPoDz++b/ADJa?= =?us-ascii?Q?xol4eELUG2I7fkZ/Saz+5pGgnSlZ92cy36d8UhqBWfRlQFQNAllw6NT8t8zc?= =?us-ascii?Q?boO0u4T7Ew+Mu7hLkUreqgKyi6bhg27St0trYg9dLZ/3qVGgwyZElTh9IfAs?= =?us-ascii?Q?OoJYctmy65ZzscW8IuOs0ZvK0GeCVxg5wAoN2rRU9AlZF5TanyVx4XbXZ9M+?= =?us-ascii?Q?2l8p/mHyCscJu57nFhEO/xrqPGk7OO+VqTU8BtV887TDiUkjVAKhEDqPGOnj?= =?us-ascii?Q?L3bNfagbS+mlFmJqO+xoP8ikVYzCbGrVdkylA/Lp8B2zdQIR4mHVVjFxkaNv?= =?us-ascii?Q?lw0fqVPiqFPyvu5yphQ9RKl/Ej3wMZ5gwxsR+471bOo5PBLngA3Xg+sTub0P?= =?us-ascii?Q?x0Bv/kUJzEWUWGgGof2/hztw4nBTaHbUt9g5QeaF3h0Y4b+TJWyEEz64DgV7?= =?us-ascii?Q?OWM6NZNB8Mfu/ybkK+sGUVq4h5BZkvcJalwnDMS1jOh7TqXBWQ1oVTdxqe9h?= =?us-ascii?Q?BSEz5jxRjw/Yuz+aq+gkKpXtrELxweZDhuTfKRTiqvvtyuxMiUapDlnUsteP?= =?us-ascii?Q?lCPZlriH2b/TRBr6W/5XMddExZh5Cdx62lNIhvRWmfdLJYr6jA+CzMWIwqJ2?= =?us-ascii?Q?GtGAIU1+npuJxL+JXYE0F73HWgwhITqVkn9O64b/YJJTU8ajllbRV5wP78iu?= =?us-ascii?Q?zdGxNasL6mI2wW+85T589Cs+EDkub5RrWRspmOHd5q8sVsX19M+QugtOvk4l?= =?us-ascii?Q?x3BK2/nswmfgenIlgM=3D?= X-Microsoft-Antispam-Message-Info: Ipt0I0EJTtkBEDFy7Wf8xKdobKh0+h4L/8OumQDXIZ8BEYpNCdfaYzDqfMQAix2UAlSKBnKZez35DLVlXKWeRhMrFlXthxwLLhVHhGvlDPOQGyVrWSL8Tx6uMXp8CCI27PAlFtzi5vCqHaxL4Fq6RKAGE0CvrBtc/cRvTaES2uJMcLsLQY1JrgcglQNFJlg6w9w60yEhJFHv9LLMhobJoM7lwmT6b7Jy/TdTD3RdCdKmrSBq35ZTxLGcOf+aNuhstuEkc5Y3GNBWBCOyQ8l1ltBlRbg82hofvheFAWfWyDX4CHCgdnIcj6Fi6mY7LP2ORJDOFv+eJzKgxWOmRKW21p8VOlscrsEN8vZpLO+IJNE= X-Microsoft-Exchange-Diagnostics: 1; BYAPR07MB4902; 6:fMauOpLa9KOV2811VaIV8jT8plPTItOLrA1W5DKj43zK/TF8LKxDC/fN1taVjlkqZaysU71hfy+E6vMLCTglXE5t6cxAOpY25kpUmblQB1k/PAHA83LMVtVBfTJ/hXLp+kpZWyoSqKef0+6+7Pgn9BafXOFXz3/kQimrwDOqsbUS9OiHgkHOrq8LEeFDhMT4qafqjvWI/Yc1jXSfMuYWjN1lGarFxC0HoVAih0HQ4eqS+boHNBJifubkJGV9ue/i4y3wQyj8I6Ks3qNoVYYUz5+3Wc6yaqK7YgTKEoUR4GMhLpev+q2k2kEPmd2ymRVp0NegoC2C2brPRVsFSlHYzgmBPlRHgC7Qiyl0De4+K3xDtrHSyzM+OU22MmrShFSl6wVXXMxAFqLxHcZsf5n7xgiAkmaPHEGpx3o+A0CfddFtBlHmmRuhEitoPST06oOjusyaeIjmS5HN2hUnn4Dksw==; 5:7EFkpBJNUS5uBZ6bzao06Vkicx5JF55mhloiLDHETWVBMm22gzj9QjpoJQI8YwlShzsCBQ2ZlwnaxnTNyGzc1EVnSmbIh7wUqZjxkizfE06C9+h3ddZyCpVV3sGcLDolUItGya12uEsAmMLlO2DHJyaunT0/piv0JHDh8nqTR9w=; 7:6VpQHGbiIebvcc8TDz25vjMkvdjN7ZUX2LVIHF7P8HVfR/MMqUqg9L5X7d/RBrdbA/9XZd90ciMoLm53zZvVw6KkfOmC7corlDhsU9H61TTn97wywQ5K7eYU/vCC8dfsuz6x9wjlwHECoSvZ5WOax00KYNeu23KArigcjbQNRqN98bnOMFtLkRI7HZVNYD9Cymaou6V02oRcgnUKDOSXb7iLpOt6XMjh+Khfr724a6Bq6G58Q1EqMv2VNUgb0k+/ SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 04 Sep 2018 04:04:10.8349 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: e5457248-08b2-4f42-2260-08d6121b7a69 X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 711e4ccf-2e9b-4bcf-a551-4094005b6194 X-MS-Exchange-Transport-CrossTenantHeadersStamped: BYAPR07MB4902 Subject: [dpdk-dev] [PATCH v2 33/33] 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: , X-List-Received-Date: Tue, 04 Sep 2018 04:09:15 -0000 From: Anoob Joseph 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 --- doc/guides/cryptodevs/features/octeontx.ini | 60 ++++++++++++++ doc/guides/cryptodevs/octeontx.rst | 121 ++++++++++++++++++++++++++++ 2 files changed, 181 insertions(+) create mode 100644 doc/guides/cryptodevs/features/octeontx.ini create mode 100644 doc/guides/cryptodevs/octeontx.rst diff --git a/doc/guides/cryptodevs/features/octeontx.ini b/doc/guides/cryptodevs/features/octeontx.ini new file mode 100644 index 0000000..f5f5229 --- /dev/null +++ b/doc/guides/cryptodevs/features/octeontx.ini @@ -0,0 +1,60 @@ +; +; 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 +Mbuf scatter gather = 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/octeontx.rst b/doc/guides/cryptodevs/octeontx.rst new file mode 100644 index 0000000..67bd441 --- /dev/null +++ b/doc/guides/cryptodevs/octeontx.rst @@ -0,0 +1,121 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2018 Cavium, Inc + +Cavium's OcteonTX Poll Mode Driver +================================== + +The octeontx crypto poll mode driver provides support for offloading +cryptographic operations on cryptographic accelerator units on OcteonTX +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 OcteonTX board must be running the linux kernel based on sdk-6.2.0 patch 3. +In this the OcteonTX 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 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 sriov_numvfs should be assigned for the octeontx pf driver using the +following: + +.. code-block:: console + + echo > /sys/bus/pci/devices//sriov_numvfs + +The device number can be ascertained by running the dpdk-devbind.py scripts in +the dpdk sources. + +Then the corresponding vf should be binded to the vfio-pci driver using the +following: + +.. 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 examples dpdk +application. + +.. code-block:: console + + echo 8 > /sys/kernel/mm/hugepages/hugepages-524288kB/nr_hugepages + mkdir /mnt/huge + mount -t hugetlbfs nodev /mnt/huge + +After that the example dpdk application can be executed on the hardware. + +.. 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 -- 2.7.4