Struct RawFlashAlgorithm

pub struct RawFlashAlgorithm {

    pub name: String,
    pub description: String,
    pub default: bool,
    pub instructions: Vec<u8>,
    pub load_address: Option<u64>,
    pub data_load_address: Option<u64>,
    pub pc_init: Option<u64>,
    pub pc_uninit: Option<u64>,
    pub pc_program_page: u64,
    pub pc_erase_sector: u64,
    pub pc_erase_all: Option<u64>,
    pub pc_verify: Option<u64>,
    pub pc_read: Option<u64>,
    pub data_section_offset: u64,
    pub rtt_location: Option<u64>,
    pub flash_properties: FlashProperties,
    pub cores: Vec<String>,
    pub stack_size: Option<u32>,
    pub stack_overflow_check: Option<bool>,
    pub transfer_encoding: Option<TransferEncoding>,
}

The raw flash algorithm is the description of a flash algorithm, and is usually read from a target description file.

Before it can be used for flashing, it has to be assembled for a specific chip, by determining the RAM addresses which are used when flashing. This process is done in the main probe-rs library.

Fields

name: String

The name of the flash algorithm.

description: String

The description of the algorithm.

default: bool

Whether this flash algorithm is the default one or not.

instructions: Vec<u8>

List of 32-bit words containing the code for the algo. If load_address is not specified, the code must be position independent (PIC).

load_address: Option<u64>

Address to load algo into RAM. Optional.

data_load_address: Option<u64>

Address to load data into RAM. Optional.

pc_init: Option<u64>

Address of the Init() entry point. Optional.

pc_uninit: Option<u64>

Address of the UnInit() entry point. Optional.

pc_program_page: u64

Address of the ProgramPage() entry point.

pc_erase_sector: u64

Address of the EraseSector() entry point.

pc_erase_all: Option<u64>

Address of the EraseAll() entry point. Optional.

pc_verify: Option<u64>

Address of the Verify() entry point. Optional.

pc_read: Option<u64>

Address of the (non-standard) ReadFlash() entry point. Optional.

data_section_offset: u64

The offset from the start of RAM to the data section.

rtt_location: Option<u64>

Location of the RTT control block in RAM.

If this is set, the flash algorithm supports RTT output and debug messages will be read over RTT.

flash_properties: FlashProperties

The properties of the flash on the device.

cores: Vec<String>

List of cores that can use this algorithm

stack_size: Option<u32>

The flash algorithm’s stack size, in bytes.

If not set, probe-rs selects a default value. Increase this value if you’re concerned about stack overruns during flashing.

stack_overflow_check: Option<bool>

Whether to check for stack overflows during flashing.

transfer_encoding: Option<TransferEncoding>

The encoding format accepted by the flash algorithm.

Implementations

impl RawFlashAlgorithm

pub fn stack_overflow_check(&self) -> bool

Whether to check for stack overflows during flashing.

Trait Implementations

impl Clone for RawFlashAlgorithm

fn clone(&self) -> RawFlashAlgorithm

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RawFlashAlgorithm

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

Formats the value using the given formatter.

impl Default for RawFlashAlgorithm

fn default() -> RawFlashAlgorithm

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for RawFlashAlgorithm

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for RawFlashAlgorithm

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for RawFlashAlgorithm

fn eq(&self, other: &RawFlashAlgorithm) -> 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 RawFlashAlgorithm

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for RawFlashAlgorithm

impl StructuralPartialEq for RawFlashAlgorithm