[6/6] doc: add documentation for OCTEON TX2 crypto asym support

Message ID 1568042799-25982-7-git-send-email-anoobj@marvell.com
State New
Delegated to: akhil goyal
Headers show
Series
  • add asymmetric support in crypto_octeontx2 PMD
Related show

Checks

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

Commit Message

Anoob Joseph Sept. 9, 2019, 3:26 p.m.
Adding documentation for asymmetric features supported by
crypto_octeontx2 PMD.

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/octeontx2.ini |  9 +++++++++
 doc/guides/cryptodevs/octeontx2.rst          | 13 +++++++++++++
 2 files changed, 22 insertions(+)

Comments

Jerin Jacob Kollanukkaran Sept. 10, 2019, 4:13 a.m. | #1
> -----Original Message-----
> From: Anoob Joseph <anoobj@marvell.com>
> Sent: Monday, September 9, 2019 8:57 PM
> To: Akhil Goyal <akhil.goyal@nxp.com>; Pablo de Lara
> <pablo.de.lara.guarch@intel.com>; Thomas Monjalon
> <thomas@monjalon.net>
> Cc: Anoob Joseph <anoobj@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>; Sunila Sahu <ssahu@marvell.com>; dev@dpdk.org
> Subject: [PATCH 6/6] doc: add documentation for OCTEON TX2 crypto asym
> support
> 
> Adding documentation for asymmetric features supported by
> crypto_octeontx2 PMD.
> 
> 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/octeontx2.ini |  9 +++++++++
>  doc/guides/cryptodevs/octeontx2.rst          | 13 +++++++++++++

Please update the release notes.
Anoob Joseph Sept. 10, 2019, 6:12 a.m. | #2
Hi Jerin,

Please see inline.

Thanks,
Anoob

> -----Original Message-----
> From: Jerin Jacob Kollanukkaran <jerinj@marvell.com>
> Sent: Tuesday, September 10, 2019 9:43 AM
> To: Anoob Joseph <anoobj@marvell.com>; Akhil Goyal
> <akhil.goyal@nxp.com>; Pablo de Lara <pablo.de.lara.guarch@intel.com>;
> Thomas Monjalon <thomas@monjalon.net>
> Cc: Anoob Joseph <anoobj@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>; Sunila Sahu <ssahu@marvell.com>; dev@dpdk.org
> Subject: RE: [PATCH 6/6] doc: add documentation for OCTEON TX2 crypto
> asym support
> 
> > -----Original Message-----
> > From: Anoob Joseph <anoobj@marvell.com>
> > Sent: Monday, September 9, 2019 8:57 PM
> > To: Akhil Goyal <akhil.goyal@nxp.com>; Pablo de Lara
> > <pablo.de.lara.guarch@intel.com>; Thomas Monjalon
> > <thomas@monjalon.net>
> > Cc: Anoob Joseph <anoobj@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>; Sunila Sahu <ssahu@marvell.com>;
> dev@dpdk.org
> > Subject: [PATCH 6/6] doc: add documentation for OCTEON TX2 crypto asym
> > support
> >
> > Adding documentation for asymmetric features supported by
> > crypto_octeontx2 PMD.
> >
> > 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/octeontx2.ini |  9 +++++++++
> >  doc/guides/cryptodevs/octeontx2.rst          | 13 +++++++++++++
> 
> Please update the release notes.

[Anoob] Will update in  v2.
Thomas Monjalon Sept. 10, 2019, 6:30 a.m. | #3
10/09/2019 06:13, Jerin Jacob Kollanukkaran:
> From: Anoob Joseph <anoobj@marvell.com>
> > Adding documentation for asymmetric features supported by
> > crypto_octeontx2 PMD.
> > 
> > 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/octeontx2.ini |  9 +++++++++
> >  doc/guides/cryptodevs/octeontx2.rst          | 13 +++++++++++++
> 
> Please update the release notes.

Please avoid doing a separate patch for documentation.
It could be updated while adding the feature, in the same patch.
Anoob Joseph Sept. 10, 2019, 11:33 a.m. | #4
Hi Thomas,

Please see inline.

Thanks,
Anoob

