You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

49 lines
1.6 KiB
Markdown

5 years ago
# Operating System development tutorials in Rust on the Raspberry Pi 3
6 years ago
5 years ago
## Notice
5 years ago
**This is a work-in-progress rewrite, started on September 2019. I will first add
5 years ago
code and minimal READMEs, and later write accompanying full-fledged tutorial
text.**
5 years ago
5 years ago
- 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 editing, I recommend [Visual Studio Code] with the [Rust Language Server] extension.
5 years ago
- For practical purposes, the kernel will be a classic [monolith].
5 years ago
5 years ago
_Cheers,
5 years ago
[Andre](https://github.com/andre-richter)_
5 years ago
5 years ago
[monolith]: https://en.wikipedia.org/wiki/Monolithic_kernel
5 years ago
[Visual Studio Code]: https://code.visualstudio.com
[Rust Language Server]: https://github.com/rust-lang/rls
5 years ago
## Prerequisites
6 years ago
6 years ago
Before you can start, you'll need a suitable Rust toolchain.
6 years ago
```bash
curl https://sh.rustup.rs -sSf \
| \
sh -s -- \
--default-toolchain nightly \
--component rust-src llvm-tools-preview clippy rustfmt rls rust-analysis
cargo install cargo-xbuild cargo-binutils
6 years ago
```
5 years ago
## USB Serial
6 years ago
I'd also recommend to get an [USB serial debug
cable](https://www.adafruit.com/product/954). You connect it to the GPIO pins
14/15.
6 years ago
5 years ago
[Tutorial 6](06_drivers_gpio_uart) is the first where you can use it. Earlier tutorials will work solely with `QEMU`.
6 years ago
5 years ago
![UART wiring diagram](doc/wiring.png)
6 years ago
## License
Licensed under the MIT license ([LICENSE-MIT](LICENSE) or http://opensource.org/licenses/MIT).