Merge #114

114: 2018 edition r=therealprof a=japaric

This PR:

- moves the code to the 2018 edition and to cortex-m-rt v0.6.x
- simplifies setting up correct permissions (i.e. udev rules) for the st-link and the serial adapter 

closes #102 

r? @rust-embedded/resources (anyone)

Co-authored-by: Jorge Aparicio <[email protected]>

Author: bors[bot]

ci/script.sh

@@ -15,14 +15,14 @@ main() {
         pushd $chapter
         case $(basename $chapter) in
             05-led-roulette | 06-hello-world)
-                cargo check --target thumbv7em-none-eabihf
+                RUSTFLAGS="-D rust_2018_compatibility -D rust_2018_idioms" cargo check --target thumbv7em-none-eabihf
                 ;;
             WIP-async-io-the-future)
                 popd
                 continue
                 ;;
             *)
-                cargo check
+                RUSTFLAGS="-D rust_2018_compatibility -D rust_2018_idioms" cargo check
                 ;;
         esac
         popd

src/02-requirements/README.md

@@ -1,8 +1,12 @@
 # Hardware/knowledge requirements
 
-The only knowledge requirement to read this book is to know *some* Rust. It's hard for me to
-quantify *some* but at least I can tell you that you don't need to fully grok generics but you do
-need to know how to *use* closures.
+The only knowledge requirement to read this book is to know *some* Rust. It's
+hard for me to quantify *some* but at least I can tell you that you don't need
+to fully grok generics but you do need to know how to *use* closures. You also
+need to be familiar with the idioms of the [2018 edition], in particular with
+the fact that `extern crate` is not necessary in the 2018 edition.
+
+[2018 edition]: https://rust-lang-nursery.github.io/edition-guide/
 
 Also, to follow this material you'll need the following hardware:
 

src/03-setup/README.md

@@ -30,7 +30,7 @@ several MBs in size.
 We'll use all the tools listed below. Where a minimum version is not specified, any recent version
 should work but we have listed the version we have tested.
 
-- Cargo & `rustc` >= nightly-2018-08-02
+- Rust 1.30, 1.30-beta, nightly-2018-09-13, or a newer toolchain.
 
 - [`itmdump`] v0.2.1
 
@@ -39,7 +39,7 @@ should work but we have listed the version we have tested.
 - `arm-none-eabi-gdb`. Version 7.12 or newer highly recommended. Tested versions: 7.10, 7.11,
   7.12 and 8.1
 
-- [`cargo-binutils`]. Version 0.1.2 or newer.
+- [`cargo-binutils`]. Version 0.1.4 or newer.
 
 [`cargo-binutils`]: https://github.com/japaric/cargo-binutils
 
@@ -73,12 +73,12 @@ Then, install or switch to the nightly channel.
 $ rustup default nightly
 ```
 
-**NOTE** Make sure you have a nightly newer than `nightly-2018-08-02`. `rustc -V` should return a
+**NOTE** Make sure you have a nightly newer than `nightly-2018-09-13`. `rustc -V` should return a
 date newer than the one shown below:
 
 ``` console
 $ rustc -V
-rustc 1.29.0-nightly (97085f9fb 2018-08-01)
+rustc 1.30.0-nightly (f2302daef 2018-09-12)
 ```
 
 ### `itmdump`
@@ -95,11 +95,11 @@ itmdump 0.3.1
 ``` console
 $ rustup component add llvm-tools-preview
 
-$ cargo install cargo-binutils --vers 0.1.2
+$ cargo install cargo-binutils --vers 0.1.4
 
