From mboxrd@z Thu Jan  1 00:00:00 1970
From: Akhil Goyal <akhil.goyal@nxp.com>
Subject: Re: [dpdk-dev, v1,
 3/3] doc: update cryptodev documentation for set/get private data
Date: Tue, 10 Apr 2018 14:51:57 +0530
Message-ID: <41e3bfb1-22ce-f359-0969-e8edec7bd9dc@nxp.com>
References: <1522823672-60023-1-git-send-email-abhinandan.gujjar@intel.com>
Mime-Version: 1.0
Content-Type: text/plain; charset=utf-8; format=flowed
Content-Transfer-Encoding: 7bit
Cc: narender.vangati@intel.com, nikhil.rao@intel.com
To: Abhinandan Gujjar <abhinandan.gujjar@intel.com>,
 pablo.de.lara.guarch@intel.com, declan.doherty@intel.com,
 jerin.jacob@caviumnetworks.com, hemant.agrawal@nxp.com, dev@dpdk.org
Return-path: <dev-bounces@dpdk.org>
Received: from EUR01-DB5-obe.outbound.protection.outlook.com
 (mail-db5eur01on0060.outbound.protection.outlook.com [104.47.2.60])
 by dpdk.org (Postfix) with ESMTP id 7B44A1B87D
 for <dev@dpdk.org>; Tue, 10 Apr 2018 11:22:15 +0200 (CEST)
In-Reply-To: <1522823672-60023-1-git-send-email-abhinandan.gujjar@intel.com>
Content-Language: en-US
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

Hi Abhinandan,

One minor comment.
Series
Acked-by: Akhil Goyal <akhil.goyal@nxp.com>

On 4/4/2018 12:04 PM, Abhinandan Gujjar wrote:
> Signed-off-by: Abhinandan Gujjar <abhinandan.gujjar@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

> +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
>   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>   
>