Crate embassy_boot

embassy-boot

An Embassy project.

A lightweight bootloader supporting firmware updates in a power-fail-safe way, with trial boots and rollbacks.

The bootloader can be used either as a library or be flashed directly with the default configuration derived from linker scripts.

By design, the bootloader does not provide any network capabilities. Networking capabilities for fetching new firmware can be provided by the user application, using the bootloader as a library for updating the firmware, or by using the bootloader as a library and adding this capability yourself.

Hardware support

The bootloader supports different hardware in separate crates:

• embassy-boot-nrf - for the nRF microcontrollers.
• embassy-boot-stm32 - for the STM32 microcontrollers.

Minimum supported Rust version (MSRV)

embassy-boot requires Rust nightly to compile as it relies on async traits for interacting with the flash peripherals.

License

This work is licensed under either of

• Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Structs

AlignedBuffer

Buffer aligned to 32 byte boundary, largest known alignment requirement for embassy-boot.

BootFlash

A flash wrapper implementing the Flash and embedded_storage traits.

BootLoader

BootLoader works with any flash implementing embedded_storage and can also work with different page sizes and flash write sizes.

FirmwareUpdater

FirmwareUpdater is an application API for interacting with the BootLoader without the ability to ‘mess up’ the internal bootloader state

FirmwareWriter

FirmwareWriter allows writing blocks to an already erased flash.

MultiFlashConfig

Convenience flash provider that uses separate flash instances for each partition.

Partition

A region in flash used by the bootloader.

SingleFlashConfig

Convenience provider that uses a single flash for all partitions.

Enums

BootError

Errors returned by bootloader

State

The state of the bootloader after running prepare.

Traits

Flash

Extension of the embedded-storage flash type information with block size and erase value.

FlashConfig

Trait defining the flash handles used for active and DFU partition