Populate README.md, migration complete.

rust-embedded · Jan 12, 2020 · e27d0b5 · e27d0b5
1 parent 9405234
commit e27d0b5
Showing 1 changed file with 136 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,138 @@
 # `msp430-quickstart`
 
-> WIP
+> A template for building applications for TI MSP430 microcontrollers.
+
+This project is developed and maintained by the [MSP430 team][team].
+
+## Dependencies
+
+- Rust nightly-2019-03-27 or a newer toolchain. _Only nightly compilers work
+  for now._
+
+  You can set up a nightly compiler as the default compiler using
+  `rustup default nightly`. Alternatively, you can set up overrides on a
+  project basis using `rustup override set --path /path/to/crate nightly-YYYY-MM-DD`
+
+- The `cargo generate` subcommand ([Installation instructions](https://github.com/ashleygwilliams/cargo-generate#installation)).
+
+- The [`xargo`](https://github.com/japaric/xargo) sysroot manager.
+  `xargo` is required until MSP430's `libcore` is part of Rust CI). To
+  install, run:
+  ``` console
+  $ cargo install xargo
+  $ rustup component add rust-src
+  ```
+
+- TI's [MSP430 GCC Compiler](http://www.ti.com/tool/MSP430-GCC-OPENSOURCE),
+  version 8.3.0 or greater. `msp430-elf-gcc` should be visible on the path.
+
+- [`svd2rust`](https://github.com/rust-embedded/svd2rust), commit 783fbd0 or
+  newer.
+
+- [`msp430_svd`](https://github.com/pftbest/msp430_svd), commit e1eb730 or
+  newer. Cloning the repo and following the directions in README.md is
+  sufficient.
+
+## Using this template
+
+0. Before instantiating a project, you need to know some characteristics about
+   your specific MSP430 device that will be used to fill in the template. In
+   particular:
+
+   - What is the exact part number of your device? Which MSP430 family does
+     your part belong to?
+
+   - Does your part have an already-existing [peripheral access crate](https://rust-embedded.github.io/book/start/registers.html) (PAC)?
+
+   - How much flash memory, RAM, and how many interrupt vectors does your
+     device have?
+
+   - Where does flash memory, RAM, and interrupt vectors begin in the address
+     space?
+
+   `msp430g2553` is used for the examples in this crate. Answering the first
+   question above:
+
+   - `msp430g2553` belongs to the [`MSP430x2xx` family](https://www.ti.com/lit/ug/slau144j/slau144j.pdf).
+
+   The linked family manual and [datasheet](http://www.ti.com/lit/ds/slas735j/slas735j.pdf)
+   can be used to answer the remaining questions:
+
+   - The `msp430g2553` PAC exists already and can be found on [crates.io](https://crates.io/crates/msp430g2553).
+
+   - `msp430g2553` has 16kB of flash memory, 512 bytes of RAM, and 16 vectors.
+
+   - Flash memory begins at address 0xC000. RAM begins at address 0x0200.
+     The interrupt vectors begin at 0xFFE0.
+
+1. If your particular device does not have a PAC crate, you will need to
+   generate one using `svd2rust` and possibly [publish](https://doc.rust-lang.org/cargo/reference/publishing.html)
+   the crate to https://crates.io. To generate an SVD file, follow the directions
+   in the `msp430_svd` [README.md](https://github.com/pftbest/msp430_svd#msp430_svd)
+   for your device.
+
+   In some cases like [`msp430fr2355`](https://github.com/YuhanLiin/msp430fr2355-quickstart/issues/4#issuecomment-569178043),
+   TI's linker files are not consistent with datasheets on where interrupt
+   vectors begin and how many interrupt vectors there are for a given device.
+   In case of a conflict, _[examine](https://github.com/YuhanLiin/msp430fr2355-quickstart#issuecomment-569320608)
+   the linker script to determine where to start the `VECTORS` section in
+   `memory.x`._ Copies of many linker scripts are kept in the
+   [`msp430_svd`](https://github.com/pftbest/msp430_svd/tree/master/msp430-gcc-support-files)
+   repository.
+
+2. Instantiate the template.
+
+   ``` console
+   $ cargo generate --git https://github.com/rust-embedded/msp430-quickstart
+   Project Name: app
+   Creating project called `app`...
+   Done! New project created /tmp/app
+
+   $ cd app
+   ```
+
+3. If not targeting `msp430g2553`, replace the PAC entry for `msp430g2553` in
+   `Cargo.toml` with that of your device, e.g.:
+
+   ``` toml
+   # [dependencies.msp430g2553]
+   # version = "0.2.0"
+   # features = ["rt"]
+   [dependencies.msp430fr2355]
+   version = "0.4.0"
+   features = ["rt"]
+   ```
+
+4. Populate the `memory.x` file with address space layout information of your
+   device. _Note: As mentioned above, in case of a conflict between the
+   datasheet and linker script on where interrupt vectors begin, use the
+   linker script!_
+
+   ``` console
+   $ cat memory.x
+   MEMORY
+   {
+     /* These values are correct for the msp430g2553 device. You will need to
+        modify these values if using a different device. Room must be reserved
+        for interrupt vectors plus reset vector and the end of the first 64kB
+        of address space. */
+     RAM : ORIGIN = 0x0200, LENGTH = 0x0200
+     ROM : ORIGIN = 0xC000, LENGTH = 0x3FE0
+     VECTORS : ORIGIN = 0xFFE0, LENGTH = 0x20
+   }
+   ```
+
+5. Build the template application or one of the examples. If building
+   `timer-oncecell`, don't forget to uncomment the `once_cell` dependency in
+   `Cargo.toml`!
+
+   ``` console
+   $ xargo build
+   $ xargo build --examples
+   ```
+
+   `Xargo.toml` is set up properly for nearly all use cases and need not be
+   modified.
 
 # License
 
@@ -10,11 +142,12 @@ Licensed under either of
   http://www.apache.org/licenses/LICENSE-2.0)
 
 - MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
-
-at your option.
+  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.
+
+[team]: https://github.com/rust-embedded/wg#the-msp430-team