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 Keyboard/Keypad Usage Page (0x07) plus media keys from Generic Desktop Page (0x01) and Consumer Page (0x0C)
21 * See https://web.archive.org/web/20060218214400/http://www.usb.org/developers/devclass_docs/Hut1_12.pdf
22 * or http://www.usb.org/developers/hidpage/Hut1_12v2.pdf (older)
27 /* FIXME: Add doxygen comments here */
29 #define IS_ERROR(code) (KC_ROLL_OVER <= (code) && (code) <= KC_UNDEFINED)
30 #define IS_ANY(code) (KC_A <= (code) && (code) <= 0xFF)
31 #define IS_KEY(code) (KC_A <= (code) && (code) <= KC_EXSEL)
32 #define IS_MOD(code) (KC_LCTRL <= (code) && (code) <= KC_RGUI)
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_BRID)
38 #define IS_FN(code) (KC_FN0 <= (code) && (code) <= KC_FN31)
40 #define IS_MOUSEKEY(code) (KC_MS_UP <= (code) && (code) <= KC_MS_ACCEL2)
41 #define IS_MOUSEKEY_MOVE(code) (KC_MS_UP <= (code) && (code) <= KC_MS_RIGHT)
42 #define IS_MOUSEKEY_BUTTON(code) (KC_MS_BTN1 <= (code) && (code) <= KC_MS_BTN5)
43 #define IS_MOUSEKEY_WHEEL(code) (KC_MS_WH_UP <= (code) && (code) <= KC_MS_WH_RIGHT)
44 #define IS_MOUSEKEY_ACCEL(code) (KC_MS_ACCEL0 <= (code) && (code) <= KC_MS_ACCEL2)
46 #define MOD_BIT(code) (1 << MOD_INDEX(code))
47 #define MOD_INDEX(code) ((code) & 0x07)
49 #define MOD_MASK_CTRL (MOD_BIT(KC_LCTRL) | MOD_BIT(KC_RCTRL))
50 #define MOD_MASK_SHIFT (MOD_BIT(KC_LSHIFT) | MOD_BIT(KC_RSHIFT))
51 #define MOD_MASK_ALT (MOD_BIT(KC_LALT) | MOD_BIT(KC_RALT))
52 #define MOD_MASK_GUI (MOD_BIT(KC_LGUI) | MOD_BIT(KC_RGUI))
53 #define MOD_MASK_CS (MOD_MASK_CTRL | MOD_MASK_SHIFT)
54 #define MOD_MASK_CA (MOD_MASK_CTRL | MOD_MASK_ALT)
55 #define MOD_MASK_CG (MOD_MASK_CTRL | MOD_MASK_GUI)
56 #define MOD_MASK_SA (MOD_MASK_SHIFT | MOD_MASK_ALT)
57 #define MOD_MASK_SG (MOD_MASK_SHIFT | MOD_MASK_GUI)
58 #define MOD_MASK_AG (MOD_MASK_ALT | MOD_MASK_GUI)
59 #define MOD_MASK_CSA (MOD_MASK_CTRL | MOD_MASK_SHIFT | MOD_MASK_ALT)
60 #define MOD_MASK_CSG (MOD_MASK_CTRL | MOD_MASK_SHIFT | MOD_MASK_GUI)
61 #define MOD_MASK_CAG (MOD_MASK_CTRL | MOD_MASK_ALT | MOD_MASK_GUI)
62 #define MOD_MASK_SAG (MOD_MASK_SHIFT | MOD_MASK_ALT | MOD_MASK_GUI)
63 #define MOD_MASK_CSAG (MOD_MASK_CTRL | MOD_MASK_SHIFT | MOD_MASK_ALT | MOD_MASK_GUI)
65 #define FN_BIT(code) (1 << FN_INDEX(code))
66 #define FN_INDEX(code) ((code) - KC_FN0)
68 #define FN_MAX KC_FN31
71 * Short names for ease of definition of keymap
74 #define KC_TRANSPARENT 0x01
75 #define KC_TRNS KC_TRANSPARENT
78 #define KC_ENT KC_ENTER
79 #define KC_ESC KC_ESCAPE
80 #define KC_BSPC KC_BSPACE
81 #define KC_SPC KC_SPACE
82 #define KC_MINS KC_MINUS
83 #define KC_EQL KC_EQUAL
84 #define KC_LBRC KC_LBRACKET
85 #define KC_RBRC KC_RBRACKET
86 #define KC_BSLS KC_BSLASH
87 #define KC_NUHS KC_NONUS_HASH
88 #define KC_SCLN KC_SCOLON
89 #define KC_QUOT KC_QUOTE
90 #define KC_GRV KC_GRAVE
91 #define KC_COMM KC_COMMA
92 #define KC_SLSH KC_SLASH
93 #define KC_NUBS KC_NONUS_BSLASH
96 #define KC_CLCK KC_CAPSLOCK
97 #define KC_CAPS KC_CAPSLOCK
98 #define KC_SLCK KC_SCROLLLOCK
99 #define KC_NLCK KC_NUMLOCK
100 #define KC_LCAP KC_LOCKING_CAPS
101 #define KC_LNUM KC_LOCKING_NUM
102 #define KC_LSCR KC_LOCKING_SCROLL
105 #define KC_PSCR KC_PSCREEN
106 #define KC_PAUS KC_PAUSE
107 #define KC_BRK KC_PAUSE
108 #define KC_INS KC_INSERT
109 #define KC_DEL KC_DELETE
110 #define KC_PGDN KC_PGDOWN
111 #define KC_RGHT KC_RIGHT
112 #define KC_APP KC_APPLICATION
113 #define KC_EXEC KC_EXECUTE
114 #define KC_SLCT KC_SELECT
115 #define KC_AGIN KC_AGAIN
116 #define KC_PSTE KC_PASTE
117 #define KC_ERAS KC_ALT_ERASE
118 #define KC_CLR KC_CLEAR
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_PENT KC_KP_ENTER
126 #define KC_P1 KC_KP_1
127 #define KC_P2 KC_KP_2
128 #define KC_P3 KC_KP_3
129 #define KC_P4 KC_KP_4
130 #define KC_P5 KC_KP_5
131 #define KC_P6 KC_KP_6
132 #define KC_P7 KC_KP_7
133 #define KC_P8 KC_KP_8
134 #define KC_P9 KC_KP_9
135 #define KC_P0 KC_KP_0
136 #define KC_PDOT KC_KP_DOT
137 #define KC_PEQL KC_KP_EQUAL
138 #define KC_PCMM KC_KP_COMMA
140 /* Japanese specific */
141 #define KC_ZKHK KC_GRAVE
142 #define KC_RO KC_INT1
143 #define KC_KANA KC_INT2
144 #define KC_JYEN KC_INT3
145 #define KC_HENK KC_INT4
146 #define KC_MHEN KC_INT5
148 /* Korean specific */
149 #define KC_HAEN KC_LANG1
150 #define KC_HANJ KC_LANG2
153 #define KC_LCTL KC_LCTRL
154 #define KC_LSFT KC_LSHIFT
155 #define KC_LCMD KC_LGUI
156 #define KC_LWIN KC_LGUI
157 #define KC_RCTL KC_RCTRL
158 #define KC_RSFT KC_RSHIFT
159 #define KC_ALGR KC_RALT
160 #define KC_RCMD KC_RGUI
161 #define KC_RWIN KC_RGUI
163 /* Generic Desktop Page (0x01) */
164 #define KC_PWR KC_SYSTEM_POWER
165 #define KC_SLEP KC_SYSTEM_SLEEP
166 #define KC_WAKE KC_SYSTEM_WAKE
168 /* Consumer Page (0x0C) */
169 #define KC_MUTE KC_AUDIO_MUTE
170 #define KC_VOLU KC_AUDIO_VOL_UP
171 #define KC_VOLD KC_AUDIO_VOL_DOWN
172 #define KC_MNXT KC_MEDIA_NEXT_TRACK
173 #define KC_MPRV KC_MEDIA_PREV_TRACK
174 #define KC_MSTP KC_MEDIA_STOP
175 #define KC_MPLY KC_MEDIA_PLAY_PAUSE
176 #define KC_MSEL KC_MEDIA_SELECT
177 #define KC_EJCT KC_MEDIA_EJECT
178 #define KC_MAIL KC_MAIL
179 #define KC_CALC KC_CALCULATOR
180 #define KC_MYCM KC_MY_COMPUTER
181 #define KC_WSCH KC_WWW_SEARCH
182 #define KC_WHOM KC_WWW_HOME
183 #define KC_WBAK KC_WWW_BACK
184 #define KC_WFWD KC_WWW_FORWARD
185 #define KC_WSTP KC_WWW_STOP
186 #define KC_WREF KC_WWW_REFRESH
187 #define KC_WFAV KC_WWW_FAVORITES
188 #define KC_MFFD KC_MEDIA_FAST_FORWARD
189 #define KC_MRWD KC_MEDIA_REWIND
190 #define KC_BRIU KC_BRIGHTNESS_UP
191 #define KC_BRID KC_BRIGHTNESS_DOWN
193 /* System Specific */
194 #define KC_BRMU KC_PAUSE
195 #define KC_BRMD KC_SCROLLLOCK
198 #define KC_MS_U KC_MS_UP
199 #define KC_MS_D KC_MS_DOWN
200 #define KC_MS_L KC_MS_LEFT
201 #define KC_MS_R KC_MS_RIGHT
202 #define KC_BTN1 KC_MS_BTN1
203 #define KC_BTN2 KC_MS_BTN2
204 #define KC_BTN3 KC_MS_BTN3
205 #define KC_BTN4 KC_MS_BTN4
206 #define KC_BTN5 KC_MS_BTN5
207 #define KC_WH_U KC_MS_WH_UP
208 #define KC_WH_D KC_MS_WH_DOWN
209 #define KC_WH_L KC_MS_WH_LEFT
210 #define KC_WH_R KC_MS_WH_RIGHT
211 #define KC_ACL0 KC_MS_ACCEL0
212 #define KC_ACL1 KC_MS_ACCEL1
213 #define KC_ACL2 KC_MS_ACCEL2
215 /* Keyboard/Keypad Page (0x07) */
216 enum hid_keyboard_keypad_usage {
384 // ***************************************************************
385 // These keycodes are present in the HID spec, but are *
386 // nonfunctional on modern OSes. QMK uses this range (0xA5-0xDF) *
387 // for the media and function keys instead - see below. *
388 // ***************************************************************
392 KC_THOUSANDS_SEPARATOR,
393 KC_DECIMAL_SEPARATOR,
395 KC_CURRENCY_SUB_UNIT,
422 KC_KP_MEM_STORE, //0xD0
448 // **********************************************
449 // * 0xF0-0xFF are unallocated in the HID spec. *
450 // * QMK uses these for Mouse Keys - see below. *
451 // **********************************************
454 /* Media and Function keys */
455 enum internal_special_keycodes {
456 /* Generic Desktop Page (0x01) */
457 KC_SYSTEM_POWER = 0xA5,
461 /* Consumer Page (0x0C) */
470 KC_MEDIA_EJECT, //0xB0
481 KC_MEDIA_FAST_FORWARD,