Archives/rust-raspberrypi-OS-tutorials
2
0
Fork 0
mirror of https://github.com/rust-embedded/rust-raspberrypi-OS-tutorials.git synced 2024-11-05 12:00:22 +00:00
Code Issues Projects Releases Wiki Activity
📚 Learn to write an embedded OS in Rust 🦀
246 Commits 1 Branch 1 Tag 22 MiB
Rust 82.3%
Makefile 8.4%
Ruby 5.9%
Assembly 3.2%
Dockerfile 0.1%
7cb4b92402
Go to file
Andre Richter 7cb4b92402
Update README.md
2019-10-27 23:11:54 +01:00
.githooks Initial preparations for rewrite 2019-10-27 23:09:23 +01:00
01_wait_forever Big restructuring for more modularity 2019-10-27 23:11:52 +01:00
02_runtime_init Big restructuring for more modularity 2019-10-27 23:11:52 +01:00
03_hacky_hello_world Big restructuring for more modularity 2019-10-27 23:11:52 +01:00
04_zero_overhead_abstraction Big restructuring for more modularity 2019-10-27 23:11:52 +01:00
05_safe_globals Big restructuring for more modularity 2019-10-27 23:11:52 +01:00
06_drivers_gpio_uart Big restructuring for more modularity 2019-10-27 23:11:52 +01:00
doc Initial preparations for rewrite 2019-10-27 23:09:23 +01:00
docker Change some more license headers to SPDX 2019-10-27 23:11:50 +01:00
utils Forgot renaming 2019-10-27 23:10:54 +01:00
.gitignore Ignore cargo built files 2019-03-19 23:38:04 +01:00
contributor_setup.sh Add a pre-commit hook 2019-01-12 21:55:28 +01:00
LICENSE Initial preparations for rewrite 2019-10-27 23:09:23 +01:00
README.md Update README.md 2019-10-27 23:11:54 +01:00

README.md

Bare-metal and Operating System development tutorials in Rust on the Raspberry Pi 3

Notice

This is a work-in-progress rewrite started on September 2019. I will first add code and minimal READMEs, and later write accompanying full-fledged tutorial text.

  • Check out the make doc command to browse the code with HTML goodness.
  • Note that the branch is subject to frequent force pushing. If updates happened since you last visited, make sure to clone a clean copy to be safe.
  • For practical purposes, the kernel will be a classic monolith.

Cheers, Andre

Prerequisites

Before you can start, you'll need a suitable Rust toolchain. Please browse to the rustup components history and note the date of the most recent build that shows clippy as present.

Then, proceed to install this nightly using your noted date:

curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain nightly-YOUR_DATE_HERE
# For example:
# curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain nightly-2019-09-05

rustup component add rust-src llvm-tools-preview clippy
cargo install cargo-xbuild cargo-binutils

Additionally, a Micro SD card with firmware files on a FAT filesystem is needed.

I recommend to get a Micro SD card USB adapter (many manufacturers ship SD cards with such an adapter), so that you can connect the card to any desktop computer just like an USB stick, no special card reader interface required (although many laptops have those these days).

You can create an MBR partitioning scheme on the SD card with an LBA FAT32 (type 0x0C) partition, format it and copy bootcode.bin, start.elf and fixup.dat onto it. Delete all other files or booting might not work. Alternatively, you can download a raspbian image, dd it to the SD card, mount it and delete the unnecessary .img files. Whichever you prefer. What's important, you'll create kernel8.img with these tutorials which must be copied to the root directory on the SD card, and no other .img files should exists there.

I'd also recommend to get an USB serial debug cable. You connect it to the GPIO pins 14/15.

UART wiring diagram

Then, run screen on your desktop computer like

sudo screen /dev/ttyUSB0 115200

Exit screen again by pressing ctrl-a ctrl-d

License

Licensed under the MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT).