Merge pull request #2 from Neotron-Compute/more-apps

thejpster · web-flow · commit 4d8daf9af513 · 2023-06-10T23:13:30.000+01:00
Add a fancy panic handler, and some more samples.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -18,6 +18,10 @@ jobs:
       - name: Add targets
         run: |
           rustup target add thumbv6m-none-eabi
+          rustup target add thumbv7m-none-eabi
+          rustup target add thumbv7em-none-eabi
+          rustup component add llvm-tools
+          cargo install cargo-binutils
 
       - name: Build lib (native)
         run: |
@@ -27,10 +31,14 @@ jobs:
         run: |
           cargo test --verbose
 
-      - name: Build lib (Cortex-M0), OS mode
+      - name: Build samples (Cortex-M0)
         run: |
-          cargo build --verbose --target=thumbv6m-none-eabi --features=os
+          cd samples && ./build.sh thumbv6m-none-eabi
 
-      - name: Build samples (Cortex-M0)
+      - name: Build samples (Cortex-M3)
+        run: |
+          cd samples && ./build.sh thumbv7m-none-eabi
+
+      - name: Build samples (Cortex-M4)
         run: |
-          cd samples && cargo build --verbose --target=thumbv6m-none-eabi
+          cd samples && ./build.sh thumbv7em-none-eabi
diff --git a/Cargo.toml b/Cargo.toml
@@ -12,7 +12,5 @@ neotron-ffi = "0.1"
 neotron-api = "0.1"
 
 [features]
-# Enables functions the OS needs but an application does not
-os = []
-# Enables functions an application needs but the OS does not
-application = []
+# Prints panic info. Costs you about 14K of code.
+fancy-panic = []
diff --git a/samples/.gitignore b/samples/.gitignore
@@ -1 +1,2 @@
-target
+*.bin
+
diff --git a/samples/Cargo.toml b/samples/Cargo.toml
diff --git a/samples/README.md b/samples/README.md
@@ -8,7 +8,7 @@ Build the application as follows:
 
 ```console
 $ cargo build --release --target=thumbv6m-none-eabi
-$ cargo objcopy --release --target=thumbv6m-none-eabi --  -O binary hello.bin
+$ rust-objcopy -O binary ./target/thumbv6m-none-eabi/release/hello hello.bin
 ```
 
 Then copy the resulting `hello.bin` file to an SD card and insert it into your Neotron system. You can load the application with something like:
@@ -18,10 +18,10 @@ Then copy the resulting `hello.bin` file to an SD card and insert it into your N
 > run
 ```
 
-If you don't have `cargo-binutils` installed (which adds the `objcopy` sub-command), install it with:
+If you don't have `rust-objcopy` installed, install it with:
 
 ```console
