Skip to content

Commit

Permalink
Merge pull request #26 from em32-rs/rename-crate
Browse files Browse the repository at this point in the history
Rename crate to target efm32hg309f64 specifically
  • Loading branch information
fudanchii authored Aug 22, 2022
2 parents 665a0e7 + bf7b142 commit c689561
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
6 changes: 3 additions & 3 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "efm32hg-pac"
version = "0.2.0"
authors = ["Jacob Rosenthal <[email protected]>"]
name = "efm32hg309f64-pac"
version = "0.2.1"
authors = ["Jacob Rosenthal <[email protected]>", "Nurahmadie <[email protected]>"]
edition = "2021"
keywords = ["no-std", "arm", "cortex-m", "efm32", "efm32hg", "efm32hg309", "efm32hg309f64", "pac"]
readme = "readme.md"
Expand Down
10 changes: 6 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,25 @@
# `efm32hg-pac`
# `efm32hg309f64-pac`

Peripheral access API for efm32hg microcontroller from Silicon Labs.
Peripheral access API for efm32hg309f64 microcontroller from Silicon Labs' efm32hg family.

The efm32hg register definitions were retrieved from from keil.com and provided here in ./svd as a convenience only.

Additionally, this crate includes SVD patch for DEVINFO register which isn't included in the original SVD file from keil.

## Supported Series
Currently supported and tested series:

- efm32hg309f64

Other HG series might be able to use this crate but is not supported until it's stated otherwise.

## [Documentation](https://docs.rs/efm32hg-pac)
## [Documentation](https://docs.rs/efm32hg309f64-pac)

## Requirements
The crate can be used with Rust v1.56 or newer.

## Regenerate
The src directory is generated. If you want to upstream changes here, don't manually edit, but rather send a PR to one of the upstream tools used in tools/gen. However if you have tools or svd version bumps you can regenerate this pac. The script needs to apply patches to the svd via the Makefile which requires python3 and `pip3 install --user pyyaml`. Then you can run `make` to patch, generate and format the pac from source svd.
The src directory is generated. If you want to upstream changes here, don't manually edit, but rather send a PR to one of the upstream tools used in tools/gen. However if you have tools or svd version bumps you can regenerate this pac. The script needs to apply patches to the svd via the Makefile which requires [svdtools](https://github.com/stm32-rs/svdtools) to be installed. Then you can run `make` to patch, generate and format the pac from source svd.

## License

Expand Down

0 comments on commit c689561

Please sign in to comment.