[jackhill/qmk/firmware.git] / tmk_core / common / action_code.h

/*
Copyright 2013 Jun Wako <wakojun@gmail.com>

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 2 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef ACTION_CODE_H
#define ACTION_CODE_H

/* Action codes
 * ============
 * 16bit code: action_kind(4bit) + action_parameter(12bit)
 *
 *
 * Key Actions(00xx)
 * -----------------
 * ACT_MODS(000r):
 * 000r|0000|0000 0000    No action code
 * 000r|0000|0000 0001    Transparent code
 * 000r|0000| keycode     Key
 * 000r|mods|0000 0000    Modifiers
 * 000r|mods| keycode     Modifiers+Key(Modified key)
 *   r: Left/Right flag(Left:0, Right:1)
 *
 * ACT_MODS_TAP(001r):
 * 001r|mods|0000 0000    Modifiers with OneShot
 * 001r|mods|0000 0001    Modifiers with tap toggle
 * 001r|mods|0000 00xx    (reserved)
 * 001r|mods| keycode     Modifiers with Tap Key(Dual role)
 *
 *
 * Other Keys(01xx)
 * ----------------
 * ACT_USAGE(0100): TODO: Not needed?
 * 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(0101): TODO: Merge these two actions to conserve space?
 * 0101|xxxx| keycode     Mouse key
 *
 * ACT_SWAP_HANDS(0110):
 * 0110|xxxx| keycode     Swap hands (keycode on tap, or options)
 *
 *
 * 0111|xxxx xxxx xxxx    (reserved)
 *
 *
 * Layer Actions(10xx)
 * -------------------
 * ACT_LAYER(1000):
 * 1000|oo00|pppE BBBB   Default Layer Bitwise operation
 *   oo:    operation(00:AND, 01:OR, 10:XOR, 11:SET)
 *   ppp:   4-bit chunk part(0-7)
 *   EBBBB: bits and extra bit
 * 1000|ooee|pppE BBBB   Layer Bitwise Operation
 *   oo:    operation(00:AND, 01:OR, 10:XOR, 11:SET)
 *   ppp:   4-bit chunk part(0-7)
 *   EBBBB: bits and extra bit
 *   ee:    on event(01:press, 10:release, 11:both)
 *
 * 1001|xxxx|xxxx xxxx   (reserved)
 *
 * ACT_LAYER_TAP(101x):
 * 101E|LLLL| keycode    On/Off with tap key    (0x00-DF)[TAP]
 * 101E|LLLL|1110 mods   On/Off with modifiers  (0xE0-EF)[NOT TAP]
 * 101E|LLLL|1111 0000   Invert with tap toggle (0xF0)   [TAP]
 * 101E|LLLL|1111 0001   On/Off                 (0xF1)   [NOT TAP]
 * 101E|LLLL|1111 0010   Off/On                 (0xF2)   [NOT TAP]
 * 101E|LLLL|1111 0011   Set/Clear              (0xF3)   [NOT TAP]
 * 101E|LLLL|1111 0100   One Shot Layer         (0xF4)   [TAP]
 * 101E|LLLL|1111 xxxx   Reserved               (0xF5-FF)
 *   ELLLL: layer 0-31(E: extra bit for layer 16-31)
 *
 *
 * Extensions(11xx)
 * ----------------
 * ACT_MACRO(1100):
 * 1100|opt | id(8)      Macro play?
 * 1100|1111| id(8)      Macro record?
 *
 * ACT_BACKLIGHT(1101):
 * 1101|opt |level(8)    Backlight commands
 *
 * 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 {
    /* Key Actions */
    ACT_MODS            = 0b0000,
    ACT_LMODS           = 0b0000,
    ACT_RMODS           = 0b0001,
    ACT_MODS_TAP        = 0b0010,
    ACT_LMODS_TAP       = 0b0010,
    ACT_RMODS_TAP       = 0b0011,
    /* Other Keys */
    ACT_USAGE           = 0b0100,
    ACT_MOUSEKEY        = 0b0101,
    /* One-hand Support */
    ACT_SWAP_HANDS      = 0b0110,
    /* Layer Actions */
    ACT_LAYER           = 0b1000,
    ACT_LAYER_TAP       = 0b1010, /* Layer  0-15 */
    ACT_LAYER_TAP_EXT   = 0b1011, /* Layer 16-31 */
    /* Extensions */
    ACT_MACRO           = 0b1100,
    ACT_BACKLIGHT       = 0b1101,
    ACT_COMMAND         = 0b1110,
    ACT_FUNCTION        = 0b1111
};


