alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Merge branch 'docs/rng_update_outdated' into 'master'

Browse Source 
docs(esp_hw_support): corrected outdated RNG docs

See merge request espressif/esp-idf!32737
This commit is contained in:
Mahavir Jain 2024-08-12 10:49:35 +08:00
commit cff436cf57
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
components/esp_hw_support/include/esp_random.h
View File

@ -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
*/