diff options
| author | bors[bot] <26634292+bors[bot]@users.noreply.github.com> | 2020-11-12 17:48:54 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-11-12 17:48:54 +0000 |
| commit | c6a8477b9b0a9f848f5308b670cf335bd98f6590 (patch) | |
| tree | f6f16fd6c187afe5c2ee1065b266569b4a7bb596 /book/en/src/by-example | |
| parent | 5b8b2383e1c9128303410c76c1be2ca5db947ff9 (diff) | |
| parent | d25017a59cfd7a59019e7b8cc2724e8353df1221 (diff) | |
Merge #407
407: Fixed spawn and timer queue docs r=AfoHT a=korken89
Co-authored-by: Emil Fresk <emil.fresk@gmail.com>
Diffstat (limited to 'book/en/src/by-example')
| -rw-r--r-- | book/en/src/by-example/tasks.md | 6 | ||||
| -rw-r--r-- | book/en/src/by-example/timer-queue.md | 4 |
2 files changed, 3 insertions, 7 deletions
diff --git a/book/en/src/by-example/tasks.md b/book/en/src/by-example/tasks.md index ba16404..8558a54 100644 --- a/book/en/src/by-example/tasks.md +++ b/book/en/src/by-example/tasks.md @@ -6,15 +6,13 @@ application from any execution context. Software tasks can also be assigned priorities and, under the hood, are dispatched from interrupt handlers. RTIC requires that free interrupts are -declared in an `extern` block when using software tasks; some of these free +declared in the `dispatchers` app argument when using software tasks; some of these free interrupts will be used to dispatch the software tasks. An advantage of software tasks over hardware tasks is that many tasks can be mapped to a single interrupt handler. Software tasks are also declared using the `task` attribute but the `binds` -argument must be omitted. To be able to spawn a software task from a context -the name of the task must appear in the `spawn` argument of the context -attribute (`init`, `idle`, `task`, etc.). +argument must be omitted. The example below showcases three software tasks that run at 2 different priorities. The three software tasks are mapped to 2 interrupts handlers. diff --git a/book/en/src/by-example/timer-queue.md b/book/en/src/by-example/timer-queue.md index 482aebc..2964175 100644 --- a/book/en/src/by-example/timer-queue.md +++ b/book/en/src/by-example/timer-queue.md @@ -29,9 +29,7 @@ on the built-in CYCle CouNTer (CYCCNT). Note that this is a 32-bit timer clocked at the frequency of the CPU and as such it is not suitable for tracking time spans in the order of seconds. -To be able to schedule a software task from a context the name of the task must -first appear in the `schedule` argument of the context attribute. When -scheduling a task the (user-defined) `Instant` at which the task should be +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 |