Skip to content

Document physical memory mapping size #506

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 6, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion api/src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -386,10 +386,16 @@ pub struct Mappings {
pub boot_info: Mapping,
/// Specifies the mapping of the frame buffer memory region.
pub framebuffer: Mapping,
/// The bootloader supports to map the whole physical memory into the virtual address
/// The bootloader supports mapping the whole physical memory into the virtual address
/// space at some offset. This is useful for accessing and modifying the page tables set
/// up by the bootloader.
///
/// This mapping will go from physical address `0x0` to whichever is larger:
/// - The end of the last region in the BIOS/UEFI memory map
/// - The address `0x1_0000_0000` (such that at least 4 GiB of physical memory are always mapped).
/// This is to ensure that useful MMIO regions (local APIC, I/O APIC, PCI bars) are
/// accessible to the kernel even if less physical memory than that is on the system.
///
/// Defaults to `None`, i.e. no mapping of the physical memory.
pub physical_memory: Option<Mapping>,
/// As an alternative to mapping the whole physical memory (see [`Self::physical_memory`]),
Expand Down
Loading