diff options
| author | Christian Cunningham <cc@localhost> | 2022-08-19 21:22:18 -0700 |
|---|---|---|
| committer | Christian Cunningham <cc@localhost> | 2022-08-19 21:22:18 -0700 |
| commit | 26ab71043d97c1b06bdd252378b64171cb95b1a9 (patch) | |
| tree | 9bea25574fc20e77a4faae6811add97e0a248175 /src/_arch/arm/cpu | |
| parent | 0d061dac9e31831e4fe426a0df777463043868d7 (diff) | |
Updated docs
Diffstat (limited to 'src/_arch/arm/cpu')
| -rw-r--r-- | src/_arch/arm/cpu/boot.rs | 16 |
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() |