NaxdyOrg/embassy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity
Modern embedded framework, using Rust and async.
212 commits 3 branches 0 tags 20 MiB
Rust 98.8%
Shell 0.9%
Python 0.2%
Find a file
Dario Nieuwenhuis da91779117 interrupt: Split set_handler context. 
Since introducing the ctx pointer, the handler is now two words, so setting it can
race with the interrupt firing. On race it's possible for the new handler to be
alled with the old ctx pointer or viceversa.

Rather than documenting this, it's better to split the function in two to make it
obvious to the user that it's not atomic. The user can use a critical section, or
disable/enable the interrupt to avoid races if this is a concern.
2021-02-26 02:04:48 +01:00
.github/workflows Fix CI 2020-12-01 17:52:06 +01:00
.vscode Enable rust-analyzer proc-macros 2021-02-20 00:27:34 +01:00
embassy interrupt: Split set_handler context. 2021-02-26 02:04:48 +01:00
embassy-macros Cleanup interrupt package naming. Fixes #40 2021-02-26 01:55:27 +01:00
embassy-nrf interrupt: Split set_handler context. 2021-02-26 02:04:48 +01:00
embassy-nrf-examples Cleanup interrupt package naming. Fixes #40 2021-02-26 01:55:27 +01:00
embassy-std Remove rand(), fixes #50 2021-02-26 01:58:00 +01:00
embassy-std-examples Get rid of some warnings 2021-02-13 21:41:36 -03:00
embassy-stm32f4 interrupt: Split set_handler context. 2021-02-26 02:04:48 +01:00
embassy-stm32f4-examples update defmt and defmt-rtt to 0.2.0 2021-02-24 08:44:23 +01:00
.gitignore Update embassy-std to new executor api 2021-02-03 04:30:11 +01:00
Cargo.toml Add embassy-std-examples 2021-02-03 05:05:05 +01:00
LICENSE-APACHE First commit 2020-09-22 18:03:43 +02:00
LICENSE-MIT First commit 2020-09-22 18:03:43 +02:00
README.md Update readme 2021-01-02 20:13:35 +01:00
test-build.sh Add embassy-std-examples 2021-02-03 05:05:05 +01:00

README.md

Embassy

Embassy is a project to make async/await a first-class option for embedded development.

Traits and types

embassy provides a set of traits and types specifically designed for async usage.

  • embassy::io: AsyncBufRead, AsyncWrite. Traits for byte-stream IO, essentially no_std compatible versions of futures::io.
  • embassy::flash: Flash device trait.
  • embassy::time: Clock and Alarm traits. Std-like Duration and Instant.
  • More traits for SPI, I2C, UART async HAL coming soon.

Executor

The embassy::executor module provides an async/await executor designed for embedded usage.

  • No alloc, no heap needed. Task futures are statically allocated.
  • No "fixed capacity" data structures, executor works with 1 or 1000 tasks without needing config/tuning.
  • Integrated timer queue: sleeping is easy, just do Timer::after(Duration::from_secs(1)).await;.
  • No busy-loop polling: CPU sleeps when there's no work to do, using interrupts or WFE/SEV.
  • Efficient polling: a wake will only poll the woken task, not all of them.
  • Fair: a task can't monopolize CPU time even if it's constantly being woken. All other tasks get a chance to run before a given task gets polled for the second time.
  • Creating multiple executor instances is supported, to run tasks with multiple priority levels. This allows higher-priority tasks to preempt lower-priority tasks.

Utils

embassy::util contains some lightweight async/await utilities, mainly helpful for async driver development (signaling a task that an interrupt has occured, for example).

embassy-nrf

The embassy-nrf crate contains implementations for nRF 52 series SoCs.

  • uarte: UARTE driver implementing AsyncBufRead and AsyncWrite.
  • qspi: QSPI driver implementing Flash.
  • gpiote: GPIOTE driver. Allows awaiting GPIO pin changes. Great for reading buttons or receiving interrupts from external chips.
  • rtc: RTC driver implementing Clock and Alarm, for use with embassy::executor.

Running the examples

Examples are for the nRF52840 chip but should be easily adaptable to other nRF52 chips.

GPIO pins are set up for the nrf52840-dk board (PCA10056)

  • Install probe-run with defmt support.
cargo install --git https://github.com/knurling-rs/probe-run --branch main --features defmt
  • Run the example
cargo run --bin rtc_async

Minimum supported Rust version (MSRV)

Only recent nighly supported. Nightly is required for:

  • generic_associated_types: for trait funcs returning futures.
  • type_alias_impl_trait: for trait funcs returning futures implemented with async{} blocks, and for static-executor.

Stable support is a non-goal until these features get stabilized.

Why the name?

EMBedded ASYnc! :)

License

This work is licensed under either of

at your option.