Enum SingleBootCommandDescription 

pub enum SingleBootCommandDescription {
    Erase {
        start: u32,
        end: u32,
    },
    Load {
        file: String,
        src: u32,
        dst: u32,
        len: Option<u32>,
    },
    CheckNonsecureFirmwareVersion {
        version: u32,
    },
    CheckSecureFirmwareVersion {
        version: u32,
    },
}

Commands used to define SB2.1 files

Currently, we only need to erase and load (partial) files.

Example

Since there does not seem to exit a command to enter the bootloader, but a corrupt / missing firmware makes the MCU enter the bootloader, one way to do so is the following specification, which erases the first flash page.

[[commands]]
cmd = "Erase"
start = 0
end = 512

Example

To securely flash firmware, it is advised to write the first page last, so that if flashing goes wrong or is interrupted, the MCU stays in the bootloader on next boot.

[[commands]]
cmd = "Erase"
start = 0
end = 0x8_9800

[[commands]]
# write firmware, skipping first flash page
cmd = "Load"
file = "example.sb2"
src = 512
dst = 512

[[commands]]
# write first flash page of firmware
cmd = "Load"
file = "example.sb2"
len = 512

Variants

Erase

Maps to BootCommand::EraseRegion, but start and end are given in bytes.

Fields

start: u32

end: u32

Load

Load (part) of the data reference in source to flash.

The syntax is such that if source data and destination flash were slices src: &[u8] and dst: &mut [u8], this command would do:

let src_len = src.len() - cmd.src;
let len = cmd.len.unwrap_or(src_len);
dst[cmd.dst..][..len].copy_from_slice(&src[cmd.src..][..len]);

Fields

file: String

src: u32

source offset in bytes (default 0)

dst: u32

destination offset in bytes (default 0)

len: Option<u32>

number of bytes to copy

CheckNonsecureFirmwareVersion

Fields

version: u32

CheckSecureFirmwareVersion

Fields

version: u32

Trait Implementations

impl Clone for SingleBootCommandDescription

fn clone(&self) -> SingleBootCommandDescription

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SingleBootCommandDescription

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SingleBootCommandDescription

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SingleBootCommandDescription

fn eq(&self, other: &SingleBootCommandDescription) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SingleBootCommandDescription

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a SingleBootCommandDescription> for BootCommand

type Error = Error

The type returned in the event of a conversion error.

fn try_from(cmd: &'a SingleBootCommandDescription) -> Result<BootCommand>

Performs the conversion.

impl Eq for SingleBootCommandDescription

impl StructuralPartialEq for SingleBootCommandDescription