yuzu/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-emu/mbedtls.git synced 2025-01-22 19:41:09 +00:00
Code Issues Packages Projects Releases Wiki Activity

Minor clarification in the public documentation

Browse source 
Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine 2021-02-16 16:49:42 +01:00
parent cd2d648b00
commit 2cff7e2a59
1 changed files with 4 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
include/mbedtls/psa_util.h
View file

@ -437,12 +437,12 @@ typedef int mbedtls_f_rng_t( void *p_rng, unsigned char *output, size_t output_s
/** The random generator function for the PSA subsystem. /** The random generator function for the PSA subsystem.
* *
* This function is suitable as the `f_rng` random generator function * This function is suitable as the `f_rng` random generator function
* parameter of many `mbedtls_xxx` functions. It must be used in combination * parameter of many `mbedtls_xxx` functions. Use #MBEDTLS_PSA_RANDOM_STATE
* with the random generator state #MBEDTLS_PSA_RANDOM_STATE. * to obtain the \p p_rng parameter.
* *
* The implementation of this function depends on the configuration of the * The implementation of this function depends on the configuration of the
* library. * library.
*
* \note Depending on the configuration, this may be a function or * \note Depending on the configuration, this may be a function or
* a pointer to a function. * a pointer to a function.
* *
@ -465,6 +465,7 @@ typedef int mbedtls_f_rng_t( void *p_rng, unsigned char *output, size_t output_s
* *
* \return \c 0 on success. * \return \c 0 on success.
* \return An `MBEDTLS_ERR_ENTROPY_xxx`, * \return An `MBEDTLS_ERR_ENTROPY_xxx`,
* `MBEDTLS_ERR_PLATFORM_xxx,
* `MBEDTLS_ERR_CTR_DRBG_xxx` or * `MBEDTLS_ERR_CTR_DRBG_xxx` or
* `MBEDTLS_ERR_HMAC_DRBG_xxx` on error. * `MBEDTLS_ERR_HMAC_DRBG_xxx` on error.
*/ */