riscv-cove 0.0.0

//! Chapter 10. COVE Host Extension (EID #0x434F5648 "COVH").

/// Extension ID for COVE Host Extension.
#[doc(alias = "SBI_EXT_COVH")]
pub const EID_COVH: usize = crate::eid_from_str("COVH") as _;
pub use fid::*;

/// Declared in §10.
mod fid {
    /// Function ID to get TEE Security Monitor (TSM) information.
    ///
    /// Declared in §10.2.
    #[doc(alias = "SBI_EXT_COVH_GET_TSM_INFO")]
    pub const GET_TSM_INFO: usize = 0;
    /// Function ID to convert pages.
    ///
    /// Declared in §10.3.
    #[doc(alias = "SBI_EXT_COVH_CONVERT_PAGES")]
    pub const CONVERT_PAGES: usize = 1;
    /// Function ID to reclaim pages.
    ///
    /// Declared in §10.4.
    #[doc(alias = "SBI_EXT_COVH_RECLAIM_PAGES")]
    pub const RECLAIM_PAGES: usize = 2;
    /// Function ID to initiate global fence.
    ///
    /// Declared in §10.5.
    #[doc(alias = "SBI_EXT_COVH_GLOBAL_FENCE")]
    pub const GLOBAL_FENCE: usize = 3;
    /// Function ID to local fence.
    ///
    /// Declared in §10.6.
    #[doc(alias = "SBI_EXT_COVH_LOCAL_FENCE")]
    pub const LOCAL_FENCE: usize = 4;
    /// Function ID to create TVM.
    ///
    /// Declared in §10.7.
    #[doc(alias = "SBI_EXT_COVH_CREATE_TVM")]
    pub const CREATE_TVM: usize = 5;
    /// Function ID to finalize TVM.
    ///
    /// Declared in §10.8.
    #[doc(alias = "SBI_EXT_COVH_FINALIZE_TVM")]
    pub const FINALIZE_TVM: usize = 6;
    /// Function ID to promote to TVM.
    ///
    /// Declared in §10.9.
    #[doc(alias = "SBI_EXT_COVH_PROMOTE_TO_TVM")]
    pub const PROMOTE_TO_TVM: usize = 7;
    /// Function ID to destroy TVM.
    ///
    /// Declared in §10.10.
    #[doc(alias = "SBI_EXT_COVH_DESTROY_TVM")]
    pub const DESTROY_TVM: usize = 8;
    /// Function ID to add TVM memory region.
    ///
    /// Declared in §10.11.
    #[doc(alias = "SBI_EXT_COVH_ADD_TVM_MEMORY_REGION")]
    pub const ADD_TVM_MEMORY_REGION: usize = 9;
    /// Function ID to add TVM page table pages.
    ///
    /// Declared in §10.12.
    #[doc(alias = "SBI_EXT_COVH_ADD_TVM_PAGE_TABLE_PAGES")]
    pub const ADD_TVM_PAGE_TABLE_PAGES: usize = 10;
    /// Function ID to add TVM measured pages.
    ///
    /// Declared in §10.13.
    #[doc(alias = "SBI_EXT_COVH_ADD_TVM_MEASURED_PAGES")]
    pub const ADD_TVM_MEASURED_PAGES: usize = 11;
    /// Function ID to add TVM zero pages.
    ///
    /// Declared in §10.14.
    #[doc(alias = "SBI_EXT_COVH_ADD_TVM_ZERO_PAGES")]
    pub const ADD_TVM_ZERO_PAGES: usize = 12;
    /// Function ID to add TVM shared pages.
    ///
    /// Declared in §10.15.
    #[doc(alias = "SBI_EXT_COVH_ADD_TVM_SHARED_PAGES")]
    pub const ADD_TVM_SHARED_PAGES: usize = 13;
    /// Function ID to create TVM vCPU.
    ///
    /// Declared in §10.16.
    #[doc(alias = "SBI_EXT_COVH_CREATE_TVM_VCPU")]
    pub const CREATE_TVM_VCPU: usize = 14;
    /// Function ID to run TVM vCPU.
    ///
    /// Declared in §10.17.
    #[doc(alias = "SBI_EXT_COVH_RUN_TVM_VCPU")]
    pub const RUN_TVM_VCPU: usize = 15;
    /// Function ID to initiate TVM fence.
    ///
    /// Declared in §10.18.
    #[doc(alias = "SBI_EXT_COVH_TVM_FENCE")]
    pub const TVM_FENCE: usize = 16;
    /// Function ID to invalidate TVM pages.
    ///
    /// Declared in §10.19.
    #[doc(alias = "SBI_EXT_COVH_TVM_INVALIDATE_PAGES")]
    pub const TVM_INVALIDATE_PAGES: usize = 17;
    /// Function ID to validate TVM pages.
    ///
    /// Declared in §10.20.
    #[doc(alias = "SBI_EXT_COVH_TVM_VALIDATE_PAGES")]
    pub const TVM_VALIDATE_PAGES: usize = 18;
    /// Function ID to remove TVM pages.
    ///
    /// Declared in §10.21.
    #[doc(alias = "SBI_EXT_COVH_TVM_REMOVE_PAGES")]
    pub const TVM_REMOVE_PAGES: usize = 19;
}

