limine 0.6.3

Rust interface for the Limine boot protocol
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91

// Copyright © 2026, Julian Scheffers
// SPDX-License-Identifier: MIT OR Apache-2.0

#![no_std]
#![allow(unused)]
#![feature(ptr_metadata)]

use core::cell::UnsafeCell;

use request::BootloaderInfoRequest;

pub mod entrypoint;
pub mod file;
pub mod firmware;
pub mod framebuffer;
pub mod memmap;
pub mod module;
pub mod mp;
pub mod paging;
pub mod request;
pub mod uuid;

/// Common magic for requests.
pub const COMMON_MAGIC: [u64; 2] = [0xc7b1dd30df4c8b88, 0x0a82e883a194f07b];

/// Request that Limine uses a certain base revision.
/// If omitted, 0 is used.
/// A conformant kernel should test that either [`BaseRevision::is_supported`] is true,
/// or [`BaseRevision::actual_revision()`] specifies a revision supported by the kernel.
#[repr(C)]
pub struct BaseRevision {
    magic: UnsafeCell<[u64; 3]>,
}
unsafe impl Send for BaseRevision {}
unsafe impl Sync for BaseRevision {}

impl BaseRevision {
    /// Currently highest supported base revision.
    pub const MAX_SUPPORTED: u64 = 6;

    /// Use the default base revision.
    /// Identical to `BaseRevision::with_revision(BaseRevision::MAX_SUPPORTED)`.
    pub const fn new() -> Self {
        Self::with_revision(Self::MAX_SUPPORTED)
    }

    /// Use a specific base revision.
    pub const fn with_revision(revision: u64) -> Self {
        Self {
            magic: UnsafeCell::new([0xf9562b2d5c95a6c8, 0x6a7b384944536bdc, revision]),
        }
    }

    /// Whether the requested revision is supported.
    pub fn is_supported(&self) -> bool {
        unsafe { (self.magic.get() as *const u64).add(2).read_volatile() == 0 }
    }

    /// What revision is actually in use right now, regardless of whether it is the requested one.
    pub fn actual_revision(&self) -> Option<u64> {
        let actual = unsafe { (self.magic.get() as *const u64).add(1).read_volatile() };
        if actual == 0x6a7b384944536bdc {
            None
        } else {
            Some(actual)
        }
    }
}

/// Requests start marker; the bootloader must ignore requests before this marker.
pub struct RequestsStartMarker([u64; 4]);

impl RequestsStartMarker {
    pub const fn new() -> Self {
        Self([
            0xf6b8f4b39de7d1ae,
            0xfab91a6940fcb9cf,
            0x785c6ed015d3e316,
            0x181e920a7852b9d9,
        ])
    }
}

/// Requests end marker; the bootloader must ignore requests after this marker.
pub struct RequestsEndMarker([u64; 2]);

impl RequestsEndMarker {
    pub const fn new() -> Self {
        Self([0xadc0e0531bb10d03, 0x9572709f31764c62])
    }
}