diff mbox series

[v2] doc: fix aesni mb documentation.

Message ID 20190109121112.22841-1-roy.fan.zhang@intel.com (mailing list archive)
State Accepted, archived
Delegated to: akhil goyal
Headers
Series [v2] doc: fix aesni mb documentation. |

Checks

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

Commit Message

Fan Zhang Jan. 9, 2019, 12:11 p.m. UTC 
  This patch fixes the incorrect intel multi buffer library support
version and missed limitation of GCM algorithm support.

Fixes: 0e9f8507afcb ("crypto/aesni_mb: support AES-GCM algorithm")
Cc: stable@dpdk.org

Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
---
v2:
-fixed a typo

 doc/guides/cryptodevs/aesni_mb.rst | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

Comments

De Lara Guarch, Pablo Jan. 9, 2019, 8:06 p.m. UTC | #1 
> -----Original Message-----
> From: Zhang, Roy Fan
> Sent: Wednesday, January 9, 2019 12:11 PM
> To: dev@dpdk.org
> Cc: akhil.goyal@nxp.com; De Lara Guarch, Pablo
> <pablo.de.lara.guarch@intel.com>; Trahe, Fiona <fiona.trahe@intel.com>;
> stable@dpdk.org
> Subject: [PATCH v2] doc: fix aesni mb documentation.
> 
> This patch fixes the incorrect intel multi buffer library support version and
> missed limitation of GCM algorithm support.
> 
> Fixes: 0e9f8507afcb ("crypto/aesni_mb: support AES-GCM algorithm")
> Cc: stable@dpdk.org
> 
> Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>

Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
De Lara Guarch, Pablo Jan. 9, 2019, 8:16 p.m. UTC | #2 
> -----Original Message-----
> From: De Lara Guarch, Pablo
> Sent: Wednesday, January 9, 2019 8:06 PM
> To: Zhang, Roy Fan <roy.fan.zhang@intel.com>; dev@dpdk.org
> Cc: akhil.goyal@nxp.com; Trahe, Fiona <fiona.trahe@intel.com>;
> stable@dpdk.org
> Subject: RE: [PATCH v2] doc: fix aesni mb documentation.
> 
> 
> 
> > -----Original Message-----
> > From: Zhang, Roy Fan
> > Sent: Wednesday, January 9, 2019 12:11 PM
> > To: dev@dpdk.org
> > Cc: akhil.goyal@nxp.com; De Lara Guarch, Pablo
> > <pablo.de.lara.guarch@intel.com>; Trahe, Fiona
> > <fiona.trahe@intel.com>; stable@dpdk.org
> > Subject: [PATCH v2] doc: fix aesni mb documentation.
> >
> > This patch fixes the incorrect intel multi buffer library support
> > version and missed limitation of GCM algorithm support.
> >
> > Fixes: 0e9f8507afcb ("crypto/aesni_mb: support AES-GCM algorithm")
> > Cc: stable@dpdk.org
> >
> > Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
> 
> Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>

Applied to dpdk-next-crypto.

Thanks,
Pablo
diff mbox series

Patch

diff --git a/doc/guides/cryptodevs/aesni_mb.rst b/doc/guides/cryptodevs/aesni_mb.rst
index 63e060d75..d9fd41ae5 100644
--- a/doc/guides/cryptodevs/aesni_mb.rst
+++ b/doc/guides/cryptodevs/aesni_mb.rst
@@ -1,5 +1,5 @@ 
 ..  SPDX-License-Identifier: BSD-3-Clause
-    Copyright(c) 2015-2017 Intel Corporation.
+    Copyright(c) 2015-2018 Intel Corporation.
 
 AESN-NI Multi Buffer Crypto Poll Mode Driver
 ============================================
@@ -51,6 +51,8 @@  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.
 
 
 Installation
@@ -59,8 +61,8 @@  Installation
 To build DPDK with the AESNI_MB_PMD the user is required to download the multi-buffer
 library from `here <https://github.com/01org/intel-ipsec-mb>`_
 and compile it on their user system before building DPDK.
-The latest version of the library supported by this PMD is v0.50, which
-can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v0.50.zip>`_.
+The latest version of the library supported by this PMD is v0.51, which
+can be downloaded from `<https://github.com/01org/intel-ipsec-mb/archive/v0.51.zip>`.
 
 .. code-block:: console