> -----Original Message-----
> From: Thomas Monjalon <thomas@monjalon.net>
> Sent: Tuesday, September 10, 2019 12:00 PM
> To: Jerin Jacob Kollanukkaran <jerinj@marvell.com>; Anoob Joseph
> <anoobj@marvell.com>
> Cc: Akhil Goyal <akhil.goyal@nxp.com>; Pablo de Lara
> <pablo.de.lara.guarch@intel.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>; Sunila Sahu <ssahu@marvell.com>; dev@dpdk.org
> Subject: Re: [PATCH 6/6] doc: add documentation for OCTEON TX2 crypto
> asym support
> 
> 10/09/2019 06:13, Jerin Jacob Kollanukkaran:
> > From: Anoob Joseph <anoobj@marvell.com>
> > > Adding documentation for asymmetric features supported by
> > > crypto_octeontx2 PMD.
> > >
> > > 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/octeontx2.ini |  9 +++++++++
> > >  doc/guides/cryptodevs/octeontx2.rst          | 13 +++++++++++++
> >
> > Please update the release notes.
> 
> Please avoid doing a separate patch for documentation.
> It could be updated while adding the feature, in the same patch.

[Anoob] To which patch should I squash this change? Here are my options,

1. The patch which adds ASYM in capabilities. Issue: the doc update updates about autotest, which won't be available until the final patch is merged.
2. Test patch which adds the autotest for the PMD. Issue: Additions to the doc would be done by a patch which adds test.

Which one should I use?
Akhil Goyal Sept. 10, 2019, 11:39 a.m. | #5
Hi Anoob,

> 
> Hi Thomas,
> 
> Please see inline.
> 
> Thanks,
> Anoob
> 
> > -----Original Message-----
> > From: Thomas Monjalon <thomas@monjalon.net>
> > Sent: Tuesday, September 10, 2019 12:00 PM
> > To: Jerin Jacob Kollanukkaran <jerinj@marvell.com>; Anoob Joseph
> > <anoobj@marvell.com>
> > Cc: Akhil Goyal <akhil.goyal@nxp.com>; Pablo de Lara
> > <pablo.de.lara.guarch@intel.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>; Sunila Sahu <ssahu@marvell.com>; dev@dpdk.org
> > Subject: Re: [PATCH 6/6] doc: add documentation for OCTEON TX2 crypto
> > asym support
> >
> > 10/09/2019 06:13, Jerin Jacob Kollanukkaran:
> > > From: Anoob Joseph <anoobj@marvell.com>
> > > > Adding documentation for asymmetric features supported by
> > > > crypto_octeontx2 PMD.
> > > >
> > > > 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/octeontx2.ini |  9 +++++++++
> > > >  doc/guides/cryptodevs/octeontx2.rst          | 13 +++++++++++++
> > >
> > > Please update the release notes.
> >
> > Please avoid doing a separate patch for documentation.
> > It could be updated while adding the feature, in the same patch.
> 
> [Anoob] To which patch should I squash this change? Here are my options,
> 
> 1. The patch which adds ASYM in capabilities. Issue: the doc update updates
> about autotest, which won't be available until the final patch is merged.
> 2. Test patch which adds the autotest for the PMD. Issue: Additions to the doc
> would be done by a patch which adds test.
> 
> Which one should I use?

As per the convention followed these days, documentation should be the part of the
Patch which support it.
If you have supported many features in your patchset, you should add that piece
of documentation which is supported in each of the patches in the patchset.

Release notes should be added in the patch which completes the whole feature.

-Akhil
Thomas Monjalon Sept. 10, 2019, 11:41 a.m. | #6
10/09/2019 13:33, Anoob Joseph:
> From: Thomas Monjalon <thomas@monjalon.net>
> > 10/09/2019 06:13, Jerin Jacob Kollanukkaran:
> > > From: Anoob Joseph <anoobj@marvell.com>
> > > > Adding documentation for asymmetric features supported by
> > > > crypto_octeontx2 PMD.
> > > >
> > > > 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/octeontx2.ini |  9 +++++++++
> > > >  doc/guides/cryptodevs/octeontx2.rst          | 13 +++++++++++++
> > >
> > > Please update the release notes.
> > 
> > Please avoid doing a separate patch for documentation.
> > It could be updated while adding the feature, in the same patch.
> 
> [Anoob] To which patch should I squash this change? Here are my options,
> 
> 1. The patch which adds ASYM in capabilities. Issue: the doc update updates about autotest, which won't be available until the final patch is merged.
> 2. Test patch which adds the autotest for the PMD. Issue: Additions to the doc would be done by a patch which adds test.
> 
> Which one should I use?

You should split the doc patch and squash in both relevant patches.
This is exactly why I prefer to have doc squashed:
When I will look at the autotest patch, I will find the doc for this test.
Same for the feature patch.
It is also better for git history: if you git blame on doc, you will find
the commit implementing what is documented.

Thanks
Anoob Joseph Sept. 10, 2019, 12:23 p.m. | #7
Hi Akhil,

