yuzu-emu/mbedtls
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix abort documentation.

Browse source 
Make it clear that these functions reset the number of ops, and remove
statements that say they have no effect.

Signed-off-by: Paul Elliott <paul.elliott@arm.com>
This commit is contained in:
Paul Elliott 2023-02-03 14:27:32 +00:00
parent cb23311bd0
commit 1b49ef5384
1 changed files with 15 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
include/psa/crypto.h
View file

@ -4430,7 +4430,13 @@ psa_status_t psa_sign_hash_complete(
* \warning This is a beta API, and thus subject to change * \warning This is a beta API, and thus subject to change
* at any point. It is not bound by the usual * at any point. It is not bound by the usual
* interface stability promises. * interface stability promises.
*
* \note This function is the only function that clears
* the number of ops completed as part of the
* operation. Please ensure you copy this value via
* \c psa_sign_hash_get_num_ops() if required
* before calling.
*
* \note Aborting an operation frees all associated * \note Aborting an operation frees all associated
* resources except for the \p operation structure * resources except for the \p operation structure
* itself. Once aborted, the operation object can * itself. Once aborted, the operation object can
@ -4442,8 +4448,7 @@ psa_status_t psa_sign_hash_complete(
* particular, calling \c psa_sign_hash_abort() * particular, calling \c psa_sign_hash_abort()
* after the operation has already been terminated * after the operation has already been terminated
* by a call to \c psa_sign_hash_abort() or * by a call to \c psa_sign_hash_abort() or
* psa_sign_hash_complete() is safe and has no * psa_sign_hash_complete() is safe.
* effect.
* *
* \param[in,out] operation Initialized sign hash operation. * \param[in,out] operation Initialized sign hash operation.
* *
@ -4620,6 +4625,12 @@ psa_status_t psa_verify_hash_complete(
* any point. It is not bound by the usual interface * any point. It is not bound by the usual interface
* stability promises. * stability promises.
* *
* \note This function is the only function that clears the
* number of ops completed as part of the operation.
* Please ensure you copy this value via
* \c psa_verify_hash_get_num_ops() if required
* before calling.
*
* \note Aborting an operation frees all associated * \note Aborting an operation frees all associated
* resources except for the operation structure * resources except for the operation structure
* itself. Once aborted, the operation object can be * itself. Once aborted, the operation object can be
@ -4631,8 +4642,7 @@ psa_status_t psa_verify_hash_complete(
* In particular, calling \c psa_verify_hash_abort() * In particular, calling \c psa_verify_hash_abort()
* after the operation has already been terminated by * after the operation has already been terminated by
* a call to \c psa_verify_hash_abort() or * a call to \c psa_verify_hash_abort() or
* psa_verify_hash_complete() is safe and has no * psa_verify_hash_complete() is safe.
* effect.
* *
* \param[in,out] operation Initialized verify hash operation. * \param[in,out] operation Initialized verify hash operation.
* *