[dpdk-dev] doc: fix crypto overview matrix for missing QAT items

Message ID 1488545508-8110-1-git-send-email-fiona.trahe@intel.com (mailing list archive)
State Rejected, archived
Delegated to: Pablo de Lara Guarch
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Fiona Trahe March 3, 2017, 12:51 p.m. UTC
  Support for all the following was added in release 16.11
but not updated in the matrix:
3DES, MD5_HMAC, SHA224, SHA383, NULL, KASUMI F8/F9, GMAC.

Fixes: e1b7f509e6f2 ("crypto/qat: add 3DES cipher algorithm")
Fixes: 61ec5181625f ("crypto/qat: add MD5 HMAC capability")
Fixes: ebdbe12fbfc1 ("crypto/qat: add aes-sha224-hmac capability")
Fixes: d905ee32d0dc ("crypto/qat: add aes-sha384-hmac capability")
Fixes: db0e952a5c01 ("crypto/qat: add NULL capability")
Fixes: d4f2745300e0 ("crypto/qat: add KASUMI")
Fixes: 2fa64f840d65 ("crypto/qat: add GMAC capability")

Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
---
This should also be backported to 16.11 and 17.02

 doc/guides/cryptodevs/overview.rst | 18 ++++++++++--------
 1 file changed, 10 insertions(+), 8 deletions(-)
  

Comments

Thomas Monjalon March 9, 2017, 8:20 p.m. UTC | #1
2017-03-03 12:51, Fiona Trahe:
> Support for all the following was added in release 16.11
> but not updated in the matrix:
> 3DES, MD5_HMAC, SHA224, SHA383, NULL, KASUMI F8/F9, GMAC.
> 
> Fixes: e1b7f509e6f2 ("crypto/qat: add 3DES cipher algorithm")
> Fixes: 61ec5181625f ("crypto/qat: add MD5 HMAC capability")
> Fixes: ebdbe12fbfc1 ("crypto/qat: add aes-sha224-hmac capability")
> Fixes: d905ee32d0dc ("crypto/qat: add aes-sha384-hmac capability")
> Fixes: db0e952a5c01 ("crypto/qat: add NULL capability")
> Fixes: d4f2745300e0 ("crypto/qat: add KASUMI")
> Fixes: 2fa64f840d65 ("crypto/qat: add GMAC capability")

There was already a miss for ZUC added in previous release.
It is hard to maintain such matrix...
>  
> -   "NULL",,x,,,,,,
> +   "NULL",x,x,,,,,,
>     "AES_CBC_128",x,,x,,,,,x
>     "AES_CBC_192",x,,x,,,,,
>     "AES_CBC_256",x,,x,,,,,
>     "AES_CTR_128",x,,x,,,,,
>     "AES_CTR_192",x,,x,,,,,
>     "AES_CTR_256",x,,x,,,,,
> +   "3DES_CBC",x,,,,,,,
> +   "3DES_CTR",x,,,,,,,
>     "DES_CBC",x,,,,,,,
>     "SNOW3G_UEA2",x,,,,x,,,
> -   "KASUMI_F8",,,,,,x,,
> +   "KASUMI_F8",x,,,,,x,,
>     "ZUC_EEA3",,,,,,,x,
>     "AES_DOCSISBPI",x,,,,,,,
>     "DES_DOCSISBPI",x,,,,,,,

... and even harder when it so unreadable!

Please switch to the features directory system used for networking drivers.
  
