https://github.com/rust-embedded/svd2rust

Generate Rust register maps (`struct`s) from SVD files
https://github.com/rust-embedded/svd2rust

arm cmsis-svd code-generator cortex-m microcontroller rust

Last synced: 1 day ago
JSON representation

Generate Rust register maps (`struct`s) from SVD files

• Host: GitHub
• URL: https://github.com/rust-embedded/svd2rust
• Owner: rust-embedded
• License: apache-2.0
• Created: 2016-10-09T02:47:52.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-06-09T18:50:34.000Z (5 months ago)
• Last Synced: 2024-06-12T22:28:54.631Z (5 months ago)
• Topics: arm, cmsis-svd, code-generator, cortex-m, microcontroller, rust
• Language: Rust
• Size: 1.69 MB
• Stars: 668
• Watchers: 26
• Forks: 145
• Open Issues: 61
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-APACHE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
![GitHub top language](https://img.shields.io/github/languages/top/rust-embedded/svd2rust)

![Minimum Supported Rust Version](https://img.shields.io/badge/rustc-1.74+-blue.svg)

[![crates.io](https://img.shields.io/crates/v/svd2rust.svg)](https://crates.io/crates/svd2rust)

[![crates.io](https://img.shields.io/crates/d/svd2rust.svg)](https://crates.io/crates/svd2rust)

[![Released API docs](https://docs.rs/svd2rust/badge.svg)](https://docs.rs/svd2rust)

![Crates.io](https://img.shields.io/crates/l/svd2rust)

[![dependency status](https://deps.rs/repo/github/rust-embedded/svd2rust/status.svg)](https://deps.rs/repo/github/rust-embedded/svd2rust)

[![Continuous integration](https://github.com/rust-embedded/svd2rust/workflows/Continuous%20integration/badge.svg)](https://github.com/rust-embedded/svd2rust)

# `svd2rust`

> Generate Rust register maps (`struct`s) from SVD files

This project is developed and maintained by the [Tools team][team].

# [Documentation](https://docs.rs/svd2rust)

## Minimum Supported Rust Version (MSRV)

The **generated code** is guaranteed to compile on stable Rust 1.76.0 and up.

If you encounter compilation errors on any stable version newer than 1.76.0, please open an issue.

# Testing Locally

`svd2rust-regress` is a helper program for regression testing changes against `svd2rust`. This tool can be used locally to check modifications of `svd2rust` locally before submitting a PR.

Check out the [svd2rust-regress README](ci/svd2rust-regress/README.md) for information on how to use this tool.

## License

Licensed under either of

- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or

  https://www.apache.org/licenses/LICENSE-2.0)

- MIT license ([LICENSE-MIT](LICENSE-MIT) or https://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.

## Code of Conduct

Contribution to this crate is organized under the terms of the [Rust Code of

Conduct][CoC], the maintainer of this crate, the [Tools team][team], promises

to intervene to uphold that code of conduct.

[CoC]: CODE_OF_CONDUCT.md

[team]: https://github.com/rust-embedded/wg#the-tools-team