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

View File

@ -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.05 and removed in 18.08, as there are no drivers doing anything useful
with them.

View File

@ -327,18 +327,6 @@ flow_create_failure:
rte_cryptodev_info_get(ipsec_ctx->tbl[cdev_id_qp].id,
&cdev_info);
if (cdev_info.sym.max_nb_sessions_per_qp > 0) {
ret = rte_cryptodev_queue_pair_attach_sym_session(
ipsec_ctx->tbl[cdev_id_qp].id,
ipsec_ctx->tbl[cdev_id_qp].qp,
sa->crypto_session);
if (ret < 0) {
RTE_LOG(ERR, IPSEC,
"Session cannot be attached to qp %u\n",
ipsec_ctx->tbl[cdev_id_qp].qp);
return -1;
}
}
}
sa->cdev_id_qp = cdev_id_qp;

View File

@ -989,6 +989,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.
@ -1000,11 +1001,13 @@ rte_cryptodev_get_private_session_size(uint8_t dev_id);
* - On success, zero.
* - On failure, a negative value.
*/
__rte_deprecated
int
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.
@ -1016,6 +1019,7 @@ rte_cryptodev_queue_pair_attach_sym_session(uint8_t dev_id, uint16_t qp_id,
* - On success, zero.
* - On failure, a negative value.
*/
__rte_deprecated
int
rte_cryptodev_queue_pair_detach_sym_session(uint8_t dev_id, uint16_t qp_id,
struct rte_cryptodev_sym_session *session);