RIOT-OS/RIOT
RIOT-OS/RIOT
1
0
Fork 0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-13 08:40:26 +01:00
Code Releases Activity

doc: mention auto_adjust in relevant section of porting-boards.md

Browse Source
This commit is contained in:
Mikolai Gütschow 2024-11-18 17:29:25 +01:00
parent 28ec1c5d2e
commit a2ef45f252
No known key found for this signature in database
GPG Key ID: 943E2F37AA659AD5
1 changed files with 7 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/doxygen/src/porting-boards.md
View File

@ -178,13 +178,13 @@ PROGRAMMER ?= openocd
## Timer Configurations {#board-timer-configurations} ## Timer Configurations {#board-timer-configurations}
When using high level timers, i.e. `ztimer` there is an overhead in calling When using the high level timer `ztimer` there is an overhead in calling
for @ref ztimer_sleep and @ref ztimer_set functions. This offset can be 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` compensated for. It can be measured by running `tests/sys/ztimer_overhead`
on your board, i.e: on your board, i.e:
```shell ```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! main(): This is RIOT!
ZTIMER_USEC auto_adjust params: ZTIMER_USEC auto_adjust params:
ZTIMER_USEC->adjust_set = xx 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} ## doc.txt {#board-doc}
Although not explicitly needed, if upstreamed and as a general good Although not explicitly needed, if upstreamed and as a general good