Skip to main content

StateBank

Struct StateBank 

Source
pub struct StateBank { /* private fields */ }
Expand description

Word-addressed software state bank exposing observable driver state slots, policy-gated runtime knobs, read probes, and diagnostic triggers.

Implementations§

Source§

impl StateBank

Source

pub fn new(logical_size: u64) -> StateBank

Creates an empty StateBank with the given byte logical_size.

Source

pub fn logical_size(&self) -> u64

Returns the logical byte size of the state bank.

Source

pub fn writable_offsets(&self) -> &[u64]

Returns the 4-byte aligned offsets that are configured as writable knobs or triggers.

Source

pub fn ceiling(&self) -> ResourceCeiling

Builds the default ResourceCeiling for this state bank, allowing 32-bit reads and polls within logical_size and permitting writes only on offsets registered via Self::define_knob or Self::define_trigger.

Source

pub fn define_state_slot( &mut self, offset: u64, initial: u32, ) -> StateSlotHandle

Defines a read-only 32-bit observable state slot at a 4-byte aligned offset and returns a StateSlotHandle for the driver to update.

Source

pub fn define_knob(&mut self, offset: u64, initial: u32) -> StateSlotHandle

Defines a policy-gated writable 32-bit runtime knob at a 4-byte aligned offset and returns a StateSlotHandle for the driver to read.

Source

pub fn define_read_probe( &mut self, offset: u64, probe: impl Fn() -> Result<u32, BackendError> + Send + Sync + 'static, )

Defines a read-only on-demand probe callback at a 4-byte aligned offset.

Source

pub fn define_trigger( &mut self, offset: u64, trigger: impl Fn(u32) -> Result<u32, BackendError> + Send + Sync + 'static, )

Defines a write-triggered diagnostic action at a 4-byte aligned offset.

Writing value to offset invokes trigger(value) and stores the returned u32 status into the entry’s last_result slot so readback or subsequent read32/poll32 calls observe the trigger outcome.

Trait Implementations§

Source§

impl Clone for StateBank

Source§

fn clone(&self) -> StateBank

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StateBank

Source§

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

Formats the value using the given formatter. Read more
Source§

impl MmioBackend for StateBank

Source§

fn read32(&mut self, offset: u64) -> Result<u32, BackendError>

Performs one volatile 32-bit read at offset bytes from the start of the logical resource.
Source§

fn write32(&mut self, offset: u64, value: u32) -> Result<(), BackendError>

Performs one volatile 32-bit write at offset bytes from the start of the logical resource.
Source§

fn barrier(&mut self)

Applies a platform MMIO memory barrier.
Source§

impl ResourceBackend for StateBank

Source§

fn read32(&mut self, offset: u64) -> Result<u32, BackendError>

Source§

fn write32(&mut self, offset: u64, value: u32) -> Result<(), BackendError>

Source§

fn barrier(&mut self)

Source§

fn gpio_read(&mut self) -> Result<bool, BackendError>

Source§

fn gpio_write(&mut self, _value: bool) -> Result<(), BackendError>

Source§

fn i2c_transfer( &mut self, _write_data: &[u8], _read_length: usize, ) -> Result<Vec<u8>, BackendError>

Source§

fn spi_transmit(&mut self, _tx_data: &[u8]) -> Result<Vec<u8>, BackendError>

Source§

fn clock_enable(&mut self) -> Result<(), BackendError>

Source§

fn clock_disable(&mut self) -> Result<(), BackendError>

Source§

fn clock_is_enabled(&mut self) -> Result<bool, BackendError>

Source§

fn clock_set_rate(&mut self, _hz: u64) -> Result<(), BackendError>

Source§

fn clock_query_rate(&mut self, _hz_in: u64) -> Result<u64, BackendError>

Source§

fn clock_get_rate(&mut self) -> Result<u64, BackendError>

Source§

fn reset_assert(&mut self) -> Result<(), BackendError>

Source§

fn reset_deassert(&mut self) -> Result<(), BackendError>

Source§

fn reset_toggle(&mut self) -> Result<(), BackendError>

Source§

fn reset_status(&mut self) -> Result<bool, BackendError>

Source§

fn serial_read(&mut self) -> Result<Vec<u8>, BackendError>

Source§

fn serial_write(&mut self, _data: &[u8]) -> Result<(), BackendError>

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T, D> Encode<Ambiguous1, D> for T
where D: ResourceDialect,

Source§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
Source§

impl<T, D> Encode<Ambiguous2, D> for T
where D: ResourceDialect,

Source§

unsafe fn encode( self, _encoder: &mut Encoder<'_, D>, _offset: usize, _depth: Depth, ) -> Result<(), Error>

Encodes the object into the encoder’s buffers. Any handles stored in the object are swapped for Handle::INVALID. Read more
§

impl<F, N> FidlIntoNative<Box<N>> for F
where F: FidlIntoNative<N>,

§

fn fidl_into_native(self) -> Box<N>

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> InstanceFromServiceTransport<T> for T

§

fn from_service_transport(handle: T) -> T

Converts the given service transport handle of type T to [Self]
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> IntoAny for T
where T: 'static + Send + Sync,

§

fn into_any(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Cast the given object into a dyn std::any::Any.
Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<E> RunsTransport<Mpsc> for E

§

impl<E> RunsTransport<Mpsc> for E
where E: RunsTransport<Mpsc>,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.