RRIV platform firmware, written in Rust.
You will need to install the Rust toolchain. The easiest way to do this is with rustup.
You will need the nightly toolchain since Rust on embedded needs unstable features. You will also need to install the thumbv7m-none-eabi target to build for the STM32F103RB.
rustup toolchain install nightly
rustup target add thumbv7m-none-eabi
rustup default nightlyprobe-rs sets up the tooling for flashing and debugging. You will need to install the probe-rs cli tool. You can do this with a curl command in Linux or MacOS:
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/probe-rs/probe-rs/releases/latest/download/probe-rs-tools-installer.sh | shThis will install the probe-rs, cargo-flash and cargo-embed binaries and put them in $PATH.
Users of VSCode will also want to install the following extensions:
- rust-analyzer
probe-rs-debugger: This is now installed with probe-rs.
The top level directories are part of a vscode workspace. This is so that you can have multiple projects open at once. You will want to open the project for editing via the workspace file: rriv-rust.code-workspace.
There is a Cargo.toml file in board and src, these are Cargo workspaces. Each Cargo workspace defines its member packages. Each of these have their own Cargo.toml in turn.
To build packages from the terminal, you can use cargo build, but you will need to specify the -p flag and the package name. For example, to build the board/app package, you would run cargo build -p app from the board directory.
The code in board must be run on target hardware. This is because it is either board-specific or it is the firmware that runs on the board. While the code in src is pure Rust and can be tested on the host and used by the board-specific code.
board/app - a Rust firmware binary that will be the eventual home of the platform firmware, but it is basically a test app right now.
board/lib - a static C FFI library is being used as a way to call new features written in Rust from the current C firmware. Eventually, the C firmware will have been fully replaced (and upgraded!) by the Rust firmware.
board/rriv-0-4 - This is where the board-specific code lives.
The Rust library in src/lib is for core functionality that can be tested on the host and used by the C firmware via the FFI library.
There are vscode tasks to build the various code packages. You can run these tasks by pressing ctrl+shift+b (or cmd+shift+b on mac). Tasks are defined in .vscode/tasks.json in each of the top level directories.
board/app has a vscode debug config called "Build, Run, Debug Rust Binary" that will build the binary, flash it to the target, and then attach the debugger. You can run this by pressing F5.
To use the tooling from the command line, you can run this. You will need to cd into the directory where the Cargo.toml is for the firmware that you want to flash. You can also call cargo flash with an argument for path of the binary.
cargo flash --chip STM32F103RBThis is only optional. It maps various useful embedded cli tools to work via cargo commands.
cargo install cargo-binutils
rustup component add llvm-tools-preview