mirror of
https://github.com/espressif/esp-idf.git
synced 2024-09-20 00:36:01 -04:00
soc: Explain units for rtc_clk_cal() function, fix typo
This commit is contained in:
parent
75dede2344
commit
fa892eb017
@ -475,10 +475,10 @@ void rtc_dig_clk8m_enable(void);
|
|||||||
void rtc_dig_clk8m_disable(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`
|
* @param cal_val Average slow clock period in microseconds, fixed point value as returned from `rtc_clk_cal`
|
||||||
* @return The real value of the clock has been measured
|
* @return Frequency of the clock in Hz
|
||||||
*/
|
*/
|
||||||
uint32_t rtc_clk_freq_cal(uint32_t cal_val);
|
uint32_t rtc_clk_freq_cal(uint32_t cal_val);
|
||||||
|
|
||||||
|
@ -578,10 +578,10 @@ void rtc_dig_clk8m_enable(void);
|
|||||||
void rtc_dig_clk8m_disable(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`
|
* @param cal_val Average slow clock period in microseconds, fixed point value as returned from `rtc_clk_cal`
|
||||||
* @return The real value of the clock has been measured
|
* @return Frequency of the clock in Hz
|
||||||
*/
|
*/
|
||||||
uint32_t rtc_clk_freq_cal(uint32_t cal_val);
|
uint32_t rtc_clk_freq_cal(uint32_t cal_val);
|
||||||
|
|
||||||
|
@ -604,10 +604,10 @@ void rtc_dig_clk8m_enable(void);
|
|||||||
void rtc_dig_clk8m_disable(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`
|
* @param cal_val Average slow clock period in microseconds, fixed point value as returned from `rtc_clk_cal`
|
||||||
* @return The real value of the clock has been measured
|
* @return Frequency of the clock in Hz
|
||||||
*/
|
*/
|
||||||
uint32_t rtc_clk_freq_cal(uint32_t cal_val);
|
uint32_t rtc_clk_freq_cal(uint32_t cal_val);
|
||||||
|
|
||||||
|
@ -578,10 +578,10 @@ void rtc_dig_clk8m_enable(void);
|
|||||||
void rtc_dig_clk8m_disable(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`
|
* @param cal_val Average slow clock period in microseconds, fixed point value as returned from `rtc_clk_cal`
|
||||||
* @return The real value of the clock has been measured
|
* @return Frequency of the clock in Hz
|
||||||
*/
|
*/
|
||||||
uint32_t rtc_clk_freq_cal(uint32_t cal_val);
|
uint32_t rtc_clk_freq_cal(uint32_t cal_val);
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user