📚 Learn to write an embedded OS in Rust 🦀
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Andre Richter 7014c0cdfd
Bump dependencies
3 days ago
.githooks Update copyright 9 months ago
.github Update pull_request_template.md 5 months ago
.vscode Add VSCode Rust Analyzer Settings 5 months ago
00_before_we_start README.ES.md -> 00_before_we_start (#149) 6 months ago
01_wait_forever Add Cargo.toml to dependencies 3 months ago
02_runtime_init Bump dependencies 3 days ago
03_hacky_hello_world Bump dependencies 3 days ago
04_safe_globals Bump dependencies 3 days ago
05_drivers_gpio_uart Bump dependencies 3 days ago
06_uart_chainloader Bump dependencies 3 days ago
07_timestamps Bump dependencies 3 days ago
08_hw_debug_JTAG Bump dependencies 3 days ago
09_privilege_level Bump dependencies 3 days ago
10_virtual_mem_part1_identity_mapping Bump dependencies 3 days ago
11_exceptions_part1_groundwork Bump dependencies 3 days ago
12_integrated_testing Bump dependencies 3 days ago
13_exceptions_part2_peripheral_IRQs Bump dependencies 3 days ago
14_virtual_mem_part2_mmio_remap Bump dependencies 3 days ago
15_virtual_mem_part3_precomputed_tables Bump dependencies 3 days ago
16_virtual_mem_part4_higher_half_kernel Bump dependencies 3 days ago
17_kernel_symbols Bump dependencies 3 days ago
18_backtrace Bump dependencies 3 days ago
19_kernel_heap Bump dependencies 3 days ago
X1_JTAG_boot Bump dependencies 3 days ago
common Copy editing and UART clarification. 2 months ago
doc Add tutorial 18 5 months ago
docker Update copyright 9 months ago
utils devtool: Fix boot test discovery 6 days ago
.editorconfig Add tutorial 17 5 months ago
.gitignore Rework driver subsystem 5 months ago
.prettierignore Adapt ignore file 2 years ago
.prettierrc.json Add prettier for .json and .yml 2 years ago
.rubocop.yml Fix newest rubocop complaints 5 months ago
.ruby-version Update ruby actions 8 months ago
.rustfmt.toml Bump compiler and dependencies 2 months ago
Gemfile Refactor memory subsystem code 10 months ago
LICENSE-APACHE Relicense as dual MIT OR Apache-2.0 3 years ago
LICENSE-MIT Update copyright 9 months ago
README.CN.md fix desc for README.CN.md 12 months ago
README.ES.md README.ES.md -> 00_before_we_start (#149) 6 months ago
README.md Update README.md 3 months ago
SPONSORING.md Fix some old links 3 years ago
contributor_setup.sh chore: replace `git.io` link with the original URL 5 months ago
devtool devtool: symlink + clippy for rpi4 3 years ago
devtool_completion.bash Refactor Tests and Makefile 1 year ago
rust-toolchain.toml Bump compiler and dependencies 2 months ago

README.md

Operating System development tutorials in Rust on the Raspberry Pi


Introduction

This is a tutorial series for hobby OS developers who are new to ARM's 64 bit ARMv8-A architecture. The tutorials will give a guided, step-by-step tour of how to write a monolithic Operating System kernel for an embedded system from scratch. They cover implementation of common Operating Systems tasks, like writing to the serial console, setting up virtual memory and handling HW exceptions. All while leveraging Rust's unique features to provide for safety and speed.

Have fun!

Best regards,
Andre (@andre-richter)

P.S.: For other languages, please look out for alternative README files. For example, README.CN.md or README.ES.md. Many thanks to our translators 🙌.

📑 Organization

  • Each tutorial contains a stand-alone, bootable kernel binary.
  • Each new tutorial extends the previous one.
  • Each tutorial README will have a short tl;dr section giving a brief overview of the additions, and show the source code diff to the previous tutorial, so that you can conveniently inspect the changes/additions.
    • Some tutorials have a full-fledged, detailed text in addition to the tl;dr section. The long-term plan is that all tutorials get a full text, but for now this is exclusive to tutorials where I think that tl;dr and diff are not enough to get the idea.
  • The code written in these tutorials supports and runs on the Raspberry Pi 3 and the Raspberry Pi 4.
    • Tutorials 1 till 5 are groundwork code which only makes sense to run in QEMU.
    • Starting with tutorial 5, you can load and run the kernel on the real Raspberrys and observe output over UART.
  • Although the Raspberry Pi 3 and 4 are the main target boards, the code is written in a modular fashion which allows for easy porting to other CPU architectures and/or boards.
    • I would really love if someone takes a shot at a RISC-V implementation!
  • For editing, I recommend Visual Studio Code with Rust Analyzer.
  • In addition to the tutorial text, also check out the make doc command in each tutorial. It lets you browse the extensively documented code in a convenient way.

Output of make doc

make doc

🛠 System Requirements

The tutorials are primarily targeted at Linux-based distributions. Most stuff will also work on macOS, but this is only experimental.

🚀 The tl;dr Version

  1. Install Docker Engine.

  2. (Linux only) Ensure your user account is in the docker group.

  3. Prepare the Rust toolchain. Most of it will be handled on first use through the rust-toolchain file. What's left for us to do is:

    1. If you already have a version of Rust installed:

      cargo install cargo-binutils rustfilt
      
    2. If you need to install Rust from scratch:

      curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
      
      source $HOME/.cargo/env
      cargo install cargo-binutils rustfilt
      
  4. In case you use Visual Studio Code, I strongly recommend installing the Rust Analyzer extension.

  5. (macOS only) Install a few Ruby gems.

    Run this in the repository root folder:

    bundle install --path .vendor/bundle --without development
    

🧰 More Details: Eliminating Toolchain Hassle

This series tries to put a strong focus on user friendliness. Therefore, efforts were made to eliminate the biggest painpoint in embedded development as much as possible: Toolchain hassle.

Rust itself is already helping a lot in that regard, because it has built-in support for cross-compilation. All that we need for cross-compiling from an x86 host to the Raspberry Pi's AArch64 architecture will be automatically installed by rustup. However, besides the Rust compiler, we will use some more tools. Among others:

  • QEMU to emulate our kernel on the host system.
  • A self-made tool called Minipush to load a kernel onto the Raspberry Pi on-demand over UART.
  • OpenOCD and GDB for debugging on the target.

There is a lot that can go wrong while installing and/or compiling the correct version of each tool on your host machine. For example, your distribution might not provide the latest version that is needed. Or you are missing some hard-to-get dependencies for the compilation of one of these tools.

This is why we will make use of Docker whenever possible. We are providing an accompanying container that has all the needed tools or dependencies pre-installed, and it gets pulled in automagically once it is needed. If you want to know more about Docker and peek at the provided container, please refer to the repository's docker folder.

📟 USB Serial Output

Since the kernel developed in the tutorials runs on the real hardware, it is highly recommended to get a USB serial cable to get the full experience.

  • You can find USB-to-serial cables that should work right away at [1] [2], but many others will work too. Ideally, your cable is based on the CP2102 chip.
  • You connect it to GND and GPIO pins 14/15 as shown below.
  • Tutorial 5 is the first where you can use it. Check it out for instructions on how to prepare the SD card to boot your self-made kernel from it.
  • Starting with tutorial 6, booting kernels on your Raspberry is getting really comfortable. In this tutorial, a so-called chainloader is developed, which will be the last file you need to manually copy on the SD card for a while. It will enable you to load the tutorial kernels during boot on demand over UART.

UART wiring diagram

🙌 Acknowledgements

The original version of the tutorials started out as a fork of Zoltan Baldaszti's awesome tutorials on bare metal programming on RPi3 in C. Thanks for giving me a head start!

Translations of this repository

  • Chinese
  • Spanish
    • @zanezhub.
    • In the future there'll be tutorials translated to spanish.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.