diff options
| author |  Nils Fitinghoff <nils.fitinghoff@mobilaris.se>
| 2023-08-29 09:28:43 +0200 |
|---|---|---|
| committer |  Emil Fresk <emil.fresk@gmail.com>
| 2023-08-29 11:31:11 +0000 |
| commit | cc1e7154fce6780b8db7fe3457405b8e02563f7d (patch) | |
| tree | 7b58e18fdd4db60422d1c7c6740ae13fce073d8f | |
| parent | 57be9b0dc9c1c53bb55d0efcaaa0b2c2cea0c7a2 (diff) | |
| download | rtic-cc1e7154fce6780b8db7fe3457405b8e02563f7d.tar.gz rtic-cc1e7154fce6780b8db7fe3457405b8e02563f7d.tar.zst rtic-cc1e7154fce6780b8db7fe3457405b8e02563f7d.zip | |
book: Update default priority to 0
| -rw-r--r-- | book/en/src/by-example/app.md | 2 | ||||
| -rw-r--r-- | book/en/src/by-example/app_priorities.md | 4 | ||||
| -rw-r--r-- | book/en/src/by-example/software_tasks.md | 2 |
3 files changed, 4 insertions, 4 deletions
diff --git a/book/en/src/by-example/app.md b/book/en/src/by-example/app.md index 0aeed5b6..6cdd92a1 100644 --- a/book/en/src/by-example/app.md +++ b/book/en/src/by-example/app.md @@ -32,7 +32,7 @@ Overall, the generated code infers no additional overhead in comparison to a han ## Priority -Priorities in RTIC are specified using the `priority = N` (where N is a positive number) argument passed to the `#[task]` attribute. All `#[task]`s can have a priority. If the priority of a task is not specified, it is set to the default value of 1. +Priorities in RTIC are specified using the `priority = N` (where N is a positive number) argument passed to the `#[task]` attribute. All `#[task]`s can have a priority. If the priority of a task is not specified, it is set to the default value of 0. Priorities in RTIC follow a higher value = more important scheme. For examples, a task with priority 2 will preempt a task with priority 1. diff --git a/book/en/src/by-example/app_priorities.md b/book/en/src/by-example/app_priorities.md index 86ff9859..47032917 100644 --- a/book/en/src/by-example/app_priorities.md +++ b/book/en/src/by-example/app_priorities.md @@ -4,9 +4,9 @@ The `priority` argument declares the static priority of each `task`. -For Cortex-M, tasks can have priorities in the range `1..=(1 << NVIC_PRIO_BITS)` where `NVIC_PRIO_BITS` is a constant defined in the `device` crate. +For Cortex-M, tasks can have priorities in the range `0..=(1 << NVIC_PRIO_BITS)` where `NVIC_PRIO_BITS` is a constant defined in the `device` crate. -Omitting the `priority` argument the task priority defaults to `1`. The `idle` task has a non-configurable static priority of `0`, the lowest priority. +Omitting the `priority` argument the task priority defaults to `0`. The `idle` task has a non-configurable static priority of `0`, the lowest priority. > A higher number means a higher priority in RTIC, which is the opposite from what > Cortex-M does in the NVIC peripheral. diff --git a/book/en/src/by-example/software_tasks.md b/book/en/src/by-example/software_tasks.md index 444f4a6f..756150d7 100644 --- a/book/en/src/by-example/software_tasks.md +++ b/book/en/src/by-example/software_tasks.md @@ -35,7 +35,7 @@ $ cargo run --target thumbv7m-none-eabi --example spawn ``` You may `spawn` a *software* task again, given that it has run-to-completion (returned). -In the below example, we `spawn` the *software* task `foo` from the `idle` task. Since the default priority of the *software* task is 1 (higher than `idle`), the dispatcher will execute `foo` (preempting `idle`). Since `foo` runs-to-completion. It is ok to `spawn` the `foo` task again. +In the below example, we `spawn` the *software* task `foo` from the `idle` task. Since the priority of the *software* task is 1 (higher than `idle`), the dispatcher will execute `foo` (preempting `idle`). Since `foo` runs-to-completion. It is ok to `spawn` the `foo` task again. Technically the async executor will `poll` the `foo` *future* which in this case leaves the *future* in a *completed* state. |