aboutsummaryrefslogtreecommitdiff
path: root/book
diff options
context:
space:
mode:
authorJorge Aparicio <jorge@japaric.io>2019-10-15 18:44:49 -0500
committerJorge Aparicio <jorge@japaric.io>2019-10-15 18:44:49 -0500
commiteef4e7bf7908d2a99c8d797d6f9d2ac3717e2b63 (patch)
tree1d2a7d49ce5443fcc06ab7cad39c7c8907789a70 /book
parent6196984d6d75be987d3dec3bf17909e3cd40c15b (diff)
more monotonic timer docs
covers - initialization and configuration of the timer; this is now a responsibility of the application author - correctness of `Monotonic::now()` in `#[init]` - safety of `Monotonic::reset()` closes #251
Diffstat (limited to 'book')
-rw-r--r--book/en/src/by-example/timer-queue.md4
1 files changed, 4 insertions, 0 deletions
diff --git a/book/en/src/by-example/timer-queue.md b/book/en/src/by-example/timer-queue.md
index 7c8be38..fb41512 100644
--- a/book/en/src/by-example/timer-queue.md
+++ b/book/en/src/by-example/timer-queue.md
@@ -34,6 +34,10 @@ first appear in the `schedule` argument of the context attribute. When
scheduling a task the (user-defined) `Instant` at which the task should be
executed must be passed as the first argument of the `schedule` invocation.
+Additionally, the chosen `monotonic` timer must be configured and initialized
+during the `#[init]** phase. Note that this is *also* the case if you choose to
+use the `CYCCNT` provided by the `cortex-m-rtfm` crate.
+
The example below schedules two tasks from `init`: `foo` and `bar`. `foo` is
scheduled to run 8 million clock cycles in the future. Next, `bar` is scheduled
to run 4 million clock cycles in the future. Thus `bar` runs before `foo` since