STM32 Peripheral Access Crates

This repository provides Rust device support crates for all STM32 microcontrollers, providing a safe API to that device's peripherals using svd2rust and a community-built collection of patches to the basic SVD files. There is one crate per device family, and each supported device is a feature-gated module in that crate. These crates are commonly known as peripheral access crates or "PACs".

To view the generated code that makes up each crate, visit the stm32-rs-nightlies repository, which is automatically rebuilt on every commit to stm32-rs master. The stm32-rs repository contains the patches to the underlying SVD files and the tooling to generate the crates.

While these crates are widely used, not every register of every device will have been tested on hardware, and so errors or omissions may remain. We can't make any guarantee of correctness. Please report any bugs you find!

You can see current coverage status for each chip here. Coverage means that individual fields are documented with possible values, but even devices with low coverage should have every register and field available in the API. That page also allows you to drill down into each field on each register on each peripheral.

Using Device Crates In Your Own Project

In your own project's Cargo.toml:

[dependencies.stm32f4]
version = "0.15.1"
features = ["stm32f405", "rt"]

The rt feature is optional but helpful. See svd2rust for details.

Then, in your code:

use stm32f4::stm32f405;

let mut peripherals = stm32f405::Peripherals::take().unwrap();

Refer to svd2rust documentation for further usage.

Replace stm32f4 and stm32f405 with your own device; see the individual crate READMEs for the complete list of supported devices. All current STM32 devices should be supported to some level.

Using Latest "Nightly" Builds

Whenever the master branch of this repository is updated, all device crates are built and deployed to the stm32-rs-nightlies repository. You can use this in your Cargo.toml:

[dependencies.stm32f4]
git = "https://github.com/stm32-rs/stm32-rs-nightlies"
features = ["stm32f405", "rt"]

The nightlies should always build and be as stable as the latest release, but contain the latest patches and updates.

Generating Device Crates / Building Locally

Install svd2rust, svdtools, and form:
- On x86-64 Linux, run make install to download pre-built binaries at the current version used by stm32-rs
- Otherwise, build using cargo (double check versions against scripts/tool_install.sh):
  - cargo install form --version 0.12.1
  - cargo install svdtools --version 0.3.14
  - cargo install svd2rust --version 0.33.3
Install rustfmt: rustup component add rustfmt
Generate patched SVD files: make patch (you probably want -j for all make invocations)
- Alternatively you could install cargo-make runner and then use it instead of make. Works on MS Windows natively:
  - cargo install cargo-make
  - cargo make patch
Generate svd2rust device crates: make svd2rust
Optional: Format device crates: make form

Motivation and Objectives

This project serves two purposes:

Create a source of high-quality STM32 SVD files, with manufacturer errors and inconsistencies fixed. These files could be used with svd2rust or other tools, or in other projects. They should hopefully be useful in their own right.
Create and publish svd2rust-generated crates covering all STM32s, using the SVD files.

When this project began, many individual crates existed for specific STM32 devices, typically maintained separately with hand-edited updates to the SVD files. This project hopes to reduce that duplication of effort and centralise the community's STM32 device support in one place.

Helping

This project is still young and there's a lot to do!

More peripheral patches need to be written, most of all. See what we've got in peripherals/ and grab a reference manual!
Also everything needs testing, and you can't so easily automate finding bugs in the SVD files...

Supported Device Families

Please see the individual crate READMEs for the full list of devices each crate supports. All SVDs released by ST for STM32 devices are covered, so probably your device is supported to some extent!

Devices that are nearly identical, like the STM32F405/F415, are supported by ST under a single SVD file STM32F405, so if you can't find your exact device check if its sibling is supported instead. The crate READMEs make this clear.

Many peripherals are not yet patched to provide the type-safe friendly-name interface (enumerated values); please consider helping out with this!

Check out the full list of supported devices here.

Adding New Devices

Update SVD zips in svd/vendor to include new SVDs.
Run make extract to extract the new zip files.
Add new YAML file in devices/ with the new SVD path and include any required SVD patches for this device, such as renaming or merging fields.
Add the new devices to stm32_part_table.yaml.
Add the new devices to scripts/makecrates.py.
You can run scripts/matchperipherals.py script to find out what existing peripherals could be cleanly applied to this new SVD. If they look sensible, you can include them in your device YAML. This requires a Python environment with the pyyaml and svdtools dependencies. Example command: python scripts/matchperipherals.py peripherals/rcc devices/stm32h562.yaml
Re-run scripts/makecrates.py devices/ to update the crates with the new devices.
Run make to rebuild, which will make a patched SVD and then run svd2rust on it to generate the final library.

If adding a new STM32 family (not just a new device to an existing family), complete these steps as well:

Add the new devices to the CRATES field in Makefile.
Update this Readme to include the new devices.
Add the devices to workflows/ci.yaml and workflows/nightlies.yaml.

Updating Existing Devices/Peripherals

Using Linux, run make extract at least once to pull the SVDs out.
Edit the device or peripheral YAML (see below for format).
Using Linux, run make to rebuild all the crates using svd patch and svd2rust.
Test your new stuff compiles: cd stm32f4; cargo build --features stm32f405

If you've added a new peripheral, consider using the matchperipherals.py script to see which devices it would cleanly apply to.

To generate a new peripheral file from scratch, consider using periphtemplate.py, which creates an empty peripheral file based on a single SVD file, with registers and fields ready to be populated. For single bit wide fields with names ending in 'E' or 'D' it additionally generates sample "Enabled"/"Disabled" entries to save time.

Device and Peripheral YAML Format

Please see the svdtools documentation for full details of the patch file format.

Style Guide

Enumerated values should be named in the past tense ("enabled", "masked", etc).
Descriptions should start with capital letters but do not end with a period

Releasing

Notes for maintainers:

Create PR preparing for new release:
- Update CHANGELOG.md with changes since last release and new contributors
- Update README.md to bump version number in example snippet
- Update scripts/makecrates.py to update version number for generated PACs
Merge PR once CI passes, pull master locally.
make clean
make -j16 form
for f in stm32f0 stm32f1 stm32f2 stm32f3 stm32f4 stm32f7 stm32h7 stm32l0 stm32l1 stm32l4 stm32l5 stm32g0 stm32g4 stm32mp1 stm32wl stm32wb; cd $f; pwd; cargo publish --allow-dirty --no-default-features; cd ..; end
git tag -a vX.X.X -m vX.X.X
git push vX.X.X

License

Licensed under either of

Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

oblonka/stm32-rs