libtock-rs: Sync with upstream to Merge #365

The only major change from upstream that this preserves is customized
external assembly linkage. This should be mostly removed once libtock
switches to using `global_asm!` - now that that will be stabilized.

This CL is a squash merge of the following commits:

28ebb70 Merge #365
a0440ba Merge #370
abff51c Merge #359
85242dc Merge #364
f1bd0d4 Merge #361
b0f8593 Merge #355
4c7ecb6 Merge #358
6f8b512 Merge #356
73cbbde Merge #357
022984f Merge #353
b2e6471 Merge #352
9eb12c0 Merge #351

This was retrieved with the following command:
```
git log ti50-internal/upstream/master --not \
  $(git merge-base --all ti50-internal/upstream/master m/main) \
  --first-parent
```

BUG=None
TEST=ti50/common make build
SOURCE=UPSTREAM(28ebb70)

Change-Id: I0aa1606f407a0b4bcf0c76b62261414903479092

Author: kupiakos

.cargo/config

@@ -12,4 +12,4 @@ rustflags = [
     "-C", "relocation-model=static",
     "-C", "link-arg=-Tlayout.ld",
 ]
-runner = "./tools/flash.sh"
+runner = ["cargo", "run", "-p", "runner", "--release"]

.github/workflows/ci.yml

@@ -43,7 +43,7 @@ jobs:
       - name: Build and Test
         run: |
           sudo apt-get install binutils-arm-none-eabi \
-            binutils-riscv64-unknown-elf
+            binutils-riscv64-unknown-elf ninja-build
           cd "${GITHUB_WORKSPACE}"
           echo "[target.'cfg(all())']" >> .cargo/config
           echo 'rustflags = ["-D", "warnings"]' >> .cargo/config

Cargo.toml

@@ -82,14 +82,16 @@ lto = true
 debug = true
 
 [workspace]
