Skip to content

Commit 8515d40

Browse files
bors[bot]cr1901
andauthored
Merge #577
577: Bring documentation on MSP430 up to date. r=burrbull a=cr1901 Crate versions must be `0.3.0` or higher now; minor version `0.2.0` and below is unsupported due to (among other things) bumping to bare-metal `1.0.0` and [using](rust-lang/rust#93219) Rust inline assembly to implement useful operations. Co-authored-by: William D. Jones <[email protected]>
2 parents 74a6553 + c951c7e commit 8515d40

File tree

3 files changed

+18
-11
lines changed

3 files changed

+18
-11
lines changed

CHANGELOG.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
77

88
## [Unreleased]
99

10+
### Changed
11+
12+
- Bring documentation on how to generate MSP430 PACs up to date (in line with
13+
[msp430_svd](https://github.com/pftbest/msp430_svd)).
14+
1015
## [v0.21.0] - 2022-01-17
1116

1217
### Added
@@ -34,7 +39,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
3439
### Fixed
3540

3641
- Bug with `use_mask`
37-
- Correct derive for register (cluster) array (needs `svd-rs` 0.11.2)
42+
- Correct derive for register (cluster) array (needs `svd-rs` 0.11.2)
3843
- New line separators are now rendered in enumerated values
3944
- Multi line field descriptions are now rendered correctly in write and read registers
4045

@@ -67,7 +72,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
6772

6873
### Changed
6974

70-
- `\n` in descriptions for multiline
75+
- `\n` in descriptions for multiline
7176
- `_reserved` fields in `RegisterBlock` now hexidemical usize
7277
- options can be set now with `svd2rust.toml` config
7378
- option `ignore_groups` for optional disabling #506
@@ -120,7 +125,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
120125

121126
- with feature "const-generic" generate const generic variant of
122127
"field array" structure in addition to structure
123-
that contain offset (requires rust 1.51)
128+
that contain offset (requires rust 1.51)
124129

125130
- move interrupt generation after generic file
126131

ci/script.sh

+2-2
Original file line numberDiff line numberDiff line change
@@ -507,10 +507,10 @@ main() {
507507
# test other targets (architectures)
508508
OTHER)
509509
echo '[dependencies.msp430]' >> $td/Cargo.toml
510-
echo 'version = "0.2.2"' >> $td/Cargo.toml
510+
echo 'version = "0.3.0"' >> $td/Cargo.toml
511511

512512
# Test MSP430
513-
test_svd_for_target msp430 https://raw.githubusercontent.com/pftbest/msp430g2553/v0.1.3-svd/msp430g2553.svd
513+
test_svd_for_target msp430 https://raw.githubusercontent.com/pftbest/msp430g2553/v0.3.0-svd/msp430g2553.svd
514514
;;
515515

516516
# Community-provided RISC-V SVDs

src/lib.rs

+8-6
Original file line numberDiff line numberDiff line change
@@ -99,30 +99,32 @@
9999
//!
100100
//! $ xmllint -format out.svd > msp430g2553.svd
101101
//!
102-
//! $ svd2rust --target=msp430 -i msp430g2553.svd
102+
//! $ svd2rust -g --target=msp430 -i msp430g2553.svd
103103
//!
104104
//! $ rm -rf src
105105
//!
106106
//! $ form -i lib.rs -o src/ && rm lib.rs
107107
//!
108+
//! $ mv generic.rs src/
109+
//!
108110
//! $ cargo fmt
109111
//! ```
110112
//!
111113
//! The resulting crate must provide opt-in "rt" feature and depend on these crates: `msp430`
112-
//! v0.2.x, `msp430-rt` v0.2.x, and `vcell` v0.1.x. If the `--nightly` flag is provided to
113-
//! `svd2rust`, then `msp430-atomic` v0.1.2 is also needed. Furthermore the "device" feature of
114+
//! v0.3.x, `msp430-rt` v0.3.x, and `vcell` v0.1.x. If the `--nightly` flag is provided to
115+
//! `svd2rust`, then `msp430-atomic` v0.1.4 is also needed. Furthermore the "device" feature of
114116
//! `msp430-rt` must be enabled when the "rt" feature is enabled. The `Cargo.toml` of the device
115117
//! crate will look like this:
116118
//!
117119
//! ``` toml
118120
//! [dependencies]
119-
//! msp430 = "0.2.0"
121+
//! msp430 = "0.3.0"
120122
//! vcell = "0.1.0"
121-
//! msp430-atomic = "0.1.2" # Only when using the --nightly flag
123+
//! msp430-atomic = "0.1.4" # Only when using the --nightly flag
122124
//!
123125
//! [dependencies.msp430-rt]
124126
//! optional = true
125-
//! version = "0.2.0"
127+
//! version = "0.3.0"
126128
//!
127129
//! [features]
128130
//! rt = ["msp430-rt/device"]

0 commit comments

Comments
 (0)