Matrix power saving

[tmk_firmware.git] / common / keyboard.h

diff --git a/common/keyboard.h b/common/keyboard.h
index dd1ebb2bd007bd87bfd59ae87d2057549889ca0b..6442716fc754115037e3a03a833cf28b5588fb0b 100644 (file)
--- a/common/keyboard.h
+++ b/common/keyboard.h
@@ -1,5 +1,5 @@
 /*
-Copyright 2011 Jun Wako <wakojun@gmail.com>
+Copyright 2011,2012,2013 Jun Wako <wakojun@gmail.com>
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
@@ -26,43 +26,45 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 extern "C" {
 #endif
 
+/* key matrix position */
 typedef struct {
     uint8_t col;
     uint8_t row;
 } keypos_t;
 
-typedef union {
-    uint16_t raw;
-    keypos_t pos;
-} key_t;
-
+/* key event */
 typedef struct {
-    key_t    key;
+    keypos_t key;
     bool     pressed;
     uint16_t time;
 } keyevent_t;
 
-#define KEYEQ(keya, keyb)       ((keya).raw == (keyb).raw)
-#define IS_NOEVENT(event)       ((event).key.pos.row == 255 && (event).key.pos.col == 255)
-#define NOEVENT                 (keyevent_t){           \
-    .key.pos = (keypos_t){ .row = 255, .col = 255 },    \
-    .pressed = false,                                   \
-    .time = 0                                           \
-}
+/* equivalent test of keypos_t */
+#define KEYEQ(keya, keyb)       ((keya).row == (keyb).row && (keya).col == (keyb).col)
+
+/* 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); }
+
+/* Tick event */
 #define TICK                    (keyevent_t){           \
-    .key.pos = (keypos_t){ .row = 255, .col = 255 },    \
+    .key = (keypos_t){ .row = 255, .col = 255 },           \
     .pressed = false,                                   \
-    .time = timer_read()                                \
+    .time = (timer_read() | 1)                          \
 }
 
 
-extern uint8_t current_layer;
-extern uint8_t default_layer;
-
 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