Struct BootloaderConfig

#[non_exhaustive]
pub struct BootloaderConfig {
    pub version: ApiVersion,
    pub mappings: Mappings,
    pub kernel_stack_size: u64,
    pub frame_buffer: FrameBuffer,
}

Allows configuring the bootloader behavior.

TODO: describe use together with entry_point macro TODO: example

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

version: ApiVersion

The version of the bootloader API.

Automatically generated from the crate version. Checked on deserialization to ensure that the kernel and bootloader use the same API version, i.e. the same config and boot info format.

mappings: Mappings

Configuration for (optional) page table mappings created by the bootloader.

kernel_stack_size: u64

The size of the stack that the bootloader should allocate for the kernel (in bytes).

The bootloader starts the kernel with a valid stack pointer. This setting defines the stack size that the bootloader should allocate and map.

The stack is created with a additional guard page, so a stack overflow will lead to a page fault.

frame_buffer: FrameBuffer

👎Deprecated since 0.11.1: The frame buffer is now configured through the BootConfig struct when creating the bootable disk image

Configuration for the frame buffer that can be used by the kernel to display pixels on the screen.

Implementations

impl BootloaderConfig

pub const fn new_default() -> Self

Creates a new default configuration with the following values:

• kernel_stack_size: 80kiB
• mappings: See Mappings::new_default()

pub const fn serialize(&self) -> [u8; 124]

Serializes the configuration to a byte array.

This is used by the [crate::entry_point] macro to store the configuration in a dedicated section in the resulting ELF file.

pub fn deserialize(serialized: &[u8]) -> Result<Self, &'static str>

Tries to deserialize a config byte array that was created using Self::serialize.

This is used by the bootloader to deserialize the configuration given in the kernel’s ELF file.

TODO: return error enum

Trait Implementations

impl Clone for BootloaderConfig

fn clone(&self) -> BootloaderConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BootloaderConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for BootloaderConfig

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for BootloaderConfig

fn eq(&self, other: &BootloaderConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for BootloaderConfig

impl Eq for BootloaderConfig

impl StructuralPartialEq for BootloaderConfig