common/keyboard.h

   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 typedef union {
  36     uint16_t raw;
  37     keypos_t pos;
  38 } key_t;
  39
  40 /* key event */
  41 typedef struct {
  42     key_t    key;
  43     bool     pressed;
  44     uint16_t time;
  45 } keyevent_t;
  46
  47 /* equivalent test of key_t */
  48 #define KEYEQ(keya, keyb)       ((keya).raw == (keyb).raw)
  49
  50 /* (time == 0) means no event and assumes matrix has no 255 line. */
  51 #define IS_NOEVENT(event)       ((event).time == 0 || ((event).key.pos.row == 255 && (event).key.pos.col == 255))
  52
  53 #define NOEVENT                 (keyevent_t){           \
  54     .key.pos = (keypos_t){ .row = 255, .col = 255 },    \
  55     .pressed = false,                                   \
  56     .time = 0                                           \
  57 }
  58
  59 /* tick event */
  60 #define TICK                    (keyevent_t){           \
  61     .key.pos = (keypos_t){ .row = 255, .col = 255 },    \
  62     .pressed = false,                                   \
  63     .time = (timer_read() | 1)                          \
  64 }
  65
  66
  67 void keyboard_init(void);
  68 void keyboard_task(void);
  69 void keyboard_set_leds(uint8_t leds);
  70
  71 #ifdef __cplusplus
  72 }
  73 #endif
  74
  75 #endif