aboutsummaryrefslogtreecommitdiff
path: root/src/_arch/arm/cpu
diff options
context:
space:
mode:
Diffstat (limited to 'src/_arch/arm/cpu')
-rw-r--r--src/_arch/arm/cpu/boot.rs16
1 files changed, 12 insertions, 4 deletions
diff --git a/src/_arch/arm/cpu/boot.rs b/src/_arch/arm/cpu/boot.rs
index 9ea2330..b81a16a 100644
--- a/src/_arch/arm/cpu/boot.rs
+++ b/src/_arch/arm/cpu/boot.rs
@@ -1,11 +1,19 @@
-//! Architectural boot code
-//! # Boot code for ARM
-//! crate::cpu::boot::arch_boot
+//! # Architectural boot code
+//!
+//! crate::cpu::boot::arch_boot
+//!
+//! ## Boot code for ARM
+//!
+//! Provides the initial handoff
+//! function from Assembly to Rust.
use core::arch::global_asm;
global_asm!(include_str!("boot.s"));
-/// The Rust entry of the `kernel` binary.
+/// # Rust entry of the `kernel` binary.
+///
+/// This function is unmangled so that the
+/// ASM boot code can switch to Rust safely.
#[no_mangle]
pub unsafe fn _start_rust() -> ! {
crate::kernel_init()