firmware-rs

NER Firmware in Rust (experimental, not for usage on car)

Setup

1. get rustup.
2. clone and open this root folder.
3. get probe-rs.

Commands

• To enter a project: cd ./projects/project-name
• To build: cargo build
• To deploy onto an embedded chip locally connected, run cargo run --release.
• To format, run cargo format.
• To lint and check stuff, run cargo clippy.
• To run a RTT terminal dedicated: cargo embed --release rtt
• To run a GDB terminal dedicated: cargo embed --release gdb
• To flash and leave code: cargo embed --release

At this time, many commands only work consistently inside the project (via cd) The workspace's only purpose is to organize dependencies and build artificats, especially for rust-analyzer.

Coding tips and tricks

• Use defmt macros to print stuff

IDE Stuff

There are currently custom rust-analyzer settings for VSCode and zed. Feel free to adapt them to your own liking.

Repository structure

This is a mono-repo configured as a normal embassy-styled project with multiple dependency crates and sub-projects.

Various files:

Top level Cargo.toml and rust-toolchain.toml define the various parts of the embassy project. See comments inside for how these were structure, but most follow embassy specification.

The crates folder defines drivers or other code shared between projects.

The projects folder defines individual board-specific compilation units which inherit explicity defined Cargo.toml dependencies and Embed.toml settings, and more. They can also depend on a crate in the crates folder. Notably, they all may have individual .config/cargo.toml if they override anything.

This structure has multiple benefits, including:

• Static versioning of all embassy and other dependencies, eliminating version conflicts for in-tree code
• Inherited build settings so like-microcontroller projects share all of that boilerplate
• Shared target folder meaning a shared build cache for quicker and space-saving builds
• Other quirks, such as vscode settings.json and config.toml, are shared between projects

Upgrades of Embassy/Dep versions

Updating versions is as follows

1. Update the rust-toolchain to the version found in embassy repo
2. Update all embassy versions to the versions found in the embassy repo, use x.y.z, in main Cargo.toml
3. Update all features, especially ones that say the version in them (ex. "defmt-03")
4. Update major package versions of other projects, use x.y, in main Cargo.toml
5. Update package versions of other projects, in individual Cargo.toml
6. Fix any build issues