diff options
Diffstat (limited to 'book/en/src/by-example/app_init.md')
| -rw-r--r-- | book/en/src/by-example/app_init.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/book/en/src/by-example/app_init.md b/book/en/src/by-example/app_init.md new file mode 100644 index 0000000..7a73e1b --- /dev/null +++ b/book/en/src/by-example/app_init.md @@ -0,0 +1,28 @@ +# App initialization and `#[init]` + +An RTIC application is required an `init` task setting up the system. The corresponding function must have the signature `fn(init::Context) -> (Shared, Local, init::Monotonics)`, where `Shared` and `Local` are the resource structures defined by the user. + +On system reset, the `init` task is executed (after the optionally defined `pre-init` and internal RTIC initialization). The `init` task runs *with interrupts disabled* and has exclusive access to Cortex-M (the `bare_metal::CriticalSection` token is available as `cs`) while device specific peripherals are available through the `core` and `device` fields of `init::Context`. + +## Example + +The example below shows the types of the `core`, `device` and `cs` fields, and showcases the use of a `local` variable with `'static` lifetime. As we will see later, such variables can later be delegated from `init` to other tasks of the RTIC application. + +The `device` field is only available when the `peripherals` argument is set to `true` (which is the default). In the rare case you want to implement an ultra-slim application you can explicitly set `peripherals` to `false`. + +``` rust +{{#include ../../../../examples/init.rs}} +``` + +Running the example will print `init` to the console and then exit the QEMU process. + +``` console +$ cargo run --target thumbv7m-none-eabi --example init +{{#include ../../../../ci/expected/init.run}} +``` + +> **NOTE**: You can choose target device by passing a target +> triple to cargo (e.g `cargo run --example init --target thumbv7m-none-eabi`) or +> configure a default target in `.cargo/config.toml`. +> +> For running the examples, we use a Cortex M3 emulated in QEMU so the target is `thumbv7m-none-eabi`. |
