htmos-boot-info 0.9.3

The Boot Information required when booting into HTMOS
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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

//! # Boot Information for the HyperText Markup Operating System
//! 
//! This also includes the entry calling convention and type for the kernel.
//! 
//! It's recommended to use the auto-assigned type HTMOSBootInformation, but I have provided explicit 32- and 64-bit versions of
//! the struct for BIOS bootloading purposes.
//! 
//! When filling out the struct, the 'more_info' field of the struct is optional on BIOS systems; required otherwise.

#![no_std]

#[cfg(target_pointer_width = "32")]
pub type HTMOSBootInformation = HTMOSBootInformation32;
#[cfg(target_pointer_width = "64")]
pub type HTMOSBootInformation = HTMOSBootInformation64;

#[cfg(target_arch = "x86")]
pub type HTMOSEntry = extern "cdecl" fn(*const HTMOSBootInformation) -> !;
#[cfg(target_arch = "x86_64")]
pub type HTMOSEntry = extern "sysv64" fn(*const HTMOSBootInformation) -> !;
// As of right now, I haven't expanded at all on the other archs.  Defaulting to C.
#[cfg(not(any(target_arch = "x86_64", target_arch = "x86")))]
pub type HTMOSEntry = extern "C" fn(*const HTMOSBootInformation) -> !;

/// Boot Information required for successful boot of the HyperText Markup Operation System on 32-bit systems.
#[repr(C)]
pub struct HTMOSBootInformation32 {
    /// "HTMLBOOT" - 0x48544D4C424F4F54
    /// 
    /// HTMOS is forced to panic at the very beginning if this value is not presented correctly.
    pub magic: u64,

    /// Boot mode indicator
    ///
    /// - **0** - BIOS
    /// - **1** - UEFI
    pub boot_mode: u32,

    /// Address to the Memory Map.
    /// - **BIOS** - HTMOS only has support for the E820 Memory Map entries.
    /// - **UEFI** - The memory map will be given to you close to exiting boot services.
    pub memory_map_addr: u32,
    /// Size of the Memory Map
    pub memory_map_size: u32,
    /// Size of a Memory Description
    pub memory_desc_size: u32,

    /// Base address for the Framebuffer
    ///
    /// HTMOS does not have support for VGA text (0xB8000) or the VGA buffer (0xA0000).
    //To use the VGA buffer, **don't use VGA text** as HTMOS does not support that yet.
    pub framebuffer_addr: u32,
    /// Size of the Framebuffer (can be 0 for now, I will change it in the future to require a number > 0)
    pub framebuffer_size: u32,
    /// Number of pixels on a horizontal line
    pub framebuffer_width: u32,
    /// Number of pixels on a vertical line
    pub framebuffer_height: u32,
    /// Number of pixels per scan line
    pub framebuffer_pitch: u32,
    /// Pixel format (UEFI) or Bits Per Pixel (BIOS) of the Framebuffer
    ///
    /// - **BIOS** - This is bbp (**BITS** per pixel); it should come straight from the information given when converting to the framebuffer.
    /// - **UEFI** - As of right now, I'm only aware of UEFI values 0x0 and 0x1.
    pub framebuffer_format: u32,

    /// **BIOS** - Address to raw config tables (if 0, HTMOS will find it manually)
    ///
    /// **UEFI** - Address to the System Table given at the UEFI entry point
    pub more_info: u32,
}

/// Boot Information required for successful boot of the HyperText Markup Operation System on 64-bit systems.
#[repr(C)]
pub struct HTMOSBootInformation64 {
    /// "HTMLBOOT" - 0x48544D4C424F4F54
    /// 
    /// HTMOS is forced to panic at the very beginning if this value is not presented correctly.
    pub magic: u64,

    /// Boot mode indicator
    ///
    /// - **0** - BIOS
    /// - **1** - UEFI
    pub boot_mode: u64,

    /// Address to the Memory Map.
    /// - **BIOS** - HTMOS only has support for the E820 Memory Map entries.
    /// - **UEFI** - The memory map will be given to you close to exiting boot services.
    pub memory_map_addr: u64,
    /// Size of the Memory Map
    pub memory_map_size: u64,
    /// Size of a Memory Description
    pub memory_desc_size: u64,

    /// Base address for the Framebuffer
    ///
    /// HTMOS does not have support for VGA text (0xB8000) or the VGA buffer (0xA0000).
    //To use the VGA buffer, **don't use VGA text** as HTMOS does not support that yet.
    pub framebuffer_addr: u64,
    /// Size of the Framebuffer (can be 0 for now, I will change it in the future to require a number > 0)
    pub framebuffer_size: u64,
    /// Number of pixels on a horizontal line
    pub framebuffer_width: u32,
    /// Number of pixels on a vertical line
    pub framebuffer_height: u32,
    /// Number of pixels per scan line
    pub framebuffer_pitch: u32,
    /// Pixel format (UEFI) or Bits Per Pixel (BIOS) of the Framebuffer
    ///
    /// - **BIOS** - This is bbp (**BITS** per pixel); it should come straight from the information given when converting to the framebuffer.
    /// - **UEFI** - As of right now, I'm only aware of UEFI values 0x0 and 0x1.
    pub framebuffer_format: u32,

    /// **BIOS** - Address to raw config tables (if 0, HTMOS will find it manually)
    ///
    /// **UEFI** - Address to the System Table given at the UEFI entry point
    pub more_info: u64,
}