d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: add private data info in crypto guide

Browse Source 
Signed-off-by: Abhinandan Gujjar <abhinandan.gujjar@intel.com>
Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
This commit is contained in:
Abhinandan Gujjar 2018-04-16 12:24:56 +05:30 committed by Pablo de Lara
parent 2d96371fbd
commit fe84aaee29
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
doc/guides/prog_guide/cryptodev_lib.rst
View File

@ -299,6 +299,33 @@ directly from the devices processed queue, and for virtual device's from a
enqueue call. enqueue call.
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 crypto session.
For example, suppose an application is submitting a crypto operation with a session
associated and wants to indicate private data information which is required to be
used after completion of the crypto 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 other crypto information such as the IVs (since there can
be an IV also for authentication).
Enqueue / Dequeue Burst APIs Enqueue / Dequeue Burst APIs
~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~