47 lines
1.6 KiB
Markdown
47 lines
1.6 KiB
Markdown
|
# HAL for the Vorago VA416xx MCU family
|
||
|
|
|
||
|
|
This repository contains the **H**ardware **A**bstraction **L**ayer (HAL), which is an additional
|
||
|
|
hardware abstraction on top of the [peripheral access API](https://egit.irs.uni-stuttgart.de/rust/va416xx).
|
||
|
|
|
||
|
|
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](https://github.com/rust-embedded/embedded-hal) project, making it compatible with
|
||
|
|
various drivers in the embedded rust ecosystem.
|
||
|
|
|
||
|
|
## Supported Boards
|
||
|
|
|
||
|
|
The first way to use this HAL will probably be with the
|
||
|
|
[PEB1 development board](https://www.voragotech.com/products/peb1va416x0-development-kit).
|
||
|
|
The BSP provided for this board also contains instructions how to flash the board.
|
||
|
|
|
||
|
|
## Building
|
||
|
|
|
||
|
|
Building an application requires the `thumbv7em-none-eabihf` cross-compiler toolchain.
|
||
|
|
If you have not installed it yet, you can do so with
|
||
|
|
|
||
|
|
```sh
|
||
|
|
rustup target add thumbv7em-none-eabihf
|
||
|
|
```
|
||
|
|
|
||
|
|
After that, you can use `cargo build` to build the development version of the crate.
|
||
|
|
|
||
|
|
If you have not done this yet, it is recommended to read some of the excellent resources
|
||
|
|
available to learn Rust:
|
||
|
|
|
||
|
|
- [Rust Embedded Book](https://docs.rust-embedded.org/book/)
|
||
|
|
- [Rust Discovery Book](https://docs.rust-embedded.org/discovery/)
|
||
|
|
|
||
|
|
## Using the `.cargo/config.toml` file
|
||
|
|
|
||
|
|
Use the following command to have a starting `config.toml` file
|
||
|
|
|
||
|
|
```sh
|
||
|
|
cp .cargo/def-config.toml .cargo/config.toml
|
||
|
|
```
|
||
|
|
|
||
|
|
You then can adapt the `config.toml` to your needs. For example, you can configure runners
|
||
|
|
to conveniently flash with `cargo run`.
|
||
|
|
|
||
|
|
## Setting up your own binary crate
|
||
|
|
|
||
|
|
TODO
|