Struct FlashLoader

pub struct FlashLoader { /* private fields */ }

FlashLoader is a struct which manages the flashing of any chunks of data onto any sections of flash.

Use add_data() to add a chunk of data. Once you are done adding all your data, use commit() to flash the data. The flash loader will make sure to select the appropriate flash region for the right data chunks. Region crossing data chunks are allowed as long as the regions are contiguous.

Implementations

impl FlashLoader

pub fn new( memory_map: Vec<MemoryRegion>, source: TargetDescriptionSource, ) -> Self

Create a new flash loader.

pub fn boot_info(&self) -> BootInfo

Retrieve available boot information

pub fn add_data(&mut self, address: u64, data: &[u8]) -> Result<(), FlashError>

Stages a chunk of data to be programmed.

The chunk can cross flash boundaries as long as one flash region connects to another flash region.

pub fn has_data_for_address(&self, address: u64) -> bool

Returns whether an address will be flashed with data

pub fn load_image<T: Read + Seek>( &mut self, session: &mut Session, file: &mut T, format: Format, image_instruction_set: Option<InstructionSet>, ) -> Result<(), FileDownloadError>

Reads the image according to the file format and adds it to the loader.

pub fn verify(&self, session: &mut Session) -> Result<(), FlashError>

Verifies data on the device.

pub fn commit( &self, session: &mut Session, options: DownloadOptions, ) -> Result<(), FlashError>

Writes all the stored data chunks to flash.

Requires a session with an attached target that has a known flash algorithm.

pub fn data(&self) -> impl Iterator<Item = (u64, &[u8])>

Return data chunks stored in the FlashLoader as pairs of address and bytes.