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

Updated documentation to include the critical section token in init

Browse source
This commit is contained in:
Emil Fresk 2020-10-03 15:30:15 +02:00
parent 97eae45fa5
commit f0f982faca
2 changed files with 8 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

7
book/en/src/by-example/app.md
View file

@ -33,15 +33,16 @@ required).
This initialization function will be the first part of the application to run.
The `init` function will run *with interrupts disabled* and has exclusive access
to Cortex-M and, optionally, device specific peripherals through the `core` and
`device` fields of `init::Context`.
to Cortex-M where the `bare_metal::CriticalSection` token is available as `cs`.
And optionally, device specific peripherals through the `core` and `device` fields
of `init::Context`.
`static mut` variables declared at the beginning of `init` will be transformed
into `&'static mut` references that are safe to access.
[`rtic::Peripherals`]: ../../api/rtic/struct.Peripherals.html
The example below shows the types of the `core` and `device` fields and
The example below shows the types of the `core`, `device` and `cs` fields, and
showcases safe access to a `static mut` variable. The `device` field is only
available when the `peripherals` argument is set to `true` (it defaults to
`false`).