Clean layer actions.

[max/tmk_keyboard.git] / common / keyboard.h

diff --git a/common/keyboard.h b/common/keyboard.h
index 51bf67379aa2791051e6de225dc82bc109cc14eb..e1cab31194ccaee402aee1e7d99a3ede61b7d309 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
@@ -18,15 +18,57 @@ along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #ifndef KEYBOARD_H
 #define KEYBOARD_H
 
+#include <stdbool.h>
 #include <stdint.h>
 
 
 #ifdef __cplusplus
 extern "C" {
 #endif
+
+/* key matrix position */
+typedef struct {
+    uint8_t col;
+    uint8_t row;
+} keypos_t;
+
+// TODO: need raw? keypos_t -> key_t?
+typedef union {
+    uint16_t raw;
+    keypos_t pos;
+} key_t;
+
+/* key event */
+typedef struct {
+    key_t    key;
+    bool     pressed;
+    uint16_t time;
+} keyevent_t;
+
+/* equivalent test of key_t */
+#define KEYEQ(keya, keyb)       ((keya).raw == (keyb).raw)
+
+/* (time == 0) means no event and assumes matrix has no 255 line. */
+#define IS_NOEVENT(event)       ((event).time == 0 || ((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                                           \
+}
+
+/* tick event */
+#define TICK                    (keyevent_t){           \
+    .key.pos = (keypos_t){ .row = 255, .col = 255 },    \
+    .pressed = false,                                   \
+    .time = (timer_read() | 1)                          \
+}
+
+
 void keyboard_init(void);
-void keyboard_proc(void);
+void keyboard_task(void);
 void keyboard_set_leds(uint8_t leds);
+
 #ifdef __cplusplus
 }
 #endif