Struct svd_rs::peripheral::Peripheral

#[non_exhaustive]
pub struct Peripheral {
    pub name: String,
    pub display_name: Option<String>,
    pub version: Option<String>,
    pub description: Option<String>,
    pub group_name: Option<String>,
    pub base_address: u64,
    pub default_register_properties: RegisterProperties,
    pub address_block: Option<Vec<AddressBlock>>,
    pub interrupt: Vec<Interrupt>,
    pub registers: Option<Vec<RegisterCluster>>,
    pub derived_from: Option<String>,
}

A description of a peripheral in the device, describing, for example, the memory mappings.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

The string identifies the peripheral. Peripheral names are required to be unique for a device

display_name: Option<String>

Specifies a register name without the restrictions of an ANSI C identifier.

version: Option<String>

The string specifies the version of this peripheral description

description: Option<String>

The string provides an overview of the purpose and functionality of the peripheral

group_name: Option<String>

Assigns this peripheral to a group of peripherals. This is only used bye the System View

base_address: u64

Lowest address reserved or used by the peripheral

default_register_properties: RegisterProperties

Default properties for all registers

address_block: Option<Vec<AddressBlock>>

Specify an address range uniquely mapped to this peripheral

interrupt: Vec<Interrupt>

A peripheral can have multiple associated interrupts

registers: Option<Vec<RegisterCluster>>

Group to enclose register definitions. None indicates that the <registers> node is not present

derived_from: Option<String>

Specify the peripheral name from which to inherit data. Elements specified subsequently override inherited values

Implementations

impl Peripheral

pub fn builder() -> PeripheralBuilder

Make a builder for Peripheral

pub fn modify_from(
    &mut self,
    builder: PeripheralBuilder,
    lvl: ValidateLevel
) -> Result<(), SvdError>

Modify an existing Peripheral based on a builder.

pub fn validate(&mut self, lvl: ValidateLevel) -> Result<(), SvdError>

Validate the Peripheral

pub fn reg_iter(&self) -> RegIter<'_>

returns iterator over all registers peripheral contains

pub fn reg_iter_mut(&mut self) -> RegIterMut<'_>

returns mutable iterator over all registers peripheral contains

Trait Implementations

impl Clone for Peripheral

fn clone(&self) -> Peripheral

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Peripheral

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

Formats the value using the given formatter.

impl From<Peripheral> for PeripheralBuilder

fn from(p: Peripheral) -> Self

Performs the conversion.

impl PartialEq<Peripheral> for Peripheral

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for Peripheral