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

periph/timer: Document that set_absolute is expected to wrap

Browse Source 
Most timers are implemented this way already, and keeping (documenting)
it that way allows the generic timer_set implementation to stay as
simple as it is.
This commit is contained in:
chrysn 2020-09-23 10:36:12 +02:00
parent dcb25eb3fc
commit d8d56e5e3a
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -149,6 +149,9 @@ int timer_set(tim_t dev, int channel, unsigned int timeout);
/** /**
* @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
* *
* Timers that are less wide than `unsigned int` accept and truncate overflown
* values.
*
* @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