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 <pablo.de.lara.guarch@intel.com>
Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
Acked-by: Fiona Trahe <fiona.trahe@intel.com>
Acked-by: Deepak Kumar Jain <deepak.k.jain@intel.com>
This commit is contained in:
Pablo de Lara 2018-05-21 14:08:39 +01:00
parent fd9e776e97
commit 2d9c4d0621
2 changed files with 8 additions and 0 deletions

View File

@ -84,3 +84,7 @@ Deprecation Notices
``rte_cryptodev_queue_pair_dettach_sym_session()`` will be deprecated from ``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 18.05 and removed in 18.08, as there are no drivers doing anything useful
with them. 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.

View File

@ -603,6 +603,7 @@ rte_cryptodev_queue_pair_setup(uint8_t dev_id, uint16_t queue_pair_id,
struct rte_mempool *session_pool); struct rte_mempool *session_pool);
/** /**
* @deprecated
* Start a specified queue pair of a device. It is used * Start a specified queue pair of a device. It is used
* when deferred_start flag of the specified queue is true. * 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. * - -EINVAL: The dev_id or the queue_id out of range.
* - -ENOTSUP: The function not supported in PMD driver. * - -ENOTSUP: The function not supported in PMD driver.
*/ */
__rte_deprecated
extern int extern int
rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id); rte_cryptodev_queue_pair_start(uint8_t dev_id, uint16_t queue_pair_id);
/** /**
* @deprecated
* Stop specified queue pair of a device * Stop specified queue pair of a device
* *
* @param dev_id The identifier of the 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. * - -EINVAL: The dev_id or the queue_id out of range.
* - -ENOTSUP: The function not supported in PMD driver. * - -ENOTSUP: The function not supported in PMD driver.
*/ */
__rte_deprecated
extern int extern int
rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id); rte_cryptodev_queue_pair_stop(uint8_t dev_id, uint16_t queue_pair_id);