From: Fiona Trahe Date: Tue, 25 Apr 2017 16:56:31 +0000 (+0100) Subject: cryptodev: fix API digest length comments X-Git-Tag: spdx-start~3318 X-Git-Url: http://git.droids-corp.org/?a=commitdiff_plain;h=daf3c9152f54efa25244fc1f199c4fe8dc0ea999;p=dpdk.git cryptodev: fix API digest length comments Fix misleading comments clarifying setting of digest length. Fixes: d11b0f30df88 ("cryptodev: introduce API and framework for crypto devices") Cc: stable@dpdk.org Signed-off-by: Fiona Trahe Acked-by: Declan Doherty --- diff --git a/lib/librte_cryptodev/rte_crypto_sym.h b/lib/librte_cryptodev/rte_crypto_sym.h index 6f24ea9a16..3a40844810 100644 --- a/lib/librte_cryptodev/rte_crypto_sym.h +++ b/lib/librte_cryptodev/rte_crypto_sym.h @@ -310,11 +310,10 @@ struct rte_crypto_auth_xform { * this specifies the length of the digest to be compared for the * session. * + * It is the caller's responsibility to ensure that the + * digest length is compliant with the hash algorithm being used. * If the value is less than the maximum length allowed by the hash, - * the result shall be truncated. If the value is greater than the - * maximum length allowed by the hash then an error will be generated - * by *rte_cryptodev_sym_session_create* or by the - * *rte_cryptodev_sym_enqueue_burst* if using session-less APIs. + * the result shall be truncated. */ uint32_t add_auth_data_length; @@ -597,7 +596,9 @@ struct rte_crypto_sym_op { phys_addr_t phys_addr; /**< Physical address of digest */ uint16_t length; - /**< Length of digest */ + /**< Length of digest. This must be the same value as + * @ref rte_crypto_auth_xform.digest_length. + */ } digest; /**< Digest parameters */ struct {