Struct MmioReg

pub struct MmioReg<E: Endianess, A: Access, T: Copy> { /* private fields */ }

A memory-mapped I/O register.

This struct defines a memory-mapped I/O register. It is parameterized by:

• E: Endianness of the register (LittleEndian, BigEndian).
• A: Access type of the register (ReadOnly, WriteOnly, ReadWrite).
• T: Type of the register (u8, u16, u32, u64).

Implementations

impl<E: Endianess, A: Access, T: Copy> MmioReg<E, A, T>

pub const fn new(offset: usize) -> MmioReg<E, A, T>

Defines a MMIO register.

pub fn do_read_with_offset(&self, folio: &mut MappedFolio, offset: usize) -> T

Reads a value from the MMIO register with an offset.

This is useful when the MMIO register spans multiple words or unaligned length, such as MAC address (6 bytes).

impl<E: Endianess, T: Copy> MmioReg<E, ReadOnly, T>

pub fn read(&self, folio: &mut MappedFolio) -> T

Reads a value from the MMIO register.

pub fn read_with_offset(&self, folio: &mut MappedFolio, offset: usize) -> T

impl<E: Endianess, T: Copy> MmioReg<E, WriteOnly, T>

pub fn write(&self, folio: &mut MappedFolio, value: T)

Writes a value to the MMIO register.

impl<E: Endianess, T: Copy> MmioReg<E, ReadWrite, T>

pub fn read(&self, folio: &mut MappedFolio) -> T

Reads a value from the MMIO register.

pub fn read_with_offset(&self, folio: &mut MappedFolio, offset: usize) -> T

Writes a value to the MMIO register with an offset.

pub fn write(&self, folio: &mut MappedFolio, value: T)

Writes a value to the MMIO register.

pub fn write_with_offset( &self, folio: &mut MappedFolio, offset: usize, value: T, )

Writes a value to the MMIO register with an offset.