[v2,3/3] doc: update documentation

Message ID 20190228113619.76782-4-roy.fan.zhang@intel.com (mailing list archive)
State Superseded, archived
Delegated to: akhil goyal
Headers
Series crypto/aesni_mb: enable out of place processing |

Checks

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

Commit Message

Fan Zhang Feb. 28, 2019, 11:36 a.m. UTC
  This patch updates the documentation for the newly supported
AESNI-MB PMD out-of-place operation feature.

Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
---
 doc/guides/cryptodevs/aesni_mb.rst          | 1 -
 doc/guides/cryptodevs/features/aesni_mb.ini | 1 +
 doc/guides/rel_notes/release_19_05.rst      | 4 ++++
 3 files changed, 5 insertions(+), 1 deletion(-)
  

Comments

Fiona Trahe March 19, 2019, 5:29 p.m. UTC | #1
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Fan Zhang
> Sent: Thursday, February 28, 2019 11:36 AM
> To: dev@dpdk.org
> Cc: akhil.goyal@nxp.com; Zhang, Roy Fan <roy.fan.zhang@intel.com>; De Lara Guarch, Pablo
> <pablo.de.lara.guarch@intel.com>
> Subject: [dpdk-dev] [PATCH v2 3/3] doc: update documentation
> 
> This patch updates the documentation for the newly supported
> AESNI-MB PMD out-of-place operation feature.
> 
> Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
Acked-by: Fiona Trahe <fiona.trahe@intel.com>
  
De Lara Guarch, Pablo March 20, 2019, 5:55 p.m. UTC | #2
> -----Original Message-----
> From: Zhang, Roy Fan
> Sent: Thursday, February 28, 2019 11:36 AM
> To: dev@dpdk.org
> Cc: akhil.goyal@nxp.com; Zhang, Roy Fan <roy.fan.zhang@intel.com>; De
> Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
> Subject: [PATCH v2 3/3] doc: update documentation

I think you can merge this patch with patch 1.

> 
> This patch updates the documentation for the newly supported AESNI-MB
> PMD out-of-place operation feature.
> 
> Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>

...

> +++ b/doc/guides/rel_notes/release_19_05.rst
> @@ -65,6 +65,10 @@ New Features
>      process.
>    * Added support for Rx packet types list in a secondary process.
> 
> +* **Updated AESNI-MB PMD.**
> +
> +  Updated AESNI-MB PMD for supporting out-of-place operations.

Better to simply state "Added support for out-of-place operations", to avoid redundancy.

> +
> 
>  Removed Items
>  -------------
> --
> 2.14.5
  

Patch

diff --git a/doc/guides/cryptodevs/aesni_mb.rst b/doc/guides/cryptodevs/aesni_mb.rst
index 47f2ecc2f..55aa7cd94 100644
--- a/doc/guides/cryptodevs/aesni_mb.rst
+++ b/doc/guides/cryptodevs/aesni_mb.rst
@@ -56,7 +56,6 @@  Limitations
 -----------
 
 * Chained mbufs are not supported.
-* Only in-place is currently supported (destination address is the same as source address).
 * RTE_CRYPTO_AEAD_AES_GCM only works properly when the multi-buffer library is
   0.51.0 or newer.
 * RTE_CRYPTO_HASH_AES_GMAC is supported by library version v0.51 or later.
diff --git a/doc/guides/cryptodevs/features/aesni_mb.ini b/doc/guides/cryptodevs/features/aesni_mb.ini
index f72957451..93a534f19 100644
--- a/doc/guides/cryptodevs/features/aesni_mb.ini
+++ b/doc/guides/cryptodevs/features/aesni_mb.ini
@@ -11,6 +11,7 @@  CPU AVX                = Y
 CPU AVX2               = Y
 CPU AVX512             = Y
 CPU AESNI              = Y
+OOP LB  In LB  Out     = Y
 
 ;
 ; Supported crypto algorithms of the 'aesni_mb' crypto driver.
diff --git a/doc/guides/rel_notes/release_19_05.rst b/doc/guides/rel_notes/release_19_05.rst
index 2b0f60d3d..33067013f 100644
--- a/doc/guides/rel_notes/release_19_05.rst
+++ b/doc/guides/rel_notes/release_19_05.rst
@@ -65,6 +65,10 @@  New Features
     process.
   * Added support for Rx packet types list in a secondary process.
 
+* **Updated AESNI-MB PMD.**
+
+  Updated AESNI-MB PMD for supporting out-of-place operations.
+
 
 Removed Items
 -------------