[1/5] cryptodev: fix RSA op cipher field description

Message ID 20211129095159.16376-2-rbalu@marvell.com (mailing list archive)
State Rejected, archived
Delegated to: akhil goyal
Series cryptodev: fix inconsistency in RSA op usage |


Context Check Description
ci/checkpatch success coding style OK

Commit Message

Ramkumar Balu Nov. 29, 2021, 9:51 a.m. UTC
  From: Ramkumar <rbalu@marvell.com>

The description for 'struct rte_crypto_rsa_op_param' failed to specify
a field for returning the plaintext from RSA public key decryption.

This patch fixes the rte_crypto_rsa_op_param description to specify
'cipher' field to be used for returning plaintext during RSA op_type

Fixes: 501ed9c6611f ("cryptodev: add cipher field to RSA op")
Cc: stable@dpdk.org

Signed-off-by: Ramkumar <rbalu@marvell.com>
 lib/cryptodev/rte_crypto_asym.h | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)


diff --git a/lib/cryptodev/rte_crypto_asym.h b/lib/cryptodev/rte_crypto_asym.h
index 9c866f553f..b99cf6843c 100644
--- a/lib/cryptodev/rte_crypto_asym.h
+++ b/lib/cryptodev/rte_crypto_asym.h
@@ -461,11 +461,12 @@  struct rte_crypto_rsa_op_param {
 	 * - to be decrypted for RSA private decrypt.
 	 * Pointer to output data
-	 * - for RSA public encrypt.
+	 * - for RSA public encrypt/decrypt.
 	 * In this case the underlying array should have been allocated
-	 * with enough memory to hold ciphertext output (i.e. must be
+	 * with enough memory to hold ciphertext/plaintext output (i.e. must be
 	 * at least RSA key size). The cipher.length field should
-	 * be 0 and will be overwritten by the PMD with the encrypted length.
+	 * be 0 and will be overwritten by the PMD with the encrypted/decrypted
+	 * length.
 	 * All data is in Octet-string network byte order format.