NaxdyOrg/embassy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #568 from danbev/runtime-doc-typo

Browse source 
Fix typo in runtime.adoc
This commit is contained in:
Dario Nieuwenhuis 2022-01-06 11:15:14 +01:00 committed by GitHub
commit 23b9ede395
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/modules/ROOT/pages/basic_application.adoc
View file

@ -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

2
docs/modules/ROOT/pages/hal.adoc
View file

@ -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

2
docs/modules/ROOT/pages/runtime.adoc
View file

@ -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.