diff --git a/CHANGELOG.md b/CHANGELOG.md index 118abdf2..9b45edcb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ## [Unreleased] +## [v0.18.0] - 2021-04-17 + ### Added - Support for registers with alternateGroup @@ -14,6 +16,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/). - New `-m` switch generates a `mod.rs` file instead of `lib.rs`, which can be used as a module inside a crate without further modification. +- ESP32/XtensaLX6 support. + +- Field array support. + +- Add repr(transparent) to Reg struct + - Generated crates now contain the git commit hash and date of svd2rust compilation. @@ -43,8 +51,22 @@ and this project adheres to [Semantic Versioning](http://semver.org/). - [breaking-change] make `write_with_zero` method `unsafe` because the way it is +- Use complete path for cluster names + +- Rename some generated variables. + +- [breaking-change] Publishes the register spec zero-sized type and move all relevant register traits to that struct. + +- [breaking-change] Removes the extra type parameter on Reg, making the register spec the sole authority on the shape of the register. + +- Wrap register reader/writer and field readers in newtype wrappers, which significantly improves the documentation output. + +- Improve documentation on generated registers and fields + - [breaking-change] remove `Variant`, use `Option` instead +- [breaking-change] Update `svd-parser` to `0.11` + - split out register size type (`RawType`) from `ResetValue` trait - `anyhow` crate is used for error handling @@ -63,6 +85,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/). interrupt number handling. The minimum supported `cortex-m` version is now **0.7** and `bare-metal` is not a dependency anymore. +### Removed + +- Generated use of the register type aliases in favor of directly referencing `Reg` + ## [v0.17.0] - 2019-12-31 ### Fixed @@ -557,7 +583,8 @@ peripheral.register.write(|w| w.field().set()); - Initial version of the `svd2rust` tool -[Unreleased]: https://github.com/rust-embedded/svd2rust/compare/v0.17.0...HEAD +[Unreleased]: https://github.com/rust-embedded/svd2rust/compare/v0.18.0...HEAD +[v0.18.0]: https://github.com/rust-embedded/svd2rust/compare/v0.17.0...v0.18.0 [v0.17.0]: https://github.com/rust-embedded/svd2rust/compare/v0.16.1...v0.17.0 [v0.16.1]: https://github.com/rust-embedded/svd2rust/compare/v0.16.0...v0.16.1 [v0.16.0]: https://github.com/rust-embedded/svd2rust/compare/v0.15.2...v0.16.0 diff --git a/Cargo.toml b/Cargo.toml index bf482ce6..1ceabb4d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -23,7 +23,7 @@ keywords = [ license = "MIT OR Apache-2.0" name = "svd2rust" repository = "https://github.com/rust-embedded/svd2rust/" -version = "0.17.0" +version = "0.18.0" readme = "README.md" [[bin]] diff --git a/README.md b/README.md index 2ecc1f02..c5aa4a4e 100644 --- a/README.md +++ b/README.md @@ -13,9 +13,9 @@ This project is developed and maintained by the [Tools team][team]. ## Minimum Supported Rust Version (MSRV) -The **generated code** is guaranteed to compile on stable Rust 1.37.0 and up. +The **generated code** is guaranteed to compile on stable Rust 1.40.0 and up. -If you encounter compilation errors on any stable version newer than 1.37.0, please open an issue. +If you encounter compilation errors on any stable version newer than 1.40.0, please open an issue. # Testing Locally