/* Action Code Struct
 *
 * NOTE:
 * In avr-gcc bit field seems to be assigned from LSB(bit0) to MSB(bit15).
 * AVR looks like a little endian in avr-gcc.
 * Not portable across compiler/endianness?
 *
 * Byte order and bit order of 0x1234:
 *   Big endian:                Little endian:
 *   --------------------       --------------------
 *   FEDC BA98  7654 3210       0123 4567  89AB CDEF
 *   0001 0010  0011 0100       0010 1100  0100 1000
 *     0x12       0x34            0x34       0x12
 */
typedef union {
    uint16_t code;
    struct action_kind {
        uint16_t param  :12;
        uint8_t  id     :4;
    } kind;
    struct action_key {
        uint8_t  code   :8;
        uint8_t  mods   :4;
        uint8_t  kind   :4;
    } key;
    struct action_layer_bitop {
        uint8_t  bits   :4;
        uint8_t  xbit   :1;
        uint8_t  part   :3;
        uint8_t  on     :2;
        uint8_t  op     :2;
        uint8_t  kind   :4;
    } layer_bitop;
    struct action_layer_tap {
        uint8_t  code   :8;
        uint8_t  val    :5;
        uint8_t  kind   :3;
    } layer_tap;
    struct action_usage {
        uint16_t code   :10;
        uint8_t  page   :2;
        uint8_t  kind   :4;
    } usage;
    struct action_backlight {
        uint8_t  level  :8;
        uint8_t  opt    :4;
        uint8_t  kind   :4;
    } backlight;
    struct action_command {
        uint8_t  id     :8;
        uint8_t  opt    :4;
        uint8_t  kind   :4;
    } command;
    struct action_function {
        uint8_t  id     :8;
        uint8_t  opt    :4;
        uint8_t  kind   :4;
    } func;
    struct action_swap {
        uint8_t  code   :8;
        uint8_t  opt   :4;
        uint8_t  kind   :4;
    } swap;
} action_t;


/* action utility */
#define ACTION_NO                       0
#define ACTION_TRANSPARENT              1
#define ACTION(kind, param)             ((kind)<<12 | (param))


/*
 * Key Actions
 */
/* Mod bits:    43210
 *   bit 0      ||||+- Control
 *   bit 1      |||+-- Shift
 *   bit 2      ||+--- Alt
 *   bit 3      |+---- Gui
 *   bit 4      +----- LR flag(Left:0, Right:1)
 */
enum mods_bit {
    MOD_LCTL = 0x01,
    MOD_LSFT = 0x02,
    MOD_LALT = 0x04,
    MOD_LGUI = 0x08,
    MOD_RCTL = 0x11,
    MOD_RSFT = 0x12,
    MOD_RALT = 0x14,
    MOD_RGUI = 0x18,
};
enum mods_codes {
    MODS_ONESHOT = 0x00,
    MODS_TAP_TOGGLE = 0x01,
};
#define ACTION_KEY(key)                 ACTION(ACT_MODS, (key))
#define ACTION_MODS(mods)               ACTION(ACT_MODS, ((mods)&0x1f)<<8 | 0)
#define ACTION_MODS_KEY(mods, key)      ACTION(ACT_MODS, ((mods)&0x1f)<<8 | (key))
#define ACTION_MODS_TAP_KEY(mods, key)  ACTION(ACT_MODS_TAP, ((mods)&0x1f)<<8 | (key))
#define ACTION_MODS_ONESHOT(mods)       ACTION(ACT_MODS_TAP, ((mods)&0x1f)<<8 | MODS_ONESHOT)
#define ACTION_MODS_TAP_TOGGLE(mods)    ACTION(ACT_MODS_TAP, ((mods)&0x1f)<<8 | MODS_TAP_TOGGLE)


/*
 * Other Keys
 */
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))
#define ACTION_MOUSEKEY(key)            ACTION(ACT_MOUSEKEY, key)


/* 
 * Layer Actions
 */
