qmk_firmware/tmk_core/common/keyboard.c

318 lines
8.2 KiB
C
Raw Normal View History

/*
2016-05-24 05:42:21 +02:00
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/>.
*/
2017-02-06 01:55:08 +01:00
#include <stdint.h>
#include "keyboard.h"
#include "matrix.h"
#include "keymap.h"
#include "host.h"
#include "led.h"
#include "keycode.h"
#include "timer.h"
#include "print.h"
#include "debug.h"
#include "command.h"
#include "util.h"
#include "sendchar.h"
2016-05-24 05:42:21 +02:00
#include "eeconfig.h"
#include "backlight.h"
#include "action_layer.h"
#ifdef BOOTMAGIC_ENABLE
2016-05-24 05:42:21 +02:00
# include "bootmagic.h"
#else
2016-05-24 05:42:21 +02:00
# include "magic.h"
#endif
#ifdef MOUSEKEY_ENABLE
# include "mousekey.h"
#endif
#ifdef PS2_MOUSE_ENABLE
# include "ps2_mouse.h"
#endif
#ifdef SERIAL_MOUSE_ENABLE
2016-05-24 05:42:21 +02:00
# include "serial_mouse.h"
#endif
#ifdef ADB_MOUSE_ENABLE
2016-05-24 05:42:21 +02:00
# include "adb.h"
#endif
2016-06-13 00:01:55 +02:00
#ifdef RGBLIGHT_ENABLE
# include "rgblight.h"
#endif
#ifdef STENO_ENABLE
# include "process_steno.h"
#endif
2017-02-13 02:03:07 +01:00
#ifdef FAUXCLICKY_ENABLE
# include "fauxclicky.h"
#endif
2016-07-06 14:22:34 +02:00
#ifdef SERIAL_LINK_ENABLE
# include "serial_link/system/serial_link.h"
#endif
#ifdef VISUALIZER_ENABLE
# include "visualizer/visualizer.h"
#endif
2017-10-06 19:13:08 +02:00
#ifdef POINTING_DEVICE_ENABLE
# include "pointing_device.h"
#endif
Merge ChibiOS and LUFA descriptor support (#2362) * Move lufa descriptor to protocol/usb_descriptor * Try to compile usb_descriptor on ChibiOS * Add lufa_utils for ChibiOS Lufa USB descriptors for ChibiOS * More lufa_util compatibility fixes * First compiling version of shared USB descriptor * Send the usb descriptors * Fix the CONSOLE output on ChibiOS * Add errors for unsupported interfaces * Enable support for vitual serial port USB descriptors * Implement virtual serial port for ChibiOS * Cleanup the lufa_utils Use the default lufa header files * Add raw hid support for ChibiOS This is completely untested * Enable midi compilation on ChibiOS * Move midi functionality out of lufa.c * Don't register sysex callback when not needed * ChibiOS compilation fixes * Update ChibiOS submodule * Fix the Midi USB descriptor It didn't work properly when both Midi and Virtual serial port was enabled. * Add MIDI support for ChibiOS * Fix USB descriptor strings on ChibiOS * Use serial usb driver for raw hid * Generalize the ChibiOS stream like drivers This makes the initialization much more simple and eliminates a lot of the code duplication. * Convert console output to chibios stream driver * Fixes for ChibiOS update * Update the ChibiOS contrib submodule To include the usb data toggle synchronization fixes * Fix duplicate reset enumeration on ChibiOS * Add missing include * Add number of endpoints check for ChibiOS * Enable serial USB driver on all keyboards * Add missing includes when API is enabled withot midi * Add another missing inlcude
2018-02-08 21:07:46 +01:00
#ifdef MIDI_ENABLE
# include "process_midi.h"
#endif
#ifdef HD44780_ENABLE
# include "hd44780.h"
#endif
#ifdef MATRIX_HAS_GHOST
2017-05-14 03:24:43 +02:00
extern const uint16_t keymaps[][MATRIX_ROWS][MATRIX_COLS];
static matrix_row_t get_real_keys(uint8_t row, matrix_row_t rowdata){
matrix_row_t out = 0;
for (uint8_t col = 0; col < MATRIX_COLS; col++) {
//read each key in the row data and check if the keymap defines it as a real key
2017-05-14 18:36:50 +02:00
if (pgm_read_byte(&keymaps[0][row][col]) && (rowdata & (1<<col))){
//this creates new row data, if a key is defined in the keymap, it will be set here
2017-05-14 03:24:43 +02:00
out |= 1<<col;
}
}
return out;
}
static inline bool popcount_more_than_one(matrix_row_t rowdata)
2017-05-14 01:57:23 +02:00
{
rowdata &= rowdata-1; //if there are less than two bits (keys) set, rowdata will become zero
return rowdata;
2017-05-13 22:19:28 +02:00
}
2017-05-14 04:07:05 +02:00
2017-05-14 02:22:38 +02:00
static inline bool has_ghost_in_row(uint8_t row, matrix_row_t rowdata)
2016-07-04 17:45:58 +02:00
{
/* No ghost exists when less than 2 keys are down on the row.
If there are "active" blanks in the matrix, the key can't be pressed by the user,
there is no doubt as to which keys are really being pressed.
The ghosts will be ignored, they are KC_NO. */
rowdata = get_real_keys(row, rowdata);
if ((popcount_more_than_one(rowdata)) == 0){
return false;
}
/* Ghost occurs when the row shares a column line with other row,
and two columns are read on each row. Blanks in the matrix don't matter,
so they are filtered out.
If there are two or more real keys pressed and they match columns with
at least two of another row's real keys, the row will be ignored. Keep in mind,
we are checking one row at a time, not all of them at once.
*/
2016-07-04 17:45:58 +02:00
for (uint8_t i=0; i < MATRIX_ROWS; i++) {
if (i != row && popcount_more_than_one(get_real_keys(i, matrix_get_row(i)) & rowdata)){
2016-07-04 17:45:58 +02:00
return true;
}
}
return false;
}
2017-05-14 01:57:23 +02:00
#endif
/** \brief matrix_setup
*
* FIXME: needs doc
*/
2016-05-24 05:42:21 +02:00
__attribute__ ((weak))
void matrix_setup(void) {
}
/** \brief keyboard_setup
*
* FIXME: needs doc
*/
2016-05-24 05:42:21 +02:00
void keyboard_setup(void) {
matrix_setup();
}
/** \brief is_keyboard_master
*
* FIXME: needs doc
*/
2017-09-30 10:58:09 +02:00
__attribute__((weak))
bool is_keyboard_master(void) {
return true;
}
/** \brief keyboard_init
*
* FIXME: needs doc
*/
2016-05-24 05:42:21 +02:00
void keyboard_init(void) {
timer_init();
// To use PORTF disable JTAG with writing JTD bit twice within four cycles.
#if (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__) || defined(__AVR_ATmega32U4__))
MCUCR |= _BV(JTD);
MCUCR |= _BV(JTD);
#endif
matrix_init();
#ifdef PS2_MOUSE_ENABLE
ps2_mouse_init();
#endif
#ifdef SERIAL_MOUSE_ENABLE
serial_mouse_init();
#endif
#ifdef ADB_MOUSE_ENABLE
adb_mouse_init();
#endif
#ifdef BOOTMAGIC_ENABLE
bootmagic();
#else
magic();
#endif
#ifdef BACKLIGHT_ENABLE
backlight_init();
#endif
2016-06-13 00:01:55 +02:00
#ifdef RGBLIGHT_ENABLE
rgblight_init();
#endif
#ifdef STENO_ENABLE
steno_init();
#endif
2017-02-13 02:03:07 +01:00
#ifdef FAUXCLICKY_ENABLE
fauxclicky_init();
#endif
2017-10-06 19:13:08 +02:00
#ifdef POINTING_DEVICE_ENABLE
pointing_device_init();
#endif
#if defined(NKRO_ENABLE) && defined(FORCE_NKRO)
keymap_config.nkro = 1;
#endif
}
/** \brief Keyboard task: Do keyboard routine jobs
*
* Do routine keyboard jobs:
*
* * scan matrix
* * handle mouse movements
* * run visualizer code
* * handle midi commands
* * light LEDs
*
2016-07-04 17:45:58 +02:00
* This is repeatedly called as fast as possible.
*/
void keyboard_task(void)
{
static matrix_row_t matrix_prev[MATRIX_ROWS];
#ifdef MATRIX_HAS_GHOST
2017-05-14 02:01:27 +02:00
// static matrix_row_t matrix_ghost[MATRIX_ROWS];
2016-07-04 17:45:58 +02:00
#endif
static uint8_t led_status = 0;
matrix_row_t matrix_row = 0;
matrix_row_t matrix_change = 0;
#ifdef QMK_KEYS_PER_SCAN
uint8_t keys_processed = 0;
#endif
2016-07-04 17:45:58 +02:00
matrix_scan();
2017-09-30 10:58:09 +02:00
if (is_keyboard_master()) {
for (uint8_t r = 0; r < MATRIX_ROWS; r++) {
matrix_row = matrix_get_row(r);
matrix_change = matrix_row ^ matrix_prev[r];
if (matrix_change) {
#ifdef MATRIX_HAS_GHOST
2017-09-30 10:58:09 +02:00
if (has_ghost_in_row(r, matrix_row)) {
/* Keep track of whether ghosted status has changed for
* debugging. But don't update matrix_prev until un-ghosted, or
* the last key would be lost.
*/
//if (debug_matrix && matrix_ghost[r] != matrix_row) {
// matrix_print();
//}
//matrix_ghost[r] = matrix_row;
continue;
}
2017-05-14 02:01:27 +02:00
//matrix_ghost[r] = matrix_row;
2017-09-30 10:58:09 +02:00
#endif
if (debug_matrix) matrix_print();
for (uint8_t c = 0; c < MATRIX_COLS; c++) {
if (matrix_change & ((matrix_row_t)1<<c)) {
action_exec((keyevent_t){
.key = (keypos_t){ .row = r, .col = c },
.pressed = (matrix_row & ((matrix_row_t)1<<c)),
.time = (timer_read() | 1) /* time should not be 0 */
});
// record a processed key
matrix_prev[r] ^= ((matrix_row_t)1<<c);
#ifdef QMK_KEYS_PER_SCAN
// only jump out if we have processed "enough" keys.
if (++keys_processed >= QMK_KEYS_PER_SCAN)
#endif
2017-09-30 10:58:09 +02:00
// process a key per task call
goto MATRIX_LOOP_END;
}
}
}
}
}
2016-07-04 17:45:58 +02:00
// call with pseudo tick event when no real key event.
#ifdef QMK_KEYS_PER_SCAN
// we can get here with some keys processed now.
if (!keys_processed)
#endif
action_exec(TICK);
2016-07-04 17:45:58 +02:00
MATRIX_LOOP_END:
#ifdef MOUSEKEY_ENABLE
2016-07-04 17:45:58 +02:00
// mousekey repeat & acceleration
mousekey_task();
#endif
2016-07-04 17:45:58 +02:00
#ifdef PS2_MOUSE_ENABLE
ps2_mouse_task();
#endif
2016-07-04 17:45:58 +02:00
#ifdef SERIAL_MOUSE_ENABLE
2016-07-06 14:22:34 +02:00
serial_mouse_task();
#endif
2016-07-04 17:45:58 +02:00
#ifdef ADB_MOUSE_ENABLE
2016-07-06 14:22:34 +02:00
adb_mouse_task();
#endif
#ifdef SERIAL_LINK_ENABLE
serial_link_update();
#endif
2016-07-04 17:45:58 +02:00
#ifdef VISUALIZER_ENABLE
visualizer_update(default_layer_state, layer_state, visualizer_get_mods(), host_keyboard_leds());
#endif
2017-10-06 19:13:08 +02:00
#ifdef POINTING_DEVICE_ENABLE
pointing_device_task();
#endif
Merge ChibiOS and LUFA descriptor support (#2362) * Move lufa descriptor to protocol/usb_descriptor * Try to compile usb_descriptor on ChibiOS * Add lufa_utils for ChibiOS Lufa USB descriptors for ChibiOS * More lufa_util compatibility fixes * First compiling version of shared USB descriptor * Send the usb descriptors * Fix the CONSOLE output on ChibiOS * Add errors for unsupported interfaces * Enable support for vitual serial port USB descriptors * Implement virtual serial port for ChibiOS * Cleanup the lufa_utils Use the default lufa header files * Add raw hid support for ChibiOS This is completely untested * Enable midi compilation on ChibiOS * Move midi functionality out of lufa.c * Don't register sysex callback when not needed * ChibiOS compilation fixes * Update ChibiOS submodule * Fix the Midi USB descriptor It didn't work properly when both Midi and Virtual serial port was enabled. * Add MIDI support for ChibiOS * Fix USB descriptor strings on ChibiOS * Use serial usb driver for raw hid * Generalize the ChibiOS stream like drivers This makes the initialization much more simple and eliminates a lot of the code duplication. * Convert console output to chibios stream driver * Fixes for ChibiOS update * Update the ChibiOS contrib submodule To include the usb data toggle synchronization fixes * Fix duplicate reset enumeration on ChibiOS * Add missing include * Add number of endpoints check for ChibiOS * Enable serial USB driver on all keyboards * Add missing includes when API is enabled withot midi * Add another missing inlcude
2018-02-08 21:07:46 +01:00
#ifdef MIDI_ENABLE
midi_task();
#endif
2016-07-04 17:45:58 +02:00
// update LED
if (led_status != host_keyboard_leds()) {
led_status = host_keyboard_leds();
keyboard_set_leds(led_status);
}
}
/** \brief keyboard set leds
*
* FIXME: needs doc
*/
2016-07-04 17:45:58 +02:00
void keyboard_set_leds(uint8_t leds)
{
if (debug_keyboard) { debug("keyboard_set_led: "); debug_hex8(leds); debug("\n"); }
led_set(leds);
}