aboutsummaryrefslogtreecommitdiff
path: root/src/_arch/arm/cpu.rs
diff options
context:
space:
mode:
authorChristian Cunningham <cc@localhost>2022-08-19 21:22:18 -0700
committerChristian Cunningham <cc@localhost>2022-08-19 21:22:18 -0700
commit26ab71043d97c1b06bdd252378b64171cb95b1a9 (patch)
tree9bea25574fc20e77a4faae6811add97e0a248175 /src/_arch/arm/cpu.rs
parent0d061dac9e31831e4fe426a0df777463043868d7 (diff)
Updated docs
Diffstat (limited to 'src/_arch/arm/cpu.rs')
-rw-r--r--src/_arch/arm/cpu.rs12
1 files changed, 10 insertions, 2 deletions
diff --git a/src/_arch/arm/cpu.rs b/src/_arch/arm/cpu.rs
index 1ca6fab..cd80151 100644
--- a/src/_arch/arm/cpu.rs
+++ b/src/_arch/arm/cpu.rs
@@ -1,8 +1,16 @@
-//! Architectural processor code.
+//! # Architectural processor code.
+//!
+//! This module provides the assembly instructions and higher level constructions
+//! for the rest of the kernel.
+
mod asm;
+
+/// # Bare Assembly Instructions
+///
+/// Re-export bare ASM bindings.
pub use asm::*;
-/// Pause execution
+/// # Halt until event
pub fn wait_forever() -> ! {
loop {
asm::wfe()