diff options
| author | bors[bot] <26634292+bors[bot]@users.noreply.github.com> | 2021-09-25 17:09:54 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-25 17:09:54 +0000 |
| commit | f0c319982524988fa67cac3c59a4a4a863c409c9 (patch) | |
| tree | de4cbe4b43d399d4dcf2021c33225ccd00627434 /book/en/src/by-example/hardware_tasks.md | |
| parent | c8621d78b9b1c0c67dff31404ade873a9d7b426e (diff) | |
| parent | b71df58f2fb4ed85d4c8cf806d5837ce63c73f31 (diff) | |
Merge #528
528: The great 0.6 docs update r=AfoHT a=korken89
Closes #530
Closes #527
Closes #487
Closes #461
Closes #448
Closes #440
Closes #422
Co-authored-by: Emil Fresk <emil.fresk@gmail.com>
Diffstat (limited to 'book/en/src/by-example/hardware_tasks.md')
| -rw-r--r-- | book/en/src/by-example/hardware_tasks.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/book/en/src/by-example/hardware_tasks.md b/book/en/src/by-example/hardware_tasks.md new file mode 100644 index 0000000..5f7b26f --- /dev/null +++ b/book/en/src/by-example/hardware_tasks.md @@ -0,0 +1,24 @@ +# Hardware tasks + +To declare interrupt handlers the `#[task]` attribute takes a `binds = InterruptName` argument whose +value is the name of the interrupt to which the handler will be bound to; the +function used with this attribute becomes the interrupt handler. Within the +framework these type of tasks are referred to as *hardware* tasks, because they +start executing in reaction to a hardware event. + +Providing an interrupt name that does not exist will cause a compile error to help with accidental +errors. + +The example below demonstrates the use of the `#[task]` attribute to declare an +interrupt handler. Like in the case of `#[init]` and `#[idle]` local `static +mut` variables are safe to use within a hardware task. + +``` rust +{{#include ../../../../examples/hardware.rs}} +``` + +``` console +$ cargo run --target thumbv7m-none-eabi --example hardware +{{#include ../../../../ci/expected/hardware.run}} +``` + |
