[v2] doc: announce ABI change for cryptodev config

Message ID 1551955163-1752-1-git-send-email-anoobj@marvell.com
State Accepted, archived
Delegated to: akhil goyal
Headers show
Series
  • [v2] doc: announce ABI change for cryptodev config
Related show

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Anoob Joseph March 7, 2019, 10:39 a.m.
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 <anoobj@marvell.com>
---
v2:
* Renamed 'ff_enable' to 'ff_disable'

 doc/guides/rel_notes/deprecation.rst | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

Comments

Fiona Trahe March 7, 2019, 3:25 p.m. | #1
> -----Original Message-----
> From: Anoob Joseph [mailto:anoobj@marvell.com]
> Sent: Thursday, March 7, 2019 10:40 AM
> To: Akhil Goyal <akhil.goyal@nxp.com>; Trahe, Fiona <fiona.trahe@intel.com>; De Lara Guarch, Pablo
> <pablo.de.lara.guarch@intel.com>
> Cc: Anoob Joseph <anoobj@marvell.com>; Jerin Jacob Kollanukkaran <jerinj@marvell.com>; Narayana
> Prasad Raju Athreya <pathreya@marvell.com>; Shally Verma <shallyv@marvell.com>; Suheil Chandran
> <schandran@marvell.com>; dev@dpdk.org
> Subject: [PATCH v2] 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 <anoobj@marvell.com>
Acked-by: Fiona Trahe <fiona.trahe@intel.com>
Akhil Goyal March 29, 2019, 2:23 p.m. | #2
On 3/7/2019 8:55 PM, Trahe, Fiona wrote:
>
>> -----Original Message-----
>> From: Anoob Joseph [mailto:anoobj@marvell.com]
>> Sent: Thursday, March 7, 2019 10:40 AM
>> To: Akhil Goyal <akhil.goyal@nxp.com>; Trahe, Fiona <fiona.trahe@intel.com>; De Lara Guarch, Pablo
>> <pablo.de.lara.guarch@intel.com>
>> Cc: Anoob Joseph <anoobj@marvell.com>; Jerin Jacob Kollanukkaran <jerinj@marvell.com>; Narayana
>> Prasad Raju Athreya <pathreya@marvell.com>; Shally Verma <shallyv@marvell.com>; Suheil Chandran
>> <schandran@marvell.com>; dev@dpdk.org
>> Subject: [PATCH v2] 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 <anoobj@marvell.com>
> Acked-by: Fiona Trahe <fiona.trahe@intel.com>
>
Acked-by: Akhil Goyal <akhil.goyal@nxp.com>

Applied to dpdk-next-crypto

Thanks.

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 1b4fcb7..d0a60f9 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -75,3 +75,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.