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