diff mbox series

doc/crypto: fix missing asymmetric algo table

Message ID 1554287900-28149-1-git-send-email-fiona.trahe@intel.com (mailing list archive)
State Accepted, archived
Delegated to: akhil goyal
Headers
Series doc/crypto: fix missing asymmetric algo table |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/mellanox-Performance-Testing success Performance Testing PASS
ci/intel-Performance-Testing success Performance Testing PASS

Commit Message

Fiona Trahe April 3, 2019, 10:38 a.m. UTC 
  Fixes: 11e5ba72cf67 ("doc: add crypto asymmetric feature list")
cc: stable@dpdk.org

Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
---
 .gitignore                                   | 1 +
 doc/guides/conf.py                           | 5 +++++
 doc/guides/cryptodevs/features/aesni_gcm.ini | 5 +++++
 doc/guides/cryptodevs/features/aesni_mb.ini  | 5 +++++
 doc/guides/cryptodevs/features/armv8.ini     | 5 +++++
 doc/guides/cryptodevs/features/caam_jr.ini   | 5 +++++
 doc/guides/cryptodevs/features/ccp.ini       | 5 +++++
 doc/guides/cryptodevs/features/default.ini   | 9 +++++++++
 doc/guides/cryptodevs/features/dpaa2_sec.ini | 5 +++++
 doc/guides/cryptodevs/features/dpaa_sec.ini  | 5 +++++
 doc/guides/cryptodevs/features/kasumi.ini    | 5 +++++
 doc/guides/cryptodevs/features/mvsam.ini     | 5 +++++
 doc/guides/cryptodevs/features/null.ini      | 5 +++++
 doc/guides/cryptodevs/features/octeontx.ini  | 5 +++++
 doc/guides/cryptodevs/features/qat.ini       | 5 +++++
 doc/guides/cryptodevs/features/snow3g.ini    | 5 +++++
 doc/guides/cryptodevs/features/virtio.ini    | 5 +++++
 doc/guides/cryptodevs/features/zuc.ini       | 5 +++++
 doc/guides/cryptodevs/openssl.rst            | 8 ++++++++
 doc/guides/cryptodevs/overview.rst           | 7 +++++++
 20 files changed, 105 insertions(+)

Comments

Akhil Goyal April 3, 2019, 11 a.m. UTC | #1 
Hi Fiona,

On 4/3/2019 4:08 PM, Fiona Trahe wrote:
> Fixes: 11e5ba72cf67 ("doc: add crypto asymmetric feature list")
> cc: stable@dpdk.org
>
> Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
> ---
>   .gitignore                                   | 1 +
>   doc/guides/conf.py                           | 5 +++++
>   doc/guides/cryptodevs/features/aesni_gcm.ini | 5 +++++
>   doc/guides/cryptodevs/features/aesni_mb.ini  | 5 +++++
>   doc/guides/cryptodevs/features/armv8.ini     | 5 +++++
>   doc/guides/cryptodevs/features/caam_jr.ini   | 5 +++++
>   doc/guides/cryptodevs/features/ccp.ini       | 5 +++++
>   doc/guides/cryptodevs/features/default.ini   | 9 +++++++++
>   doc/guides/cryptodevs/features/dpaa2_sec.ini | 5 +++++
>   doc/guides/cryptodevs/features/dpaa_sec.ini  | 5 +++++
>   doc/guides/cryptodevs/features/kasumi.ini    | 5 +++++
>   doc/guides/cryptodevs/features/mvsam.ini     | 5 +++++
>   doc/guides/cryptodevs/features/null.ini      | 5 +++++
>   doc/guides/cryptodevs/features/octeontx.ini  | 5 +++++
>   doc/guides/cryptodevs/features/qat.ini       | 5 +++++
I believe qat need to be updated with the supported asym features.
>   doc/guides/cryptodevs/features/snow3g.ini    | 5 +++++
>   doc/guides/cryptodevs/features/virtio.ini    | 5 +++++
>   doc/guides/cryptodevs/features/zuc.ini       | 5 +++++
>   doc/guides/cryptodevs/openssl.rst            | 8 ++++++++
>   doc/guides/cryptodevs/overview.rst           | 7 +++++++
>   20 files changed, 105 insertions(+)
>
>
rest of the patch looks good.

-Akhil
Fiona Trahe April 3, 2019, 11:11 a.m. UTC | #2 
Hi Akhil,

//snip///
> >   doc/guides/cryptodevs/features/qat.ini       | 5 +++++
> I believe qat need to be updated with the supported asym features.
This patch is a fix and should be applied back to stable.
We'll send a separate QAT patch as that will only apply to 19.05

