diff mbox

[dpdk-dev] doc: announce API deprecation in cryptodev

Message ID 20180126112732.28967-1-pablo.de.lara.guarch@intel.com (mailing list archive)
State Superseded, archived
Headers

Checks

Context Check Description
ci/checkpatch success coding style OK

Commit Message

De Lara Guarch, Pablo Jan. 26, 2018, 11:27 a.m. UTC 
  Functions rte_cryptodev_queue_pair_start/stop
are not really used in any of the crypto drivers
(they all just return 0 or -ENOTSUP).
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(+)

Comments

Akhil Goyal Jan. 29, 2018, 9:15 a.m. UTC | #1 
On 1/26/2018 4:57 PM, Pablo de Lara wrote:
> Functions rte_cryptodev_queue_pair_start/stop
> are not really used in any of the crypto drivers
> (they all just return 0 or -ENOTSUP).
> 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(+)
> 

Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
diff mbox

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index d59ad5988..c5846d849 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -59,3 +59,8 @@  Deprecation Notices
   be added between the producer and consumer structures. The size of the
   structure and the offset of the fields will remain the same on
   platforms with 64B cache line, but will change on other platforms.
+
+* cryptodev: Functions ``rte_cryptodev_queue_pair_start()`` and
+  ``rte_cryptodev_queue_pair_stop()`` 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..a2863b206 100644
--- a/lib/librte_cryptodev/rte_cryptodev.h
+++ b/lib/librte_cryptodev/rte_cryptodev.h
@@ -602,6 +602,7 @@  rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
 		struct rte_mempool *session_pool);
 
 /**
+ * @deprecated
  * Start a specified queue pair of a device. It is used
  * when deferred_start flag of the specified queue is true.
  *
@@ -619,6 +620,7 @@  extern int
 rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id);
 
 /**
+ * @deprecated
  * Stop specified queue pair of a device
  *
  * @param	dev_id		The identifier of the device