1 /*
2  * SPDX-FileCopyrightText: 2020-2024 Espressif Systems (Shanghai) CO LTD
3  *
4  * SPDX-License-Identifier: Apache-2.0
5  */
6 
7 // DO NOT USE THESE APIS IN ANY APPLICATIONS
8 // GDMA driver is not public for end users, but for ESP-IDF developers.
9 
10 #pragma once
11 
12 #include "esp_err.h"
13 
14 #ifdef __cplusplus
15 extern "C" {
16 #endif
17 
18 /**
19  * Initialize GDMA channel retention link for powerdown the TOP powerdomain during lightsleep
20  * @param  group_id Group id
21  * @param  pair_id  Pair id
22  * @return
23  *      - ESP_OK: Create DMA retention link successfully
24  *      - ESP_ERR_NO_MEM: Create DMA retention link failed because out of memory
25  */
26 esp_err_t gdma_sleep_retention_init(int group_id, int pair_id);
27 
28 
29 
30 /**
31  * Destroy GDMA channel retention link
32  * @param  group_id Group id
33  * @param  pair_id  Pair id
34  * @return always return ESP_OK
35  */
36 esp_err_t gdma_sleep_retention_deinit(int group_id, int pair_id);
37 
38 #ifdef __cplusplus
39 }
40 #endif
41