[8/8] doc: update octeontx asymmetric features
Checks
Commit Message
From: Sunila Sahu <ssahu@marvell.com>
Update documentation with supported asymmetric features for octeontx
Signed-off-by: Anoob Joseph <anoobj@marvell.com>
Signed-off-by: Kanaka Durga Kotamarthy <kkotamarthy@marvell.com>
Signed-off-by: Sunila Sahu <ssahu@marvell.com>
---
doc/guides/cryptodevs/features/octeontx.ini | 6 +++++-
doc/guides/cryptodevs/octeontx.rst | 25 +++++++++++++++++++++++++
2 files changed, 30 insertions(+), 1 deletion(-)
Comments
Hi Anoob,
>
> From: Sunila Sahu <ssahu@marvell.com>
>
> Update documentation with supported asymmetric features for octeontx
>
> Signed-off-by: Anoob Joseph <anoobj@marvell.com>
> Signed-off-by: Kanaka Durga Kotamarthy <kkotamarthy@marvell.com>
> Signed-off-by: Sunila Sahu <ssahu@marvell.com>
> ---
> doc/guides/cryptodevs/features/octeontx.ini | 6 +++++-
> doc/guides/cryptodevs/octeontx.rst | 25 +++++++++++++++++++++++++
> 2 files changed, 30 insertions(+), 1 deletion(-)
>
> diff --git a/doc/guides/cryptodevs/features/octeontx.ini
> b/doc/guides/cryptodevs/features/octeontx.ini
> index 1735b8f..1c036c5 100644
> --- a/doc/guides/cryptodevs/features/octeontx.ini
> +++ b/doc/guides/cryptodevs/features/octeontx.ini
> @@ -5,11 +5,13 @@
> ;
> [Features]
> Symmetric crypto = Y
> +Asymmetric 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
> +RSA PRIV OP KEY QT = Y
>
> ;
> ; Supported crypto algorithms of 'octeontx' crypto driver.
> @@ -64,4 +66,6 @@ AES GCM (256) = Y
> ;
> ; Supported Asymmetric algorithms of the 'octeontx' crypto driver.
> ;
> -[Asymmetric]
> \ No newline at end of file
> +[Asymmetric]
> +RSA = Y
> +Modular Exponentiation = Y
> diff --git a/doc/guides/cryptodevs/octeontx.rst
> b/doc/guides/cryptodevs/octeontx.rst
> index 1600a56..a26882b 100644
> --- a/doc/guides/cryptodevs/octeontx.rst
> +++ b/doc/guides/cryptodevs/octeontx.rst
> @@ -53,6 +53,12 @@ AEAD Algorithms
>
> * ``RTE_CRYPTO_AEAD_AES_GCM``
>
> +Asymmetric Crypto Algorithms
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Probably you should have some heading to specify Symmetric crypto Algorithms also.
> +
> +* ``RTE_CRYPTO_ASYM_XFORM_RSA``
> +* ``RTE_CRYPTO_ASYM_XFORM_MODEX``
> +
> Config flags
> ------------
>
> @@ -120,3 +126,22 @@ OCTEON TX crypto PMD.
>
> ./build/ipsec-secgw --log-level=8 -c 0xff -- -P -p 0x3 -u 0x2 --config
> "(1,0,0),(0,0,0)" -f ep1.cfg
> +
> +Testing
> +-------
> +
> +The symmetric crypto operations on OCTEON TX crypto PMD may be verified
> by running the test
> +application:
> +
> +.. code-block:: console
> +
> + ./test
> + RTE>>cryptodev_octeontx_autotest
> +
> +The asymmetric crypto operations on OCTEON TX crypto PMD may be verified
> by running the test
> +application:
> +
> +.. code-block:: console
> +
> + ./test
> + RTE>>cryptodev_octeontx_asym_autotest
> --
> 2.7.4
Hi Akhil,
Please see inline.
Thanks,
Anoob
> -----Original Message-----
> From: Akhil Goyal <akhil.goyal@nxp.com>
> Sent: Tuesday, October 1, 2019 6:58 PM
> To: Anoob Joseph <anoobj@marvell.com>; Pablo de Lara
> <pablo.de.lara.guarch@intel.com>
> Cc: Sunila Sahu <ssahu@marvell.com>; Jerin Jacob Kollanukkaran
> <jerinj@marvell.com>; Narayana Prasad Raju Athreya
> <pathreya@marvell.com>; Fiona Trahe <fiona.trahe@intel.com>; Kanaka Durga
> Kotamarthy <kkotamarthy@marvell.com>; Shally Verma
> <shallyv@marvell.com>; dev@dpdk.org
> Subject: RE: [PATCH 8/8] doc: update octeontx asymmetric features
>
> Hi Anoob,
>
> >
> > From: Sunila Sahu <ssahu@marvell.com>
> >
> > Update documentation with supported asymmetric features for octeontx
> >
> > Signed-off-by: Anoob Joseph <anoobj@marvell.com>
> > Signed-off-by: Kanaka Durga Kotamarthy <kkotamarthy@marvell.com>
> > Signed-off-by: Sunila Sahu <ssahu@marvell.com>
> > ---
> > doc/guides/cryptodevs/features/octeontx.ini | 6 +++++-
> > doc/guides/cryptodevs/octeontx.rst | 25 +++++++++++++++++++++++++
> > 2 files changed, 30 insertions(+), 1 deletion(-)
> >
> > diff --git a/doc/guides/cryptodevs/features/octeontx.ini
> > b/doc/guides/cryptodevs/features/octeontx.ini
> > index 1735b8f..1c036c5 100644
> > --- a/doc/guides/cryptodevs/features/octeontx.ini
> > +++ b/doc/guides/cryptodevs/features/octeontx.ini
> > @@ -5,11 +5,13 @@
> > ;
> > [Features]
> > Symmetric crypto = Y
> > +Asymmetric 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
> > +RSA PRIV OP KEY QT = Y
> >
> > ;
> > ; Supported crypto algorithms of 'octeontx' crypto driver.
> > @@ -64,4 +66,6 @@ AES GCM (256) = Y
> > ;
> > ; Supported Asymmetric algorithms of the 'octeontx' crypto driver.
> > ;
> > -[Asymmetric]
> > \ No newline at end of file
> > +[Asymmetric]
> > +RSA = Y
> > +Modular Exponentiation = Y
> > diff --git a/doc/guides/cryptodevs/octeontx.rst
> > b/doc/guides/cryptodevs/octeontx.rst
> > index 1600a56..a26882b 100644
> > --- a/doc/guides/cryptodevs/octeontx.rst
> > +++ b/doc/guides/cryptodevs/octeontx.rst
> > @@ -53,6 +53,12 @@ AEAD Algorithms
> >
> > * ``RTE_CRYPTO_AEAD_AES_GCM``
> >
> > +Asymmetric Crypto Algorithms
> > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>
> Probably you should have some heading to specify Symmetric crypto Algorithms
> also.
[Anoob] Do you recommend adding that change also in this patch or should I submit a separate patch for redesigning that. FYI. For crypto_octeontx2, following is the list we are adding. Do you suggest a similar change there also?
The OCTEON TX2 crypto PMD has support for:
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``
Asymmetric algorithms:
* ``RTE_CRYPTO_ASYM_XFORM_RSA``
* ``RTE_CRYPTO_ASYM_XFORM_MODEX``
>
> > +
> > +* ``RTE_CRYPTO_ASYM_XFORM_RSA``
> > +* ``RTE_CRYPTO_ASYM_XFORM_MODEX``
> > +
> > Config flags
> > ------------
> >
> > @@ -120,3 +126,22 @@ OCTEON TX crypto PMD.
> >
> > ./build/ipsec-secgw --log-level=8 -c 0xff -- -P -p 0x3 -u 0x2 --config
> > "(1,0,0),(0,0,0)" -f ep1.cfg
> > +
> > +Testing
> > +-------
> > +
> > +The symmetric crypto operations on OCTEON TX crypto PMD may be verified
> > by running the test
> > +application:
> > +
> > +.. code-block:: console
> > +
> > + ./test
> > + RTE>>cryptodev_octeontx_autotest
> > +
> > +The asymmetric crypto operations on OCTEON TX crypto PMD may be
> verified
> > by running the test
> > +application:
> > +
> > +.. code-block:: console
> > +
> > + ./test
> > + RTE>>cryptodev_octeontx_asym_autotest
> > --
> > 2.7.4
> >
> > Hi Anoob,
> >
> > >
> > > From: Sunila Sahu <ssahu@marvell.com>
> > >
> > > Update documentation with supported asymmetric features for octeontx
> > >
> > > Signed-off-by: Anoob Joseph <anoobj@marvell.com>
> > > Signed-off-by: Kanaka Durga Kotamarthy <kkotamarthy@marvell.com>
> > > Signed-off-by: Sunila Sahu <ssahu@marvell.com>
> > > ---
> > > doc/guides/cryptodevs/features/octeontx.ini | 6 +++++-
> > > doc/guides/cryptodevs/octeontx.rst | 25
> +++++++++++++++++++++++++
> > > 2 files changed, 30 insertions(+), 1 deletion(-)
> > >
> > > diff --git a/doc/guides/cryptodevs/features/octeontx.ini
> > > b/doc/guides/cryptodevs/features/octeontx.ini
> > > index 1735b8f..1c036c5 100644
> > > --- a/doc/guides/cryptodevs/features/octeontx.ini
> > > +++ b/doc/guides/cryptodevs/features/octeontx.ini
> > > @@ -5,11 +5,13 @@
> > > ;
> > > [Features]
> > > Symmetric crypto = Y
> > > +Asymmetric 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
> > > +RSA PRIV OP KEY QT = Y
> > >
> > > ;
> > > ; Supported crypto algorithms of 'octeontx' crypto driver.
> > > @@ -64,4 +66,6 @@ AES GCM (256) = Y
> > > ;
> > > ; Supported Asymmetric algorithms of the 'octeontx' crypto driver.
> > > ;
> > > -[Asymmetric]
> > > \ No newline at end of file
> > > +[Asymmetric]
> > > +RSA = Y
> > > +Modular Exponentiation = Y
> > > diff --git a/doc/guides/cryptodevs/octeontx.rst
> > > b/doc/guides/cryptodevs/octeontx.rst
> > > index 1600a56..a26882b 100644
> > > --- a/doc/guides/cryptodevs/octeontx.rst
> > > +++ b/doc/guides/cryptodevs/octeontx.rst
> > > @@ -53,6 +53,12 @@ AEAD Algorithms
> > >
> > > * ``RTE_CRYPTO_AEAD_AES_GCM``
> > >
> > > +Asymmetric Crypto Algorithms
> > > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> >
> > Probably you should have some heading to specify Symmetric crypto
> Algorithms
> > also.
>
> [Anoob] Do you recommend adding that change also in this patch or should I
> submit a separate patch for redesigning that. FYI. For crypto_octeontx2,
> following is the list we are adding. Do you suggest a similar change there also?
You can refer to qat.rst.
I believe it will not be a big change and is totally relevant in this patchset, so you can have
That in this patchset.
Yes you should do this in octeontx2 as well.
>
> The OCTEON TX2 crypto PMD has support for:
>
> 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``
>
> Asymmetric algorithms:
>
> * ``RTE_CRYPTO_ASYM_XFORM_RSA``
> * ``RTE_CRYPTO_ASYM_XFORM_MODEX``
>
> >
> > > +
> > > +* ``RTE_CRYPTO_ASYM_XFORM_RSA``
> > > +* ``RTE_CRYPTO_ASYM_XFORM_MODEX``
> > > +
> > > Config flags
> > > ------------
> > >
> > > @@ -120,3 +126,22 @@ OCTEON TX crypto PMD.
> > >
> > > ./build/ipsec-secgw --log-level=8 -c 0xff -- -P -p 0x3 -u 0x2 --config
> > > "(1,0,0),(0,0,0)" -f ep1.cfg
> > > +
> > > +Testing
> > > +-------
> > > +
> > > +The symmetric crypto operations on OCTEON TX crypto PMD may be
> verified
> > > by running the test
> > > +application:
> > > +
> > > +.. code-block:: console
> > > +
> > > + ./test
> > > + RTE>>cryptodev_octeontx_autotest
> > > +
> > > +The asymmetric crypto operations on OCTEON TX crypto PMD may be
> > verified
> > > by running the test
> > > +application:
> > > +
> > > +.. code-block:: console
> > > +
> > > + ./test
> > > + RTE>>cryptodev_octeontx_asym_autotest
> > > --
> > > 2.7.4
@@ -5,11 +5,13 @@
;
[Features]
Symmetric crypto = Y
+Asymmetric 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
+RSA PRIV OP KEY QT = Y
;
; Supported crypto algorithms of 'octeontx' crypto driver.
@@ -64,4 +66,6 @@ AES GCM (256) = Y
;
; Supported Asymmetric algorithms of the 'octeontx' crypto driver.
;
-[Asymmetric]
\ No newline at end of file
+[Asymmetric]
+RSA = Y
+Modular Exponentiation = Y
@@ -53,6 +53,12 @@ AEAD Algorithms
* ``RTE_CRYPTO_AEAD_AES_GCM``
+Asymmetric Crypto Algorithms
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+* ``RTE_CRYPTO_ASYM_XFORM_RSA``
+* ``RTE_CRYPTO_ASYM_XFORM_MODEX``
+
Config flags
------------
@@ -120,3 +126,22 @@ OCTEON TX crypto PMD.
./build/ipsec-secgw --log-level=8 -c 0xff -- -P -p 0x3 -u 0x2 --config
"(1,0,0),(0,0,0)" -f ep1.cfg
+
+Testing
+-------
+
+The symmetric crypto operations on OCTEON TX crypto PMD may be verified by running the test
+application:
+
+.. code-block:: console
+
+ ./test
+ RTE>>cryptodev_octeontx_autotest
+
+The asymmetric crypto operations on OCTEON TX crypto PMD may be verified by running the test
+application:
+
+.. code-block:: console
+
+ ./test
+ RTE>>cryptodev_octeontx_asym_autotest