Skip to content

Commit a2ef45f

Browse files
committed
doc: mention auto_adjust in relevant section of porting-boards.md
1 parent 28ec1c5 commit a2ef45f

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

doc/doxygen/src/porting-boards.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -178,13 +178,13 @@ PROGRAMMER ?= openocd
178178

179179
## Timer Configurations {#board-timer-configurations}
180180

181-
When using high level timers, i.e. `ztimer` there is an overhead in calling
182-
for @ref ztimer_sleep and @ref ztimer_set functions. This offset can be
181+
When using the high level timer `ztimer` there is an overhead in calling
182+
the @ref ztimer_sleep and @ref ztimer_set functions. This offset can be
183183
compensated for. It can be measured by running `tests/sys/ztimer_overhead`
184184
on your board, i.e:
185185

186186
```shell
187-
$ BOARD=my-new-board make -C tests/sys/ztimer_overhead
187+
$ BOARD=my-new-board make -C tests/sys/ztimer_overhead flash term
188188
main(): This is RIOT!
189189
ZTIMER_USEC auto_adjust params:
190190
ZTIMER_USEC->adjust_set = xx
@@ -211,6 +211,10 @@ The last two lines can be added as defines to the new board `board.h`:
211211
/** @} */
212212
```
213213

214+
Alternatively, the pseudomodule @ref pseudomodule_ztimer_auto_adjust can be used
215+
in an application to enable automatic timer offset compensation at board startup.
216+
This however incurs overhead both in the text segment and at bootup time.
217+
214218
## doc.txt {#board-doc}
215219

216220
Although not explicitly needed, if upstreamed and as a general good

0 commit comments

Comments
 (0)