[PATCH] doc: announce change to cryptodev cb function prototype

From: Srujana Challa <schalla@marvell.com>
To: <gakhil@marvell.com>, <roy.fan.zhang@intel.com>
Cc: <dev@dpdk.org>, <jerinj@marvell.com>, <ndabilpuram@marvell.com>,
	<anoobj@marvell.com>
Subject: [PATCH] doc: announce change to cryptodev cb function prototype
Date: Fri, 24 Jun 2022 19:15:24 +0530	[thread overview]
Message-ID: <20220624134524.3461406-1-schalla@marvell.com> (raw)

Function rte_cryptodev_cb_fn prototype will be extended to
add new parameter qp_id, to return queue pair ID, which got
error interrupt to the application, so that application can
reset that particular queue pair.

https://mails.dpdk.org/archives/dev/2022-June/245428.html

Signed-off-by: Srujana Challa <schalla@marvell.com>
---
 doc/guides/rel_notes/deprecation.rst | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 4e5b23c53d..d6c94f8ac8 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -112,6 +112,11 @@ Deprecation Notices
   session and the private data of session. An opaque pointer can be exposed
   directly to application which can be attached to the ``rte_crypto_op``.
 
+* cryptodev: The function pointer ``rte_cryptodev_cb_fn`` will be updated to
+  have another parameter ``qp_id`` to return the queue_pair ID which got error
+  interrupt to the application so that application can reset that particular
+  queue pair.
+
 * security: Hide structure ``rte_security_session`` and expose an opaque
   pointer for the private data to the application which can be attached
   to the packet while enqueuing.
-- 
2.25.1

