Struct ChipFamily

pub struct ChipFamily {
    pub name: String,
    pub manufacturer: Option<JEP106Code>,
    pub chip_detection: Vec<ChipDetectionMethod>,
    pub generated_from_pack: bool,
    pub pack_file_release: Option<String>,
    pub variants: Vec<Chip>,
    pub flash_algorithms: Vec<RawFlashAlgorithm>,
    pub source: TargetDescriptionSource,
}

This describes a chip family with all its variants.

This struct is usually read from a target description file.

Fields

name: String

This is the name of the chip family in base form. E.g. nRF52832.

manufacturer: Option<JEP106Code>

The JEP106 code of the manufacturer.

chip_detection: Vec<ChipDetectionMethod>

The method(s) that may be able to identify targets in this family.

generated_from_pack: bool

The target-gen process will set this to true. Please change this to false if this file is modified from the generated, or is a manually created target description.

pack_file_release: Option<String>

The latest release of the pack file from which this was generated. Values:

• Some("1.3.0") if the latest pack file release was for example “1.3.0”.
• None if this was not generated from a pack file, or has been modified since it was generated.

variants: Vec<Chip>

This vector holds all the variants of the family.

flash_algorithms: Vec<RawFlashAlgorithm>

This vector holds all available algorithms.

source: TargetDescriptionSource

Source of the target description, used for diagnostics

Implementations

impl ChipFamily

pub fn validate(&self) -> Result<(), String>

Validates the ChipFamily such that probe-rs can make assumptions about the correctness without validating thereafter.

This method should be called right after the ChipFamily is created!

impl ChipFamily

pub fn variants(&self) -> &[Chip]

Get the different Chips which are part of this family.

pub fn algorithms(&self) -> &[RawFlashAlgorithm]

Get all flash algorithms for this family of chips.

pub fn get_algorithm(&self, name: impl AsRef<str>) -> Option<&RawFlashAlgorithm>

Try to find a RawFlashAlgorithm with a given name.

pub fn get_algorithm_for_chip( &self, name: impl AsRef<str>, chip: &Chip, ) -> Option<RawFlashAlgorithm>

Tries to find a RawFlashAlgorithm with a given name and returns it with the core assignment fixed to the cores of the given chip.

Trait Implementations

impl Clone for ChipFamily

fn clone(&self) -> ChipFamily

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChipFamily

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChipFamily

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ChipFamily

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.