diff --git a/CHANGELOG.md b/CHANGELOG.md index 89d2b8c..fc7675d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,8 +5,17 @@ This project adheres to [Semantic Versioning](http://semver.org/). ## [Unreleased] +## v0.1.1 - 2017-04-27 + +### Changed + +- Bumped the version of the `cortex-m-rt` dependency to v0.2.0. NOTE that the + instantiation steps have slightly changed, the `memory.x` file changed, + because of this. + ## v0.1.0 - 2017-04-25 - Initial release -[Unreleased]: https://github.com/japaric/cortex-m-quickstart/compare/v0.1.0...HEAD +[Unreleased]: https://github.com/japaric/cortex-m-quickstart/compare/v0.1.1...HEAD +[v0.1.1]: https://github.com/japaric/cortex-m-quickstart/compare/v0.1.0...v0.1.1 diff --git a/Cargo.toml b/Cargo.toml index 6dcbc33..d5a867d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -5,11 +5,11 @@ keywords = ["arm", "cortex-m", "template"] license = "MIT OR Apache-2.0" name = "cortex-m-quickstart" repository = "https://github.com/japaric/cortex-m-quickstart" -version = "0.1.0" +version = "0.1.1" [dependencies] cortex-m = "0.2.4" -cortex-m-rt = "0.1.3" +cortex-m-rt = "0.2.0" [profile.release] lto = true diff --git a/memory.x b/memory.x index 1ee89d1..32adb49 100644 --- a/memory.x +++ b/memory.x @@ -1,6 +1,12 @@ MEMORY { /* NOTE K = KiBi = 1024 bytes */ + /* TODO Adjust these memory regions to match your device memory layout */ FLASH : ORIGIN = 0xBAAAAAAD, LENGTH = 0K RAM : ORIGIN = 0xBAAAAAAD, LENGTH = 0K } + +/* This is where the call stack will be allocated. */ +/* The stack is of the full descending type. */ +/* NOTE Do NOT modify `_stack_start` unless you know what you are doing */ +_stack_start = ORIGIN(RAM) + LENGTH(RAM); diff --git a/src/lib.rs b/src/lib.rs index cda4143..b926c3f 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -20,6 +20,10 @@ //! //! - Specify the memory layout of the target device //! +//! (Note that some board support crates may provide this file for you (check +//! the crate documentation). If you are using one that does that then remove +//! *both* the `memory.x` and `build.rs` files.) +//! //! ``` text //! $ edit memory.x && cat $_ //! MEMORY @@ -28,6 +32,11 @@ //! FLASH : ORIGIN = 0x08000000, LENGTH = 256K //! RAM : ORIGIN = 0x20000000, LENGTH = 40K //! } +//! +//! /* This is where the call stack will be allocated. */ +//! /* The stack is of the full descending type. */ +//! /* NOTE Do NOT modify `_stack_start` unless you know what you are doing */ +//! _stack_start = ORIGIN(RAM) + LENGTH(RAM); //! ``` //! //! - Optionally, set a default build target @@ -45,7 +54,7 @@ //! # add a device crate, or //! $ cargo add stm32f30x //! -//! # add a BSP crate +//! # add a board support crate //! $ cargo add f3 //! ``` //!