alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-09-20 00:36:01 -04:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

soc: Explain units for rtc_clk_cal() function, fix typo

Browse Source
This commit is contained in:
Angus Gratton 2020-12-19 08:39:22 +11:00
parent 75dede2344
commit fa892eb017
4 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
components/soc/esp32/include/soc/rtc.h
View File

@ -475,10 +475,10 @@ void rtc_dig_clk8m_enable(void);
void rtc_dig_clk8m_disable(void);
/**
* @brief Caculate the real clock value after the clock calibration
* @brief Calculate the real clock value after the clock calibration
*
* @param cal_val average slow clock period in microseconds, can be return from `rtc_clk_cal`
* @return The real value of the clock has been measured
* @param cal_val Average slow clock period in microseconds, fixed point value as returned from `rtc_clk_cal`
* @return Frequency of the clock in Hz
*/
uint32_t rtc_clk_freq_cal(uint32_t cal_val);

6
components/soc/esp32c3/include/soc/rtc.h
View File

@ -578,10 +578,10 @@ void rtc_dig_clk8m_enable(void);
void rtc_dig_clk8m_disable(void);
/**
* @brief Caculate the real clock value after the clock calibration
* @brief Calculate the real clock value after the clock calibration
*
* @param cal_val average slow clock period in microseconds, can be return from `rtc_clk_cal`
* @return The real value of the clock has been measured
* @param cal_val Average slow clock period in microseconds, fixed point value as returned from `rtc_clk_cal`
* @return Frequency of the clock in Hz
*/
uint32_t rtc_clk_freq_cal(uint32_t cal_val);

6
components/soc/esp32s2/include/soc/rtc.h
View File

@ -604,10 +604,10 @@ void rtc_dig_clk8m_enable(void);
void rtc_dig_clk8m_disable(void);
/**
* @brief Caculate the real clock value after the clock calibration
* @brief Calculate the real clock value after the clock calibration
*
* @param cal_val average slow clock period in microseconds, can be return from `rtc_clk_cal`
* @return The real value of the clock has been measured
* @param cal_val Average slow clock period in microseconds, fixed point value as returned from `rtc_clk_cal`
* @return Frequency of the clock in Hz
*/
uint32_t rtc_clk_freq_cal(uint32_t cal_val);

6
components/soc/esp32s3/include/soc/rtc.h
View File

@ -578,10 +578,10 @@ void rtc_dig_clk8m_enable(void);
void rtc_dig_clk8m_disable(void);
/**
* @brief Caculate the real clock value after the clock calibration
* @brief Calculate the real clock value after the clock calibration
*
* @param cal_val average slow clock period in microseconds, can be return from `rtc_clk_cal`
* @return The real value of the clock has been measured
* @param cal_val Average slow clock period in microseconds, fixed point value as returned from `rtc_clk_cal`
* @return Frequency of the clock in Hz
*/
uint32_t rtc_clk_freq_cal(uint32_t cal_val);