Struct kernel::utilities::registers::Field

pub struct Field<T, R>
where
    T: UIntLike,
    R: RegisterLongName,
{
    pub mask: T,
    pub shift: usize,
    /* private fields */
}

Specific section of a register.

For the Field, the mask is unshifted, ie. the LSB should always be set.

Fields

mask: T

shift: usize

Implementations

impl<T, R> Field<T, R>

where T: UIntLike, R: RegisterLongName,

pub const fn new(mask: T, shift: usize) -> Field<T, R>

pub fn read(self, val: T) -> T

pub fn is_set(self, val: T) -> bool

Check if one or more bits in a field are set

pub fn read_as_enum<E>(self, val: T) -> Option<E>

where E: TryFromValue<T, EnumType = E>,

Read value of the field as an enum member

This method expects to be passed the unasked and unshifted register value, extracts the field value by calling Field::read and subsequently passes that value to the TryFromValue implementation on the passed enum type.

The register_bitfields! macro will generate an enum containing the various named field variants and implementing the required TryFromValue trait. It is accessible as $REGISTER_NAME::$FIELD_NAME::Value.

This method can be useful to symbolically represent read register field states throughout the codebase and to enforce exhaustive matches over all defined valid register field values.

Usage Example

register_bitfields![u8,
    EXAMPLEREG [
        TESTFIELD OFFSET(3) NUMBITS(3) [
            Foo = 2,
            Bar = 3,
            Baz = 6,
        ],
    ],
];

assert_eq!(
    EXAMPLEREG::TESTFIELD.read_as_enum::<EXAMPLEREG::TESTFIELD::Value>(0x9C).unwrap(),
    EXAMPLEREG::TESTFIELD::Value::Bar
);

impl<R> Field<u8, R>

where R: RegisterLongName,

pub const fn val(&self, value: u8) -> FieldValue<u8, R>

impl<R> Field<u16, R>

where R: RegisterLongName,

pub const fn val(&self, value: u16) -> FieldValue<u16, R>

impl<R> Field<u32, R>

where R: RegisterLongName,

pub const fn val(&self, value: u32) -> FieldValue<u32, R>

impl<R> Field<u64, R>

where R: RegisterLongName,

pub const fn val(&self, value: u64) -> FieldValue<u64, R>

impl<R> Field<u128, R>

where R: RegisterLongName,

pub const fn val(&self, value: u128) -> FieldValue<u128, R>

impl<R> Field<usize, R>

where R: RegisterLongName,

pub const fn val(&self, value: usize) -> FieldValue<usize, R>

Trait Implementations

impl<T, R> Clone for Field<T, R>

where T: UIntLike, R: RegisterLongName,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, R> Copy for Field<T, R>

where T: UIntLike, R: RegisterLongName,