From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from NAM03-DM3-obe.outbound.protection.outlook.com (mail-dm3nam03on0044.outbound.protection.outlook.com [104.47.41.44]) by dpdk.org (Postfix) with ESMTP id 3FD0D1B20D for ; Tue, 9 Oct 2018 11:10:16 +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=0etmCcKFL5P5HCv+nvYEUoCnXlWWn+MWcor95mKVNWY=; b=Sh8fT+P2qahwt8ywdfz0tdJyV1uuNiynlroBJezA0ivVQM/LkD50F+gy/SW4Yc7O6tG9YsEcKBBTYMMMF1CnK/Jjr0eCiJdgOCMk7kiUgIntLuV76IZj6v51RnUjs1Vl5p0cZh2tuyDkBIXdiFl7T/cy7nrN3xmQ9588+LY9+sY= Authentication-Results: spf=none (sender IP is ) smtp.mailfrom=Anoob.Joseph@cavium.com; Received: from ajoseph83.caveonetworks.com.com (115.113.156.2) by BN7PR07MB4897.namprd07.prod.outlook.com (2603:10b6:406:ef::26) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.1207.28; Tue, 9 Oct 2018 09:10:10 +0000 From: Anoob Joseph To: Akhil Goyal , Pablo de Lara , Thomas Monjalon Cc: Anoob Joseph , Jerin Jacob , Narayana Prasad , Ankur Dwivedi , Murthy NSSR , Nithin Dabilpuram , Ragothaman Jayaraman , Srisivasubramanian S , Tejasree Kondoj , dev@dpdk.org Date: Tue, 9 Oct 2018 14:37:56 +0530 Message-Id: <1539076076-19786-24-git-send-email-anoob.joseph@caviumnetworks.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: <1539076076-19786-1-git-send-email-anoob.joseph@caviumnetworks.com> References: <1538744363-30340-1-git-send-email-anoob.joseph@caviumnetworks.com> <1539076076-19786-1-git-send-email-anoob.joseph@caviumnetworks.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Originating-IP: [115.113.156.2] X-ClientProxiedBy: PN1PR0101CA0004.INDPRD01.PROD.OUTLOOK.COM (2603:1096:c00:e::14) To BN7PR07MB4897.namprd07.prod.outlook.com (2603:10b6:406:ef::26) X-MS-PublicTrafficType: Email X-MS-Office365-Filtering-Correlation-Id: 488e3800-2f94-402f-f3b7-08d62dc705af X-Microsoft-Antispam: BCL:0; PCL:0; RULEID:(7020095)(4652040)(8989299)(4534185)(7168020)(4627221)(201703031133081)(201702281549075)(8990200)(5600074)(711020)(2017052603328)(7153060)(7193020); SRVR:BN7PR07MB4897; X-Microsoft-Exchange-Diagnostics: 1; BN7PR07MB4897; 3:Br4OdPhopkqt0n/+lwEEzZfhOYLcNGyHowp6NgZjMCe9wt+X0DiVllIT/9QgaQ3zc2GlhhCCl6z1fQ0z77f2/ykKpLRv3VRbSsCSlG/Y3QoSM51IwDErdy2F457d9Rx/bhybS82Y8oo/cWQRO9enFzSaiT9YqdLxUN6Osr6qsokRIII3ueNLAqixL+cE5B7xwQkzyi3AIAGDFneh6cRkYjP0A3gPeGmJznsjHDAX7Gen9v3Ty8IHqOnhxAyM6zyK; 25:3OzhObX0Gqk46nqlGMaAUYiHlS67dk1s1iRaGXRK42PJ00ov5XSt71bkabpIFRgH+95YL+TP5jTI3hh4FoQRvsP5ZEKIQI7/0n/rh9TTnW+c1m6vUUk+N2fF1s+B86B2I7A3yKvinNg3cjEgYGVIX2V4LjYHyhrGoepzDrV4EXR/b/UCxCLVB+NszYnXqP54QghJbqY+V8hN/qZIvbVivy5DG8Oz4fYUrk1JAxNmyVX54PAxHM5Qa19g/8JcqO7euLJoOKvuLR6OXe0n6SLHlyaG6tdaBvbO6S8mXRAez6/bosR00oz2jI6A+mF7dcX4+o3xgAlJCBbuJ/QAuv9jIQ==; 31:L32vQdfROc4e0kkYhOZt+8QR0IaeNqVaGCsNkCuZrOR4z3stPGmzqyyWJ/2ZnPNithvEMszsjncUXAuM+z6MiBbWS7k/6Wt3OjMu42kDhikI7DCLbRb1E4nLSYin9Dr7wiPOItXsQfILC+2x3Odw3kc7OHtCLvq1jJsjLGcXSenpZTm9DWtC8xh6yLiteBwsBRLORfdar2Vo0bqRrtCCTPeSIRf0GKKzhwOP7AnKH+Q= X-MS-TrafficTypeDiagnostic: BN7PR07MB4897: X-Microsoft-Exchange-Diagnostics: 1; BN7PR07MB4897; 20:s87G6rEmB+nzLyRUvoRY1hSwrNmcpQ1l9Wmoc6ywpcHXKPFZzvC45AfT8okkaovZe+4bH9XVq+eMchT7tVbBtBxFAWflOzJphsdaibk8dkdDZ0cTjquC9Fc5dZkRNC0q03BWJulRalr8Mne3arZbG4rdjKjkSM/3kTZ0Ol9iuWq3KMBFJWNrUi/R+CYlZHbYbp3hj4I4VASkgFCsTKYdWAP1K6XTU6/DYNHeRUU+lm7gX9GM/cjbvd2mnJkE3Nx1bqXdW/nIZOmAUwvHiYNXGD94DdDjrTwcSZpLrw5s7+gJ4yzp4wqf7ftuI6NqScs/chPXuIzbxJ2g54sGS/ehsPUq5ZFACiuTpslQjvu05OTBYSdozbtIHJwVuJaRz15BZbXJulcafyQUeizDpSg0pUDsTTDO6eXC7uCoyckR08SVTRZVoBInueSAdEhaSjYtRuTUrwwhE6UxHlUSCyxGCeI+qf3LGsjpPkDBAkdIApgw0WtHXc0su9jotzyZPPfiZRR7qYLHPa+EIgTC4xZVCwzfR7ldxJhvrqoDpMbguM4X3wsyC3LVTpbu/ceTvDSQaJ6QBltU9Y7AFguhvhzhckk8GnXooSDh++oczBt8MiU= 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)(5005006)(8121501046)(3002001)(93006095)(10201501046)(3231355)(944501410)(52105095)(149066)(150057)(6041310)(20161123560045)(201703131423095)(201702281528075)(20161123555045)(201703061421075)(201703061406153)(20161123562045)(20161123564045)(20161123558120)(201708071742011)(7699051); SRVR:BN7PR07MB4897; BCL:0; PCL:0; RULEID:; SRVR:BN7PR07MB4897; X-Microsoft-Exchange-Diagnostics: 1; BN7PR07MB4897; 4:HXUJoy18DmGhWhPJXdj/UvSfnfoUBJDC3wONh87YdvTHGPia7Mt7msoiXlbOAzaQuz4m5k9cy5wn8CCIi63FEECtZhr4eSLQBP6UOK6XYEZcLBTNGwusVrUCUh0/WlTq/kvkp55NPPyiiI6M5MEYk7ZNPE26BfZT51pS5okWZSTdyD2NJXGLGMXnCIl3sZ8lAF3cugv6+A6ZnfOTxE3whsg0nEkVpLI1BGJNF6dSIKeLZywCBRcRefeZrAnt0yvd8jdIdUYvu/ybYDNn/M+mwl28lK7IVGNgkbO9sa3ueMKss8xK92KhKJjsIarAW2gaKvN+OvvKhRfJ20y37cqHXq2UA846Vk/gX7g55I8azvA= X-Forefront-PRVS: 08200063E9 X-Forefront-Antispam-Report: SFV:NSPM; SFS:(10009020)(396003)(366004)(376002)(136003)(346002)(39860400002)(199004)(189003)(42882007)(47776003)(106356001)(6666003)(2870700001)(186003)(5660300001)(26005)(68736007)(16526019)(8936002)(25786009)(6116002)(2906002)(81156014)(50226002)(305945005)(81166006)(7736002)(3846002)(105586002)(478600001)(8676002)(54906003)(110136005)(14444005)(575784001)(6486002)(6506007)(50466002)(316002)(53936002)(386003)(23676004)(52116002)(76176011)(11346002)(6512007)(44832011)(446003)(36756003)(55236004)(956004)(2616005)(486006)(4326008)(66066001)(97736004)(72206003)(476003); DIR:OUT; SFP:1101; SCL:1; SRVR:BN7PR07MB4897; 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?B?MTtCTjdQUjA3TUI0ODk3OzIzOmxhUUNpWEZFUE1VNnB6WWc1MVdDOUk5N0pz?= =?utf-8?B?b0hDMUZoTmdBcGFlOFJEc1BoQVF4U2xKQkkrR2ExL1pFN2YyNmZETStKVE1B?= =?utf-8?B?NGlIb3pSMmcrcjNjSmMxYWdUdHcyZ2hYMlNDMlNxVG5jTE16OGY0Z24yTTdS?= =?utf-8?B?NEd0WVo0MmV6bTc5UnIrZExpdHhOQ0lORTRvVjFubXRBV2U0RGl3UGp1SHh3?= =?utf-8?B?WE95UGUvOVh0TStZdXNJQitZYWE4d1FEUmZYRFYvV09MY3YyY1JQenl4UWFY?= =?utf-8?B?UXFtQTNtSW04ZjNUdkFDK05NbmZpUmx5NERvZURqTnIzWExJV1JPRWUzOG1E?= =?utf-8?B?VjRQR3QweHhrampkTlVGMGhoQmV0YzVWVWRWOXRZVUtJTXY3b3JpZ0lBMjlC?= =?utf-8?B?MXFJdUpwNHZvQVB6L3BGNldiRUFDZlRVNndsbHp3N1VQMDBGc0tPRHdqMW40?= =?utf-8?B?a0VEa204Nlo1RWxyUW9aaFNGcS8weEFLWjdKOHIvaVJSOVJ4R0lhWFFPRDBJ?= =?utf-8?B?Y3dZSE9iTDQwNUo5ZDlQWi9RelJWNG9nNWhjRHI1QXNVRUkxMDNYZnBlRmRV?= =?utf-8?B?dzFoaDhaMmxxekpxYkExT0lmVGd4MnFydXhDY3kwZmVzMzBzWklCZkV5OUZ2?= =?utf-8?B?SVFlVXQ3R0FjcXp4bmpueDJYWUhaOC9rcnEyRS96UU13anFZeEdzMDZtaHJ1?= =?utf-8?B?N3p1MGhlbUgvamRSaFQwWTl2V0c3OVN2OTRjRHFkTlJxN3BMYlB3dk84SEYv?= =?utf-8?B?Wi9YZlR5RnNveU41WUJzZjJmbFMvbjIvUzRsSFNsZWRkNTB2em9oeXV2SWZ6?= =?utf-8?B?cE93bXN0M2k4ZUpNR2o1VlBkQXdpUzVyMk12TWkzQVFDTC9vRTFJdlRpRWY5?= =?utf-8?B?V2R4eDRrOVZKWVVzRG9OWWk1STRkME16S0lKRHc4YWk1SkVueHhyZlBxNlNa?= =?utf-8?B?MVdud1dzOWdBN0dqMHJjOUs1WEtUUjBESXZEc1ZaSzVaK1NrRW1zYW5XMDlN?= =?utf-8?B?UmZQVGVwQ2E1OHVBbjBsZmNZL3NnNlRRRFhWbEhNMi9obnl6UERoakhqL09T?= =?utf-8?B?ZS9aV3o4RHZ3bjYzdmRQT2daT1FpYVJvYms5Rng3cG9HdmNWa29qUDBrTDVU?= =?utf-8?B?cHNlZGdrMldKdUFUSUlyUVdOKzZMQ2lwYzNreVFVMHY1U3ZYWEE4MFRWTmpL?= =?utf-8?B?d1BKQkkrNW9USjdMby9nRW83a2lCd1FndHZOa0czY0tvRzFHT1BuM01VRkdU?= =?utf-8?B?RHFlVStXWjR4MlBqaHdGR0hzWjhNaStZV0pWTzAvLzE5YUlCcDc1dDhEeFR3?= =?utf-8?B?ZmlPMWR4WWdpRWI4ZzRHRVdKTGxyZE1tZjdWUG5uVmppR2VyYSt5ZjloU1R4?= =?utf-8?B?VG1mOEpCWEdnSGFlMElOM3Y1WHp2SzR4QmtuQ0o3K20rOXY3TDc5bjVoOStC?= =?utf-8?B?WVVmVllKdDNscmRWUG1NYjNLVEVLZTduNUdidGhpS2gvMVY4UnpvRnZGKzgr?= =?utf-8?B?ZGFHOGRZQUxqcGU5TCtUWUplUjN1MFd6WlBZaHBRZkczWkw2T3VLS1dBaTRa?= =?utf-8?B?cXZBWXhHM0ZPYWs0a09RVHJIalEzMTVLRFVla0hFVWk4azJsR3VsaVVTV3lS?= =?utf-8?B?ZUsvY05FeCtzbG1Ga0VESDd3cWtqQmFGRFF2aklHZkJ4eUE2RlR2dUZ0OFMx?= =?utf-8?B?MHV4Q1ZrenRCN2hvVTlGSjB0NlplUUdIL0tIN21nMGt2WHZvY1FFN1ptM2wy?= =?utf-8?B?dDZ2WE5pV1lUQ01iOS9VZz09?= X-Microsoft-Antispam-Message-Info: ai5qpxUvMNrrsK7sjMWR0sEipqfJNPNPAllM/M93wEjRh1v3bbM9uYjl+we1YVylZZ7ocyiAOpOXj4nCfSk/GDk7/09matGbTFFF2GQ97HqWtlvA7k9+hg4Fdk84fms2PprrE8rsXiLhORV8WEyT5dV02RA3jdOGwe+Te59Wn4vSk4Kg9wDYH76d8KV+Yr19u1OpOsI3x9Hk0y1e11KIWYl9b+/MjplTG6kaQjuKIRNWDcdM8XJum/ClpmhsYui0O4IoXS1YDclkvfLkACTTkWf58q9rPr3XFcQe1dYFtWUDPSsE2Y87mJ6kpmtWuv580su1qm0auL6YSgepKgu3ZDxYCUhpREabx2BiEqui2bM= X-Microsoft-Exchange-Diagnostics: 1; BN7PR07MB4897; 6:tFLrKJ+LGbR0ia8AKVkkQbzrFEZRSN+jL4Uk3WNppVtZp88/j7rEsBpD/Bg71BfrSSEGD+fK2nEthYIGPgz+RC4nmFOqMhePP6wURCij5ikU8rb9m+6Ek/Yeky7BSSakgK/gNd2KSZKQklvjoT2ngNSwWP/BxUSaQdoU/jeA/FCuwld+OLPKwmIV0boEMcs75I7+ah79ftSSnL6V7ECDhzTgN3HLDoZzqBsBV49LMNvlzlQPs8Kw6l5+qz9c0s6qCFl1Xeoz1qA414t7Ygugt86w+Um8Nokfww9jXp4YTbr8SKA60NzDFW0iY7rigBh9B/xE6KnS/D5wVpVQ7+9iPwsGzxzRYIZ6GA+1iu1BJ72C0MWrmS/invujy/f8kYPeIrNtfHTHguVyX2KaUDzkAuyll4Gg+VqR245gmJEP7SZZDvR+3vO9Hp31RVTSUMthCY0qiVBkb+UnYHwt/tnNew==; 5:G3a8ndTdR018K7ZMHQEZOAlKlhyWUE0emKcoWQNCjC+nGWKcqNDHBl7rD9Z32rtSAuDDQfEbRbW4V1aoD08MnDwm5kcludMTOlAcOyCGVK5rWb/CxQYoXLRHLwsml9+cJezxO+cV0q6rRXCh4r+RfWSP8yNw6+sFy/cYHkDxIh8=; 7:VY/9o4AtQK04WTznUadg5J8K6p4rPtesE5+86frcS+aimFt8Smz78KS+zfip0nTBqBWoBTakFxsQ1rZ/4tVPvNI5rjpdDScuosScAnG5pxJHZJWj1pgGioUr3Huvt1BGczNW6thiKzgKnNKLVtFuEPQLGVb2qPGNwDPrDc6TjMhcAcTVXHKayAJpBHdqtuXwDJ+RF4AMZdVLbtCDQBqoRNzht02X3iJQI4uktXb9bxViVaN1jMx6juE7M43OsenT SpamDiagnosticOutput: 1:99 SpamDiagnosticMetadata: NSPM X-OriginatorOrg: caviumnetworks.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 09 Oct 2018 09:10:10.2519 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: 488e3800-2f94-402f-f3b7-08d62dc705af X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 711e4ccf-2e9b-4bcf-a551-4094005b6194 X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN7PR07MB4897 Subject: [dpdk-dev] [PATCH v4 23/23] doc: add documentation for OCTEON TX crypto 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, 09 Oct 2018 09:10:17 -0000 Adding feature file and guide for OCTEON TX crypto PMD 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 001bae9..afa0e56 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -783,6 +783,8 @@ Cavium OCTEON TX crypto 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..1054446 --- /dev/null +++ b/doc/guides/cryptodevs/octeontx.rst @@ -0,0 +1,128 @@ +.. SPDX-License-Identifier: BSD-3-Clause + Copyright(c) 2018 Cavium, Inc + +Cavium OCTEON TX Crypto Poll Mode Driver +======================================== + +The OCTEON TX crypto poll mode driver provides support for offloading +cryptographic operations to cryptographic accelerator units on +**OCTEON TX** :sup:`®` family of processors (CN8XXX). The OCTEON TX 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 OCTEON TX crypto PF driver is already built in. + +For compiling the OCTEON TX 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 OCTEON TX 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 OCTEON TX 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 +OCTEON TX 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 + -- 2.7.4