qmk_firmware/common/keyboard.h

73 lines
2.0 KiB
C
Raw Normal View History

2011-07-20 17:32:52 +02:00
/*
2013-01-28 06:06:42 +01:00
Copyright 2011,2012,2013 Jun Wako <wakojun@gmail.com>
2011-07-20 17:32:52 +02:00
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
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
2011-02-08 16:03:58 +01:00
#ifndef KEYBOARD_H
#define KEYBOARD_H
#include <stdbool.h>
2011-02-12 16:15:51 +01:00
#include <stdint.h>
2011-02-08 16:03:58 +01:00
#ifdef __cplusplus
extern "C" {
#endif
2013-01-28 06:06:42 +01:00
/* key matrix position */
typedef struct {
uint8_t col;
2013-01-17 07:00:41 +01:00
uint8_t row;
2014-06-16 17:57:59 +02:00
} keypos_t;
2013-01-17 07:00:41 +01:00
2013-01-28 06:06:42 +01:00
/* key event */
typedef struct {
2014-06-16 17:57:59 +02:00
keypos_t key;
bool pressed;
2013-01-09 14:33:33 +01:00
uint16_t time;
} keyevent_t;
2014-06-16 17:57:59 +02:00
/* equivalent test of keypos_t */
2013-02-13 04:16:24 +01:00
#define KEYEQ(keya, keyb) ((keya).row == (keyb).row && (keya).col == (keyb).col)
2013-01-28 06:06:42 +01:00
/* 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 */
2013-01-26 18:42:48 +01:00
#define TICK (keyevent_t){ \
2014-06-16 17:57:59 +02:00
.key = (keypos_t){ .row = 255, .col = 255 }, \
2013-01-26 18:42:48 +01:00
.pressed = false, \
2013-01-28 06:06:42 +01:00
.time = (timer_read() | 1) \
2013-01-26 18:42:48 +01:00
}
2011-02-10 07:51:30 +01:00
void keyboard_init(void);
void keyboard_task(void);
2011-02-12 16:15:51 +01:00
void keyboard_set_leds(uint8_t leds);
2014-11-23 05:08:05 +01:00
__attribute__ ((weak)) void matrix_power_up(void) {}
__attribute__ ((weak)) void matrix_power_down(void) {}
#ifdef __cplusplus
}
#endif
2011-02-08 16:03:58 +01:00
#endif