From fa892eb01757f8575a9963579362b0f95217e8a3 Mon Sep 17 00:00:00 2001 From: Angus Gratton Date: Sat, 19 Dec 2020 08:39:22 +1100 Subject: [PATCH] soc: Explain units for rtc_clk_cal() function, fix typo --- components/soc/esp32/include/soc/rtc.h | 6 +++--- components/soc/esp32c3/include/soc/rtc.h | 6 +++--- components/soc/esp32s2/include/soc/rtc.h | 6 +++--- components/soc/esp32s3/include/soc/rtc.h | 6 +++--- 4 files changed, 12 insertions(+), 12 deletions(-) diff --git a/components/soc/esp32/include/soc/rtc.h b/components/soc/esp32/include/soc/rtc.h index 7b09fde1eb..6efffc0203 100644 --- a/components/soc/esp32/include/soc/rtc.h +++ b/components/soc/esp32/include/soc/rtc.h @@ -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); diff --git a/components/soc/esp32c3/include/soc/rtc.h b/components/soc/esp32c3/include/soc/rtc.h index 3eafc77c1f..e6700f374f 100644 --- a/components/soc/esp32c3/include/soc/rtc.h +++ b/components/soc/esp32c3/include/soc/rtc.h @@ -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); diff --git a/components/soc/esp32s2/include/soc/rtc.h b/components/soc/esp32s2/include/soc/rtc.h index 2474c67bae..0ea0716e6d 100644 --- a/components/soc/esp32s2/include/soc/rtc.h +++ b/components/soc/esp32s2/include/soc/rtc.h @@ -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); diff --git a/components/soc/esp32s3/include/soc/rtc.h b/components/soc/esp32s3/include/soc/rtc.h index 0287081d69..be79674509 100644 --- a/components/soc/esp32s3/include/soc/rtc.h +++ b/components/soc/esp32s3/include/soc/rtc.h @@ -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);