[][src]Trait drone_core::reg::Reg

pub trait Reg<T: RegTag>: Token + Sync {
    type Val: Bitfield;
    type UReg: Reg<Urt>;
    type SReg: Reg<Srt>;
    type CReg: Reg<Crt>;

    const ADDRESS: usize;
    const RESET: <Self::Val as Bitfield>::Bits;

    unsafe fn val_from(bits: <Self::Val as Bitfield>::Bits) -> Self::Val;

    fn into_unsync(self) -> Self::UReg
    where
        T: RegOwned
, { ... }
fn into_sync(self) -> Self::SReg
    where
        T: RegOwned
, { ... }
fn into_copy(self) -> Self::CReg { ... }
fn as_sync(&self) -> &Self::SReg
    where
        T: RegAtomic
, { ... }
fn default_val(&self) -> Self::Val { ... } }

The base trait for a memory-mapped register token.

Associated Types

type Val: Bitfield

Opaque storage for register values.

This type is only a storage, without methods to read or write the stored bits. It should be used in conjunction with RegHold or register fields.

See also Hold.

type UReg: Reg<Urt>

Corresponding unsynchronized register token.

type SReg: Reg<Srt>

Corresponding synchronized register token.

type CReg: Reg<Crt>

Corresponding copyable register token.

Loading content...

Associated Constants

const ADDRESS: usize

The register address in memory.

const RESET: <Self::Val as Bitfield>::Bits

The register default value.

Loading content...

Required methods

unsafe fn val_from(bits: <Self::Val as Bitfield>::Bits) -> Self::Val

Creates a new instance of Reg::Val from raw bits.

Safety

This function is unsafe because it doesn't require a token.

Loading content...

Provided methods

fn into_unsync(self) -> Self::UReg where
    T: RegOwned

Converts into unsynchronized register token.

fn into_sync(self) -> Self::SReg where
    T: RegOwned

Converts into synchronized register token.

fn into_copy(self) -> Self::CReg

Converts into copyable register token.

fn as_sync(&self) -> &Self::SReg where
    T: RegAtomic

Returns a reference to the synchronized register token.

fn default_val(&self) -> Self::Val

Creates a new opaque register value, and initializes it with the reset value.

See also default.

Loading content...

Implementors

Loading content...