Skip to content

Commit 41b37f8

Browse files
AdityaHPatwardhanmahavirj
authored andcommitted
feat(docs): Added svg file for the RNG
1 parent d2cd0e7 commit 41b37f8

File tree

5 files changed

+138
-6
lines changed

5 files changed

+138
-6
lines changed
-38.6 KB
Binary file not shown.
Lines changed: 77 additions & 0 deletions
Loading
-36.2 KB
Binary file not shown.
Lines changed: 57 additions & 0 deletions
Loading

docs/en/api-reference/system/random.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,12 @@ The following digram shows the noise sources for the RNG on the {IDF_TARGET_NAME
2626

2727
.. only:: SOC_WIFI_SUPPORTED or SOC_IEEE802154_SUPPORTED or SOC_BT_SUPPORTED
2828

29-
.. image:: /../_static/esp_rng_noise_source_rf_available.png
30-
:scale: 80 %
29+
.. image:: /../_static/esp_rng_noise_source_rf_available.svg
3130
:align: center
3231

3332
.. only:: not SOC_WIFI_SUPPORTED and not SOC_IEEE802154_SUPPORTED and not SOC_BT_SUPPORTED
3433

35-
.. image:: /../_static/esp_rng_noise_source_rf_unavailable.png
36-
:scale: 80 %
34+
.. image:: /../_static/esp_rng_noise_source_rf_unavailable.svg
3735
:align: center
3836

3937
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
5553
Enabling RF subsystem
5654
---------------------
5755

58-
The RF subsystem can be enabled with help of the following APIs:
56+
The RF subsystem can be enabled with help of one of the following APIs:
5957

6058
.. list::
6159

@@ -71,7 +69,7 @@ During startup, the ESP-IDF bootloader temporarily enables the non-RF internal e
7169

7270
.. only:: not SOC_WIFI_SUPPORTED and not SOC_IEEE802154_SUPPORTED and not SOC_BT_SUPPORTED
7371

74-
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.
72+
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.
7573

7674
.. only:: SOC_WIFI_SUPPORTED or SOC_IEEE802154_SUPPORTED or SOC_BT_SUPPORTED
7775

0 commit comments

Comments
 (0)