Robin Mueller
60f4a52953
Changed: - Move most library components to new [`vorago-shared-periphs`](https://egit.irs.uni-stuttgart.de/rust/vorago-shared-periphs) which is mostly re-exported in this crate. - All HAL API constructors now have a more consistent argument order: PAC structures and resource management structures first, then clock configuration, then any other configuration. - Overhaul and simplification of several HAL APIs. The system configuration and IRQ router peripheral instance generally does not need to be passed to HAL API anymore. - All HAL drivers are now type erased. The constructors will still expect and consume the PAC singleton component for resource management purposes, but are not cached anymore. - Refactoring of GPIO library to be more inline with embassy GPIO API. Added: - I2C clock timeout feature support.
HAL for the Vorago VA108xx MCU family
This repository contains the Hardware Abstraction Layer (HAL), which is an additional hardware abstraction on top of the peripheral access API.
It is the result of reading the datasheet for the device and encoding a type-safe layer over the raw PAC. This crate also implements traits specified by the embedded-hal project, making it compatible with various drivers in the embedded rust ecosystem.
In contrats to other HAL implementations, there is only one chip variant available here so there is no need to pass the chip variant as a feature.
Building
Building an application requires the thumbv6m-none-eabi cross-compiler toolchain.
If you have not installed it yet, you can do so with
rustup target add thumbv6m-none-eabi
After that, you can use cargo build to build the development version of the crate.
Setting up your own binary crate
If you have a custom board, you might be interested in setting up a new binary crate for your project. These steps aim to provide a complete list to get a binary crate working to flash your custom board.
The hello world of embedded development is usually to blinky a LED. This example is contained within the examples folder.
-
Set up your Rust cross-compiler if you have not done so yet. See more in the build chapter
-
Create a new binary crate with
cargo init -
To ensure that
cargo buildcross-compiles, it is recommended to create a.cargo/config.tomlfile. A sample.cargo/config.tomlfile is provided in this repository as well -
Copy the
memory.xfile into your project. This file contains information required by the linker. -
Copy the
blinky.rsfile to thesrc/main.rsfile in your binary crate -
You need to add some dependencies to your
Cargo.tomlfile[dependencies] cortex-m = "<Compatible Version>" cortex-m-rt = "<Compatible Version>" panic-halt = "<Compatible Version>" embedded-hal = "<Compatible Version>" [dependencies.va108xx-hal] version = "<Most Recent Version>" features = ["rt"] -
Build the application with
cargo build -
Flashing the board might work differently for different boards and there is usually more than one way. You can find example instructions in primary README.
Embedded Rust
If you have not done this yet, it is recommended to read some of the excellent resources available to learn Rust: