Skip to content

Commit d79f0a5

Browse files
doc: nrf-bm: libraries: timer: updates to BM timer documentation
Updates to BM timer documentation. Signed-off-by: Eivind Jølsgard <eivind.jolsgard@nordicsemi.no>
1 parent fc1a083 commit d79f0a5

1 file changed

Lines changed: 7 additions & 12 deletions

File tree

doc/nrf-bm/libraries/timer.rst

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,18 @@
11
.. _lib_bm_timer:
22

3-
Timer library
4-
#############
3+
Bare Metal Timer library
4+
########################
55

66
.. contents::
77
:local:
88
:depth: 2
99

10-
The timer library allows the application to create multiple timer instances.
10+
The Bare Metal (BM) Timer library provides a wrapper around Zephyr's Timers functionality, utilizing the GRTC peripheral.
1111

12-
Functions such as starting and stopping timers, checking for timeouts, and invoking user-defined timeout handlers are all managed within the GRTC interrupt handler.
12+
The BM Timer has a resolution of 1 µs and can run in all power modes.
13+
This allows for waking up the system after a specific period or at specific intervals, independent of power modes.
14+
The BM Timer allows the application to create multiple timer instances, each with dedicated, user defined timeout handlers.
15+
The timers can be individually started and stopped.
1316

1417
Configuration
1518
*************
@@ -41,14 +44,6 @@ The library provides macros to convert standard time units to ticks:
4144
* :c:macro:`BM_TIMER_US_TO_TICKS` - Converts microseconds to ticks.
4245
* :c:macro:`BM_TIMER_MS_TO_TICKS` - Converts milliseconds to ticks.
4346

44-
The timer library is using the GRTC peripheral, available in all power modes including ``System OFF``.
45-
The GRTC peripheral has a resolution of 1 microsecond.
46-
47-
.. note::
48-
49-
The timer accuracy is reduced in low power mode.
50-
The low frequency clock source, running 32.768 kHz, provides a clock tick approximately every 30.5 microseconds.
51-
5247
To stop a timer, call the :c:func:`bm_timer_stop` function.
5348

5449
Sample

0 commit comments

Comments
 (0)