enum layer_param_on {
    ON_PRESS    = 1,
    ON_RELEASE  = 2,
    ON_BOTH     = 3,
};
enum layer_param_bit_op {
    OP_BIT_AND = 0,
    OP_BIT_OR  = 1,
    OP_BIT_XOR = 2,
    OP_BIT_SET = 3,
};
enum layer_pram_tap_op {
    OP_TAP_TOGGLE = 0xF0,
    OP_ON_OFF,
    OP_OFF_ON,
    OP_SET_CLEAR,
    OP_ONESHOT,
};
#define ACTION_LAYER_BITOP(op, part, bits, on)      (ACT_LAYER<<12 | (op)<<10 | (on)<<8 | (part)<<5 | ((bits)&0x1f))
#define ACTION_LAYER_TAP(layer, key)                (ACT_LAYER_TAP<<12 | (layer)<<8 | (key))
/* Default Layer */
#define ACTION_DEFAULT_LAYER_SET(layer)             ACTION_DEFAULT_LAYER_BIT_SET((layer)/4, 1<<((layer)%4))
/* Layer Operation */
#define ACTION_LAYER_CLEAR(on)                      ACTION_LAYER_BIT_AND(0, 0, (on))
#define ACTION_LAYER_MOMENTARY(layer)               ACTION_LAYER_ON_OFF(layer)
#define ACTION_LAYER_TOGGLE(layer)                  ACTION_LAYER_INVERT(layer, ON_RELEASE)
#define ACTION_LAYER_INVERT(layer, on)              ACTION_LAYER_BIT_XOR((layer)/4,   1<<((layer)%4),  (on))
#define ACTION_LAYER_ON(layer, on)                  ACTION_LAYER_BIT_OR( (layer)/4,   1<<((layer)%4),  (on))
#define ACTION_LAYER_OFF(layer, on)                 ACTION_LAYER_BIT_AND((layer)/4, ~(1<<((layer)%4)), (on))
#define ACTION_LAYER_SET(layer, on)                 ACTION_LAYER_BIT_SET((layer)/4,   1<<((layer)%4),  (on))
#define ACTION_LAYER_ON_OFF(layer)                  ACTION_LAYER_TAP((layer), OP_ON_OFF)
#define ACTION_LAYER_OFF_ON(layer)                  ACTION_LAYER_TAP((layer), OP_OFF_ON)
#define ACTION_LAYER_SET_CLEAR(layer)               ACTION_LAYER_TAP((layer), OP_SET_CLEAR)
#define ACTION_LAYER_ONESHOT(layer)                 ACTION_LAYER_TAP((layer), OP_ONESHOT)
#define ACTION_LAYER_MODS(layer, mods)              ACTION_LAYER_TAP((layer), 0xe0 | ((mods)&0x0f))
/* With Tapping */
#define ACTION_LAYER_TAP_KEY(layer, key)            ACTION_LAYER_TAP((layer), (key))
#define ACTION_LAYER_TAP_TOGGLE(layer)              ACTION_LAYER_TAP((layer), OP_TAP_TOGGLE)
/* Bitwise Operation */
#define ACTION_LAYER_BIT_AND(part, bits, on)        ACTION_LAYER_BITOP(OP_BIT_AND, (part), (bits), (on))
#define ACTION_LAYER_BIT_OR( part, bits, on)        ACTION_LAYER_BITOP(OP_BIT_OR,  (part), (bits), (on))
#define ACTION_LAYER_BIT_XOR(part, bits, on)        ACTION_LAYER_BITOP(OP_BIT_XOR, (part), (bits), (on))
#define ACTION_LAYER_BIT_SET(part, bits, on)        ACTION_LAYER_BITOP(OP_BIT_SET, (part), (bits), (on))
/* Default Layer Bitwise Operation */
#define ACTION_DEFAULT_LAYER_BIT_AND(part, bits)    ACTION_LAYER_BITOP(OP_BIT_AND, (part), (bits), 0)
#define ACTION_DEFAULT_LAYER_BIT_OR( part, bits)    ACTION_LAYER_BITOP(OP_BIT_OR,  (part), (bits), 0)
#define ACTION_DEFAULT_LAYER_BIT_XOR(part, bits)    ACTION_LAYER_BITOP(OP_BIT_XOR, (part), (bits), 0)
#define ACTION_DEFAULT_LAYER_BIT_SET(part, bits)    ACTION_LAYER_BITOP(OP_BIT_SET, (part), (bits), 0)


/*
 * Extensions
 */
enum backlight_opt {
    BACKLIGHT_INCREASE = 0,
    BACKLIGHT_DECREASE = 1,
    BACKLIGHT_TOGGLE   = 2,
    BACKLIGHT_STEP     = 3,
    BACKLIGHT_ON       = 4,
    BACKLIGHT_OFF      = 5,
};

