From: Abhinandan Gujjar <abhinandan.gujjar@intel.com>
To: dev@dpdk.org, declan.doherty@intel.com, akhil.goyal@nxp.com,
Honnappa.Nagarahalli@arm.com, konstantin.ananyev@intel.com
Cc: narender.vangati@intel.com, jerinj@marvell.com,
abhinandan.gujjar@intel.com
Subject: [dpdk-dev] [v4 3/3] doc: add enqueue callback APIs
Date: Sun, 25 Oct 2020 15:14:50 +0530 [thread overview]
Message-ID: <1603619090-118652-4-git-send-email-abhinandan.gujjar@intel.com> (raw)
In-Reply-To: <1603619090-118652-1-git-send-email-abhinandan.gujjar@intel.com>
Add enqueue callback support for cryptodev library
Signed-off-by: Abhinandan Gujjar <abhinandan.gujjar@intel.com>
---
doc/guides/prog_guide/cryptodev_lib.rst | 22 ++++++++++++++++++++++
doc/guides/rel_notes/release_20_11.rst | 5 +++++
2 files changed, 27 insertions(+)
diff --git a/doc/guides/prog_guide/cryptodev_lib.rst b/doc/guides/prog_guide/cryptodev_lib.rst
index 72129e4..bb3de61 100644
--- a/doc/guides/prog_guide/cryptodev_lib.rst
+++ b/doc/guides/prog_guide/cryptodev_lib.rst
@@ -366,6 +366,28 @@ can never be larger than ``nb_ops``.
uint16_t rte_cryptodev_dequeue_burst(uint8_t dev_id, uint16_t qp_id,
struct rte_crypto_op **ops, uint16_t nb_ops)
+User callback APIs
+~~~~~~~~~~~~~~~~~~
+The add API configures a callback function to be called for each burst of crypto
+ops received on a given crypto device queue pair. The return value is a pointer
+that can be used later to remove the callback using rte_cryptodev_remove_enq_callback().
+Multiple callback functions can be added for a given queue pair.
+
+.. code-block:: c
+
+ struct rte_cryptodev_cb *
+ rte_cryptodev_add_enq_callback(uint8_t dev_id,
+ uint16_t qp_id,
+ rte_cryptodev_callback_fn cb_fn,
+ void *cb_arg);
+
+The remove API removes a callback function added by rte_cryptodev_add_enq_callback().
+
+.. code-block:: c
+
+ int rte_cryptodev_remove_enq_callback(uint8_t dev_id,
+ uint16_t qp_id,
+ struct rte_cryptodev_cb *cb);
Operation Representation
~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/doc/guides/rel_notes/release_20_11.rst b/doc/guides/rel_notes/release_20_11.rst
index 48717ee..7e2fd30 100644
--- a/doc/guides/rel_notes/release_20_11.rst
+++ b/doc/guides/rel_notes/release_20_11.rst
@@ -285,6 +285,11 @@ New Features
* Added scatter gather support.
* Added NIST GCMVS complaint GMAC test method support.
+* **Added enqueue callback APIs for cryptodev library.**
+
+ Cryptodev is added with enqueue callback APIs to enable applications
+ to add/remove user callbacks which gets called for every enqueue
+ operations.
Removed Items
-------------
--
1.9.1
next prev parent reply other threads:[~2020-10-26 18:52 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-10-25 9:44 [dpdk-dev] [v4 0/3] support enqueue callbacks on cryptodev Abhinandan Gujjar
2020-10-25 9:44 ` [dpdk-dev] [v4 1/3] cryptodev: support enqueue callback functions Abhinandan Gujjar
2020-10-27 12:47 ` Ananyev, Konstantin
2020-10-27 17:16 ` Gujjar, Abhinandan S
2020-10-27 17:20 ` Ananyev, Konstantin
2020-10-27 17:22 ` Gujjar, Abhinandan S
2020-10-27 18:19 ` Akhil Goyal
2020-10-27 19:16 ` Gujjar, Abhinandan S
2020-10-27 19:26 ` Akhil Goyal
2020-10-27 19:41 ` Gujjar, Abhinandan S
2020-10-27 18:28 ` Akhil Goyal
2020-10-28 8:20 ` Gujjar, Abhinandan S
2020-10-28 12:55 ` Ananyev, Konstantin
2020-10-28 14:28 ` Akhil Goyal
2020-10-28 14:52 ` Ananyev, Konstantin
2020-10-28 15:11 ` [dpdk-dev] [dpdk-techboard] " Bruce Richardson
2020-10-28 15:22 ` Honnappa Nagarahalli
2020-10-29 13:52 ` Gujjar, Abhinandan S
2020-10-29 14:00 ` Akhil Goyal
2020-10-30 4:24 ` Gujjar, Abhinandan S
2020-10-30 17:18 ` Gujjar, Abhinandan S
2020-10-29 14:26 ` Kinsella, Ray
2020-10-25 9:44 ` [dpdk-dev] [v4 2/3] test: add testcase for crypto enqueue callback Abhinandan Gujjar
2020-10-25 9:44 ` Abhinandan Gujjar [this message]
2020-10-26 19:08 ` [dpdk-dev] [v4 3/3] doc: add enqueue callback APIs Akhil Goyal
2020-10-27 3:52 ` Gujjar, Abhinandan S
2020-10-27 12:51 ` Ananyev, Konstantin
2020-10-27 17:17 ` Gujjar, Abhinandan S
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=1603619090-118652-4-git-send-email-abhinandan.gujjar@intel.com \
--to=abhinandan.gujjar@intel.com \
--cc=Honnappa.Nagarahalli@arm.com \
--cc=akhil.goyal@nxp.com \
--cc=declan.doherty@intel.com \
--cc=dev@dpdk.org \
--cc=jerinj@marvell.com \
--cc=konstantin.ananyev@intel.com \
--cc=narender.vangati@intel.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).