doc: announce change to cryptodev cb function prototype

Message ID 20220624134524.3461406-1-schalla@marvell.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc: announce change to cryptodev cb function prototype |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/github-robot: build success github build: passed
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-abi-testing success Testing PASS

Commit Message

Srujana Challa June 24, 2022, 1:45 p.m. UTC
  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(+)
  

Comments

Akhil Goyal June 24, 2022, 6:09 p.m. UTC | #1
> Subject: [PATCH] doc: announce change to cryptodev cb function prototype
> 
> 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>
Acked-by: Akhil Goyal <gakhil@marvell.com>
  
Fan Zhang July 6, 2022, 9:11 a.m. UTC | #2
> -----Original Message-----
> From: Srujana Challa <schalla@marvell.com>
> Sent: Friday, June 24, 2022 2:45 PM
> To: gakhil@marvell.com; Zhang, Roy Fan <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
> 
> 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
Acked-by: Fan Zhang <roy.fan.zhang@intel.com>
  
Jerin Jacob July 11, 2022, 2:52 p.m. UTC | #3
On Wed, Jul 6, 2022 at 2:41 PM Zhang, Roy Fan <roy.fan.zhang@intel.com> wrote:
>
> > -----Original Message-----
> > From: Srujana Challa <schalla@marvell.com>
> > Sent: Friday, June 24, 2022 2:45 PM
> > To: gakhil@marvell.com; Zhang, Roy Fan <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

> > --
> > 2.25.1
> Acked-by: Fan Zhang <roy.fan.zhang@intel.com>


Acked-by: Jerin Jacob <jerinj@marvell.com>
  
Akhil Goyal July 12, 2022, 11:55 a.m. UTC | #4
Hi Hemant,

Can you please ack this deprecation notice?

> Subject: [PATCH] doc: announce change to cryptodev cb function prototype
> 
> 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
  
Hemant Agrawal July 12, 2022, 11:57 a.m. UTC | #5
Acked-by:  Hemant Agrawal <hemant.agrawal@nxp.com>
  
Thomas Monjalon July 17, 2022, 10:37 a.m. UTC | #6
24/06/2022 15:45, Srujana Challa:
> 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>
> ---
> +* 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.

I think it is a wrong decision.
Some events may not be related to queues.
You cannot add all events infos in the callback.
In ethdev, we are querying the event infos with additional functions,
specific to the event type.

Applied, but I will try to convince you to not do it.
  

Patch

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.