From 744eafd718e624f1f547df8c3f52f61ed0a0ed99 Mon Sep 17 00:00:00 2001 From: Daniel Bevenius Date: Thu, 6 Jan 2022 10:03:50 +0100 Subject: [PATCH 1/3] Fix typo in runtime.adoc --- docs/modules/ROOT/pages/runtime.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/ROOT/pages/runtime.adoc b/docs/modules/ROOT/pages/runtime.adoc index 25feb9c29..c10a7102e 100644 --- a/docs/modules/ROOT/pages/runtime.adoc +++ b/docs/modules/ROOT/pages/runtime.adoc @@ -25,7 +25,7 @@ If you use the `#[embassy::main]` macro in your application, it creates the `Exe == Interrupts -Interrupts are a common way for peripherals to signal completion of some operation and fits well with the async execution model. The following diagram describes a typical application flow where (1) a task is polled and is attempting to make progress. The task then (2) instructs the peripheral to perform some operation, and awaits. After some time has passede, (3) an interrupt is raised, marking the completion of the operation. +Interrupts are a common way for peripherals to signal completion of some operation and fits well with the async execution model. The following diagram describes a typical application flow where (1) a task is polled and is attempting to make progress. The task then (2) instructs the peripheral to perform some operation, and awaits. After some time has passed, (3) an interrupt is raised, marking the completion of the operation. The peripheral HAL then (4) ensures that interrupt signals are routed to to the peripheral and updating the peripheral state with the results of the operation. The executor is then (5) notified that the task should be polled, which it will do. From 01ec70d2410ff110c5d90ea701271a56b5c1a593 Mon Sep 17 00:00:00 2001 From: Daniel Bevenius Date: Thu, 6 Jan 2022 10:56:47 +0100 Subject: [PATCH 2/3] Fix typo in hal.adoc --- docs/modules/ROOT/pages/hal.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/ROOT/pages/hal.adoc b/docs/modules/ROOT/pages/hal.adoc index 8e7fb8dba..0b15e2fce 100644 --- a/docs/modules/ROOT/pages/hal.adoc +++ b/docs/modules/ROOT/pages/hal.adoc @@ -2,7 +2,7 @@ Embassy provides HAL's for several microcontroller families: -* `embassy-nrf` for the nRF microcontroller sfrom Nordic Semiconductor +* `embassy-nrf` for the nRF microcontrollers from Nordic Semiconductor * `embassy-stm32` for STM32 microcontrollers from ST Microelectronics * `embassy-rp` for the Raspberry Pi RP2040 microcontrollers From 50c8f9adb8b60929e800387459742c3caf7de443 Mon Sep 17 00:00:00 2001 From: Daniel Bevenius Date: Thu, 6 Jan 2022 11:11:52 +0100 Subject: [PATCH 3/3] Fix typo in basic_application.adoc --- docs/modules/ROOT/pages/basic_application.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/ROOT/pages/basic_application.adoc b/docs/modules/ROOT/pages/basic_application.adoc index 46a375c86..749869ec0 100644 --- a/docs/modules/ROOT/pages/basic_application.adoc +++ b/docs/modules/ROOT/pages/basic_application.adoc @@ -35,7 +35,7 @@ include::example$basic/src/main.rs[lines="18..27"] An embassy task must be declared `async`, and may NOT take generic arguments. In this case, we are handed the LED that should be blinked and the interval of the blinking. -NOTE: Notice that there is not busy waiting going on in this task. It is using the Embassy timer to yield execution, allowing the microcontroller to sleep in between the blinking. +NOTE: Notice that there is no busy waiting going on in this task. It is using the Embassy timer to yield execution, allowing the microcontroller to sleep in between the blinking. === Main