-exclude = [ "tock" ]
+exclude = ["tock", "tock2"]
 members = [
+    "apis/leds",
     "apis/low_level_debug",
     "codegen",
     "core",
     "libtock2",
     "panic_handlers/small_panic",
     "platform",
+    "runner",
     "runtime",
     "syscalls_tests",
     "test_runner",

Makefile

@@ -11,6 +11,7 @@ usage:
 	@echo "libtock-rs currently includes support for the following platforms:"
 	@echo " - hail"
 	@echo " - nrf52840"
+	@echo " - microbit_v2"
 	@echo " - nucleo_f429zi"
 	@echo " - nucleo_f446re"
 	@echo " - opentitan"
@@ -25,6 +26,7 @@ usage:
 	@echo "    Set the DEBUG flag to enable the debug build"
 	@echo "    Set the FEATURES flag to enable features"
 	@echo "Run 'make flash-<board> EXAMPLE=<>' to flash EXAMPLE to that board"
+	@echo "Run 'make qemu-example EXAMPLE=<>' to run EXAMPLE in QEMU"
 	@echo "Run 'make test' to test any local changes you have made"
 	@echo "Run 'make print-sizes' to print size data for the example binaries"
 
@@ -37,8 +39,8 @@ release=--release
 endif
 
 .PHONY: setup
-setup: setup-qemu
-	cargo install elf2tab --version 0.6.0
+setup: setup-qemu setup-qemu-2
+	cargo install elf2tab
 	cargo install stack-sizes
 	cargo miri setup
 
@@ -48,6 +50,12 @@ setup: setup-qemu
 setup-qemu:
 	CI=true $(MAKE) -C tock ci-setup-qemu
 
+# Sets up QEMU in the tock2/ directory. We use Tock's QEMU which may contain
+# patches to better support boards that Tock supports.
+.PHONY: setup-qemu-2
+setup-qemu-2:
+	CI=true $(MAKE) -C tock2 ci-setup-qemu
+
 # Builds a Tock kernel for the HiFive board for use by QEMU tests.
 .PHONY: kernel-hifive
 kernel-hifive:
@@ -62,11 +70,25 @@ kernel-hifive-2:
 	$(MAKE) -C tock2/boards/hifive1 \
 		$(CURDIR)/tock2/target/riscv32imac-unknown-none-elf/release/hifive1.elf
 
+# Builds a Tock kernel for the OpenTitan board on the cw310 FPGA for use by QEMU
+# tests.
+.PHONY: kernel-opentitan
+kernel-opentitan:
+	CARGO_TARGET_RISCV32IMC_UNKNOWN_NONE_ELF_RUNNER="[]" \
+		$(MAKE) -C tock2/boards/opentitan/earlgrey-cw310 \
+		$(CURDIR)/tock2/target/riscv32imc-unknown-none-elf/release/earlgrey-cw310.elf
+
 # Prints out the sizes of the example binaries.
 .PHONY: print-sizes
 print-sizes: examples
 	cargo run --release -p print_sizes
 
+# Runs a libtock2 example in QEMU on a simulated HiFive board.
+.PHONY: qemu-example
+qemu-example: kernel-hifive-2
+	LIBTOCK_PLATFORM="hifive1" cargo run --example "$(EXAMPLE)" -p libtock2 \
+		--release --target=riscv32imac-unknown-none-elf -- --deploy qemu
+
 # Runs the libtock_test tests in QEMU on a simulated HiFive board.
 .PHONY: test-qemu-hifive
 test-qemu-hifive: kernel-hifive
@@ -99,7 +121,7 @@ EXCLUDE_MIRI := $(EXCLUDE_RUNTIME) --exclude libtock_codegen \
 # Arguments to pass to cargo to exclude `std` and crates that depend on it. Used
 # when we build a crate for an embedded target, as those targets lack `std`.
 EXCLUDE_STD := --exclude libtock_unittest --exclude print_sizes \
-               --exclude syscalls_tests --exclude test_runner
+               --exclude runner --exclude syscalls_tests --exclude test_runner
 
 # Some of our crates should build with a stable toolchain. This verifies those
 # crates don't depend on unstable features by using cargo check. We specify a
@@ -111,7 +133,7 @@ test-stable:
 		$(EXCLUDE_RUNTIME) --exclude libtock --exclude libtock_core
 
 .PHONY: test
-test: examples test-qemu-hifive test-stable
+test: examples test-stable
 	PLATFORM=nrf52 cargo test $(EXCLUDE_RUNTIME) --workspace
 	# TODO: When we have a working embedded test harness, change the libtock2
 	# builds to --all-targets rather than --examples.
@@ -153,6 +175,14 @@ hail:
 flash-hail:
 	PLATFORM=hail cargo run $(release) --target=thumbv7em-none-eabi --example $(EXAMPLE) $(features)
 
+.PHONY: microbit_v2
+microbit_v2:
+	PLATFORM=microbit_v2 cargo build $(release) --target=thumbv7em-none-eabi --examples $(features)
+
+.PHONY: flash-microbit_v2
+flash-microbit_v2:
+	PLATFORM=microbit_v2 cargo run $(release) --target=thumbv7em-none-eabi --example $(EXAMPLE) $(features)
+
 .PHONY: nucleo_f429zi
 nucleo_f429zi:
 	PLATFORM=nucleo_f429zi cargo build $(release) --target=thumbv7em-none-eabi --examples $(features)
@@ -229,3 +259,4 @@ flash-msp432:
 clean:
 	cargo clean
 	$(MAKE) -C tock clean
+	$(MAKE) -C tock2 clean

apis/leds/Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "libtock_leds"
+version = "0.1.0"
+authors = ["Tock Project Developers <[email protected]>"]
+license = "MIT/Apache-2.0"
+edition = "2018"
+repository = "https://www.github.com/tock/libtock-rs"
+description = "libtock leds driver"
+
+[dependencies]
+libtock_platform = { path = "../../platform" }
+
+[dev-dependencies]
+libtock_unittest = { path = "../../unittest" }

apis/leds/src/lib.rs

@@ -0,0 +1,48 @@
+#![no_std]
+
+use libtock_platform::{ErrorCode, Syscalls};
+
+/// The LEDs driver
+///
+/// # Example
+/// ```ignore
+/// use libtock2::Leds;
+///
+/// // Turn on led 0
+/// let _ = Leds::on(0);
+/// ```
+pub struct Leds<S: Syscalls>(S);
+
+impl<S: Syscalls> Leds<S> {
+    /// Run a check against the leds capsule to ensure it is present.
+    ///
+    /// Returns `Ok(number_of_leds)` if the driver was present. This does not necessarily mean
+    /// that the driver is working, as it may still fail to allocate grant
+    /// memory.
+    pub fn count() -> Result<u32, ErrorCode> {
+        S::command(DRIVER_ID, LEDS_COUNT, 0, 0).to_result()
+    }
+
+    pub fn on(led: u32) -> Result<(), ErrorCode> {
+        S::command(DRIVER_ID, LED_ON, led, 0).to_result()
+    }
+
+    pub fn off(led: u32) -> Result<(), ErrorCode> {
+        S::command(DRIVER_ID, LED_OFF, led, 0).to_result()
+    }
+
+    pub fn toggle(led: u32) -> Result<(), ErrorCode> {
+        S::command(DRIVER_ID, LED_TOGGLE, led, 0).to_result()
+    }
+}
+
+const DRIVER_ID: u32 = 2;
+
+// Command IDs
+const LEDS_COUNT: u32 = 0;
+const LED_ON: u32 = 1;
+const LED_OFF: u32 = 2;
+const LED_TOGGLE: u32 = 3;
+
+#[cfg(test)]
+mod tests;

apis/leds/src/tests.rs

@@ -0,0 +1,86 @@
+use libtock_platform::ErrorCode;
+use libtock_unittest::fake;
+
+type Leds = super::Leds<fake::Syscalls>;
+
+#[test]
+fn no_driver() {
+    let _kernel = fake::Kernel::new();
+    assert_eq!(Leds::count(), Err(ErrorCode::NoDevice));
+}
+
+#[test]
+fn driver_check() {
+    let kernel = fake::Kernel::new();
+    let driver = fake::Leds::<10>::new();
+    kernel.add_driver(&driver);
+
+    assert_eq!(Leds::count(), Ok(10));
+    for led in 0..10 {
+        assert_eq!(driver.get_led(led), Some(false));
+    }
+}
+
+#[test]
+fn num_leds() {
+    let kernel = fake::Kernel::new();
+    let driver = fake::Leds::<10>::new();
+    kernel.add_driver(&driver);
+    assert_eq!(Leds::count().unwrap_or_default(), 10);
+}
+
+#[test]
+fn on() {
+    let kernel = fake::Kernel::new();
+    let driver = fake::Leds::<10>::new();
+    kernel.add_driver(&driver);
+
+    assert_eq!(Leds::on(0), Ok(()));
+    assert_eq!(driver.get_led(0), Some(true));
+}
+
+#[test]
+fn off() {
+    let kernel = fake::Kernel::new();
+    let driver = fake::Leds::<10>::new();
+    kernel.add_driver(&driver);
+
+    assert_eq!(Leds::off(0), Ok(()));
+    assert_eq!(driver.get_led(0), Some(false));
+}
+
+#[test]
+fn toggle() {
+    let kernel = fake::Kernel::new();
+    let driver = fake::Leds::<10>::new();
+    kernel.add_driver(&driver);
+
+    assert_eq!(Leds::toggle(0), Ok(()));
+    assert_eq!(driver.get_led(0), Some(true));
+    assert_eq!(Leds::toggle(0), Ok(()));
+    assert_eq!(driver.get_led(0), Some(false));
+}
+
+#[test]
+fn on_off() {
+    let kernel = fake::Kernel::new();
+    let driver = fake::Leds::<10>::new();
+    kernel.add_driver(&driver);
+
+    assert_eq!(Leds::on(0), Ok(()));
+    assert_eq!(driver.get_led(0), Some(true));
+    assert_eq!(Leds::off(0), Ok(()));
+    assert_eq!(driver.get_led(0), Some(false));
+}
+
+#[test]
+fn no_led() {
+    let kernel = fake::Kernel::new();
+    let driver = fake::Leds::<10>::new();
+    kernel.add_driver(&driver);
+
+    assert_eq!(Leds::on(11), Err(ErrorCode::Invalid));
+    for led in 0..Leds::count().unwrap_or_default() {
+        assert_eq!(driver.get_led(led), Some(false));
+    }
+}