From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mga05.intel.com (mga05.intel.com [192.55.52.43]) by dpdk.org (Postfix) with ESMTP id 529182C54 for ; Tue, 5 Feb 2019 19:20:11 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from fmsmga002.fm.intel.com ([10.253.24.26]) by fmsmga105.fm.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 05 Feb 2019 10:20:06 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.58,336,1544515200"; d="scan'208";a="140917221" Received: from akusztax-mobl.ger.corp.intel.com ([10.104.116.169]) by fmsmga002.fm.intel.com with ESMTP; 05 Feb 2019 10:20:04 -0800 From: Arek Kusztal 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 Date: Tue, 5 Feb 2019 19:19:41 +0100 Message-Id: <20190205181941.10484-1-arkadiuszx.kusztal@intel.com> X-Mailer: git-send-email 2.19.1.windows.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [dpdk-dev] [PATCH v2] cryptodev: rework mod exp and mod inv comments X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 05 Feb 2019 18:20:12 -0000 This patch changes modular exponentiation and modular multiplicative inverse API comments to make it more precise. Signed-off-by: Arek Kusztal --- v2: - grammar fixes lib/librte_cryptodev/rte_crypto_asym.h | 44 ++++++++++++++++++++++------------ 1 file changed, 29 insertions(+), 15 deletions(-) diff --git a/lib/librte_cryptodev/rte_crypto_asym.h b/lib/librte_cryptodev/rte_crypto_asym.h index 5e185b2..9582ee3 100644 --- a/lib/librte_cryptodev/rte_crypto_asym.h +++ b/lib/librte_cryptodev/rte_crypto_asym.h @@ -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,39 @@ 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, any positive integer + * + * 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, + * positive integer + * + * 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 +327,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 +362,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 */ -- 2.1.0