-$ cargo size -- --version
+$ cargo size -- -version
 LLVM (http://llvm.org/):
-  LLVM version 7.0.0svn
+  LLVM version 8.0.0svn
   Optimized build.
   Default target: x86_64-unknown-linux-gnu
   Host CPU: skylake

src/03-setup/linux.md

@@ -90,7 +90,7 @@ $ cat /etc/udev/rules.d/99-ftdi.rules
 
 ``` text
 # FT232 - USB <-> Serial Converter
-ATTRS{idVendor}=="0403", ATTRS{idProduct}=="6001", GROUP="uucp"
+ATTRS{idVendor}=="0403", ATTRS{idProduct}=="6001", MODE:="0666"
 ```
 
 ``` console
@@ -99,10 +99,10 @@ $ cat /etc/udev/rules.d/99-openocd.rules
 
 ``` text
 # STM32F3DISCOVERY rev A/B - ST-LINK/V2
-ATTRS{idVendor}=="0483", ATTRS{idProduct}=="3748", GROUP="uucp"
+ATTRS{idVendor}=="0483", ATTRS{idProduct}=="3748", MODE:="0666"
 
 # STM32F3DISCOVERY rev C+ - ST-LINK/V2-1
-ATTRS{idVendor}=="0483", ATTRS{idProduct}=="374b", GROUP="uucp"
+ATTRS{idVendor}=="0483", ATTRS{idProduct}=="374b", MODE:="0666"
 ```
 
 Then reload the udev rules with:
@@ -113,47 +113,6 @@ $ sudo udevadm control --reload-rules
 
 If you had any board plugged to your laptop, unplug them and then plug them in again.
 
-Finally, check if you are in the `uucp` group.
-
-``` console
-$ groups $(id -nu)
-(..) uucp (..)
-$ #  ^^^^
-```
-
-(`$(id -nu)` returns your user name. In my case it's `japaric`.)
-
-If `uucp` appears in the output. You are all set! Go to the [next section]. Otherwise, keep reading:
+Now, go to the [next section].
 
 [next section]: /03-setup/verify.html
-
-- Add yourself to the `uucp` group.
-
-``` console
-$ sudo usermod -a -G uucp $(id -u -n)
-```
-
-- Check again the output of `groups`. `uucp` should be there this time!
-
-``` console
-$ groups $(id -nu)
-(..) uucp (..)
-$ #  ^^^^
-```
-
-You'll have to re-log for these changes to take effect. You have two options:
-
-You can reboot or log out from your current session and then log in; this will close all the
-programs you have open right now.
-
-The other option is to use the command below:
-
-``` console
-$ su - $(id -nu)
-```
-
-to re-log *only in the current shell* and get access to `uucp` devices *only on that shell*. Other
-shells *won't* have access to `uucp` devices unless you manually re-log on them with the same `su`
-command.
-
-Now, go to the [next section].

src/03-setup/verify.md

@@ -23,11 +23,11 @@ file `/dev/bus/usb/003/004` *is* the F3. Let's check its permissions:
 
 ``` console
 $ ls -l /dev/bus/usb/003/004
-crw-rw-r-- 1 root uucp 189, 262 Oct 27 00:00 /dev/bus/usb/003/004
+crw-rw-rw- 1 root root 189, 20 Sep 13 00:00 /dev/bus/usb/003/004
 ```
 
-The group should be `uucp`. If it's not ... then check your [udev rules] and try re-loading them
-with:
+The permissions should be `crw-rw-rw-`. If it's not ... then check your [udev
+rules] and try re-loading them with:
 
 [udev rules]: /03-setup/linux.html#udev%20rules
 
@@ -48,10 +48,10 @@ In my case, it's the `/dev/bus/usb/003/005`. Now, check its permissions:
 
 ``` console
 $ ls -l /dev/bus/usb/003/005
-crw-rw-r--+ 1 root uucp 189, 261 Oct 27 00:00 /dev/bus/usb/003/005
+crw-rw-r-- 1 root root 189, 21 Sep 13 00:00 /dev/bus/usb/003/005
 ```
 
-As before, the group should be `uucp`.
+As before, the permissions should be `crw-rw-r--`.
 
 ## All
 

src/05-led-roulette/.cargo/config

@@ -1,5 +1,5 @@
 [target.thumbv7em-none-eabihf]
-runner = "arm-none-eabi-gdb"
+runner = "arm-none-eabi-gdb -q"
 rustflags = [
   "-C", "linker=rust-lld",
   "-C", "link-arg=-Tlink.x",

src/05-led-roulette/Cargo.toml

@@ -1,8 +1,8 @@
 [package]
 authors = ["Jorge Aparicio <[email protected]>"]
+edition = "2018"
 name = "led-roulette"
 version = "0.1.0"
 
 [dependencies]
 aux5 = { path = "auxiliary" }
-cortex-m-rt = "0.5.3"

src/05-led-roulette/README.md

@@ -22,24 +22,7 @@ projects.
 Now, jump into the `src/05-led-roulette` directory. Check the `src/main.rs` file:
 
 ``` rust
-#![deny(unsafe_code)]
-#![no_main]
-#![no_std]
-
-extern crate aux5;
-#[macro_use]
-extern crate cortex_m_rt;
-
-entry!(main);
-
-fn main() -> ! {
-    let _y;
-    let x = 42;
-    _y = x;
-
-    // infinite loop; just so we don't leave this stack frame
-    loop {}
-}
+{{#include src/main.rs}}
 ```
 
 Microcontroller programs are different from standard programs in two aspects: `#![no_std]` and
@@ -51,7 +34,7 @@ systems (i.e., systems without OS abstractions like files and sockets).
 
 The `no_main` attribute says that this program won't use the standard `main` interface, which is
 tailored for command line applications that receive arguments. Instead of the standard `main` we'll
-use the `entry!` macro from the [`cortex-m-rt`] crate to define a custom entry point. In this
+use the `entry` attribute from the [`cortex-m-rt`] crate to define a custom entry point. In this
 program we have named the entry point "main", but any other name could have been used. The entry
 point function must have signature `fn() -> !`; this type indicates that the function can't return
 -- this means that the program never terminates.

src/05-led-roulette/auxiliary/Cargo.toml

@@ -1,12 +1,13 @@
 [package]
 authors = ["Jorge Aparicio <[email protected]>"]
+edition = "2018"
 name = "aux5"
 version = "0.1.0"
 
 [dependencies]
 cortex-m = "0.5.6"
-panic-abort = "0.2.0"
-cortex-m-rt = "0.5.3"
+panic-halt = "0.2.0"
+cortex-m-rt = "0.6.3"
 
 [dependencies.f3]
 features = ["rt"]

src/05-led-roulette/auxiliary/src/lib.rs

@@ -2,21 +2,16 @@
 
 #![no_std]
 
-extern crate cortex_m;
-#[macro_use]
-extern crate cortex_m_rt;
-extern crate f3;
-extern crate panic_abort;
-
-use core::sync::atomic::{self, Ordering};
-
-use cortex_m::asm;
-use cortex_m_rt::ExceptionFrame;
-pub use f3::hal::delay::Delay;
-pub use f3::hal::prelude;
-use f3::hal::prelude::*;
-use f3::hal::stm32f30x;
-pub use f3::led::Leds;
+#[allow(unused_extern_crates)] // NOTE(allow) bug rust-lang/rust#53964
+extern crate panic_halt; // panic handler
+
+pub use cortex_m_rt::entry;
+pub use f3::{
+    hal::{delay::Delay, prelude},
+    led::Leds,
+};
+
+use f3::hal::{prelude::*, stm32f30x};
 
 pub fn init() -> (Delay, Leds) {
     let cp = cortex_m::Peripherals::take().unwrap();
@@ -33,23 +28,3 @@ pub fn init() -> (Delay, Leds) {
 
     (delay, leds)
 }
-
-exception!(HardFault, hard_fault);
-
-fn hard_fault(_ef: &ExceptionFrame) -> ! {
-    asm::bkpt();
-
-    loop {
-        // add some side effect to prevent LLVM from turning this into a UDF (abort) instruction
-        // see rust-lang/rust#28728 for details
-        atomic::compiler_fence(Ordering::SeqCst)
-    }
-}
-
-exception!(*, default_handler);
-
-fn default_handler(_irqn: i16) {
-    loop {
-        atomic::compiler_fence(Ordering::SeqCst)
-    }
-}