From afe4d5b2f10a75e2b32d07a38d5ca00f7ddb6c30 Mon Sep 17 00:00:00 2001 From: Alexandre Bourdiol Date: Thu, 29 Aug 2019 11:27:03 +0200 Subject: [PATCH] Add comment on refresh() function usage By the way fixo typo in setPrescaleFactor() Fix #617 --- cores/arduino/HardwareTimer.cpp | 2 ++ cores/arduino/HardwareTimer.h | 5 ++++- 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/cores/arduino/HardwareTimer.cpp b/cores/arduino/HardwareTimer.cpp index 86d279591c..d065e12e28 100644 --- a/cores/arduino/HardwareTimer.cpp +++ b/cores/arduino/HardwareTimer.cpp @@ -688,6 +688,8 @@ void HardwareTimer::detachInterrupt(uint32_t channel) /** * @brief Generate an update event to force all registers (Autoreload, prescaler, compare) to be taken into account + * @note Refresh() can only be called after a 1st call to resume() to be sure timer is initialised. + * It is usefull while timer is running after some registers update * @retval None */ void HardwareTimer::refresh() diff --git a/cores/arduino/HardwareTimer.h b/cores/arduino/HardwareTimer.h index 7ad5c62448..45036bb4f2 100644 --- a/cores/arduino/HardwareTimer.h +++ b/cores/arduino/HardwareTimer.h @@ -93,7 +93,7 @@ class HardwareTimer { void pause(void); // Pause counter and all output channels void resume(void); // Resume counter and all output channels - void setPrescaleFactor(uint32_t format = TICK_FORMAT); // set prescaler register (which is factor value - 1) + void setPrescaleFactor(uint32_t prescaler); // set prescaler register (which is factor value - 1) uint32_t getPrescaleFactor(); void setOverflow(uint32_t val, TimerFormat_t format = TICK_FORMAT); // set AutoReload register depending on format provided @@ -122,8 +122,11 @@ class HardwareTimer { void timerHandleDeinit(); // Timer deinitialization + // Refresh() can only be called after a 1st call to resume() to be sure timer is initialised. + // It is usefull while timer is running after some registers update void refresh(void); // Generate update event to force all registers (Autoreload, prescaler, compare) to be taken into account + uint32_t getTimerClkFreq(); // return timer clock frequency in Hz. static void captureCompareCallback(TIM_HandleTypeDef *htim); // Generic Caputre and Compare callback which will call user callback