1
0

Add new layer actions.

This commit is contained in:
tmk 2013-01-09 22:33:33 +09:00
parent 38a8012def
commit 93078aad21
5 changed files with 283 additions and 279 deletions

View File

@ -1,6 +1,6 @@
#include "host.h"
#include "timer.h"
//#include "keymap.h"
#include "keymap.h"
#include "keycode.h"
#include "keyboard.h"
#include "mousekey.h"
@ -78,8 +78,6 @@ typedef enum { IDLE, DELAYING, WAITING, PRESSING } kbdstate_t;
static kbdstate_t kbdstate = IDLE;
static uint8_t fn_state_bits = 0;
static keyrecord_t delayed_fn = {};
static keyrecord_t waiting_key = {};
static const char *state_str(kbdstate_t state)
{
@ -96,17 +94,6 @@ static bool anykey_sent_to_host(void)
}
/*
static void layer_switch_on(uint8_t code);
static void layer_switch_off(uint8_t code);
static void key_action(uint8_t code, keyevent_t event);
static void key_pressed(uint8_t code, keyevent_t event);
static void key_released(uint8_t code, keyevent_t event);
static void mod_pressed(uint8_t code, keyevent_t event);
static void mod_released(uint8_t code, keyevent_t event);
*/
static void register_code(uint8_t code);
static void unregister_code(uint8_t code);
static void register_mods(uint8_t mods);
@ -118,6 +105,7 @@ static void layer_switch(uint8_t new_layer);
/* tap */
#define TAP_TIME 200
#define LAYER_DELAY 200
static keyevent_t last_event = {};
static uint16_t last_event_time = 0;
static uint8_t tap_count = 0;
@ -125,10 +113,10 @@ static uint8_t tap_count = 0;
/* layer */
uint8_t default_layer = 0;
uint8_t current_layer = 0;
uint8_t waiting_layer = 0;
keyrecord_t delaying_layer = {};
void action_exec(action_t action, keyevent_t event)
void action_exec(keyevent_t event)
{
/* count tap when key is up */
if (KEYEQ(event.key, last_event.key) && timer_elapsed(last_event_time) < TAP_TIME) {
@ -137,6 +125,20 @@ void action_exec(action_t action, keyevent_t event)
tap_count = 0;
}
/* layer switch after LAYER_DELAY */
if (delaying_layer.action.code && timer_elapsed(delaying_layer.event.time) > LAYER_DELAY) {
switch (delaying_layer.action.kind.id) {
case ACT_LAYER_PRESSED:
layer_switch(delaying_layer.action.layer.opt);
break;
case ACT_LAYER_BIT:
layer_switch(current_layer | delaying_layer.action.layer.opt);
break;
}
delaying_layer = (keyrecord_t){};
}
action_t action = keymap_get_action(current_layer, event.key.row, event.key.col);
debug("action: "); debug_hex16(action.code); debug("\n");
debug("kind.id: "); debug_hex(action.kind.id); debug("\n");
debug("kind.param: "); debug_hex16(action.kind.param); debug("\n");
@ -145,6 +147,7 @@ void action_exec(action_t action, keyevent_t event)
switch (action.kind.id) {
case ACT_LMODS:
// normal key or key plus mods
if (event.pressed) {
register_mods(action.key.mods);
register_code(action.key.code);
@ -162,60 +165,9 @@ void action_exec(action_t action, keyevent_t event)
unregister_mods(action.key.mods<<4);
}
break;
case ACT_LAYER:
switch (action.layer_key.code) {
case 0x00: // Momentary switch
// TODO: history of layer switch
if (event.pressed) {
layer_switch(action.layer_key.layer);
} else {
layer_switch(default_layer);
}
break;
case 0x01: // Oneshot switch
// TODO:
break;
case 0x02: // reserved
case 0x03: // reserved
break;
case 0xF0 ... 0xF7: // Tap to enable/disable
case 0xF8 ... 0xFF: // Tap to toggle layer
// TODO:
break;
default: // with keycode for tap
debug("tap: "); debug_hex(tap_count); debug("\n");
// TODO: layer switch
// TODO: in case tap is interrupted by other key
if (event.pressed) {
// when any key down
if (host_has_anykey()) {
if (tap_count == 0)
register_code(action.layer_key.code);
} else {
}
if (tap_count == 0) {
if (host_has_anykey()) {
register_code(action.layer_key.code);
} else {
waiting_layer = action.layer_key.layer;
}
}
// register key when press after a tap
if (tap_count > 0) {
register_code(action.layer_key.code);
}
} else {
// type key after tap
if (tap_count == 1) {
register_code(action.layer_key.code);
}
unregister_code(action.layer_key.code);
}
break;
}
case ACT_LMOD_TAP:
break;
case ACT_RMOD_TAP:
break;
case ACT_USAGE:
#ifdef EXTRAKEY_ENABLE
@ -248,8 +200,172 @@ void action_exec(action_t action, keyevent_t event)
}
#endif
break;
case ACT_LMOD_TAP:
case ACT_RMOD_TAP:
case ACT_LAYER_PRESSED:
// layer action when pressed
switch (action.layer.code) {
case 0x00:
if (event.pressed) {
layer_switch(action.layer.opt);
}
break;
case 0xF0:
// TODO: tap toggle
break;
case 0xFF:
if (event.pressed) {
default_layer = action.layer.opt;
layer_switch(default_layer);
}
break;
default:
// with tap key
debug("tap: "); debug_hex(tap_count); debug("\n");
if (event.pressed) {
if (tap_count == 0) {
if (host_has_anykey()) {
register_code(action.layer.code);
} else {
delaying_layer = (keyrecord_t){
.event = event,
.action = action,
.mods = keyboard_report->mods
};
}
} else if (tap_count > 0) {
register_code(action.layer.code);
}
} else {
// type key after tap
if (tap_count == 1) {
delaying_layer = (keyrecord_t){};
register_code(action.layer.code);
}
unregister_code(action.layer.code);
}
break;
}
break;
case ACT_LAYER_RELEASED:
switch (action.layer.code) {
case 0x00:
if (event.pressed) {
layer_switch(action.layer.opt);
}
break;
case 0xF0:
// Ignored. LAYER_RELEASED with tap toggle is invalid action.
break;
case 0xFF:
if (!event.pressed) {
default_layer = action.layer.opt;
layer_switch(default_layer);
}
break;
default:
// Ignored. LAYER_RELEASED with tap key is invalid action.
break;
}
break;
case ACT_LAYER_BIT:
switch (action.layer.code) {
case 0x00:
if (event.pressed) {
layer_switch(current_layer | action.layer.opt);
} else {
layer_switch(current_layer & ~action.layer.opt);
}
break;
case 0xF0:
// TODO: tap toggle
break;
case 0xFF:
// change default layer
if (event.pressed) {
default_layer = current_layer | action.layer.opt;
layer_switch(default_layer);
} else {
default_layer = current_layer & ~action.layer.opt;
layer_switch(default_layer);
}
break;
default:
// with tap key
debug("tap: "); debug_hex(tap_count); debug("\n");
if (event.pressed) {
if (tap_count == 0) {
if (host_has_anykey()) {
register_code(action.layer.code);
} else {
delaying_layer = (keyrecord_t){
.event = event,
.action = action,
.mods = keyboard_report->mods
};
}
} else if (tap_count > 0) {
register_code(action.layer.code);
}
} else {
if (tap_count == 0) {
// no tap
layer_switch(current_layer & ~action.layer.opt);
} else if (tap_count == 1) {
// tap
register_code(action.layer.code);
}
unregister_code(action.layer.code);
}
break;
}
case ACT_LAYER_EXT:
switch (action.layer.opt) {
case 0x00:
// set default layer when pressed
switch (action.layer.code) {
case 0x00:
if (event.pressed) {
layer_switch(default_layer);
}
break;
case 0xF0:
// TODO: tap toggle
break;
case 0xFF:
if (event.pressed) {
default_layer = current_layer;
layer_switch(default_layer);
}
break;
default:
// TODO: tap key
break;
}
break;
case 0x01:
// set default layer when released
switch (action.layer.code) {
case 0x00:
if (!event.pressed) {
layer_switch(default_layer);
}
break;
case 0xFF:
if (!event.pressed) {
default_layer = current_layer;
layer_switch(default_layer);
}
break;
case 0xF0:
default:
// Ignore tap.
if (!event.pressed) {
layer_switch(default_layer);
}
break;
}
break;
}
break;
case ACT_MACRO:
case ACT_COMMAND:
case ACT_FUNCTION:
@ -263,142 +379,6 @@ void action_exec(action_t action, keyevent_t event)
}
#if 0
/* Key Action */
inline
static void key_action(uint8_t code, keyevent_t event)
{
if (event.pressed)
key_pressed(code, event);
else
key_released(code, event);
}
void fn_action(uint8_t code, keyevent_t event)
{
}
/* Key */
inline static void key_pressed(uint8_t code, keyevent_t event)
{
uint8_t tmp_mods;
switch (kbdstate) {
case IDLE:
register_code(code);
NEXT(PRESSING);
break;
case PRESSING:
register_code(code);
break;
case DELAYING:
waiting_key = (keyrecord_t) {
.event = event,
.code = code,
.mods = keyboard_report->mods,
.time = timer_read()
};
NEXT(WAITING);
break;
case WAITING:
// play back key stroke
tmp_mods = keyboard_report->mods;
host_set_mods(delayed_fn.mods);
register_code(delayed_fn.code);
host_set_mods(waiting_key.mods);
register_code(waiting_key.code);
host_set_mods(tmp_mods);
register_code(code);
NEXT(IDLE);
break;
}
}
inline static void key_released(uint8_t code, keyevent_t event)
{
uint8_t tmp_mods;
switch (kbdstate) {
case IDLE:
unregister_code(code);
break;
case PRESSING:
unregister_code(code);
if (!anykey_sent_to_host())
NEXT(IDLE);
break;
case DELAYING:
unregister_code(code);
break;
case WAITING:
if (code == waiting_key.code) {
layer_switch_on(delayed_fn.code);
NEXT(IDLE);
// process waiting_key
tmp_mods = keyboard_report->mods;
host_set_mods(waiting_key.mods);
keymap_process_event(waiting_key.event);
host_set_mods(tmp_mods);
keymap_process_event(event);
} else {
unregister_code(code);
}
break;
}
}
/* layer switch momentary */
inline static void layerkey_pressed(uint8_t code, keyevent_t event)
{
uint8_t tmp_mods;
switch (kbdstate) {
case IDLE:
layer_switch_on(code);
break;
case PRESSING:
// ignore
break;
case DELAYING:
waiting_key = (keyrecord_t) {
.event = event,
.code = code,
.mods = keyboard_report->mods,
.time = timer_read()
};
NEXT(WAITING);
break;
case WAITING:
tmp_mods = keyboard_report->mods;
host_set_mods(delayed_fn.mods);
register_code(delayed_fn.code);
host_set_mods(waiting_key.mods);
register_code(waiting_key.code);
host_set_mods(tmp_mods);
if (kind == FN_DOWN) {
// ignore Fn
} else if (kind == FNK_DOWN) {
register_code(code);
} else if (kind == KEY_DOWN) {
register_code(code);
}
NEXT(IDLE);
break;
}
}
inline static void layerkey_released(uint8_t code, keyevent_t event)
{
switch (kbdstate) {
case IDLE:
layer_switch_off(code);
break;
case PRESSING:
case DELAYING:
case WAITING:
if (layer_switch_off(code))
NEXT(IDLE);
break;
}
}
#endif
static void register_code(uint8_t code)
{
if (code == KC_NO) {

View File

@ -15,10 +15,6 @@ ACT_LMODS(0000)
0 0 0 0| mods(4) | 0 0 0 0 0 0| 1 0 (reserved)
0 0 0 0| mods(4) | 0 0 0 0 0 0| 1 1 (reserved)
0 0 0 0| mods(4) | keycode(8) Key+Lmods
???
0 0 0 0| mods(4) | 1 1 1 1 0| tap(3) Lmods+tap Switch(enable/disable)
0 0 0 0| mods(4) | 1 1 1 1 1| tap(3) Lmods+tap Toggle(on/off)
???
ACT_RMODS(0001)
0 0 0 1| 0 0 0 0| 0 0 0 0 0 0 0 0 No action(not used)
@ -28,10 +24,6 @@ ACT_RMODS(0001)
0 0 0 1| mods(4) | 0 0 0 0 0 0| 1 0 (reserved)
0 0 0 1| mods(4) | 0 0 0 0 0 0| 1 1 (reserved)
0 0 0 1| mods(4) | keycode(8) Key+Rmod
???
0 0 0 1| mods(4) | 1 1 1 1 0| tap(3) Rmods+tap Switch(enable/disable)
0 0 0 1| mods(4) | 1 1 1 1 1| tap(3) Rmods+tap Toggle(on/off)
???
ACT_LMODS_TAP(0010)
0 0 1 0| 0 0 0 0| X X X X X X X X (reserved)[00-FF]
@ -45,36 +37,47 @@ ACT_RMODS_TAP(0011)
0 0 1 1| mods(4) | keycode(8) Rmods+tap Key
0 0 1 1| mods(4) | 1 1 1 1| X X X X (reserved)[F0-FF]
ACT_LAYER(0100)
0 1 0 0| layer(4) | 0 0 0 0 0 0| 0 0 Momentary
0 1 0 0| layer(4) | 0 0 0 0 0 0| 0 1 Oneshot
0 1 0 0| layer(4) | 0 0 0 0 0 0| 1 0 (reserved)
0 1 0 0| layer(4) | 0 0 0 0 0 0| 1 1 (reserved)
0 1 0 0| layer(4) | keycode(8) Fn momentary + tap Key
0 1 0 0| layer(4) | 1 1 1 1 0| tap(3) Fn+tap Switch(enable/disable)
0 1 0 0| layer(4) | 1 1 1 1 1| tap(3) Fn+tap Toggle(on/off)
ACT_USAGE(0101)
0 1 0 1| 0 0| usage(10) System usage
0 1 0 1| 0 1| usage(10) Consumer usage
0 1 0 1| 1 0| usage(10) (reserved)
0 1 0 1| 1 1| usage(10) (reserved)
ACT_USAGE - other HID usage than keyboard
0 1 0 0| 0 0| usage(10) System usage
0 1 0 0| 0 1| usage(10) Consumer usage
0 1 0 0| 1 0| usage(10) (reserved)
0 1 0 0| 1 1| usage(10) (reserved)
ACT_MOUSEKEY(0110)
0 1 1 0| X X X X| keycode(8) Mouse key
0 1 0 1| X X X X| keycode(8) Mouse key
??? TODO: refactor
0 1 1 0| 0 0 X X| accel(5) |cursor(3) Mouse key
0 1 1 0| 0 1 X X| accel(5) |wheel(3) Mouse key
0 1 1 0| 1 0 X X| button(8) Mouse key
0 1 1 0| 1 1 X X| button(8) Mouse key
0 1 0 1| 0 0 X X| accel(5) |cursor(3) Mouse key
0 1 0 1| 0 1 X X| accel(5) |wheel(3) Mouse key
0 1 0 1| 1 0 X X| button(8) Mouse key
0 1 0 1| 1 1 X X| button(8) Mouse key
???
0 1 1 1| (reserved)
1 0 0 0| (reserved)
1 0 0 1| (reserved)
1 0 1 0| (reserved)
1 0 1 1| (reserved)
1 1 0 0| (reserved)
Layer Action
------------
1000|LLLL|0000 0000 set layer L when pressed
1001|LLLL|0000 0000 set layer L when released
1010|BBBB|0000 0000 on/off bit B when pressed/released
1011|0000|0000 0000 set default layer when pressed
1011|0001|0000 0000 set default layer when released
1000|LLLL|1111 0000 set layer L when pressed + tap toggle
1001|LLLL|1111 0000 set layer L when released[tap is ignored/not used]
1010|BBBB|1111 0000 on/off bit B when pressed/released + tap toggle
1011|0000|1111 0000 set default layer when pressed + tap toggle
1011|0001|1111 0000 set default layer when released[tap is ignored/not used]
1000|LLLL|1111 1111 set L to default layer when pressed
1001|LLLL|1111 1111 set L to default layer when released
1010|BBBB|1111 1111 on/off bit B of default layer when pressed/released
1011|0000|1111 1111 set current to default layer when pressed
1011|0001|1111 1111 set current to default layer when released
1000|LLLL| keycode set layer L when pressed + tap key
1001|LLLL| keyocde set layer L when released[tap is ignored/not used]
1010|BBBB| keyocde on/off bit B when pressed/released + tap key
1011|0000| keyocde set default layer when pressed + tap key
1011|0001| keyocde set default layer when released[tap is ignored/not used]
ACT_MACRO(1100)
1 1 0 0| option(4) | macro-table id(8) Macro play(Flash)
@ -88,25 +91,32 @@ ACT_FUNCTION(1111)
1 1 1 1| function address(4K range) Function
Macro record(dynamicly)
Macro play(dynamicly)
TODO: modifier + [tap key /w mod]
: layerkey + [tap key /w mod]
for example: LShift + '('[Shift+9] and RShift + ')'[Shift+0]
http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478.html#p90052
*/
enum action_id {
ACT_LMODS = 0,
ACT_RMODS,
ACT_LMOD_TAP,
ACT_RMOD_TAP,
ACT_LAYER,
ACT_USAGE,
ACT_MOUSEKEY,
ACT_MACRO = 14,
ACT_COMMAND = 15,
ACT_FUNCTION = 16
ACT_LMODS = 0b0000,
ACT_RMODS = 0b0001,
ACT_LMOD_TAP = 0b0010,
ACT_RMOD_TAP = 0b0011,
ACT_USAGE = 0b0100,
ACT_MOUSEKEY = 0b0101,
ACT_LAYER_PRESSED = 0b1000,
ACT_LAYER_RELEASED = 0b1001,
ACT_LAYER_BIT = 0b1010,
ACT_LAYER_EXT = 0b1011,
ACT_MACRO = 0b1100,
ACT_COMMAND = 0b1110,
ACT_FUNCTION = 0b1111
};
// TODO: not portable across compiler/endianness?
/*
In avr-gcc bit fields seems to be assigned from LSB(bit0) to MSB(bit15).
AVR seems like little endian in avr-gcc.
AVR looks like a little endian in avr-gcc.
Byte order and bit order of 0x1234:
Big endian: 15 ... 8 7 ... 210
@ -127,17 +137,11 @@ typedef union {
uint16_t mods :4;
uint16_t kind :4;
} key;
struct action_layer_key {
struct action_layer {
uint16_t code :8;
uint16_t layer :4;
uint16_t opt :4;
uint16_t kind :4;
} layer_key;
struct action_layer_tap {
uint16_t count :3;
uint16_t rest :5;
uint16_t layer :4;
uint16_t kind :4;
} layer_tap;
} layer;
struct action_usage {
uint16_t code :10;
uint16_t page :2;
@ -157,7 +161,14 @@ enum stroke_cmd {
STROKE_ALLUP, /* release all keys in reverse order */
};
void action_exec(action_t act, keyevent_t event);
typedef struct {
keyevent_t event;
action_t action;
uint8_t mods;
} keyrecord_t;
void action_exec(keyevent_t event);
/*
void key_action(uint8_t code, keyevent_t event);
void mod_action(uint8_t code, keyevent_t event);
@ -166,9 +177,12 @@ void fn_action(uint8_t code, keyevent_t event);
/* action_t utility */
/*
#define ACTION_NO { .code = 0 }
#define ACTION(kind, param) { .code = ((kind)<<12 | (param)) }
#define NO_ACTION ACTION(0, 0)
#define LAYER_PARAM(layer, key) ((layer)<<8|(key))
*/
#define ACTION_NO 0
#define ACTION(kind, param) ((kind)<<12 | (param))
/* Key & Mods */
#define ACTION_KEY(key) ACTION(ACT_LMODS, key)
@ -185,12 +199,28 @@ void fn_action(uint8_t code, keyevent_t event);
/* Mods + Tap key */
#define ACTION_LMODS_TAP(mods, key) ACTION(ACT_LMODS_TAP,(mods)<<8 | (key))
#define ACTION_RMODS_TAP(mods, key) ACTION(ACT_RMODS_TAP,(mods)<<8 | (key))
/* Layer Switch */
#define ACTION_LAYER(layer) ACTION(ACT_LAYER, (layer)<<8 | 0x00)
#define ACTION_LAYER_ONESHOT(layer) ACTION(ACT_LAYER, (layer)<<8 | 0x01)
#define ACTION_LAYER_KEY(layer, key) ACTION(ACT_LAYER, (layer)<<8 | (key))
#define ACTION_LAYER_SWITCH(layer, tap) ACTION(ACT_LAYER, (layer)<<8 | 0xF0 | (tap))
#define ACTION_LAYER_TOGGLE(layer, tap) ACTION(ACT_LAYER, (layer)<<8 | 0xF1 | (tap))
#define ACTION_LAYER_SET_ON_PRESSED(layer) ACTION(ACT_LAYER_PRESSED, (layer)<<8 | 0x00)
#define ACTION_LAYER_SET_ON_RELEASED(layer) ACTION(ACT_LAYER_RELEASED, (layer)<<8 | 0x00)
#define ACTION_LAYER_BIT(bits) ACTION(ACT_LAYER_BIT, (layer)<<8 | 0x00)
#define ACTION_LAYER_TO_DEFAULT_ON_PRESSED ACTION(ACT_LAYER_EXT, 0x0<<8 | 0x00)
#define ACTION_LAYER_TO_DEFAULT_ON_RELEASED ACTION(ACT_LAYER_EXT, 0x1<<8 | 0x00)
#define ACTION_LAYER_TAP_TOGGLE(layer) ACTION(ACT_LAYER_PRESSED, (layer)<<8 | 0xF0)
#define ACTION_LAYER_BIT_TAP_TOGGLE(layer) ACTION(ACT_LAYER_BIT, (layer)<<8 | 0xF0)
#define ACTION_LAYER_DEFAULT_TAP_TOGGLE ACTION(ACT_LAYER_EXT, 0x0<<8 | 0xF0)
#define ACTION_LAYER_DEFAULT_SET_ON_PRESSED(layer) ACTION(ACT_LAYER_PRESSED, (layer)<<8 | 0xFF)
#define ACTION_LAYER_DEFAULT_SET_ON_RELEASED(layer) ACTION(ACT_LAYER_RELEASED, (layer)<<8 | 0xFF)
#define ACTION_LAYER_DEFAULT_BIT(bits) ACTION(ACT_LAYER_BIT, (bits)<<8 | 0xFF)
#define ACTION_LAYER_DEFAULT_SET_CURRENT_ON_PRESSED ACTION(ACT_LAYER_EXT, 0x0<<8 | 0xFF)
#define ACTION_LAYER_DEFAULT_SET_CURRENT_ON_RELEASED ACTION(ACT_LAYER_EXT, 0x1<<8 | 0xFF)
#define ACTION_LAYER_SET_TAP_KEY(layer, key) ACTION(ACT_LAYER_PRESSED, (layer)<<8 | (key))
#define ACTION_LAYER_BIT_TAP_KEY(bits, key) ACTION(ACT_LAYER_BIT, (layer)<<8 | (key))
#define ACTION_LAYER_DEFAULT_SET_TAP_KEY(key) ACTION(ACT_LAYER_EXT, 0x0<<8 | (key))
/* HID Usage */
#define ACTION_USAGE_PAGE_SYSTEM 0
#define ACTION_USAGE_PAGE_CONSUMER 1

View File

@ -65,9 +65,10 @@ void keyboard_task(void)
for (int c = 0; c < MATRIX_COLS; c++) {
if (matrix_change & (1<<c)) {
keymap_process_event((keyevent_t){
action_exec((keyevent_t){
.key = (keypos_t){ .row = r, .col = c },
.pressed = (matrix_row & (1<<c))
.pressed = (matrix_row & (1<<c)),
.time = timer_read()
});
// record a processed key
matrix_prev[r] ^= (1<<c);

View File

@ -34,15 +34,9 @@ typedef struct {
typedef struct {
keypos_t key;
bool pressed;
uint16_t time;
} keyevent_t;
typedef struct {
keyevent_t event;
uint8_t code;
uint8_t mods;
uint16_t time;
} keyrecord_t;
#define KEYEQ(keya, keyb) (keya.row == keyb.row && keya.col == keyb.col)
extern uint8_t current_layer;

View File

@ -35,6 +35,5 @@ uint8_t keymap_fn_keycode(uint8_t fn_bits);
* new keymap interface: action
*/
action_t keymap_get_action(uint8_t layer, uint8_t row, uint8_t col);
uint8_t keymap_process_event(keyevent_t event);
#endif