Hi Arek, > -----Original Message----- > From: Kusztal, ArkadiuszX > Sent: Tuesday, February 5, 2019 11:13 AM > To: dev@dpdk.org > Cc: shally.ve...@caviumnetworks.com; sunila.s...@caviumnetworks.com; > ashish.gu...@caviumnetworks.com; umesh.kar...@caviumnetworks.com; Trahe, Fiona > <fiona.tr...@intel.com>; akhil.go...@nxp.com; Kusztal, ArkadiuszX > <arkadiuszx.kusz...@intel.com> > Subject: [PATCH] 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.kusz...@intel.com>
> + * In case this number is equal to zero driver set crypto op > + * status field to RTE_CRYPTO_OP_STATUS_ERROR [Fiona] grammar nit - ....the driver should set the crypto op..... > - * Structure describing modulus inverse xform params > + * Structure describing modular multiplicative inverse transform xform params [Fiona] grammar nit - no need for transform and xform - one will do. > + * In case this number is equal to zero driver set crypto op > + * status field to RTE_CRYPTO_OP_STATUS_ERROR [Fiona] grammar nit - same comment as above > + * > + * This number need to be relatively prime to base > + * in corresponding Modular Multiplicative Inverse > + * rte_crypto_mod_op_param > */ [Fiona] grammar nit - "The number needs..." or "This number should be" > 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. [Fiona] grammar nit - octet-string - no need for capitalisation > + * > + * In case Multiplicative Inverse is used this number need > + * to be relatively prime to modulus in corresponding Modular > + * Multiplicative Inverse rte_crypto_modinv_xform [Fiona] grammar nit - same comment as above