va108xx/README.md

1.7 KiB

Crates.io build docs.rs

PAC for the Vorago VA108xx microcontroller family

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

The crate was generated using svd2rust.

If you are interested in higher-level abstractions, it is recommended you visit the va108xx-hal HAL crate and the vorago-reb1 BSP crate which build on top of this PAC and provide application examples as well.

Usage

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

[dependencies.va108xx]
version = "<Most Recent Version>"
features = ["rt"]

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

For full details on the autgenerated API, please see the svd2rust documentation.

Regenerating the PAC

The base file used by svd2rust is generated using the svdtools package and a YAML patch file. You can create the patched file by running this command after installing the Python svdtools package and the form tool with cargo install form:

cd svd
svd patch va108xx-patch.yml

After that, you can regenerate the PAC by running the gen-helper.sh helper script.