Struct MmioRegion 

pub struct MmioRegion {
    base: usize,
    size: usize,
}

Fields

base: usize

size: usize

Implementations

impl MmioRegion

pub const fn new() -> Self

Creates a new instance.

pub fn init(&mut self, base: usize, size: usize)

Performs the init operation.

pub fn base(&self) -> usize

Performs the base operation.

pub fn is_valid(&self) -> bool

Returns whether valid.

pub fn contains(&self, offset: usize, width: usize) -> bool

Bounds + alignment check for a would-be access of width bytes at offset, without performing it.

Drivers exposing user-controllable offsets (e.g. /bus/<drv>/reg/<hex>) must call this before touching MMIO so an out-of-range request fails with a clean error instead of tripping the panic backstop in Self::checked_addr and taking the kernel down.

pub fn check_user_offset(&self, offset: usize) -> Result<(), BusError>

Validate a caller-supplied 32-bit register offset (bounds + natural alignment), mapping failures to [BusError::InvalidAddress] instead of tripping the panic backstop inside the accessors.

fn checked_addr(&self, offset: usize, width: usize) -> usize

Performs the checked addr operation.

Enforces region bounds AND natural alignment for the access width: read_volatile/write_volatile on a misaligned pointer is UB on several supported architectures (strict-alignment ARM/MIPS), not just a slow access.

pub fn read8(&self, offset: usize) -> u8

Performs the read8 operation.

pub fn read16(&self, offset: usize) -> u16

Performs the read16 operation.

pub fn read32(&self, offset: usize) -> u32

Performs the read32 operation.

pub fn read64(&self, offset: usize) -> u64

Performs the read64 operation.

pub fn write8(&self, offset: usize, val: u8)

Performs the write8 operation.

pub fn write16(&self, offset: usize, val: u16)

Performs the write16 operation.

pub fn write32(&self, offset: usize, val: u32)

Performs the write32 operation.

pub fn write64(&self, offset: usize, val: u64)

Performs the write64 operation.

pub fn set_bits32(&self, offset: usize, bits: u32)

Sets bits32.

pub fn clear_bits32(&self, offset: usize, bits: u32)

Performs the clear bits32 operation.

pub fn modify32(&self, offset: usize, clear: u32, set: u32)

Performs the modify32 operation.

pub fn read_field32(&self, offset: usize, mask: u32, shift: u32) -> u32

Reads field32.

pub fn write_field32(&self, offset: usize, mask: u32, shift: u32, value: u32)

Writes field32.

value is masked to the field width before shifting so that a caller passing an unshifted field value can never trigger a shift overflow (value may be up to u32::MAX when shift > 0). Bits of value outside the field width are ignored by contract.

Trait Implementations

impl Send for MmioRegion

impl Sync for MmioRegion