From 728762e37ed3ea29e7270d4239e833ecc9ac0043 Mon Sep 17 00:00:00 2001 From: Anoob Joseph Date: Thu, 7 Mar 2019 10:39:50 +0000 Subject: [PATCH] doc: announce ABI change for cryptodev config Add new field ff_disable in rte_cryptodev_config. This enables applications to control the features enabled on the crypto device. Proposed new layout: /** Crypto device configuration structure */ struct rte_cryptodev_config { int socket_id; /**< Socket to allocate resources on */ uint16_t nb_queue_pairs; /**< Number of queue pairs to configure on device */ + uint64_t ff_disable; + /**< Feature flags to be disabled. Only the following features are + * allowed to be disabled, + * - RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO + * - RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO + * - RTE_CRYTPODEV_FF_SECURITY + */ }; For eth devices, rte_eth_conf.rx_mode.offloads and rte_eth_conf.tx_mode.offloads fields are used by applications to control the offloads enabled on the eth device. This proposal adds a similar ability for the crypto device. Signed-off-by: Anoob Joseph Acked-by: Fiona Trahe Acked-by: Akhil Goyal --- doc/guides/rel_notes/deprecation.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst index 4b328a5594..76465794d3 100644 --- a/doc/guides/rel_notes/deprecation.rst +++ b/doc/guides/rel_notes/deprecation.rst @@ -72,3 +72,17 @@ Deprecation Notices * crypto/aesni_mb: the minimum supported intel-ipsec-mb library version will be changed from 0.49.0 to 0.52.0. + +* cryptodev: New member in ``rte_cryptodev_config`` to allow applications to + disable features supported by the crypto device. Only the following features + would be allowed to be disabled this way, + + - ``RTE_CRYPTODEV_FF_SYMMETRIC_CRYPTO`` + - ``RTE_CRYPTODEV_FF_ASYMMETRIC_CRYPTO`` + - ``RTE_CRYPTODEV_FF_SECURITY`` + + Disabling unused features would facilitate efficient usage of HW/SW offload. + + - Member ``uint64_t ff_disable`` in ``rte_cryptodev_config`` + + The field would be added in v19.08. -- 2.20.1