Skip to content

HardwareTimer: update function header and parameter description #1431

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 25, 2021
Merged

HardwareTimer: update function header and parameter description #1431

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 8 additions & 12 deletions cores/arduino/HardwareTimer.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -826,7 +826,7 @@ void HardwareTimer::setCaptureCompare(uint32_t channel, uint32_t compare, TimerC
* TICK_FORMAT: return value is the number of tick for Capture/Compare value
* MICROSEC_FORMAT: return value is the number of microsecondes for Capture/Compare value
* HERTZ_FORMAT: return value is the frequency in hertz for Capture/Compare value
* @retval None
* @retval Capture/Compare value
*/
uint32_t HardwareTimer::getCaptureCompare(uint32_t channel, TimerCompareFormat_t format)
{
Expand Down Expand Up @@ -880,10 +880,8 @@ uint32_t HardwareTimer::getCaptureCompare(uint32_t channel, TimerCompareFormat_
* @param pin: Arduino pin number, ex D1, 1 or PA1
* @param frequency: PWM frequency expessed in hertz
* @param dutycycle: PWM dutycycle expressed in percentage
* @param format of return value. If ommited default format is Tick
* TICK_FORMAT: return value is the number of tick for Capture/Compare value
* MICROSEC_FORMAT: return value is the number of microsecondes for Capture/Compare value
* HERTZ_FORMAT: return value is the frequency in hertz for Capture/Compare value
* @param PeriodCallback: timer period callback (timer rollover upon udate event)
* @param CompareCallback: timer compare callback
* @retval None
*/
void HardwareTimer::setPWM(uint32_t channel, uint32_t pin, uint32_t frequency, uint32_t dutycycle, callback_function_t PeriodCallback, callback_function_t CompareCallback)
Expand All @@ -897,10 +895,8 @@ void HardwareTimer::setPWM(uint32_t channel, uint32_t pin, uint32_t frequency, u
* @param pin: pin name, ex PB_0
* @param frequency: PWM frequency expessed in hertz
* @param dutycycle: PWM dutycycle expressed in percentage
* @param format of return value. If ommited default format is Tick
* TICK_FORMAT: return value is the number of tick for Capture/Compare value
* MICROSEC_FORMAT: return value is the number of microsecondes for Capture/Compare value
* HERTZ_FORMAT: return value is the frequency in hertz for Capture/Compare value
* @param PeriodCallback: timer period callback (timer rollover upon udate event)
* @param CompareCallback: timer compare callback
* @retval None
*/
void HardwareTimer::setPWM(uint32_t channel, PinName pin, uint32_t frequency, uint32_t dutycycle, callback_function_t PeriodCallback, callback_function_t CompareCallback)
Expand Down Expand Up @@ -1142,7 +1138,7 @@ HardwareTimer::~HardwareTimer()
/**
* @brief return timer index from timer handle
* @param htim : one of the defined timer
* @retval None
* @retval timer index
*/
timer_index_t get_timer_index(TIM_TypeDef *instance)
{
Expand Down Expand Up @@ -1263,7 +1259,7 @@ timer_index_t get_timer_index(TIM_TypeDef *instance)

/**
* @brief This function return the timer clock frequency.
* @param tim: timer instance
* @param None
* @retval frequency in Hz
*/
uint32_t HardwareTimer::getTimerClkFreq()
Expand Down Expand Up @@ -1395,7 +1391,7 @@ uint32_t HardwareTimer::getTimerClkFreq()

/**
* @brief This function will reset the timer
* @param obj : Hardware timer instance ex: Timer6, ...
* @param None
* @retval None
*/
void HardwareTimer::timerHandleDeinit()
Expand Down