diff options
Diffstat (limited to 'tmk_core/common/keyboard.h')
-rw-r--r-- | tmk_core/common/keyboard.h | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/tmk_core/common/keyboard.h b/tmk_core/common/keyboard.h new file mode 100644 index 000000000..6442716fc --- /dev/null +++ b/tmk_core/common/keyboard.h | |||
@@ -0,0 +1,72 @@ | |||
1 | /* | ||
2 | Copyright 2011,2012,2013 Jun Wako <wakojun@gmail.com> | ||
3 | |||
4 | This program is free software: you can redistribute it and/or modify | ||
5 | it under the terms of the GNU General Public License as published by | ||
6 | the Free Software Foundation, either version 2 of the License, or | ||
7 | (at your option) any later version. | ||
8 | |||
9 | This program is distributed in the hope that it will be useful, | ||
10 | but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
11 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
12 | GNU General Public License for more details. | ||
13 | |||
14 | You should have received a copy of the GNU General Public License | ||
15 | along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
16 | */ | ||
17 | |||
18 | #ifndef KEYBOARD_H | ||
19 | #define KEYBOARD_H | ||
20 | |||
21 | #include <stdbool.h> | ||
22 | #include <stdint.h> | ||
23 | |||
24 | |||
25 | #ifdef __cplusplus | ||
26 | extern "C" { | ||
27 | #endif | ||
28 | |||
29 | /* key matrix position */ | ||
30 | typedef struct { | ||
31 | uint8_t col; | ||
32 | uint8_t row; | ||
33 | } keypos_t; | ||
34 | |||
35 | /* key event */ | ||
36 | typedef struct { | ||
37 | keypos_t key; | ||
38 | bool pressed; | ||
39 | uint16_t time; | ||
40 | } keyevent_t; | ||
41 | |||
42 | /* equivalent test of keypos_t */ | ||
43 | #define KEYEQ(keya, keyb) ((keya).row == (keyb).row && (keya).col == (keyb).col) | ||
44 | |||
45 | /* Rules for No Event: | ||
46 | * 1) (time == 0) to handle (keyevent_t){} as empty event | ||
47 | * 2) Matrix(255, 255) to make TICK event available | ||
48 | */ | ||
49 | static inline bool IS_NOEVENT(keyevent_t event) { return event.time == 0 || (event.key.row == 255 && event.key.col == 255); } | ||
50 | static inline bool IS_PRESSED(keyevent_t event) { return (!IS_NOEVENT(event) && event.pressed); } | ||
51 | static inline bool IS_RELEASED(keyevent_t event) { return (!IS_NOEVENT(event) && !event.pressed); } | ||
52 | |||
53 | /* Tick event */ | ||
54 | #define TICK (keyevent_t){ \ | ||
55 | .key = (keypos_t){ .row = 255, .col = 255 }, \ | ||
56 | .pressed = false, \ | ||
57 | .time = (timer_read() | 1) \ | ||
58 | } | ||
59 | |||
60 | |||
61 | void keyboard_init(void); | ||
62 | void keyboard_task(void); | ||
63 | void keyboard_set_leds(uint8_t leds); | ||
64 | |||
65 | __attribute__ ((weak)) void matrix_power_up(void) {} | ||
66 | __attribute__ ((weak)) void matrix_power_down(void) {} | ||
67 | |||
68 | #ifdef __cplusplus | ||
69 | } | ||
70 | #endif | ||
71 | |||
72 | #endif | ||