diff mbox series

[1/2] cryptodev: update raw datapath API documentation

Message ID 20230522115636.309-1-anoobj@marvell.com (mailing list archive)
State Accepted, archived
Delegated to: akhil goyal
Headers
Series [1/2] cryptodev: update raw datapath API documentation |

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

Anoob Joseph May 22, 2023, 11:56 a.m. UTC 
  Clarify the error codes returned by rte_cryptodev_raw_dp_ctx. Cryptodev
can return -ENOTSUP to indicate any unsupported features with raw APIs.

Remove redundant references about 'rte_cryptodev_raw_attach_session()'.
The API is not part of the specification.

Signed-off-by: Anoob Joseph <anoobj@marvell.com>
Signed-off-by: Vidya Sagar Velumuri <vvelumuri@marvell.com>
---
 lib/cryptodev/rte_cryptodev.h | 10 ++++------
 1 file changed, 4 insertions(+), 6 deletions(-)

Comments

Akhil Goyal May 25, 2023, 7:57 a.m. UTC | #1 
> Subject: [PATCH 1/2] cryptodev: update raw datapath API documentation
> 
> Clarify the error codes returned by rte_cryptodev_raw_dp_ctx. Cryptodev
> can return -ENOTSUP to indicate any unsupported features with raw APIs.
> 
> Remove redundant references about 'rte_cryptodev_raw_attach_session()'.
> The API is not part of the specification.
> 
> Signed-off-by: Anoob Joseph <anoobj@marvell.com>
> Signed-off-by: Vidya Sagar Velumuri <vvelumuri@marvell.com>
Acked-by: Akhil Goyal <gakhil@marvell.com>
Akhil Goyal May 29, 2023, 10:53 a.m. UTC | #2 
> > Subject: [PATCH 1/2] cryptodev: update raw datapath API documentation
> >
> > Clarify the error codes returned by rte_cryptodev_raw_dp_ctx. Cryptodev
> > can return -ENOTSUP to indicate any unsupported features with raw APIs.
> >
> > Remove redundant references about 'rte_cryptodev_raw_attach_session()'.
> > The API is not part of the specification.
> >
> > Signed-off-by: Anoob Joseph <anoobj@marvell.com>
> > Signed-off-by: Vidya Sagar Velumuri <vvelumuri@marvell.com>
> Acked-by: Akhil Goyal <gakhil@marvell.com>

Series applied to dpdk-next-crypto
diff mbox series

Patch

diff --git a/lib/cryptodev/rte_cryptodev.h b/lib/cryptodev/rte_cryptodev.h
index 3a9ad13660..fcc366805f 100644
--- a/lib/cryptodev/rte_cryptodev.h
+++ b/lib/cryptodev/rte_cryptodev.h
@@ -1519,18 +1519,13 @@  struct rte_crypto_raw_dp_ctx {
 /**
  * Configure raw data-path context data.
  *
- * NOTE:
- * After the context data is configured, the user should call
- * rte_cryptodev_raw_attach_session() before using it in
- * rte_cryptodev_raw_enqueue/dequeue function call.
- *
  * @param	dev_id		The device identifier.
  * @param	qp_id		The index of the queue pair from which to
  *				retrieve processed packets. The value must be
  *				in the range [0, nb_queue_pair - 1] previously
  *				supplied to rte_cryptodev_configure().
  * @param	ctx		The raw data-path context data.
- * @param	sess_type	session type.
+ * @param	sess_type	Session type.
  * @param	session_ctx	Session context data.
  * @param	is_update	Set 0 if it is to initialize the ctx.
  *				Set 1 if ctx is initialized and only to update
@@ -1538,6 +1533,9 @@  struct rte_crypto_raw_dp_ctx {
  * @return
  *   - On success return 0.
  *   - On failure return negative integer.
+ *     - -EINVAL if input parameters are invalid.
+ *     - -ENOTSUP if crypto device does not support raw DP operations with the
+ *        provided session.
  */
 __rte_experimental
 int