Trait embedded_update::FirmwareDevice

pub trait FirmwareDevice {
    type Version: FirmwareVersion;
    type Error;
    type StatusFuture<'m>: Future<Output = Result<FirmwareStatus<Self::Version>, Self::Error>> + 'm
    where
        Self: 'm;
    type StartFuture<'m>: Future<Output = Result<(), Self::Error>> + 'm
    where
        Self: 'm;
    type WriteFuture<'m>: Future<Output = Result<(), Self::Error>> + 'm
    where
        Self: 'm;
    type UpdateFuture<'m>: Future<Output = Result<(), Self::Error>> + 'm
    where
        Self: 'm;
    type SyncedFuture<'m>: Future<Output = Result<(), Self::Error>> + 'm
    where
        Self: 'm;

    const MTU: usize;

    fn status(&mut self) -> Self::StatusFuture<'_>;
    fn start<'m>(&'m mut self, version: &'m [u8]) -> Self::StartFuture<'m>;
    fn write<'m>(
        &'m mut self,
        offset: u32,
        data: &'m [u8]
    ) -> Self::WriteFuture<'m>;
    fn update<'m>(
        &'m mut self,
        version: &'m [u8],
        checksum: &'m [u8]
    ) -> Self::UpdateFuture<'m>;
    fn synced(&mut self) -> Self::SyncedFuture<'_>;
}

Represents a device that can be updated by a FirmwareUpdater.

Required Associated Types

type Version: FirmwareVersion

The expected version type for this device.

type Error

The error type.

type StatusFuture<'m>: Future<Output = Result<FirmwareStatus<Self::Version>, Self::Error>> + 'm
where
    Self: 'm

Future returned by status

type StartFuture<'m>: Future<Output = Result<(), Self::Error>> + 'm
where
    Self: 'm

Future returned by start

type WriteFuture<'m>: Future<Output = Result<(), Self::Error>> + 'm
where
    Self: 'm

Future returned by write

type UpdateFuture<'m>: Future<Output = Result<(), Self::Error>> + 'm
where
    Self: 'm

Future returned by update

type SyncedFuture<'m>: Future<Output = Result<(), Self::Error>> + 'm
where
    Self: 'm

Future returned by synced

Required Associated Constants

const MTU: usize

The preferred block size to be passed in write.

Required Methods

fn status(&mut self) -> Self::StatusFuture<'_>

Return the status of the currently running firmware.

fn start<'m>(&'m mut self, version: &'m [u8]) -> Self::StartFuture<'m>

Prepare for starting the firmware update process.

fn write<'m>(&'m mut self, offset: u32, data: &'m [u8]) -> Self::WriteFuture<'m>

Write a block of firmware at the expected offset.

fn update<'m>(
    &'m mut self,
    version: &'m [u8],
    checksum: &'m [u8]
) -> Self::UpdateFuture<'m>

Finish the firmware write and mark device to be updated

fn synced(&mut self) -> Self::SyncedFuture<'_>

Mark firmware as being in sync with the expected

Implementors

impl FirmwareDevice for Simulator

const MTU: usize = 256usize

type Version = Vec<u8, 16>

type Error = Infallible

type StatusFuture<'m>
where
    Self: 'm = impl Future<Output = Result<FirmwareStatus<<Simulator as FirmwareDevice>::Version>, <Simulator as FirmwareDevice>::Error>> + 'm

type StartFuture<'m>
where
    Self: 'm = impl Future<Output = Result<(), <Simulator as FirmwareDevice>::Error>> + 'm

type WriteFuture<'m>
where
    Self: 'm = impl Future<Output = Result<(), <Simulator as FirmwareDevice>::Error>> + 'm

type UpdateFuture<'m>
where
    Self: 'm = impl Future<Output = Result<(), <Simulator as FirmwareDevice>::Error>> + 'm

type SyncedFuture<'m>
where
    Self: 'm = impl Future<Output = Result<(), <Simulator as FirmwareDevice>::Error>> + 'm

impl<T> FirmwareDevice for Serial<T> where
    T: Read + Write, 

const MTU: usize = 968usize

type Version = Vec<u8, 16>

type Error = SerialError<<T as Io>::Error, Error>

type StatusFuture<'m>
where
    Self: 'm = impl Future<Output = Result<FirmwareStatus<<Serial<T> as FirmwareDevice>::Version>, <Serial<T> as FirmwareDevice>::Error>> + 'm

type StartFuture<'m>
where
    Self: 'm = impl Future<Output = Result<(), <Serial<T> as FirmwareDevice>::Error>> + 'm

type WriteFuture<'m>
where
    Self: 'm = impl Future<Output = Result<(), <Serial<T> as FirmwareDevice>::Error>> + 'm

type UpdateFuture<'m>
where
    Self: 'm = impl Future<Output = Result<(), <Serial<T> as FirmwareDevice>::Error>> + 'm

type SyncedFuture<'m>
where
    Self: 'm = impl Future<Output = Result<(), <Serial<T> as FirmwareDevice>::Error>> + 'm