/* Macro */
#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))
/* Backlight */
#define ACTION_BACKLIGHT_INCREASE()     ACTION(ACT_BACKLIGHT, BACKLIGHT_INCREASE << 8)
#define ACTION_BACKLIGHT_DECREASE()     ACTION(ACT_BACKLIGHT, BACKLIGHT_DECREASE << 8)
#define ACTION_BACKLIGHT_TOGGLE()       ACTION(ACT_BACKLIGHT, BACKLIGHT_TOGGLE << 8)
#define ACTION_BACKLIGHT_STEP()         ACTION(ACT_BACKLIGHT, BACKLIGHT_STEP << 8)
#define ACTION_BACKLIGHT_ON()           ACTION(ACT_BACKLIGHT, BACKLIGHT_ON << 8)
#define ACTION_BACKLIGHT_OFF()          ACTION(ACT_BACKLIGHT, BACKLIGHT_OFF << 8)
/* Command */
#define ACTION_COMMAND(id, opt)         ACTION(ACT_COMMAND,  (opt)<<8 | (id))
/* Function */
enum function_opts {
    FUNC_TAP = 0x8,     /* indciates function is tappable */
};
#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))
/* OneHand Support */
enum swap_hands_pram_tap_op {
    OP_SH_TOGGLE = 0xF0,
    OP_SH_TAP_TOGGLE,
    OP_SH_ON_OFF,
    OP_SH_OFF_ON,
    OP_SH_OFF,
    OP_SH_ON,
};

#define ACTION_SWAP_HANDS()             ACTION_SWAP_HANDS_ON_OFF()
#define ACTION_SWAP_HANDS_TOGGLE()      ACTION(ACT_SWAP_HANDS, OP_SH_TOGGLE)
#define ACTION_SWAP_HANDS_TAP_TOGGLE()  ACTION(ACT_SWAP_HANDS, OP_SH_TAP_TOGGLE)
#define ACTION_SWAP_HANDS_TAP_KEY(key)  ACTION(ACT_SWAP_HANDS, key)
#define ACTION_SWAP_HANDS_ON_OFF()      ACTION(ACT_SWAP_HANDS, OP_SH_ON_OFF)
#define ACTION_SWAP_HANDS_OFF_ON()      ACTION(ACT_SWAP_HANDS, OP_SH_OFF_ON)
#define ACTION_SWAP_HANDS_ON()          ACTION(ACT_SWAP_HANDS, OP_SH_ON)
#define ACTION_SWAP_HANDS_OFF()         ACTION(ACT_SWAP_HANDS, OP_SH_OFF)

