LailaTheElf/embassy
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #4120 from Gerharddc/dfu-app

Browse Source 
[embassy-usb-dfu] Add generic DFU marking interface
This commit is contained in:
Ulf Lilleengen 2025-04-30 12:17:43 +02:00 committed by GitHub
commit e68713e9af
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 25 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
embassy-usb-dfu/src/application.rs
View File

@ -13,9 +13,25 @@ use crate::consts::{
}; };
use crate::Reset; use crate::Reset;
/// Generic interface for a system that can signal to the bootloader that USB DFU mode is needed on the next boot.
///
/// By default this trait is implemented for `BlockingFirmwareState<'d, STATE>` but you could also implement this generic
/// interface yourself instead in more complex situations. This could for instance be when you cannot hand ownership of a
/// `BlockingFirmwareState` instance over directly to the DFU `Control` instance and need to use a more complex mechanism.
pub trait DfuMarker {
/// Signal to the bootloader that DFU mode should be used on the next boot.
fn mark_dfu(&mut self);
}
impl<'d, STATE: NorFlash> DfuMarker for BlockingFirmwareState<'d, STATE> {
fn mark_dfu(&mut self) {
self.mark_dfu().expect("Failed to mark DFU mode in bootloader")
}
}
/// Internal state for the DFU class /// Internal state for the DFU class
pub struct Control<'d, STATE: NorFlash, RST: Reset> { pub struct Control<MARK: DfuMarker, RST: Reset> {
firmware_state: BlockingFirmwareState<'d, STATE>, dfu_marker: MARK,
attrs: DfuAttributes, attrs: DfuAttributes,
state: State, state: State,
timeout: Option<Duration>, timeout: Option<Duration>,
@ -23,11 +39,11 @@ pub struct Control<'d, STATE: NorFlash, RST: Reset> {
_rst: PhantomData<RST>, _rst: PhantomData<RST>,
} }
impl<'d, STATE: NorFlash, RST: Reset> Control<'d, STATE, RST> { impl<MARK: DfuMarker, RST: Reset> Control<MARK, RST> {
/// Create a new DFU instance to expose a DFU interface. /// Create a new DFU instance to expose a DFU interface.
pub fn new(firmware_state: BlockingFirmwareState<'d, STATE>, attrs: DfuAttributes) -> Self { pub fn new(dfu_marker: MARK, attrs: DfuAttributes) -> Self {
Control { Control {
firmware_state, dfu_marker,
attrs, attrs,
state: State::AppIdle, state: State::AppIdle,
detach_start: None, detach_start: None,
@ -37,7 +53,7 @@ impl<'d, STATE: NorFlash, RST: Reset> Control<'d, STATE, RST> {
} }
} }
impl<'d, STATE: NorFlash, RST: Reset> Handler for Control<'d, STATE, RST> { impl<MARK: DfuMarker, RST: Reset> Handler for Control<MARK, RST> {
fn reset(&mut self) { fn reset(&mut self) {
if let Some(start) = self.detach_start { if let Some(start) = self.detach_start {
let delta = Instant::now() - start; let delta = Instant::now() - start;
@ -48,9 +64,7 @@ impl<'d, STATE: NorFlash, RST: Reset> Handler for Control<'d, STATE, RST> {
timeout.as_millis() timeout.as_millis()
); );
if delta < timeout { if delta < timeout {
self.firmware_state self.dfu_marker.mark_dfu();
.mark_dfu()
.expect("Failed to mark DFU mode in bootloader");
RST::sys_reset() RST::sys_reset()
} }
} }
@ -109,9 +123,9 @@ impl<'d, STATE: NorFlash, RST: Reset> Handler for Control<'d, STATE, RST> {
/// it should expose a DFU device, and a software reset will be issued. /// it should expose a DFU device, and a software reset will be issued.
/// ///
/// To apply USB DFU updates, the bootloader must be capable of recognizing the DFU magic and exposing a device to handle the full DFU transaction with the host. /// To apply USB DFU updates, the bootloader must be capable of recognizing the DFU magic and exposing a device to handle the full DFU transaction with the host.
pub fn usb_dfu<'d, D: Driver<'d>, STATE: NorFlash, RST: Reset>( pub fn usb_dfu<'d, D: Driver<'d>, MARK: DfuMarker, RST: Reset>(
builder: &mut Builder<'d, D>, builder: &mut Builder<'d, D>,
handler: &'d mut Control<'d, STATE, RST>, handler: &'d mut Control<MARK, RST>,
timeout: Duration, timeout: Duration,
) { ) {
let mut func = builder.function(0x00, 0x00, 0x00); let mut func = builder.function(0x00, 0x00, 0x00);