action_code.h 12 KB

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