mirror of
https://github.com/qmk/qmk_firmware.git
synced 2024-12-21 09:03:23 +00:00
74e97eefd7
This commit is mostly a cherry-pick from `ahtn` at https://github.com/tmk/tmk_keyboard/pull/255. These are the changes: * Adds ACTION_LAYER_ONESHOT * Adds ONESHOT_TAP_TOGGLE * Mentions sticky keys in the docs on oneshot.
379 lines
10 KiB
C
379 lines
10 KiB
C
/*
|
|
Copyright 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/>.
|
|
*/
|
|
#include "host.h"
|
|
#include "report.h"
|
|
#include "debug.h"
|
|
#include "action_util.h"
|
|
#include "action_layer.h"
|
|
#include "timer.h"
|
|
|
|
static inline void add_key_byte(uint8_t code);
|
|
static inline void del_key_byte(uint8_t code);
|
|
#ifdef NKRO_ENABLE
|
|
static inline void add_key_bit(uint8_t code);
|
|
static inline void del_key_bit(uint8_t code);
|
|
#endif
|
|
|
|
static uint8_t real_mods = 0;
|
|
static uint8_t weak_mods = 0;
|
|
static uint8_t macro_mods = 0;
|
|
|
|
#ifdef USB_6KRO_ENABLE
|
|
#define RO_ADD(a, b) ((a + b) % KEYBOARD_REPORT_KEYS)
|
|
#define RO_SUB(a, b) ((a - b + KEYBOARD_REPORT_KEYS) % KEYBOARD_REPORT_KEYS)
|
|
#define RO_INC(a) RO_ADD(a, 1)
|
|
#define RO_DEC(a) RO_SUB(a, 1)
|
|
static int8_t cb_head = 0;
|
|
static int8_t cb_tail = 0;
|
|
static int8_t cb_count = 0;
|
|
#endif
|
|
|
|
// TODO: pointer variable is not needed
|
|
//report_keyboard_t keyboard_report = {};
|
|
report_keyboard_t *keyboard_report = &(report_keyboard_t){};
|
|
|
|
#ifndef NO_ACTION_ONESHOT
|
|
static int8_t oneshot_mods = 0;
|
|
static int8_t oneshot_locked_mods = 0;
|
|
int8_t get_oneshot_locked_mods(void) { return oneshot_locked_mods; }
|
|
void set_oneshot_locked_mods(int8_t mods) { oneshot_locked_mods = mods; }
|
|
void clear_oneshot_locked_mods(void) { oneshot_locked_mods = 0; }
|
|
#if (defined(ONESHOT_TIMEOUT) && (ONESHOT_TIMEOUT > 0))
|
|
static int16_t oneshot_time = 0;
|
|
inline bool has_oneshot_mods_timed_out() {
|
|
return TIMER_DIFF_16(timer_read(), oneshot_time) >= ONESHOT_TIMEOUT;
|
|
}
|
|
#endif
|
|
#endif
|
|
|
|
/* oneshot layer */
|
|
#ifndef NO_ACTION_ONESHOT
|
|
/* oneshot_layer_data bits
|
|
* LLLL LSSS
|
|
* where:
|
|
* L => are layer bits
|
|
* S => oneshot state bits
|
|
*/
|
|
static int8_t oneshot_layer_data = 0;
|
|
|
|
inline uint8_t get_oneshot_layer(void) { return oneshot_layer_data >> 3; }
|
|
inline uint8_t get_oneshot_layer_state(void) { return oneshot_layer_data & 0b111; }
|
|
|
|
#if (defined(ONESHOT_TIMEOUT) && (ONESHOT_TIMEOUT > 0))
|
|
static int16_t oneshot_layer_time = 0;
|
|
inline bool has_oneshot_layer_timed_out() {
|
|
return TIMER_DIFF_16(timer_read(), oneshot_layer_time) >= ONESHOT_TIMEOUT &&
|
|
!(get_oneshot_layer_state() & ONESHOT_TOGGLED);
|
|
}
|
|
#endif
|
|
|
|
/* Oneshot layer */
|
|
void set_oneshot_layer(uint8_t layer, uint8_t state)
|
|
{
|
|
oneshot_layer_data = layer << 3 | state;
|
|
layer_on(layer);
|
|
#if (defined(ONESHOT_TIMEOUT) && (ONESHOT_TIMEOUT > 0))
|
|
oneshot_layer_time = timer_read();
|
|
#endif
|
|
}
|
|
void reset_oneshot_layer(void) {
|
|
oneshot_layer_data = 0;
|
|
#if (defined(ONESHOT_TIMEOUT) && (ONESHOT_TIMEOUT > 0))
|
|
oneshot_layer_time = 0;
|
|
#endif
|
|
}
|
|
void clear_oneshot_layer_state(oneshot_fullfillment_t state)
|
|
{
|
|
uint8_t start_state = oneshot_layer_data;
|
|
oneshot_layer_data &= ~state;
|
|
if (!get_oneshot_layer_state() && start_state != oneshot_layer_data) {
|
|
layer_off(get_oneshot_layer());
|
|
#if (defined(ONESHOT_TIMEOUT) && (ONESHOT_TIMEOUT > 0))
|
|
oneshot_layer_time = 0;
|
|
#endif
|
|
}
|
|
}
|
|
bool is_oneshot_layer_active(void)
|
|
{
|
|
return get_oneshot_layer_state();
|
|
}
|
|
#endif
|
|
|
|
void send_keyboard_report(void) {
|
|
keyboard_report->mods = real_mods;
|
|
keyboard_report->mods |= weak_mods;
|
|
keyboard_report->mods |= macro_mods;
|
|
#ifndef NO_ACTION_ONESHOT
|
|
if (oneshot_mods) {
|
|
#if (defined(ONESHOT_TIMEOUT) && (ONESHOT_TIMEOUT > 0))
|
|
if (has_oneshot_mods_timed_out()) {
|
|
dprintf("Oneshot: timeout\n");
|
|
clear_oneshot_mods();
|
|
}
|
|
#endif
|
|
keyboard_report->mods |= oneshot_mods;
|
|
if (has_anykey()) {
|
|
clear_oneshot_mods();
|
|
}
|
|
}
|
|
|
|
#endif
|
|
host_keyboard_send(keyboard_report);
|
|
}
|
|
|
|
/* key */
|
|
void add_key(uint8_t key)
|
|
{
|
|
#ifdef NKRO_ENABLE
|
|
if (keyboard_protocol && keyboard_nkro) {
|
|
add_key_bit(key);
|
|
return;
|
|
}
|
|
#endif
|
|
add_key_byte(key);
|
|
}
|
|
|
|
void del_key(uint8_t key)
|
|
{
|
|
#ifdef NKRO_ENABLE
|
|
if (keyboard_protocol && keyboard_nkro) {
|
|
del_key_bit(key);
|
|
return;
|
|
}
|
|
#endif
|
|
del_key_byte(key);
|
|
}
|
|
|
|
void clear_keys(void)
|
|
{
|
|
// not clear mods
|
|
for (int8_t i = 1; i < KEYBOARD_REPORT_SIZE; i++) {
|
|
keyboard_report->raw[i] = 0;
|
|
}
|
|
}
|
|
|
|
|
|
/* modifier */
|
|
uint8_t get_mods(void) { return real_mods; }
|
|
void add_mods(uint8_t mods) { real_mods |= mods; }
|
|
void del_mods(uint8_t mods) { real_mods &= ~mods; }
|
|
void set_mods(uint8_t mods) { real_mods = mods; }
|
|
void clear_mods(void) { real_mods = 0; }
|
|
|
|
/* weak modifier */
|
|
uint8_t get_weak_mods(void) { return weak_mods; }
|
|
void add_weak_mods(uint8_t mods) { weak_mods |= mods; }
|
|
void del_weak_mods(uint8_t mods) { weak_mods &= ~mods; }
|
|
void set_weak_mods(uint8_t mods) { weak_mods = mods; }
|
|
void clear_weak_mods(void) { weak_mods = 0; }
|
|
|
|
/* macro modifier */
|
|
uint8_t get_macro_mods(void) { return macro_mods; }
|
|
void add_macro_mods(uint8_t mods) { macro_mods |= mods; }
|
|
void del_macro_mods(uint8_t mods) { macro_mods &= ~mods; }
|
|
void set_macro_mods(uint8_t mods) { macro_mods = mods; }
|
|
void clear_macro_mods(void) { macro_mods = 0; }
|
|
|
|
/* Oneshot modifier */
|
|
#ifndef NO_ACTION_ONESHOT
|
|
void set_oneshot_mods(uint8_t mods)
|
|
{
|
|
oneshot_mods = mods;
|
|
#if (defined(ONESHOT_TIMEOUT) && (ONESHOT_TIMEOUT > 0))
|
|
oneshot_time = timer_read();
|
|
#endif
|
|
}
|
|
void clear_oneshot_mods(void)
|
|
{
|
|
oneshot_mods = 0;
|
|
#if (defined(ONESHOT_TIMEOUT) && (ONESHOT_TIMEOUT > 0))
|
|
oneshot_time = 0;
|
|
#endif
|
|
}
|
|
uint8_t get_oneshot_mods(void)
|
|
{
|
|
return oneshot_mods;
|
|
}
|
|
#endif
|
|
|
|
/*
|
|
* inspect keyboard state
|
|
*/
|
|
uint8_t has_anykey(void)
|
|
{
|
|
uint8_t cnt = 0;
|
|
for (uint8_t i = 1; i < KEYBOARD_REPORT_SIZE; i++) {
|
|
if (keyboard_report->raw[i])
|
|
cnt++;
|
|
}
|
|
return cnt;
|
|
}
|
|
|
|
uint8_t has_anymod(void)
|
|
{
|
|
return bitpop(real_mods);
|
|
}
|
|
|
|
uint8_t get_first_key(void)
|
|
{
|
|
#ifdef NKRO_ENABLE
|
|
if (keyboard_protocol && keyboard_nkro) {
|
|
uint8_t i = 0;
|
|
for (; i < KEYBOARD_REPORT_BITS && !keyboard_report->nkro.bits[i]; i++)
|
|
;
|
|
return i<<3 | biton(keyboard_report->nkro.bits[i]);
|
|
}
|
|
#endif
|
|
#ifdef USB_6KRO_ENABLE
|
|
uint8_t i = cb_head;
|
|
do {
|
|
if (keyboard_report->keys[i] != 0) {
|
|
break;
|
|
}
|
|
i = RO_INC(i);
|
|
} while (i != cb_tail);
|
|
return keyboard_report->keys[i];
|
|
#else
|
|
return keyboard_report->keys[0];
|
|
#endif
|
|
}
|
|
|
|
|
|
|
|
/* local functions */
|
|
static inline void add_key_byte(uint8_t code)
|
|
{
|
|
#ifdef USB_6KRO_ENABLE
|
|
int8_t i = cb_head;
|
|
int8_t empty = -1;
|
|
if (cb_count) {
|
|
do {
|
|
if (keyboard_report->keys[i] == code) {
|
|
return;
|
|
}
|
|
if (empty == -1 && keyboard_report->keys[i] == 0) {
|
|
empty = i;
|
|
}
|
|
i = RO_INC(i);
|
|
} while (i != cb_tail);
|
|
if (i == cb_tail) {
|
|
if (cb_tail == cb_head) {
|
|
// buffer is full
|
|
if (empty == -1) {
|
|
// pop head when has no empty space
|
|
cb_head = RO_INC(cb_head);
|
|
cb_count--;
|
|
}
|
|
else {
|
|
// left shift when has empty space
|
|
uint8_t offset = 1;
|
|
i = RO_INC(empty);
|
|
do {
|
|
if (keyboard_report->keys[i] != 0) {
|
|
keyboard_report->keys[empty] = keyboard_report->keys[i];
|
|
keyboard_report->keys[i] = 0;
|
|
empty = RO_INC(empty);
|
|
}
|
|
else {
|
|
offset++;
|
|
}
|
|
i = RO_INC(i);
|
|
} while (i != cb_tail);
|
|
cb_tail = RO_SUB(cb_tail, offset);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
// add to tail
|
|
keyboard_report->keys[cb_tail] = code;
|
|
cb_tail = RO_INC(cb_tail);
|
|
cb_count++;
|
|
#else
|
|
int8_t i = 0;
|
|
int8_t empty = -1;
|
|
for (; i < KEYBOARD_REPORT_KEYS; i++) {
|
|
if (keyboard_report->keys[i] == code) {
|
|
break;
|
|
}
|
|
if (empty == -1 && keyboard_report->keys[i] == 0) {
|
|
empty = i;
|
|
}
|
|
}
|
|
if (i == KEYBOARD_REPORT_KEYS) {
|
|
if (empty != -1) {
|
|
keyboard_report->keys[empty] = code;
|
|
}
|
|
}
|
|
#endif
|
|
}
|
|
|
|
static inline void del_key_byte(uint8_t code)
|
|
{
|
|
#ifdef USB_6KRO_ENABLE
|
|
uint8_t i = cb_head;
|
|
if (cb_count) {
|
|
do {
|
|
if (keyboard_report->keys[i] == code) {
|
|
keyboard_report->keys[i] = 0;
|
|
cb_count--;
|
|
if (cb_count == 0) {
|
|
// reset head and tail
|
|
cb_tail = cb_head = 0;
|
|
}
|
|
if (i == RO_DEC(cb_tail)) {
|
|
// left shift when next to tail
|
|
do {
|
|
cb_tail = RO_DEC(cb_tail);
|
|
if (keyboard_report->keys[RO_DEC(cb_tail)] != 0) {
|
|
break;
|
|
}
|
|
} while (cb_tail != cb_head);
|
|
}
|
|
break;
|
|
}
|
|
i = RO_INC(i);
|
|
} while (i != cb_tail);
|
|
}
|
|
#else
|
|
for (uint8_t i = 0; i < KEYBOARD_REPORT_KEYS; i++) {
|
|
if (keyboard_report->keys[i] == code) {
|
|
keyboard_report->keys[i] = 0;
|
|
}
|
|
}
|
|
#endif
|
|
}
|
|
|
|
#ifdef NKRO_ENABLE
|
|
static inline void add_key_bit(uint8_t code)
|
|
{
|
|
if ((code>>3) < KEYBOARD_REPORT_BITS) {
|
|
keyboard_report->nkro.bits[code>>3] |= 1<<(code&7);
|
|
} else {
|
|
dprintf("add_key_bit: can't add: %02X\n", code);
|
|
}
|
|
}
|
|
|
|
static inline void del_key_bit(uint8_t code)
|
|
{
|
|
if ((code>>3) < KEYBOARD_REPORT_BITS) {
|
|
keyboard_report->nkro.bits[code>>3] &= ~(1<<(code&7));
|
|
} else {
|
|
dprintf("del_key_bit: can't del: %02X\n", code);
|
|
}
|
|
}
|
|
#endif
|