1
0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-06-25 12:41:56 +03:00

Explicitly document return behaviour

A bug existed previously where this guarantee was not met,
causing some issues in multi-threaded code.

Signed-off-by: Ryan Everett <ryan.everett@arm.com>
This commit is contained in:
Ryan Everett
2024-04-29 18:26:19 +01:00
parent d4ea40de44
commit 231f15ba11

View File

@ -58,6 +58,9 @@ static inline int psa_key_id_is_volatile(psa_key_id_t key_id)
* It is the responsibility of the caller to call psa_unregister_read(slot) * It is the responsibility of the caller to call psa_unregister_read(slot)
* when they have finished reading the contents of the slot. * when they have finished reading the contents of the slot.
* *
* On failure, `*p_slot` is set to NULL. This ensures that it is always valid
* to call psa_unregister_read on the returned slot.
*
* \param key Key identifier to query. * \param key Key identifier to query.
* \param[out] p_slot On success, `*p_slot` contains a pointer to the * \param[out] p_slot On success, `*p_slot` contains a pointer to the
* key slot containing the description of the key * key slot containing the description of the key