Matrix power saving

[tmk_firmware.git] / common / keyboard.h

diff --git a/common/keyboard.h b/common/keyboard.h
index 78cb24034f51586940bc9a0f1b34028ec44f09e9..6442716fc754115037e3a03a833cf28b5588fb0b 100644 (file)
--- a/common/keyboard.h
+++ b/common/keyboard.h
@@ -30,30 +30,29 @@ extern "C" {
 typedef struct {
     uint8_t col;
     uint8_t row;
-} key_t;
+} keypos_t;
 
 /* key event */
 typedef struct {
-    key_t    key;
+    keypos_t key;
     bool     pressed;
     uint16_t time;
 } keyevent_t;
 
-/* equivalent test of key_t */
+/* equivalent test of keypos_t */
 #define KEYEQ(keya, keyb)       ((keya).row == (keyb).row && (keya).col == (keyb).col)
 
-/* (time == 0) means no event and assumes matrix has no 255 line. */
-#define IS_NOEVENT(event)       ((event).time == 0 || ((event).key.row == 255 && (event).key.col == 255))
+/* Rules for No Event:
+ * 1) (time == 0) to handle (keyevent_t){} as empty event
+ * 2) Matrix(255, 255) to make TICK event available
+ */
+static inline bool IS_NOEVENT(keyevent_t event) { return event.time == 0 || (event.key.row == 255 && event.key.col == 255); }
+static inline bool IS_PRESSED(keyevent_t event) { return (!IS_NOEVENT(event) && event.pressed); }
+static inline bool IS_RELEASED(keyevent_t event) { return (!IS_NOEVENT(event) && !event.pressed); }
 
-#define NOEVENT                 (keyevent_t){           \
-    .key = (key_t){ .row = 255, .col = 255 },           \
-    .pressed = false,                                   \
-    .time = 0                                           \
-}
-
-/* tick event */
+/* Tick event */
 #define TICK                    (keyevent_t){           \
-    .key = (key_t){ .row = 255, .col = 255 },           \
+    .key = (keypos_t){ .row = 255, .col = 255 },           \
     .pressed = false,                                   \
     .time = (timer_read() | 1)                          \
 }
@@ -63,6 +62,9 @@ void keyboard_init(void);
 void keyboard_task(void);
 void keyboard_set_leds(uint8_t leds);
 
+__attribute__ ((weak)) void matrix_power_up(void) {}
+__attribute__ ((weak)) void matrix_power_down(void) {}
+
 #ifdef __cplusplus
 }
 #endif