From: Billy O'Mahony <billy.o.mahony@intel.com>
Date: Mon, 27 Nov 2017 11:40:28 +0000 (+0000)
Subject: cryptodev: extend sym session doxygen info
X-Git-Tag: spdx-start~126
X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;ds=sidebyside;h=c4000fe51830a27e5e753964f9cfde0a7d480460;p=dpdk.git

cryptodev: extend sym session doxygen info

Signed-off-by: Billy O'Mahony <billy.o.mahony@intel.com>
Acked-by: Fiona Trahe <fiona.trahe@intel.com>
---

diff --git a/lib/librte_cryptodev/rte_cryptodev.h b/lib/librte_cryptodev/rte_cryptodev.h
index ed92f9822e..c8fa68935c 100644
--- a/lib/librte_cryptodev/rte_cryptodev.h
+++ b/lib/librte_cryptodev/rte_cryptodev.h
@@ -891,7 +891,10 @@ rte_cryptodev_enqueue_burst(uint8_t dev_id, uint16_t qp_id,
 }
 
 
-/** Cryptodev symmetric crypto session */
+/** Cryptodev symmetric crypto session
+ * Each session is derived from a fixed xform chain. Therefore each session
+ * has a fixed algo, key, op-type, digest_len etc.
+ */
 struct rte_cryptodev_sym_session {
 	__extension__ void *sess_private_data[0];
 	/**< Private session material */