Struct drone_svd::Device

#[non_exhaustive]
pub struct Device {
    pub name: String,
    pub size: Option<u32>,
    pub reset_value: Option<u32>,
    pub access: Option<Access>,
    // some fields omitted
}

The outermost frame of the description.

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 device or device series.

size: Option<u32>

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

reset_value: Option<u32>

Default value for all registers at RESET.

access: Option<Access>

Default access rights for all registers.

Methods

impl Device

pub fn new(name: String) -> Self

Creates a new empty device definition.

pub fn periph(&mut self, name: &str) -> &mut Peripheral

Returns a mutable reference to the peripheral with name name.

pub fn add_periph(&mut self, peripheral: Peripheral)

Inserts a new peripheral peripheral.

pub fn new_periph(&mut self, f: impl FnOnce(&mut Peripheral))

Inserts a new peripheral initialized by f.

pub fn remove_periph(&mut self, name: &str) -> Peripheral

Removes the peripheral with name name

pub fn generate_regs(
    self,
    regs: &mut File,
    except: &[&str],
    pool_number: usize,
    pool_size: usize
) -> Result<()>

Writes register binding definitions to the file regs.

pub fn generate_rest(
    self,
    reg_index: &mut File,
    interrupts: &mut File,
    except: &[&str],
    reg_index_macro: &str
) -> Result<()>

Writes interrupt binding definitions to the file interrupts and register bindings index to the file reg_index.

Trait Implementations

impl Clone for Device

fn clone(&self) -> Device

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Device

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Device

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

Deserialize this value from the given Serde deserializer.