From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from dpdk.org (dpdk.org [92.243.14.124]) by inbox.dpdk.org (Postfix) with ESMTP id 26F38A04DD; Mon, 26 Oct 2020 19:52:57 +0100 (CET) Received: from [92.243.14.124] (localhost [127.0.0.1]) by dpdk.org (Postfix) with ESMTP id 3D1592BDB; Mon, 26 Oct 2020 19:52:14 +0100 (CET) Received: from mga12.intel.com (mga12.intel.com [192.55.52.136]) by dpdk.org (Postfix) with ESMTP id 7F1B22BFF for ; Mon, 26 Oct 2020 19:52:11 +0100 (CET) IronPort-SDR: V4TyC0w5QYHLZ5jS/h84smd1rd6V5qNTZh6c4s2ffeP5NTQCk2vpJqj2j0oh+x6w3GsKZpSRF1 11YPUbBkq04Q== X-IronPort-AV: E=McAfee;i="6000,8403,9786"; a="147255852" X-IronPort-AV: E=Sophos;i="5.77,420,1596524400"; d="scan'208";a="147255852" X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga008.fm.intel.com ([10.253.24.58]) by fmsmga106.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 26 Oct 2020 11:52:11 -0700 IronPort-SDR: zz3XftYoWxtC7lUsI7zo3XPpzexr4GRGr2Covzux0p1RUOjCGjOQ0LCMkSeQQQiMR4tqkGzmYf QlMYtsvl50IQ== X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.77,420,1596524400"; d="scan'208";a="303501305" Received: from unknown (HELO localhost.localdomain) ([10.190.210.98]) by fmsmga008.fm.intel.com with ESMTP; 26 Oct 2020 11:52:08 -0700 From: Abhinandan Gujjar 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 Date: Sun, 25 Oct 2020 15:14:50 +0530 Message-Id: <1603619090-118652-4-git-send-email-abhinandan.gujjar@intel.com> X-Mailer: git-send-email 1.9.1 In-Reply-To: <1603619090-118652-1-git-send-email-abhinandan.gujjar@intel.com> References: <1603619090-118652-1-git-send-email-abhinandan.gujjar@intel.com> Subject: [dpdk-dev] [v4 3/3] doc: add enqueue callback APIs X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Add enqueue callback support for cryptodev library Signed-off-by: Abhinandan Gujjar --- 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