From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 8B86EA0521; Tue, 3 Nov 2020 13:37:17 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 5570FCA34; Tue, 3 Nov 2020 13:36:44 +0100 (CET) Received: from mga11.intel.com (mga11.intel.com [192.55.52.93]) by dpdk.org (Postfix) with ESMTP id 4341ECA14 for ; Tue, 3 Nov 2020 13:36:41 +0100 (CET) IronPort-SDR: 5QmDTGpmctvrswHTmvUYLz8MhxlhR6BqtVszYt3DU+K7wAdtBhfa9e4sKyck2l5L1+cwiMEFsJ u01AVyFHcWOA== X-IronPort-AV: E=McAfee;i="6000,8403,9793"; a="165540646" X-IronPort-AV: E=Sophos;i="5.77,448,1596524400"; d="scan'208";a="165540646" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by fmsmga102.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 03 Nov 2020 04:36:40 -0800 IronPort-SDR: X8CHtVxsHuMpKFSUJYmbMGo7U1AeTjHvBhj6LscjoLbGtcw0wDGw+R75GSg2usKknArtkVxLI+ WMkbBm4CUc/w== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,448,1596524400"; d="scan'208";a="528468523" Received: from silpixa00399126.ir.intel.com ([10.237.222.4]) by fmsmga005.fm.intel.com with ESMTP; 03 Nov 2020 04:36:38 -0800 From: Bruce Richardson To: dev@dpdk.org Cc: Bruce Richardson , Declan Doherty , Pablo de Lara , Somalapuram Amaranath , Michael Shamis , Liron Himi , Fan Zhang , Rosen Xu , Andrew Rybchenko , Luca Boccassi Date: Tue, 3 Nov 2020 12:36:03 +0000 Message-Id: <20201103123608.1114433-3-bruce.richardson@intel.com> X-Mailer: git-send-email 2.25.1 In-Reply-To: <20201103123608.1114433-1-bruce.richardson@intel.com> References: <20201102174507.1085128-1-bruce.richardson@intel.com> <20201103123608.1114433-1-bruce.richardson@intel.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v2 2/7] doc: fix driver names in crypto devices guide 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" Since the built driver filenames have changed in DPDK 20.11, we need to update the driver doc to match. Fixes: a20b2c01a7a1 ("build: standardize component names and defines") Signed-off-by: Bruce Richardson --- V2: added two missed driver name changes --- doc/guides/cryptodevs/aesni_gcm.rst | 2 +- doc/guides/cryptodevs/aesni_mb.rst | 2 +- doc/guides/cryptodevs/ccp.rst | 2 +- doc/guides/cryptodevs/kasumi.rst | 2 +- doc/guides/cryptodevs/mvsam.rst | 2 +- doc/guides/cryptodevs/null.rst | 2 +- doc/guides/cryptodevs/scheduler.rst | 4 ++-- doc/guides/cryptodevs/snow3g.rst | 2 +- doc/guides/cryptodevs/zuc.rst | 2 +- 9 files changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/guides/cryptodevs/aesni_gcm.rst b/doc/guides/cryptodevs/aesni_gcm.rst index e4f244a991..2fd32b021f 100644 --- a/doc/guides/cryptodevs/aesni_gcm.rst +++ b/doc/guides/cryptodevs/aesni_gcm.rst @@ -5,7 +5,7 @@ AES-NI GCM Crypto Poll Mode Driver ================================== -The AES-NI GCM PMD (**librte_pmd_aesni_gcm**) provides poll mode crypto driver +The AES-NI GCM PMD (**librte_crypto_aesni_gcm**) provides poll mode crypto driver support for utilizing Intel multi buffer library (see AES-NI Multi-buffer PMD documentation to learn more about it, including installation). diff --git a/doc/guides/cryptodevs/aesni_mb.rst b/doc/guides/cryptodevs/aesni_mb.rst index 32850c977c..042d95baee 100644 --- a/doc/guides/cryptodevs/aesni_mb.rst +++ b/doc/guides/cryptodevs/aesni_mb.rst @@ -5,7 +5,7 @@ AESN-NI Multi Buffer Crypto Poll Mode Driver ============================================ -The AESNI MB PMD (**librte_pmd_aesni_mb**) provides poll mode crypto driver +The AESNI MB PMD (**librte_crypto_aesni_mb**) provides poll mode crypto driver support for utilizing Intel multi buffer library, see the white paper `Fast Multi-buffer IPsec Implementations on Intel® Architecture Processors `_. diff --git a/doc/guides/cryptodevs/ccp.rst b/doc/guides/cryptodevs/ccp.rst index 4cf9f5907e..36dae090f9 100644 --- a/doc/guides/cryptodevs/ccp.rst +++ b/doc/guides/cryptodevs/ccp.rst @@ -5,7 +5,7 @@ AMD CCP Poll Mode Driver ======================== This code provides the initial implementation of the ccp poll mode driver. -The CCP poll mode driver library (librte_pmd_ccp) implements support for +The CCP poll mode driver library (**librte_crypto_ccp**) implements support for AMD’s cryptographic co-processor (CCP). The CCP PMD is a virtual crypto poll mode driver which schedules crypto operations to one or more available CCP hardware engines on the platform. The CCP PMD provides poll mode crypto diff --git a/doc/guides/cryptodevs/kasumi.rst b/doc/guides/cryptodevs/kasumi.rst index 5770a60cb2..4790f0ff77 100644 --- a/doc/guides/cryptodevs/kasumi.rst +++ b/doc/guides/cryptodevs/kasumi.rst @@ -4,7 +4,7 @@ KASUMI Crypto Poll Mode Driver =============================== -The KASUMI PMD (**librte_pmd_kasumi**) provides poll mode crypto driver support for +The KASUMI PMD (**librte_crypto_kasumi**) provides poll mode crypto driver support for utilizing `Intel IPSec Multi-buffer library `_ which implements F8 and F9 functions for KASUMI UEA1 cipher and UIA1 hash algorithms. diff --git a/doc/guides/cryptodevs/mvsam.rst b/doc/guides/cryptodevs/mvsam.rst index 6188c1248c..49482c7714 100644 --- a/doc/guides/cryptodevs/mvsam.rst +++ b/doc/guides/cryptodevs/mvsam.rst @@ -5,7 +5,7 @@ MVSAM Crypto Poll Mode Driver ============================= -The MVSAM CRYPTO PMD (**librte_crypto_mvsam_pmd**) provides poll mode crypto driver +The MVSAM CRYPTO PMD (**librte_crypto_mvsam**) provides poll mode crypto driver support by utilizing MUSDK library, which provides cryptographic operations acceleration by using Security Acceleration Engine (EIP197) directly from user-space with minimum overhead and high performance. diff --git a/doc/guides/cryptodevs/null.rst b/doc/guides/cryptodevs/null.rst index aac5904b1d..12577fa0bf 100644 --- a/doc/guides/cryptodevs/null.rst +++ b/doc/guides/cryptodevs/null.rst @@ -4,7 +4,7 @@ Null Crypto Poll Mode Driver ============================ -The Null Crypto PMD (**librte_pmd_null_crypto**) provides a crypto poll mode +The Null Crypto PMD (**librte_crypto_null**) provides a crypto poll mode driver which provides a minimal implementation for a software crypto device. As a null device it does not modify the data in the mbuf on which the crypto operation is to operate and it only has support for a single cipher and diff --git a/doc/guides/cryptodevs/scheduler.rst b/doc/guides/cryptodevs/scheduler.rst index 0b731fe8ad..835d999cfa 100644 --- a/doc/guides/cryptodevs/scheduler.rst +++ b/doc/guides/cryptodevs/scheduler.rst @@ -13,14 +13,14 @@ crypto ops among them in a certain manner. Cryptodev Scheduler Overview -The Cryptodev Scheduler PMD library (**librte_pmd_crypto_scheduler**) acts as +The Cryptodev Scheduler PMD library (**librte_crypto_scheduler**) acts as a software crypto PMD and shares the same API provided by librte_cryptodev. The PMD supports attaching multiple crypto PMDs, software or hardware, as workers, and distributes the crypto workload to them with certain behavior. The behaviors are categorizes as different "modes". Basically, a scheduling mode defines certain actions for scheduling crypto ops to its workers. -The librte_pmd_crypto_scheduler library exports a C API which provides an API +The librte_crypto_scheduler library exports a C API which provides an API for attaching/detaching workers, set/get scheduling modes, and enable/disable crypto ops reordering. diff --git a/doc/guides/cryptodevs/snow3g.rst b/doc/guides/cryptodevs/snow3g.rst index 13341c39c4..e8f9b5ff04 100644 --- a/doc/guides/cryptodevs/snow3g.rst +++ b/doc/guides/cryptodevs/snow3g.rst @@ -4,7 +4,7 @@ SNOW 3G Crypto Poll Mode Driver =============================== -The SNOW3G PMD (**librte_snow3g_zuc**) provides poll mode crypto driver support for +The SNOW3G PMD (**librte_crypto_snow3g**) provides poll mode crypto driver support for utilizing `Intel IPSec Multi-buffer library `_ which implements F8 and F8 functions for SNOW 3G UEA2 cipher and UIA2 hash algorithms. diff --git a/doc/guides/cryptodevs/zuc.rst b/doc/guides/cryptodevs/zuc.rst index 907840ef05..800d371f4b 100644 --- a/doc/guides/cryptodevs/zuc.rst +++ b/doc/guides/cryptodevs/zuc.rst @@ -4,7 +4,7 @@ ZUC Crypto Poll Mode Driver =========================== -The ZUC PMD (**librte_pmd_zuc**) provides poll mode crypto driver support for +The ZUC PMD (**librte_crypto_zuc**) provides poll mode crypto driver support for utilizing `Intel IPSec Multi-buffer library `_ which implements F8 and F9 functions for ZUC EEA3 cipher and EIA3 hash algorithms. -- 2.25.1