]>
git.gir.st - tmk_keyboard.git/blob - common/usb_keycodes.h
2 Copyright 2011 Jun Wako <wakojun@gmail.com>
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.
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.
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/>.
19 * Key codes: HID Keyboard/Keypad Page(0x07)
20 * http://www.usb.org/developers/devclass_docs/Hut1_12.pdf
22 #ifndef USB_KEYCODES_H
23 #define USB_KEYCODES_H
26 #define IS_ERROR(code) (KB_ROLL_OVER <= (code) && (code) <= KB_UNDEFINED)
27 #define IS_ANY(code) (KB_A <= (code))
28 #define IS_KEY(code) (KB_A <= (code) && (code) <= KB_EXSEL)
29 #define IS_MOD(code) (KB_LCTRL <= (code) && (code) <= KB_RGUI)
30 #define IS_FN(code) (KB_FN0 <= (code) && (code) <= KB_FN7)
31 #define IS_MOUSEKEY(code) (KB_MS_UP <= (code) && (code) <= KB_MS_WH_RIGHT)
32 #define IS_MOUSEKEY_MOVE(code) (KB_MS_UP <= (code) && (code) <= KB_MS_RIGHT)
33 #define IS_MOUSEKEY_BUTTON(code) (KB_MS_BTN1 <= (code) && (code) <= KB_MS_BTN5)
34 #define IS_MOUSEKEY_WHEEL(code) (KB_MS_WH_UP <= (code) && (code) <= KB_MS_WH_RIGHT)
36 #define MOD_BIT(code) (1<<((code) & 0x07))
37 #define FN_BIT(code) (1<<((code) - KB_FN0))
38 #define FN_INDEX(code) ((code) - KB_FN0)
42 #define KB_LCTL KB_LCTRL
43 #define KB_RCTL KB_RCTRL
44 #define KB_LSFT KB_LSHIFT
45 #define KB_RSFT KB_RSHIFT
46 #define KB_ESC KB_ESCAPE
47 #define KB_BSPC KB_BSPACE
48 #define KB_ENT KB_ENTER
49 #define KB_DEL KB_DELETE
50 #define KB_INS KB_INSERT
51 #define KB_CAPS KB_CAPSLOCK
52 #define KB_RGHT KB_RIGHT
53 #define KB_PGDN KB_PGDOWN
54 #define KB_PSCR KB_PSCREEN
55 #define KB_SLCK KB_SCKLOCK
56 #define KB_PAUS KB_PAUSE
57 #define KB_BRK KB_PAUSE
58 #define KB_NLCK KB_NUMLOCK
59 #define KB_SPC KB_SPACE
60 #define KB_MINS KB_MINUS
61 #define KB_EQL KB_EQUAL
62 #define KB_GRV KB_GRAVE
63 #define KB_RBRC KB_RBRACKET
64 #define KB_LBRC KB_LBRACKET
65 #define KB_COMM KB_COMMA
66 #define KB_BSLS KB_BSLASH
67 #define KB_SLSH KB_SLASH
68 #define KB_SCLN KB_SCOLON
69 #define KB_QUOT KB_QUOTE
70 #define KB_APP KB_APPLICATION
71 #define KB_NUHS KB_NONUS_HASH
72 #define KB_NUBS KB_NONUS_BSLASH
73 #define KB_ERAS KB_ALT_ERASE,
74 #define KB_CLR KB_CLEAR
76 #define KB_ZKHK KB_GRAVE
78 #define KB_KANA KB_INT2
79 #define KB_JYEN KB_INT3
80 #define KB_HENK KB_INT4
81 #define KB_MHEN KB_INT5
93 #define KB_PDOT KB_KP_DOT
94 #define KB_PCMM KB_KP_COMMA
95 #define KB_PSLS KB_KP_SLASH
96 #define KB_PAST KB_KP_ASTERISK
97 #define KB_PMNS KB_KP_MINUS
98 #define KB_PPLS KB_KP_PLUS
99 #define KB_PEQL KB_KP_EQUAL
100 #define KB_PENT KB_KP_ENTER
102 #define KB_MS_U KB_MS_UP
103 #define KB_MS_D KB_MS_DOWN
104 #define KB_MS_L KB_MS_LEFT
105 #define KB_MS_R KB_MS_RIGHT
106 #define KB_BTN1 KB_MS_BTN1
107 #define KB_BTN2 KB_MS_BTN2
108 #define KB_BTN3 KB_MS_BTN3
109 #define KB_BTN4 KB_MS_BTN4
110 #define KB_BTN5 KB_MS_BTN5
111 #define KB_WH_U KB_MS_WH_UP
112 #define KB_WH_D KB_MS_WH_DOWN
113 #define KB_WH_L KB_MS_WH_LEFT
114 #define KB_WH_R KB_MS_WH_RIGHT
115 /* Sytem Control & Consumer usage */
116 #define KB_PWR KB_SYSTEM_POWER
117 #define KB_SLEP KB_SYSTEM_SLEEP
118 #define KB_WAKE KB_SYSTEM_WAKE
119 #define KB_MUTE KB_AUDIO_MUTE
120 #define KB_VOLU KB_AUDIO_VOL_UP
121 #define KB_VOLD KB_AUDIO_VOL_DOWN
122 #define KB_MNXT KB_MEDIA_NEXT_TRACK
123 #define KB_MPRV KB_MEDIA_PREV_TRACK
124 #define KB_MSTP KB_MEDIA_STOP
125 #define KB_MPLY KB_MEDIA_PLAY_PAUSE
126 #define KB_MSEL KB_MEDIA_SELECT
127 #define KB_MAIL KB_MAIL
128 #define KB_CALC KB_CALCULATOR
129 #define KB_MYCM KB_MY_COMPUTER
130 #define KB_WSCH KB_WWW_SEARCH
131 #define KB_WHOM KB_WWW_HOME
132 #define KB_WBAK KB_WWW_BACK
133 #define KB_WFWD KB_WWW_FORWARD
134 #define KB_WSTP KB_WWW_STOP
135 #define KB_WREF KB_WWW_REFRESH
136 #define KB_WFAV KB_WWW_FAVORITES
139 /* Special keycode */
140 enum special_keycodes
{
142 KB_SYSTEM_POWER
= 0xB0,
160 KB_WWW_BACK
, /* 0xC0 */
166 /* reserve 0xE0-E7 for Modifiers */
168 /* Layer Switching */
244 KB_RBRACKET
, /* 0x30 */
245 KB_BSLASH
, /* \ (and |) */
246 KB_NONUS_HASH
, /* Non-US # and ~ */
247 KB_SCOLON
, /* ; (and :) */
248 KB_QUOTE
, /* ' and " */
249 KB_GRAVE
, /* Grave accent and tilde */
250 KB_COMMA
, /* , and < */
251 KB_DOT
, /* . and > */
252 KB_SLASH
, /* / and ? */
296 KB_NONUS_BSLASH
, /* Non-US \ and | */
324 KB__VOLUP
, /* 0x80 */
326 KB_LOCKING_CAPS
, /* locking Caps Lock */
327 KB_LOCKING_NUM
, /* locking Num Lock */
328 KB_LOCKING_SCROLL
, /* locking Scroll Lock */
330 KB_KP_EQUAL_AS400
, /* equal sign on AS/400 */
362 /* NOTE: 0xB0-DF are used as special_keycodes */
366 KB_THOUSANDS_SEPARATOR
,
367 KB_DECIMAL_SEPARATOR
,
369 KB_CURRENCY_SUB_UNIT
,
372 KB_KP_LCBRACKET
, /* { */
373 KB_KP_RCBRACKET
, /* } */
396 KB_KP_MEM_STORE
, /* 0xD0 */
422 /* NOTE: 0xE8-FF are used as special_keycodes */
425 #endif /* USB_KEYCODES_H */