#endif /* ACTION_CODE_H */
Commit	Line	Data
a074364c	1	/*
	2	Copyright 2013 Jun Wako <wakojun@gmail.com>
	3
	4	This program is free software: you can redistribute it and/or modify
	5	it under the terms of the GNU General Public License as published by
	6	the Free Software Foundation, either version 2 of the License, or
	7	(at your option) any later version.
	8
	9	This program is distributed in the hope that it will be useful,
	10	but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	GNU General Public License for more details.
	13
	14	You should have received a copy of the GNU General Public License
	15	along with this program. If not, see <http://www.gnu.org/licenses/>.
	16	*/
	17	#ifndef ACTION_CODE_H
	18	#define ACTION_CODE_H
	19
	20	/* Action codes
	21	* ============
	22	* 16bit code: action_kind(4bit) + action_parameter(12bit)
	23	*
	24	*
	25	* Key Actions(00xx)
	26	* -----------------
	27	* ACT_MODS(000r):
	28	* 000r\|0000\|0000 0000 No action code
	29	* 000r\|0000\|0000 0001 Transparent code
	30	* 000r\|0000\| keycode Key
	31	* 000r\|mods\|0000 0000 Modifiers
	32	* 000r\|mods\| keycode Modifiers+Key(Modified key)
	33	* r: Left/Right flag(Left:0, Right:1)
	34	*
	35	* ACT_MODS_TAP(001r):
	36	* 001r\|mods\|0000 0000 Modifiers with OneShot
	37	* 001r\|mods\|0000 0001 Modifiers with tap toggle
	38	* 001r\|mods\|0000 00xx (reserved)
	39	* 001r\|mods\| keycode Modifiers with Tap Key(Dual role)
	40	*
	41	*
	42	* Other Keys(01xx)
	43	* ----------------
	44	* ACT_USAGE(0100): TODO: Not needed?
	45	* 0100\|00\| usage(10) System control(0x80) - General Desktop page(0x01)
	46	* 0100\|01\| usage(10) Consumer control(0x01) - Consumer page(0x0C)
	47	* 0100\|10\| usage(10) (reserved)
	48	* 0100\|11\| usage(10) (reserved)
	49	*
87bc3625 LS	50	*
87bc3625 LS	51	* ACT_MOUSEKEY(0101): TODO: Merge these two actions to conserve space?
a074364c	52	* 0101\|xxxx\| keycode Mouse key
a074364c	53	*
87bc3625 LS	54	* ACT_SWAP_HANDS(0110):
	55	* 0110\|xxxx\| keycode Swap hands (keycode on tap, or options)
	56	*
	57	*
	58	* 0111\|xxxx xxxx xxxx (reserved)
a074364c	59	*
	60	*
	61	* Layer Actions(10xx)
	62	* -------------------
	63	* ACT_LAYER(1000):
	64	* 1000\|oo00\|pppE BBBB Default Layer Bitwise operation
	65	* oo: operation(00:AND, 01:OR, 10:XOR, 11:SET)
	66	* ppp: 4-bit chunk part(0-7)
	67	* EBBBB: bits and extra bit
	68	* 1000\|ooee\|pppE BBBB Layer Bitwise Operation
	69	* oo: operation(00:AND, 01:OR, 10:XOR, 11:SET)
	70	* ppp: 4-bit chunk part(0-7)
	71	* EBBBB: bits and extra bit
	72	* ee: on event(01:press, 10:release, 11:both)
	73	*
	74	* 1001\|xxxx\|xxxx xxxx (reserved)
a074364c	75	*
a074364c	76	* ACT_LAYER_TAP(101x):
1f4a22ee JW	77	* 101E\|LLLL\| keycode On/Off with tap key (0x00-DF)[TAP]
	78	* 101E\|LLLL\|1110 mods On/Off with modifiers (0xE0-EF)[NOT TAP]
	79	* 101E\|LLLL\|1111 0000 Invert with tap toggle (0xF0) [TAP]
	80	* 101E\|LLLL\|1111 0001 On/Off (0xF1) [NOT TAP]
	81	* 101E\|LLLL\|1111 0010 Off/On (0xF2) [NOT TAP]
	82	* 101E\|LLLL\|1111 0011 Set/Clear (0xF3) [NOT TAP]
74e97eef TA	83	* 101E\|LLLL\|1111 0100 One Shot Layer (0xF4) [TAP]
74e97eef TA	84	* 101E\|LLLL\|1111 xxxx Reserved (0xF5-FF)
a074364c	85	* ELLLL: layer 0-31(E: extra bit for layer 16-31)
	86	*
	87	*
	88	* Extensions(11xx)
	89	* ----------------
	90	* ACT_MACRO(1100):
	91	* 1100\|opt \| id(8) Macro play?
	92	* 1100\|1111\| id(8) Macro record?
	93	*
	94	* ACT_BACKLIGHT(1101):
	95	* 1101\|opt \|level(8) Backlight commands
	96	*
	97	* ACT_COMMAND(1110):
	98	* 1110\|opt \| id(8) Built-in Command exec
	99	*
	100	* ACT_FUNCTION(1111):
	101	* 1111\| address(12) Function?
	102	* 1111\|opt \| id(8) Function?
	103	*/
	104	enum action_kind_id {
	105	/* Key Actions */
	106	ACT_MODS = 0b0000,
	107	ACT_LMODS = 0b0000,
	108	ACT_RMODS = 0b0001,
	109	ACT_MODS_TAP = 0b0010,
	110	ACT_LMODS_TAP = 0b0010,
	111	ACT_RMODS_TAP = 0b0011,
	112	/* Other Keys */
	113	ACT_USAGE = 0b0100,
	114	ACT_MOUSEKEY = 0b0101,
8090f6b4 JW	115	/* One-hand Support */
8090f6b4 JW	116	ACT_SWAP_HANDS = 0b0110,
a074364c	117	/* Layer Actions */
	118	ACT_LAYER = 0b1000,
	119	ACT_LAYER_TAP = 0b1010, /* Layer 0-15 */
	120	ACT_LAYER_TAP_EXT = 0b1011, /* Layer 16-31 */
	121	/* Extensions */
	122	ACT_MACRO = 0b1100,
	123	ACT_BACKLIGHT = 0b1101,
	124	ACT_COMMAND = 0b1110,
	125	ACT_FUNCTION = 0b1111
	126	};
	127
	128
	129	/* Action Code Struct
	130	*
	131	* NOTE:
	132	* In avr-gcc bit field seems to be assigned from LSB(bit0) to MSB(bit15).
	133	* AVR looks like a little endian in avr-gcc.
	134	* Not portable across compiler/endianness?
	135	*
	136	* Byte order and bit order of 0x1234:
	137	* Big endian: Little endian:
	138	* -------------------- --------------------
	139	* FEDC BA98 7654 3210 0123 4567 89AB CDEF
	140	* 0001 0010 0011 0100 0010 1100 0100 1000
	141	* 0x12 0x34 0x34 0x12
	142	*/
	143	typedef union {
	144	uint16_t code;
	145	struct action_kind {
	146	uint16_t param :12;
	147	uint8_t id :4;
	148	} kind;
	149	struct action_key {
	150	uint8_t code :8;
	151	uint8_t mods :4;
	152	uint8_t kind :4;
	153	} key;
	154	struct action_layer_bitop {
	155	uint8_t bits :4;
	156	uint8_t xbit :1;
	157	uint8_t part :3;
	158	uint8_t on :2;
	159	uint8_t op :2;
	160	uint8_t kind :4;
	161	} layer_bitop;
	162	struct action_layer_tap {
	163	uint8_t code :8;
	164	uint8_t val :5;
	165	uint8_t kind :3;
	166	} layer_tap;
	167	struct action_usage {
	168	uint16_t code :10;
	169	uint8_t page :2;
	170	uint8_t kind :4;
	171	} usage;
	172	struct action_backlight {
	173	uint8_t level :8;
	174	uint8_t opt :4;
	175	uint8_t kind :4;
	176	} backlight;
	177	struct action_command {
	178	uint8_t id :8;
	179	uint8_t opt :4;
	180	uint8_t kind :4;
181	} command;
182	struct action_function {
183	uint8_t id :8;
184	uint8_t opt :4;
185	uint8_t kind :4;
186	} func;
8090f6b4 JW	187	struct action_swap {
	188	uint8_t code :8;
	189	uint8_t opt :4;
	190	uint8_t kind :4;
	191	} swap;
a074364c	192	} action_t;
	193
	194
	195	/* action utility */
	196	#define ACTION_NO 0
	197	#define ACTION_TRANSPARENT 1
	198	#define ACTION(kind, param) ((kind)<<12 \| (param))
	199
	200
	201	/*
	202	* Key Actions
	203	*/
	204	/* Mod bits: 43210
	205	* bit 0 \|\|\|\|+- Control
	206	* bit 1 \|\|\|+-- Shift
	207	* bit 2 \|\|+--- Alt
	208	* bit 3 \|+---- Gui
	209	* bit 4 +----- LR flag(Left:0, Right:1)
	210	*/
	211	enum mods_bit {
	212	MOD_LCTL = 0x01,
	213	MOD_LSFT = 0x02,
	214	MOD_LALT = 0x04,
	215	MOD_LGUI = 0x08,
	216	MOD_RCTL = 0x11,
	217	MOD_RSFT = 0x12,
	218	MOD_RALT = 0x14,
	219	MOD_RGUI = 0x18,
	220	};
	221	enum mods_codes {
	222	MODS_ONESHOT = 0x00,
	223	MODS_TAP_TOGGLE = 0x01,
	224	};
	225	#define ACTION_KEY(key) ACTION(ACT_MODS, (key))
	226	#define ACTION_MODS(mods) ACTION(ACT_MODS, ((mods)&0x1f)<<8 \| 0)
	227	#define ACTION_MODS_KEY(mods, key) ACTION(ACT_MODS, ((mods)&0x1f)<<8 \| (key))
	228	#define ACTION_MODS_TAP_KEY(mods, key) ACTION(ACT_MODS_TAP, ((mods)&0x1f)<<8 \| (key))
	229	#define ACTION_MODS_ONESHOT(mods) ACTION(ACT_MODS_TAP, ((mods)&0x1f)<<8 \| MODS_ONESHOT)
	230	#define ACTION_MODS_TAP_TOGGLE(mods) ACTION(ACT_MODS_TAP, ((mods)&0x1f)<<8 \| MODS_TAP_TOGGLE)
	231
	232
	233	/*
	234	* Other Keys
	235	*/
	236	enum usage_pages {
	237	PAGE_SYSTEM,
	238	PAGE_CONSUMER
	239	};
	240	#define ACTION_USAGE_SYSTEM(id) ACTION(ACT_USAGE, PAGE_SYSTEM<<10 \| (id))
	241	#define ACTION_USAGE_CONSUMER(id) ACTION(ACT_USAGE, PAGE_CONSUMER<<10 \| (id))
	242	#define ACTION_MOUSEKEY(key) ACTION(ACT_MOUSEKEY, key)
	243
	244
	245
	246	/*
	247	* Layer Actions
	248	*/
	249	enum layer_param_on {
	250	ON_PRESS = 1,
	251	ON_RELEASE = 2,
	252	ON_BOTH = 3,
	253	};
	254	enum layer_param_bit_op {
	255	OP_BIT_AND = 0,
256	OP_BIT_OR = 1,
257	OP_BIT_XOR = 2,
258	OP_BIT_SET = 3,
259	};
260	enum layer_pram_tap_op {
261	OP_TAP_TOGGLE = 0xF0,
262	OP_ON_OFF,
263	OP_OFF_ON,
264	OP_SET_CLEAR,
74e97eef	265	OP_ONESHOT,
a074364c	266	};
	267	#define ACTION_LAYER_BITOP(op, part, bits, on) (ACT_LAYER<<12 \| (op)<<10 \| (on)<<8 \| (part)<<5 \| ((bits)&0x1f))
	268	#define ACTION_LAYER_TAP(layer, key) (ACT_LAYER_TAP<<12 \| (layer)<<8 \| (key))
	269	/* Default Layer */
	270	#define ACTION_DEFAULT_LAYER_SET(layer) ACTION_DEFAULT_LAYER_BIT_SET((layer)/4, 1<<((layer)%4))
	271	/* Layer Operation */
	272	#define ACTION_LAYER_CLEAR(on) ACTION_LAYER_BIT_AND(0, 0, (on))
	273	#define ACTION_LAYER_MOMENTARY(layer) ACTION_LAYER_ON_OFF(layer)
	274	#define ACTION_LAYER_TOGGLE(layer) ACTION_LAYER_INVERT(layer, ON_RELEASE)
	275	#define ACTION_LAYER_INVERT(layer, on) ACTION_LAYER_BIT_XOR((layer)/4, 1<<((layer)%4), (on))
	276	#define ACTION_LAYER_ON(layer, on) ACTION_LAYER_BIT_OR( (layer)/4, 1<<((layer)%4), (on))
	277	#define ACTION_LAYER_OFF(layer, on) ACTION_LAYER_BIT_AND((layer)/4, ~(1<<((layer)%4)), (on))
	278	#define ACTION_LAYER_SET(layer, on) ACTION_LAYER_BIT_SET((layer)/4, 1<<((layer)%4), (on))
	279	#define ACTION_LAYER_ON_OFF(layer) ACTION_LAYER_TAP((layer), OP_ON_OFF)
	280	#define ACTION_LAYER_OFF_ON(layer) ACTION_LAYER_TAP((layer), OP_OFF_ON)
	281	#define ACTION_LAYER_SET_CLEAR(layer) ACTION_LAYER_TAP((layer), OP_SET_CLEAR)
