From 965f52a45a55c6dae577706669ff0a7750d07524 Mon Sep 17 00:00:00 2001 From: Jakob Hasse Date: Fri, 9 Aug 2024 16:20:02 +0200 Subject: [PATCH] docs(esp_hw_support): corrected outdated RNG docs --- components/esp_hw_support/include/esp_random.h | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/components/esp_hw_support/include/esp_random.h b/components/esp_hw_support/include/esp_random.h index 4a1af7548a..a8bc09fbde 100644 --- a/components/esp_hw_support/include/esp_random.h +++ b/components/esp_hw_support/include/esp_random.h @@ -1,5 +1,5 @@ /* - * SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD + * SPDX-FileCopyrightText: 2021-2024 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 */ @@ -22,8 +22,10 @@ extern "C" { * Guide "Random Number Generation" section for necessary prerequisites. * * This function automatically busy-waits to ensure enough external entropy has been - * introduced into the hardware RNG state, before returning a new random number. This delay - * is very short (always less than 100 CPU cycles). + * introduced into the hardware RNG state, before returning a new random number. + * This delay makes sure the reading frequency does not exceed 15-75 KHz. The actual + * value is dependent on the specific chip. More information on this can be found in + * components/esp_hw_support/hw_random.c. * * @return Random value between 0 and UINT32_MAX */