diff --git a/README.md b/README.md
index 29d71cd8bae60de3aa80ba1af187d7a9a4c9093a..e3d110bdca3c71517c5dcc4e3df21bb93efeda0c 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,4 @@
-
-Are We Embedded Yet
+Are We Embedded Yet
=====================
## D7018E - Special Studies in Embedded Systems
@@ -29,8 +28,8 @@ The course will be given as a self study course with a set of introductional sem
7. Macros
- Macro_rules/matching and expansion. Procedural macros (macros 2.0). Overview of the Rust RTFM implementation.
-
+ Macro_rules/matching and expansion. Procedural macros (macros 2.0). Overview of the Rust RTFM implementation.
+
8. Building and debugging embedded code in Rust
Hardware abstractions using svd2rust (autogenerated from vendor-provided SVD specifications). Compiling using xargo. Setting up openocd and gdb.
@@ -45,7 +44,7 @@ Please fill out the [doodle](http://doodle.com) so we can arrange for a first sc
Each topic will be accompanied by a set of small illustrative examples and assignments that each student should master (learning goals). On the following session, each student should prepare to discuss and demonstrate their solutions.
-Lectures and assignments will be covered over a 4 week period, leaving time for a larger assignment/project.
+Lectures and assignments will be covered over a 4 week period, leaving time for a larger assignment/project.
Each project should be reported in terms of a git Rust crate, with sufficient documentation (readme.md) to build, and recreate the result.
@@ -54,19 +53,19 @@ There will be two presentation rounds (at end of LP2 and LP3). Students taking (
Projects should be related to embedded programming, either on the target side (some application using the RTFM-core or CRC model), or on the host side, communicating with an embedded target running Rust RTFM. E.g., two groups can work together with building a system, e.g., with back-end processing of data collected by the embedded system, or by providing a front-end to the embedded system. Alternatively, host side project could relate the development of the RTFM-core/ RTFM-CRC frameworks or related tools (e.g. LLWM-KLEE as a backend for analysis of Rust code).
## Resources
-Students will carry out the assignments on their personal laptops (in case you don't have a working laptop we will try to lend you one). Tools used are available for Linux and OSX, but with a bit of trickery windows based installations should be possible (but you are on your own here). In case you don't run OSX/Linux native, virtual box or VMware is possible, though debugging of target MCUs are feasible it is a bit more tricky.
+Students will carry out the assignments on their personal laptops (in case you don't have a working laptop we will try to lend you one). Tools used are available for Linux and OSX, but with a bit of trickery windows based installations should be possible (but you are on your own here). In case you don't run OSX/Linux native, virtual box or VMware is possible, though debugging of target MCUs are feasible it is a bit more tricky.
Embedded targets STM32F401RE/411RE (Nucleo-64) will be made available to all students. You will need to get a mini-USB cable yourselves. If you prefer to work with some other ARM Cortex M processor, let us know and we will have a look at available support.
-Teaching material will be made available through git (this project), build and refined throughout the course.
+Teaching material will be made available through git (this project), build and refined throughout the course.
We encourage all sorts of collaborations in between the students. Rust is not the easiest language to learn, and we will cover a lot of ground. Use the seminars to try to get as much as possible by being well prepared in order to succeed. We will use telegram as the main means of communication and support from teachers as well as other fellow students, (this way information will reach everyone, keeping support as efficient as possible).
# Course in detail
Seminars
-1. Welcome.
+1. Welcome.
* Preparation
Please bring your laptop, and we will install the Rust tools required in order to compile and run your first application.
@@ -75,10 +74,10 @@ Seminars
About the course. Scheduling further seminars. Introduction to the Rust [ecosystem](doc/Ecosystem.md), and basics of Rust programming.
- We will cover the Rust book [Rustbook Second Edition](https://doc.rust-lang.org/book/second-edition/) sections
+ We will cover the Rust book [Rustbook Second Edition](https://doc.rust-lang.org/book/second-edition/) sections
- * [1 - Introduction](https://doc.rust-lang.org/book/second-edition/ch01-00-introduction.html),
- * [2 - Guessing Game Tutorial](https://doc.rust-lang.org/book/second-edition/ch02-00-guessing-game-tutorial.html), and
+ * [1 - Introduction](https://doc.rust-lang.org/book/second-edition/ch01-00-introduction.html),
+ * [2 - Guessing Game Tutorial](https://doc.rust-lang.org/book/second-edition/ch02-00-guessing-game-tutorial.html), and
* [3 - Common Programming Concepts](https://doc.rust-lang.org/book/second-edition/ch03-00-common-programming-concepts.html).
* Assignment 1
@@ -86,7 +85,7 @@ Seminars
Make a GitHub account (if you don't have it). Make a GitHub project with your code, along with a README.md for usage instructions.
- Prepare to present your development for the next seminar.
+ Prepare to present your development for the next seminar.
2. Basic Programming
* Preparation
@@ -94,7 +93,7 @@ Seminars
Solve and be prepared to present Assignment 1.
* Assessment
- We will in the class install, test and comment on one of Your solutions. That is, make sure your `crate` on git actually works, and that the accompanying `readme.md` is sufficient for your fellow students in order to recreate the result.
+ We will in the class install, test and comment on one of Your solutions. That is, make sure your `crate` on git actually works, and that the accompanying `readme.md` is sufficient for your fellow students in order to recreate the result.
Later in the course, you will assess each others assignments by creating an `issue` to their development. More on that later.
* Topic
@@ -102,10 +101,10 @@ Seminars
Using the Rust ownership model.
Data structures, structs, enums, String (relation to slices) etc. Containers, Vec, and HashSets/Maps. Iterators. Using the Rust module system. Handling errors.
- We will cover the Rust book [Rustbook Second Edition](https://doc.rust-lang.org/book/second-edition/) sections
+ We will cover the Rust book [Rustbook Second Edition](https://doc.rust-lang.org/book/second-edition/) sections
- * [4 - Understanding Ownership](https://doc.rust-lang.org/book/second-edition/ch04-00-understanding-ownership.html),
- * [5 - Using Structs to Structure Related Data](https://doc.rust-lang.org/book/second-edition/ch05-00-structs.html),
+ * [4 - Understanding Ownership](https://doc.rust-lang.org/book/second-edition/ch04-00-understanding-ownership.html),
+ * [5 - Using Structs to Structure Related Data](https://doc.rust-lang.org/book/second-edition/ch05-00-structs.html),
* [6 - Enums and Pattern Matchings](https://doc.rust-lang.org/book/second-edition/ch06-00-enums.html),
* [7 - Modules](https://doc.rust-lang.org/book/second-edition/ch07-00-modules.html),
@@ -124,7 +123,7 @@ Seminars
e. Instead of vector use a 'HashMap', with a key `u32` and a value `String`. Again iterate (`for`) to print all entries at exiting. (Explain the result.)
- f. Optional, find a way to print the last 3 entries of the `HashMap` (output similar to d).
+ f. Optional, find a way to print the last 3 entries of the `HashMap` (output similar to d).
Make new branches (`2a, 2b, ..., 2f`) with your solutions, along with a README.md for usage instructions, and expected behavior.
@@ -138,12 +137,12 @@ Seminars
Finish Assignment 2.
* Topic [Memory](doc/Memory.md)
- In-depth discussion of underlying theory, linear types (relation to functional programming). The *Affine* type system of Rust, requirements on the programmer, and guarantees offered by the compiler. Lifetimes, of stack allocated and global variables. Relation to C++ `unique pointers`.
+ In-depth discussion of underlying theory, linear types (relation to functional programming). The *Affine* type system of Rust, requirements on the programmer, and guarantees offered by the compiler. Lifetimes, of stack allocated and global variables. Relation to C++ `unique pointers`.
* Assignment
a. Recall the D0013E course lab2/4, where you decrypted a message in assembler (lab2) and C (lab 4). Now, let's re-implement the lab in Rust (base your development on group number [1's](http://www.sm.luth.se/csee/courses/smd/D0013E/labs/lab1underlag/grupp_01.lab1_underlag.s ) lab assignment).
- You have to be careful about the signed/unsigned operations and use `wrapping` arithmetics to avoid panics due to unsigned *carry* and signed *overflow*.
+ You have to be careful about the signed/unsigned operations and use `wrapping` arithmetics to avoid panics due to unsigned *carry* and signed *overflow*.
Use borrowed array slices as arguments to `decode`.
@@ -161,12 +160,13 @@ Seminars
Finish assignment 3. Bring a USB mini cable, and/or your Cortex M dev board of choice. We will provide Nucleo 64s (STM32f401re/STM32f411re if you do not have a board.)
* Topic
- Embedded programming in Rust.
+ Embedded programming in Rust. Check this [document](doc/Quickstart.md)
* xargo for building non-`std` (bare metal) systems
- * [cortex-m-quickstart]
- * [cortex-m]
- * [bluepill/nucleo] crates
+ * `cortex-m-quickstart`, project template
+ * `cortex-m`, crate common to all Cortex-M devices
+ * `stm32f103xx` and `stm32f40x`, device crates
+ * `blue-pill` and `nucleo` board support crates
* Building and debugging your first application.
* Assignment
@@ -200,13 +200,13 @@ Seminars
* Finish lab 3 and be prepared to show your solution.
* Topic
- * UnsafeCell, and synchronization in the RTFM model.
+ * UnsafeCell, and synchronization in the RTFM model.
* Requirements for Stack Resource Policy (SRP) based single-core scheduling.
* [cortex-m-rtfm](https://github.com/japaric/cortex-m-rtfm) The RTFM-core (task and resource model) in Rust for the Cortex-M family
- * [svd2rust](https://github.com/japaric/svd2rust) Generating
+ * [svd2rust](https://github.com/japaric/svd2rust) Generating
* Assignment 4
Implement a simple system with two tasks
@@ -254,7 +254,7 @@ Seminars
Write a project specification including individual grading assessment criteria.
-10. Wrap-up
+10. Wrap-up
* Preparation
* Be prepared to present assignment 5.