cryptodev: extend sym session doxygen info
authorBilly O'Mahony <billy.o.mahony@intel.com>
Mon, 27 Nov 2017 11:40:28 +0000 (11:40 +0000)
committerPablo de Lara <pablo.de.lara.guarch@intel.com>
Sat, 20 Jan 2018 15:08:34 +0000 (16:08 +0100)
Signed-off-by: Billy O'Mahony <billy.o.mahony@intel.com>
Acked-by: Fiona Trahe <fiona.trahe@intel.com>
lib/librte_cryptodev/rte_cryptodev.h

index ed92f98..c8fa689 100644 (file)
@@ -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 */