tmk_core/common/action_code.h

   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[TAP]
  37  * 001r|mods|0000 0001    Modifiers with tap toggle[TAP]
  38  * 001r|mods|0000 00xx    (reserved)            (0x02-03)
  39  * 001r|mods| keycode     Modifiers with tap key[TAP]
  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  *
  50  * ACT_MOUSEKEY(0101): TODO: Not needed?
  51  * 0101|xxxx| keycode     Mouse key
  52  *
  53  * 011x|xxxx xxxx xxxx    (reseved)
  54  *
  55  *
  56  * Layer Actions(10xx)
  57  * -------------------
  58  * ACT_LAYER(1000):
  59  * 1000|oo00|pppE BBBB   Default Layer Bitwise operation
  60  *   oo:    operation(00:AND, 01:OR, 10:XOR, 11:SET)
  61  *   ppp:   4-bit chunk part(0-7)
  62  *   EBBBB: bits and extra bit
  63  * 1000|ooee|pppE BBBB   Layer Bitwise Operation
  64  *   oo:    operation(00:AND, 01:OR, 10:XOR, 11:SET)
  65  *   ppp:   4-bit chunk part(0-7)
  66  *   EBBBB: bits and extra bit
  67  *   ee:    on event(01:press, 10:release, 11:both)
  68  *
  69  * 1001|xxxx|xxxx xxxx   (reserved)
  70  * 1001|oopp|BBBB BBBB   8-bit Bitwise Operation???
  71  *
  72  * ACT_LAYER_TAP(101x):
  73  * 101E|LLLL| keycode    On/Off with tap key    [TAP]
  74  * 101E|LLLL|110r mods   On/Off with modifiers  (0xC0-DF)[NOT TAP]
  75  *                       r: Left/Right flag(Left:0, Right:1)
  76  * 101E|LLLL|1111 0000   Invert with tap toggle (0xF0)   [TAP]
  77  * 101E|LLLL|1111 0001   On/Off                 (0xF1)   [NOT TAP]
  78  * 101E|LLLL|1111 0010   Off/On                 (0xF2)   [NOT TAP]
  79  * 101E|LLLL|1111 0011   Set/Clear              (0xF3)   [NOT TAP]
  80  * 101E|LLLL|1111 xxxx   (reserved)             (0xF4-FF)
  81  *   ELLLL: layer 0-31(E: extra bit for layer 16-31)
  82  *
  83  *
  84  * Extensions(11xx)
  85  * ----------------
  86  * ACT_MACRO(1100):
  87  * 1100|opt | id(8)      Macro play?
  88  * 1100|1111| id(8)      Macro record?
  89  *
  90  * ACT_BACKLIGHT(1101):
  91  * 1101|opt |level(8)    Backlight commands
  92  *
  93  * ACT_COMMAND(1110):
  94  * 1110|opt | id(8)      Built-in Command exec
  95  *
  96  * ACT_FUNCTION(1111):
  97  * 1111| address(12)     Function?
  98  * 1111|opt | id(8)      Function?
  99  */
 100 enum action_kind_id {
 101     /* Key Actions */
 102     ACT_MODS            = 0b0000,
 103     ACT_LMODS           = 0b0000,
 104     ACT_RMODS           = 0b0001,
 105     ACT_MODS_TAP        = 0b0010,
 106     ACT_LMODS_TAP       = 0b0010,
 107     ACT_RMODS_TAP       = 0b0011,
 108     /* Other Keys */
 109     ACT_USAGE           = 0b0100,
 110     ACT_MOUSEKEY        = 0b0101,
 111     /* Layer Actions */
 112     ACT_LAYER           = 0b1000,
 113     ACT_LAYER_TAP       = 0b1010, /* Layer  0-15 */
 114     ACT_LAYER_TAP_EXT   = 0b1011, /* Layer 16-31 */
 115     /* Extensions */
 116     ACT_MACRO           = 0b1100,
 117     ACT_BACKLIGHT       = 0b1101,
 118     ACT_COMMAND         = 0b1110,
 119     ACT_FUNCTION        = 0b1111
 120 };
 121
 122
 123 /* Action Code Struct
 124  *
 125  * NOTE:
 126  * In avr-gcc bit field seems to be assigned from LSB(bit0) to MSB(bit15).
 127  * AVR looks like a little endian in avr-gcc.
 128  * Not portable across compiler/endianness?
 129  *
 130  * Byte order and bit order of 0x1234:
 131  *   Big endian:                Little endian:
 132  *   --------------------       --------------------
 133  *   FEDC BA98  7654 3210       0123 4567  89AB CDEF
 134  *   0001 0010  0011 0100       0010 1100  0100 1000
 135  *     0x12       0x34            0x34       0x12
 136  */
 137 typedef union {
 138     uint16_t code;
 139     struct action_kind {
 140         uint16_t param  :12;
 141         uint8_t  id     :4;
 142     } kind;
 143     struct action_key {
 144         uint8_t  code   :8;
 145         uint8_t  mods   :4;
 146         uint8_t  kind   :4;
 147     } key;
 148     struct action_layer_bitop {
 149         uint8_t  bits   :4;
 150         uint8_t  xbit   :1;
 151         uint8_t  part   :3;
 152         uint8_t  on     :2;
 153         uint8_t  op     :2;
 154         uint8_t  kind   :4;
 155     } layer_bitop;
 156     struct action_layer_tap {
 157         uint8_t  code   :8;
 158         uint8_t  val    :5;
 159         uint8_t  kind   :3;
 160     } layer_tap;
 161     struct action_usage {
 162         uint16_t code   :10;
 163         uint8_t  page   :2;
 164         uint8_t  kind   :4;
 165     } usage;
 166     struct action_backlight {
 167         uint8_t  level  :8;
 168         uint8_t  opt    :4;
 169         uint8_t  kind   :4;
 170     } backlight;
 171     struct action_command {
 172         uint8_t  id     :8;
 173         uint8_t  opt    :4;
 174         uint8_t  kind   :4;
 175     } command;
 176     struct action_function {
 177         uint8_t  id     :8;
 178         uint8_t  opt    :4;
 179         uint8_t  kind   :4;
 180     } func;
 181 } action_t;
 182
 183
 184 /* action utility */
 185 #define ACTION_NO                       { .code = 0 }
 186 #define ACTION_TRANSPARENT              { .code = 1 }
 187 #define ACTION(kind, param)             { .code = ((kind)<<12 | (param)) }
 188
 189
 190 /*
 191  * Key Actions
 192  */
 193 /* Mod bits:    43210
 194  *   bit 0      ||||+- Control
 195  *   bit 1      |||+-- Shift
 196  *   bit 2      ||+--- Alt
 197  *   bit 3      |+---- Gui
 198  *   bit 4      +----- LR flag(Left:0, Right:1)
 199  */
 200 enum mods_bit {
 201     MOD_NONE = 0x0000,
 202     MOD_LCTL = 0x0100,
 203     MOD_LSFT = 0x0200,
 204     MOD_LALT = 0x0400,
 205     MOD_LGUI = 0x0800,
 206     MOD_RCTL = 0x1100,
 207     MOD_RSFT = 0x1200,
 208     MOD_RALT = 0x1400,
 209     MOD_RGUI = 0x1800,
 210 };
 211 enum mods_codes {
 212     MODS_ONESHOT = 0x00,
 213     MODS_TAP_TOGGLE = 0x01,
 214 };
 215 #define ACTION_KEY(key)                 ACTION(ACT_MODS, (key))
 216 #define ACTION_MODS(mods)               ACTION(ACT_MODS, ((mods)&0x1f00) | 0)
 217 #define ACTION_MODS_KEY(mods, key)      ACTION(ACT_MODS, ((mods)&0x1f00) | (key))
 218 #define ACTION_MODS_TAP_KEY(mods, key)  ACTION(ACT_MODS_TAP, ((mods)&0x1f00) | (key))
 219 #define ACTION_MODS_ONESHOT(mods)       ACTION(ACT_MODS_TAP, ((mods)&0x1f00) | MODS_ONESHOT)
 220 #define ACTION_MODS_TAP_TOGGLE(mods)    ACTION(ACT_MODS_TAP, ((mods)&0x1f00) | MODS_TAP_TOGGLE)
 221
 222
 223 /*
 224  * Other Keys
 225  */
 226 enum usage_pages {
 227     PAGE_SYSTEM,
 228     PAGE_CONSUMER
 229 };
 230 #define ACTION_USAGE_SYSTEM(id)         ACTION(ACT_USAGE, PAGE_SYSTEM<<10 | (id))
 231 #define ACTION_USAGE_CONSUMER(id)       ACTION(ACT_USAGE, PAGE_CONSUMER<<10 | (id))
 232 #define ACTION_MOUSEKEY(key)            ACTION(ACT_MOUSEKEY, key)
 233
 234
 235
 236 /*
 237  * Layer Actions
 238  */
 239 enum layer_param_on {
 240     ON_PRESS    = 1,
 241     ON_RELEASE  = 2,
 242     ON_BOTH     = 3,
 243 };
 244 enum layer_param_bit_op {
 245     OP_BIT_AND = 0,
 246     OP_BIT_OR  = 1,
 247     OP_BIT_XOR = 2,
 248     OP_BIT_SET = 3,
 249 };
 250 enum layer_pram_tap_op {
 251     OP_TAP_TOGGLE = 0xF0,
 252     OP_ON_OFF,
 253     OP_OFF_ON,
 254     OP_SET_CLEAR,
 255 };
 256 #define ACTION_LAYER_BITOP(op, part, bits, on)      ACTION(ACT_LAYER, (op)<<10 | (on)<<8 | (part)<<5 | ((bits)&0x1f))
 257 #define ACTION_LAYER_TAP(layer, key)                ACTION(ACT_LAYER_TAP, (layer)<<8 | (key))
 258 /* Default Layer */
 259 #define ACTION_DEFAULT_LAYER_SET(layer)             ACTION_DEFAULT_LAYER_BIT_SET((layer)/4, 1<<((layer)%4))
 260 #define ACTION_DEFAULT_LAYER_TOGGLE(layer)          ACTION_DEFAULT_LAYER_BIT_XOR((layer)/4, 1<<((layer)%4))
 261 /* Layer Operation */
 262 #define ACTION_LAYER_CLEAR(on)                      ACTION_LAYER_BIT_AND(0, 0, (on))
 263 #define ACTION_LAYER_MOMENTARY(layer)               ACTION_LAYER_ON_OFF(layer)
 264 #define ACTION_LAYER_TOGGLE(layer)                  ACTION_LAYER_INVERT(layer, ON_RELEASE)
 265 #define ACTION_LAYER_INVERT(layer, on)              ACTION_LAYER_BIT_XOR((layer)/4,   1<<((layer)%4),  (on))
 266 #define ACTION_LAYER_ON(layer, on)                  ACTION_LAYER_BIT_OR( (layer)/4,   1<<((layer)%4),  (on))
 267 #define ACTION_LAYER_OFF(layer, on)                 ACTION_LAYER_BIT_AND((layer)/4, ~(1<<((layer)%4)), (on))
 268 #define ACTION_LAYER_SET(layer, on)                 ACTION_LAYER_BIT_SET((layer)/4,   1<<((layer)%4),  (on))
 269 #define ACTION_LAYER_ON_OFF(layer)                  ACTION_LAYER_TAP((layer), OP_ON_OFF)
 270 #define ACTION_LAYER_OFF_ON(layer)                  ACTION_LAYER_TAP((layer), OP_OFF_ON)
 271 #define ACTION_LAYER_SET_CLEAR(layer)               ACTION_LAYER_TAP((layer), OP_SET_CLEAR)
 272 #define ACTION_LAYER_MODS(layer, mods)              ACTION_LAYER_TAP((layer), 0xc0 | ((mods>>8)&0x1f))
 273 /* With Tapping */
 274 #define ACTION_LAYER_TAP_KEY(layer, key)            ACTION_LAYER_TAP((layer), (key))
 275 #define ACTION_LAYER_TAP_TOGGLE(layer)              ACTION_LAYER_TAP((layer), OP_TAP_TOGGLE)
 276 /* Bitwise Operation */
 277 #define ACTION_LAYER_BIT_AND(part, bits, on)        ACTION_LAYER_BITOP(OP_BIT_AND, (part), (bits), (on))
 278 #define ACTION_LAYER_BIT_OR( part, bits, on)        ACTION_LAYER_BITOP(OP_BIT_OR,  (part), (bits), (on))
 279 #define ACTION_LAYER_BIT_XOR(part, bits, on)        ACTION_LAYER_BITOP(OP_BIT_XOR, (part), (bits), (on))
 280 #define ACTION_LAYER_BIT_SET(part, bits, on)        ACTION_LAYER_BITOP(OP_BIT_SET, (part), (bits), (on))
 281 /* Default Layer Bitwise Operation */
 282 #define ACTION_DEFAULT_LAYER_BIT_AND(part, bits)    ACTION_LAYER_BITOP(OP_BIT_AND, (part), (bits), 0)
 283 #define ACTION_DEFAULT_LAYER_BIT_OR( part, bits)    ACTION_LAYER_BITOP(OP_BIT_OR,  (part), (bits), 0)
 284 #define ACTION_DEFAULT_LAYER_BIT_XOR(part, bits)    ACTION_LAYER_BITOP(OP_BIT_XOR, (part), (bits), 0)
 285 #define ACTION_DEFAULT_LAYER_BIT_SET(part, bits)    ACTION_LAYER_BITOP(OP_BIT_SET, (part), (bits), 0)
 286
 287
 288 /*
 289  * Extensions
 290  */
 291 /* Macro */
 292 #define ACTION_MACRO(id)                ACTION(ACT_MACRO, (id))
 293 #define ACTION_MACRO_TAP(id)            ACTION(ACT_MACRO, FUNC_TAP<<8 | (id))
 294 #define ACTION_MACRO_OPT(id, opt)       ACTION(ACT_MACRO, (opt)<<8 | (id))
 295
 296 /* Backlight */
 297 enum backlight_opt {
 298     BACKLIGHT_INCREASE = 0,
 299     BACKLIGHT_DECREASE = 1,
 300     BACKLIGHT_TOGGLE   = 2,
 301     BACKLIGHT_STEP     = 3,
 302     BACKLIGHT_LEVEL    = 4,
 303 };
 304 #define ACTION_BACKLIGHT_INCREASE()     ACTION(ACT_BACKLIGHT, BACKLIGHT_INCREASE << 8)
 305 #define ACTION_BACKLIGHT_DECREASE()     ACTION(ACT_BACKLIGHT, BACKLIGHT_DECREASE << 8)
 306 #define ACTION_BACKLIGHT_TOGGLE()       ACTION(ACT_BACKLIGHT, BACKLIGHT_TOGGLE << 8)
 307 #define ACTION_BACKLIGHT_STEP()         ACTION(ACT_BACKLIGHT, BACKLIGHT_STEP << 8)
 308 #define ACTION_BACKLIGHT_LEVEL(level)   ACTION(ACT_BACKLIGHT, BACKLIGHT_LEVEL << 8 | level)
 309
 310 /* Command */
 311 enum command_ids {
 312     COMMAND_BOOTLOADER, // jump to bootloader
 313 };
 314 #define ACTION_COMMAND(id, opt)         ACTION(ACT_COMMAND,  (opt)<<8 | (id))
 315
 316 /* Function */
 317 enum function_opts {
 318     FUNC_TAP = 0x8,     /* indciates function is tappable */
 319 };
 320 #define ACTION_FUNCTION(id)             ACTION(ACT_FUNCTION, (id))
 321 #define ACTION_FUNCTION_TAP(id)         ACTION(ACT_FUNCTION, FUNC_TAP<<8 | (id))
 322 #define ACTION_FUNCTION_OPT(id, opt)    ACTION(ACT_FUNCTION, (opt)<<8 | (id))
 323
 324 #endif /* ACTION_CODE_H */