qmk_firmware/tmk_core/common/keyboard.h
James Young c66df16644
2020 November 28 Breaking Changes Update ()
* Branch point for 2020 November 28 Breaking Change                                                

* Remove matrix_col_t to allow MATRIX_ROWS > 32 ()                                           

* Add support for soft serial to ATmega32U2 ()                                               

* Change MIDI velocity implementation to allow direct control of velocity value ()            

* Add ability to build a subset of all keyboards based on platform.                                

* Actually use eeprom_driver_init().                                                               

* Make bootloader_jump weak for ChibiOS. ()                                                  

* Joystick 16-bit support ()                                                                 

* Per-encoder resolutions ()                                                                 

* Share button state from mousekey to pointing_device ()                                     

* Add hotfix for chibios keyboards not wake ()                                               

* Add advanced/efficient RGB Matrix Indicators ()                                             

* Naming change.                                                                                   

* Support for STM32 GPIOF,G,H,I,J,K ()                                                       

* Add milc as a dependency and remove the installed milc ()                                  

* ChibiOS upgrade: early init conversions ()                                                 

* ChibiOS upgrade: configuration file migrator ()                                             

* Haptic and solenoid cleanup ()                                                              

* XD75 cleanup ()                                                                            

* OLED display update interval support ()                                                    

* Add definition based on currently-selected serial driver. ()                               

* New feature: Retro Tapping per key ()                                                      

* Allow for modification of output RGB values when using rgblight/rgb_matrix. ()             

* Add housekeeping task callbacks so that keyboards/keymaps are capable of executing code for each main loop iteration. ()

* Rescale both ChibiOS and AVR backlighting.                                                       

* Reduce Helix keyboard build variation ()                                                    

* Minor change to behavior allowing display updates to continue between task ticks ()        

* Some GPIO manipulations in matrix.c change to atomic. ()                                   

* qmk cformat ()                                                                             

* [Keyboard] Update the Speedo firmware for v3.0 ()                                          

* Maartenwut/Maarten namechange to evyd13/Evy ()                                             

* [quantum] combine repeated lines of code ()                                                

* Add step sequencer feature ()                                                               

* aeboards/ext65 refactor ()                                                                 

* Refactor xelus/dawn60 for Rev2 later ()                                                    

* add DEBUG_MATRIX_SCAN_RATE_ENABLE to common_features.mk ()                                 

* [Core] Added `add_oneshot_mods` & `del_oneshot_mods` ()                                    

* update chibios os usb for the otg driver ()                                                 

* Remove HD44780 References, Part 4 ()                                                       

* [Keyboard] Add Valor FRL TKL (+refactor) ()                                                

* Fix cursor position bug in oled_write_raw functions ()                                     

* Fixup version.h writing when using SKIP_VERSION=yes ()                                     

* Allow for certain code in the codebase assuming length of string. ()                       

* Add AT90USB support for serial.c ()                                                        

* Auto shift: support repeats and early registration ()                                       

* Rename ledmatrix.h to match .c file ()                                                      

* Split RGB_MATRIX_ENABLE into _ENABLE and _DRIVER ()                                        

* Split LED_MATRIX_ENABLE into _ENABLE and _DRIVER ()                                        

* Merge point for 2020 Nov 28 Breaking Change
2020-11-28 12:02:18 -08:00

82 lines
2.5 KiB
C

/*
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;
/* key event */
typedef struct {
keypos_t key;
bool pressed;
uint16_t time;
} keyevent_t;
/* equivalent test of keypos_t */
#define KEYEQ(keya, keyb) ((keya).row == (keyb).row && (keya).col == (keyb).col)
/* 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 */
#define TICK \
(keyevent_t) { .key = (keypos_t){.row = 255, .col = 255}, .pressed = false, .time = (timer_read() | 1) }
/* it runs once at early stage of startup before keyboard_init. */
void keyboard_setup(void);
/* it runs once after initializing host side protocol, debug and MCU peripherals. */
void keyboard_init(void);
/* it runs repeatedly in main loop */
void keyboard_task(void);
/* it runs when host LED status is updated */
void keyboard_set_leds(uint8_t leds);
/* it runs whenever code has to behave differently on a slave */
bool is_keyboard_master(void);
/* it runs whenever code has to behave differently on left vs right split */
bool is_keyboard_left(void);
void keyboard_pre_init_kb(void);
void keyboard_pre_init_user(void);
void keyboard_post_init_kb(void);
void keyboard_post_init_user(void);
void housekeeping_task_kb(void);
void housekeeping_task_user(void);
#ifdef __cplusplus
}
#endif
#endif