riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #15017 from benpicco/periph/timer-doc-fix

Browse Source 
drivers/periph/timer: amend documentation for timer_set_periodic()
This commit is contained in:
Francisco 2020-09-13 21:30:47 +02:00 committed by GitHub
commit a301e81b47
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
drivers/include/periph/timer.h
View File

@ -160,12 +160,14 @@ int timer_set(tim_t dev, int channel, unsigned int timeout);
int timer_set_absolute(tim_t dev, int channel, unsigned int value); int timer_set_absolute(tim_t dev, int channel, unsigned int value);
/** /**
* @brief Set an absolute timeout value for the given channel of the given timer * @brief Set an absolute timeout value for the given channel of the given timer.
* The timeout will be called periodically for each iteration * The timeout will be called periodically for each iteration.
* *
* @note Only one channel with `TIM_FLAG_RESET_ON_MATCH` can be active. * @note Only one channel with `TIM_FLAG_RESET_ON_MATCH` can be active.
* Some platforms (Atmel) only allow to use the first channel as TOP value. * Some platforms (Atmel) only allow to use the first channel as TOP value.
* *
* @note Needs to be enabled with `FEATURES_REQUIRED += periph_timer_periodic`.
*
* @param[in] dev the timer device to set * @param[in] dev the timer device to set
* @param[in] channel the channel to set * @param[in] channel the channel to set
* @param[in] value the absolute compare value when the callback will be * @param[in] value the absolute compare value when the callback will be