74e97eef	282	#define ACTION_LAYER_ONESHOT(layer) ACTION_LAYER_TAP((layer), OP_ONESHOT)
a8d4daa7	283	#define ACTION_LAYER_MODS(layer, mods) ACTION_LAYER_TAP((layer), 0xe0 \| ((mods)&0x0f))
a074364c	284	/* With Tapping */
	285	#define ACTION_LAYER_TAP_KEY(layer, key) ACTION_LAYER_TAP((layer), (key))
	286	#define ACTION_LAYER_TAP_TOGGLE(layer) ACTION_LAYER_TAP((layer), OP_TAP_TOGGLE)
	287	/* Bitwise Operation */
	288	#define ACTION_LAYER_BIT_AND(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_AND, (part), (bits), (on))
	289	#define ACTION_LAYER_BIT_OR( part, bits, on) ACTION_LAYER_BITOP(OP_BIT_OR, (part), (bits), (on))
	290	#define ACTION_LAYER_BIT_XOR(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_XOR, (part), (bits), (on))
	291	#define ACTION_LAYER_BIT_SET(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_SET, (part), (bits), (on))
	292	/* Default Layer Bitwise Operation */
	293	#define ACTION_DEFAULT_LAYER_BIT_AND(part, bits) ACTION_LAYER_BITOP(OP_BIT_AND, (part), (bits), 0)
	294	#define ACTION_DEFAULT_LAYER_BIT_OR( part, bits) ACTION_LAYER_BITOP(OP_BIT_OR, (part), (bits), 0)
	295	#define ACTION_DEFAULT_LAYER_BIT_XOR(part, bits) ACTION_LAYER_BITOP(OP_BIT_XOR, (part), (bits), 0)
	296	#define ACTION_DEFAULT_LAYER_BIT_SET(part, bits) ACTION_LAYER_BITOP(OP_BIT_SET, (part), (bits), 0)
	297
	298
	299	/*
	300	* Extensions
	301	*/
	302	enum backlight_opt {
	303	BACKLIGHT_INCREASE = 0,
	304	BACKLIGHT_DECREASE = 1,
	305	BACKLIGHT_TOGGLE = 2,
	306	BACKLIGHT_STEP = 3,
4931510a BG	307	BACKLIGHT_ON = 4,
4931510a BG	308	BACKLIGHT_OFF = 5,
a074364c	309	};
dd378601	310
a074364c	311	/* Macro */
	312	#define ACTION_MACRO(id) ACTION(ACT_MACRO, (id))
	313	#define ACTION_MACRO_TAP(id) ACTION(ACT_MACRO, FUNC_TAP<<8 \| (id))
	314	#define ACTION_MACRO_OPT(id, opt) ACTION(ACT_MACRO, (opt)<<8 \| (id))
	315	/* Backlight */
	316	#define ACTION_BACKLIGHT_INCREASE() ACTION(ACT_BACKLIGHT, BACKLIGHT_INCREASE << 8)
	317	#define ACTION_BACKLIGHT_DECREASE() ACTION(ACT_BACKLIGHT, BACKLIGHT_DECREASE << 8)
	318	#define ACTION_BACKLIGHT_TOGGLE() ACTION(ACT_BACKLIGHT, BACKLIGHT_TOGGLE << 8)
	319	#define ACTION_BACKLIGHT_STEP() ACTION(ACT_BACKLIGHT, BACKLIGHT_STEP << 8)
