[dpdk-dev] [PATCH] cryptodev: Add useful comment to _sym_session

[O Mahony, Billy]

Nacked-by: Billy O'Mahony <billy.o.mahony at intel.com>

There are some assumptions about the internals of crypto lib in this comment. I'll remove those and submit again.

> -----Original Message-----
> From: O Mahony, Billy
> Sent: Saturday, November 25, 2017 10:11 PM
> To: Doherty, Declan <declan.doherty at intel.com>; dev at dpdk.org
> Cc: O Mahony, Billy <billy.o.mahony at intel.com>
> Subject: [PATCH] cryptodev: Add useful comment to _sym_session
> 
> Signed-off-by: Billy O'Mahony <billy.o.mahony at intel.com>
> ---
>  lib/librte_cryptodev/rte_cryptodev.h | 7 ++++++-
>  1 file changed, 6 insertions(+), 1 deletion(-)
> 
> diff --git a/lib/librte_cryptodev/rte_cryptodev.h
> b/lib/librte_cryptodev/rte_cryptodev.h
> index dade554..6edb468 100644
> --- a/lib/librte_cryptodev/rte_cryptodev.h
> +++ b/lib/librte_cryptodev/rte_cryptodev.h
> @@ -890,7 +890,12 @@ rte_cryptodev_enqueue_burst(uint8_t dev_id, uint16_t
> qp_id,  }
> 
> 
> -/** Cryptodev symmetric crypto session */
> +/** Cryptodev symmetric crypto session
> + * Internally the crytpodev library maintains an association between
> +the
> + * session and an rte_crypto_sym_xform which is specified as an
> +argument to
> + * rte_cryptodev_sym_session_create().  Therefore a session has a fixed
> +xform
> + * chain and each xform has a fixed algo, key, op-type, digest_len etc.
> + */
>  struct rte_cryptodev_sym_session {
>  	__extension__ void *sess_private_data[0];
>  	/**< Private session material */
> --
> 2.7.4