Merge pull request #5 from Neotron-Compute/new-input-sample

Adds new input test sample program.

Author: jonathanpallant

samples/README.md

@@ -8,13 +8,13 @@ Build the application as follows:
 
 ```console
 $ cargo build --release --target=thumbv6m-none-eabi
-$ rust-objcopy -O binary ./target/thumbv6m-none-eabi/release/hello hello.bin
+$ cp ./target/thumbv6m-none-eabi/release/hello /my/sdcard/hello.elf
 ```
 
-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:
+Then copy the resulting `hello.elf` file to an SD card and insert it into your Neotron system. You can load the application with something like:
 
 ```text
-> load hello.bin
+> load hello.elf
 > run
 ```
 
@@ -30,6 +30,10 @@ $ rustup component add llvm-tools
 
 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.
 
+## [`input-test`](./input-test)
+
+This reports any bytes received on Standard Input. Press Ctrl-X to quit.
+
 ## [`panic`](./panic)
 
 This application panics, printing a nice panic message.

samples/input_test/.gitignore

@@ -0,0 +1 @@
+target

samples/input_test/Cargo.toml

@@ -0,0 +1,18 @@
+[package]
+name = "input-test"
+version = "0.1.0"
+edition = "2021"
+license = "MIT OR Apache-2.0"
+authors = ["Jonathan 'theJPster' Pallant <[email protected]>"]
+description = "Hello World for Neotron systems"
+
+[dependencies]
+neotron-sdk = { path = "../.." }
+
+[profile.dev]
+panic = "abort"
+
+[profile.release]
+panic = "unwind"
+opt-level = "z"
+lto = "fat"

samples/input_test/README.md

@@ -0,0 +1,18 @@
+# Hello, World!
+
+A basic standard input test application for Neotron systems.
+
+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.

samples/input_test/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");
+}

samples/input_test/src/main.rs

@@ -0,0 +1,32 @@
+#![no_std]
+#![no_main]
+
+extern crate neotron_sdk;
+
+use core::fmt::Write;
+
+#[no_mangle]
+extern "C" fn neotron_main() -> i32 {
+    let mut stdout = neotron_sdk::stdout();
+    let stdin = neotron_sdk::stdin();
+    let _ = stdout.write(b"Type some things, press Ctrl-X to quit...\n");
+    loop {
+        let mut buffer = [0u8; 16];
+        match stdin.read(&mut buffer) {
+            Err(_) => {
+                return 1;
+            }
+            Ok(0) => {
+                // Do nothing
+            }
+            Ok(n) => {
+                for b in &buffer[0..n] {
+                    let _ = writeln!(stdout, "0x{:02x}", b);
+                    if *b == 0x18 {
+                        return 0;
+                    }
+                }
+            }
+        }
+    }
+}