diff --git a/docs/_static/esp_rng_noise_source_rf_available.png b/docs/_static/esp_rng_noise_source_rf_available.png deleted file mode 100644 index 7af9335ec1..0000000000 Binary files a/docs/_static/esp_rng_noise_source_rf_available.png and /dev/null differ diff --git a/docs/_static/esp_rng_noise_source_rf_available.svg b/docs/_static/esp_rng_noise_source_rf_available.svg new file mode 100644 index 0000000000..6e10f18db5 --- /dev/null +++ b/docs/_static/esp_rng_noise_source_rf_available.svg @@ -0,0 +1,77 @@ + + + + + + + + SAR ADC + + + + High Speed + ADC + + + + RC_FAST_CLK + + + Entropy source + + Entropy source + + Entropy source + + + + + XOR + + + + XOR + + + + Random + Number + Generator + + + RNG_DATA_REG + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/_static/esp_rng_noise_source_rf_unavailable.png b/docs/_static/esp_rng_noise_source_rf_unavailable.png deleted file mode 100644 index 0973f66187..0000000000 Binary files a/docs/_static/esp_rng_noise_source_rf_unavailable.png and /dev/null differ diff --git a/docs/_static/esp_rng_noise_source_rf_unavailable.svg b/docs/_static/esp_rng_noise_source_rf_unavailable.svg new file mode 100644 index 0000000000..e5465a01e2 --- /dev/null +++ b/docs/_static/esp_rng_noise_source_rf_unavailable.svg @@ -0,0 +1,57 @@ + + + + + + + + SAR ADC + + + + RC_FAST_CLK + + + Entropy source + + Entropy source + + + + XOR + + + + Random + Number + Generator + + + RNG_DATA_REG + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/en/api-reference/system/random.rst b/docs/en/api-reference/system/random.rst index aeb370a464..eb21bedd3e 100644 --- a/docs/en/api-reference/system/random.rst +++ b/docs/en/api-reference/system/random.rst @@ -26,14 +26,12 @@ The following digram shows the noise sources for the RNG on the {IDF_TARGET_NAME .. only:: SOC_WIFI_SUPPORTED or SOC_IEEE802154_SUPPORTED or SOC_BT_SUPPORTED - .. image:: /../_static/esp_rng_noise_source_rf_available.png - :scale: 80 % + .. image:: /../_static/esp_rng_noise_source_rf_available.svg :align: center .. only:: not SOC_WIFI_SUPPORTED and not SOC_IEEE802154_SUPPORTED and not SOC_BT_SUPPORTED - .. image:: /../_static/esp_rng_noise_source_rf_unavailable.png - :scale: 80 % + .. image:: /../_static/esp_rng_noise_source_rf_unavailable.svg :align: center The hardware RNG produces true random numbers so long as one or more of the following conditions are met: @@ -55,7 +53,7 @@ If none of the above conditions are true, the output of the RNG should be consid Enabling RF subsystem --------------------- - The RF subsystem can be enabled with help of the following APIs: + The RF subsystem can be enabled with help of one of the following APIs: .. list:: @@ -71,7 +69,7 @@ During startup, the ESP-IDF bootloader temporarily enables the non-RF internal e .. only:: not SOC_WIFI_SUPPORTED and not SOC_IEEE802154_SUPPORTED and not SOC_BT_SUPPORTED - For {IDF_TARGET_NAME}, the High Speed ADC is not available. Hence the non-RF internal entropy source (SAR ADC) is kept enabled by default at the time of application startup. Please note that if the application wants to use ADC for other purposes, it should call :cpp:func:`bootloader_random_disable` before using the ADC and :cpp:func:`bootloader_random_enable` to re-enable the entropy source when the Random Number Generator is needed again. + For {IDF_TARGET_NAME}, the High Speed ADC is not available. Hence the non-RF internal entropy source (SAR ADC) is kept enabled by default at the time of application startup. .. only:: SOC_WIFI_SUPPORTED or SOC_IEEE802154_SUPPORTED or SOC_BT_SUPPORTED