Struct RegisterField 

pub struct RegisterField<const START_OFFSET: usize, const MASK: u64, const DIM: u8, const DIM_INCREMENT: u8, ValueTypeRead, ValueTypeWrite, T, A>
where
    T: RegSpec,
    A: Access,
{ /* private fields */ }

Proxy struct for numeric bitfields

Implementations

impl<const START_OFFSET: usize, const MASK: u64, const DIM: u8, const DIM_INCREMENT: u8, ValueTypeRead, ValueTypeWrite, T, A> RegisterField<START_OFFSET, MASK, DIM, DIM_INCREMENT, ValueTypeRead, ValueTypeWrite, T, A>

where T: RegSpec, A: Access,

pub fn mask(&self) -> T::DataType

Get mask for bitfield, the mask is unshifted and at offset 0

Prefer the use of RegisterField<START_OFFSET, MASK, DIM, DIM_INCREMENT, ValueTypeRead,ValueTypeWrite, T, A>::get() to extract a bitfield value.

pub const fn offset(&self) -> usize

Get offset of bitfield in containing register

Prefer the use of RegisterField<START_OFFSET, MASK, DIM, DIM_INCREMENT, ValueTypeRead,ValueTypeWrite, T, A>::get() to extract a bitfield value.

impl<const START_OFFSET: usize, const MASK: u64, const DIM: u8, const DIM_INCREMENT: u8, ValueTypeRead, ValueTypeWrite, T, A> RegisterField<START_OFFSET, MASK, DIM, DIM_INCREMENT, ValueTypeRead, ValueTypeWrite, T, A>

where T: RegSpec, A: Read, ValueTypeRead: CastFrom<u64>,

pub fn get(&self) -> ValueTypeRead

Extract bitfield from read register value

impl<const START_OFFSET: usize, const MASK: u64, const DIM: u8, const DIM_INCREMENT: u8, ValueTypeRead, ValueTypeWrite, T, A> RegisterField<START_OFFSET, MASK, DIM, DIM_INCREMENT, ValueTypeRead, ValueTypeWrite, T, A>

where T: RegSpec, A: Write, u64: From<ValueTypeWrite>,

pub fn set(self, value: ValueTypeWrite) -> RegValueT<T>

Prepare bitfield value that could be written to register

Example

// example with generic names
// get an instance by reading
let values = TIMER.bitfield_reg().read();
// or by starting with a known value
let value = timer::BitfieldReg::new(0);
// or by starting with the default
let value = timer::BitfieldReg::default();

// set bitfields
let value = value
    // set numeric bitfield
    .bitfieldw()
    .set(0x55)
    // set enumerated bitfield with enumeration
    .bitfieldenumerated()
    .set(timer::bitfield_reg::BitfieldEnumerated::GPIOA_0)
    // set enumerated bitfield from integer
    .bitfieldenumerated()
    .set(1.into());

// up until now no hardware change has taken place, do that now by writing
TIMER.bitfield_reg().write(value);