Struct peripherals::Reg

pub struct Reg<R, P> { /* fields omitted */ }

Base struct for all registers

This is the struct that allows to read and write registers. It is created as part of the peripheral struct generated by the periph! macro. The type parameters indicate the actual register and the peripheral it belongs to.

Implementations

impl<R: Register, P: Peripheral> Reg<R, P>

pub fn ptr(&self) -> *const R::Int

Get a raw pointer to the register

pub fn ptr_mut(&mut self) -> *mut R::Int

Get a mutable raw pointer to the register

pub fn into_dyn(self) -> &'static mut DynReg<R>

Erase peripheral information

This allows to choose at runtime which instance of a peripheral to use.

impl<R: ReadRegister, P: Peripheral> Reg<R, P>

pub fn read(&self) -> Value<R::Value>

Read the current value of this register

This returns a Value, which can be used to read fields or modified and written back.

pub fn field<T>(&self, field: Field<R::Value, T, R::Int>) -> T where
    R::Int: TryInto<T>,
    <R::Int as TryInto<T>>::Error: Debug, 

Read the given field

Same as register.read().field(fields). See Value::field for more details.

pub fn fields<F: Into<Fields<R::Value>> + MayToggle>(
    &self,
    fields: F
) -> FieldValues<R::Value, F::Toggle>

Read the given fields

Same as register.read() & fields. See Value for more details.

pub fn test<B: Into<FieldValues<R::Value>>>(&self, bits: B) -> bool

Test the value of the given fields

Same as register.read().test(bits). See Value::test for more details.

impl<R: WriteRegister, P: Peripheral> Reg<R, P>

pub fn write(&mut self, value: Value<R::Value>)

Write a value to this register

This takes a Value, which can be read from a register or created with Default.

pub fn reset(&mut self)

Reset this register

This set the register to the value it has right after a reset or a boot.

impl<R: ReadRegister + WriteRegister, P: Peripheral> Reg<R, P>

pub fn modify<B: Into<FieldValues<R::Value>>>(&mut self, bits: B)

Modify the given fields

This takes any field defined for this register by the periph! macro. These fields can also be combined with the | operator.

pub fn toggle<F: Into<Fields<R::Value, Toggle>>>(&mut self, fields: F)

Toggle the given fields

This takes a toggleable field defined for this register by the periph! macro. These fields can also be combined with the | operator.

Trait Implementations

impl<R: Register, P: Peripheral> Debug for Reg<R, P>

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

Formats the value using the given formatter.