From 2cff7e2a596e3a17a4bc7c91b32745553f729421 Mon Sep 17 00:00:00 2001 From: Gilles Peskine Date: Tue, 16 Feb 2021 16:49:42 +0100 Subject: [PATCH] Minor clarification in the public documentation Signed-off-by: Gilles Peskine --- include/mbedtls/psa_util.h | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/include/mbedtls/psa_util.h b/include/mbedtls/psa_util.h index b4814012e..95153d0ae 100644 --- a/include/mbedtls/psa_util.h +++ b/include/mbedtls/psa_util.h @@ -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. * * This function is suitable as the `f_rng` random generator function - * parameter of many `mbedtls_xxx` functions. It must be used in combination - * with the random generator state #MBEDTLS_PSA_RANDOM_STATE. + * parameter of many `mbedtls_xxx` functions. Use #MBEDTLS_PSA_RANDOM_STATE + * to obtain the \p p_rng parameter. * * The implementation of this function depends on the configuration of the * library. - + * * \note Depending on the configuration, this may be a function or * 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 An `MBEDTLS_ERR_ENTROPY_xxx`, + * `MBEDTLS_ERR_PLATFORM_xxx, * `MBEDTLS_ERR_CTR_DRBG_xxx` or * `MBEDTLS_ERR_HMAC_DRBG_xxx` on error. */