usb_keycodes.h

   1 /*
   2 Copyright 2011 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  * Key codes from HID Keyboard/Keypad Page
  20  * http://www.usb.org/developers/devclass_docs/Hut1_12.pdf
  21  */
  22 #ifndef USB_KEYCODES_H
  23 #define USB_KEYCODES_H
  24
  25
  26 #define IS_ERROR(code)           (KB_ROLL_OVER <= (code) && (code) <= KB_UNDEFINED)
  27 #define IS_KEY(code)             (KB_A         <= (code) && (code) <= KB_EXSEL)
  28 #define IS_MOD(code)             (KB_LCTRL     <= (code) && (code) <= KB_RGUI)
  29 #define IS_FN(code)              (KB_FN0       <= (code) && (code) <= KB_FN7)
  30 #define IS_MOUSEKEY(code)        (KB_MS_UP     <= (code) && (code) <= KB_MS_WH_RIGHT)
  31 #define IS_MOUSEKEY_MOVE(code)   (KB_MS_UP     <= (code) && (code) <= KB_MS_RIGHT)
  32 #define IS_MOUSEKEY_BUTTON(code) (KB_MS_BTN1   <= (code) && (code) <= KB_MS_BTN5)
  33 #define IS_MOUSEKEY_WHEEL(code)  (KB_MS_WH_UP  <= (code) && (code) <= KB_MS_WH_RIGHT)
  34
  35 #define MOD_BIT(code) (1<<((code) & 0x07))
  36 #define FN_BIT(code)  (1<<((code) - KB_FN0))
  37
  38
  39 /* Short names */
  40 #define KB_LCTL KB_LCTRL
  41 #define KB_RCTL KB_RCTRL
  42 #define KB_LSFT KB_LSHIFT
  43 #define KB_RSFT KB_RSHIFT
  44 #define KB_ESC  KB_ESCAPE
  45 #define KB_BSPC KB_BSPACE
  46 #define KB_ENT  KB_ENTER
  47 #define KB_DEL  KB_DELETE
  48 #define KB_INS  KB_INSERT
  49 #define KB_CAPS KB_CAPSLOCK
  50 #define KB_RGHT KB_RIGHT
  51 #define KB_PGDN KB_PGDOWN
  52 #define KB_PSCR KB_PSCREEN
  53 #define KB_SLCK KB_SCKLOCK
  54 #define KB_BRK  KB_BREAK
  55 #define KB_NLCK KB_NUMLOCK
  56 #define KB_SPC  KB_SPACE
  57 #define KB_MINS KB_MINUS
  58 #define KB_EQL  KB_EQUAL
  59 #define KB_GRV  KB_GRAVE
  60 #define KB_RBRC KB_RBRACKET
  61 #define KB_LBRC KB_LBRACKET
  62 #define KB_COMM KB_COMMA
  63 #define KB_BSLS KB_BSLASH
  64 #define KB_SLSH KB_SLASH
  65 #define KB_SCLN KB_SCOLON
  66 #define KB_QUOT KB_QUOTE
  67 #define KB_APP  KB_APPLICATION
  68 #define KB_NUHS KB_NONUS_HASH
  69 #define KB_NUBS KB_NONUS_BSLASH
  70 /* for Japanese */
  71 #define KB_RO   KB_INT1
  72 #define KB_KANA KB_INT2
  73 #define KB_JYEN KB_INT3
  74 #define KB_HENK KB_INT4
  75 #define KB_MHEN KB_INT5
  76 #define KB_ZEHA KB_GRAVE
  77 /* Keypad */
  78 #define KB_P1   KB_KP_1
  79 #define KB_P2   KB_KP_2
  80 #define KB_P3   KB_KP_3
  81 #define KB_P4   KB_KP_4
  82 #define KB_P5   KB_KP_5
  83 #define KB_P6   KB_KP_6
  84 #define KB_P7   KB_KP_7
  85 #define KB_P8   KB_KP_8
  86 #define KB_P9   KB_KP_9
  87 #define KB_P0   KB_KP_0
  88 #define KB_PDOT KB_KP_DOT
  89 #define KB_PSLS KB_KP_SLASH
  90 #define KB_PAST KB_KP_ASTERISK
  91 #define KB_PMNS KB_KP_MINUS
  92 #define KB_PPLS KB_KP_PLUS
  93 #define KB_PEQL KB_KP_EQUAL
  94 #define KB_PENT KB_KP_ENTER
  95 /* Mousekey */
  96 #define KB_MS_U KB_MS_UP
  97 #define KB_MS_D KB_MS_DOWN
  98 #define KB_MS_L KB_MS_LEFT
  99 #define KB_MS_R KB_MS_RIGHT
 100 #define KB_BTN1 KB_MS_BTN1
 101 #define KB_BTN2 KB_MS_BTN2
 102 #define KB_BTN3 KB_MS_BTN3
 103 #define KB_BTN4 KB_MS_BTN4
 104 #define KB_BTN5 KB_MS_BTN5
 105 #define KB_WH_U KB_MS_WH_UP
 106 #define KB_WH_D KB_MS_WH_DOWN
 107 #define KB_WH_L KB_MS_WH_LEFT
 108 #define KB_WH_R KB_MS_WH_RIGHT
 109 /* Sytem Control & Consumer usage */
 110 #define KB_PWR  KB_SYSTEM_POWER
 111 #define KB_SLEP KB_SYSTEM_SLEEP
 112 #define KB_WAKE KB_SYSTEM_WAKE
 113 #define KB_MUTE KB_AUDIO_MUTE
 114 #define KB_VOLU KB_AUDIO_VOL_UP
 115 #define KB_VOLD KB_AUDIO_VOL_DOWN
 116 #define KB_MNXT KB_MEDIA_NEXT_TRACK
 117 #define KB_MPRV KB_MEDIA_PREV_TRACK
 118 #define KB_MSTP KB_MEDIA_STOP
 119 #define KB_MPLY KB_MEDIA_PLAY_PAUSE
 120 #define KB_MSEL KB_MEDIA_SELECT
 121 #define KB_MAIL KB_MAIL
 122 #define KB_CALC KB_CALCULATOR
 123 #define KB_MYCM KB_MY_COMPUTER
 124 #define KB_WSCH KB_WWW_SEARCH
 125 #define KB_WHOM KB_WWW_HOME
 126 #define KB_WBAK KB_WWW_BACK
 127 #define KB_WFWD KB_WWW_FORWARD
 128 #define KB_WSTP KB_WWW_STOP
 129 #define KB_WREF KB_WWW_REFRESH
 130 #define KB_WFAV KB_WWW_FAVORITES
 131
 132
 133 /* Special keycode */
 134 enum special_keycodes {
 135     /* System Control */
 136     KB_SYSTEM_POWER = 0xB0,
 137     KB_SYSTEM_SLEEP,
 138     KB_SYSTEM_WAKE,
 139
 140     /* Consumer Page */
 141     KB_AUDIO_MUTE,
 142     KB_AUDIO_VOL_UP,
 143     KB_AUDIO_VOL_DOWN,
 144     KB_MEDIA_NEXT_TRACK,
 145     KB_MEDIA_PREV_TRACK,
 146     KB_MEDIA_STOP,
 147     KB_MEDIA_PLAY_PAUSE,
 148     KB_MEDIA_SELECT,
 149     KB_MAIL,
 150     KB_CALCULATOR,
 151     KB_MY_COMPUTER,
 152     KB_WWW_SEARCH,
 153     KB_WWW_HOME,
 154     KB_WWW_BACK,        /* 0xC0 */
 155     KB_WWW_FORWARD,
 156     KB_WWW_STOP,
 157     KB_WWW_REFRESH,
 158     KB_WWW_FAVORITES,
 159
 160     /* reserve 0xE0-E7 for Modifiers */
 161
 162     /* Layer Switching */
 163     KB_FN0 = 0xE8,
 164     KB_FN1,
 165     KB_FN2,
 166     KB_FN3,
 167     KB_FN4,
 168     KB_FN5,
 169     KB_FN6,
 170     KB_FN7,
 171
 172     /* Mousekey */
 173     KB_MS_UP = 0xF0,
 174     KB_MS_DOWN,
 175     KB_MS_LEFT,
 176     KB_MS_RIGHT,
 177     KB_MS_BTN1,
 178     KB_MS_BTN2,
 179     KB_MS_BTN3,
 180     KB_MS_BTN4,
 181     KB_MS_BTN5,
 182     /* Mousekey wheel */
 183     KB_MS_WH_UP,
 184     KB_MS_WH_DOWN,
 185     KB_MS_WH_LEFT,
 186     KB_MS_WH_RIGHT,
 187 };
 188
 189 enum keycodes {
 190     KB_NO = 0,
 191     KB_ROLL_OVER,
 192     KB_POST_FAIL,
 193     KB_UNDEFINED,
 194     KB_A,
 195     KB_B,
 196     KB_C,
 197     KB_D,
 198     KB_E,
 199     KB_F,
 200     KB_G,
 201     KB_H,
 202     KB_I,
 203     KB_J,
 204     KB_K,
 205     KB_L,
 206     KB_M,               /* 0x10 */
 207     KB_N,
 208     KB_O,
 209     KB_P,
 210     KB_Q,
 211     KB_R,
 212     KB_S,
 213     KB_T,
 214     KB_U,
 215     KB_V,
 216     KB_W,
 217     KB_X,
 218     KB_Y,
 219     KB_Z,
 220     KB_1,
 221     KB_2,
 222     KB_3,               /* 0x20 */
 223     KB_4,
 224     KB_5,
 225     KB_6,
 226     KB_7,
 227     KB_8,
 228     KB_9,
 229     KB_0,
 230     KB_ENTER,
 231     KB_ESCAPE,
 232     KB_BSPACE,
 233     KB_TAB,
 234     KB_SPACE,
 235     KB_MINUS,
 236     KB_EQUAL,
 237     KB_LBRACKET,
 238     KB_RBRACKET,        /* 0x30 */
 239     KB_BSLASH,          /* \ (and |) */
 240     KB_NONUS_HASH,      /* Non-US # and ~ */
 241     KB_SCOLON,          /* ; (and :) */
 242     KB_QUOTE,           /* ' and " */
 243     KB_GRAVE,           /* Grave accent and tilde */
 244     KB_COMMA,           /* , and < */
 245     KB_DOT,             /* . and > */
 246     KB_SLASH,           /* / and ? */
 247     KB_CAPSLOCK,
 248     KB_F1,
 249     KB_F2,
 250     KB_F3,
 251     KB_F4,
 252     KB_F5,
 253     KB_F6,
 254     KB_F7,              /* 0x40 */
 255     KB_F8,
 256     KB_F9,
 257     KB_F10,
 258     KB_F11,
 259     KB_F12,
 260     KB_PSCREEN,
 261     KB_SCKLOCK,
 262     KB_BREAK,
 263     KB_INSERT,
 264     KB_HOME,
 265     KB_PGUP,
 266     KB_DELETE,
 267     KB_END,
 268     KB_PGDOWN,
 269     KB_RIGHT,
 270     KB_LEFT,            /* 0x50 */
 271     KB_DOWN,
 272     KB_UP,
 273     KB_NUMLOCK,
 274     KB_KP_SLASH,
 275     KB_KP_ASTERISK,
 276     KB_KP_MINUS,
 277     KB_KP_PLUS,
 278     KB_KP_ENTER,
 279     KB_KP_1,
 280     KB_KP_2,
 281     KB_KP_3,
 282     KB_KP_4,
 283     KB_KP_5,
 284     KB_KP_6,
 285     KB_KP_7,
 286     KB_KP_8,            /* 0x60 */
 287     KB_KP_9,
 288     KB_KP_0,
 289     KB_KP_DOT,
 290     KB_NONUS_BSLASH,    /* Non-US \ and | */
 291     KB_APPLICATION,
 292     KB_POWER,
 293     KB_KP_EQUAL,
 294     KB_F13,
 295     KB_F14,
 296     KB_F15,
 297     KB_F16,
 298     KB_F17,
 299     KB_F18,
 300     KB_F19,
 301     KB_F20,
 302     KB_F21,             /* 0x70 */
 303     KB_F22,
 304     KB_F23,
 305     KB_F24,
 306     KB_EXECUTE,
 307     KB_HELP,
 308     KB_MENU,
 309     KB_SELECT,
 310     KB_STOP,
 311     KB_AGAIN,
 312     KB_UNDO,
 313     KB_CUT,
 314     KB_COPY,
 315     KB_PASTE,
 316     KB_FIND,
 317     KB__MUTE,
 318     KB__VOLUP,          /* 0x80 */
 319     KB__VOLDOWN,
 320     KB_LOCKING_CAPS,    /* locking Caps Lock */
 321     KB_LOCKING_NUM,     /* locking Num Lock */
 322     KB_LOCKING_SCROLL,  /* locking Scroll Lock */
 323     KB_KP_COMMA,
 324     KB_KP_EQUAL_AS400,  /* equal sign on AS/400 */
 325     KB_INT1,
 326     KB_INT2,
 327     KB_INT3,
 328     KB_INT4,
 329     KB_INT5,
 330     KB_INT6,
 331     KB_INT7,
 332     KB_INT8,
 333     KB_INT9,
 334     KB_LANG1,           /* 0x90 */
 335     KB_LANG2,
 336     KB_LANG3,
 337     KB_LANG4,
 338     KB_LANG5,
 339     KB_LANG6,
 340     KB_LANG7,
 341     KB_LANG8,
 342     KB_LANG9,
 343     KB_ALT_ERASE,
 344     KB_SYSREQ,
 345     KB_CANCEL,
 346     KB_CLEAR,
 347     KB_PRIOR,
 348     KB_RETURN,
 349     KB_SEPARATOR,
 350     KB_OUT,             /* 0xA0 */
 351     KB_OPER,
 352     KB_CLEAR_AGAIN,
 353     KB_CRSEL,
 354     KB_EXSEL,
 355
 356     /* NOTE: uses 0xB0-DF for special keycodes */
 357     KB_KP_00 = 0xB0,
 358     KB_KP_000,
 359     KB_THOUSANDS_SEPARATOR,
 360     KB_DECIMAL_SEPARATOR,
 361     KB_CURRENCY_UNIT,
 362     KB_CURRENCY_SUB_UNIT,
 363     KB_KP_LPAREN,
 364     KB_KP_RPAREN,
 365     KB_KP_LCBRACKET,    /* { */
 366     KB_KP_RCBRACKET,    /* } */
 367     KB_KP_TAB,
 368     KB_KP_BSPACE,
 369     KB_KP_A,
 370     KB_KP_B,
 371     KB_KP_C,
 372     KB_KP_D,
 373     KB_KP_E,            /* 0xC0 */
 374     KB_KP_F,
 375     KB_KP_XOR,
 376     KB_KP_HAT,
 377     KB_KP_PERC,
 378     KB_KP_LT,
 379     KB_KP_GT,
 380     KB_KP_AND,
 381     KB_KP_LAZYAND,
 382     KB_KP_OR,
 383     KB_KP_LAZYOR,
 384     KB_KP_COLON,
 385     KB_KP_HASH,
 386     KB_KP_SPACE,
 387     KB_KP_ATMARK,
 388     KB_KP_EXCLAMATION,
 389     KB_KP_MEM_STORE,    /* 0xD0 */
 390     KB_KP_MEM_RECALL,
 391     KB_KP_MEM_CLEAR,
 392     KB_KP_MEM_ADD,
 393     KB_KP_MEM_SUB,
 394     KB_KP_MEM_MUL,
 395     KB_KP_MEM_DIV,
 396     KB_KP_PLUS_MINUS,
 397     KB_KP_CLEAR,
 398     KB_KP_CLEAR_ENTRY,
 399     KB_KP_BINARY,
 400     KB_KP_OCTAL,
 401     KB_KP_DECIMAL,
 402     KB_KP_HEXADECIMAL,
 403
 404     /* Modifiers */
 405     KB_LCTRL = 0xE0,
 406     KB_LSHIFT,
 407     KB_LALT,
 408     KB_LGUI,
 409     KB_RCTRL,
 410     KB_RSHIFT,
 411     KB_RALT,
 412     KB_RGUI,
 413
 414     /* NOTE: uses 0xE8-FF for special keycodes */
 415 };
 416
 417 #endif /* USB_KEYCODES_H */