mirror/rtic
1
0
Fork 0
mirror of https://github.com/rtic-rs/rtic.git synced 2025-12-19 22:35:19 +01:00
Code Issues Projects Releases Packages Wiki Activity

Docs: SW and HW tasks

Browse source
This commit is contained in:
Henrik Tjäder 2022-02-05 13:38:01 +01:00
parent 9f8248a0c9
commit a39d306649
2 changed files with 23 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

11
book/en/src/by-example/hardware_tasks.md
View file

@ -14,11 +14,18 @@ start execution in reaction to a hardware event.
Specifying a non-existing interrupt name will cause a compilation error. The interrupt names
are commonly defined by [PAC or HAL][pacorhal] crates.
Any available interrupt vector should work, but different hardware might have
added special properties to select interrupt priority levels, such as the
[nRF “softdevice”](https://github.com/rtic-rs/cortex-m-rtic/issues/434).
Beware of re-purposing interrupt vectors used internally by hardware features,
RTIC is unaware of such hardware specific details.
[pacorhal]: https://docs.rust-embedded.org/book/start/registers.html
[NVIC]: https://developer.arm.com/documentation/100166/0001/Nested-Vectored-Interrupt-Controller/NVIC-functional-description/NVIC-interrupts
The example below demonstrates the use of the `#[task]` attribute to declare an
interrupt handler.
The example below demonstrates the use of the `#[task(binds = InterruptName)]` attribute to declare a
hardware task bound to an interrupt handler.
``` rust
{{#include ../../../../examples/hardware.rs}}