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

[Gujjar, Abhinandan S]

> -----Original Message-----
> From: Akhil Goyal [mailto:akhil.goyal at nxp.com]
> Sent: Tuesday, April 10, 2018 2:52 PM
> To: Gujjar, Abhinandan S <abhinandan.gujjar at intel.com>; 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; dev at dpdk.org
> Cc: Vangati, Narender <narender.vangati at intel.com>; Rao, Nikhil
> <nikhil.rao at intel.com>
> Subject: Re: [dpdk-dev, v1, 3/3] doc: update cryptodev documentation for
> set/get private data
> 
> Hi Abhinandan,
> 
> One minor comment.
> Series
> Acked-by: Akhil Goyal <akhil.goyal at nxp.com>
> 
> On 4/4/2018 12:04 PM, Abhinandan Gujjar wrote:
> > 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
> > +~~~~~~~~~~~~~~~~~~~~
> > +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.
> > +
> > +For example, suppose an application is submitting a
> > +rte_cryptodev_sym_session operation and wants to indicate private
> > +data information is required to be used
> wants to indicate private data information which is required
Sure Akhil. Thanks for reviewing.
> 
> > +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).
> > +
> > +
> >   Enqueue / Dequeue Burst APIs
> >   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> >
> >