4931510a BG	320	#define ACTION_BACKLIGHT_ON() ACTION(ACT_BACKLIGHT, BACKLIGHT_ON << 8)
4931510a BG	321	#define ACTION_BACKLIGHT_OFF() ACTION(ACT_BACKLIGHT, BACKLIGHT_OFF << 8)
a074364c	322	/* Command */
dd378601	323	#define ACTION_COMMAND(id, opt) ACTION(ACT_COMMAND, (opt)<<8 \| (id))
a074364c	324	/* Function */
	325	enum function_opts {
	326	FUNC_TAP = 0x8, /* indciates function is tappable */
	327	};
	328	#define ACTION_FUNCTION(id) ACTION(ACT_FUNCTION, (id))
	329	#define ACTION_FUNCTION_TAP(id) ACTION(ACT_FUNCTION, FUNC_TAP<<8 \| (id))
	330	#define ACTION_FUNCTION_OPT(id, opt) ACTION(ACT_FUNCTION, (opt)<<8 \| (id))
dd378601	331	/* OneHand Support */
8090f6b4 JW	332	enum swap_hands_pram_tap_op {
	333	OP_SH_TOGGLE = 0xF0,
	334	OP_SH_TAP_TOGGLE,
	335	OP_SH_ON_OFF,
	336	OP_SH_OFF_ON,
	337	OP_SH_OFF,
	338	OP_SH_ON,
	339	};
	340
	341	#define ACTION_SWAP_HANDS() ACTION_SWAP_HANDS_ON_OFF()
	342	#define ACTION_SWAP_HANDS_TOGGLE() ACTION(ACT_SWAP_HANDS, OP_SH_TOGGLE)
	343	#define ACTION_SWAP_HANDS_TAP_TOGGLE() ACTION(ACT_SWAP_HANDS, OP_SH_TAP_TOGGLE)
	344	#define ACTION_SWAP_HANDS_TAP_KEY(key) ACTION(ACT_SWAP_HANDS, key)
	345	#define ACTION_SWAP_HANDS_ON_OFF() ACTION(ACT_SWAP_HANDS, OP_SH_ON_OFF)
	346	#define ACTION_SWAP_HANDS_OFF_ON() ACTION(ACT_SWAP_HANDS, OP_SH_OFF_ON)
	347	#define ACTION_SWAP_HANDS_ON() ACTION(ACT_SWAP_HANDS, OP_SH_ON)
	348	#define ACTION_SWAP_HANDS_OFF() ACTION(ACT_SWAP_HANDS, OP_SH_OFF)
a074364c	349
a074364c	350	#endif /* ACTION_CODE_H */