rustsbi/src/ipi.rs

use crate::hart_mask::HartMask;
use sbi_spec::binary::SbiRet;

#[cfg(feature = "singleton")]
use crate::util::AmoOnceRef;

/// Inter-processor interrupt support
pub trait Ipi: Send + Sync {
    /// Send an inter-processor interrupt to all the harts defined in `hart_mask`.
    ///
    /// Inter-processor interrupts manifest at the receiving harts as the supervisor software interrupts.
    ///
    /// # Return value
    ///
    /// Should return `SbiRet::success()` if IPI was sent to all the targeted harts successfully.
    fn send_ipi(&self, hart_mask: HartMask) -> SbiRet;
}

impl<T: Ipi> Ipi for &T {
    #[inline]
    fn send_ipi(&self, hart_mask: HartMask) -> SbiRet {
        T::send_ipi(self, hart_mask)
    }
}

#[cfg(feature = "singleton")]
static IPI: AmoOnceRef<dyn Ipi> = AmoOnceRef::new();

/// Init singleton IPI module
#[cfg(feature = "singleton")]
pub fn init_ipi(ipi: &'static dyn Ipi) {
    if !IPI.try_call_once(ipi) {
        panic!("load sbi module when already loaded")
    }
}

#[cfg(feature = "singleton")]
#[inline]
pub(crate) fn probe_ipi() -> bool {
    IPI.get().is_some()
}

#[cfg(feature = "singleton")]
#[inline]
pub(crate) fn send_ipi(hart_mask: HartMask) -> SbiRet {
    if let Some(ipi) = IPI.get() {
        return ipi.send_ipi(hart_mask);
    }
    SbiRet::not_supported()
}