From e1b0d83cbd124f794c4ac925f3e793e91224eb4e Mon Sep 17 00:00:00 2001
From: bunnie <bunnie@kosagi.com>
Date: Sat, 2 Mar 2024 01:08:59 +0800
Subject: [PATCH] add test plan

---
 libs/xous-bio/src/bio_tests/mod.rs | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)

diff --git a/libs/xous-bio/src/bio_tests/mod.rs b/libs/xous-bio/src/bio_tests/mod.rs
index 9eccb7c2b..81ac763ab 100644
--- a/libs/xous-bio/src/bio_tests/mod.rs
+++ b/libs/xous-bio/src/bio_tests/mod.rs
@@ -81,3 +81,25 @@ pub fn bio_tests() {
     units::hello_world();
     units::hello_multiverse();
 }
+
+// Test plan:
+// Unit tests:
+//   - Basic FIFO stall test. Two cores writing to each other to unlock.
+//   - Host FIFO stall on empty test. Core stalls until host provides data.
+//   - Host FIFO stall on full test. Core stall until host reads data.
+//   - GPIO input path test
+//   - GPIO direction control test
+//   - FIFO level trigger test - eq, gt, lt on various channels, at various fullness levels
+//   - Stall on event - register bit test, between cores
+//   - Stall on event - register bit test, to host
+//   - Stall on event - FIFO level test
+//   - Host IRQ generation test - some combination with event tests above to confirm IRQ generation
+//   - Core ID read test
+//   - Core aclk counter test
+// Application tests:
+//   - SPI loopback test
+//   - I2C loopback test
+//   - IR controller test
+//   - Arithmetic test, utilizing load/store on core 0
+//   - Arithmetic test, without store, cores 1-3
+//   - DMA transfer test -- might have to wait until full-chip integration to get MDMA core?