Fiona
Akhil Goyal April 3, 2019, 11:58 a.m. UTC | #3 
On 4/3/2019 4:41 PM, Trahe, Fiona wrote:
> Hi Akhil,
>
> //snip///
>>>    doc/guides/cryptodevs/features/qat.ini       | 5 +++++
>> I believe qat need to be updated with the supported asym features.
> This patch is a fix and should be applied back to stable.
> We'll send a separate QAT patch as that will only apply to 19.05
>
> Fiona
>
yes, agreed. You can send a 2/2 for this patch with qat.
Akhil Goyal April 16, 2019, 1:53 p.m. UTC | #4 
> Hi Fiona,
> 
> On 4/3/2019 4:08 PM, Fiona Trahe wrote:
> > Fixes: 11e5ba72cf67 ("doc: add crypto asymmetric feature list")
> > cc: stable@dpdk.org
> >
> > Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
> > ---
> >   .gitignore                                   | 1 +
> >   doc/guides/conf.py                           | 5 +++++
> >   doc/guides/cryptodevs/features/aesni_gcm.ini | 5 +++++
> >   doc/guides/cryptodevs/features/aesni_mb.ini  | 5 +++++
> >   doc/guides/cryptodevs/features/armv8.ini     | 5 +++++
> >   doc/guides/cryptodevs/features/caam_jr.ini   | 5 +++++
> >   doc/guides/cryptodevs/features/ccp.ini       | 5 +++++
> >   doc/guides/cryptodevs/features/default.ini   | 9 +++++++++
> >   doc/guides/cryptodevs/features/dpaa2_sec.ini | 5 +++++
> >   doc/guides/cryptodevs/features/dpaa_sec.ini  | 5 +++++
> >   doc/guides/cryptodevs/features/kasumi.ini    | 5 +++++
> >   doc/guides/cryptodevs/features/mvsam.ini     | 5 +++++
> >   doc/guides/cryptodevs/features/null.ini      | 5 +++++
> >   doc/guides/cryptodevs/features/octeontx.ini  | 5 +++++
> >   doc/guides/cryptodevs/features/qat.ini       | 5 +++++
> I believe qat need to be updated with the supported asym features.
> >   doc/guides/cryptodevs/features/snow3g.ini    | 5 +++++
> >   doc/guides/cryptodevs/features/virtio.ini    | 5 +++++
> >   doc/guides/cryptodevs/features/zuc.ini       | 5 +++++
> >   doc/guides/cryptodevs/openssl.rst            | 8 ++++++++
> >   doc/guides/cryptodevs/overview.rst           | 7 +++++++
> >   20 files changed, 105 insertions(+)
> >
> >
> rest of the patch looks good.
> 
> -Akhil

Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
Akhil Goyal April 16, 2019, 2:57 p.m. UTC | #5 
> > On 4/3/2019 4:08 PM, Fiona Trahe wrote:
> > > Fixes: 11e5ba72cf67 ("doc: add crypto asymmetric feature list")
> > > cc: stable@dpdk.org
> > >
> > > Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
> > > ---
> > >   .gitignore                                   | 1 +
> > >   doc/guides/conf.py                           | 5 +++++
> > >   doc/guides/cryptodevs/features/aesni_gcm.ini | 5 +++++
> > >   doc/guides/cryptodevs/features/aesni_mb.ini  | 5 +++++
> > >   doc/guides/cryptodevs/features/armv8.ini     | 5 +++++
> > >   doc/guides/cryptodevs/features/caam_jr.ini   | 5 +++++
> > >   doc/guides/cryptodevs/features/ccp.ini       | 5 +++++
> > >   doc/guides/cryptodevs/features/default.ini   | 9 +++++++++
> > >   doc/guides/cryptodevs/features/dpaa2_sec.ini | 5 +++++
> > >   doc/guides/cryptodevs/features/dpaa_sec.ini  | 5 +++++
> > >   doc/guides/cryptodevs/features/kasumi.ini    | 5 +++++
> > >   doc/guides/cryptodevs/features/mvsam.ini     | 5 +++++
> > >   doc/guides/cryptodevs/features/null.ini      | 5 +++++
> > >   doc/guides/cryptodevs/features/octeontx.ini  | 5 +++++
> > >   doc/guides/cryptodevs/features/qat.ini       | 5 +++++
> > I believe qat need to be updated with the supported asym features.
> > >   doc/guides/cryptodevs/features/snow3g.ini    | 5 +++++
> > >   doc/guides/cryptodevs/features/virtio.ini    | 5 +++++
> > >   doc/guides/cryptodevs/features/zuc.ini       | 5 +++++
> > >   doc/guides/cryptodevs/openssl.rst            | 8 ++++++++
> > >   doc/guides/cryptodevs/overview.rst           | 7 +++++++
> > >   20 files changed, 105 insertions(+)
> > >
> > >
> > rest of the patch looks good.
> >
> > -Akhil
> 
> Acked-by: Akhil Goyal <akhil.goyal@nxp.com>

