kaspar/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2025-12-17 18:43:50 +01:00
Code Releases Activity

sys/include/ztimer: document CONFIG_ZTIMER_USEC_ADJUST_%

Browse Source
This commit is contained in:
Francisco Molina 2022-02-09 14:27:13 +01:00
parent 726c461cb5
commit 2005ba53f5
1 changed files with 24 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
sys/include/ztimer/config.h
View File

@ -136,6 +136,30 @@ extern "C" {
# endif
#endif
/**
* @brief An offset for ZTIMER_USEC allowing to compensate for the offset
* of @ref ztimer_set(). It can be measured with @ref ztimer_overhead_set()
*
* This value should be configured in the board.h.
*
*/
#ifndef CONFIG_ZTIMER_USEC_ADJUST_SET
#define CONFIG_ZTIMER_USEC_ADJUST_SET 0
#endif
/**
* @brief An offset for ZTIMER_USEC allowing to compentsate for the offset
* of @ref ztimer_sleep().
*
* @note As internally @ref ztimer_sleep() uses @ref ztimer_set()
* @ref CONFIG_ZTIMER_USEC_ADJUST_SET should be tuned before.
*
* This value should be configured in the board.h.
*/
#ifndef CONFIG_ZTIMER_USEC_ADJUST_SLEEP
#define CONFIG_ZTIMER_USEC_ADJUST_SLEEP 0
#endif
#ifdef __cplusplus
}
#endif