From 8320451f43500868696078f49b80b4064434a01f Mon Sep 17 00:00:00 2001
From: chrysn <chrysn@fsfe.org>
Date: Sun, 5 Jan 2025 20:45:36 +0100
Subject: [PATCH] spi: Add test program

---
 tests/spi/Cargo.toml | 15 +++++++++++
 tests/spi/Makefile   |  9 +++++++
 tests/spi/src/lib.rs | 64 ++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 88 insertions(+)
 create mode 100644 tests/spi/Cargo.toml
 create mode 100644 tests/spi/Makefile
 create mode 100644 tests/spi/src/lib.rs

diff --git a/tests/spi/Cargo.toml b/tests/spi/Cargo.toml
new file mode 100644
index 0000000..19550df
--- /dev/null
+++ b/tests/spi/Cargo.toml
@@ -0,0 +1,15 @@
+[package]
+name = "riot-wrappers-test-spi"
+version = "0.1.0"
+edition = "2021"
+publish = false
+
+[lib]
+crate-type = ["staticlib"]
+
+[profile.release]
+panic = "abort"
+
+[dependencies]
+riot-wrappers = { path = "../..", features = [ "set_panic_handler", "panic_handler_format" ] }
+embedded-hal = "1"
diff --git a/tests/spi/Makefile b/tests/spi/Makefile
new file mode 100644
index 0000000..b21be9e
--- /dev/null
+++ b/tests/spi/Makefile
@@ -0,0 +1,9 @@
+APPLICATION = riot-wrappers-test-spi
+APPLICATION_RUST_MODULE = riot_wrappers_test_spi
+BASELIBS += $(APPLICATION_RUST_MODULE).module
+FEATURES_REQUIRED += rust_target
+FEATURES_REQUIRED += periph_gpio
+FEATURES_REQUIRED += periph_spi
+USEMODULE += ztimer_usec
+
+include $(RIOTBASE)/Makefile.include
diff --git a/tests/spi/src/lib.rs b/tests/spi/src/lib.rs
new file mode 100644
index 0000000..df9ab25
--- /dev/null
+++ b/tests/spi/src/lib.rs
@@ -0,0 +1,64 @@
+//! This is a primitive SPI test.
+//!
+//! It performs different reads and writes in different modes. The precise results depend on
+//! the voltage on the MISO pin, which is usually indeterminate.
+#![no_std]
+
+use embedded_hal::spi::SpiDevice;
+
+use riot_wrappers::println;
+use riot_wrappers::riot_main;
+
+riot_main!(main);
+
+fn main() {
+    // SPI device and CS pin that the test may drive.
+    //
+    // Boards should only be added if the attached peripherals are safe to use, no matter what gets
+    // written there.
+    let (spi, cs) = match riot_wrappers::BOARD {
+        "particle-xenon" => (0, (0, 31)),
+        _ => panic!("No "),
+    };
+
+    let cs = riot_wrappers::gpio::GPIO::from_port_and_pin(cs.0, cs.1).unwrap();
+    let mut spi = riot_wrappers::spi::for_embedded_hal_1::SPIDevice::from_number_and_cs_pin(spi, cs).unwrap()
+        // arbitrary parameters
+        .with_speed_1mhz()
+        .with_mode(embedded_hal::spi::MODE_2);
+
+    println!("Plain transfer in place:");
+    let mut buf = [0, 0, 0x12, 0x34];
+    println!("Writing {:?}, …", buf);
+    let Ok(()) = spi.transfer_in_place(&mut buf);
+    println!("read {:?}.", buf);
+
+    println!("Write from flash:");
+    // Writing from flash makes a difference eg. on nrf52: That peripheral is DMA only and can not
+    // read flash.
+    let buf = [0, 0, 0x12, 0x34];
+    println!("Writing {:?}.", buf);
+    let Ok(()) = spi.write(&buf);
+
+    println!("Performing complex sequence:");
+    let writebuf = [0; 300];
+    let mut readbuf1 = [0x12, 0x34, 0x56, 0x78];
+    let mut readbuf2 = [0x12, 0x34, 0x56, 0x78];
+    use embedded_hal::spi::Operation;
+    let mut operations = [
+        Operation::Write(&writebuf),
+        Operation::DelayNs(123),
+        Operation::Read(&mut readbuf1),
+        Operation::Read(&mut readbuf2),
+    ];
+    let Ok(()) = spi.transaction(&mut operations);
+    println!("Wrote [0; 300], read into {:?} and {:?}", readbuf1, readbuf2);
+
+    println!("Plain transfer in place:");
+    let writebuf = [0, 0];
+    let mut readbuf = [0xff; 10];
+    let Ok(()) = spi.transfer(&mut readbuf, &writebuf);
+    println!("In mixed transfer, wrote [0; 2], and continued reading into {:?}.", readbuf);
+
+    println!("Tests done.");
+}