X-Git-Url: https://git.friedersdorff.com/?a=blobdiff_plain;f=common%2Faction.h;h=ead917983cb646c20430ceb486b8f451fa60fc00;hb=0142e20bf0012eada5ba40caaa63466bfbb095a2;hp=9b559cb181d5e66716d67b2dc429b79eb3470980;hpb=eea85c7e24c4ff61bff0a6db8246a19896b5b630;p=max%2Ftmk_keyboard.git diff --git a/common/action.h b/common/action.h index 9b559cb1..ead91798 100644 --- a/common/action.h +++ b/common/action.h @@ -19,21 +19,28 @@ along with this program. If not, see . #include "keyboard.h" #include "keycode.h" - - -/* Execute action per keyevent */ -void action_exec(keyevent_t event); +#include "action_macro.h" /* Struct to record event and tap count */ +typedef union { + struct { + bool interrupted :1; + bool reserved2 :1; + bool reserved1 :1; + bool reserved0 :1; + uint8_t count :4; + }; +} tap_t; + typedef struct { keyevent_t event; - uint8_t tap_count; + tap_t tap; } keyrecord_t; /* Action struct. * - * In avr-gcc bit field seems to be assigned from LSB(bit0) to MSB(bit15). + * In avr-gcc bit field seems to be assigned from LSB(bit0) to MSB(bit15). * AVR looks like a little endian in avr-gcc. * * NOTE: not portable across compiler/endianness? @@ -79,6 +86,19 @@ typedef union { } action_t; + +/* Execute action per keyevent */ +void action_exec(keyevent_t event); + +/* action for key */ +action_t action_for_key(uint8_t layer, key_t key); + +/* macro */ +const prog_macro_t *action_get_macro(keyrecord_t *record, uint8_t id, uint8_t opt); + +/* user defined special function */ +void action_function(keyrecord_t *record, uint8_t id, uint8_t opt); + /* * Utilities for actions. */ @@ -96,96 +116,101 @@ bool waiting_buffer_has_anykey_pressed(void); - /* * Action codes * ============ * 16bit code: action_kind(4bit) + action_parameter(12bit) * -Keyboard Keys -------------- -ACT_LMODS(0000): -0000|0000|000000|00 No action -0000|0000| keycode Key -0000|mods|000000|00 Left mods -0000|mods| keycode Key & Left mods - -ACT_RMODS(0001): -0001|0000|000000|00 No action -0001|0000| keycode Key(no used) -0001|mods|000000|00 Right mods -0001|mods| keycode Key & Right mods - -ACT_LMODS_TAP(0010): -0010|mods|000000|00 Left mods OneShot -0010|mods|000000|01 (reserved) -0010|mods|000000|10 (reserved) -0010|mods|000000|11 (reserved) -0010|mods| keycode Left mods + tap Key - -ACT_RMODS_TAP(0011): -0011|mods|000000|00 Right mods OneShot -0011|mods|000000|01 (reserved) -0011|mods|000000|10 (reserved) -0011|mods|000000|11 (reserved) -0011|mods| keycode Right mods + tap Key - - -Other HID Usage ---------------- -This action handles other usages than keyboard. -ACT_USAGE(0100): -0100|00| usage(10) System control(0x80) - General Desktop page(0x01) -0100|01| usage(10) Consumer control(0x01) - Consumer page(0x0C) -0100|10| usage(10) (reserved) -0100|11| usage(10) (reserved) - - -Mouse Keys ----------- -TODO: can be combined with 'Other HID Usage'? to save action kind id. -ACT_MOUSEKEY(0110): -0101|XXXX| keycode Mouse key - - -Layer Actions -------------- -ACT_LAYER(1000): Set layer -ACT_LAYER_BIT(1001): Bit-op layer - -1000|LLLL|0000 0000 set L to layer on press and set default on release(momentary) -1000|LLLL|0000 0001 set L to layer on press -1000|LLLL|0000 0010 set L to layer on release -1000|----|0000 0011 set default to layer on both(return to default layer) -1000|LLLL|xxxx xxxx set L to layer while hold and send key on tap -1000|LLLL|1111 0000 set L to layer while hold and toggle on several taps -1000|LLLL|1111 1111 set L to default and layer(on press) - -1001|BBBB|0000 0000 (not used) -1001|BBBB|0000 0001 bit-xor layer with B on press -1001|BBBB|0000 0010 bit-xor layer with B on release -1001|BBBB|0000 0011 bit-xor layer with B on both(momentary) -1001|BBBB|xxxx xxxx bit-xor layer with B while hold and send key on tap -1001|BBBB|1111 0000 bit-xor layer with B while hold and toggle on several taps -1001|BBBB|1111 1111 bit-xor default with B and set layer(on press) - - - -Extensions(11XX) ----------------- -NOTE: NOT FIXED - -ACT_MACRO(1100): -1100|opt | id(8) Macro play? -1100|1111| id(8) Macro record? - -ACT_COMMAND(1110): -1110|opt | id(8) Built-in Command exec - -ACT_FUNCTION(1111): -1111| address(12) Function? -1111|opt | id(8) Function? - + * Keyboard Keys(00XX) + * ------------------- + * ACT_LMODS(0000): + * 0000|0000|000000|00 No action + * 0000|0000|000000|01 Transparent + * 0000|0000| keycode Key + * 0000|mods|000000|00 Left mods + * 0000|mods| keycode Key & Left mods + * + * ACT_RMODS(0001): + * 0001|0000|000000|00 No action(not used) + * 0001|0000|000000|01 Transparent(not used) + * 0001|0000| keycode Key(no used) + * 0001|mods|000000|00 Right mods + * 0001|mods| keycode Key & Right mods + * + * ACT_LMODS_TAP(0010): + * 0010|mods|000000|00 Left mods OneShot + * 0010|mods|000000|01 (reserved) + * 0010|mods|000000|10 (reserved) + * 0010|mods|000000|11 (reserved) + * 0010|mods| keycode Left mods + tap Key + * + * ACT_RMODS_TAP(0011): + * 0011|mods|000000|00 Right mods OneShot + * 0011|mods|000000|01 (reserved) + * 0011|mods|000000|10 (reserved) + * 0011|mods|000000|11 (reserved) + * 0011|mods| keycode Right mods + tap Key + * + * + * Other keys(01XX) + * -------------------- + * This action handles other usages than keyboard. + * ACT_USAGE(0100): + * 0100|00| usage(10) System control(0x80) - General Desktop page(0x01) + * 0100|01| usage(10) Consumer control(0x01) - Consumer page(0x0C) + * 0100|10| usage(10) (reserved) + * 0100|11| usage(10) (reserved) + * + * ACT_MOUSEKEY(0110): + * 0101|XXXX| keycode Mouse key + * + * + * Layer Actions(10XX) + * ------------------- + * ACT_KEYMAP: + * 1000|--xx|0000 0000 Clear keyamp and overlay + * 1000|LLLL|0000 00xx Reset default layer and clear keymap and overlay + * 1000|LLLL| keycode Invert with tap key + * 1000|LLLL|1111 0000 Invert with tap toggle + * 1000|LLLL|1111 00xx Invert[^= 1<>4 | (mods)) & 0x0F) -/* Key */ +/* + * Key + */ #define ACTION_KEY(key) ACTION(ACT_LMODS, key) /* Mods & key */ -#define ACTION_LMODS(mods) ACTION(ACT_LMODS, (mods)<<8 | 0x00) -#define ACTION_LMODS_KEY(mods, key) ACTION(ACT_LMODS, (mods)<<8 | (key)) -#define ACTION_RMODS(mods) ACTION(ACT_RMODS, (mods)<<8 | 0x00) -#define ACTION_RMODS_KEY(mods, key) ACTION(ACT_RMODS, (mods)<<8 | (key)) -/* Mod & key */ +#define ACTION_LMODS(mods) ACTION(ACT_LMODS, MODS4(mods)<<8 | 0x00) +#define ACTION_LMODS_KEY(mods, key) ACTION(ACT_LMODS, MODS4(mods)<<8 | (key)) +#define ACTION_RMODS(mods) ACTION(ACT_RMODS, MODS4(mods)<<8 | 0x00) +#define ACTION_RMODS_KEY(mods, key) ACTION(ACT_RMODS, MODS4(mods)<<8 | (key)) #define ACTION_LMOD(mod) ACTION(ACT_LMODS, MODS4(MOD_BIT(mod))<<8 | 0x00) #define ACTION_LMOD_KEY(mod, key) ACTION(ACT_LMODS, MODS4(MOD_BIT(mod))<<8 | (key)) #define ACTION_RMOD(mod) ACTION(ACT_RMODS, MODS4(MOD_BIT(mod))<<8 | 0x00) #define ACTION_RMOD_KEY(mod, key) ACTION(ACT_RMODS, MODS4(MOD_BIT(mod))<<8 | (key)) - -/* Mods + Tap key */ +/* Tap key */ enum mods_codes { MODS_ONESHOT = 0x00, }; @@ -231,101 +257,112 @@ enum mods_codes { #define ACTION_LMODS_ONESHOT(mods) ACTION(ACT_LMODS_TAP, MODS4(mods)<<8 | MODS_ONESHOT) #define ACTION_RMODS_TAP_KEY(mods, key) ACTION(ACT_RMODS_TAP, MODS4(mods)<<8 | (key)) #define ACTION_RMODS_ONESHOT(mods) ACTION(ACT_RMODS_TAP, MODS4(mods)<<8 | MODS_ONESHOT) -/* Mod + Tap key */ #define ACTION_LMOD_TAP_KEY(mod, key) ACTION(ACT_LMODS_TAP, MODS4(MOD_BIT(mod))<<8 | (key)) #define ACTION_LMOD_ONESHOT(mod) ACTION(ACT_LMODS_TAP, MODS4(MOD_BIT(mod))<<8 | MODS_ONESHOT) #define ACTION_RMOD_TAP_KEY(mod, key) ACTION(ACT_RMODS_TAP, MODS4(MOD_BIT(mod))<<8 | (key)) #define ACTION_RMOD_ONESHOT(mod) ACTION(ACT_RMODS_TAP, MODS4(MOD_BIT(mod))<<8 | MODS_ONESHOT) +/* HID Usage */ +enum usage_pages { + PAGE_SYSTEM, + PAGE_CONSUMER +}; +#define ACTION_USAGE_SYSTEM(id) ACTION(ACT_USAGE, PAGE_SYSTEM<<10 | (id)) +#define ACTION_USAGE_CONSUMER(id) ACTION(ACT_USAGE, PAGE_CONSUMER<<10 | (id)) + +/* Mousekey */ +#define ACTION_MOUSEKEY(key) ACTION(ACT_MOUSEKEY, key) -/* - * Switch layer + + +/* Layer Actions: + * Invert layer ^= (1<