axplat 0.4.0

This crate provides a unified abstraction layer for diverse hardware platforms.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

#![cfg_attr(not(test), no_std)]
#![cfg_attr(docsrs, feature(doc_cfg))]
#![doc = include_str!("../README.md")]

#[macro_use]
extern crate crate_interface;

pub mod console;
pub mod init;
#[cfg(feature = "irq")]
pub mod irq;
pub mod mem;
pub mod power;
pub mod time;

pub use axplat_macros::main;
pub use crate_interface::impl_interface;

#[cfg(feature = "smp")]
pub use axplat_macros::secondary_main;

#[doc(hidden)]
pub mod __priv {
    pub use const_str::equal as const_str_eq;
}

/// Checks that two strings are equal. If they are not equal, it will cause a compile-time
/// error. And the message will be printed if it is provided.
///
/// # Example
///
/// ```rust
/// extern crate axplat;
/// const A: &str = "hello";
/// const B: &str = "hello";
/// axplat::assert_str_eq!(A, B);
/// ```
///
/// ```compile_fail
/// extern crate axplat;
/// const A: &str = "hello";
/// const B: &str = "world";
/// axplat::assert_str_eq!(A, B, "A and B are not equal!");
/// ```
#[macro_export]
macro_rules! assert_str_eq {
    ($expect:expr, $actual:expr, $mes:literal) => {
        const _: () = assert!($crate::__priv::const_str_eq!($expect, $actual), $mes);
    };
    ($expect:expr, $actual:expr $(,)?) => {
        const _: () = assert!(
            $crate::__priv::const_str_eq!($expect, $actual),
            "assertion failed: expected != actual.",
        );
    };
}

/// Call the function decorated by [`axplat::main`][main] for the primary core.
///
/// This function should only be called by the platform implementer, not the kernel.
pub fn call_main(cpu_id: usize, arg: usize) -> ! {
    unsafe { __axplat_main(cpu_id, arg) }
}

/// Call the function decorated by [`axplat::secondary_main`][secondary_main] for secondary cores.
///
/// This function should only be called by the platform implementer, not the kernel.
#[cfg(feature = "smp")]
pub fn call_secondary_main(cpu_id: usize) -> ! {
    unsafe { __axplat_secondary_main(cpu_id) }
}

unsafe extern "Rust" {
    fn __axplat_main(cpu_id: usize, arg: usize) -> !;
    fn __axplat_secondary_main(cpu_id: usize) -> !;
}