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 'bugfix/docs_update_deep_sleep_note' into 'master'

Browse Source 
add a note for deep sleep crc check

Closes DOC-665

See merge request espressif/esp-idf!15686
This commit is contained in:
Krzysztof Budzynski 2021-12-20 05:25:14 +00:00
commit 18978cc1c2
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/en/api-guides/deep-sleep-stub.rst
View File

@ -100,3 +100,18 @@ For example, the equivalent example in ``rtc_wake_stub_counter.c``::
The second way is a better option if you need to use strings, or write other more complex code.
To reduce wake-up time use the `CONFIG_BOOTLOADER_SKIP_VALIDATE_IN_DEEP_SLEEP` Kconfig option, see more information in :doc:`Fast boot from Deep Sleep <bootloader>`.
CRC Check For Wake Stubs
------------------------
.. only:: SOC_PM_SUPPORT_DEEPSLEEP_VERIFY_STUB_ONLY
During deep sleep, only the wake stubs area of RTC Fast memory is validated with CRC. When {IDF_TARGET_NAME} wakes up from deep sleep, the wake stubs area is validated again. If the validation passes, the wake stubs code will be executed. Otherwise, the normal initialization, bootloader, and esp-idf codes will be executed.
.. only:: not SOC_PM_SUPPORT_DEEPSLEEP_VERIFY_STUB_ONLY
During deep sleep, all RTC Fast memory areas will be validated with CRC. When {IDF_TARGET_NAME} wakes up from deep sleep, the RTC fast memory will be validated with CRC again. If the validation passes, the wake stubs code will be executed. Otherwise, the normal initialization, bootloader and esp-idf codes will be executed.
.. note::
When the `CONFIG_ESP_SYSTEM_ALLOW_RTC_FAST_MEM_AS_HEAP` option is enabled, all the RTC fast memory except the wake stubs area is added to the heap.