rust
/
va108xx
6
0
Fork 0
Code Issues Pull Requests Projects Releases 4 Wiki Activity
va108xx/README.md

45 lines
1.7 KiB
Markdown
Raw Permalink Normal View History

added crates IO badge
2021-11-06 01:37:29 +01:00
[![Crates.io](https://img.shields.io/crates/v/va108xx)](https://crates.io/crates/va108xx)
replaced badge
2021-12-03 20:39:53 +01:00
[![build](https://github.com/us-irs/va108xx-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/us-irs/va108xx-rs/actions/workflows/ci.yml)
added docs and build badge
2021-11-02 10:41:22 +01:00
[![docs.rs](https://img.shields.io/docsrs/va108xx)](https://docs.rs/va108xx)
added basic CI file
2021-11-01 23:41:06 +01:00
# PAC for the Vorago VA108xx microcontroller family
typo
2021-11-02 00:07:57 +01:00
This repository contains the Peripheral Access Crate (PAC) for
added basic CI file
2021-11-01 23:41:06 +01:00
Voragos VA108xx series of Cortex-M0 based microcontrollers.
update README
2021-11-01 23:55:24 +01:00
The crate was generated using [`svd2rust`](https://github.com/rust-embedded/svd2rust).
Updated SVD file handling and README SVD base file is now created using the svdtools package and a YAML file. Update README with usage information as well. This PR also adds new fields for the peripheral clock enable register in the SVD file
2021-11-04 22:34:12 +01:00
cross-reference HAL and BSP
2021-12-05 17:42:58 +01:00
If you are interested in higher-level abstractions, it is recommended you visit
update HAL link
2021-12-06 15:55:59 +01:00
the [`va108xx-hal` HAL crate](https://egit.irs.uni-stuttgart.de/rust/va108xx-hal) and
cross-reference HAL and BSP
2021-12-05 17:42:58 +01:00
the [`vorago-reb1` BSP crate](https://github.com/robamu-org/vorago-reb1-rs) which build on top of
this PAC and provide application examples as well.
Updated SVD file handling and README SVD base file is now created using the svdtools package and a YAML file. Update README with usage information as well. This PR also adds new fields for the peripheral clock enable register in the SVD file
2021-11-04 22:34:12 +01:00
## Usage
To use this crate, add this to your `Cargo.toml`
```toml
[dependencies.va108xx]
small README fix
2021-12-03 15:06:49 +01:00
version = "<Most Recent Version>"
Updated SVD file handling and README SVD base file is now created using the svdtools package and a YAML file. Update README with usage information as well. This PR also adds new fields for the peripheral clock enable register in the SVD file
2021-11-04 22:34:12 +01:00
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](https://docs.rs/svd2rust/0.19.0/svd2rust/#peripheral-api).
## 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
Add peripheral reset fields - Also update CHANGELOG
2021-12-05 21:48:06 +01:00
the Python [`svdtools` package](https://github.com/stm32-rs/svdtools) and the `form` tool
with `cargo install form`:
Updated SVD file handling and README SVD base file is now created using the svdtools package and a YAML file. Update README with usage information as well. This PR also adds new fields for the peripheral clock enable register in the SVD file
2021-11-04 22:34:12 +01:00
```sh
cd svd
svd patch va108xx-patch.yml
```
After that, you can regenerate the PAC by running the `gen-helper.sh` helper script.