From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: Bruce Richardson <bruce.richardson@intel.com>,
Declan Doherty <declan.doherty@intel.com>,
Pablo de Lara <pablo.de.lara.guarch@intel.com>,
Somalapuram Amaranath <asomalap@amd.com>,
Fan Zhang <roy.fan.zhang@intel.com>,
Rosen Xu <rosen.xu@intel.com>,
Andrew Rybchenko <andrew.rybchenko@oktetlabs.ru>,
Luca Boccassi <bluca@debian.org>
Subject: [dpdk-dev] [PATCH 3/8] doc: fix driver names in crypto devices guide
Date: Mon, 2 Nov 2020 17:45:02 +0000 [thread overview]
Message-ID: <20201102174507.1085128-4-bruce.richardson@intel.com> (raw)
In-Reply-To: <20201102174507.1085128-1-bruce.richardson@intel.com>
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 <bruce.richardson@intel.com>
---
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/null.rst | 2 +-
doc/guides/cryptodevs/scheduler.rst | 4 ++--
doc/guides/cryptodevs/zuc.rst | 2 +-
7 files changed, 8 insertions(+), 8 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
<https://www.intel.com/content/dam/www/public/us/en/documents/white-papers/fast-multi-buffer-ipsec-implementations-ia-processors-paper.pdf>`_.
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 <https://github.com/01org/intel-ipsec-mb>`_
which implements F8 and F9 functions for KASUMI UEA1 cipher and UIA1 hash algorithms.
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/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 <https://github.com/01org/intel-ipsec-mb>`_
which implements F8 and F9 functions for ZUC EEA3 cipher and EIA3 hash algorithms.
--
2.25.1
next prev parent reply other threads:[~2020-11-02 17:46 UTC|newest]
Thread overview: 39+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-11-02 17:44 [dpdk-dev] [PATCH 0/8] fix driver filenames in the docs Bruce Richardson
2020-11-02 17:45 ` [dpdk-dev] [PATCH 1/8] regex/octeontx2: fix unnecessary name override Bruce Richardson
2020-11-02 19:48 ` David Marchand
2020-11-03 0:30 ` Thomas Monjalon
2020-11-03 8:19 ` David Marchand
2020-11-03 9:06 ` Thomas Monjalon
2020-11-03 9:19 ` David Marchand
2020-11-03 9:45 ` David Marchand
2020-11-03 10:27 ` Bruce Richardson
2020-11-02 17:45 ` [dpdk-dev] [PATCH 2/8] doc: fix driver names in compression devices guide Bruce Richardson
2020-11-02 19:54 ` David Marchand
2020-11-02 17:45 ` Bruce Richardson [this message]
2020-11-02 20:00 ` [dpdk-dev] [PATCH 3/8] doc: fix driver names in crypto " David Marchand
2020-11-02 20:02 ` David Marchand
2020-11-03 10:28 ` Bruce Richardson
2020-11-02 17:45 ` [dpdk-dev] [PATCH 4/8] doc: fix driver names in event " Bruce Richardson
2020-11-02 20:03 ` David Marchand
2020-11-02 17:45 ` [dpdk-dev] [PATCH 5/8] doc: fix driver names in NIC " Bruce Richardson
2020-11-02 20:17 ` David Marchand
2020-11-02 20:45 ` David Marchand
2020-11-03 2:31 ` Xu, Rosen
2020-11-03 2:47 ` Ajit Khaparde
2020-11-02 17:45 ` [dpdk-dev] [PATCH 6/8] doc: fix driver names in regex " Bruce Richardson
2020-11-02 20:07 ` David Marchand
2020-11-02 17:45 ` [dpdk-dev] [PATCH 7/8] doc: fix driver names in vDPA " Bruce Richardson
2020-11-02 20:09 ` David Marchand
2020-11-02 17:45 ` [dpdk-dev] [PATCH 8/8] doc: fix driver names in programmers guide Bruce Richardson
2020-11-02 20:12 ` David Marchand
2020-11-02 20:19 ` [dpdk-dev] [PATCH 0/8] fix driver filenames in the docs David Marchand
2020-11-03 12:36 ` [dpdk-dev] [PATCH v2 0/7] " Bruce Richardson
2020-11-03 12:36 ` [dpdk-dev] [PATCH v2 1/7] doc: fix driver names in compression devices guide Bruce Richardson
2020-11-03 12:36 ` [dpdk-dev] [PATCH v2 2/7] doc: fix driver names in crypto " Bruce Richardson
2020-11-03 13:05 ` David Marchand
2020-11-03 12:36 ` [dpdk-dev] [PATCH v2 3/7] doc: fix driver names in event " Bruce Richardson
2020-11-03 12:36 ` [dpdk-dev] [PATCH v2 4/7] doc: fix driver names in NIC " Bruce Richardson
2020-11-03 12:36 ` [dpdk-dev] [PATCH v2 5/7] doc: fix driver names in regex " Bruce Richardson
2020-11-03 12:36 ` [dpdk-dev] [PATCH v2 6/7] doc: fix driver names in vDPA " Bruce Richardson
2020-11-03 12:36 ` [dpdk-dev] [PATCH v2 7/7] doc: fix driver names in programmers guide Bruce Richardson
2020-11-03 14:50 ` [dpdk-dev] [PATCH v2 0/7] fix driver filenames in the docs David Marchand
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20201102174507.1085128-4-bruce.richardson@intel.com \
--to=bruce.richardson@intel.com \
--cc=andrew.rybchenko@oktetlabs.ru \
--cc=asomalap@amd.com \
--cc=bluca@debian.org \
--cc=declan.doherty@intel.com \
--cc=dev@dpdk.org \
--cc=pablo.de.lara.guarch@intel.com \
--cc=rosen.xu@intel.com \
--cc=roy.fan.zhang@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).