sambuc/microrust
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

2018-10 version bumps and compatibility updates

Browse Source
This commit is contained in:
Michael Droogleever
2018-10-13 21:52:24 +02:00
parent cac16f3494
commit da3e868599
21 changed files with 106 additions and 335 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
.cargo/config
View File

@@ -1,9 +1,14 @@
# Configure builds for our target, the micro:bit's architecture
[target.thumbv6m-none-eabi]
# Execute binary using gdb when calling cargo run
runner = "arm-none-eabi-gdb"
# Tweak to the linking process required by the cortex-m-rt crate
rustflags = [
"-C", "link-arg=-Wl,-Tlink.x",
"-C", "link-arg=-nostartfiles",
"-C", "link-arg=-Tlink.x",
# The LLD linker is selected by default
#"-C", "linker=arm-none-eabi-ld",
]
# Automatically select this target when cargo building this project
[build]
target = "thumbv6m-none-eabi"

4
src/SUMMARY.md
View File

@@ -56,9 +56,11 @@
- [Multiplexing](display/03.02.MULT.md)
- [Full Solution](display/03.03.FULL.md)
- [WIP - Sensors and I²C](sensors/00.00.README.md)
- [WIP - Non-blocking](nb/00.00.README.md)
- [WIP - Sensors and I²C](sensors/00.00.README.md)
- [WIP - Interrupts](nb/00.00.README.md)
- [WIP - Real time](rtfm/00.00.README.md)

11
src/appendix/troubleshooting.md
View File

@@ -147,3 +147,14 @@ The `eh_personality` language item is used to implement stack unwinding in case
You need to use the correct target
by using `--target thumbv6m-none-eabi`
or modifying `.cargo/config`
### `error: ld: cannot open linker script file memory.x: No such file or directory`
#### Cause
A memory.x file is needed, this specifies memory layout.
#### Fix
Either ask the board support crate maintainer to add memory.x to their crate,
or add a memory.x file to your project.

6
src/display/Cargo.toml
View File

@@ -3,7 +3,7 @@ name = "display"
version = "0.1.0"
[dependencies]
cortex-m-rt="~0.5"
cortex-m-rt="~0.6"
cortex-m-semihosting="~0.3"
panic-semihosting = "~0.3"
microbit="~0.5"
panic-semihosting = "~0.5"
microbit="~0.6"

18
src/display/src/main.rs
View File

