mirror/rtic
1
0
Fork 0
mirror of https://github.com/rtic-rs/rtic.git synced 2024-11-23 20:22:51 +01:00
Code Issues Projects Releases Packages Wiki Activity

Fixed spawn and timer queue docs

Browse source
This commit is contained in:
Emil Fresk 2020-11-12 18:42:07 +01:00
parent 5b8b2383e1
commit d25017a59c
2 changed files with 3 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
book/en/src/by-example/tasks.md
View file

@ -6,15 +6,13 @@ application from any execution context.
Software tasks can also be assigned priorities and, under the hood, are Software tasks can also be assigned priorities and, under the hood, are
dispatched from interrupt handlers. RTIC requires that free interrupts 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 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 tasks over hardware tasks is that many tasks can be mapped to a single interrupt
handler. handler.
Software tasks are also declared using the `task` attribute but the `binds` 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 argument must be omitted.
the name of the task must appear in the `spawn` argument of the context
attribute (`init`, `idle`, `task`, etc.).
The example below showcases three software tasks that run at 2 different The example below showcases three software tasks that run at 2 different
priorities. The three software tasks are mapped to 2 interrupts handlers. priorities. The three software tasks are mapped to 2 interrupts handlers.

4
book/en/src/by-example/timer-queue.md
View file

@ -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 at the frequency of the CPU and as such it is not suitable for tracking time
spans in the order of seconds. spans in the order of seconds.
To be able to schedule a software task from a context the name of the task must When scheduling a task the (user-defined) `Instant` at which the task should be
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. executed must be passed as the first argument of the `schedule` invocation.
Additionally, the chosen `monotonic` timer must be configured and initialized Additionally, the chosen `monotonic` timer must be configured and initialized