qmk_firmware/common/keyboard.h

/*
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
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/>.
*/

#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_task(void);
void keyboard_set_leds(uint8_t leds);

#ifdef __cplusplus
}
#endif

#endif