@@ -4,12 +4,10 @@
extern crate panic_semihosting;
extern crate cortex_m_rt as rt;
extern crate cortex_m_semihosting as sh;
#[macro_use(entry, exception)]
extern crate microbit;
use core::fmt::Write;
use rt::ExceptionFrame;
use rt::entry;
use sh::hio;
use microbit::hal::delay::Delay;
@@ -20,18 +18,6 @@ use microbit::hal::serial;
use microbit::hal::serial::BAUD115200;
use microbit::hal::prelude::*;
exception!(HardFault, hard_fault);
fn hard_fault(ef: &ExceptionFrame) -> ! {
panic!("{:#?}", ef);
}
exception!(*, default_handler);
fn default_handler(irqn: i16) {
panic!("Unhandled exception (IRQn = {})", irqn);
}
type LED = PIN<Output<PushPull>>;
const DEFAULT_DELAY_MS: u32 = 2;
@@ -128,7 +114,7 @@ impl Display {
}
}
entry!(main);
#[entry]
fn main() -> ! {
let mut stdout = hio::hstdout().unwrap();
writeln!(stdout, "Start").unwrap();

9
src/getting-started/.cargo/config
View File

@@ -1,9 +0,0 @@
[target.thumbv6m-none-eabi]
runner = "arm-none-eabi-gdb"
rustflags = [
"-C", "link-arg=-Wl,-Tlink.x",
"-C", "link-arg=-nostartfiles",
]
[build]
target = "thumbv6m-none-eabi"

163
src/getting-started/01.00.BUILD.md
View File

@@ -1,9 +1,9 @@
# New Project
``` shell
$ cargo new rustled
Created binary (application) `rustled` project
$ cd rustled
$ cargo new microrust-start
Created binary (application) `microrust-start` project
$ cd microrust-start
Cargo.toml src
```
@@ -47,7 +47,7 @@ error[E0463]: can't find crate for `std`
error: aborting due to previous error
For more information about this error, try `rustc --explain E0463`.
error: Could not compile `rustled`.
error: Could not compile `microrust-start`.
To learn more, run the command again with --verbose.
```
@@ -75,9 +75,6 @@ fn main() {
``` shell
$ cargo build --target thumbv6m-none-eabi
```
``` shell
error: cannot find macro `println!` in this scope
--> src/main.rs:4:5
|
@@ -91,11 +88,11 @@ We don't need it at the moment, so we can remove it and try to build again.
## Build 3
``` shell
error: language item required, but not found: `panic_impl`
$ cargo build --target thumbv6m-none-eabi
error: `#[panic_handler]` function required, but not found
```
This error, is because the panic macro is unimplemented,
when rustc needs it to have an implementation.
This error, is because rustc required a panic handler to be implemented.
### `panic_impl`
@@ -112,8 +109,7 @@ If you have forgotten how to do this, try looking at [the cargo book][cargo].
`Cargo.toml`
``` toml
[dependencies]
panic-abort = "~0.2"
{{#include Cargo.toml:5:6}}
```
`src/main.rs`
@@ -130,9 +126,6 @@ fn main() {
``` shell
$ cargo build --target thumbv6m-none-eabi
```
``` shell
error: requires `start` lang_item
```
@@ -172,9 +165,7 @@ At this point we need the help of a board-specific support crate and a few cargo
Let us add a dependency on the board crate for the micro:bit.
``` toml
[dependencies]
panic-abort = "~0.2"
microbit="~0.5"
{{#include Cargo.toml:5:7}}
```
The microbit crate has 2 notable dependencies:
@@ -192,13 +183,15 @@ be implemented by board specific crates.
This crate implements the minimal startup / runtime for Cortex-M microcontrollers.
Among other things this crate provides:
- the `entry!` macro, to define the entry point of the program.
- the `exception!` macro, to set or override a processor core exception handler.
- the `#[entry]` attribute, to define the entry point of the program.
- a definition of the hard fault handler
- a definition of the default exception handler
This crate requires:
- a definition of the specific microcontroller's memory layout as a memory.x file.
- a definition of the hard fault handler
- a definition of the default exception handler
fortunately this is usually provided by the board support crates
To use the `#[entry]` attribute, we will need to add this as a dependency.
For more detailed information,
you can use the helpful [cortex-m-quickstart crate][qs] and [its documentation][doc].
@@ -209,14 +202,14 @@ you can use the helpful [cortex-m-quickstart crate][qs] and [its documentation][
## cargo config
Before we go any further,
we are going to tweak the cargo's configuration by editing `rustled/.cargo/config`.
we are going to tweak the cargo's configuration by editing `microrust-start/.cargo/config`.
For more information, you can read [the documentation here][cargoconfig].
[cargoconfig]: https://doc.rust-lang.org/cargo/reference/config.html
### `.cargo/config`
``` toml
<!-- ``` toml
# Configure builds for our target
[target.thumbv6m-none-eabi]
# Execute binary using gdb
@@ -230,6 +223,10 @@ rustflags = [
# Automatically select this target when running cargo for this project
[build]
target = "thumbv6m-none-eabi"
``` -->
``` toml
{{#include ../../.cargo/config}}
```
### arm-none-eabi-gdb
@@ -246,9 +243,7 @@ and cargo will automatically add `--target thumbv6m-none-eabi`.
### `Cargo.toml`
``` toml
[dependencies]
panic-abort = "~0.2"
microbit="~0.5"
{{#include Cargo.toml:5:8}}
```
### `src/main.rs`
@@ -259,7 +254,9 @@ microbit="~0.5"
extern crate panic_abort;
entry!(main);
use cortex_m_rt::entry;
#[entry];
fn main() {
}
```
@@ -269,22 +266,20 @@ $ cargo build
```
``` shell
error[E0308]: mismatched types
--> src/main.rs:9:1
error: custom attribute panicked
--> src/main.rs:7:1
|
8 | entry!(main);
| ^^^^^^^^^^^^^ expected !, found ()
7 | #[entry]
| ^^^^^^^^
|
= note: expected type `fn() -> !`
found type `fn() {main}`
= note: this error originates in a macro outside of the current crate (in Nightly builds, run with -Z external-macro-backtrace for more info)
= help: message: `#[entry]` function must have signature `[unsafe] fn() -> !`
```
## `!` return type
A little known rust feature, so I will forgive you if you do not know what this means.
A return type of `!` means that the function cannot return
An easy way to implement this, is by using an infinite loop.
A return type of `!` means that the function cannot return.
An easy way to implement this is to use an infinite loop.
### `src/main.rs`
@@ -294,10 +289,9 @@ An easy way to implement this, is by using an infinite loop.
extern crate panic_abort;
#[macro_use(entry)]
extern crate microbit;
use cortex_m_rt::entry;
entry!(main);
#[entry]
fn main() -> ! {
loop {}
}
@@ -305,98 +299,19 @@ fn main() -> ! {
## Build 6
``` shell
error: linking with `arm-none-eabi-gcc` failed: exit code: 1
|
= note: "arm-none-eabi-gcc" "-L" "/home/xxx/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/thumbv6m-none-eabi/lib" "/home/xxx/rust/rustled/target/thumbv6m-none-eabi/debug/deps/rustled-e6053d34b0422141.2yhvr0tmp69gb94x.rcgu.o" "-o"
# SNIP
"/home/xxx/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/thumbv6m-none-eabi/lib/libcore-fb37a4ea1db1e473.rlib" "-Wl,--end-group" "/home/xxx/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/thumbv6m-none-eabi/lib/libcompiler_builtins-f2357c0397dd7e0d.rlib" "-Wl,-Tlink.x" "-nostartfiles" "-Wl,-Bdynamic"
= note: /usr/lib/gcc/arm-none-eabi/8.1.0/../../../../arm-none-eabi/bin/ld: cannot open linker script file memory.x: No such file or directory
collect2: error: ld returned 1 exit status
```
A scary error, but if you look closely you will see `cannot open linker script file memory.x: No such file or directory`.
We mentioned something a little earlier about memory.x file.
To save you the hassle of scouring the internet for one or creating your own, you can copy it over into your project:
``` shell
$ cp ../../memory.x ./
```
> Often a board support crate will already include this, so this step will not be necessary.
## Build 7
``` shell
error: linking with `arm-none-eabi-gcc` failed: exit code: 1
|
= note: "arm-none-eabi-gcc" "-L" "/home/xxx/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/thumbv6m-none-eabi/lib" "/home/xxx/rust/rustled/target/thumbv6m-none-eabi/debug/deps/rustled-e6053d34b0422141.2yhvr0tmp69gb94x.rcgu.o" "-o"
# SNIP
"/home/xxx/.rustup/toolchains/nightly-x86_64-unknown-linux-gnu/lib/rustlib/thumbv6m-none-eabi/lib/libcompiler_builtins-f2357c0397dd7e0d.rlib" "-Wl,-Tlink.x" "-nostartfiles" "-Wl,-Bdynamic"
= note: device.x:1: undefined symbol `DefaultHandler' referenced in expression
collect2: error: ld returned 1 exit status
```
Notice `undefined symbol 'DefaultHandler' referenced in expression`.
We said earlier, as with the memory,
that the hard fault handler and default exception handler both need defining.
### `Cargo.toml`
``` toml
[dependencies]
panic-abort = "~0.2"
cortex-m-rt="~0.5"
microbit="~0.5"
```
### `src/main.rs`
``` rust
#![no_std]
#![no_main]
extern crate panic_abort;
extern crate cortex_m_rt as rt;
#[macro_use(entry, exception)]
extern crate microbit;
use rt::ExceptionFrame;
exception!(HardFault, hard_fault);
fn hard_fault(ef: &ExceptionFrame) -> ! {
panic!("{:#?}", ef);
}
exception!(*, default_handler);
fn default_handler(irqn: i16) {
panic!("Unhandled exception (IRQn = {})", irqn);
}
entry!(main);
fn main() -> ! {
loop {}
}
```
It is all a bit ugly, but fortunately it only needs to be done once.
If you try building now, you should finally be greeted with `Finished`!
``` shell
$ cargo build
Finished dev [unoptimized + debuginfo] target(s) in 20.51s
Finished dev [unoptimized + debuginfo] target(s) in 0.04s
```
## Build Complete
As a sanity check, let's verify that the produced executable is actually an ARM binary:
``` console
$ file target/thumbv6m-none-eabi/debug/rustled
target/thumbv6m-none-eabi/debug/rustled: ELF 32-bit LSB executable, ARM, EABI5 version 1 (SYSV), statically linked, with debug_info, not stripped
^^^ ^^^^
``` shell
$ file target/thumbv6m-none-eabi/debug/microrust-start
target/thumbv6m-none-eabi/debug/microrust-start: ELF 32-bit LSB executable, ARM, EABI5 version 1 (SYSV), statically linked, with debug_info, not stripped
^^^ ^^^^^
```

8
src/getting-started/Cargo.toml
View File

@@ -1,8 +1,8 @@
[package]
name = "start"
version = "0.1.0"
version = "0.2.0"
[dependencies]
panic-abort = "~0.2"
cortex-m-rt="~0.5"
microbit="~0.5"
panic-abort = "~0.3"
microbit="~0.6"
cortex-m-rt="~0.6"

24
src/getting-started/src/main.rs
View File

@@ -1,30 +1,16 @@
#![no_std]
#![no_main]
extern crate panic_abort;
extern crate cortex_m_rt as rt;
#[macro_use(entry, exception)]
extern crate cortex_m_rt;
extern crate microbit;
extern crate panic_abort;
use rt::ExceptionFrame;
use cortex_m_rt::entry;
exception!(HardFault, hard_fault);
fn hard_fault(ef: &ExceptionFrame) -> ! {
panic!("{:#?}", ef);
}
exception!(*, default_handler);
fn default_handler(irqn: i16) {
panic!("Unhandled exception (IRQn = {})", irqn);
}
entry!(main);
#[entry]
fn main() -> ! {
let _y;
let x = 42;
_y = x;
loop {}
}
}

10
src/hello-world/Cargo.toml
View File

@@ -1,9 +1,9 @@
[package]
name = "hello"
version = "0.1.0"
version = "0.2.0"
[dependencies]
cortex-m-rt="~0.5"
cortex-m-semihosting=""
panic-semihosting = "~0.3"
microbit="~0.5"
microbit="~0.6"
cortex-m-rt="~0.6"
cortex-m-semihosting="~0.3"
panic-semihosting = "~0.5"

18
src/hello-world/src/main.rs
View File

@@ -4,31 +4,17 @@
extern crate panic_semihosting;
extern crate cortex_m_rt as rt;
extern crate cortex_m_semihosting as sh;
#[macro_use(entry, exception)]
extern crate microbit;
use core::fmt::Write;
use rt::ExceptionFrame;
use rt::entry;
use sh::hio;
use microbit::hal::prelude::*;
use microbit::hal::serial;
use microbit::hal::serial::BAUD115200;
exception!(HardFault, hard_fault);
fn hard_fault(ef: &ExceptionFrame) -> ! {
panic!("{:#?}", ef);
}
exception!(*, default_handler);
fn default_handler(irqn: i16) {
panic!("Unhandled exception (IRQn = {})", irqn);
}
entry!(main);
#[entry]
fn main() -> ! {
let mut stdout = hio::hstdout().unwrap();
writeln!(stdout, "Start").unwrap();

10
src/microbit/Cargo.toml
View File

@@ -3,8 +3,8 @@ name = "microbit"
version = "0.1.0"
[dependencies]
cortex-m-rt="~0.5"
cortex-m-semihosting=""
panic-abort = "~0.2"
panic-semihosting = "~0.3"
microbit="~0.5"
cortex-m-rt="~0.6"
cortex-m-semihosting="~0.3"
panic-abort = "~0.3"
panic-semihosting = "~0.5"
microbit="~0.6"

18
src/microbit/examples/buttons.rs
View File

@@ -3,30 +3,16 @@
extern crate panic_abort;
extern crate cortex_m_rt as rt;
#[macro_use(entry, exception)]
extern crate microbit;
use core::fmt::Write;
use rt::ExceptionFrame;
use rt::entry;
use microbit::hal::prelude::*;
use microbit::hal::serial;
use microbit::hal::serial::BAUD115200;
exception!(HardFault, hard_fault);
fn hard_fault(ef: &ExceptionFrame) -> ! {
panic!("{:#?}", ef);
}
exception!(*, default_handler);
fn default_handler(irqn: i16) {
panic!("Unhandled exception (IRQn = {})", irqn);
}
entry!(main);
#[entry]
fn main() -> ! {
if let Some(p) = microbit::Peripherals::take() {
// Split GPIO

16
src/microbit/examples/buttons_poll.rs
View File

@@ -3,8 +3,6 @@
extern crate panic_abort;
extern crate cortex_m_rt as rt;
#[macro_use(entry, exception)]
extern crate microbit;
use core::fmt::Write;
@@ -15,19 +13,7 @@ use microbit::hal::delay::Delay;
use microbit::hal::serial;
use microbit::hal::serial::BAUD115200;
exception!(HardFault, hard_fault);
fn hard_fault(ef: &ExceptionFrame) -> ! {
panic!("{:#?}", ef);
}
exception!(*, default_handler);
fn default_handler(irqn: i16) {
panic!("Unhandled exception (IRQn = {})", irqn);
}
entry!(main);
#[entry]
fn main() -> ! {
if let Some(p) = microbit::Peripherals::take() {
// Split GPIO

18
src/microbit/examples/display_blocking.rs
View File

@@ -8,29 +8,15 @@ extern crate cortex_m_semihosting as sh;
extern crate panic_abort;
use core::fmt::Write;
use rt::ExceptionFrame;
use rt::entry;
use microbit::hal::delay::Delay;
use microbit::hal::prelude::*;
use microbit::hal::serial;
use microbit::hal::serial::BAUD115200;
use microbit::led;
exception!(HardFault, hard_fault);
fn hard_fault(ef: &ExceptionFrame) -> ! {
panic!("{:#?}", ef);
}
exception!(*, default_handler);
fn default_handler(irqn: i16) {
panic!("Unhandled exception (IRQn = {})", irqn);
}
entry!(main);
#[entry]
fn main() -> ! {
if let Some(p) = microbit::Peripherals::take() {
let mut gpio = p.GPIO.split();

8
src/serial/Cargo.toml
View File

@@ -4,7 +4,7 @@ version = "0.1.0"
[dependencies]
heapless="~0.3"
cortex-m-rt="~0.5"
cortex-m-semihosting=""
panic-semihosting = "~0.3"
microbit="~0.5"
cortex-m-rt="~0.6"
cortex-m-semihosting="~0.3"
panic-semihosting = "~0.5"
microbit="~0.6"

18
src/serial/examples/countdown.rs
View File

@@ -5,12 +5,10 @@ extern crate panic_semihosting;
extern crate cortex_m_rt as rt;
extern crate cortex_m_semihosting as sh;
extern crate heapless;
#[macro_use(entry, exception, block)]
extern crate microbit;
use core::fmt::Write;
use rt::ExceptionFrame;
use rt::entry;
use sh::hio;
use heapless::{consts, Vec, String};
@@ -19,19 +17,7 @@ use microbit::hal::delay::Delay;
use microbit::hal::serial;
use microbit::hal::serial::BAUD115200;
exception!(HardFault, hard_fault);
fn hard_fault(ef: &ExceptionFrame) -> ! {
panic!("{:#?}", ef);
}
exception!(*, default_handler);
fn default_handler(irqn: i16) {
panic!("Unhandled exception (IRQn = {})", irqn);
}
entry!(main);
#[entry]
fn main() -> ! {
let mut stdout = hio::hstdout().unwrap();
writeln!(stdout, "Start").unwrap();

18
src/serial/examples/display_echo.rs.disabled
View File

@@ -5,12 +5,10 @@ extern crate panic_semihosting;
extern crate cortex_m_rt as rt;
extern crate cortex_m_semihosting as sh;
extern crate heapless;
#[macro_use(entry, exception, block)]
extern crate microbit;
use core::fmt::Write;
use rt::ExceptionFrame;
use rt::entry;
use sh::hio;
use heapless::{consts, Vec, String};
@@ -19,19 +17,7 @@ use microbit::hal::delay::Delay;
use microbit::hal::serial;
use microbit::hal::serial::BAUD115200;
exception!(HardFault, hard_fault);
fn hard_fault(ef: &ExceptionFrame) -> ! {
panic!("{:#?}", ef);
}
exception!(*, default_handler);
fn default_handler(irqn: i16) {
panic!("Unhandled exception (IRQn = {})", irqn);
}
entry!(main);
#[entry]
fn main() -> ! {
let mut stdout = hio::hstdout().unwrap();
writeln!(stdout, "Start").unwrap();

18
src/serial/examples/quiz.rs
View File

@@ -4,12 +4,10 @@
extern crate panic_semihosting;
extern crate cortex_m_rt as rt;
extern crate cortex_m_semihosting as sh;
#[macro_use(entry, exception, block)]
extern crate microbit;
use core::fmt::Write;
use rt::ExceptionFrame;
use rt::entry;
use sh::hio;
use microbit::hal::delay::Delay;
@@ -18,18 +16,6 @@ use microbit::hal::serial;
use microbit::hal::serial::BAUD115200;
use microbit::led;
exception!(HardFault, hard_fault);
fn hard_fault(ef: &ExceptionFrame) -> ! {
panic!("{:#?}", ef);
}
exception!(*, default_handler);
fn default_handler(irqn: i16) {
panic!("Unhandled exception (IRQn = {})", irqn);
}
const WINNING_SCORE: u8 = 6;
const QUESTION_COUNT: u8 = 2*WINNING_SCORE - 1;
@@ -49,7 +35,7 @@ const LETTER_B: [[u8; 5]; 5] = [
[0, 1, 1, 0, 0],
];
entry!(main);
#[entry]
fn main() -> ! {
let mut stdout = hio::hstdout().unwrap();
writeln!(stdout, "Start").unwrap();

18
src/serial/examples/reverse.rs
View File

@@ -5,12 +5,10 @@ extern crate panic_semihosting;
extern crate cortex_m_rt as rt;
extern crate cortex_m_semihosting as sh;
extern crate heapless;
#[macro_use(entry, exception, block)]
extern crate microbit;
use core::fmt::Write;
use rt::ExceptionFrame;
use rt::entry;
use sh::hio;
use heapless::{consts, Vec};
@@ -19,19 +17,7 @@ use microbit::hal::delay::Delay;
use microbit::hal::serial;
use microbit::hal::serial::BAUD115200;
exception!(HardFault, hard_fault);
fn hard_fault(ef: &ExceptionFrame) -> ! {
panic!("{:#?}", ef);
}
exception!(*, default_handler);
fn default_handler(irqn: i16) {
panic!("Unhandled exception (IRQn = {})", irqn);
}
entry!(main);
#[entry]
fn main() -> ! {
let mut stdout = hio::hstdout().unwrap();
writeln!(stdout, "Start").unwrap();

19
src/serial/src/main.rs
View File

@@ -4,31 +4,18 @@
extern crate panic_semihosting;
extern crate cortex_m_rt as rt;
extern crate cortex_m_semihosting as sh;
#[macro_use(entry, exception, block)]
extern crate microbit;
use core::fmt::Write;
use rt::ExceptionFrame;
use rt::entry;
use sh::hio;
use microbit::hal::prelude::*;
use microbit::hal::serial;
use microbit::hal::serial::BAUD115200;
use microbit::nb::block;
exception!(HardFault, hard_fault);
fn hard_fault(ef: &ExceptionFrame) -> ! {
panic!("{:#?}", ef);
}
exception!(*, default_handler);
fn default_handler(irqn: i16) {
panic!("Unhandled exception (IRQn = {})", irqn);
}
entry!(main);
#[entry]
fn main() -> ! {
let mut stdout = hio::hstdout().unwrap();
writeln!(stdout, "Start").unwrap();