Struct probe_rs::config::flash_algorithm::FlashAlgorithm

pub struct FlashAlgorithm {
    pub name: String,
    pub default: bool,
    pub load_address: u32,
    pub instructions: Vec<u32>,
    pub pc_init: Option<u32>,
    pub pc_uninit: Option<u32>,
    pub pc_program_page: u32,
    pub pc_erase_sector: u32,
    pub pc_erase_all: Option<u32>,
    pub static_base: u32,
    pub begin_stack: u32,
    pub begin_data: u32,
    pub page_buffers: Vec<u32>,
    pub flash_properties: FlashProperties,
}

Fields

name: String

The name of the flash algorithm.

default: bool

Whether this flash algorithm is the default one or not.

load_address: u32

Memory address where the flash algo instructions will be loaded to.

instructions: Vec<u32>

List of 32-bit words containing the position-independent code for the algo.

pc_init: Option<u32>

Address of the Init() entry point. Optional.

pc_uninit: Option<u32>

Address of the UnInit() entry point. Optional.

pc_program_page: u32

Address of the ProgramPage() entry point.

pc_erase_sector: u32

Address of the EraseSector() entry point.

pc_erase_all: Option<u32>

Address of the EraseAll() entry point. Optional.

static_base: u32

Initial value of the R9 register for calling flash algo entry points, which determines where the position-independent data resides.

begin_stack: u32

Initial value of the stack pointer when calling any flash algo API.

begin_data: u32

Base address of the page buffer. Used if page_buffers is not provided.

page_buffers: Vec<u32>

An optional list of base addresses for page buffers. The buffers must be at least as large as the region's page_size attribute. If at least 2 buffers are included in the list, then double buffered programming will be enabled.

flash_properties: FlashProperties

The properties of the flash on the device.

Methods

impl FlashAlgorithm

pub fn sector_info(&self, address: u32) -> Option<SectorInfo>

pub fn page_info(&self, address: u32) -> Option<PageInfo>

Returns the necessary information about the page which address resides in if the address is inside the flash region.

pub fn is_erased(&self, data: &[u8]) -> bool

Returns true if the entire contents of the argument array equal the erased byte value.

Trait Implementations

impl Clone for FlashAlgorithm

fn clone(&self) -> FlashAlgorithm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FlashAlgorithm

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

Formats the value using the given formatter.

impl Default for FlashAlgorithm

fn default() -> FlashAlgorithm

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for FlashAlgorithm

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for FlashAlgorithm

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

Serialize this value into the given Serde serializer.