Struct svd_expander::RegisterSpec

pub struct RegisterSpec {
    pub name: String,
    pub description: Option<String>,
    pub address_offset: u32,
    pub size: Option<u32>,
    pub reset_value: Option<u32>,
    pub reset_mask: Option<u32>,
    pub access: Option<AccessSpec>,
    pub fields: Vec<FieldSpec>,
    pub default_field_write_constraint: Option<WriteConstraintSpec>,
    pub default_field_modified_write_values: Option<ModifiedWriteValuesSpec>,
    // some fields omitted
}

Describes a register. Registers may be top-level constructs of a peripheral or may be nested within register clusters.

Fields

name: String

Name that identifies the register. Must be unique within the scope of its parent.

description: Option<String>

Description of the details of the register. May describe its purpose, operation, and effects on other parts of the device.

address_offset: u32

Register's starting address relative to its parent.

size: Option<u32>

The bit width of the register.

reset_value: Option<u32>

The value of the register after reset.

reset_mask: Option<u32>

The bits of the register that have a defined reset value.

access: Option<AccessSpec>

The access rights of the register.

fields: Vec<FieldSpec>

The fields that exist on the register.

default_field_write_constraint: Option<WriteConstraintSpec>

Default write constraints for fields on this register

default_field_modified_write_values: Option<ModifiedWriteValuesSpec>

Default modified write values for fields on this register

Implementations

impl RegisterSpec

pub fn derived_from_path(&self) -> Option<String>

The full path to the register that this register inherits from (if any).

pub fn path(&self) -> String

The full path to this register.

pub fn iter_enumerated_value_sets<'a>(
    &'a self
) -> Box<dyn Iterator<Item = &EnumeratedValueSetSpec> + 'a>

Iterates all the enumerated value sets on all the fields in this register.

Trait Implementations

impl Clone for RegisterSpec

fn clone(&self) -> RegisterSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RegisterSpec

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

Formats the value using the given formatter.

impl PartialEq<RegisterSpec> for RegisterSpec

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

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

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

This method tests for !=.

impl StructuralPartialEq for RegisterSpec