mirror/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-04-16 08:42:50 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve IOP documentation

Browse Source 
Signed-off-by: Janos Follath <janos.follath@arm.com>
This commit is contained in:
Janos Follath 2024-08-13 16:21:17 +01:00
parent 7311600fd5
commit 9f48917b88
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
tf-psa-crypto/include/psa/crypto.h
View File

@ -5272,11 +5272,13 @@ uint32_t psa_generate_key_iop_get_num_ops(psa_generate_key_iop_t *operation);
* aborted by calling \c * aborted by calling \c
* psa_generate_key_iop_abort(). * psa_generate_key_iop_abort().
* *
* \note Only asymmetric keys are supported. (See \p attributes.)
*
* \param[in, out] operation The \c psa_generate_key_iop_t to use. * \param[in, out] operation The \c psa_generate_key_iop_t to use.
* This must be initialized as per the * This must be initialized as per the
* documentation for * documentation for
* \c psa_generate_key_iop_t, and be inactive. * \c psa_generate_key_iop_t, and be inactive.
*
* \param[in] attributes The attributes for the new key. * \param[in] attributes The attributes for the new key.
* The following attributes are required for all * The following attributes are required for all
* keys: * keys:
@ -5322,7 +5324,6 @@ uint32_t psa_generate_key_iop_get_num_ops(psa_generate_key_iop_t *operation);
* \retval PSA_ERROR_NOT_PERMITTED * \retval PSA_ERROR_NOT_PERMITTED
* Creating a key with the specified attributes is not permitted. * Creating a key with the specified attributes is not permitted.
* *
* \retval #PSA_ERROR_INVALID_ARGUMENT \emptydescription
* \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription * \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
* \retval #PSA_ERROR_COMMUNICATION_FAILURE \emptydescription * \retval #PSA_ERROR_COMMUNICATION_FAILURE \emptydescription
* \retval #PSA_ERROR_HARDWARE_FAILURE \emptydescription * \retval #PSA_ERROR_HARDWARE_FAILURE \emptydescription
@ -5377,7 +5378,7 @@ psa_status_t psa_generate_key_iop_setup(
* *
* \param[in, out] operation The \c psa_generate_key_iop_t to use. * \param[in, out] operation The \c psa_generate_key_iop_t to use.
* This must be initialized first, and have had \c * This must be initialized first, and have had \c
* psa_generate_key_iop_start() called * psa_generate_key_iop_setup() called
* with it first. * with it first.
* *
* \param[out] key On success, an identifier for the newly created * \param[out] key On success, an identifier for the newly created