Add MatrixHardware trait with mock tests

bootloader/src/main.rs

@@ -2,6 +2,7 @@
 #![no_main]
 use cortex_m::asm;
 use cortex_m_rt::entry;
+#[cfg(not(test))]
 use panic_halt as _;
 use stm32h7::stm32h723;
 
@@ -23,5 +24,7 @@ fn main() -> ! {
     }
 
     // Stay in bootloader (update mode)
-    loop {}
+    loop {
+        cortex_m::asm::wfi();
+    }
 }

core/src/lib.rs

@@ -10,9 +10,16 @@ extern crate std;
 pub type KeyState = u64;
 
 pub mod debounce;
-pub use debounce::{Debouncer, MaskDebounce, NoDebounce, TimeDebounce};
-#[cfg(any(feature = "no-debounce", feature = "time-debounce", feature = "mask-debounce"))]
+#[cfg(any(
+    feature = "no-debounce",
+    feature = "time-debounce",
+    feature = "mask-debounce"
+))]
 pub use debounce::ActiveDebouncer;
+pub use debounce::{Debouncer, MaskDebounce, NoDebounce, TimeDebounce};
+
+pub mod traits;
+pub use traits::MatrixHardware;
 
 /// Abstraction over the hardware keyboard interface.  This trait is
 /// implemented by the STM32 firmware as well as the Linux simulator.

core/src/logic.rs

@@ -6,6 +6,7 @@ const NUM_KEYS: usize = NUM_ROWS * NUM_COLS;
 const DEBOUNCE_BITS: u8 = 5;
 const MASK: u16 = (1 << DEBOUNCE_BITS) - 1;
 
+#[derive(Default)]
 pub struct KeyboardLogic {
     history: [u16; NUM_KEYS],
     stable: KeyState,

core/src/traits.rs

@@ -0,0 +1,3 @@
+pub trait MatrixHardware {
+    fn read_row(&self, row: usize) -> u16;
+}

core/tests/mock_matrix.rs

@@ -0,0 +1,11 @@
+use keyboard_core::MatrixHardware;
+
+pub struct MockMatrix {
+    pub rows: Vec<u16>,
+}
+
+impl MatrixHardware for MockMatrix {
+    fn read_row(&self, row: usize) -> u16 {
+        self.rows[row]
+    }
+}

core/tests/test_matrix.rs

@@ -0,0 +1,12 @@
+use keyboard_core::MatrixHardware;
+mod mock_matrix;
+use mock_matrix::MockMatrix;
+
+#[test]
+fn read_row_returns_correct_value() {
+    let mock = MockMatrix {
+        rows: vec![0b1100u16, 0b0011u16],
+    };
+    assert_eq!(mock.read_row(0), 0b1100u16);
+    assert_eq!(mock.read_row(1), 0b0011u16);
+}

firmware/src/main.rs

@@ -3,6 +3,7 @@
 use cortex_m::peripheral::{Peripherals, SYST};
 use cortex_m_rt::entry;
 use keyboard_core::{self as core, KeyEventHandler, KeyboardHW, Timer};
+#[cfg(not(test))]
 use panic_halt as _;
 use stm32h7::stm32h723;
 
@@ -20,7 +21,6 @@ impl Stm32Keyboard {
 
 struct SysTimer {
     syst: SYST,
-    start: u64,
 }
 
 struct EventSink;
@@ -67,9 +67,11 @@ fn main() -> ! {
     syst.set_reload(SYSCLK_HZ / 1000);
     syst.clear_current();
     syst.enable_counter();
-    let timer = SysTimer { syst, start: 0 };
+    let timer = SysTimer { syst };
     let mut events = EventSink;
 
     core::run(&mut hw, &timer, &mut events);
-    loop {}
+    loop {
+        cortex_m::asm::nop();
+    }
 }

simulator/src/main.rs

@@ -3,7 +3,7 @@ mod input_scenario;
 
 use sim_hal::{SimKeyboard, SimTimer};
 use input_scenario::example_scenario;
-use keyboard_core::{KeyboardHW, Timer};
+use keyboard_core::KeyboardHW;
 
 fn scan_and_process(hw: &mut impl KeyboardHW, time: u64) {
     let keys = hw.read_keys();

simulator/src/sim_hal.rs

@@ -3,16 +3,14 @@ use keyboard_core::{KeyboardHW, Timer};
 pub struct SimKeyboard {
     pub keys: u64,
     pub active_row: Option<usize>,
-    pub num_rows: usize,
     pub num_cols: usize,
 }
 
 impl SimKeyboard {
-    pub fn new(rows: usize, cols: usize) -> Self {
+    pub fn new(_rows: usize, cols: usize) -> Self {
         SimKeyboard {
             keys: 0,
             active_row: None,
-            num_rows: rows,
             num_cols: cols,
         }
     }