Struct drone_svd::Peripheral

[+] Show declaration

[+] Expand attributes
#[non_exhaustive]pub struct Peripheral {
    pub derived_from: Option<String>,
    pub dim: Option<u32>,
    pub dim_increment: Option<u32>,
    pub name: String,
    pub description: Option<String>,
    pub alternate_peripheral: Option<String>,
    pub base_address: u32,
    pub size: Option<u32>,
    pub reset_value: Option<u32>,
    pub access: Option<Access>,
    // some fields omitted
}

[−] Expand description

A peripheral of a device.

Fields (Non-exhaustive)

[+] This struct is marked as 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.

derived_from: Option<String>

[−] Expand description

The peripheral name from which to inherit data.

dim: Option<u32>

[−] Expand description

Define the number of elements in an array.

dim_increment: Option<u32>

[−] Expand description

Specify the address increment, in Bytes, between two neighboring array members in the address map.

name: String

[−] Expand description

The string identifies the peripheral.

description: Option<String>

[−] Expand description

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

alternate_peripheral: Option<String>

[−] Expand description

A peripheral redefining an address block needs to specify the name of the peripheral that is listed first in the description.

base_address: u32

[−] Expand description

Lowest address reserved or used by the peripheral.

size: Option<u32>

[−] Expand description

Default bit-width of any register contained in the peripheral.

reset_value: Option<u32>

[−] Expand description

Default value for all registers in the peripheral at RESET.

access: Option<Access>

[−] Expand description

Default access rights for all registers in the peripheral.

Implementations

impl Peripheral[−]

pub fn reg(&mut self, path: &str) -> &mut Register[−]

Returns a mutable reference to the register at the path path.

pub fn add_reg(&mut self, register: Register)[−]

Adds a new register register.

pub fn new_reg(&mut self, f: impl FnOnce(&mut Register))[−]

Adds a new register initialized by f.

pub fn remove_reg(&mut self, path: &str) -> Register[−]

Removes the register at the path path.

Trait Implementations

impl Clone for Peripheral[+]

[+] Show hidden undocumented items

fn clone(&self) -> Peripheral[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for Peripheral[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Default for Peripheral[+]

[+] Show hidden undocumented items

fn default() -> Peripheral[−]

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Peripheral[+]

[+] Show hidden undocumented items

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, [−]

Deserialize this value from the given Serde deserializer.