consortium-cfg-common 0.5.0

use std::collections::HashMap;

use super::HardwareDoorbellPeripheral;
use crate::config::VisibleCore;

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
#[serde(deny_unknown_fields)]
pub struct ChipDatabase {
    pub name: String,
    pub trm: String,
    pub ap: String,
    /// Device-tree label of this chip's primary interrupt controller (the GIC):
    /// `intc` on STM32MP2, `gic` on i.MX 9. Emitted as `interrupt-parent = <&…>`
    /// on the register-backed (doorbell) UIO nodes so their GIC SPI resolves —
    /// the STM32MP2 root sets no default interrupt-parent, so a doorbell node at
    /// `/` would otherwise bind with no IRQ.
    pub interrupt_parent: String,
    pub cp: Vec<Coprocessor>,
    /// Linux remoteproc loader contracts keyed by coprocessor name.
    #[serde(default)]
    pub remoteproc: HashMap<String, RemoteprocDatabase>,
    pub memory: MemoryDatabase,
    pub peripheral: PeripheralDatabase,
}

/// Chip-specific Linux remoteproc loader contract.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct RemoteprocDatabase {
    /// Compatible string identifying the remoteproc node in the Linux DTS.
    pub compatible: String,
    /// Section name the deployed ELF loader uses to find the vector table.
    pub vector_section: String,
    /// How the generated `memory.x` relates `FLASH` to the vector window.
    pub vector_placement: VectorPlacement,
    /// Mandatory vector-table subregion at the start of the load image.
    pub vector: RemoteprocVector,
    /// Default code/read-only window.
    pub flash: RemoteprocWindow,
    /// Mandatory remoteproc shared-memory region that owns `.resource_table`.
    pub shmem: RemoteprocRegion,
    /// Default writable window.
    pub ram: RemoteprocWindow,
}

/// How a remote core's generated `memory.x` lays out `FLASH` relative to its
/// vector window.
#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum VectorPlacement {
    /// `FLASH` starts at the vector window and spans it plus the flash window,
    /// so `cortex-m-rt` links `.vector_table` at the vector origin; `_stext`
    /// then keeps `.text` inside the flash window. The two windows must be
    /// adjacent. Used by the i.MX 9 cores.
    Flash,
    /// `FLASH` is exactly the flash window and the vector window is emitted as
    /// its own region. Used by STM32MP2.
    Separate,
}

/// The mandatory chip-defined remoteproc shared-memory region.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct RemoteprocRegion {
    pub name: String,
    pub read: bool,
    pub write: bool,
    pub execute: bool,
    pub window: RemoteprocWindow,
}

/// Chip-specific mandatory vector-table memory contract.
#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct RemoteprocVector {
    pub name: String,
    pub read: bool,
    pub write: bool,
    pub execute: bool,
    pub window: RemoteprocWindow,
}

/// One recommended default remoteproc firmware window.
///
/// Manifests may override every field. The same origin is used by the firmware
/// linker, ELF validation, and Linux DTS generation.
#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
pub struct RemoteprocWindow {
    pub origin: u64,
    pub length: u64,
    pub reserve: bool,
}

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct Coprocessor {
    pub name: String,
    pub count: Option<u8>,
    pub variant: CoprocessorVariant,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum CoprocessorVariant {
    Remote,
    Manager,
}

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct MemoryDatabase {
    pub trm_page: Vec<u32>,
    pub aliases: Vec<MemoryAlias>,
    pub regions: Vec<MemoryRegion>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
pub struct MemoryAlias {
    pub offset: u32,
    pub secure: bool,
}

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct MemoryRegion {
    pub name: String,
    pub r#type: MemoryRegionType,
    pub base: u32,
    pub length: u32,
    pub visible: Vec<VisibleCore>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum MemoryRegionType {
    Sram,
}

#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
pub struct PeripheralDatabase {
    pub aliases: Vec<PeripheralAlias>,
    pub doorbells: Vec<HardwareDoorbellPeripheral>,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, serde::Serialize, serde::Deserialize)]
pub struct PeripheralAlias {
    pub address: u32,
    pub secure: bool,
}