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 /** \brief Action codes
  21  *
  22  * 16bit code: action_kind(4bit) + action_parameter(12bit)
  23  *
  24  * Key Actions(00xx)
  25  * -----------------
  26  * ACT_MODS(000r):
  27  * 000r|0000|0000 0000    No action code
  28  * 000r|0000|0000 0001    Transparent code
  29  * 000r|0000| keycode     Key
  30  * 000r|mods|0000 0000    Modifiers
  31  * 000r|mods| keycode     Modifiers+Key(Modified key)
  32  *   r: Left/Right flag(Left:0, Right:1)
  33  *
  34  * ACT_MODS_TAP(001r):
  35  * 001r|mods|0000 0000    Modifiers with OneShot
  36  * 001r|mods|0000 0001    Modifiers with tap toggle
  37  * 001r|mods|0000 00xx    (reserved)
  38  * 001r|mods| keycode     Modifiers with Tap Key(Dual role)
  39  *
  40  * Other Keys(01xx)
  41  * ----------------
  42  * ACT_USAGE(0100): TODO: Not needed?
  43  * 0100|00| usage(10)     System control(0x80) - General Desktop page(0x01)
  44  * 0100|01| usage(10)     Consumer control(0x01) - Consumer page(0x0C)
  45  * 0100|10| usage(10)     (reserved)
  46  * 0100|11| usage(10)     (reserved)
  47  *
  48  * ACT_MOUSEKEY(0101): TODO: Merge these two actions to conserve space?
  49  * 0101|xxxx| keycode     Mouse key
  50  *
  51  * ACT_SWAP_HANDS(0110):
  52  * 0110|xxxx| keycode     Swap hands (keycode on tap, or options)
  53  *
  54  * 0111|xxxx xxxx xxxx    (reserved)
  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  *
  71  * ACT_LAYER_TAP(101x):
  72  * 101E|LLLL| keycode    On/Off with tap key    (0x00-DF)[TAP]
  73  * 101E|LLLL|1110 mods   On/Off with modifiers  (0xE0-EF)[NOT TAP]
  74  * 101E|LLLL|1111 0000   Invert with tap toggle (0xF0)   [TAP]
  75  * 101E|LLLL|1111 0001   On/Off                 (0xF1)   [NOT TAP]
  76  * 101E|LLLL|1111 0010   Off/On                 (0xF2)   [NOT TAP]
  77  * 101E|LLLL|1111 0011   Set/Clear              (0xF3)   [NOT TAP]
  78  * 101E|LLLL|1111 0100   One Shot Layer         (0xF4)   [TAP]
  79  * 101E|LLLL|1111 xxxx   Reserved               (0xF5-FF)
  80  *   ELLLL: layer 0-31(E: extra bit for layer 16-31)
  81  *
  82  * Extensions(11xx)
  83  * ----------------
  84  * ACT_MACRO(1100):
  85  * 1100|opt | id(8)      Macro play?
  86  * 1100|1111| id(8)      Macro record?
  87  *
  88  * ACT_BACKLIGHT(1101):
  89  * 1101|opt |level(8)    Backlight commands
  90  *
  91  * ACT_COMMAND(1110):
  92  * 1110|opt | id(8)      Built-in Command exec
  93  *
  94  * ACT_FUNCTION(1111):
  95  * 1111| address(12)     Function?
  96  * 1111|opt | id(8)      Function?
  97  */
  98 enum action_kind_id {
  99     /* Key Actions */
 100     ACT_MODS            = 0b0000,
 101     ACT_LMODS           = 0b0000,
 102     ACT_RMODS           = 0b0001,
 103     ACT_MODS_TAP        = 0b0010,
 104     ACT_LMODS_TAP       = 0b0010,
 105     ACT_RMODS_TAP       = 0b0011,
 106     /* Other Keys */
 107     ACT_USAGE           = 0b0100,
 108     ACT_MOUSEKEY        = 0b0101,
 109     /* One-hand Support */
 110     ACT_SWAP_HANDS      = 0b0110,
 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 /** \brief 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     struct action_swap {
 182         uint8_t  code   :8;
 183         uint8_t  opt    :4;
 184         uint8_t  kind   :4;
 185     } swap;
 186 } action_t;
 187
 188
 189 /* action utility */
 190 #define ACTION_NO                       0
 191 #define ACTION_TRANSPARENT              1
 192 #define ACTION(kind, param)             ((kind)<<12 | (param))
 193
 194
 195 /** \brief Key Actions
 196  *
 197  * Mod bits:    43210
 198  *   bit 0      ||||+- Control
 199  *   bit 1      |||+-- Shift
 200  *   bit 2      ||+--- Alt
 201  *   bit 3      |+---- Gui
 202  *   bit 4      +----- LR flag(Left:0, Right:1)
 203  */
 204 enum mods_bit {
 205     MOD_LCTL = 0x01,
 206     MOD_LSFT = 0x02,
 207     MOD_LALT = 0x04,
 208     MOD_LGUI = 0x08,
 209     MOD_RCTL = 0x11,
 210     MOD_RSFT = 0x12,
 211     MOD_RALT = 0x14,
 212     MOD_RGUI = 0x18,
 213 };
 214 enum mods_codes {
 215     MODS_ONESHOT = 0x00,
 216     MODS_TAP_TOGGLE = 0x01,
 217 };
 218 #define ACTION_KEY(key)                 ACTION(ACT_MODS, (key))
 219 #define ACTION_MODS(mods)               ACTION(ACT_MODS, ((mods)&0x1f)<<8 | 0)
 220 #define ACTION_MODS_KEY(mods, key)      ACTION(ACT_MODS, ((mods)&0x1f)<<8 | (key))
 221 #define ACTION_MODS_TAP_KEY(mods, key)  ACTION(ACT_MODS_TAP, ((mods)&0x1f)<<8 | (key))
 222 #define ACTION_MODS_ONESHOT(mods)       ACTION(ACT_MODS_TAP, ((mods)&0x1f)<<8 | MODS_ONESHOT)
 223 #define ACTION_MODS_TAP_TOGGLE(mods)    ACTION(ACT_MODS_TAP, ((mods)&0x1f)<<8 | MODS_TAP_TOGGLE)
 224
 225
 226 /** \brief Other Keys
 227  */
 228 enum usage_pages {
 229     PAGE_SYSTEM,
 230     PAGE_CONSUMER
 231 };
 232 #define ACTION_USAGE_SYSTEM(id)         ACTION(ACT_USAGE, PAGE_SYSTEM<<10 | (id))
 233 #define ACTION_USAGE_CONSUMER(id)       ACTION(ACT_USAGE, PAGE_CONSUMER<<10 | (id))
 234 #define ACTION_MOUSEKEY(key)            ACTION(ACT_MOUSEKEY, key)
 235
 236
 237
 238 /** \brief Layer Actions
 239  */
 240 enum layer_param_on {
 241     ON_PRESS    = 1,
 242     ON_RELEASE  = 2,
 243     ON_BOTH     = 3,
 244 };
 245
 246 /** \brief Layer Actions
 247  */
 248 enum layer_param_bit_op {
 249     OP_BIT_AND = 0,
 250     OP_BIT_OR  = 1,
 251     OP_BIT_XOR = 2,
 252     OP_BIT_SET = 3,
 253 };
 254
 255 /** \brief Layer Actions
 256  */
 257 enum layer_param_tap_op {
 258     OP_TAP_TOGGLE = 0xF0,
 259     OP_ON_OFF,
 260     OP_OFF_ON,
 261     OP_SET_CLEAR,
 262     OP_ONESHOT,
 263 };
 264 #define ACTION_LAYER_BITOP(op, part, bits, on)      (ACT_LAYER<<12 | (op)<<10 | (on)<<8 | (part)<<5 | ((bits)&0x1f))
 265 #define ACTION_LAYER_TAP(layer, key)                (ACT_LAYER_TAP<<12 | (layer)<<8 | (key))
 266 /* Default Layer */
 267 #define ACTION_DEFAULT_LAYER_SET(layer)             ACTION_DEFAULT_LAYER_BIT_SET((layer)/4, 1<<((layer)%4))
 268 /* Layer Operation */
 269 #define ACTION_LAYER_CLEAR(on)                      ACTION_LAYER_BIT_AND(0, 0, (on))
 270 #define ACTION_LAYER_MOMENTARY(layer)               ACTION_LAYER_ON_OFF(layer)
 271 #define ACTION_LAYER_TOGGLE(layer)                  ACTION_LAYER_INVERT(layer, ON_RELEASE)
 272 #define ACTION_LAYER_INVERT(layer, on)              ACTION_LAYER_BIT_XOR((layer)/4,   1<<((layer)%4),  (on))
 273 #define ACTION_LAYER_ON(layer, on)                  ACTION_LAYER_BIT_OR( (layer)/4,   1<<((layer)%4),  (on))
 274 #define ACTION_LAYER_OFF(layer, on)                 ACTION_LAYER_BIT_AND((layer)/4, ~(1<<((layer)%4)), (on))
 275 #define ACTION_LAYER_SET(layer, on)                 ACTION_LAYER_BIT_SET((layer)/4,   1<<((layer)%4),  (on))
 276 #define ACTION_LAYER_ON_OFF(layer)                  ACTION_LAYER_TAP((layer), OP_ON_OFF)
 277 #define ACTION_LAYER_OFF_ON(layer)                  ACTION_LAYER_TAP((layer), OP_OFF_ON)
 278 #define ACTION_LAYER_SET_CLEAR(layer)               ACTION_LAYER_TAP((layer), OP_SET_CLEAR)
 279 #define ACTION_LAYER_ONESHOT(layer)                 ACTION_LAYER_TAP((layer), OP_ONESHOT)
 280 #define ACTION_LAYER_MODS(layer, mods)              ACTION_LAYER_TAP((layer), 0xe0 | ((mods)&0x0f))
 281 /* With Tapping */
 282 #define ACTION_LAYER_TAP_KEY(layer, key)            ACTION_LAYER_TAP((layer), (key))
 283 #define ACTION_LAYER_TAP_TOGGLE(layer)              ACTION_LAYER_TAP((layer), OP_TAP_TOGGLE)
 284 /* Bitwise Operation */
 285 #define ACTION_LAYER_BIT_AND(part, bits, on)        ACTION_LAYER_BITOP(OP_BIT_AND, (part), (bits), (on))
 286 #define ACTION_LAYER_BIT_OR( part, bits, on)        ACTION_LAYER_BITOP(OP_BIT_OR,  (part), (bits), (on))
 287 #define ACTION_LAYER_BIT_XOR(part, bits, on)        ACTION_LAYER_BITOP(OP_BIT_XOR, (part), (bits), (on))
 288 #define ACTION_LAYER_BIT_SET(part, bits, on)        ACTION_LAYER_BITOP(OP_BIT_SET, (part), (bits), (on))
 289 /* Default Layer Bitwise Operation */
 290 #define ACTION_DEFAULT_LAYER_BIT_AND(part, bits)    ACTION_LAYER_BITOP(OP_BIT_AND, (part), (bits), 0)
 291 #define ACTION_DEFAULT_LAYER_BIT_OR( part, bits)    ACTION_LAYER_BITOP(OP_BIT_OR,  (part), (bits), 0)
 292 #define ACTION_DEFAULT_LAYER_BIT_XOR(part, bits)    ACTION_LAYER_BITOP(OP_BIT_XOR, (part), (bits), 0)
 293 #define ACTION_DEFAULT_LAYER_BIT_SET(part, bits)    ACTION_LAYER_BITOP(OP_BIT_SET, (part), (bits), 0)
 294
 295
 296 /** \brief Extensions
 297  */
 298 enum backlight_opt {
 299     BACKLIGHT_INCREASE = 0,
 300     BACKLIGHT_DECREASE = 1,
 301     BACKLIGHT_TOGGLE   = 2,
 302     BACKLIGHT_STEP     = 3,
 303     BACKLIGHT_ON       = 4,
 304     BACKLIGHT_OFF      = 5,
 305 };
 306
 307 /* Macro */
 308 #define ACTION_MACRO(id)                ACTION(ACT_MACRO, (id))
 309 #define ACTION_MACRO_TAP(id)            ACTION(ACT_MACRO, FUNC_TAP<<8 | (id))
 310 #define ACTION_MACRO_OPT(id, opt)       ACTION(ACT_MACRO, (opt)<<8 | (id))
 311 /* Backlight */
 312 #define ACTION_BACKLIGHT_INCREASE()     ACTION(ACT_BACKLIGHT, BACKLIGHT_INCREASE << 8)
 313 #define ACTION_BACKLIGHT_DECREASE()     ACTION(ACT_BACKLIGHT, BACKLIGHT_DECREASE << 8)
 314 #define ACTION_BACKLIGHT_TOGGLE()       ACTION(ACT_BACKLIGHT, BACKLIGHT_TOGGLE << 8)
 315 #define ACTION_BACKLIGHT_STEP()         ACTION(ACT_BACKLIGHT, BACKLIGHT_STEP << 8)
 316 #define ACTION_BACKLIGHT_ON()           ACTION(ACT_BACKLIGHT, BACKLIGHT_ON << 8)
 317 #define ACTION_BACKLIGHT_OFF()          ACTION(ACT_BACKLIGHT, BACKLIGHT_OFF << 8)
 318 /* Command */
 319 #define ACTION_COMMAND(id, opt)         ACTION(ACT_COMMAND,  (opt)<<8 | (id))
 320 /* Function */
 321 enum function_opts {
 322     FUNC_TAP = 0x8,     /* indciates function is tappable */
 323 };
 324 #define ACTION_FUNCTION(id)             ACTION(ACT_FUNCTION, (id))
 325 #define ACTION_FUNCTION_TAP(id)         ACTION(ACT_FUNCTION, FUNC_TAP<<8 | (id))
 326 #define ACTION_FUNCTION_OPT(id, opt)    ACTION(ACT_FUNCTION, (opt)<<8 | (id))
 327 /* OneHand Support */
 328 enum swap_hands_param_tap_op {
 329     OP_SH_TOGGLE = 0xF0,
 330     OP_SH_TAP_TOGGLE,
 331     OP_SH_ON_OFF,
 332     OP_SH_OFF_ON,
 333     OP_SH_OFF,
 334     OP_SH_ON,
 335 };
 336
 337 #define ACTION_SWAP_HANDS()             ACTION_SWAP_HANDS_ON_OFF()
 338 #define ACTION_SWAP_HANDS_TOGGLE()      ACTION(ACT_SWAP_HANDS, OP_SH_TOGGLE)
 339 #define ACTION_SWAP_HANDS_TAP_TOGGLE()  ACTION(ACT_SWAP_HANDS, OP_SH_TAP_TOGGLE)
 340 #define ACTION_SWAP_HANDS_TAP_KEY(key)  ACTION(ACT_SWAP_HANDS, key)
 341 #define ACTION_SWAP_HANDS_ON_OFF()      ACTION(ACT_SWAP_HANDS, OP_SH_ON_OFF)
 342 #define ACTION_SWAP_HANDS_OFF_ON()      ACTION(ACT_SWAP_HANDS, OP_SH_OFF_ON)
 343 #define ACTION_SWAP_HANDS_ON()          ACTION(ACT_SWAP_HANDS, OP_SH_ON)
 344 #define ACTION_SWAP_HANDS_OFF()         ACTION(ACT_SWAP_HANDS, OP_SH_OFF)
 345
 346 #endif /* ACTION_CODE_H */