tmk_core/common/keycode.h

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