-$ cargo install cargo-binutils
+$ rustup component add llvm-tools
 ```
 
 ## List of Sample Applications
@@ -30,3 +30,10 @@ $ cargo install cargo-binutils
 
 This is a basic "Hello World" application. It prints the string "Hello, world" to *standard output* and then exits with an exit code of 0.
 
+## [`panic`](./panic)
+
+This application panics, printing a nice panic message.
+
+## [`fault`](./fault)
+
+This application generates a Hard Fault.
diff --git a/samples/build.sh b/samples/build.sh
@@ -0,0 +1,11 @@
+#!/bin/bash
+
+set -euo pipefail
+
+TARGET=${1:-thumbv6m-none-eabi}
+
+echo "Building for ${TARGET}"
+for program in panic hello fault; do
+    ( cd ${program} && cargo build --target=${TARGET} --release )
+    rust-objcopy -O binary ./${program}/target/${TARGET}/release/${program} ${program}.bin
+done
diff --git a/samples/fault/.gitignore b/samples/fault/.gitignore
@@ -0,0 +1 @@
+target
diff --git a/samples/fault/Cargo.toml b/samples/fault/Cargo.toml
@@ -0,0 +1,18 @@
+[package]
+name = "fault"
+version = "0.1.0"
+edition = "2021"
+license = "MIT OR Apache-2.0"
+authors = ["Jonathan 'theJPster' Pallant <neotron@thejpster.org.uk>"]
+description = "Hello World for Neotron systems"
+
+[dependencies]
+neotron-sdk = { path = "../.." }
+
+[profile.dev]
+panic = "abort"
+
+[profile.release]
+panic = "unwind"
+opt-level = "z"
+lto = "fat"
diff --git a/samples/fault/README.md b/samples/fault/README.md
@@ -0,0 +1,19 @@
+# Fault
+
+A basic *faulting* application for Neotron systems. This program will jump to
+the address 0xDEADC0DE, which will cause a Hard Fault.
+
+See the general sample application [README](../README.md) for compilation instructions.
+
+## Licence
+
+Copyright (c) The Neotron Developers, 2023
+
+Licensed under either [MIT](../../LICENSE-MIT) or [Apache-2.0](../../LICENSE-APACHE) at
+your option.
+
+## Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you shall be licensed as above, without any
+additional terms or conditions.
diff --git a/samples/fault/build.rs b/samples/fault/build.rs
@@ -0,0 +1,21 @@
+use std::env;
+use std::fs::File;
+use std::io::Write;
+use std::path::PathBuf;
+
+fn main() {
+    // Put `neotron-cortex-m.ld` in our output directory and ensure it's
+    // on the linker search path.
+    let out = &PathBuf::from(env::var_os("OUT_DIR").unwrap());
+    File::create(out.join("neotron-cortex-m.ld"))
+        .unwrap()
+        .write_all(include_bytes!("../neotron-cortex-m.ld"))
+        .unwrap();
+    println!("cargo:rustc-link-search={}", out.display());
+
+    // By default, Cargo will re-run a build script whenever
+    // any file in the project changes. By specifying `neotron-cortex-m.ld`
+    // here, we ensure the build script is only re-run when
+    // `neotron-cortex-m.ld` is changed.
+    println!("cargo:rerun-if-changed=../neotron-cortex-m.ld");
+}
diff --git a/samples/fault/src/main.rs b/samples/fault/src/main.rs
@@ -0,0 +1,14 @@
+#![no_std]
+#![no_main]
+
+use core::fmt::Write;
+
+#[no_mangle]
+extern "C" fn neotron_main() -> i32 {
+    let stdout = neotron_sdk::stdout();
+    writeln!(&stdout, "About to fault...\n").unwrap();
+    let bad_address: u32 = 0xDEAD_C0DE;
+    let bad_fn: fn() = unsafe { core::mem::transmute(bad_address) };
+    bad_fn();
+    0
+}
diff --git a/samples/hello/.gitignore b/samples/hello/.gitignore
@@ -0,0 +1 @@
+target
diff --git a/samples/hello/Cargo.toml b/samples/hello/Cargo.toml
@@ -7,11 +7,12 @@ authors = ["Jonathan 'theJPster' Pallant <neotron@thejpster.org.uk>"]
 description = "Hello World for Neotron systems"
 
 [dependencies]
-neotron-sdk = { path = "../..", features = ["application"] }
-#
-# NB: This is in a workspace, so these settings are in the workspace file.
-#[profile.dev]
-#panic = "abort"
-#
-#[profile.release]
-#panic = "abort"
+neotron-sdk = { path = "../.." }
+
+[profile.dev]
+panic = "abort"
+
+[profile.release]
+panic = "unwind"
+opt-level = "z"
+lto = "fat"
diff --git a/samples/hello/build.rs b/samples/hello/build.rs
@@ -17,5 +17,5 @@ fn main() {
     // any file in the project changes. By specifying `neotron-cortex-m.ld`
     // here, we ensure the build script is only re-run when
     // `neotron-cortex-m.ld` is changed.
-    println!("cargo:rerun-if-changed=neotron-cortex-m.ld");
+    println!("cargo:rerun-if-changed=../neotron-cortex-m.ld");
 }
diff --git a/samples/hello/src/main.rs b/samples/hello/src/main.rs
@@ -6,14 +6,9 @@ extern crate neotron_sdk;
 #[no_mangle]
 extern "C" fn neotron_main() -> i32 {
     let stdout = neotron_sdk::stdout();
-    stdout.write(b"Hello, world\n").unwrap();
-    0
-}
-
-#[inline(never)]
-#[panic_handler]
-fn panic(_info: &core::panic::PanicInfo) -> ! {
-    loop {
-        // Spin
+    if stdout.write(b"Hello, world\n").is_ok() {
+        0
+    } else {
+        1
     }
 }
diff --git a/samples/panic/.gitignore b/samples/panic/.gitignore
@@ -0,0 +1 @@
+target
diff --git a/samples/panic/Cargo.toml b/samples/panic/Cargo.toml
@@ -0,0 +1,18 @@
+[package]
+name = "panic"
+version = "0.1.0"
+edition = "2021"
+license = "MIT OR Apache-2.0"
+authors = ["Jonathan 'theJPster' Pallant <neotron@thejpster.org.uk>"]
+description = "Hello World for Neotron systems"
+
+[dependencies]
+neotron-sdk = { path = "../..", features = ["fancy-panic"] }
+
+[profile.dev]
+panic = "abort"
+
+[profile.release]
+panic = "unwind"
+opt-level = "z"
+lto = "fat"
diff --git a/samples/panic/README.md b/samples/panic/README.md
@@ -0,0 +1,19 @@
+# Hello, World!
+
+A basic *panicking* application for Neotron systems. This program will cause a
+panic, and the panic handler will print to stdout.
+
+See the general sample application [README](../README.md) for compilation instructions.
+
+## Licence
+
+Copyright (c) The Neotron Developers, 2023
+
+Licensed under either [MIT](../../LICENSE-MIT) or [Apache-2.0](../../LICENSE-APACHE) at
+your option.
+
+## Contribution
+
+Unless you explicitly state otherwise, any contribution intentionally submitted
+for inclusion in the work by you shall be licensed as above, without any
+additional terms or conditions.
diff --git a/samples/panic/build.rs b/samples/panic/build.rs
@@ -0,0 +1,21 @@
+use std::env;
+use std::fs::File;
+use std::io::Write;
+use std::path::PathBuf;
+
+fn main() {
+    // Put `neotron-cortex-m.ld` in our output directory and ensure it's
+    // on the linker search path.
+    let out = &PathBuf::from(env::var_os("OUT_DIR").unwrap());
+    File::create(out.join("neotron-cortex-m.ld"))
+        .unwrap()
+        .write_all(include_bytes!("../neotron-cortex-m.ld"))
+        .unwrap();
+    println!("cargo:rustc-link-search={}", out.display());
+
+    // By default, Cargo will re-run a build script whenever
+    // any file in the project changes. By specifying `neotron-cortex-m.ld`
+    // here, we ensure the build script is only re-run when
+    // `neotron-cortex-m.ld` is changed.
+    println!("cargo:rerun-if-changed=../neotron-cortex-m.ld");
+}
diff --git a/samples/panic/src/main.rs b/samples/panic/src/main.rs
@@ -0,0 +1,11 @@
+#![no_std]
+#![no_main]
+
+use core::fmt::Write;
+
+#[no_mangle]
+extern "C" fn neotron_main() -> i32 {
+    let stdout = neotron_sdk::stdout();
+    writeln!(&stdout, "About to panic...\n").unwrap();
+    panic!("Oh no, I panicked!");
+}
diff --git a/src/lib.rs b/src/lib.rs
@@ -209,6 +209,18 @@ impl core::ops::Drop for File {
     }
 }
 
+impl core::fmt::Write for File {
+    fn write_str(&mut self, s: &str) -> core::fmt::Result {
+        self.write(s.as_bytes()).map_err(|_| core::fmt::Error)
+    }
+}
+
+impl core::fmt::Write for &File {
+    fn write_str(&mut self, s: &str) -> core::fmt::Result {
+        self.write(s.as_bytes()).map_err(|_| core::fmt::Error)
+    }
+}
+
 /// Represents an open directory that we are iterating through.
 pub struct ReadDir(api::dir::Handle);
 
@@ -310,6 +322,26 @@ fn get_api() -> &'static Api {
     unsafe { ptr.as_ref().unwrap() }
 }
 
+#[cfg(all(feature = "fancy-panic", not(test)))]
+#[inline(never)]
+#[panic_handler]
+fn panic(info: &core::panic::PanicInfo) -> ! {
+    use core::fmt::Write;
+    let stdout = stdout();
+    let _ = writeln!(&stdout, "Panic:\n{:#?}", info);
+    loop {}
+}
+
+#[cfg(all(not(feature = "fancy-panic"), not(test)))]
+#[inline(never)]
+#[panic_handler]
+fn panic(_info: &core::panic::PanicInfo) -> ! {
+    use core::fmt::Write;
+    let stdout = stdout();
+    let _ = writeln!(&stdout, "Panic!");
+    loop {}
+}
+
 // ============================================================================
 // End of File
 // ============================================================================
