#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?
} action_t;
+
+/* layer used currently */
+extern uint8_t current_layer;
+/* layer to return or start with */
+extern uint8_t default_layer;
+
+/* 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
--------------
-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
+ * -------------
+ * 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
+ * ----------
+ * 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
+ * 1000|LLLL|0000 0000 set current layer on press and return to default on release(momentary)
+ * 1000|LLLL|0000 0001 set current layer on press
+ * 1000|LLLL|0000 0010 set current layer on release
+ * 1000|LLLL|0000 0011 set current layer on both
+ * 1000|LLLL| keycode set current layer on hold and send key on tap
+ * 1000|LLLL|1111 0000 set current layer on hold and toggle on several taps
+ * 1000|DDDD|1111 1111 set default layer on press
+ * L: 0 means default layer
+ *
+ * ACT_LAYER_BIT(1001): Bit-op layer
+ * 1001|BBBB|0000 0000 bit-on current layer on press and bit-off on release(momentary)
+ * 1001|BBBB|0000 0001 bit-xor current layer on press
+ * 1001|BBBB|0000 0010 bit-xor current layer on release
+ * 1001|BBBB|0000 0011 bit-xor current layer on both
+ * 1001|BBBB| keycode bit-xor current layer on hold and send key on tap
+ * 1001|BBBB|1111 0000 bit-xor current layer on hold and toggle on several taps
+ * 1001|BBBB|1111 1111 bit-xor default layer on both
+ *
+ * ACT_LAYER_SWITCH: Switch
+ * 1011|LLLL|0000 0000 On on press and Off on release(momentary)
+ * 1011|LLLL|0000 0001 Invert on press
+ * 1011|LLLL|0000 0010 Invert on release
+ * 1011|LLLL|0000 0011 Invert on both
+ * 1011|LLLL| keycode Invert on hold and send key on tap
+ * 1011|LLLL|1111 0000 Invert on hold and toggle on several taps
+ * 1011|LLLL|1111 1111 (not used)
+ *
+ *
+ * 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_LAYER = 0b1000,
ACT_LAYER_BIT = 0b1001,
+ ACT_LAYER_SWITCH = 0b1011,
ACT_MACRO = 0b1100,
ACT_COMMAND = 0b1110,
/* 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_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)
-/*
- * Switch layer
+/*
+ * Layer switching
*/
enum layer_codes {
LAYER_MOMENTARY = 0,
LAYER_ON_PRESS = 1,
LAYER_ON_RELEASE = 2,
- LAYER_DEFAULT =3,
+ LAYER_ON_BOTH =3,
LAYER_TAP_TOGGLE = 0xF0,
- LAYER_CHANGE_DEFAULT = 0xFF
-};
-enum layer_vals_default {
- DEFAULT_ON_PRESS = 1,
- DEFAULT_ON_RELEASE = 2,
- DEFAULT_ON_BOTH = 3,
+ LAYER_SET_DEFAULT_ON_PRESS = 0xFD,
+ LAYER_SET_DEFAULT_ON_RELEASE = 0xFE,
+ LAYER_SET_DEFAULT_ON_BOTH = 0xFF
};
-
-/*
- * return to default layer
+/*
+ * Default layer
+ */
+/* set default layer */
+#define ACTION_LAYER_SET_DEFAULT(layer) ACTION_LAYER_SET_DEFAULT_R(layer)
+#define ACTION_LAYER_SET_DEFAULT_P(layer) ACTION(ACT_LAYER, (layer)<<8 | LAYER_SET_DEFAULT_ON_PRESS)
+#define ACTION_LAYER_SET_DEFAULT_R(layer) ACTION(ACT_LAYER, (layer)<<8 | LAYER_SET_DEFAULT_ON_RELEASE)
+#define ACTION_LAYER_SET_DEFAULT_B(layer) ACTION(ACT_LAYER, (layer)<<8 | LAYER_SET_DEFAULT_ON_BOTH)
+/* bit-xor default layer */
+#define ACTION_LAYER_BIT_DEFAULT(bits) ACTION_LAYER_BIT_DEFAULT_R(bits)
+#define ACTION_LAYER_BIT_DEFAULT_P(bits) ACTION(ACT_LAYER, (bits)<<8 | LAYER_SET_DEFAULT_ON_PRESS)
+#define ACTION_LAYER_BIT_DEFAULT_R(bits) ACTION(ACT_LAYER, (bits)<<8 | LAYER_SET_DEFAULT_ON_RELEASE)
+#define ACTION_LAYER_BIT_DEFAULT_B(bits) ACTION(ACT_LAYER, (bits)<<8 | LAYER_SET_DEFAULT_ON_BOTH)
+/*
+ * Current layer: Return to default layer
*/
#define ACTION_LAYER_DEFAULT ACTION_LAYER_DEFAULT_R
-/* set default layer on press */
-#define ACTION_LAYER_DEFAULT_P ACTION(ACT_LAYER, DEFAULT_ON_PRESS<<8 | LAYER_DEFAULT)
-/* set default layer on release */
-#define ACTION_LAYER_DEFAULT_R ACTION(ACT_LAYER, DEFAULT_ON_RELEASE<<8 | LAYER_DEFAULT)
-/* change default layer and set layer */
-
+#define ACTION_LAYER_DEFAULT_P ACTION_LAYER_SET_P(0)
+#define ACTION_LAYER_DEFAULT_R ACTION_LAYER_SET_R(0)
+#define ACTION_LAYER_DEFAULT_B ACTION_LAYER_SET_B(0)
/*
- * Set layer
+ * Current layer: Set
*/
-/* set layer on press and set default on release */
-#define ACTION_LAYER_SET(layer) ACTION_LAYER_SET_MOMENTARY(layer)
+#define ACTION_LAYER_SET(layer) ACTION_LAYER_SET_P(layer)
#define ACTION_LAYER_SET_MOMENTARY(layer) ACTION(ACT_LAYER, (layer)<<8 | LAYER_MOMENTARY)
-/* set layer on press and none on release */
#define ACTION_LAYER_SET_TOGGLE(layer) ACTION_LAYER_SET_R(layer)
-/* set layer while hold and send key on tap */
-#define ACTION_LAYER_SET_TAP_KEY(layer, key) ACTION(ACT_LAYER, (layer)<<8 | (key))
-/* set layer on press */
#define ACTION_LAYER_SET_P(layer) ACTION(ACT_LAYER, (layer)<<8 | LAYER_ON_PRESS)
-/* set layer on release */
#define ACTION_LAYER_SET_R(layer) ACTION(ACT_LAYER, (layer)<<8 | LAYER_ON_RELEASE)
-/* set layer on hold and toggle on several taps */
+#define ACTION_LAYER_SET_B(layer) ACTION(ACT_LAYER, (layer)<<8 | LAYER_ON_BOTH)
#define ACTION_LAYER_SET_TAP_TOGGLE(layer) ACTION(ACT_LAYER, (layer)<<8 | LAYER_TAP_TOGGLE)
-/* set default layer on both press and release */
-#define ACTION_LAYER_SET_DEFAULT(layer) ACTION(ACT_LAYER, (layer)<<8 | LAYER_CHANGE_DEFAULT)
-
-/*
- * Bit-op layer
+#define ACTION_LAYER_SET_TAP_KEY(layer, key) ACTION(ACT_LAYER, (layer)<<8 | (key))
+/*
+ * Current layer: Bit-op
*/
-/* bit-xor on both press and release */
#define ACTION_LAYER_BIT(bits) ACTION_LAYER_BIT_MOMENTARY(bits)
#define ACTION_LAYER_BIT_MOMENTARY(bits) ACTION(ACT_LAYER_BIT, (bits)<<8 | LAYER_MOMENTARY)
-/* bit-xor on press */
#define ACTION_LAYER_BIT_TOGGLE(bits) ACTION_LAYER_BIT_R(bits)
-/* bit-xor while hold and send key on tap */
-#define ACTION_LAYER_BIT_TAP_KEY(bits, key) ACTION(ACT_LAYER_BIT, (bits)<<8 | (key))
-/* bit-xor on press */
#define ACTION_LAYER_BIT_P(bits) ACTION(ACT_LAYER_BIT, (bits)<<8 | LAYER_ON_PRESS)
-/* bit-xor on release */
#define ACTION_LAYER_BIT_R(bits) ACTION(ACT_LAYER_BIT, (bits)<<8 | LAYER_ON_RELEASE)
-/* bit-xor while hold and toggle on several taps */
+#define ACTION_LAYER_BIT_B(bits) ACTION(ACT_LAYER_BIT, (bits)<<8 | LAYER_ON_BOTH)
#define ACTION_LAYER_BIT_TAP_TOGGLE(bits) ACTION(ACT_LAYER_BIT, (bits)<<8 | LAYER_TAP_TOGGLE)
-/* bit-xor default layer and set layer */
-#define ACTION_LAYER_BIT_DEFAULT(bits) ACTION(ACT_LAYER, (bits)<<8 | LAYER_CHANGE_DEFAULT)
+#define ACTION_LAYER_BIT_TAP_KEY(bits, key) ACTION(ACT_LAYER_BIT, (bits)<<8 | (key))
+/*
+ * Layer SWITCH
+ */
+/* momentary */
+#define ACTION_LAYER_SWITCH(layer) ACTION_LAYER_SWITCH_MOMENTARY(layer)
+#define ACTION_LAYER_SWITCH_MOMENTARY(layer) ACTION(ACT_LAYER_SWITCH, (layer)<<8 | LAYER_MOMENTARY)
+#define ACTION_LAYER_SWITCH_TOGGLE(layer) ACTION_LAYER_SWITCH_R(layer)
+#define ACTION_LAYER_SWITCH_P(layer) ACTION(ACT_LAYER_SWITCH, (layer)<<8 | LAYER_ON_PRESS)
+#define ACTION_LAYER_SWITCH_R(layer) ACTION(ACT_LAYER_SWITCH, (layer)<<8 | LAYER_ON_RELEASE)
+#define ACTION_LAYER_SWITCH_B(layer) ACTION(ACT_LAYER_SWITCH, (layer)<<8 | LAYER_ON_BOTH)
+#define ACTION_LAYER_SWITCH_TAP_TOGGLE(layer) ACTION(ACT_LAYER_SWITCH, (layer)<<8 | LAYER_TAP_TOGGLE)
+#define ACTION_LAYER_SWITCH_TAP_KEY(layer, key) ACTION(ACT_LAYER_SWITCH, (layer)<<8 | (key))
-/* HID Usage */
+/*
+ * HID Usage
+ */
enum usage_pages {
PAGE_SYSTEM,
PAGE_CONSUMER
projects / tmk_firmware.git / blobdiff