History

Robin Mueller bafca6e214 init commit		2024-06-12 11:48:13 +02:00
..
.github	init commit	2024-06-12 11:48:13 +02:00
automation	init commit	2024-06-12 11:48:13 +02:00
src	init commit	2024-06-12 11:48:13 +02:00
svd	init commit	2024-06-12 11:48:13 +02:00
.gitignore	init commit	2024-06-12 11:48:13 +02:00
build.rs	init commit	2024-06-12 11:48:13 +02:00
Cargo.toml	init commit	2024-06-12 11:48:13 +02:00
CHANGELOG.md	init commit	2024-06-12 11:48:13 +02:00
device.x	init commit	2024-06-12 11:48:13 +02:00
gen-helper.sh	init commit	2024-06-12 11:48:13 +02:00
LICENSE-APACHE	init commit	2024-06-12 11:48:13 +02:00
NOTICE	init commit	2024-06-12 11:48:13 +02:00
README.md	init commit	2024-06-12 11:48:13 +02:00

README.md

PAC for the Vorago VA416xx microcontroller family

This repository contains the Peripheral Access Crate (PAC) for Voragos VA416xx series of Cortex-M4 based microcontrollers.

The crate was generated using svd2rust.

Usage

To use this crate, add this to your Cargo.toml

[dependencies.va416xx]
version = "<MostRecentVersion>"
features = ["rt"]

The rt feature is optional and recommended. It brings in support for cortex-m-rt.

For full details on the autgenerated API, you can read the svd2rust documentation.

Regenerating the PAC

If you want to re-generate the PAC, for example if the register file va416xx.svd changes or the svd2rust version is updated, you can do some using the following these steps:

Make sure all necessary tools are installed: svd2rust, svdtools and form. You can install all tools with cargo:
```
cargo install --locked svd2rust svdtools form
```
Patch the vendor-provided SVD file svd/va41xx.svd. This can be done using svdtools in conjunction with the svd/va416xx-patch.yml file.
```
svdtools patch svd/va416xx-patch.yml
```
Use svd2rust to generate the Rust library
```
svd2rust -i svd/va416xx.svd.patched
```
Use the form tool to split the generated lib.rs into individual modules.
```
form -i lib.rs -o src/
```

The gen-helper.sh automates steps 2-4.