aboutsummaryrefslogtreecommitdiff
path: root/book/en/src/by-example/app_init.md
diff options
context:
space:
mode:
authorHenrik Tjäder <henrik@tjaders.com>2023-02-01 01:15:56 +0100
committerHenrik Tjäder <henrik@tjaders.com>2023-03-01 00:33:40 +0100
commit63f3d784fe519d248c89b64006dbc13d83e07360 (patch)
tree8be6e44f20126fac674bf213eba29f81d56285bd /book/en/src/by-example/app_init.md
parent8d46fb9cf9f2b9cdd14844672ad840d777739cb2 (diff)
Revert accidental removal of editorial changes
Diffstat (limited to 'book/en/src/by-example/app_init.md')
-rw-r--r--book/en/src/by-example/app_init.md18
1 files changed, 9 insertions, 9 deletions
diff --git a/book/en/src/by-example/app_init.md b/book/en/src/by-example/app_init.md
index 62fb55b..3767bd7 100644
--- a/book/en/src/by-example/app_init.md
+++ b/book/en/src/by-example/app_init.md
@@ -1,19 +1,19 @@
# App initialization and the `#[init]` task
An RTIC application requires an `init` task setting up the system. The corresponding `init` function must have the
-signature `fn(init::Context) -> (Shared, Local)`, where `Shared` and `Local` are the resource
-structures defined by the user.
-
-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`.
-[pre-init]: https://docs.rs/cortex-m-rt/latest/cortex_m_rt/attr.pre_init.html
+signature `fn(init::Context) -> (Shared, Local)`, where `Shared` and `Local` are resource structures defined by the user.
+
+The `init` task executes after system reset, [after an optionally defined `pre-init` code section][pre-init] and an always occurring internal RTIC initialization. [pre-init]: https://docs.rs/cortex-m-rt/latest/cortex_m_rt/attr.pre_init.html
+
+The `init` and optional `pre-init` tasks runs *with interrupts disabled* and have exclusive access to Cortex-M (the `bare_metal::CriticalSection` token is available as `cs`).
+
+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. Such variables can be delegated from the `init` task to other tasks of the RTIC application.
-The `device` field is available when the `peripherals` argument is set to the default value `true`.
+The `device` field is only 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