[EXTERNAL] [RFC] lib/cryptodev: update API documentation for aux_flags

[Akhil Goyal]

Hi Radu,

> Update the API documentation description of rte_crypto_op field
> aux_flags as to allow PMDs to define driver-specific flags.

Can you give examples of the flags that you want to add for driver specific work?
I believe adding driver specific things here may not be good.
May be we can discuss the specific flags and define them as common for all PMDs.


> 
> Signed-off-by: Radu Nicolau <radu.nicolau at intel.com>
> ---
>  lib/cryptodev/rte_crypto.h | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/lib/cryptodev/rte_crypto.h b/lib/cryptodev/rte_crypto.h
> index dcf4a36fb2..38c8acbf4c 100644
> --- a/lib/cryptodev/rte_crypto.h
> +++ b/lib/cryptodev/rte_crypto.h
> @@ -116,6 +116,10 @@ struct rte_crypto_op {
>  			 * the status is RTE_CRYPTO_OP_STATUS_SUCCESS.
>  			 * In case of errors, the value of this field is undefined.
>  			 *
> +			 * In addition to RTE_CRYPTO_OP_AUX_FLAGS_* the
> PMDs can define
> +			 * their own optional auxiliary flags as needed, set by
> the
> +			 * application and to be used for driver-specific
> purposes.
> +			 *
>  			 * With TLS record offload
> (RTE_SECURITY_PROTOCOL_TLS_RECORD),
>  			 * application may provide the extra padding required for
> the plaintext
>  			 * provided. This field can be used for passing the same
> in units of 8B.
> --
> 2.50.1