Struct svd_rs::registerinfo::RegisterInfo [−][src]
#[non_exhaustive]pub struct RegisterInfo {
pub name: String,
pub display_name: Option<String>,
pub description: Option<String>,
pub alternate_group: Option<String>,
pub alternate_register: Option<String>,
pub address_offset: u32,
pub properties: RegisterProperties,
pub modified_write_values: Option<ModifiedWriteValues>,
pub write_constraint: Option<WriteConstraint>,
pub fields: Option<Vec<Field>>,
pub derived_from: Option<String>,
}
Expand description
A register is a named, programmable resource that belongs to a peripheral.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.name: String
String to identify the register. Register names are required to be unique within the scope of a peripheral
display_name: Option<String>
Specifies a register name without the restrictions of an ANSI C identifier.
description: Option<String>
String describing the details of the register
alternate_group: Option<String>
Specifies a group name associated with all alternate register that have the same name
alternate_register: Option<String>
This tag can reference a register that has been defined above to current location in the description and that describes the memory location already
address_offset: u32
Define the address offset relative to the enclosing element
properties: RegisterProperties
Specifies register size, access permission and reset value
modified_write_values: Option<ModifiedWriteValues>
Specifies the write side effects
write_constraint: Option<WriteConstraint>
Specifies the subset of allowed write values
fields: Option<Vec<Field>>
None
indicates that the <fields>
node is not present
derived_from: Option<String>
Specify the register name from which to inherit data. Elements specified subsequently override inherited values
Implementations
Make a builder for RegisterInfo
pub fn modify_from(
&mut self,
builder: RegisterInfoBuilder,
lvl: ValidateLevel
) -> Result<(), SvdError>
pub fn modify_from(
&mut self,
builder: RegisterInfoBuilder,
lvl: ValidateLevel
) -> Result<(), SvdError>
Modify an existing RegisterInfo
based on a builder.
Validate the RegisterInfo
Trait Implementations
Performs the conversion.
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl RefUnwindSafe for RegisterInfo
impl Send for RegisterInfo
impl Sync for RegisterInfo
impl Unpin for RegisterInfo
impl UnwindSafe for RegisterInfo
Blanket Implementations
Mutably borrows from an owned value. Read more