[dpdk-dev,v3,3/4] doc: announce deprecation for attach/detach crypto session
Checks
Commit Message
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.05
and removed in 18.08.
Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
---
doc/guides/rel_notes/deprecation.rst | 4 ++++
lib/librte_cryptodev/rte_cryptodev.h | 2 ++
2 files changed, 6 insertions(+)
Comments
Hi Pablo,
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Pablo de Lara
> Sent: Thursday, May 17, 2018 10:01 AM
> To: Doherty, Declan <declan.doherty@intel.com>; akhil.goyal@nxp.com
> Cc: dev@dpdk.org; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>
> Subject: [dpdk-dev] [PATCH v3 3/4] doc: announce deprecation for attach/detach crypto session
>
> 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.05
> and removed in 18.08.
>
> Signed-off-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>
> ---
> doc/guides/rel_notes/deprecation.rst | 4 ++++
> lib/librte_cryptodev/rte_cryptodev.h | 2 ++
> 2 files changed, 6 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 85945ee72..cd75150a6 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -80,3 +80,7 @@ Deprecation Notices
> is not internal in the crypto device anymore.
> - Replacement of ``pci_dev`` field with the more generic ``rte_device``
> structure.
> + - 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
[Fiona] This should read 18.05 / 18.08
Apart from that
Acked-by: Fiona Trahe <fiona.trahe@intel.com>
>> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
>> index 85945ee72..cd75150a6 100644
>> --- a/doc/guides/rel_notes/deprecation.rst
>> +++ b/doc/guides/rel_notes/deprecation.rst
>> @@ -80,3 +80,7 @@ Deprecation Notices
>> is not internal in the crypto device anymore.
>> - Replacement of ``pci_dev`` field with the more generic ``rte_device``
>> structure.
>> + - 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
> [Fiona] This should read 18.05 / 18.08
>
> Apart from that
> Acked-by: Fiona Trahe <fiona.trahe@intel.com>
>
With the above change
Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
@@ -80,3 +80,7 @@ Deprecation Notices
is not internal in the crypto device anymore.
- Replacement of ``pci_dev`` field with the more generic ``rte_device``
structure.
+ - 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.
@@ -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.