> -----Original Message-----
> From: Akhil Goyal <akhil.goyal@nxp.com>
> Sent: Tuesday, September 10, 2019 5:10 PM
> To: Anoob Joseph <anoobj@marvell.com>; Thomas Monjalon
> <thomas@monjalon.net>; Jerin Jacob Kollanukkaran <jerinj@marvell.com>
> Cc: Pablo de Lara <pablo.de.lara.guarch@intel.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>; Sunila Sahu <ssahu@marvell.com>; dev@dpdk.org
> Subject: RE: [PATCH 6/6] doc: add documentation for OCTEON TX2 crypto
> asym support
> 
> Hi Anoob,
> 
> >
> > Hi Thomas,
> >
> > Please see inline.
> >
> > Thanks,
> > Anoob
> >
> > > -----Original Message-----
> > > From: Thomas Monjalon <thomas@monjalon.net>
> > > Sent: Tuesday, September 10, 2019 12:00 PM
> > > To: Jerin Jacob Kollanukkaran <jerinj@marvell.com>; Anoob Joseph
> > > <anoobj@marvell.com>
> > > Cc: Akhil Goyal <akhil.goyal@nxp.com>; Pablo de Lara
> > > <pablo.de.lara.guarch@intel.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>; Sunila Sahu <ssahu@marvell.com>;
> dev@dpdk.org
> > > Subject: Re: [PATCH 6/6] doc: add documentation for OCTEON TX2
> > > crypto asym support
> > >
> > > 10/09/2019 06:13, Jerin Jacob Kollanukkaran:
> > > > From: Anoob Joseph <anoobj@marvell.com>
> > > > > Adding documentation for asymmetric features supported by
> > > > > crypto_octeontx2 PMD.
> > > > >
> > > > > 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/octeontx2.ini |  9 +++++++++
> > > > >  doc/guides/cryptodevs/octeontx2.rst          | 13 +++++++++++++
> > > >
> > > > Please update the release notes.
> > >
> > > Please avoid doing a separate patch for documentation.
> > > It could be updated while adding the feature, in the same patch.
> >
> > [Anoob] To which patch should I squash this change? Here are my
> > options,
> >
> > 1. The patch which adds ASYM in capabilities. Issue: the doc update
> > updates about autotest, which won't be available until the final patch is
> merged.
> > 2. Test patch which adds the autotest for the PMD. Issue: Additions to
> > the doc would be done by a patch which adds test.
> >
> > Which one should I use?
> 
> As per the convention followed these days, documentation should be the
> part of the Patch which support it.
> If you have supported many features in your patchset, you should add that
> piece of documentation which is supported in each of the patches in the
> patchset.
> 
> Release notes should be added in the patch which completes the whole
> feature.
> 
> -Akhil

Will do so when sending v2.

Thanks,
Anoob

Patch

diff --git a/doc/guides/cryptodevs/features/octeontx2.ini b/doc/guides/cryptodevs/features/octeontx2.ini
index ac76b11..7d07053 100644
--- a/doc/guides/cryptodevs/features/octeontx2.ini
+++ b/doc/guides/cryptodevs/features/octeontx2.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 'octeontx2' crypto driver.
@@ -60,3 +62,10 @@  ZUC EIA3     = Y
 AES GCM (128) = Y
 AES GCM (192) = Y
 AES GCM (256) = Y
+
+;
+; Supported Asymmetric algorithms of the 'octeontx2' crypto driver.
+;
+[Asymmetric]
+RSA                    = Y
+Modular Exponentiation = Y
diff --git a/doc/guides/cryptodevs/octeontx2.rst b/doc/guides/cryptodevs/octeontx2.rst
index a2cbb50..410183c 100644
--- a/doc/guides/cryptodevs/octeontx2.rst
+++ b/doc/guides/cryptodevs/octeontx2.rst
@@ -53,6 +53,11 @@  AEAD algorithms:
 
 * ``RTE_CRYPTO_AEAD_AES_GCM``
 
+Asymmetric algorithms:
+
+* ``RTE_CRYPTO_ASYM_XFORM_RSA``
+* ``RTE_CRYPTO_ASYM_XFORM_MODEX``
+
 
 Installation
 ------------
@@ -140,3 +145,11 @@  application:
 
     ./test
     RTE>>cryptodev_octeontx2_autotest
+
+The asymmetric crypto operations on OCTEON TX2 crypto PMD may be verified by running the test
+application:
+
+.. code-block:: console
+
+    ./test
+    RTE>>cryptodev_octeontx2_asym_autotest