improve return codes and logic description

Signed-off-by: Paul Elliott <paul.elliott@arm.com>
This commit is contained in:
Paul Elliott 2024-08-01 10:29:24 +01:00
parent 867815d89d
commit 9bcfd8981e

View File

@ -4900,7 +4900,7 @@ uint32_t psa_key_agreement_iop_get_num_ops(psa_key_agreement_iop_t *operation);
* on the same operation object after a successful * on the same operation object after a successful
* call to this function until \c * call to this function until \c
* psa_key_agreement_iop_complete() either returns * psa_key_agreement_iop_complete() either returns
* 0 or an error. * #PSA_SUCCESS or an error.
* \c psa_key_agreement_iop_complete() will return * \c psa_key_agreement_iop_complete() will return
* #PSA_OPERATION_INCOMPLETE if there is more work * #PSA_OPERATION_INCOMPLETE if there is more work
* to do. Alternatively users can call * to do. Alternatively users can call
@ -5049,10 +5049,10 @@ psa_status_t psa_key_agreement_iop_setup(
* maximum time spent in a function call. * maximum time spent in a function call.
* *
* \note Users should call this function on the same * \note Users should call this function on the same
* operation object repeatedly until it either * operation object repeatedly whilst it returns
* returns 0 or an error. This function will return * #PSA_OPERATION_INCOMPLETE, stopping when it
* #PSA_OPERATION_INCOMPLETE if there is more work * returns either #PSA_SUCCESS or an error.
* to do. Alternatively users can call * Alternatively users can call
* \c psa_key_agreement_iop_abort() at any point if * \c psa_key_agreement_iop_abort() at any point if
* they no longer want the result. * they no longer want the result.
* *