mirror of
https://github.com/rtic-rs/rtic.git
synced 2025-12-18 13:55:23 +01:00
v0.2.2
This commit is contained in:
Jorge Aparicio
parent
c184f91e3c
commit
948e1fd0fb
10 changed files with 161 additions and 61 deletions
|
|
@ -19,11 +19,9 @@ mod analyze;
|
|||
mod check;
|
||||
mod trans;
|
||||
|
||||
/// The `app!` macro, a macro used to specify the tasks and resources of a
|
||||
/// RTFM application.
|
||||
/// The `app!` macro, a macro used to specify the tasks and resources of a RTFM application.
|
||||
///
|
||||
/// The contents of this macro uses a `key: value` syntax. All the possible keys
|
||||
/// are shown below:
|
||||
/// The contents of this macro uses a `key: value` syntax. All the possible keys are shown below:
|
||||
///
|
||||
/// ``` text
|
||||
/// app! {
|
||||
|
|
@ -41,14 +39,13 @@ mod trans;
|
|||
///
|
||||
/// # `device`
|
||||
///
|
||||
/// The value of this key is a Rust path, like `foo::bar::baz`, that must point to
|
||||
/// a *device crate*, a crate generated using `svd2rust`.
|
||||
/// The value of this key is a Rust path, like `foo::bar::baz`, that must point to a *device crate*,
|
||||
/// a crate generated using `svd2rust`.
|
||||
///
|
||||
/// # `resources`
|
||||
///
|
||||
/// This key is optional. Its value is a list of `static` variables. These
|
||||
/// variables are the data that can be safely accessed, modified and shared by
|
||||
/// tasks.
|
||||
/// This key is optional. Its value is a list of `static` variables. These variables are the data
|
||||
/// that can be safely accessed, modified and shared by tasks.
|
||||
///
|
||||
/// ``` text
|
||||
/// resources: {
|
||||
|
|
@ -56,15 +53,18 @@ mod trans;
|
|||
/// static B: i32 = 0;
|
||||
/// static C: [u8; 16] = [0; 16];
|
||||
/// static D: Thing = Thing::new(..);
|
||||
/// static E: Thing;
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
/// The initial value of a resource can be omitted. This means that the resource will be runtime
|
||||
/// initialized.
|
||||
///
|
||||
/// If this key is omitted its value defaults to an empty list.
|
||||
///
|
||||
/// # `init`
|
||||
///
|
||||
/// This key is optional. Its value is a set of key values. All the possible
|
||||
/// keys are shown below:
|
||||
/// This key is optional. Its value is a set of key values. All the possible keys are shown below:
|
||||
///
|
||||
/// ``` text
|
||||
/// init: {
|
||||
|
|
@ -74,15 +74,14 @@ mod trans;
|
|||
///
|
||||
/// ## `init.path`
|
||||
///
|
||||
/// This key is optional. Its value is a Rust path, like `foo::bar::baz`, that
|
||||
/// points to the initialization function.
|
||||
/// This key is optional. Its value is a Rust path, like `foo::bar::baz`, that points to the
|
||||
/// initialization function.
|
||||
///
|
||||
/// If the key is omitted its value defaults to `init`.
|
||||
///
|
||||
/// # `idle`
|
||||
///
|
||||
/// This key is optional. Its value is a set of key values. All the possible
|
||||
/// keys are shown below:
|
||||
/// This key is optional. Its value is a set of key values. All the possible keys are shown below:
|
||||
///
|
||||
/// ``` text
|
||||
/// idle: {
|
||||
|
|
@ -93,25 +92,24 @@ mod trans;
|
|||
///
|
||||
/// ## `idle.path`
|
||||
///
|
||||
/// This key is optional. Its value is a Rust path, like `foo::bar::baz`, that
|
||||
/// points to the idle loop function.
|
||||
/// This key is optional. Its value is a Rust path, like `foo::bar::baz`, that points to the idle
|
||||
/// loop function.
|
||||
///
|
||||
/// If the key is omitted its value defaults to `idle`.
|
||||
///
|
||||
/// ## `idle.resources`
|
||||
///
|
||||
/// This key is optional. Its value is a list of resources the `idle` loop has
|
||||
/// access to. The resources in this list can refer to the resources listed in
|
||||
/// the top `resources` key. If the name doesn't match one of the resources
|
||||
/// listed in the top `resources` key the resource is assumed to be a
|
||||
/// peripheral.
|
||||
/// This key is optional. Its value is a list of resources the `idle` loop has access to. The
|
||||
/// resources in this list can refer to the resources listed in the top `resources` key. If the name
|
||||
/// doesn't match one of the resources /// listed in the top `resources` key the resource is assumed
|
||||
/// to be a peripheral.
|
||||
///
|
||||
/// If omitted its value defaults to an empty list.
|
||||
///
|
||||
/// # `tasks`
|
||||
///
|
||||
/// This key is optional. Its value is a list of tasks. Each task itself is a
|
||||
/// set of key value pair. The full syntax is shown below:
|
||||
/// This key is optional. Its value is a list of tasks. Each task itself is a set of key value pair.
|
||||
/// The full syntax is shown below:
|
||||
///
|
||||
/// ``` text
|
||||
/// tasks: {
|
||||
|
|
@ -128,39 +126,37 @@ mod trans;
|
|||
///
|
||||
/// ## `tasks.$TASK`
|
||||
///
|
||||
/// The key must be either a Cortex-M exception or a device specific interrupt.
|
||||
/// `PENDSV`, `SVCALL`, `SYS_TICK` are considered as exceptions. All other names
|
||||
/// are assumed to be interrupts.
|
||||
/// The key must be either a Cortex-M exception or a device specific interrupt. `PENDSV`, `SVCALL`,
|
||||
/// `SYS_TICK` are considered as exceptions. All other names are assumed to be interrupts.
|
||||
///
|
||||
/// ## `tasks.$TASK.enabled`
|
||||
///
|
||||
/// This key is optional for interrupts and forbidden for exceptions. Its value
|
||||
/// must be a boolean and indicates whether the interrupt will be enabled
|
||||
/// (`true`) or disabled (`false`) after `init` ends and before `idle` starts.
|
||||
/// This key is optional for interrupts and forbidden for exceptions. Its value must be a boolean
|
||||
/// and indicates whether the interrupt will be enabled (`true`) or disabled (`false`) after `init`
|
||||
/// ends and before `idle` starts.
|
||||
///
|
||||
/// If this key is omitted its value defaults to `true`.
|
||||
///
|
||||
/// ## `tasks.$TASK.path`
|
||||
///
|
||||
/// The value of this key is a Rust path, like `foo::bar::baz`, that points to
|
||||
/// the handler of this task.
|
||||
/// The value of this key is a Rust path, like `foo::bar::baz`, that points to the handler of this
|
||||
/// task.
|
||||
///
|
||||
/// ## `tasks.$TASK.priority`
|
||||
///
|
||||
/// This key is optional. Its value is an integer with type `u8` that specifies
|
||||
/// the priority of this task. The minimum valid priority is 1. The maximum
|
||||
/// valid priority depends on the number of the NVIC priority bits the device
|
||||
/// has; if the device has 4 priority bits the maximum allowed value would be
|
||||
/// 16.
|
||||
/// This key is optional. Its value is an integer with type `u8` that specifies the priority of this
|
||||
/// task. The minimum valid priority is 1. The maximum valid priority depends on the number of the
|
||||
/// NVIC priority bits the device has; if the device has 4 priority bits the maximum allowed value
|
||||
/// would be 16.
|
||||
///
|
||||
/// If this key is omitted its value defaults to `1`.
|
||||
///
|
||||
/// ## `tasks.$TASK.resources`
|
||||
///
|
||||
/// This key is optional. Its value is a list of resources this task has access
|
||||
/// to. The resources in this list can refer to the resources listed in the top
|
||||
/// `resources` key. If the name doesn't match one of the resources listed in
|
||||
/// the top `resources` key the resource is assumed to be a peripheral.
|
||||
/// This key is optional. Its value is a list of resources this task has access to. The resources in
|
||||
/// this list can refer to the resources listed in the top `resources` key. If the name doesn't
|
||||
/// match one of the resources listed in the top `resources` key the resource is assumed to be a
|
||||
/// peripheral.
|
||||
///
|
||||
/// If omitted its value defaults to an empty list.
|
||||
#[proc_macro]
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue