doc: announce hiding crypto session structures
authorAkhil Goyal <gakhil@marvell.com>
Tue, 3 Aug 2021 12:01:12 +0000 (17:31 +0530)
committerThomas Monjalon <thomas@monjalon.net>
Sun, 8 Aug 2021 08:10:19 +0000 (10:10 +0200)
The structures rte_cryptodev_sym_session and
rte_cryptodev_asym_session are not used by the
application directly. The application just need
an opaque pointer which it can attach to rte_crypto_op
while enqueue.
Hence, these structures can be internal to library
hidden from the user.

Signed-off-by: Akhil Goyal <gakhil@marvell.com>
Acked-by: Anoob Joseph <anoobj@marvell.com>
Acked-by: Jerin Jacob <jerinj@marvell.com>
Acked-by: Matan Azrad <matan@nvidia.com>
doc/guides/rel_notes/deprecation.rst

index 26051cc..c46497d 100644 (file)
@@ -218,6 +218,11 @@ Deprecation Notices
   data length so that driver/HW can write expanded size data after encryption.
   This change is targeted for DPDK 21.11.
 
+* cryptodev: Hide structures ``rte_cryptodev_sym_session`` and
+  ``rte_cryptodev_asym_session`` to remove unnecessary indirection between
+  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 interface between library and drivers will be marked
   as internal in DPDK 21.11.