/// Possible state of a TEE Virtual Machine (TVM).
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
#[repr(u32)]
pub enum TvmState {
    /// TVM has been created, but isn’t yet ready to run.
    Initializing = 0,
    /// TVM is in a runnable state, and can be executed.
    Runnable = 1,
}

#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
#[repr(u32)]
pub enum TsmPageType {
    /// 4 KiB.
    Page4K = 0,
    /// 2 MiB.
    Page2M = 1,
    /// 1 GiB.
    Page1G = 2,
    /// 512 GiB.
    Page512G = 3,
}

/// Possible state of a TEE Security Manager (TSM).
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
#[repr(u32)]
pub enum TsmState {
    /// TSM has not been loaded on this platform.
    NotLoaded = 0,
    /// TSM has been loaded, but has not yet been initialized.
    Loaded = 1,
    /// TSM has been loaded & initialized, and is ready to accept ECALLs.
    Ready = 2,
}

// TODO generic type of T replacing `usize`s, see sbi_spec::binary::SbiRet
/// Information structure of a TEE Security Manager (TSM).
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
#[repr(C)]
pub struct TsmInfo {
    /// The raw current state of the TSM.
    ///
    /// If the state is not [`Ready`], the remanining fields are invalid
    /// and will be initialized to zero.
    ///
    /// [`Ready`]: struct.TsmState.html#Ready
    pub tsm_state: u32,
    /// Identifier of the TSM implementation.
    ///
    /// This identifier is intended to distinguish among different TSM
    /// implementations, potentially managed by different organizations,
    /// that might target different deployment models and, thus,
    /// implement subset of CoVE specification.
    pub tsm_impl_id: u32,
    /// Version number of the running TSM.
    pub tsm_version: u32,
    /// A bit mask of CoVE features supported by the running TSM.
    ///
    /// Every bit in this field corresponds to a capability defined by
    /// constants. Presense of bit `i` indicates that both the TSM and
    /// hardware support the corresponding capability.
    pub tsm_capabilities: usize,
    /// The number of 4-KiB pages which must be donated to the TSM for
    /// storing TVM state in `covh_create_tvm_vcpu`.
    ///
    /// `0` if the TSM does not support the dynamic memory allocation
    /// capability.
    pub tvm_state_pages: usize,
    /// The maximum number of vCPUs a TVM can support.
    pub tvm_max_vcpus: usize,
    /// The number of 4-KiB pages which must be donated to the TSM when
    /// creating a new vCPU.
    ///
    /// `0` if the TSM does not support the dynamic memory allocation
    /// capability.
    pub tvm_vcpu_state_pages: usize,
}

/// Specified parameters of creating a confidential TEE Virtual Machine (TVM).
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
#[repr(C)]
pub struct TvmCreateParams {
    /// The base physical address of the 16KB confidential memory region
    /// that should be used for the TVM's page directory.
    ///
    /// Must be 16KB-aligned.
    pub tvm_page_directory_addr: usize,
    /// The base physical address of the confidential memory region to
    /// be used to hold the TVM's state.
    ///
    /// Must be page-aligned and the number of pages must be at least
    /// the value returned in tsm_info.vm_state_pages returned by the
    /// call to sbi_covh_get_tsm_info().
    pub tvm_state_addr: usize,
}

// TODO unit tests on offsets of TsmInfo.