Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

For Hardware

Is the low-level / arch-specific code correct against the hardware and ABI contract?

This is the index of the hardware guidelines. Each subsection is its own page, and each entry below links a stable short-name to its guideline, with a one-line gist so a reader (or a review tool) can grasp the guideline before opening it.

Index

Assembly Conventions

  • asm-section-directives: Short directive for built-in sections; .section with flags for custom; blank line after.
  • asm-code-width: .code64/.code32 after the section definition for single-mode sections.
  • asm-function-attributes: Place .global/.balign/.type directly before the function label; prefer .global.
  • asm-type-and-size: Give Rust-callable functions .type @function and .size (not boot/trap trampolines).
  • asm-label-prefixes: Prefix global_asm! labels (e.g. bsp_) to avoid clashes in the crate namespace.
  • asm-prefer-balign: Use .balign (byte-count) over arch-dependent .align.

CPU Architecture-Specific