doc: fix aesni-gcm limitations

Message ID 20190917120646.32413-1-roy.fan.zhang@intel.com
State Accepted
Delegated to: akhil goyal
Headers show
Series
  • doc: fix aesni-gcm limitations
Related show

Checks

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

Commit Message

Zhang, Roy Fan Sept. 17, 2019, 12:06 p.m.
This patch fixes the aesni-gcm cryptodev documentation by
filling the lacked unsupported chained mbuf description.

Fixes: 6f16aab09a91 ("crypto/aesni_gcm: migrate to Multi-buffer library")
Cc: pablo.de.lara.guarch@intel.com
Cc: stable@dpdk.org

Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
---
 doc/guides/cryptodevs/aesni_gcm.rst | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Akhil Goyal Sept. 27, 2019, 2:30 p.m. | #1
Applied to dpdk-next-crypto

Thanks.

Patch

diff --git a/doc/guides/cryptodevs/aesni_gcm.rst b/doc/guides/cryptodevs/aesni_gcm.rst
index 31297fabd..e1c4f9d24 100644
--- a/doc/guides/cryptodevs/aesni_gcm.rst
+++ b/doc/guides/cryptodevs/aesni_gcm.rst
@@ -28,11 +28,12 @@  AEAD algorithms:
 
 * RTE_CRYPTO_AEAD_AES_GCM
 
-
 Limitations
 -----------
 
 * Chained mbufs are supported but only out-of-place (destination mbuf must be contiguous).
+* Chained mbufs are only supported by RTE_CRYPTO_AEAD_AES_GCM algorithm,
+  not RTE_CRYPTO_AUTH_AES_GMAC.
 * Cipher only is not supported.