roxy-loader-api 0.1.5

Kernel-facing API types and macros for roxy-loader.
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

/// Defines the entry point used by kernels started with `roxy-loader`.
///
/// Use this macro in the crate that contains your kernel entry function.
/// It connects your function to the startup convention expected by
/// `roxy-loader`.
///
/// # Examples
///
/// ```ignore
/// #![no_std]
/// #![no_main]
///
/// use roxy_loader_api::{bootinfo::BootInfo, kernel_entry};
///
/// kernel_entry!(kernel_main);
///
/// fn kernel_main(bootinfo: &BootInfo) -> ! {
///     let _framebuffer = bootinfo.framebuffer;
///
///     loop {}
/// }
/// ```
#[macro_export]
macro_rules! kernel_entry {
    ($kernel_main:ident) => {
        #[unsafe(no_mangle)]
        extern "sysv64" fn _start(bootinfo: *const $crate::bootinfo::BootInfo) -> ! {
            unsafe {
                let bootinfo = &*bootinfo;
                $kernel_main(bootinfo);
            }
        }
    };
}