usb_keycodes.h

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