[dpdk-dev] [PATCH] doc: announce ABI change for cryptodev config

[Anoob Joseph <anoobj@marvell.com>]

Add new field ff_enable 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_enable;
+   /**< Feature flags to be enabled on the device. Only the features set
+    * on rte_cryptodev_info.feature_flags are allowed to be set.
+    */
};

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 <anoobj@marvell.com>
---
 doc/guides/rel_notes/deprecation.rst | 10 ++++++++++
 1 file changed, 10 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 5f03443..e289c2d 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -66,3 +66,13 @@ 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
+  specify the features to be enabled on the crypto device. For eth devices,
+  applications can use ``rte_eth_conf.rxmode.offloads`` and
+  ``rte_eth_conf.txmode.offloads`` to control the offloads enabled. Adding
+  a similar field to facilitate efficient usage of HW/SW offloads.
+
+  - Member ``uint64_t ff_enable`` in ``rte_cryptodev_config``
+
+  The field would be added in v19.05.
-- 
2.7.4