#include "keycode.h"
-/* Execute action per keyevent */
-void action_exec(keyevent_t event);
-
-
/* Struct to record event and tap count */
typedef struct {
keyevent_t event;
/* 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?
uint16_t code;
struct action_kind {
uint16_t param :12;
- uint16_t id :4;
+ uint8_t id :4;
} kind;
struct action_key {
- uint16_t code :8;
- uint16_t mods :4;
- uint16_t kind :4;
+ uint8_t code :8;
+ uint8_t mods :4;
+ uint8_t kind :4;
} key;
struct action_layer {
- uint16_t code :8;
- uint16_t val :4;
- uint16_t kind :4;
+ uint8_t code :8;
+ uint8_t val :4;
+ uint8_t kind :4;
} layer;
struct action_usage {
uint16_t code :10;
- uint16_t page :2;
- uint16_t kind :4;
+ uint8_t page :2;
+ uint8_t kind :4;
} usage;
struct action_command {
- uint16_t id :8;
- uint16_t opt :4;
- uint16_t kind :4;
+ uint8_t id :8;
+ uint8_t opt :4;
+ uint8_t kind :4;
} command;
struct action_function {
uint8_t id :8;
} 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);
+
+/* user defined special function */
+void action_function(keyrecord_t *record, uint8_t id, uint8_t opt);
+
/*
* Utilities for actions.
*/
-
/*
* 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
--------------
-TODO: reconsider layer methods.
-1 momemtary + tap key up: L, down: default
-1 bitwise + tap key up: xor B, down: xor B
-3 momemtary go + tap key? up: X, down:
-3 toggle(mementary back) + tap key? up: down: Y
-3 no tap up: X, down: Y
-
-ACT_LAYER_PRESSED(1000): Set layer on key pressed
-ACT_LAYER_RELEASED(1001): Set layer on key released
-ACT_LAYER_BIT(1010): On/Off layer bit
-ACT_LAYER_EXT(1011): Extentions
-
-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 toggle
-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 toggle
-
-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 key
-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 key
-
-
-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
+ * -------------
+ * 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 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
+ * ----------
+ * ACT_MOUSEKEY(0110):
+ * 0101|XXXX| keycode Mouse key
+ *
+ *
+ * Layer Actions
+ * -------------
+ * ACT_KEYMAP:
+ * 1000|LLLL|0000 0000 Reset default layer
+ * 1000|LLLL|0000 00xx Reset default layer and clear overlay
+ * 1000|LLLL| keycode Invert with tap key
+ * 1000|LLLL|1111 0000 Invert with tap toggle
+ * 1000|LLLL|1111 00xx Invert[^= L]
+ * 1000|LLLL|1111 0100 On/Off
+ * 1000|LLLL|1111 01xx On[|= L]
+ * 1000|LLLL|1111 1000 Off/On
+ * 1000|LLLL|1111 10xx Off[&= ~L]
+ * 1000|LLLL|1111 1100 Set/Set(0)
+ * 1000|LLLL|1111 11xx Set[= L]
+ * default layer: 0-15(4bit)
+ * 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[= 1<<L]/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}
+ *
+ *
+ * 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?
+ *
*/
enum action_kind_id {
ACT_LMODS = 0b0000,
ACT_USAGE = 0b0100,
ACT_MOUSEKEY = 0b0101,
- ACT_LAYER_PRESSED = 0b1000,
- ACT_LAYER_RELEASED = 0b1001,
- ACT_LAYER_BIT = 0b1010,
- ACT_LAYER_EXT = 0b1011,
+ ACT_KEYMAP = 0b1000,
+ ACT_OVERLAY = 0b1001,
ACT_MACRO = 0b1100,
ACT_COMMAND = 0b1110,
ACT_FUNCTION = 0b1111
};
-enum params {
- P_ONESHOT = 0x00,
-};
-
-enum options {
- O_TAP = 0x8,
-};
-
/* action utility */
#define ACTION_NO 0
+#define ACTION_TRANSPARENT 1
#define ACTION(kind, param) ((kind)<<12 | (param))
#define MODS4(mods) (((mods)>>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,
+};
#define ACTION_LMODS_TAP_KEY(mods, key) ACTION(ACT_LMODS_TAP, MODS4(mods)<<8 | (key))
-#define ACTION_LMODS_ONESHOT(mods) ACTION(ACT_LMODS_TAP, MODS4(mods)<<8 | P_ONESHOT)
+#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 | P_ONESHOT)
-/* Mod + Tap key */
+#define ACTION_RMODS_ONESHOT(mods) ACTION(ACT_RMODS_TAP, MODS4(mods)<<8 | MODS_ONESHOT)
#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 | P_ONESHOT)
+#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 | P_ONESHOT)
-
-// TODO: contemplate about layer action
-/* Switch current layer */
-#define ACTION_LAYER_SET(layer) ACTION(ACT_LAYER_PRESSED, (layer)<<8 | 0x00)
-#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, (bits)<<8 | 0x00)
-#define ACTION_LAYER_SET_DEFAULT ACTION(ACT_LAYER_EXT, 0x0<<8 | 0x00)
-#define ACTION_LAYER_RETURN_DEFAULT ACTION(ACT_LAYER_EXT, 0x1<<8 | 0x00)
-#define ACTION_LAYER_SET_DEFAULT_ON_PRESSED ACTION(ACT_LAYER_EXT, 0x0<<8 | 0x00)
-#define ACTION_LAYER_SET_DEFAULT_ON_RELEASED ACTION(ACT_LAYER_EXT, 0x1<<8 | 0x00)
-/* Switch default layer */
-#define ACTION_LAYER_DEFAULT_SET(layer) ACTION(ACT_LAYER_PRESSED, (layer)<<8 | 0xFF)
-#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)
-/* Layer switch with tap key */
-#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, (bits)<<8 | (key))
-#define ACTION_LAYER_DEFAULT_SET_TAP_KEY(key) ACTION(ACT_LAYER_EXT, 0x0<<8 | (key))
-/* Layer switch with tap toggle */
-#define ACTION_LAYER_SET_ON_PRESSED_TAP_TOGGLE(layer) ACTION(ACT_LAYER_PRESSED, (layer)<<8 | 0xF0)
-#define ACTION_LAYER_SET_ON_RELEASED_TAP_TOGGLE(layer) ACTION(ACT_LAYER_RELEASED, (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)
-
-/* HID Usage */
-#define ACTION_USAGE_PAGE_SYSTEM 0
-#define ACTION_USAGE_PAGE_CONSUMER 1
-#define ACTION_USAGE_SYSTEM(id) ACTION(ACT_USAGE, ACTION_USAGE_PAGE_SYSTEM<<10 | (id))
-#define ACTION_USAGE_CONSUMER(id) ACTION(ACT_USAGE, ACTION_USAGE_PAGE_CONSUMER<<10 | (id))
+#define ACTION_RMOD_ONESHOT(mod) ACTION(ACT_RMODS_TAP, MODS4(MOD_BIT(mod))<<8 | MODS_ONESHOT)
+
+
+/* Layer Operation:
+ * Invert layer ^= (1<<layer)
+ * On layer |= (1<<layer)
+ * Off layer &= ~(1<<layer)
+ * Set layer = (1<<layer)
+ * Clear layer = 0
+ */
+enum layer_params {
+ ON_PRESS = 1,
+ ON_RELEASE = 2,
+ ON_BOTH = 3,
+
+ OP_RESET = 0x00,
+ OP_INV4 = 0x00,
+ OP_INV = 0xF0,
+ OP_ON = 0xF4,
+ OP_OFF = 0xF8,
+ OP_SET = 0xFC,
+};
+
+/*
+ * Default Layer
+ */
+#define ACTION_KEYMAP(layer) ACTION_KEYMAP_MOMENTARY(layer)
+#define ACTION_KEYMAP_MOMENTARY(layer) ACTION_KEYMAP_INV_B(layer)
+#define ACTION_KEYMAP_TOGGLE(layer) ACTION_KEYMAP_INV_R(layer)
+/* Set default layer */
+#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)
+/* Keymap Set and clear overaly */
+#define ACTION_KEYMAP_RESET(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_RESET | 0)
+#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_PRESS)
+#define ACTION_KEYMAP_RESET_B(layer) ACTION(ACT_KEYMAP, (layer)<<8 | OP_RESET | ON_PRESS)
+/* 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)
+/* 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)
+/* 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)
+/* 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)
+/* 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))
+
+
+/*
+ * 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)
#define ACTION_COMMAND(opt, id) 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, O_TAP<<8 | id)
+#define ACTION_FUNCTION_TAP(id) ACTION(ACT_FUNCTION, FUNC_TAP<<8 | id)
#endif /* ACTION_H */