De Lara Guarch, Pablo March 22, 2017, 4:19 p.m. UTC | #2
> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Thursday, March 09, 2017 8:20 PM
> To: Trahe, Fiona; De Lara Guarch, Pablo; Jain, Deepak K
> Cc: dev@dpdk.org; Mcnamara, John
> Subject: Re: [dpdk-dev] [PATCH] doc: fix crypto overview matrix for missing
> QAT items
> 
> 2017-03-03 12:51, Fiona Trahe:
> > Support for all the following was added in release 16.11
> > but not updated in the matrix:
> > 3DES, MD5_HMAC, SHA224, SHA383, NULL, KASUMI F8/F9, GMAC.
> >
> > Fixes: e1b7f509e6f2 ("crypto/qat: add 3DES cipher algorithm")
> > Fixes: 61ec5181625f ("crypto/qat: add MD5 HMAC capability")
> > Fixes: ebdbe12fbfc1 ("crypto/qat: add aes-sha224-hmac capability")
> > Fixes: d905ee32d0dc ("crypto/qat: add aes-sha384-hmac capability")
> > Fixes: db0e952a5c01 ("crypto/qat: add NULL capability")
> > Fixes: d4f2745300e0 ("crypto/qat: add KASUMI")
> > Fixes: 2fa64f840d65 ("crypto/qat: add GMAC capability")
> 
> There was already a miss for ZUC added in previous release.
> It is hard to maintain such matrix...
> >
> > -   "NULL",,x,,,,,,
> > +   "NULL",x,x,,,,,,
> >     "AES_CBC_128",x,,x,,,,,x
> >     "AES_CBC_192",x,,x,,,,,
> >     "AES_CBC_256",x,,x,,,,,
> >     "AES_CTR_128",x,,x,,,,,
> >     "AES_CTR_192",x,,x,,,,,
> >     "AES_CTR_256",x,,x,,,,,
> > +   "3DES_CBC",x,,,,,,,
> > +   "3DES_CTR",x,,,,,,,
> >     "DES_CBC",x,,,,,,,
> >     "SNOW3G_UEA2",x,,,,x,,,
> > -   "KASUMI_F8",,,,,,x,,
> > +   "KASUMI_F8",x,,,,,x,,
> >     "ZUC_EEA3",,,,,,,x,
> >     "AES_DOCSISBPI",x,,,,,,,
> >     "DES_DOCSISBPI",x,,,,,,,
> 
> ... and even harder when it so unreadable!
> 
> Please switch to the features directory system used for networking drivers.

I have sent a patch that reformat this file, following the same system as the one used for the networking drivers.
Fiona, could you verify if qat.ini file is OK?

Thanks,
Pablo
  

Patch

diff --git a/doc/guides/cryptodevs/overview.rst b/doc/guides/cryptodevs/overview.rst
index 7dda404..fbec6a9 100644
--- a/doc/guides/cryptodevs/overview.rst
+++ b/doc/guides/cryptodevs/overview.rst
@@ -54,16 +54,18 @@  Supported Cipher Algorithms
    :header: "Cipher Algorithms", "qat", "null", "aesni_mb", "aesni_gcm", "snow3g", "kasumi", "zuc", "armv8"
    :stub-columns: 1
 
-   "NULL",,x,,,,,,
+   "NULL",x,x,,,,,,
    "AES_CBC_128",x,,x,,,,,x
    "AES_CBC_192",x,,x,,,,,
    "AES_CBC_256",x,,x,,,,,
    "AES_CTR_128",x,,x,,,,,
    "AES_CTR_192",x,,x,,,,,
    "AES_CTR_256",x,,x,,,,,
+   "3DES_CBC",x,,,,,,,
+   "3DES_CTR",x,,,,,,,
    "DES_CBC",x,,,,,,,
    "SNOW3G_UEA2",x,,,,x,,,
-   "KASUMI_F8",,,,,,x,,
+   "KASUMI_F8",x,,,,,x,,
    "ZUC_EEA3",,,,,,,x,
    "AES_DOCSISBPI",x,,,,,,,
    "DES_DOCSISBPI",x,,,,,,,
@@ -74,23 +76,23 @@  Supported Authentication Algorithms
    :header: "Cipher Algorithms", "qat", "null", "aesni_mb", "aesni_gcm", "snow3g", "kasumi", "zuc", "armv8"
    :stub-columns: 1
 
-   "NONE",,x,,,,,,
+   "NULL",x,x,,,,,,
    "MD5",,,,,,,,
-   "MD5_HMAC",,,x,,,,,
+   "MD5_HMAC",x,,x,,,,,
    "SHA1",,,,,,,,
    "SHA1_HMAC",x,,x,,,,,x
    "SHA224",,,,,,,,
-   "SHA224_HMAC",,,x,,,,,
+   "SHA224_HMAC",x,,x,,,,,
    "SHA256",,,,,,,,
    "SHA256_HMAC",x,,x,,,,,x
    "SHA384",,,,,,,,
-   "SHA384_HMAC",,,x,,,,,
+   "SHA384_HMAC",x,,x,,,,,
    "SHA512",,,,,,,,
    "SHA512_HMAC",x,,x,,,,,
    "AES_XCBC",x,,x,,,,,
-   "AES_GMAC",,,,x,,,,
+   "AES_GMAC",x,,,x,,,,
    "SNOW3G_UIA2",x,,,,x,,,
-   "KASUMI_F9",,,,,,x,,
+   "KASUMI_F9",x,,,,,x,,
    "ZUC_EIA3",,,,,,,x,
 
 Supported AEAD Algorithms