From 2d9c4d0621034e501e037c8dd9b9c76b8fbdee62 Mon Sep 17 00:00:00 2001 From: Pablo de Lara Date: Mon, 21 May 2018 14:08:39 +0100 Subject: [PATCH] doc: announce deprecation in crypto queue pair start/stop 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.05 and removed in 18.08. Signed-off-by: Pablo de Lara Acked-by: Akhil Goyal Acked-by: Fiona Trahe Acked-by: Deepak Kumar Jain --- doc/guides/rel_notes/deprecation.rst | 4 ++++ lib/librte_cryptodev/rte_cryptodev.h | 4 ++++ 2 files changed, 8 insertions(+) diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index b5d1cc0d5d..66168812c4 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -84,3 +84,7 @@ Deprecation Notices ``rte_cryptodev_queue_pair_dettach_sym_session()`` will be deprecated from 18.05 and removed in 18.08, as there are no drivers doing anything useful with them. + - Functions ``rte_cryptodev_queue_pair_start()`` and + ``rte_cryptodev_queue_pair_stop()`` will be deprecated from 18.05 + and removed in 18.08, 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 fe1bd82576..972f11f72d 100644 --- a/lib/librte_cryptodev/rte_cryptodev.h +++ b/lib/librte_cryptodev/rte_cryptodev.h @@ -603,6 +603,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. * @@ -616,10 +617,12 @@ rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id, * - -EINVAL: The dev_id or the queue_id out of range. * - -ENOTSUP: The function not supported in PMD driver. */ +__rte_deprecated 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 @@ -632,6 +635,7 @@ rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id); * - -EINVAL: The dev_id or the queue_id out of range. * - -ENOTSUP: The function not supported in PMD driver. */ +__rte_deprecated extern int rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id); -- 2.20.1