Struct SharedMemConfig 

pub struct SharedMemConfig {
    pub length: u64,
    pub uio: u32,
    pub mtu: u32,
}

Shared-memory region layout for an IPC channel.

Injected as compile-time environment variables by the builder before invoking cargo build. The physical base address is not carried here: the IPC transport never resolves its region from the environment. Controller firmware gets the base baked into its generated init code (via the lowered Address), and the Linux application reaches the same memory through the UIO device named by uio; so no side needs a CONSORTIUM_IPC_BASE.

Fields

length: u64

Length of the region in bytes.

uio: u32

UIO device index the Linux application mmaps to reach the same region.

mtu: u32

Maximum transfer unit (payload bytes per slot) for the channel.

Implementations

impl SharedMemConfig

pub fn from_region(region: MemoryRegion, uio: u32, mtu: u32) -> Self

Builds a resolved config from a [[ipc.channel]] shared-memory region plus the UIO index and MTU the lowering resolved.

Only the region’s length is carried; the physical base is resolved by the generated code, not the environment (see the type docs). uio is the AP-side UIO device index the Linux application mmaps (from LoweredIr’s resolved ApAddress), and mtu is the channel MTU.

pub fn env_pairs(&self, prefix: &str) -> [(String, String); 3]

Environment variable suffixes used when the builder injects this config.

The builder emits CONSORTIUM_<PREFIX>_LENGTH, _UIO, and _MTU, where <PREFIX> is IPC. Consuming crates read these with option_env! and parse them in a const context. Numeric values are emitted as decimal strings even when the source manifest used hexadecimal TOML literals.

Trait Implementations

impl Clone for SharedMemConfig

fn clone(&self) -> SharedMemConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SharedMemConfig

impl Debug for SharedMemConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SharedMemConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SharedMemConfig

impl PartialEq for SharedMemConfig

fn eq(&self, other: &SharedMemConfig) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for SharedMemConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SharedMemConfig