• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Copyright 2020 Espressif Systems (Shanghai) PTE LTD
2 //
3 // Licensed under the Apache License, Version 2.0 (the "License");
4 // you may not use this file except in compliance with the License.
5 // You may obtain a copy of the License at
6 //
7 //     http://www.apache.org/licenses/LICENSE-2.0
8 //
9 // Unless required by applicable law or agreed to in writing, software
10 // distributed under the License is distributed on an "AS IS" BASIS,
11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 // See the License for the specific language governing permissions and
13 // limitations under the License.
14 
15 #include "soc/rtc.h"
16 
17 #ifdef __cplusplus
18 extern "C" {
19 #endif
20 
21 /**
22  * @brief This function is used to enable the digital 8m rtc clock,
23  *        to support the peripherals.
24  *
25  * @note If this function is called a number of times, the `periph_rtc_dig_clk8m_disable`
26  *       function needs to be called same times to disable.
27  *
28  * @return true: success for enable the rtc 8M clock, false: rtc 8M clock enable failed
29  */
30 bool periph_rtc_dig_clk8m_enable(void);
31 
32 /**
33  * @brief This function is used to disable the rtc digital clock, which should be called
34  *        with the `periph_rtc_dig_clk8m_enable` pairedly
35  *
36  * @note If this function is called a number of times, the `periph_rtc_dig_clk8m_disable`
37  *       function needs to be called same times to disable.
38  */
39 void periph_rtc_dig_clk8m_disable(void);
40 
41 /**
42  * @brief This function is used to get the real clock frequency value of the rtc clock
43  *
44  * @return The real clock value
45  */
46 uint32_t periph_rtc_dig_clk8m_get_freq(void);
47 
48 #ifdef __cplusplus
49 }
50 #endif
51