Struct tock_registers::LocalRegisterCopy

pub struct LocalRegisterCopy<T: UIntLike, R: RegisterLongName = ()> { /* private fields */ }

A read-write copy of register contents.

This behaves very similarly to a read-write register, but instead of doing a volatile read to MMIO to get the value for each function call, a copy of the register contents are stored locally in memory. This allows a peripheral to do a single read on a register, and then check which bits are set without having to do a full MMIO read each time. It also allows the value of the register to be “cached” in case the peripheral driver needs to clear the register in hardware yet still be able to check the bits. You can write to a local register, which will modify the stored value, but will not modify any hardware because it operates only on local copy.

This type does not implement the Readable and Writeable traits because it requires a mutable reference to modify the contained value. It still mirrors the interface which would be exposed by a type implementing Readable, Writeable and ReadWriteable.

Implementations

impl<T: UIntLike, R: RegisterLongName> LocalRegisterCopy<T, R>

pub const fn new(value: T) -> Self

pub fn get(&self) -> T

Get the raw register value

pub fn set(&mut self, value: T)

Set the raw register value

pub fn read(&self, field: Field<T, R>) -> T

Read the value of the given field

pub fn read_as_enum<E: TryFromValue<T, EnumType = E>>( &self, field: Field<T, R> ) -> Option<E>

Read value of the given field as an enum member

pub fn write(&mut self, field: FieldValue<T, R>)

Write the value of one or more fields, overwriting the other fields with zero

pub fn modify(&mut self, field: FieldValue<T, R>)

Write the value of one or more fields, leaving the other fields unchanged

pub fn is_set(&self, field: Field<T, R>) -> bool

Check if one or more bits in a field are set

pub fn any_matching_bits_set(&self, field: FieldValue<T, R>) -> bool

Check if any bits corresponding to the mask in the passed FieldValue are set.

pub fn matches_all(&self, field: FieldValue<T, R>) -> bool

Check if all specified parts of a field match

pub fn matches_any(&self, fields: &[FieldValue<T, R>]) -> bool

Check if any of the passed parts of a field exactly match the contained value. This allows for matching on unset bits, or matching on specific values in multi-bit fields.

pub fn bitand(&self, rhs: T) -> LocalRegisterCopy<T, R>

Do a bitwise AND operation of the stored value and the passed in value and return a new LocalRegisterCopy.

Trait Implementations

impl<T: Clone + UIntLike, R: Clone + RegisterLongName> Clone for LocalRegisterCopy<T, R>

fn clone(&self) -> LocalRegisterCopy<T, R>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: UIntLike + Debug, R: RegisterLongName> Debug for LocalRegisterCopy<T, R>

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

Formats the value using the given formatter.

impl<R: RegisterLongName> From<LocalRegisterCopy<u128, R>> for u128

fn from(r: LocalRegisterCopy<u128, R>) -> u128

Converts to this type from the input type.

impl<R: RegisterLongName> From<LocalRegisterCopy<u16, R>> for u16

fn from(r: LocalRegisterCopy<u16, R>) -> u16

Converts to this type from the input type.

impl<R: RegisterLongName> From<LocalRegisterCopy<u32, R>> for u32

fn from(r: LocalRegisterCopy<u32, R>) -> u32

Converts to this type from the input type.

impl<R: RegisterLongName> From<LocalRegisterCopy<u64, R>> for u64

fn from(r: LocalRegisterCopy<u64, R>) -> u64

Converts to this type from the input type.

impl<R: RegisterLongName> From<LocalRegisterCopy<u8, R>> for u8

fn from(r: LocalRegisterCopy<u8, R>) -> u8

Converts to this type from the input type.

impl<R: RegisterLongName> From<LocalRegisterCopy<usize, R>> for usize

fn from(r: LocalRegisterCopy<usize, R>) -> usize

Converts to this type from the input type.

impl<T: Copy + UIntLike, R: Copy + RegisterLongName> Copy for LocalRegisterCopy<T, R>