diff mbox

[dpdk-dev,v2,2/3] doc: announce deprecation for attach/detach crypto session

Message ID 20180130121415.16623-3-pablo.de.lara.guarch@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Pablo de Lara Guarch
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation fail apply issues

Commit Message

De Lara Guarch, Pablo Jan. 30, 2018, 12:14 p.m. UTC 
  Functions rte_cryptodev_queue_pair_attach_sym_session
and rte_cryptodev_queue_pair_detach_sym_sessions
are not really used in any of the crypto drivers
(only one driver implements it and it just return 0).
Therefore, this API can be deprecated from 18.02
and removed in 18.05.

Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 5 +++++
 lib/librte_cryptodev/rte_cryptodev.h | 2 ++
 2 files changed, 7 insertions(+)
diff mbox

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 5588ba7c1..bd4200bba 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -64,3 +64,8 @@  Deprecation Notices
   and ``max_nb_sessions_per_qp``, in structure ``rte_cryptodev_info``,
   will be removed in 18.05, as these fields are not relevant anymore
   since the session mempool is not internal in the crypto device anymore.
+
+* cryptodev: Functions ``rte_cryptodev_queue_pair_attach_sym_session()`` and
+  ``rte_cryptodev_queue_pair_dettach_sym_session()`` will be deprecated from
+  18.02 and removed in 18.05, as there are no drivers doing anything useful
+  with them.
diff --git a/lib/librte_cryptodev/rte_cryptodev.h b/lib/librte_cryptodev/rte_cryptodev.h
index c8fa68935..4597f864d 100644
--- a/lib/librte_cryptodev/rte_cryptodev.h
+++ b/lib/librte_cryptodev/rte_cryptodev.h
@@ -986,6 +986,7 @@  unsigned int
 rte_cryptodev_get_private_session_size(uint8_t dev_id);
 
 /**
+ * @deprecated
  * Attach queue pair with sym session.
  *
  * @param	dev_id		Device to which the session will be attached.
@@ -1002,6 +1003,7 @@  rte_cryptodev_queue_pair_attach_sym_session(uint8_t dev_id, uint16_t qp_id,
 		struct rte_cryptodev_sym_session *session);
 
 /**
+ * @deprecated
  * Detach queue pair with sym session.
  *
  * @param	dev_id		Device to which the session is attached.