Mirrors/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2026-10-02 11:10:54 +03:00
Code Issues Packages Projects Releases Wiki Activity

add comment for sleep_retention_module_attach interface

Browse Source
This commit is contained in:
Li Shuai
2026-05-21 11:46:16 +08:00
committed by BOT
parent 36b9f73e11
commit f01e818c40
1 changed files with 17 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
components/esp_hw_support/include/esp_private/sleep_retention.h
+17
View File
@@ -161,6 +161,23 @@ esp_err_t sleep_retention_module_allocate(sleep_retention_module_t module);
*/
esp_err_t sleep_retention_module_free(sleep_retention_module_t module);
/**
* @brief Attach a module's sleep retention entries to the PMU REGDMA linked list
*
* After attachment, PMU REGDMA will execute backup and restore operations for
* this module during the SoC system's light sleep. The module must have been
* initialized with SLEEP_RETENTION_MODULE_ATTR_ATTACH attribute and its
* retention entries must have been allocated before calling this function.
*
* @param module the module number for the retention context to attach
*
* @return
* - ESP_OK on success
* - ESP_ERR_INVALID_ARG if the module is not valid or not initialized with attach attribute
* - ESP_ERR_NOT_SUPPORTED if the module does not support attachment
* - ESP_ERR_NOT_ALLOWED if the module state is not allowed
* - ESP_ERR_INVALID_STATE if the module's retention entries have not been allocated
*/
esp_err_t sleep_retention_module_attach(sleep_retention_module_t module);
esp_err_t sleep_retention_module_detach(sleep_retention_module_t module);