[dpdk-dev] [dpdk-dev, v1, 3/3] doc: update cryptodev documentation for set/get private data

[De Lara Guarch, Pablo]

> -----Original Message-----
> From: Gujjar, Abhinandan S
> Sent: Wednesday, April 4, 2018 7:35 AM
> To: De Lara Guarch, Pablo <pablo.de.lara.guarch at intel.com>; Doherty, Declan
> <declan.doherty at intel.com>; jerin.jacob at caviumnetworks.com;
> hemant.agrawal at nxp.com; akhil.goyal at nxp.com; dev at dpdk.org
> Cc: Vangati, Narender <narender.vangati at intel.com>; Gujjar, Abhinandan S
> <abhinandan.gujjar at intel.com>; Rao, Nikhil <nikhil.rao at intel.com>
> Subject: [dpdk-dev,v1,3/3] doc: update cryptodev documentation for set/get
> private data

Better to rewrite title to something shorter, like "doc: add private data info in crypto guide".

> 
> Signed-off-by: Abhinandan Gujjar <abhinandan.gujjar at intel.com>
> ---
>  doc/guides/prog_guide/cryptodev_lib.rst | 26 ++++++++++++++++++++++++++
>  1 file changed, 26 insertions(+)
> 
> diff --git a/doc/guides/prog_guide/cryptodev_lib.rst
> b/doc/guides/prog_guide/cryptodev_lib.rst
> index 066fe2d..57b3f6e 100644
> --- a/doc/guides/prog_guide/cryptodev_lib.rst
> +++ b/doc/guides/prog_guide/cryptodev_lib.rst
> @@ -299,6 +299,32 @@ directly from the devices processed queue, and for
> virtual device's from a  enqueue call.
> 
> 
> +Set/Get private data
> +~~~~~~~~~~~~~~~~~~~~

I would change the title of this section to "Private data".

> +For session-based operations, the set and get API provides a mechanism
> +for an application to store and retrieve the private data information
> +stored along with the rte_cryptodev_sym_session session.

Change to "along with the crypto session".

> +
> +For example, suppose an application is submitting a
> +rte_cryptodev_sym_session operation and wants to indicate private data

I would reword this and not use "rte_cryptodev_sym_session operation", because it means nothing.
Better "submitting a crypto operation with a session associated".

> +information is required to be used after completion of the
> +rte_cryptodev_sym_session operation. In this case, the application can use the
> set API to set the private data and retrieve it using get API.
> +
> +.. code-block:: c
> +
> +	int rte_cryptodev_sym_session_set_private_data(
> +		struct rte_cryptodev_sym_session *sess,	void *data, uint16_t
> size);
> +
> +	void * rte_cryptodev_sym_session_get_private_data(
> +		struct rte_cryptodev_sym_session *sess);
> +
> +
> +For session-less mode, the private data information can be placed along
> +with the ``struct rte_crypto_op``. The
> +``rte_crypto_op::private_data_offset`` indicates the start of private
> +data information. The offset is counted from the start of the rte_crypto_op
> including initialization vector (IV).

Including other crypto information such as the IVs (since there can be an IV also for authentication).

Thanks,
Pablo