107 lines
3.9 KiB
Rust
107 lines
3.9 KiB
Rust
#![no_std]
|
|
#![warn(missing_docs)]
|
|
#![doc = include_str!("../README.md")]
|
|
mod fmt;
|
|
|
|
pub use embassy_boot::{
|
|
AlignedBuffer, BlockingFirmwareState, BlockingFirmwareUpdater, BootError, BootLoaderConfig, FirmwareState,
|
|
FirmwareUpdater, FirmwareUpdaterConfig, State,
|
|
};
|
|
use embassy_rp::flash::{Blocking, Flash, ERASE_SIZE};
|
|
use embassy_rp::peripherals::{FLASH, WATCHDOG};
|
|
use embassy_rp::watchdog::Watchdog;
|
|
use embassy_time::Duration;
|
|
use embedded_storage::nor_flash::{ErrorType, NorFlash, ReadNorFlash};
|
|
|
|
/// A bootloader for RP2040 devices.
|
|
pub struct BootLoader<const BUFFER_SIZE: usize = ERASE_SIZE> {
|
|
/// The reported state of the bootloader after preparing for boot
|
|
pub state: State,
|
|
}
|
|
|
|
impl<const BUFFER_SIZE: usize> BootLoader<BUFFER_SIZE> {
|
|
/// Inspect the bootloader state and perform actions required before booting, such as swapping firmware
|
|
pub fn prepare<ACTIVE: NorFlash, DFU: NorFlash, STATE: NorFlash>(
|
|
config: BootLoaderConfig<ACTIVE, DFU, STATE>,
|
|
) -> Self {
|
|
if let Ok(loader) = Self::try_prepare::<ACTIVE, DFU, STATE>(config) {
|
|
loader
|
|
} else {
|
|
// Use explicit panic instead of .expect() to ensure this gets routed via defmt/etc.
|
|
// properly
|
|
panic!("Boot prepare error")
|
|
}
|
|
}
|
|
|
|
/// Inspect the bootloader state and perform actions required before booting, such as swapping firmware
|
|
pub fn try_prepare<ACTIVE: NorFlash, DFU: NorFlash, STATE: NorFlash>(
|
|
config: BootLoaderConfig<ACTIVE, DFU, STATE>,
|
|
) -> Result<Self, BootError> {
|
|
let mut aligned_buf = AlignedBuffer([0; BUFFER_SIZE]);
|
|
let mut boot = embassy_boot::BootLoader::new(config);
|
|
let state = boot.prepare_boot(aligned_buf.as_mut())?;
|
|
Ok(Self { state })
|
|
}
|
|
|
|
/// Boots the application.
|
|
///
|
|
/// # Safety
|
|
///
|
|
/// This modifies the stack pointer and reset vector and will run code placed in the active partition.
|
|
pub unsafe fn load(self, start: u32) -> ! {
|
|
trace!("Loading app at 0x{:x}", start);
|
|
#[allow(unused_mut)]
|
|
let mut p = cortex_m::Peripherals::steal();
|
|
#[cfg(not(armv6m))]
|
|
p.SCB.invalidate_icache();
|
|
p.SCB.vtor.write(start);
|
|
|
|
cortex_m::asm::bootload(start as *const u32)
|
|
}
|
|
}
|
|
|
|
/// A flash implementation that will feed a watchdog when touching flash.
|
|
pub struct WatchdogFlash<'d, const SIZE: usize> {
|
|
flash: Flash<'d, FLASH, Blocking, SIZE>,
|
|
watchdog: Watchdog,
|
|
}
|
|
|
|
impl<'d, const SIZE: usize> WatchdogFlash<'d, SIZE> {
|
|
/// Start a new watchdog with a given flash and watchdog peripheral and a timeout
|
|
pub fn start(flash: FLASH, watchdog: WATCHDOG, timeout: Duration) -> Self {
|
|
let flash = Flash::<_, Blocking, SIZE>::new_blocking(flash);
|
|
let mut watchdog = Watchdog::new(watchdog);
|
|
watchdog.start(timeout);
|
|
Self { flash, watchdog }
|
|
}
|
|
}
|
|
|
|
impl<'d, const SIZE: usize> ErrorType for WatchdogFlash<'d, SIZE> {
|
|
type Error = <Flash<'d, FLASH, Blocking, SIZE> as ErrorType>::Error;
|
|
}
|
|
|
|
impl<'d, const SIZE: usize> NorFlash for WatchdogFlash<'d, SIZE> {
|
|
const WRITE_SIZE: usize = <Flash<'d, FLASH, Blocking, SIZE> as NorFlash>::WRITE_SIZE;
|
|
const ERASE_SIZE: usize = <Flash<'d, FLASH, Blocking, SIZE> as NorFlash>::ERASE_SIZE;
|
|
|
|
fn erase(&mut self, from: u32, to: u32) -> Result<(), Self::Error> {
|
|
self.watchdog.feed();
|
|
self.flash.blocking_erase(from, to)
|
|
}
|
|
fn write(&mut self, offset: u32, data: &[u8]) -> Result<(), Self::Error> {
|
|
self.watchdog.feed();
|
|
self.flash.blocking_write(offset, data)
|
|
}
|
|
}
|
|
|
|
impl<'d, const SIZE: usize> ReadNorFlash for WatchdogFlash<'d, SIZE> {
|
|
const READ_SIZE: usize = <Flash<'d, FLASH, Blocking, SIZE> as ReadNorFlash>::READ_SIZE;
|
|
fn read(&mut self, offset: u32, data: &mut [u8]) -> Result<(), Self::Error> {
|
|
self.watchdog.feed();
|
|
self.flash.blocking_read(offset, data)
|
|
}
|
|
fn capacity(&self) -> usize {
|
|
self.flash.capacity()
|
|
}
|
|
}
|