Struct ReadWriteRiscvCsr

pub struct ReadWriteRiscvCsr<T: UIntLike, R: RegisterLongName, const V: usize> { /* private fields */ }

Read/Write registers.

Implementations

impl<R: RegisterLongName, const V: usize> ReadWriteRiscvCsr<usize, R, V>

pub const fn new() -> Self

pub fn atomic_replace(&self, val_to_set: usize) -> usize

Atomically swap the contents of a CSR

Reads the current value of a CSR and replaces it with the specified value in a single instruction, returning the previous value.

This method corresponds to the RISC-V CSRRW rd, csr, rs1 instruction where rs1 = in(reg) value_to_set and rd = out(reg) <return value>.

pub fn read_and_set_bits(&self, bitmask: usize) -> usize

Atomically read a CSR and set bits specified in a bitmask

This method corresponds to the RISC-V CSRRS rd, csr, rs1 instruction where rs1 = in(reg) bitmask and rd = out(reg) <return value>.

pub fn read_and_clear_bits(&self, bitmask: usize) -> usize

Atomically read a CSR and clear bits specified in a bitmask

This method corresponds to the RISC-V CSRRC rd, csr, rs1 instruction where rs1 = in(reg) bitmask and rd = out(reg) <return value>.

pub fn read_and_set_field(&self, field: Field<usize, R>) -> usize

Atomically read field and set all bits to 1

This method corresponds to the RISC-V CSRRS rd, csr, rs1 instruction, where rs1 is the bitmask described by the Field.

The previous value of the field is returned.

pub fn read_and_clear_field(&self, field: Field<usize, R>) -> usize

Atomically read field and set all bits to 0

This method corresponds to the RISC-V CSRRC rd, csr, rs1 instruction, where rs1 is the bitmask described by the Field.

The previous value of the field is returned.

Trait Implementations

impl<T: Clone + UIntLike, R: Clone + RegisterLongName, const V: usize> Clone for ReadWriteRiscvCsr<T, R, V>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: RegisterLongName, const V: usize> Readable for ReadWriteRiscvCsr<usize, R, V>

type T = usize

type R = R

fn get(&self) -> usize

Get the raw register value

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

Read the value of the given field

fn read_as_enum<E>(&self, field: Field<Self::T, Self::R>) -> Option<E>

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

Set the raw register value

fn extract(&self) -> LocalRegisterCopy<Self::T, Self::R>

Make a local copy of the register

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

Check if one or more bits in a field are set

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

Check if any bits corresponding to the mask in the passed FieldValue are set. This function is identical to is_set() but operates on a FieldValue rather than a Field, allowing for checking if any bits are set across multiple, non-contiguous portions of a bitfield.

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

Check if all specified parts of a field match

fn matches_any(&self, fields: &[FieldValue<Self::T, Self::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.

impl<R: RegisterLongName, const V: usize> Writeable for ReadWriteRiscvCsr<usize, R, V>

type T = usize

type R = R

fn set(&self, val_to_set: usize)

Set the raw register value

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

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

fn modify_no_read( &self, original: LocalRegisterCopy<Self::T, Self::R>, field: FieldValue<Self::T, Self::R>, )

Write the value of one or more fields, maintaining the value of unchanged fields via a provided original value, rather than a register read.

impl<T: Copy + UIntLike, R: Copy + RegisterLongName, const V: usize> Copy for ReadWriteRiscvCsr<T, R, V>