#ifndef ACTION_H
#define ACTION_H
+#include <stdint.h>
+#include <stdbool.h>
#include "keyboard.h"
#include "keycode.h"
+#include "action_macro.h"
-/* Struct to record event and tap count */
typedef struct {
keyevent_t event;
- uint8_t tap_count;
+#ifndef NO_ACTION_TAPPING
+ /* tapping count and state */
+ struct {
+ bool interrupted :1;
+ bool reserved2 :1;
+ bool reserved1 :1;
+ bool reserved0 :1;
+ uint8_t count :4;
+ } tap;
+#endif
} keyrecord_t;
/* Action struct.
} key;
struct action_layer {
uint8_t code :8;
- uint8_t val :4;
- uint8_t kind :4;
+ uint8_t val :5;
+ uint8_t kind :3;
} layer;
struct action_usage {
uint16_t code :10;
/* 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.
- */
+/* Utilities for actions. */
+void process_action(keyrecord_t *record);
void register_code(uint8_t code);
void unregister_code(uint8_t code);
void add_mods(uint8_t mods);
bool sending_anykey(void);
void layer_switch(uint8_t new_layer);
bool is_tap_key(key_t key);
-bool waiting_buffer_has_anykey_pressed(void);
+
+/* debug */
+void debug_event(keyevent_t event);
+void debug_record(keyrecord_t record);
+void debug_action(action_t action);
* ============
* 16bit code: action_kind(4bit) + action_parameter(12bit)
*
- * Keyboard Keys
- * -------------
+ * Keyboard Keys(00XX)
+ * -------------------
* ACT_LMODS(0000):
* 0000|0000|000000|00 No action
* 0000|0000|000000|01 Transparent
* 0011|mods| keycode Right mods + tap Key
*
*
- * Other HID Usage
- * ---------------
+ * 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|10| usage(10) (reserved)
* 0100|11| usage(10) (reserved)
*
- *
- * Mouse Keys
- * ----------
* ACT_MOUSEKEY(0110):
* 0101|XXXX| keycode Mouse key
*
*
- * Layer Actions
- * -------------
- * 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<<L]
- * 1000|LLLL|1111 0100 On/Off
- * 1000|LLLL|1111 01xx On[|= 1<<L]
- * 1000|LLLL|1111 1000 Off/On
- * 1000|LLLL|1111 10xx Off[&= ~(1<<L)]
- * 1000|LLLL|1111 1100 Set/Clear
- * 1000|LLLL|1111 11xx Set[= 1<<L]
- * default layer: 0-15(4bit)
+ * Layer Actions(10XX)
+ * -------------------
+ * ACT_LAYER:
+ * 1000|--xx|0000 0000 Clear keyamp
+ * 100X|LLLL|0000 00xx Reset default layer and clear keymap
+ * 100X|LLLL| keycode Invert with tap key
+ * 100X|LLLL|1111 0000 Invert with tap toggle
+ * 100X|LLLL|1111 00xx Invert[^= 1<<L]
+ * 100X|LLLL|1111 0100 On/Off
+ * 100X|LLLL|1111 01xx On[|= 1<<L]
+ * 100X|LLLL|1111 1000 Off/On
+ * 100X|LLLL|1111 10xx Off[&= ~(1<<L)]
+ * 100X|LLLL|1111 1100 Set/Clear
+ * 100X|LLLL|1111 11xx Set[= 1<<L]
+ * XLLLL: Layer 0-31
* xx: On {00:for special use, 01:press, 10:release, 11:both}
*
- * ACT_OVERLAY:
- * 1011|0000|0000 0000 Clear overlay
- * 1011|LLLL|0000 00ss Invert 4-bit chunk [^= L<<(4*ss)]
- * 1011|LLLL| keycode Invert with tap key
- * 1011|LLLL|1111 0000 Invert with tap toggle
- * 1011|LLLL|1111 00xx Invert[^= 1<<L]
- * 1011|LLLL|1111 0100 On/Off(momentary)
- * 1011|LLLL|1111 01xx On[|= 1<<L]
- * 1011|LLLL|1111 1000 Off/On
- * 1011|LLLL|1111 10xx Off[&= ~(1<<L)]
- * 1011|LLLL|1111 1100 Set/Clear
- * 1011|LLLL|1111 11xx Set[= 1<<L]
- * overlays: 16-layer on/off status(16bit)
- * xx: On {00:for special use, 01:press, 10:release, 11:both}
+ * ACT_LAYER_BITOP:
+ * 101B|Booo|xxxx xxxx bit operation
+ * BB: operand. which part of layer state bits
+ * 00: 0-7th bit
+ * 01: 8-15th bit
+ * 10: 16-23th bit
+ * 11: 24-31th bit
+ * ooo: operation.
+ * 000: AND
+ * 001: OR
+ * 010: XOR
+ * 011:
+ * 100: LSHIFT
+ * 101: RSHIFT
+ * 110:
+ * 111:
+ * bbbb bbbb: bits
+ * layer_state |= (((layer_state>>(0bBB*8)) & 0xff) BITOP 0bxxxxxxxx)<<(0bBB*8)
+ * layer_state: 32-bit layer switch state
+ *
+ *
*
*
* Extensions(11XX)
* ----------------
- * NOTE: NOT FIXED
- *
* ACT_MACRO(1100):
* 1100|opt | id(8) Macro play?
* 1100|1111| id(8) Macro record?
*
*/
enum action_kind_id {
+ ACT_MODS = 0b0000,
ACT_LMODS = 0b0000,
ACT_RMODS = 0b0001,
+ ACT_MODS_TAP = 0b0010,
ACT_LMODS_TAP = 0b0010,
ACT_RMODS_TAP = 0b0011,
ACT_USAGE = 0b0100,
ACT_MOUSEKEY = 0b0101,
- ACT_KEYMAP = 0b1000,
- ACT_OVERLAY = 0b1001,
+ ACT_LAYER = 0b1000,
+ ACT_LAYER1 = 0b1001,
+ ACT_LAYER_BITOP = 0b1010,
+ ACT_LAYER1_BITOP = 0b1011,
ACT_MACRO = 0b1100,
ACT_COMMAND = 0b1110,
#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)
+
+
-/* Layer Operation:
+/* Layer Actions:
* Invert layer ^= (1<<layer)
* On layer |= (1<<layer)
* Off layer &= ~(1<<layer)
* Set layer = (1<<layer)
* Clear layer = 0
*/
-enum layer_params {
+enum layer_param_on {
ON_PRESS = 1,
ON_RELEASE = 2,
ON_BOTH = 3,
+};
- OP_RESET = 0x00,
+enum layer_pram_op {
+ OP_RESET = 0x00,
OP_INV4 = 0x00,
OP_INV = 0xF0,
OP_ON = 0xF4,
OP_SET = 0xFC,
};
+enum layer_pram_bitop {
+ BITOP_AND,
+ BITOP_OR,
+ BITOP_XOR,
+ BITOP_LSHIFT,
+ BITOP_RSHIFT,
+};
+
/*
* Default Layer
*/
-#define ACTION_DEFAULT_LAYER ACTION(ACT_KEYMAP, 0<<8 | OP_RESET | 0)
-#define ACTION_SET_DEFAULT_LAYER(layer) ACTION_KEYMAP_RESET(layer)
-#define ACTION_SET_DEFAULT_LAYER_P(layer) ACTION_KEYMAP_RESET_P(layer)
-#define ACTION_SET_DEFAULT_LAYER_R(layer) ACTION_KEYMAP_RESET_R(layer)
-#define ACTION_SET_DEFAULT_LAYER_B(layer) ACTION_KEYMAP_RESET_B(layer)
+#define ACTION_DEFAULT_LAYER ACTION(ACT_LAYER, ON_RELEASE<<8 | OP_RESET | 0)
+#define ACTION_DEFAULT_LAYER_SET(layer) ACTION_DEFAULT_LAYER_TO(layer, ON_RELEASE)
+#define ACTION_DEFAULT_LAYER_TO(layer, on) ACTION(ACT_LAYER, (layer)<<8 | OP_RESET | (on))
+
/*
* Keymap Layer
*/
-#define ACTION_KEYMAP(layer) ACTION_KEYMAP_MOMENTARY(layer)
-#define ACTION_KEYMAP_MOMENTARY(layer) ACTION_KEYMAP_ON_OFF(layer)
-#define ACTION_KEYMAP_TOGGLE(layer) ACTION_KEYMAP_INV_R(layer)
-/* Keymap Set and clear overaly */
-#define ACTION_KEYMAP_RESET(layer) ACTION_KEYMAP_RESET_R(layer)
-#define ACTION_KEYMAP_RESET_P(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_RESET | ON_PRESS)
-#define ACTION_KEYMAP_RESET_R(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_RESET | ON_RELEASE)
-#define ACTION_KEYMAP_RESET_B(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_RESET | ON_BOTH)
+#define ACTION_LAYER_MOMENTARY(layer) ACTION_LAYER_ON_OFF(layer)
+#define ACTION_LAYER_TOGGLE(layer) ACTION_LAYER_INV(layer, ON_RELEASE)
/* Keymap Invert */
-#define ACTION_KEYMAP_INV(layer) ACTION_KEYMAP_INV_B(layer)
-#define ACTION_KEYMAP_TAP_TOGGLE(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_INV | 0)
-#define ACTION_KEYMAP_INV_P(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_INV | ON_PRESS)
-#define ACTION_KEYMAP_INV_R(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_INV | ON_RELEASE)
-#define ACTION_KEYMAP_INV_B(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_INV | ON_BOTH)
+#define ACTION_LAYER_INV(layer, on) ACTION(ACT_LAYER, (layer)<<8 | OP_INV | (on))
+#define ACTION_LAYER_TAP_TOGGLE(layer) ACTION(ACT_LAYER, (layer)<<8 | OP_INV | 0)
/* Keymap On */
-#define ACTION_KEYMAP_ON(layer) ACTION_KEYMAP_ON_OFF(layer)
-#define ACTION_KEYMAP_ON_OFF(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_ON | 0)
-#define ACTION_KEYMAP_ON_P(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_ON | ON_PRESS)
-#define ACTION_KEYMAP_ON_R(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_ON | ON_RELEASE)
-#define ACTION_KEYMAP_ON_B(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_ON | ON_BOTH)
+#define ACTION_LAYER_ON(layer, on) ACTION(ACT_LAYER, (layer)<<8 | OP_ON | (on))
+#define ACTION_LAYER_ON_OFF(layer) ACTION(ACT_LAYER, (layer)<<8 | OP_ON | 0)
/* Keymap Off */
-#define ACTION_KEYMAP_OFF(layer) ACTION_KEYMAP_OFF_ON(layer)
-#define ACTION_KEYMAP_OFF_ON(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_OFF | 0)
-#define ACTION_KEYMAP_OFF_P(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_OFF | ON_PRESS)
-#define ACTION_KEYMAP_OFF_R(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_OFF | ON_RELEASE)
-#define ACTION_KEYMAP_OFF_B(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_OFF | ON_BOTH)
+#define ACTION_LAYER_OFF(layer, on) ACTION(ACT_LAYER, (layer)<<8 | OP_OFF | (on))
+#define ACTION_LAYER_OFF_ON(layer) ACTION(ACT_LAYER, (layer)<<8 | OP_OFF | 0)
/* Keymap Set */
-#define ACTION_KEYMAP_SET(layer) ACTION_KEYMAP_SET_CLEAR(layer)
-#define ACTION_KEYMAP_SET_CLEAR(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_SET | 0)
-#define ACTION_KEYMAP_SET_P(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_SET | ON_PRESS)
-#define ACTION_KEYMAP_SET_R(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_SET | ON_RELEASE)
-#define ACTION_KEYMAP_SET_B(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_SET | ON_BOTH)
+#define ACTION_LAYER_SET(layer, on) ACTION(ACT_LAYER, (layer)<<8 | OP_SET | (on))
+#define ACTION_LAYER_SET_CLEAR(layer) ACTION(ACT_LAYER, (layer)<<8 | OP_SET | 0)
/* Keymap Invert with tap key */
-#define ACTION_KEYMAP_TAP_KEY(layer, key) ACTION(ACT_KEYMAP, (layer)<<8 | (key))
-
-/*
- * Overlay Layer
- */
-#define ACTION_OVERLAY(layer) ACTION_OVERLAY_MOMENTARY(layer)
-#define ACTION_OVERLAY_MOMENTARY(layer) ACTION_OVERLAY_ON_OFF(layer)
-#define ACTION_OVERLAY_TOGGLE(layer) ACTION_OVERLAY_INV_R(layer)
-/* Overlay Clear */
-#define ACTION_OVERLAY_CLEAR ACTION(ACT_OVERLAY, 0<<8 | OP_INV4 | 0)
-#define ACTION_OVERLAY_CLEAR_P ACTION(ACT_OVERLAY, 0<<8 | OP_INV4 | ON_PRESS)
-#define ACTION_OVERLAY_CLEAR_R ACTION(ACT_OVERLAY, 0<<8 | OP_INV4 | ON_RELEASE)
-#define ACTION_OVERLAY_CLEAR_B ACTION(ACT_OVERLAY, 0<<8 | OP_INV4 | ON_BOTH)
-/* Overlay Invert 4-bit chunk */
-#define ACTION_OVERLAY_INV4(bits, shift) ACTION(ACT_OVERLAY, (bits)<<8 | OP_INV4 | shift)
-/* Overlay Invert */
-#define ACTION_OVERLAY_INV(layer) ACTION_OVERLAY_INV_B(layer)
-#define ACTION_OVERLAY_TAP_TOGGLE(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_INV | 0)
-#define ACTION_OVERLAY_INV_P(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_INV | ON_PRESS)
-#define ACTION_OVERLAY_INV_R(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_INV | ON_RELEASE)
-#define ACTION_OVERLAY_INV_B(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_INV | ON_BOTH)
-/* Overlay On */
-#define ACTION_OVERLAY_ON(layer) ACTION_OVERLAY_ON_OFF(layer)
-#define ACTION_OVERLAY_ON_OFF(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_ON | 0)
-#define ACTION_OVERLAY_ON_P(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_ON | ON_PRESS)
-#define ACTION_OVERLAY_ON_R(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_ON | ON_RELEASE)
-#define ACTION_OVERLAY_ON_B(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_ON | ON_BOTH)
-/* Overlay Off */
-#define ACTION_OVERLAY_OFF(layer) ACTION_OVERLAY_OFF_ON(layer)
-#define ACTION_OVERLAY_OFF_ON(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_OFF | 0)
-#define ACTION_OVERLAY_OFF_P(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_OFF | ON_PRESS)
-#define ACTION_OVERLAY_OFF_R(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_OFF | ON_RELEASE)
-#define ACTION_OVERLAY_OFF_B(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_OFF | ON_BOTH)
-/* Overlay Set */
-#define ACTION_OVERLAY_SET(layer) ACTION_OVERLAY_SET_CLEAR(layer)
-#define ACTION_OVERLAY_SET_CLEAR(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_SET | 0)
-#define ACTION_OVERLAY_SET_P(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_SET | ON_PRESS)
-#define ACTION_OVERLAY_SET_R(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_SET | ON_RELEASE)
-#define ACTION_OVERLAY_SET_B(layer) ACTION(ACT_OVERLAY, (layer)<<8 | OP_SET | ON_BOTH)
-/* Overlay Invert with tap key */
-#define ACTION_OVERLAY_TAP_KEY(layer, key) ACTION(ACT_OVERLAY, (layer)<<8 | (key))
+#define ACTION_LAYER_TAP_KEY(layer, key) ACTION(ACT_LAYER, (layer)<<8 | (key))
+/* Layer BitOp: 101|BB|ooo|xxxxxxxx */
+#define ACTION_LAYER_BITOP(op, part, bits) (ACT_LAYER_BITOP<<12 | (part&0x3)<<11 | (op&0x7)<<8 | bits)
+#define ACTION_LAYER_AND(part, bits) ACTION_LAYER_BITOP(BITOP_AND, part, bits)
+#define ACTION_LAYER_OR(part, bits) ACTION_LAYER_BITOP(BITOP_OR, part, bits)
+#define ACTION_LAYER_XOR(part, bits) ACTION_LAYER_BITOP(BITOP_XOR, part, bits)
+#define ACTION_LAYER_LSHIFT(part, bits) ACTION_LAYER_BITOP(BITOP_LSHIFT, part, bits)
+#define ACTION_LAYER_RSHIFT(part, bits) ACTION_LAYER_BITOP(BITOP_RSHIFT, part, bits)
+
/*
- * HID Usage
+ * Extensions
*/
-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)
-
/* Macro */
-#define ACTION_MACRO(opt, id) ACTION(ACT_FUNCTION, (opt)<<8 | (addr))
+#define ACTION_MACRO(id) ACTION(ACT_MACRO, (id))
+#define ACTION_MACRO_TAP(id) ACTION(ACT_MACRO, FUNC_TAP<<8 | (id))
+#define ACTION_MACRO_OPT(id, opt) ACTION(ACT_MACRO, (opt)<<8 | (id))
/* Command */
-#define ACTION_COMMAND(opt, id) ACTION(ACT_COMMAND, (opt)<<8 | (addr))
+#define ACTION_COMMAND(id, opt) ACTION(ACT_COMMAND, (opt)<<8 | (addr))
/* Function */
enum function_opts {
FUNC_TAP = 0x8, /* indciates function is tappable */
};
-#define ACTION_FUNCTION(id, opt) ACTION(ACT_FUNCTION, (opt)<<8 | id)
-#define ACTION_FUNCTION_TAP(id) ACTION(ACT_FUNCTION, FUNC_TAP<<8 | id)
+#define ACTION_FUNCTION(id) ACTION(ACT_FUNCTION, (id))
+#define ACTION_FUNCTION_TAP(id) ACTION(ACT_FUNCTION, FUNC_TAP<<8 | (id))
+#define ACTION_FUNCTION_OPT(id, opt) ACTION(ACT_FUNCTION, (opt)<<8 | (id))
#endif /* ACTION_H */
projects / tmk_firmware.git / blobdiff