ESP-IDF
Select one of the symbols to view example projects that use it.
 
Outline
#include <stdint.h>
esp_clk_slowclk_cal_get();
esp_clk_slowclk_cal_set(uint32_t);
esp_clk_cpu_freq();
esp_clk_apb_freq();
esp_clk_xtal_freq();
esp_clk_rtc_time();
esp_clk_private_lock();
esp_clk_private_unlock();
Files
loading...
SourceVuESP-IDF Framework and ExamplesESP-IDFcomponents/esp_hw_support/include/esp_private/esp_clk.h
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
/* * SPDX-FileCopyrightText: 2015-2021 Espressif Systems (Shanghai) CO LTD * * SPDX-License-Identifier: Apache-2.0 *//* ... */ #pragma once #include <stdint.h> #ifdef __cplusplus extern "C" { #endif /** * @file esp_clk.h * * This file contains declarations of clock related functions. *//* ... */ /** * @brief Get the calibration value of RTC slow clock * * The value is in the same format as returned by rtc_clk_cal (microseconds, * in Q13.19 fixed-point format). * * @return the calibration value obtained using rtc_clk_cal, at startup time *//* ... */ uint32_t esp_clk_slowclk_cal_get(void); /** * @brief Update the calibration value of RTC slow clock * * The value has to be in the same format as returned by rtc_clk_cal (microseconds, * in Q13.19 fixed-point format). * This value is used by timekeeping functions (such as gettimeofday) to * calculate current time based on RTC counter value. * @param value calibration value obtained using rtc_clk_cal *//* ... */ void esp_clk_slowclk_cal_set(uint32_t value); /** * @brief Return current CPU clock frequency * When frequency switching is performed, this frequency may change. * However it is guaranteed that the frequency never changes with a critical * section. * * @return CPU clock frequency, in Hz *//* ... */ int esp_clk_cpu_freq(void); /** * @brief Return current APB clock frequency * * When frequency switching is performed, this frequency may change. * However it is guaranteed that the frequency never changes with a critical * section. * * @return APB clock frequency, in Hz *//* ... */ int esp_clk_apb_freq(void); /** * @brief Return frequency of the main XTAL * * Frequency of the main XTAL can be either auto-detected or set at compile * time (see CONFIG_XTAL_FREQ_SEL sdkconfig option). In both cases, this * function returns the actual value at run time. * * @return XTAL frequency, in Hz *//* ... */ int esp_clk_xtal_freq(void); /** * @brief Read value of RTC counter, converting it to microseconds * @attention The value returned by this function may change abruptly when * calibration value of RTC counter is updated via esp_clk_slowclk_cal_set * function. This should not happen unless application calls esp_clk_slowclk_cal_set. * In ESP-IDF, esp_clk_slowclk_cal_set is only called in startup code. * * @return Value or RTC counter, expressed in microseconds *//* ... */ uint64_t esp_clk_rtc_time(void); /** * @brief obtain internal critical section used esp_clk implementation. * * This is used by the esp_light_sleep_start() to avoid deadlocking when it * calls esp_clk related API after stalling the other CPU. *//* ... */ void esp_clk_private_lock(void); /** * @brief counterpart of esp_clk_private_lock *//* ... */ void esp_clk_private_unlock(void); #ifdef __cplusplus }{...} #endif
Details
Show:
from
Types: Columns: