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

add comment for sleep_retention_module_detach interface

Browse Source
This commit is contained in:
Li Shuai
2026-05-21 11:46:16 +08:00
committed by BOT
parent f01e818c40
commit 7b541be9d5
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
@@ -179,6 +179,23 @@ esp_err_t sleep_retention_module_free(sleep_retention_module_t module);
* - 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);
/**
* @brief Detach a module's sleep retention entries from the PMU REGDMA linked list
*
* After detachment, PMU REGDMA will no longer execute backup and restore
* operations for this module during the SoC system's light sleep. The
* retention entries are not freed and can be re-attached later via
* sleep_retention_module_attach().
*
* @param module the module number for the retention context to detach
*
* @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 detachment
* - ESP_ERR_NOT_ALLOWED if the module state is not allowed
* - ESP_ERR_INVALID_STATE if the module is not currently attached
*/
esp_err_t sleep_retention_module_detach(sleep_retention_module_t module);
/**