Struct MmioPtr 

pub struct MmioPtr<T, Access: Accessible>(/* private fields */);

Represents a pointer to an MMIO address - with specific access permissions - at which a register might be located.

Implementations

impl<T, R> MmioPtr<T, (R, NoWrite)>

where (R, NoWrite): Accessible,

pub const unsafe fn new(ptr: *const T) -> Self

Constructs a new, read-only MMIO pointer wrapper.

Safety

The caller must guarantee the safety preconditions of [core::ptr::read_volatile()] for the lifetime of MmioPtr. In particular…

• that ptr is aligned and points to a mapped MMIO address;

• the mapping remains valid for the lifetime of the returned MmioPtr (and any copies of it);

• accesses must never trap.

Note that it is not assumed that the backing memory is immutable.

pub const fn as_ptr(self) -> *const T

Returns the underlying pointer.

impl<T, Access: Writable> MmioPtr<T, Access>

pub const unsafe fn new(ptr: *mut T) -> Self

Constructs a new, writable MMIO pointer wrapper.

Safety

The caller must guarantee the safety preconditions of [core::ptr::read_volatile()] (if readable) and [core::ptr::write_volatile()] for the lifetime of MmioPtr. In particular…

• that ptr is aligned and points to a mapped MMIO address;

• the mapping remains valid for the lifetime of the returned MmioPtr (and any copies of it);

• accesses must never trap.

Also,

• If Access expresses safe-writability (see SafeWrite), that writing any value whatsoever to this address cannot result in undefined behaviour.

Note that it is not assumed that the backing memory is immutable, or that a writable MmioPtr has exclusive access to it.

pub const fn as_ptr(self) -> *mut T

Returns the underlying pointer.

impl<T, Access: Accessible> MmioPtr<T, Access>

pub const fn restrict<NewAccess>(self) -> MmioPtr<T, NewAccess>

where NewAccess: Accessible, Access: AccessRestrictsTo<NewAccess>,

Restricts the access permissions of this pointer.

Trait Implementations

impl<T, Access: Accessible> Clone for MmioPtr<T, Access>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, Access: Accessible> Copy for MmioPtr<T, Access>

impl<T: Debug, Access: Debug + Accessible> Debug for MmioPtr<T, Access>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T, Access> IoHandle for MmioPtr<T, Access>

where T: Copy, Access: Accessible,

type Base = T

The underlying base type of the register (assumed integral in practice).

impl<Access> ReadHandle for MmioPtr<u8, Access>

where Access: Readable,

unsafe fn read_raw(&self) -> u8

Performs the read.

impl<Access> ReadHandle for MmioPtr<u16, Access>

where Access: Readable,

unsafe fn read_raw(&self) -> u16

Performs the read.

impl<Access> ReadHandle for MmioPtr<u32, Access>

where Access: Readable,

unsafe fn read_raw(&self) -> u32

Performs the read.

impl<Access> ReadHandle for MmioPtr<u64, Access>

where Access: Readable,

unsafe fn read_raw(&self) -> u64

Performs the read.

impl<T, Access: Accessible> Send for MmioPtr<T, Access>

impl<T, Access: Accessible> Sync for MmioPtr<T, Access>

impl<Access> WriteHandle for MmioPtr<u8, Access>

where Access: Writable,

unsafe fn write_raw(&self, value: u8)

Performs the write of the provided value.

impl<Access> WriteHandle for MmioPtr<u16, Access>

where Access: Writable,

unsafe fn write_raw(&self, value: u16)

Performs the write of the provided value.

impl<Access> WriteHandle for MmioPtr<u32, Access>

where Access: Writable,

unsafe fn write_raw(&self, value: u32)

Performs the write of the provided value.

impl<Access> WriteHandle for MmioPtr<u64, Access>

where Access: Writable,

unsafe fn write_raw(&self, value: u64)

Performs the write of the provided value.