[v3] cryptodev: rework mod exp and mod inv comments
Checks
Commit Message
This patch changes modular exponentiation and modular multiplicative
inverse API comments to make it more precise.
Signed-off-by: Arek Kusztal <arkadiuszx.kusztal@intel.com>
---
v2:
- grammar fixes
v3:
- remove information about positive integer
lib/librte_cryptodev/rte_crypto_asym.h | 43 ++++++++++++++++++++++------------
1 file changed, 28 insertions(+), 15 deletions(-)
Comments
> -----Original Message-----
> From: Kusztal, ArkadiuszX
> Sent: Wednesday, February 6, 2019 10:34 AM
> To: dev@dpdk.org
> Cc: akhil.goyal@nxp.com; Trahe, Fiona <fiona.trahe@intel.com>; shally.verma@caviumnetworks.com;
> sunila.sahu@caviumnetworks.com; ashish.gupta@caviumnetworks.com;
> umesh.kartha@caviumnetworks.com; Kusztal, ArkadiuszX <arkadiuszx.kusztal@intel.com>
> Subject: [PATCH v3] cryptodev: rework mod exp and mod inv comments
>
> This patch changes modular exponentiation and modular multiplicative
> inverse API comments to make it more precise.
>
> Signed-off-by: Arek Kusztal <arkadiuszx.kusztal@intel.com>
Acked-by: Fiona Trahe <fiona.trahe@intel.com>
>-----Original Message-----
>From: Arek Kusztal <arkadiuszx.kusztal@intel.com>
>Sent: 06 February 2019 16:04
>To: dev@dpdk.org
>Cc: akhil.goyal@nxp.com; fiona.trahe@intel.com; shally.verma@caviumnetworks.com; sunila.sahu@caviumnetworks.com;
>ashish.gupta@caviumnetworks.com; umesh.kartha@caviumnetworks.com; Arek Kusztal <arkadiuszx.kusztal@intel.com>
>Subject: [PATCH v3] cryptodev: rework mod exp and mod inv comments
>
>External Email
>
>This patch changes modular exponentiation and modular multiplicative
>inverse API comments to make it more precise.
>
>Signed-off-by: Arek Kusztal <arkadiuszx.kusztal@intel.com>
>---
>v2:
>- grammar fixes
>
>v3:
>- remove information about positive integer
>
> lib/librte_cryptodev/rte_crypto_asym.h | 43 ++++++++++++++++++++++------------
> 1 file changed, 28 insertions(+), 15 deletions(-)
>
Acked-by: Shally Verma <shally.verma@marvell.com>
Thanks
Shally
On 2/6/2019 4:04 PM, Arek Kusztal wrote:
> This patch changes modular exponentiation and modular multiplicative
> inverse API comments to make it more precise.
>
> Signed-off-by: Arek Kusztal <arkadiuszx.kusztal@intel.com>
> ---
> v2:
> - grammar fixes
>
> v3:
> - remove information about positive integer
>
> lib/librte_cryptodev/rte_crypto_asym.h | 43 ++++++++++++++++++++++------------
> 1 file changed, 28 insertions(+), 15 deletions(-)
>
Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
Applied to dpdk-next-crypto
Thanks.
@@ -72,8 +72,8 @@ enum rte_crypto_asym_xform_type {
* Refer to rte_crypto_asym_op_type
*/
RTE_CRYPTO_ASYM_XFORM_MODINV,
- /**< Modular Inverse
- * Perform Modulus inverse b^(-1) mod n
+ /**< Modular Multiplicative Inverse
+ * Perform Modular Multiplicative Inverse b^(-1) mod n
*/
RTE_CRYPTO_ASYM_XFORM_MODEX,
/**< Modular Exponentiation
@@ -233,29 +233,38 @@ struct rte_crypto_rsa_xform {
struct rte_crypto_modex_xform {
rte_crypto_param modulus;
/**< modulus
- * Prime modulus of the modexp transform operation in octet-string
- * network byte order format.
+ * Pointer to the modulus data for modexp transform operation
+ * in octet-string network byte order format
+ *
+ * In case this number is equal to zero the driver shall set
+ * the crypto op status field to RTE_CRYPTO_OP_STATUS_ERROR
*/
rte_crypto_param exponent;
/**< exponent
- * Private exponent of the modexp transform operation in
- * octet-string network byte order format.
+ * Exponent of the modexp transform operation in
+ * octet-string network byte order format
*/
};
/**
- * Asymmetric modular inverse transform operation
+ * Asymmetric modular multiplicative inverse transform operation
*
- * Structure describing modulus inverse xform params
+ * Structure describing modular multiplicative inverse transform
*
*/
struct rte_crypto_modinv_xform {
rte_crypto_param modulus;
/**<
- * Pointer to the prime modulus data for modular
- * inverse operation in octet-string network byte
- * order format.
+ * Pointer to the modulus data for modular multiplicative inverse
+ * operation in octet-string network byte order format
+ *
+ * In case this number is equal to zero the driver shall set
+ * the crypto op status field to RTE_CRYPTO_OP_STATUS_ERROR
+ *
+ * This number shall be relatively prime to base
+ * in corresponding Modular Multiplicative Inverse
+ * rte_crypto_mod_op_param
*/
};
@@ -317,14 +326,18 @@ struct rte_crypto_dsa_xform {
/**
* Operations params for modular operations:
- * exponentiation and invert
+ * exponentiation and multiplicative inverse
*
*/
struct rte_crypto_mod_op_param {
rte_crypto_param base;
/**<
- * Pointer to base of modular exponentiation/inversion data in
- * Octet-string network byte order format.
+ * Pointer to base of modular exponentiation/multiplicative
+ * inverse data in octet-string network byte order format
+ *
+ * In case Multiplicative Inverse is used this number shall
+ * be relatively prime to modulus in corresponding Modular
+ * Multiplicative Inverse rte_crypto_modinv_xform
*/
};
@@ -348,7 +361,7 @@ struct rte_crypto_asym_xform {
/**< Modular Exponentiation xform parameters */
struct rte_crypto_modinv_xform modinv;
- /**< Modulus Inverse xform parameters */
+ /**< Modular Multiplicative Inverse xform parameters */
struct rte_crypto_dh_xform dh;
/**< DH xform parameters */