2 Copyright 2011,2012 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 * Keycodes based on HID Usage Keyboard/Keypad Page(0x07) plus special codes
20 * http://www.usb.org/developers/devclass_docs/Hut1_12.pdf
26 #define IS_ERROR(code) (KC_ROLL_OVER <= (code) && (code) <= KC_UNDEFINED)
27 #define IS_ANY(code) (KC_A <= (code) && (code) <= 0xFF)
29 #ifndef ACTIONMAP_ENABLE
30 #define IS_KEY(code) (KC_A <= (code) && (code) <= KC_EXSEL)
32 #define IS_KEY(code) ((KC_A <= (code) && (code) <= KC_EXSEL) || \
33 (KC_KP_00 <= (code) && (code) <= KC_KP_HEXADECIMAL))
36 #define IS_MOD(code) (KC_LCTRL <= (code) && (code) <= KC_RGUI)
39 #define IS_SPECIAL(code) ((0xA5 <= (code) && (code) <= 0xDF) || (0xE8 <= (code) && (code) <= 0xFF))
40 #define IS_SYSTEM(code) (KC_PWR <= (code) && (code) <= KC_WAKE)
41 #define IS_CONSUMER(code) (KC_MUTE <= (code) && (code) <= KC_WFAV)
42 #define IS_FN(code) (KC_FN0 <= (code) && (code) <= KC_FN31)
43 #define IS_MOUSEKEY(code) (KC_MS_UP <= (code) && (code) <= KC_MS_ACCEL2)
44 #define IS_MOUSEKEY_MOVE(code) (KC_MS_UP <= (code) && (code) <= KC_MS_RIGHT)
45 #define IS_MOUSEKEY_BUTTON(code) (KC_MS_BTN1 <= (code) && (code) <= KC_MS_BTN5)
46 #define IS_MOUSEKEY_WHEEL(code) (KC_MS_WH_UP <= (code) && (code) <= KC_MS_WH_RIGHT)
47 #define IS_MOUSEKEY_ACCEL(code) (KC_MS_ACCEL0 <= (code) && (code) <= KC_MS_ACCEL2)
49 #define MOD_BIT(code) (1<<MOD_INDEX(code))
50 #define MOD_INDEX(code) ((code) & 0x07)
51 #define FN_BIT(code) (1<<FN_INDEX(code))
52 #define FN_INDEX(code) ((code) - KC_FN0)
54 #define FN_MAX KC_FN31
58 * Short names for ease of definition of keymap
60 #define KC_LCTL KC_LCTRL
61 #define KC_RCTL KC_RCTRL
62 #define KC_LSFT KC_LSHIFT
63 #define KC_RSFT KC_RSHIFT
64 #define KC_ESC KC_ESCAPE
65 #define KC_BSPC KC_BSPACE
66 #define KC_ENT KC_ENTER
67 #define KC_DEL KC_DELETE
68 #define KC_INS KC_INSERT
69 #define KC_CAPS KC_CAPSLOCK
70 #define KC_CLCK KC_CAPSLOCK
71 #define KC_RGHT KC_RIGHT
72 #define KC_PGDN KC_PGDOWN
73 #define KC_PSCR KC_PSCREEN
74 #define KC_SLCK KC_SCROLLLOCK
75 #define KC_PAUS KC_PAUSE
76 #define KC_BRK KC_PAUSE
77 #define KC_NLCK KC_NUMLOCK
78 #define KC_SPC KC_SPACE
79 #define KC_MINS KC_MINUS
80 #define KC_EQL KC_EQUAL
81 #define KC_GRV KC_GRAVE
82 #define KC_RBRC KC_RBRACKET
83 #define KC_LBRC KC_LBRACKET
84 #define KC_COMM KC_COMMA
85 #define KC_BSLS KC_BSLASH
86 #define KC_SLSH KC_SLASH
87 #define KC_SCLN KC_SCOLON
88 #define KC_QUOT KC_QUOTE
89 #define KC_APP KC_APPLICATION
90 #define KC_NUHS KC_NONUS_HASH
91 #define KC_NUBS KC_NONUS_BSLASH
92 #define KC_LCAP KC_LOCKING_CAPS
93 #define KC_LNUM KC_LOCKING_NUM
94 #define KC_LSCR KC_LOCKING_SCROLL
95 #define KC_ERAS KC_ALT_ERASE
96 #define KC_CLR KC_CLEAR
97 /* Japanese specific */
98 #define KC_ZKHK KC_GRAVE
100 #define KC_KANA KC_INT2
101 #define KC_JYEN KC_INT3
102 #define KC_JPY KC_INT3
103 #define KC_HENK KC_INT4
104 #define KC_MHEN KC_INT5
105 /* Korean specific */
106 #define KC_HAEN KC_LANG1
107 #define KC_HANJ KC_LANG2
109 #define KC_P1 KC_KP_1
110 #define KC_P2 KC_KP_2
111 #define KC_P3 KC_KP_3
112 #define KC_P4 KC_KP_4
113 #define KC_P5 KC_KP_5
114 #define KC_P6 KC_KP_6
115 #define KC_P7 KC_KP_7
116 #define KC_P8 KC_KP_8
117 #define KC_P9 KC_KP_9
118 #define KC_P0 KC_KP_0
119 #define KC_PDOT KC_KP_DOT
120 #define KC_PCMM KC_KP_COMMA
121 #define KC_PSLS KC_KP_SLASH
122 #define KC_PAST KC_KP_ASTERISK
123 #define KC_PMNS KC_KP_MINUS
124 #define KC_PPLS KC_KP_PLUS
125 #define KC_PEQL KC_KP_EQUAL
126 #define KC_PENT KC_KP_ENTER
127 /* Unix function key */
128 #define KC_EXEC KC_EXECUTE
129 #define KC_SLCT KC_SELECT
130 #define KC_AGIN KC_AGAIN
131 #define KC_PSTE KC_PASTE
133 #define KC_MS_U KC_MS_UP
134 #define KC_MS_D KC_MS_DOWN
135 #define KC_MS_L KC_MS_LEFT
136 #define KC_MS_R KC_MS_RIGHT
137 #define KC_BTN1 KC_MS_BTN1
138 #define KC_BTN2 KC_MS_BTN2
139 #define KC_BTN3 KC_MS_BTN3
140 #define KC_BTN4 KC_MS_BTN4
141 #define KC_BTN5 KC_MS_BTN5
142 #define KC_WH_U KC_MS_WH_UP
143 #define KC_WH_D KC_MS_WH_DOWN
144 #define KC_WH_L KC_MS_WH_LEFT
145 #define KC_WH_R KC_MS_WH_RIGHT
146 #define KC_ACL0 KC_MS_ACCEL0
147 #define KC_ACL1 KC_MS_ACCEL1
148 #define KC_ACL2 KC_MS_ACCEL2
150 #define KC_PWR KC_SYSTEM_POWER
151 #define KC_SLEP KC_SYSTEM_SLEEP
152 #define KC_WAKE KC_SYSTEM_WAKE
154 #define KC_MUTE KC_AUDIO_MUTE
155 #define KC_VOLU KC_AUDIO_VOL_UP
156 #define KC_VOLD KC_AUDIO_VOL_DOWN
157 #define KC_MNXT KC_MEDIA_NEXT_TRACK
158 #define KC_MPRV KC_MEDIA_PREV_TRACK
159 #define KC_MFFD KC_MEDIA_FAST_FORWARD
160 #define KC_MRWD KC_MEDIA_REWIND
161 #define KC_MSTP KC_MEDIA_STOP
162 #define KC_MPLY KC_MEDIA_PLAY_PAUSE
163 #define KC_EJCT KC_MEDIA_EJECT
164 #define KC_MSEL KC_MEDIA_SELECT
165 #define KC_MAIL KC_MAIL
166 #define KC_CALC KC_CALCULATOR
167 #define KC_MYCM KC_MY_COMPUTER
168 #define KC_WSCH KC_WWW_SEARCH
169 #define KC_WHOM KC_WWW_HOME
170 #define KC_WBAK KC_WWW_BACK
171 #define KC_WFWD KC_WWW_FORWARD
172 #define KC_WSTP KC_WWW_STOP
173 #define KC_WREF KC_WWW_REFRESH
174 #define KC_WFAV KC_WWW_FAVORITES
175 /* Jump to bootloader */
176 #define KC_BTLD KC_BOOTLOADER
178 #define KC_TRANSPARENT 1
179 #define KC_TRNS KC_TRANSPARENT
183 /* USB HID Keyboard/Keypad Usage(0x07) */
184 enum hid_keyboard_keypad_usage {
233 KC_RBRACKET, /* 0x30 */
234 KC_BSLASH, /* \ (and |) */
235 KC_NONUS_HASH, /* Non-US # and ~ (Typically near the Enter key) */
236 KC_SCOLON, /* ; (and :) */
237 KC_QUOTE, /* ' and " */
238 KC_GRAVE, /* Grave accent and tilde */
239 KC_COMMA, /* , and < */
240 KC_DOT, /* . and > */
241 KC_SLASH, /* / and ? */
285 KC_NONUS_BSLASH, /* Non-US \ and | (Typically near the Left-Shift key) */
313 KC__VOLUP, /* 0x80 */
315 KC_LOCKING_CAPS, /* locking Caps Lock */
316 KC_LOCKING_NUM, /* locking Num Lock */
317 KC_LOCKING_SCROLL, /* locking Scroll Lock */
319 KC_KP_EQUAL_AS400, /* equal sign on AS/400 */
351 /* NOTE: Following code range(0xB0-DD) are shared with special codes of 8-bit keymap */
354 KC_THOUSANDS_SEPARATOR,
355 KC_DECIMAL_SEPARATOR,
357 KC_CURRENCY_SUB_UNIT,
360 KC_KP_LCBRACKET, /* { */
361 KC_KP_RCBRACKET, /* } */
384 KC_KP_MEM_STORE, /* 0xD0 */
397 KC_KP_HEXADECIMAL, /* 0xDD */
410 /* Special keycodes for 8-bit keymap
411 NOTE: 0xA5-DF and 0xE8-FF are used for internal special purpose */
412 enum internal_special_keycodes {
414 KC_SYSTEM_POWER = 0xA5,
424 KC_MEDIA_FAST_FORWARD,
439 KC_WWW_FAVORITES, /* 0xBC */
441 /* Jump to bootloader */
442 KC_BOOTLOADER = 0xBF,
479 /**************************************/
480 /* 0xE0-E7 for Modifiers. DO NOT USE. */
481 /**************************************/
492 KC_MS_BTN5, /* 0xF8 */
497 KC_MS_WH_RIGHT, /* 0xFC */
501 KC_MS_ACCEL2 /* 0xFF */
504 #endif /* KEYCODE_H */