RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00
Code Releases Activity

sys/random doc: Point to auto initialization and its caveats

Browse Source
This commit is contained in:
chrysn 2023-11-23 16:53:52 +01:00
parent df70e00b92
commit e9e1f9cce4
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
sys/include/random.h
View File

@ -21,6 +21,11 @@
* HWRNG differ in how they generate random numbers and may not use a PRNG internally. * HWRNG differ in how they generate random numbers and may not use a PRNG internally.
* Refer to the manual of your MCU for details. * Refer to the manual of your MCU for details.
* *
* By default, the `auto_init_random` module is enabled, which initializes the
* PRNG on startup. However, there is no lower limit on the entropy provided at
* that time. Unless the `periph_hwrng` module is used, entropy may be as
* little as zero (the constant may even be the same across devices).
*
* @{ * @{
* *
* @file * @file
@ -55,6 +60,9 @@ extern "C" {
/** /**
* @brief initializes PRNG with a seed * @brief initializes PRNG with a seed
* *
* Users only need to call this if the `auto_init_random` module is disabled,
* or provides insufficient quality entropy.
*
* @warning Currently, the random module uses a global state * @warning Currently, the random module uses a global state
* => multiple calls to @ref random_init will reset the existing * => multiple calls to @ref random_init will reset the existing
* state of the PRNG. * state of the PRNG.