Applied to dpdk-next-crypto

Thanks.
diff mbox series

Patch

diff --git a/.gitignore b/.gitignore
index b830c33f7..5eda2c31e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -7,6 +7,7 @@  doc/guides/cryptodevs/overview_feature_table.txt
 doc/guides/cryptodevs/overview_cipher_table.txt
 doc/guides/cryptodevs/overview_auth_table.txt
 doc/guides/cryptodevs/overview_aead_table.txt
+doc/guides/cryptodevs/overview_asym_table.txt
 doc/guides/compressdevs/overview_feature_table.txt
 
 # ignore generated ctags/cscope files
diff --git a/doc/guides/conf.py b/doc/guides/conf.py
index da99a3f84..a85f6c9d9 100644
--- a/doc/guides/conf.py
+++ b/doc/guides/conf.py
@@ -391,6 +391,11 @@  def setup(app):
                             'AEAD',
                             'AEAD algorithms in crypto drivers',
                             'AEAD algorithm')
+    table_file = dirname(__file__) + '/cryptodevs/overview_asym_table.txt'
+    generate_overview_table(table_file, 5,
+                            'Asymmetric',
+                            'Asymmetric algorithms in crypto drivers',
+                            'Asymmetric algorithm')
     table_file = dirname(__file__) + '/compressdevs/overview_feature_table.txt'
     generate_overview_table(table_file, 1,
                             'Features',
diff --git a/doc/guides/cryptodevs/features/aesni_gcm.ini b/doc/guides/cryptodevs/features/aesni_gcm.ini
index b9e9c9060..fdd3df690 100644
--- a/doc/guides/cryptodevs/features/aesni_gcm.ini
+++ b/doc/guides/cryptodevs/features/aesni_gcm.ini
@@ -30,3 +30,8 @@  AES GMAC = Y
 AES GCM (128) = Y
 AES GCM (192) = Y
 AES GCM (256) = Y
+
+;
+; Supported Asymmetric algorithms of the 'aesni_gcm' crypto driver.
+;
+[Asymmetric]
\ No newline at end of file
diff --git a/doc/guides/cryptodevs/features/aesni_mb.ini b/doc/guides/cryptodevs/features/aesni_mb.ini
index 93a534f19..9d1dd36c8 100644
--- a/doc/guides/cryptodevs/features/aesni_mb.ini
+++ b/doc/guides/cryptodevs/features/aesni_mb.ini
@@ -46,3 +46,8 @@  AES CMAC (128)  = Y
 ;
 [AEAD]
 AES CCM (128) = Y
+
+;
+; Supported Asymmetric algorithms of the 'aesni_mb' crypto driver.
+;
+[Asymmetric]
\ No newline at end of file
diff --git a/doc/guides/cryptodevs/features/armv8.ini b/doc/guides/cryptodevs/features/armv8.ini
index 1e1047714..e588f9021 100644
--- a/doc/guides/cryptodevs/features/armv8.ini
+++ b/doc/guides/cryptodevs/features/armv8.ini
@@ -26,3 +26,8 @@  SHA256 HMAC  = Y
 ; Supported AEAD algorithms of the 'armv8' crypto driver.
 ;
 [AEAD]
+
+;
+; Supported Asymmetric algorithms of the 'armv8' crypto driver.
+;
+[Asymmetric]
diff --git a/doc/guides/cryptodevs/features/caam_jr.ini b/doc/guides/cryptodevs/features/caam_jr.ini
index 68f8d8195..c64bd35da 100644
--- a/doc/guides/cryptodevs/features/caam_jr.ini
+++ b/doc/guides/cryptodevs/features/caam_jr.ini
@@ -44,3 +44,8 @@  SHA512 HMAC  = Y
 AES GCM (128) = Y
 AES GCM (192) = Y
 AES GCM (256) = Y
+
+;
+; Supported Asymmetric algorithms of the 'dpaa2_sec' crypto driver.
+;
+[Asymmetric]
\ No newline at end of file
diff --git a/doc/guides/cryptodevs/features/ccp.ini b/doc/guides/cryptodevs/features/ccp.ini
index 4722e135d..2970076b8 100644
--- a/doc/guides/cryptodevs/features/ccp.ini
+++ b/doc/guides/cryptodevs/features/ccp.ini
@@ -57,3 +57,8 @@  SHA3_512 HMAC   = Y
 AES GCM (128) = Y
 AES GCM (192) = Y
 AES GCM (256) = Y
+
+;
+; Supported Asymmetric algorithms of the 'ccp' crypto driver.
+;
+[Asymmetric]
\ No newline at end of file
diff --git a/doc/guides/cryptodevs/features/default.ini b/doc/guides/cryptodevs/features/default.ini
index 5f3ed3049..0e06261a5 100644
--- a/doc/guides/cryptodevs/features/default.ini
+++ b/doc/guides/cryptodevs/features/default.ini
@@ -97,3 +97,12 @@  AES GCM (256) =
 AES CCM (128) =
 AES CCM (192) =
 AES CCM (256) =
+;
+; Supported Asymmetric algorithms of a default crypto driver.
+;
+[Asymmetric]
+RSA =
+DSA =
+Modular Exponentiation =
+Modular Inversion =
+Diffie-hellman =
\ No newline at end of file
diff --git a/doc/guides/cryptodevs/features/dpaa2_sec.ini b/doc/guides/cryptodevs/features/dpaa2_sec.ini
index 69700df40..9f4e4029c 100644
--- a/doc/guides/cryptodevs/features/dpaa2_sec.ini
+++ b/doc/guides/cryptodevs/features/dpaa2_sec.ini
@@ -44,3 +44,8 @@  SHA512 HMAC  = Y
 AES GCM (128) = Y
 AES GCM (192) = Y
 AES GCM (256) = Y
+
+;
+; Supported Asymmetric algorithms of the 'dpaa2_sec' crypto driver.
+;
+[Asymmetric]
\ No newline at end of file
diff --git a/doc/guides/cryptodevs/features/dpaa_sec.ini b/doc/guides/cryptodevs/features/dpaa_sec.ini
index 937b621c0..954a70808 100644
--- a/doc/guides/cryptodevs/features/dpaa_sec.ini
+++ b/doc/guides/cryptodevs/features/dpaa_sec.ini
@@ -44,3 +44,8 @@  SHA512 HMAC  = Y
 AES GCM (128) = Y
 AES GCM (192) = Y
 AES GCM (256) = Y
+
+;
+; Supported Asymmetric algorithms of the 'dpaa_sec' crypto driver.
+;
+[Asymmetric]
\ No newline at end of file
diff --git a/doc/guides/cryptodevs/features/kasumi.ini b/doc/guides/cryptodevs/features/kasumi.ini
index 0e138f5a6..f3d061009 100644
--- a/doc/guides/cryptodevs/features/kasumi.ini
+++ b/doc/guides/cryptodevs/features/kasumi.ini
@@ -22,3 +22,8 @@  KASUMI F9 = Y
 ; Supported AEAD algorithms of the 'kasumi' crypto driver.
 ;
 [AEAD]
+
+;
+; Supported Asymmetric algorithms of the 'kasumi' crypto driver.
+;
+[Asymmetric]
\ No newline at end of file
diff --git a/doc/guides/cryptodevs/features/mvsam.ini b/doc/guides/cryptodevs/features/mvsam.ini
index 0cc90a53d..829deff68 100644
--- a/doc/guides/cryptodevs/features/mvsam.ini
+++ b/doc/guides/cryptodevs/features/mvsam.ini
@@ -52,3 +52,8 @@  AES GMAC     = Y
 AES GCM (128) = Y
 AES GCM (192) = Y
 AES GCM (256) = Y
+
+;
+; Supported Asymmetric algorithms of the 'mvsam' crypto driver.
+;
+[Asymmetric]
\ No newline at end of file
diff --git a/doc/guides/cryptodevs/features/null.ini b/doc/guides/cryptodevs/features/null.ini
index ecf5779ac..a1c3e22a3 100644
--- a/doc/guides/cryptodevs/features/null.ini
+++ b/doc/guides/cryptodevs/features/null.ini
@@ -24,3 +24,8 @@  NULL = Y
 ; Supported AEAD algorithms of the 'null' crypto driver.
 ;
 [AEAD]
+
+;
+; Supported Asymmetric algorithms of the 'null' crypto driver.
+;
+[Asymmetric]
\ No newline at end of file
diff --git a/doc/guides/cryptodevs/features/octeontx.ini b/doc/guides/cryptodevs/features/octeontx.ini
index 307ab88cc..1735b8f5a 100644
--- a/doc/guides/cryptodevs/features/octeontx.ini
+++ b/doc/guides/cryptodevs/features/octeontx.ini
@@ -60,3 +60,8 @@  ZUC EIA3     = Y
 AES GCM (128) = Y
 AES GCM (192) = Y
 AES GCM (256) = Y
+
+;
+; Supported Asymmetric algorithms of the 'octeontx' crypto driver.
+;
+[Asymmetric]
\ No newline at end of file
diff --git a/doc/guides/cryptodevs/features/qat.ini b/doc/guides/cryptodevs/features/qat.ini
index a7c727344..81325801e 100644
--- a/doc/guides/cryptodevs/features/qat.ini
+++ b/doc/guides/cryptodevs/features/qat.ini
@@ -62,3 +62,8 @@  AES GCM (256) = Y
 AES CCM (128) = Y
 AES CCM (192) = Y
 AES CCM (256) = Y
+
+;
+; Supported Asymmetric algorithms of the 'qat' crypto driver.
+;
+[Asymmetric]
diff --git a/doc/guides/cryptodevs/features/snow3g.ini b/doc/guides/cryptodevs/features/snow3g.ini
index 277136177..ec2daf6c6 100644
--- a/doc/guides/cryptodevs/features/snow3g.ini
+++ b/doc/guides/cryptodevs/features/snow3g.ini
@@ -22,3 +22,8 @@  SNOW3G UIA2 = Y
 ; Supported AEAD algorithms of the 'snow3g' crypto driver.
 ;
 [AEAD]
+
+;
+; Supported Asymmetric algorithms of the 'snow3g' crypto driver.
+;
+[Asymmetric]
\ No newline at end of file
diff --git a/doc/guides/cryptodevs/features/virtio.ini b/doc/guides/cryptodevs/features/virtio.ini
index 168fc174c..b59f1669b 100644
--- a/doc/guides/cryptodevs/features/virtio.ini
+++ b/doc/guides/cryptodevs/features/virtio.ini
@@ -24,3 +24,8 @@  SHA1 HMAC      = Y
 ; Supported AEAD algorithms of the 'virtio' crypto driver.
 ;
 [AEAD]
+
+;
+; Supported Asymmetric algorithms of the 'virtio' crypto driver.
+;
+[Asymmetric]
diff --git a/doc/guides/cryptodevs/features/zuc.ini b/doc/guides/cryptodevs/features/zuc.ini
index 5bb02afd4..9b6a4287e 100644
--- a/doc/guides/cryptodevs/features/zuc.ini
+++ b/doc/guides/cryptodevs/features/zuc.ini
@@ -22,3 +22,8 @@  ZUC EIA3 = Y
 ; Supported AEAD algorithms of the 'zuc' crypto driver.
 ;
 [AEAD]
+
+;
+; Supported Asymmetric algorithms of the 'zuc' crypto driver.
+;
+[Asymmetric]
diff --git a/doc/guides/cryptodevs/openssl.rst b/doc/guides/cryptodevs/openssl.rst
index 89aa5bac4..d7269870b 100644
--- a/doc/guides/cryptodevs/openssl.rst
+++ b/doc/guides/cryptodevs/openssl.rst
@@ -46,6 +46,14 @@  Supported AEAD algorithms:
 * ``RTE_CRYPTO_AEAD_AES_GCM``
 * ``RTE_CRYPTO_AEAD_AES_CCM``
 
+Supported Asymmetric Crypto algorithms:
+
+* ``RTE_CRYPTO_ASYM_XFORM_RSA``
+* ``RTE_CRYPTO_ASYM_XFORM_DSA``
+* ``RTE_CRYPTO_ASYM_XFORM_DH``
+* ``RTE_CRYPTO_ASYM_XFORM_MODINV``
+* ``RTE_CRYPTO_ASYM_XFORM_MODEX``
+
 
 Installation
 ------------
diff --git a/doc/guides/cryptodevs/overview.rst b/doc/guides/cryptodevs/overview.rst
index d7b7141a9..12f342b0f 100644
--- a/doc/guides/cryptodevs/overview.rst
+++ b/doc/guides/cryptodevs/overview.rst
@@ -64,3 +64,10 @@  Supported AEAD Algorithms
 .. _table_crypto_pmd_aead_algos:
 
 .. include:: overview_aead_table.txt
+
+Supported Asymmetric Algorithms
+-------------------------------
+
+.. _table_crypto_pmd_asym_algos:
+
+.. include:: overview_asym_table.txt