Add encoder abstraction. (#21548)

1 files changed, 74 insertions, 17 deletions

diff --git a/quantum/encoder/tests/encoder_tests_split_left_eq_right.cpp b/quantum/encoder/tests/encoder_tests_split_left_eq_right.cpp
index 916e47b185..7d6b3e30e6 100644
--- a/quantum/encoder/tests/encoder_tests_split_left_eq_right.cpp
+++ b/quantum/encoder/tests/encoder_tests_split_left_eq_right.cpp
@@ -33,22 +33,29 @@ struct update {
 uint8_t updates_array_idx = 0;
 update  updates[32];
 
+bool isMaster;
 bool isLeftHand;
 
+extern "C" {
+bool is_keyboard_master(void) {
+    return isMaster;
+}
+
 bool encoder_update_kb(uint8_t index, bool clockwise) {
-    if (!isLeftHand) {
+    if (!is_keyboard_master()) {
         // this method has no effect on slave half
-        printf("ignoring update on right hand (%d,%s)\n", index, clockwise ? "CW" : "CC");
+        printf("ignoring update on slave (%d,%s)\n", index, clockwise ? "CW" : "CC");
         return true;
     }
     updates[updates_array_idx % 32] = {index, clockwise};
     updates_array_idx++;
     return true;
 }
+};
 
 bool setAndRead(pin_t pin, bool val) {
     setPin(pin, val);
-    return encoder_read();
+    return encoder_task();
 }
 
 class EncoderSplitTestLeftEqRight : public ::testing::Test {
@@ -63,6 +70,7 @@ class EncoderSplitTestLeftEqRight : public ::testing::Test {
 };
 
 TEST_F(EncoderSplitTestLeftEqRight, TestInitLeft) {
+    isMaster   = true;
     isLeftHand = true;
     encoder_init();
     EXPECT_EQ(pinIsInputHigh[0], true);
@@ -77,6 +85,7 @@ TEST_F(EncoderSplitTestLeftEqRight, TestInitLeft) {
 }
 
 TEST_F(EncoderSplitTestLeftEqRight, TestInitRight) {
+    isMaster   = true;
     isLeftHand = false;
     encoder_init();
     EXPECT_EQ(pinIsInputHigh[0], false);
@@ -90,7 +99,8 @@ TEST_F(EncoderSplitTestLeftEqRight, TestInitRight) {
     EXPECT_EQ(updates_array_idx, 0); // no updates received
 }
 
-TEST_F(EncoderSplitTestLeftEqRight, TestOneClockwiseLeft) {
+TEST_F(EncoderSplitTestLeftEqRight, TestOneClockwiseLeftMaster) {
+    isMaster   = true;
     isLeftHand = true;
     encoder_init();
     // send 4 pulses. with resolution 4, that's one step and we should get 1 update.
@@ -102,9 +112,19 @@ TEST_F(EncoderSplitTestLeftEqRight, TestOneClockwiseLeft) {
     EXPECT_EQ(updates_array_idx, 1); // one update received
     EXPECT_EQ(updates[0].index, 0);
     EXPECT_EQ(updates[0].clockwise, true);
+
+    int              events_queued = 0;
+    encoder_events_t events;
+    encoder_retrieve_events(&events);
+    while (events.tail != events.head) {
+        events.tail = (events.tail + 1) % MAX_QUEUED_ENCODER_EVENTS;
+        ++events_queued;
+    }
+    EXPECT_EQ(events_queued, 0); // No events should be queued on master
 }
 
-TEST_F(EncoderSplitTestLeftEqRight, TestOneClockwiseRightSent) {
+TEST_F(EncoderSplitTestLeftEqRight, TestOneClockwiseRightMaster) {
+    isMaster   = true;
     isLeftHand = false;
     encoder_init();
     // send 4 pulses. with resolution 4, that's one step and we should get 1 update.
@@ -113,23 +133,60 @@ TEST_F(EncoderSplitTestLeftEqRight, TestOneClockwiseRightSent) {
     setAndRead(6, true);
     setAndRead(7, true);
 
-    uint8_t slave_state[32] = {0};
-    encoder_state_raw(slave_state);
+    EXPECT_EQ(updates_array_idx, 1); // one update received
+    EXPECT_EQ(updates[0].index, 3);
+    EXPECT_EQ(updates[0].clockwise, true);
 
-    EXPECT_EQ(slave_state[0], 0);
-    EXPECT_EQ(slave_state[1], 0xFF);
+    int              events_queued = 0;
+    encoder_events_t events;
+    encoder_retrieve_events(&events);
+    while (events.tail != events.head) {
+        events.tail = (events.tail + 1) % MAX_QUEUED_ENCODER_EVENTS;
+        ++events_queued;
+    }
+    EXPECT_EQ(events_queued, 0); // No events should be queued on master
 }
 
-TEST_F(EncoderSplitTestLeftEqRight, TestMultipleEncodersRightReceived) {
+TEST_F(EncoderSplitTestLeftEqRight, TestOneClockwiseLeftSlave) {
+    isMaster   = false;
     isLeftHand = true;
     encoder_init();
+    // send 4 pulses. with resolution 4, that's one step and we should get 1 update.
+    setAndRead(0, false);
+    setAndRead(1, false);
+    setAndRead(0, true);
+    setAndRead(1, true);
 
-    uint8_t slave_state[32] = {1, 0xFF}; // First right encoder is CCW, Second right encoder CW
-    encoder_update_raw(slave_state);
+    EXPECT_EQ(updates_array_idx, 0); // no updates received
 
-    EXPECT_EQ(updates_array_idx, 2); // two updates received, one for each changed item on the right side
-    EXPECT_EQ(updates[0].index, 2);
-    EXPECT_EQ(updates[0].clockwise, false);
-    EXPECT_EQ(updates[1].index, 3);
-    EXPECT_EQ(updates[1].clockwise, true);
+    int              events_queued = 0;
+    encoder_events_t events;
+    encoder_retrieve_events(&events);
+    while (events.tail != events.head) {
+        events.tail = (events.tail + 1) % MAX_QUEUED_ENCODER_EVENTS;
+        ++events_queued;
+    }
+    EXPECT_EQ(events_queued, 1); // One event should be queued on slave
+}
+
+TEST_F(EncoderSplitTestLeftEqRight, TestOneClockwiseRightSlave) {
+    isMaster   = false;
+    isLeftHand = false;
+    encoder_init();
+    // send 4 pulses. with resolution 4, that's one step and we should get 1 update.
+    setAndRead(6, false);
+    setAndRead(7, false);
+    setAndRead(6, true);
+    setAndRead(7, true);
+
+    EXPECT_EQ(updates_array_idx, 0); // no updates received
+
+    int              events_queued = 0;
+    encoder_events_t events;
+    encoder_retrieve_events(&events);
+    while (events.tail != events.head) {
+        events.tail = (events.tail + 1) % MAX_QUEUED_ENCODER_EVENTS;
+        ++events_queued;
+    }
+    EXPECT_EQ(events_queued, 1); // One event should be queued on slave
 }