tmk_core/common/keycode.h

   1 /*
   2 Copyright 2011,2012,2020 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
  18 /*
  19  * Keycodes based on HID Usage Keyboard/Keypad Page(0x07) plus special codes
  20  * http://www.usb.org/developers/devclass_docs/Hut1_12.pdf
  21  */
  22 #ifndef KEYCODE_H
  23 #define KEYCODE_H
  24
  25
  26 #define IS_ERROR(code)           (KC_ROLL_OVER <= (code) && (code) <= KC_UNDEFINED)
  27 #define IS_ANY(code)             (KC_A         <= (code) && (code) <= 0xFF)
  28
  29 // Use original HID usages on B0-DD instead of TMK specific codes
  30 #ifndef USE_ORIGINAL_HID_USAGE
  31 #define IS_KEY(code)             (KC_A         <= (code) && (code) <= KC_EXSEL)
  32 #else
  33 #define IS_KEY(code)             ((KC_A         <= (code) && (code) <= KC_EXSEL) || \
  34                                   (KC_KP_00     <= (code) && (code) <= KC_KP_HEXADECIMAL))
  35 #endif
  36
  37 #define IS_MOD(code)             (KC_LCTRL     <= (code) && (code) <= KC_RGUI)
  38
  39
  40 #define IS_SPECIAL(code)         ((0xA5 <= (code) && (code) <= 0xDF) || (0xE8 <= (code) && (code) <= 0xFF))
  41 #define IS_SYSTEM(code)          (KC_PWR       <= (code) && (code) <= KC_WAKE)
  42 #define IS_CONSUMER(code)        (KC_MUTE      <= (code) && (code) <= KC_BRIGHTNESS_DEC)
  43 #define IS_FN(code)              (KC_FN0       <= (code) && (code) <= KC_FN31)
  44 #define IS_MOUSEKEY(code)        (KC_MS_UP     <= (code) && (code) <= KC_MS_ACCEL2)
  45 #define IS_MOUSEKEY_MOVE(code)   (KC_MS_UP     <= (code) && (code) <= KC_MS_RIGHT)
  46 #define IS_MOUSEKEY_BUTTON(code) (KC_MS_BTN1   <= (code) && (code) <= KC_MS_BTN5)
  47 #define IS_MOUSEKEY_WHEEL(code)  (KC_MS_WH_UP  <= (code) && (code) <= KC_MS_WH_RIGHT)
  48 #define IS_MOUSEKEY_ACCEL(code)  (KC_MS_ACCEL0 <= (code) && (code) <= KC_MS_ACCEL2)
  49
  50 #define MOD_BIT(code)   (1<<MOD_INDEX(code))
  51 #define MOD_INDEX(code) ((code) & 0x07)
  52 #define FN_BIT(code)    (1<<FN_INDEX(code))
  53 #define FN_INDEX(code)  ((code) - KC_FN0)
  54 #define FN_MIN          KC_FN0
  55 #define FN_MAX          KC_FN31
  56
  57
  58 /*
  59  * Short names for ease of definition of keymap
  60  */
  61 #define KC_LCTL KC_LCTRL
  62 #define KC_RCTL KC_RCTRL
  63 #define KC_LSFT KC_LSHIFT
  64 #define KC_RSFT KC_RSHIFT
  65 #define KC_ESC  KC_ESCAPE
  66 #define KC_BSPC KC_BSPACE
  67 #define KC_ENT  KC_ENTER
  68 #define KC_DEL  KC_DELETE
  69 #define KC_INS  KC_INSERT
  70 #define KC_CAPS KC_CAPSLOCK
  71 #define KC_CLCK KC_CAPSLOCK
  72 #define KC_RGHT KC_RIGHT
  73 #define KC_PGDN KC_PGDOWN
  74 #define KC_PSCR KC_PSCREEN
  75 #define KC_SLCK KC_SCROLLLOCK
  76 #define KC_PAUS KC_PAUSE
  77 #define KC_BRK  KC_PAUSE
  78 #define KC_NLCK KC_NUMLOCK
  79 #define KC_SPC  KC_SPACE
  80 #define KC_MINS KC_MINUS
  81 #define KC_EQL  KC_EQUAL
  82 #define KC_GRV  KC_GRAVE
  83 #define KC_RBRC KC_RBRACKET
  84 #define KC_LBRC KC_LBRACKET
  85 #define KC_COMM KC_COMMA
  86 #define KC_BSLS KC_BSLASH
  87 #define KC_SLSH KC_SLASH
  88 #define KC_SCLN KC_SCOLON
  89 #define KC_QUOT KC_QUOTE
  90 #define KC_APP  KC_APPLICATION
  91 #define KC_NUHS KC_NONUS_HASH
  92 #define KC_NUBS KC_NONUS_BSLASH
  93 #define KC_LCAP KC_LOCKING_CAPS
  94 #define KC_LNUM KC_LOCKING_NUM
  95 #define KC_LSCR KC_LOCKING_SCROLL
  96 #define KC_ERAS KC_ALT_ERASE
  97 #define KC_CLR  KC_CLEAR
  98 /* Japanese specific */
  99 #define KC_ZKHK KC_GRAVE
 100 #define KC_RO   KC_INT1
 101 #define KC_KANA KC_INT2
 102 #define KC_JYEN KC_INT3
 103 #define KC_JPY  KC_INT3
 104 #define KC_HENK KC_INT4
 105 #define KC_MHEN KC_INT5
 106 /* Korean specific */
 107 #define KC_HAEN KC_LANG1
 108 #define KC_HANJ KC_LANG2
 109 /* Keypad */
 110 #define KC_P1   KC_KP_1
 111 #define KC_P2   KC_KP_2
 112 #define KC_P3   KC_KP_3
 113 #define KC_P4   KC_KP_4
 114 #define KC_P5   KC_KP_5
 115 #define KC_P6   KC_KP_6
 116 #define KC_P7   KC_KP_7
 117 #define KC_P8   KC_KP_8
 118 #define KC_P9   KC_KP_9
 119 #define KC_P0   KC_KP_0
 120 #define KC_P00  KC_KP_00
 121 #define KC_P000 KC_KP_000
 122 #define KC_PDOT KC_KP_DOT
 123 #define KC_PCMM KC_KP_COMMA
 124 #define KC_PSLS KC_KP_SLASH
 125 #define KC_PAST KC_KP_ASTERISK
 126 #define KC_PMNS KC_KP_MINUS
 127 #define KC_PPLS KC_KP_PLUS
 128 #define KC_PEQL KC_KP_EQUAL
 129 #define KC_PENT KC_KP_ENTER
 130 /* Unix function key */
 131 #define KC_EXEC KC_EXECUTE
 132 #define KC_SLCT KC_SELECT
 133 #define KC_AGIN KC_AGAIN
 134 #define KC_PSTE KC_PASTE
 135 /* Mousekey */
 136 #define KC_MS_U KC_MS_UP
 137 #define KC_MS_D KC_MS_DOWN
 138 #define KC_MS_L KC_MS_LEFT
 139 #define KC_MS_R KC_MS_RIGHT
 140 #define KC_BTN1 KC_MS_BTN1
 141 #define KC_BTN2 KC_MS_BTN2
 142 #define KC_BTN3 KC_MS_BTN3
 143 #define KC_BTN4 KC_MS_BTN4
 144 #define KC_BTN5 KC_MS_BTN5
 145 #define KC_WH_U KC_MS_WH_UP
 146 #define KC_WH_D KC_MS_WH_DOWN
 147 #define KC_WH_L KC_MS_WH_LEFT
 148 #define KC_WH_R KC_MS_WH_RIGHT
 149 #define KC_ACL0 KC_MS_ACCEL0
 150 #define KC_ACL1 KC_MS_ACCEL1
 151 #define KC_ACL2 KC_MS_ACCEL2
 152 /* Sytem Control */
 153 #define KC_PWR  KC_SYSTEM_POWER
 154 #define KC_SLEP KC_SYSTEM_SLEEP
 155 #define KC_WAKE KC_SYSTEM_WAKE
 156 /* Consumer Page */
 157 #define KC_MUTE KC_AUDIO_MUTE
 158 #define KC_VOLU KC_AUDIO_VOL_UP
 159 #define KC_VOLD KC_AUDIO_VOL_DOWN
 160 #define KC_MNXT KC_MEDIA_NEXT_TRACK
 161 #define KC_MPRV KC_MEDIA_PREV_TRACK
 162 #define KC_MFFD KC_MEDIA_FAST_FORWARD
 163 #define KC_MRWD KC_MEDIA_REWIND
 164 #define KC_MSTP KC_MEDIA_STOP
 165 #define KC_MPLY KC_MEDIA_PLAY_PAUSE
 166 #define KC_EJCT KC_MEDIA_EJECT
 167 #define KC_MSEL KC_MEDIA_SELECT
 168 #define KC_MAIL KC_MAIL
 169 #define KC_CALC KC_CALCULATOR
 170 #define KC_MYCM KC_MY_COMPUTER
 171 #define KC_WSCH KC_WWW_SEARCH
 172 #define KC_WHOM KC_WWW_HOME
 173 #define KC_WBAK KC_WWW_BACK
 174 #define KC_WFWD KC_WWW_FORWARD
 175 #define KC_WSTP KC_WWW_STOP
 176 #define KC_WREF KC_WWW_REFRESH
 177 #define KC_WFAV KC_WWW_FAVORITES
 178 #define KC_BRTI KC_BRIGHTNESS_INC
 179 #define KC_BRTD KC_BRIGHTNESS_DEC
 180 /* Jump to bootloader */
 181 #define KC_BTLD KC_BOOTLOADER
 182 /* Transparent */
 183 #define KC_TRANSPARENT  1
 184 #define KC_TRNS KC_TRANSPARENT
 185
 186
 187
 188 /* USB HID Keyboard/Keypad Usage(0x07) */
 189 enum hid_keyboard_keypad_usage {
 190     KC_NO                   = 0x00,
 191     KC_ROLL_OVER,           // 01
 192     KC_POST_FAIL,           // 02
 193     KC_UNDEFINED,           // 03
 194     KC_A,                   // 04
 195     KC_B,                   // 05
 196     KC_C,                   // 06
 197     KC_D,                   // 07
 198     KC_E,                   // 08
 199     KC_F,                   // 09
 200     KC_G,                   // 0A
 201     KC_H,                   // 0B
 202     KC_I,                   // 0C
 203     KC_J,                   // 0D
 204     KC_K,                   // 0E
 205     KC_L,                   // 0F
 206     KC_M,                   // 10
 207     KC_N,                   // 11
 208     KC_O,                   // 12
 209     KC_P,                   // 13
 210     KC_Q,                   // 14
 211     KC_R,                   // 15
 212     KC_S,                   // 16
 213     KC_T,                   // 17
 214     KC_U,                   // 18
 215     KC_V,                   // 19
 216     KC_W,                   // 1A
 217     KC_X,                   // 1B
 218     KC_Y,                   // 1C
 219     KC_Z,                   // 1D
 220     KC_1,                   // 1E
 221     KC_2,                   // 1F
 222     KC_3,                   // 20
 223     KC_4,                   // 21
 224     KC_5,                   // 22
 225     KC_6,                   // 23
 226     KC_7,                   // 24
 227     KC_8,                   // 25
 228     KC_9,                   // 26
 229     KC_0,                   // 27
 230     KC_ENTER,               // 28
 231     KC_ESCAPE,              // 29
 232     KC_BSPACE,              // 2A
 233     KC_TAB,                 // 2B
 234     KC_SPACE,               // 2C
 235     KC_MINUS,               // 2D
 236     KC_EQUAL,               // 2E
 237     KC_LBRACKET,            // 2F
 238     KC_RBRACKET,            // 30
 239     KC_BSLASH,              // 31   \ (and |)
 240     KC_NONUS_HASH,          // 32   Non-US # and ~ (Typically near the Enter key)
 241     KC_SCOLON,              // 33   ; (and :)
 242     KC_QUOTE,               // 34   ' and "
 243     KC_GRAVE,               // 35   Grave accent and tilde
 244     KC_COMMA,               // 36   , and <
 245     KC_DOT,                 // 37   . and >
 246     KC_SLASH,               // 38   / and ?
 247     KC_CAPSLOCK,            // 39
 248     KC_F1,                  // 3A
 249     KC_F2,                  // 3B
 250     KC_F3,                  // 3C
 251     KC_F4,                  // 3D
 252     KC_F5,                  // 3E
 253     KC_F6,                  // 3F
 254     KC_F7,                  // 40
 255     KC_F8,                  // 41
 256     KC_F9,                  // 42
 257     KC_F10,                 // 43
 258     KC_F11,                 // 44
 259     KC_F12,                 // 45
 260     KC_PSCREEN,             // 46
 261     KC_SCROLLLOCK,          // 47
 262     KC_PAUSE,               // 48
 263     KC_INSERT,              // 49
 264     KC_HOME,                // 4A
 265     KC_PGUP,                // 4B
 266     KC_DELETE,              // 4C
 267     KC_END,                 // 4D
 268     KC_PGDOWN,              // 4E
 269     KC_RIGHT,               // 4F
 270     KC_LEFT,                // 50
 271     KC_DOWN,                // 51
 272     KC_UP,                  // 52
 273     KC_NUMLOCK,             // 53
 274     KC_KP_SLASH,            // 54
 275     KC_KP_ASTERISK,         // 55
 276     KC_KP_MINUS,            // 56
 277     KC_KP_PLUS,             // 57
 278     KC_KP_ENTER,            // 58
 279     KC_KP_1,                // 59
 280     KC_KP_2,                // 5A
 281     KC_KP_3,                // 5B
 282     KC_KP_4,                // 5C
 283     KC_KP_5,                // 5D
 284     KC_KP_6,                // 5E
 285     KC_KP_7,                // 5F
 286     KC_KP_8,                // 60
 287     KC_KP_9,                // 61
 288     KC_KP_0,                // 62
 289     KC_KP_DOT,              // 63
 290     KC_NONUS_BSLASH,        // 64   Non-US \ and | (Typically near the Left-Shift key) */
 291     KC_APPLICATION,         // 65
 292     KC_POWER,               // 66
 293     KC_KP_EQUAL,            // 67
 294     KC_F13,                 // 68
 295     KC_F14,                 // 69
 296     KC_F15,                 // 6A
 297     KC_F16,                 // 6B
 298     KC_F17,                 // 6C
 299     KC_F18,                 // 6D
 300     KC_F19,                 // 6E
 301     KC_F20,                 // 6F
 302     KC_F21,                 // 70
 303     KC_F22,                 // 71
 304     KC_F23,                 // 72
 305     KC_F24,                 // 73
 306     KC_EXECUTE,             // 74
 307     KC_HELP,                // 75
 308     KC_MENU,                // 76
 309     KC_SELECT,              // 77
 310     KC_STOP,                // 78
 311     KC_AGAIN,               // 79
 312     KC_UNDO,                // 7A
 313     KC_CUT,                 // 7B
 314     KC_COPY,                // 7C
 315     KC_PASTE,               // 7D
 316     KC_FIND,                // 7E
 317     KC__MUTE,               // 7F
 318     KC__VOLUP,              // 80
 319     KC__VOLDOWN,            // 81
 320     KC_LOCKING_CAPS,        // 82   locking Caps Lock */
 321     KC_LOCKING_NUM,         // 83   locking Num Lock */
 322     KC_LOCKING_SCROLL,      // 84   locking Scroll Lock */
 323     KC_KP_COMMA,            // 85
 324     KC_KP_EQUAL_AS400,      // 86   equal sign on AS/400 */
 325     KC_INT1,                // 87
 326     KC_INT2,                // 88
 327     KC_INT3,                // 89
 328     KC_INT4,                // 8A
 329     KC_INT5,                // 8B
 330     KC_INT6,                // 8C
 331     KC_INT7,                // 8D
 332     KC_INT8,                // 8E
 333     KC_INT9,                // 8F
 334     KC_LANG1,               // 90
 335     KC_LANG2,               // 91
 336     KC_LANG3,               // 92
 337     KC_LANG4,               // 93
 338     KC_LANG5,               // 94
 339     KC_LANG6,               // 95
 340     KC_LANG7,               // 96
 341     KC_LANG8,               // 97
 342     KC_LANG9,               // 98
 343     KC_ALT_ERASE,           // 99
 344     KC_SYSREQ,              // 9A
 345     KC_CANCEL,              // 9B
 346     KC_CLEAR,               // 9C
 347     KC_PRIOR,               // 9D
 348     KC_RETURN,              // 9E
 349     KC_SEPARATOR,           // 9F
 350     KC_OUT,                 // A0
 351     KC_OPER,                // A1
 352     KC_CLEAR_AGAIN,         // A2
 353     KC_CRSEL,               // A3
 354     KC_EXSEL,               // A4
 355
 356     /* NOTE: Following code range(0xB0-DD) are shared with special codes of 8-bit keymap */
 357     KC_KP_00                = 0xB0,
 358     KC_KP_000,              // B1
 359     KC_THOUSANDS_SEPARATOR, // B2
 360     KC_DECIMAL_SEPARATOR,   // B3
 361     KC_CURRENCY_UNIT,       // B4
 362     KC_CURRENCY_SUB_UNIT,   // B5
 363     KC_KP_LPAREN,           // B6
 364     KC_KP_RPAREN,           // B7
 365     KC_KP_LCBRACKET,        // B8   {
 366     KC_KP_RCBRACKET,        // B9   }
 367     KC_KP_TAB,              // BA
 368     KC_KP_BSPACE,           // BB
 369     KC_KP_A,                // BC
 370     KC_KP_B,                // BD
 371     KC_KP_C,                // BE
 372     KC_KP_D,                // BF
 373     KC_KP_E,                // C0
 374     KC_KP_F,                // C1
 375     KC_KP_XOR,              // C2
 376     KC_KP_HAT,              // C3
 377     KC_KP_PERC,             // C4
 378     KC_KP_LT,               // C5
 379     KC_KP_GT,               // C6
 380     KC_KP_AND,              // C7
 381     KC_KP_LAZYAND,          // C8
 382     KC_KP_OR,               // C9
 383     KC_KP_LAZYOR,           // CA
 384     KC_KP_COLON,            // CB
 385     KC_KP_HASH,             // CC
 386     KC_KP_SPACE,            // CD
 387     KC_KP_ATMARK,           // CE
 388     KC_KP_EXCLAMATION,      // CF
 389     KC_KP_MEM_STORE,        // D0
 390     KC_KP_MEM_RECALL,       // D1
 391     KC_KP_MEM_CLEAR,        // D2
 392     KC_KP_MEM_ADD,          // D3
 393     KC_KP_MEM_SUB,          // D4
 394     KC_KP_MEM_MUL,          // D5
 395     KC_KP_MEM_DIV,          // D6
 396     KC_KP_PLUS_MINUS,       // D7
 397     KC_KP_CLEAR,            // D8
 398     KC_KP_CLEAR_ENTRY,      // D9
 399     KC_KP_BINARY,           // DA
 400     KC_KP_OCTAL,            // DB
 401     KC_KP_DECIMAL,          // DC
 402     KC_KP_HEXADECIMAL,      // DD
 403
 404     /* Modifiers */
 405     KC_LCTRL                = 0xE0,
 406     KC_LSHIFT,              // E1
 407     KC_LALT,                // E2
 408     KC_LGUI,                // E3
 409     KC_RCTRL,               // E4
 410     KC_RSHIFT,              // E5
 411     KC_RALT,                // E6
 412     KC_RGUI,                // E7
 413 };
 414
 415 /* Special keycodes for 8-bit keymap
 416    NOTE: 0xA5-DF and 0xE8-FF are used for internal special purpose */
 417 enum internal_special_keycodes {
 418     /* System Control */
 419     KC_SYSTEM_POWER         = 0xA5,
 420     KC_SYSTEM_SLEEP,        // A6
 421     KC_SYSTEM_WAKE,         // A7
 422
 423     /* Media Control */
 424     KC_AUDIO_MUTE,          // A8
 425     KC_AUDIO_VOL_UP,        // A9
 426     KC_AUDIO_VOL_DOWN,      // AA
 427     KC_MEDIA_NEXT_TRACK,    // AB
 428     KC_MEDIA_PREV_TRACK,    // AC
 429     KC_MEDIA_FAST_FORWARD,  // AD
 430     KC_MEDIA_REWIND,        // AE
 431     KC_MEDIA_STOP,          // AF
 432     KC_MEDIA_PLAY_PAUSE,    // B0
 433     KC_MEDIA_EJECT,         // B1
 434     KC_MEDIA_SELECT,        // B2
 435     KC_MAIL,                // B3
 436     KC_CALCULATOR,          // B4
 437     KC_MY_COMPUTER,         // B5
 438     KC_WWW_SEARCH,          // B6
 439     KC_WWW_HOME,            // B7
 440     KC_WWW_BACK,            // B8
 441     KC_WWW_FORWARD,         // B9
 442     KC_WWW_STOP,            // BA
 443     KC_WWW_REFRESH,         // BB
 444     KC_WWW_FAVORITES,       // BC
 445     KC_BRIGHTNESS_INC,      // BD
 446     KC_BRIGHTNESS_DEC,      // BE
 447
 448     /* Jump to bootloader */
 449     KC_BOOTLOADER,          // BF
 450
 451     /* Fn key */
 452     KC_FN0,                 // C0
 453     KC_FN1,                 // C1
 454     KC_FN2,                 // C2
 455     KC_FN3,                 // C3
 456     KC_FN4,                 // C4
 457     KC_FN5,                 // C5
 458     KC_FN6,                 // C6
 459     KC_FN7,                 // C7
 460     KC_FN8,                 // C8
 461     KC_FN9,                 // C9
 462     KC_FN10,                // CA
 463     KC_FN11,                // CB
 464     KC_FN12,                // CC
 465     KC_FN13,                // CD
 466     KC_FN14,                // CE
 467     KC_FN15,                // CF
 468     KC_FN16,                // D0
 469     KC_FN17,                // D1
 470     KC_FN18,                // D2
 471     KC_FN19,                // D3
 472     KC_FN20,                // D4
 473     KC_FN21,                // D5
 474     KC_FN22,                // D6
 475     KC_FN23,                // D7
 476     KC_FN24,                // D8
 477     KC_FN25,                // D9
 478     KC_FN26,                // DA
 479     KC_FN27,                // DB
 480     KC_FN28,                // DC
 481     KC_FN29,                // DD
 482     KC_FN30,                // DE
 483     KC_FN31,                // DF
 484
 485     /**************************************/
 486     /* 0xE0-E7 for Modifiers. DO NOT USE. */
 487     /**************************************/
 488
 489     /* Mousekey */
 490     KC_MS_UP                = 0xF0,
 491     KC_MS_DOWN,             // F1
 492     KC_MS_LEFT,             // F2
 493     KC_MS_RIGHT,            // F3
 494     KC_MS_BTN1,             // F4
 495     KC_MS_BTN2,             // F5
 496     KC_MS_BTN3,             // F6
 497     KC_MS_BTN4,             // F7
 498     KC_MS_BTN5,             // F8
 499     /* Mousekey wheel */
 500     KC_MS_WH_UP,            // F9
 501     KC_MS_WH_DOWN,          // FA
 502     KC_MS_WH_LEFT,          // FB
 503     KC_MS_WH_RIGHT,         // FC
 504     /* Mousekey accel */
 505     KC_MS_ACCEL0,           // FD
 506     KC_MS_ACCEL1,           // FE
 507     KC_MS_ACCEL2            // FF
 508 };
 509
 510 #endif /* KEYCODE_H */