Merge pull request #17 from ferrous-systems/windows-fixes

Windows fixes

Author: jonathanpallant

qemu-cortex-r5-app/.cargo/config.toml

@@ -7,7 +7,10 @@ rustflags = [
     "-Clink-arg=-Tdefmt.x",
     "-Ctarget-cpu=cortex-r5",
 ]
-runner = "./qemu_run.sh"
+runner = "./qemu_run.cmd"
 
 [build]
 target = ["armv7r-none-eabihf"]
+
+[env]
+DEFMT_LOG = "debug"

qemu-cortex-r5-app/README.md

@@ -7,47 +7,75 @@ This application is for the Arm Versatile Application Board, which includes an
 Arm Cortex-R5 processor. This board was chosen because it can be emulated by
 QEMU.
 
-To build and run this project, simply run:
+## Pre-requisites
+
+To build this demo you must:
+
+1. Run `git submodule update --init` to check-out the ThreadX source code
+2. Install `defmt-print` with `cargo install defmt-print`
+3. Install `qemu-system-arm` - see [the QEMU website](https://www.qemu.org/download/) or via `winget install --id=SoftwareFreedomConservancy.QEMU`
+4. Install `arm-none-eabi-gcc` - such as from the [Arm GNU Toolchain](https://developer.arm.com/Tools%20and%20Software/GNU%20Toolchain) or via `winget install gcc-arm-embedded`
+5. Install `libclang`, as specified in [the `bindgen` documentation](https://rust-lang.github.io/rust-bindgen/requirements.html) or via `winget install LLVM.LLVM`
+6. Add the `armv7r-none-eabihf` target with `rustup target add armv7r-none-eabih`:
+
+  ```bash
+  rustup target add armv7r-none-eabihf --toolchain=stable
+  ```
+
+This demo was tested on Ferrocene 25.05 and Rust 1.89. It may work with earlier versions.
+
+## Building
+
+Once you have the pre-requisites, to build and run this project, simply run:
 
 ```bash
-cargo run
+cargo run --release
 ```
 
 You must have `qemu-system-arm` in your system's PATH. You will also need
 `arm-none-eabi-gcc` in your system's PATH, so this project can automatically
 compile ThreadX (which is expected in `../threadx`). Our runner also requires `defmt-print`.
 
+If you have Ferrocene available, you can also do:
+
+```bash
+criticalup install
+criticalup run cargo run --release
+```
+
 You will see something like:
 
 ```console
-$ DEFMT_LOG=info cargo run
-   Compiling defmt-macros v1.0.1
-   Compiling defmt v1.0.1
-   Compiling defmt v0.3.100
-   Compiling defmt-semihosting v0.3.0
-   Compiling cortex-ar v0.2.0
-   Compiling qemu-cortex-r5-app v0.1.0 (threadx-experiments/qemu-cortex-r5-app)
-    Finished `dev` profile [unoptimized + debuginfo] target(s) in 1.17s
-     Running `threadx-experiments/qemu-cortex-r5-app/./qemu_run.sh target/armv7r-none-eabihf/debug/qemu-cortex-r5-app`
-ELF_BINARY=target/armv7r-none-eabihf/debug/qemu-cortex-r5-app
+$ cargo run --release
+    Finished `release` profile [optimized + debuginfo] target(s) in 0.3s
+     Running `threadx-experiments/qemu-cortex-r5-app/./qemu_run.cmd target/armv7r-none-eabihf/release/qemu-cortex-r5-app`
+ELF_BINARY=target/armv7r-none-eabihf/release/qemu-cortex-r5-app
 Running on '-cpu cortex-r5f -machine versatileab'...
 ------------------------------------------------------------------------
 [INFO ] Hello, this is version unknown! (src/main.rs:156)
 [INFO ] In tx_application_define()... (src/main.rs:27)
+[DEBUG] Stack allocated @ 0x000074f8 (src/main.rs:60)
+[DEBUG] Thread spawned (entry=12345678) @ 0x000134f4 (src/main.rs:86)
+[DEBUG] Stack allocated @ 0x0000b500 (src/main.rs:103)
+[DEBUG] Thread spawned (entry=aabbccdd) @ 0x000135ac (src/main.rs:129)
 [INFO ] I am my_thread(12345678) (src/main.rs:138)
 [INFO ] I am my_thread(aabbccdd) (src/main.rs:138)
 [INFO ] I am my_thread(12345678), count = 1 (src/main.rs:147)
 [INFO ] I am my_thread(aabbccdd), count = 1 (src/main.rs:147)
 [INFO ] I am my_thread(12345678), count = 2 (src/main.rs:147)
 [INFO ] I am my_thread(aabbccdd), count = 2 (src/main.rs:147)
+^Cqemu-system-arm: terminating on signal 2 from pid 56574 (<unknown process>)
+------------------------------------------------------------------------
 ```
 
-Press `Ctrl-C` to quit QEMU.
+Press `Ctrl-C` to quit QEMU, or if that doesn't work, try `Ctrl+A, X`.
 
 Console output appears through `defmt` which is transported over QEMU's
 semihosting interface into `defmt-print` on the host.
 
-If you wish to debug the program, run:
+## Debugging
+
+If you wish to debug the program, add `-- -s -S` to the `cargo run` command, like:
 
 ```bash
 cargo run -- -s -S

qemu-cortex-r5-app/build.rs

@@ -220,11 +220,22 @@ fn main() -> Result<(), Box<dyn Error>> {
     println!("cargo:rustc-link-search={}", out_dir.display());
     println!("cargo:rerun-if-changed=linker.ld");
 
-    // Build our ThreadX static library
+    // Set up common paths
     let tx_common_dir = crate_dir.join("../threadx/common/src");
     let tx_common_inc = crate_dir.join("../threadx/common/inc");
     let tx_port_dir = crate_dir.join("../threadx/ports/cortex_r5/gnu/src");
     let tx_port_inc = crate_dir.join("../threadx/ports/cortex_r5/gnu/inc");
+
+    // Check for ThreadX source code
+    for file in TX_PORT_FILES.iter().map(|&s| tx_port_dir.join(s)) {
+        if !std::fs::exists(&file)? {
+            eprintln!("Cannot find ThreadX file {}!", file.display());
+            eprintln!("Did you run `git submodule update --init`?");
+            panic!("Missing ThreadX source code");
+        }
+    }
+
+    // Build our ThreadX static library
     cc::Build::new()
         .include(&tx_common_inc)
         .include(&tx_port_inc)

qemu-cortex-r5-app/qemu_run.bat

@@ -0,0 +1,15 @@
+@echo off
+
+rem SPDX-FileCopyrightText: Copyright (c) 2025 Ferrous Systems
+rem SPDX-License-Identifier: CC0-1.0
+
+rem This requires you to previously run `cargo install defmt-print`
+
+set ELF_BINARY=%1
+set MACHINE=-cpu cortex-r5f -machine versatileab
+set QEMU_PATH=%ProgramFiles%\qemu
+echo ELF_BINARY=%ELF_BINARY%
+echo Running on '%MACHINE%'...
+echo ------------------------------------------------------------------------
+"%QEMU_PATH%\qemu-system-arm" %MACHINE% -semihosting-config enable=on -nographic -kernel %* | defmt-print -e %ELF_BINARY% --log-format="{[{L}]%%bold} {s} {({ff}:{l:1})%%dimmed}"
+echo ------------------------------------------------------------------------

qemu-cortex-r5-app/qemu_run.cmd

@@ -0,0 +1,11 @@
+: # This is a special script which intermixes both sh
+: # and cmd code. It is written this way because it is
+: # set as the cargo runner and needs to work on Windows
+: # and POSIX platforms. See https://stackoverflow.com/questions/17510688
+: # for details.
+: #
+: # SPDX-FileCopyrightText: Copyright (c) 2025 Ferrous Systems
+: # SPDX-License-Identifier: CC0-1.0
+:; ./qemu_run.sh $* ; exit
+@ECHO OFF
+call qemu_run.bat %*

qemu-cortex-r5-app/qemu_run.sh

@@ -12,5 +12,5 @@ LOG_FORMAT='{[{L}]%bold} {s} {({ff}:{l:1})%dimmed}'
 echo "ELF_BINARY=$ELF_BINARY"
 echo "Running on '$MACHINE'..."
 echo "------------------------------------------------------------------------"
-qemu-system-arm $MACHINE -semihosting-config enable=on,target=native -kernel $ELF_BINARY $* | defmt-print -e $ELF_BINARY --log-format="$LOG_FORMAT"
+qemu-system-arm $MACHINE -semihosting-config enable=on,target=native -nographic -kernel $ELF_BINARY $* | defmt-print -e $ELF_BINARY --log-format="$LOG_FORMAT"
 echo "------------------------------------------------------------------------"

qemu-cortex-r5-app/src/main.rs

@@ -127,24 +127,28 @@ extern "C" fn tx_application_define(_first_unused_memory: *mut core::ffi::c_void
         }
     };
     defmt::debug!(
-        "Thread spawned (entry={:08x}) @ 0x{=usize:08x}",
+        "Thread spawned entry={=u32:08x} @ 0x{=usize:08x}",
         entry,
         thread1 as *const _ as usize
     );
 }
 
 /// A function we execute in its own thread.
 extern "C" fn my_thread(value: u32) {
-    defmt::info!("I am my_thread({:08x})", value);
-    let mut thread_counter = 0;
+    defmt::info!("I am my_thread({=u32:08x})", value);
+    let mut thread_counter: u64 = 0;
     loop {
         thread_counter += 1;
 
         unsafe {
             threadx_sys::_tx_thread_sleep(100);
         }
 
-        defmt::info!("I am my_thread({:08x}), count = {}", value, thread_counter);
+        defmt::info!(
+            "I am my_thread({=u32:08x}), count = {=u64}",
+            value,
+            thread_counter
+        );
     }
 }