aboutsummaryrefslogtreecommitdiff
path: root/book/en/src/by-example/hardware_tasks.md
diff options
context:
space:
mode:
authorbors[bot] <26634292+bors[bot]@users.noreply.github.com>2022-02-07 07:57:11 +0000
committerGitHub <noreply@github.com>2022-02-07 07:57:11 +0000
commit84a8225d11d597549878497185a66dd1620d2777 (patch)
tree8bd0e3d85b53f04e9b1722498b3655878350c3f3 /book/en/src/by-example/hardware_tasks.md
parent3bb41ab039960bf5defaad858115af4cc7e347a4 (diff)
parenta39d306649ebd7c6e99f5914bd5d6988a1705d4b (diff)
Merge #599
599: Docs: SW and HW tasks r=korken89 a=AfoHT Reword and (hopefully) clarify SW and HW tasks Closes #576 Co-authored-by: Henrik Tjäder <henrik@grepit.se>
Diffstat (limited to 'book/en/src/by-example/hardware_tasks.md')
-rw-r--r--book/en/src/by-example/hardware_tasks.md11
1 files changed, 9 insertions, 2 deletions
diff --git a/book/en/src/by-example/hardware_tasks.md b/book/en/src/by-example/hardware_tasks.md
index 30b88d0..7f8d3c6 100644
--- a/book/en/src/by-example/hardware_tasks.md
+++ b/book/en/src/by-example/hardware_tasks.md
@@ -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}}