From a2ef45f252a664b84620d26b5aae7de1fe612b8b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mikolai=20G=C3=BCtschow?= Date: Mon, 18 Nov 2024 17:29:25 +0100 Subject: [PATCH] doc: mention auto_adjust in relevant section of porting-boards.md --- doc/doxygen/src/porting-boards.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/doc/doxygen/src/porting-boards.md b/doc/doxygen/src/porting-boards.md index f1e177a752..8e9a5fda4f 100644 --- a/doc/doxygen/src/porting-boards.md +++ b/doc/doxygen/src/porting-boards.md @@ -178,13 +178,13 @@ PROGRAMMER ?= openocd ## Timer Configurations {#board-timer-configurations} -When using high level timers, i.e. `ztimer` there is an overhead in calling -for @ref ztimer_sleep and @ref ztimer_set functions. This offset can be +When using the high level timer `ztimer` there is an overhead in calling +the @ref ztimer_sleep and @ref ztimer_set functions. This offset can be compensated for. It can be measured by running `tests/sys/ztimer_overhead` on your board, i.e: ```shell -$ BOARD=my-new-board make -C tests/sys/ztimer_overhead +$ BOARD=my-new-board make -C tests/sys/ztimer_overhead flash term main(): This is RIOT! ZTIMER_USEC auto_adjust params: ZTIMER_USEC->adjust_set = xx @@ -211,6 +211,10 @@ The last two lines can be added as defines to the new board `board.h`: /** @} */ ``` +Alternatively, the pseudomodule @ref pseudomodule_ztimer_auto_adjust can be used +in an application to enable automatic timer offset compensation at board startup. +This however incurs overhead both in the text segment and at bootup time. + ## doc.txt {#board-doc} Although not explicitly needed, if upstreamed and as a general good