HardwareTimer: getTimerClkFreq() add comment to avoid confusion

Signed-off-by: Alexandre Bourdiol <alexandre.bourdiol@st.com>
stm32duino · Jul 7, 2020 · 73633eb · 73633eb
1 parent 348fdc4
commit 73633eb
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/cores/arduino/HardwareTimer.cpp b/cores/arduino/HardwareTimer.cpp
@@ -1300,6 +1300,7 @@ uint32_t HardwareTimer::getTimerClkFreq()
       /* case RCC_APB2_DIV1: */
       case RCC_APB2_DIV2:
       case RCC_APB2_DIV4:
+        /* Note: in such cases, HCLK = (APBCLK * DIVx) */
         uwTimclock = HAL_RCC_GetHCLKFreq();
         break;
       case RCC_APB1_DIV8:
@@ -1316,7 +1317,7 @@ uint32_t HardwareTimer::getTimerClkFreq()
       case RCC_APB1_DIV2:
       /* case RCC_APB2_DIV1: */
       case RCC_APB2_DIV2:
-        // uwTimclock*=1;
+        /* Note: in such cases, HCLK = (APBCLK * DIVx) */
         uwTimclock = HAL_RCC_GetHCLKFreq();
         break;
       case RCC_APB1_DIV4:
@@ -1349,6 +1350,7 @@ uint32_t HardwareTimer::getTimerClkFreq()
       case RCC_HCLK_DIV1:
       case RCC_HCLK_DIV2:
       case RCC_HCLK_DIV4:
+        /* Note: in such cases, HCLK = (APBCLK * DIVx) */
         uwTimclock = HAL_RCC_GetHCLKFreq();
         break;
       case RCC_HCLK_DIV8: