diff options
| author | Henrik Tjäder <henrik@grepit.se> | 2021-12-14 22:46:15 +0100 |
|---|---|---|
| committer | Henrik Tjäder <henrik@grepit.se> | 2021-12-19 01:33:14 +0100 |
| commit | 4357d8be1511d28ed16f76439c9af60e78504b28 (patch) | |
| tree | cf1a74b2d312ae2573b33195a2b7d270a43900f6 /book/en/src/by-example/app_init.md | |
| parent | 37facfb5bf9aca11c43868cb8880b12b9f6b336a (diff) | |
Docs: By-example
Diffstat (limited to 'book/en/src/by-example/app_init.md')
| -rw-r--r-- | book/en/src/by-example/app_init.md | 22 |
1 files changed, 15 insertions, 7 deletions
diff --git a/book/en/src/by-example/app_init.md b/book/en/src/by-example/app_init.md index 3112ccf..615c299 100644 --- a/book/en/src/by-example/app_init.md +++ b/book/en/src/by-example/app_init.md @@ -1,14 +1,22 @@ # App initialization and the `#[init]` task -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. +An RTIC application requires an `init` task setting up the system. The corresponding `init` 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`. +The `init` task executes after system reset (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 example below shows the types of the `core`, `device` and `cs` fields, and showcases the use of a `local` +variable with `'static` lifetime. +Such variables can be delegated from the `init` task 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`. +The `device` field is available when the `peripherals` argument is set to the default value `true`. +In the rare case you want to implement an ultra-slim application you can explicitly set `peripherals` to `false`. ``` rust {{#include ../../../../examples/init.rs}} @@ -16,13 +24,13 @@ The `device` field is only available when the `peripherals` argument is set to ` Running the example will print `init` to the console and then exit the QEMU process. -``` console +``` 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 +> 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`. +> For running the examples, we use a Cortex M3 emulated in QEMU, so the target is `thumbv7m-none-eabi`. |
