kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-28 07:51:19 +01:00
Code Releases Activity

sys/xtimer: fix documentation about XTIMER_BACKOFF

Browse Source 
When XTIMER_BACKOFF is used by `_xtimer_set()`, `offset` has already
been converted to ticks.

So the documentation of the `xtimer_tsleepXX()` functions is correct,
however for `xtimer_usleep()` XTIMER_BACKOFF has to be converted to µs
to calculate the minimal sleep time.
This commit is contained in:
Benjamin Valentin 2019-12-04 02:49:18 +01:00
parent bd254dfc63
commit f24a874bac
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
sys/include/xtimer.h
View File

@ -142,7 +142,7 @@ static inline void xtimer_sleep(uint32_t seconds);
*
* When called from an ISR, this function will spin and thus block the MCU for
* the specified amount in microseconds, so only use it there for *very* short
* periods, e.g., less than XTIMER_BACKOFF.
* periods, e.g., less than XTIMER_BACKOFF converted to µs.
*
* @param[in] microseconds the amount of microseconds the thread should sleep
*/
@ -248,8 +248,8 @@ static inline void xtimer_set_wakeup64(xtimer_t *timer, uint64_t offset, kernel_
* ticks in the future.
*
* @warning BEWARE! Callbacks from xtimer_set() are being executed in interrupt
* context (unless offset < XTIMER_BACKOFF). DON'T USE THIS FUNCTION unless you
* know *exactly* what that means.
* context (unless offset < XTIMER_BACKOFF converted to µs).
* DON'T USE THIS FUNCTION unless you know *exactly* what that means.
*
* @param[in] timer the timer structure to use.
* Its xtimer_t::target and xtimer_t::long_target
@ -269,8 +269,8 @@ static inline void xtimer_set(xtimer_t *timer, uint32_t offset);
* microseconds in the future.
*
* @warning BEWARE! Callbacks from xtimer_set() are being executed in interrupt
* context (unless offset < XTIMER_BACKOFF). DON'T USE THIS FUNCTION unless you
* know *exactly* what that means.
* context (unless offset < XTIMER_BACKOFF converted to µs).
* DON'T USE THIS FUNCTION unless you know *exactly* what that means.
*
* @param[in] timer the timer structure to use.
* Its xtimer_t::target and xtimer_t::long_target
@ -478,7 +478,7 @@ static inline int xtimer_msg_receive_timeout64(msg_t *msg, uint64_t timeout);
/**
* @brief xtimer backoff value
*
* All timers that are less than XTIMER_BACKOFF microseconds in the future will
* All timers that are less than XTIMER_BACKOFF ticks in the future will
* just spin.
*
* This is supposed to be defined per-device in e.g., periph_conf.h.