keyboard.h 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  1. /*
  2. Copyright 2011,2012,2013 Jun Wako <wakojun@gmail.com>
  3. This program is free software: you can redistribute it and/or modify
  4. it under the terms of the GNU General Public License as published by
  5. the Free Software Foundation, either version 2 of the License, or
  6. (at your option) any later version.
  7. This program is distributed in the hope that it will be useful,
  8. but WITHOUT ANY WARRANTY; without even the implied warranty of
  9. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  10. GNU General Public License for more details.
  11. You should have received a copy of the GNU General Public License
  12. along with this program. If not, see <http://www.gnu.org/licenses/>.
  13. */
  14. #pragma once
  15. #include <stdbool.h>
  16. #include <stdint.h>
  17. #ifdef __cplusplus
  18. extern "C" {
  19. #endif
  20. /* key matrix position */
  21. typedef struct {
  22. uint8_t col;
  23. uint8_t row;
  24. } keypos_t;
  25. /* key event */
  26. typedef struct {
  27. keypos_t key;
  28. bool pressed;
  29. uint16_t time;
  30. } keyevent_t;
  31. /* equivalent test of keypos_t */
  32. #define KEYEQ(keya, keyb) ((keya).row == (keyb).row && (keya).col == (keyb).col)
  33. /* Rules for No Event:
  34. * 1) (time == 0) to handle (keyevent_t){} as empty event
  35. * 2) Matrix(255, 255) to make TICK event available
  36. */
  37. static inline bool IS_NOEVENT(keyevent_t event) { return event.time == 0 || (event.key.row == 255 && event.key.col == 255); }
  38. static inline bool IS_PRESSED(keyevent_t event) { return (!IS_NOEVENT(event) && event.pressed); }
  39. static inline bool IS_RELEASED(keyevent_t event) { return (!IS_NOEVENT(event) && !event.pressed); }
  40. /* Tick event */
  41. #define TICK \
  42. (keyevent_t) { .key = (keypos_t){.row = 255, .col = 255}, .pressed = false, .time = (timer_read() | 1) }
  43. /* it runs once at early stage of startup before keyboard_init. */
  44. void keyboard_setup(void);
  45. /* it runs once after initializing host side protocol, debug and MCU peripherals. */
  46. void keyboard_init(void);
  47. /* it runs repeatedly in main loop */
  48. void keyboard_task(void);
  49. /* it runs when host LED status is updated */
  50. void keyboard_set_leds(uint8_t leds);
  51. /* it runs whenever code has to behave differently on a slave */
  52. bool is_keyboard_master(void);
  53. /* it runs whenever code has to behave differently on left vs right split */
  54. bool is_keyboard_left(void);
  55. void keyboard_pre_init_kb(void);
  56. void keyboard_pre_init_user(void);
  57. void keyboard_post_init_kb(void);
  58. void keyboard_post_init_user(void);
  59. void housekeeping_task_kb(void);
  60. void housekeeping_task_user(void);
  61. #ifdef __cplusplus
  62. }
  63. #endif