From: Anoob Joseph <anoobj@marvell.com>
To: Ciara Power <ciara.power@intel.com>,
Akhil Goyal <gakhil@marvell.com>,
"Fan Zhang" <fanzhang.oss@gmail.com>
Cc: Gagandeep Singh <g.singh@nxp.com>,
Hemant Agrawal <hemant.agrawal@nxp.com>,
Jerin Jacob <jerinj@marvell.com>,
Tejasree Kondoj <ktejasree@marvell.com>,
Vidya Sagar Velumuri <vvelumuri@marvell.com>, <dev@dpdk.org>
Subject: [PATCH 1/2] cryptodev: update raw datapath API documentation
Date: Mon, 22 May 2023 17:26:35 +0530 [thread overview]
Message-ID: <20230522115636.309-1-anoobj@marvell.com> (raw)
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(-)
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
--
2.25.1
next reply other threads:[~2023-05-22 11:56 UTC|newest]
Thread overview: 5+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-05-22 11:56 Anoob Joseph [this message]
2023-05-22 11:56 ` [PATCH 2/2] test/crypto: handle returns from raw crypto APIs Anoob Joseph
2023-05-25 7:59 ` Akhil Goyal
2023-05-25 7:57 ` [PATCH 1/2] cryptodev: update raw datapath API documentation Akhil Goyal
2023-05-29 10:53 ` Akhil Goyal
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230522115636.309-1-anoobj@marvell.com \
--to=anoobj@marvell.com \
--cc=ciara.power@intel.com \
--cc=dev@dpdk.org \
--cc=fanzhang.oss@gmail.com \
--cc=g.singh@nxp.com \
--cc=gakhil@marvell.com \
--cc=hemant.agrawal@nxp.com \
--cc=jerinj@marvell.com \
--cc=ktejasree@marvell.com \
--cc=vvelumuri@marvell.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).