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/>.
26 #define REPORT_ID_KEYBOARD 1
27 #define REPORT_ID_MOUSE 2
28 #define REPORT_ID_SYSTEM 3
29 #define REPORT_ID_CONSUMER 4
30 #define REPORT_ID_NKRO 5
33 #define MOUSE_BTN1 (1<<0)
34 #define MOUSE_BTN2 (1<<1)
35 #define MOUSE_BTN3 (1<<2)
36 #define MOUSE_BTN4 (1<<3)
37 #define MOUSE_BTN5 (1<<4)
39 /* Consumer Page(0x0C)
40 * following are supported by Windows: http://msdn.microsoft.com/en-us/windows/hardware/gg463372.aspx
41 * see also https://docs.microsoft.com/en-us/windows-hardware/drivers/hid/display-brightness-control
43 #define AUDIO_MUTE 0x00E2
44 #define AUDIO_VOL_UP 0x00E9
45 #define AUDIO_VOL_DOWN 0x00EA
46 #define TRANSPORT_NEXT_TRACK 0x00B5
47 #define TRANSPORT_PREV_TRACK 0x00B6
48 #define TRANSPORT_STOP 0x00B7
49 #define TRANSPORT_STOP_EJECT 0x00CC
50 #define TRANSPORT_PLAY_PAUSE 0x00CD
51 #define BRIGHTNESS_UP 0x006F
52 #define BRIGHTNESS_DOWN 0x0070
53 /* application launch */
54 #define AL_CC_CONFIG 0x0183
55 #define AL_EMAIL 0x018A
56 #define AL_CALCULATOR 0x0192
57 #define AL_LOCAL_BROWSER 0x0194
58 /* application control */
59 #define AC_SEARCH 0x0221
60 #define AC_HOME 0x0223
61 #define AC_BACK 0x0224
62 #define AC_FORWARD 0x0225
63 #define AC_STOP 0x0226
64 #define AC_REFRESH 0x0227
65 #define AC_BOOKMARKS 0x022A
66 /* supplement for Bluegiga iWRAP HID(not supported by Windows?) */
67 #define AL_LOCK 0x019E
68 #define TRANSPORT_RECORD 0x00B2
69 #define TRANSPORT_FAST_FORWARD 0x00B3
70 #define TRANSPORT_REWIND 0x00B4
71 #define TRANSPORT_EJECT 0x00B8
72 #define AC_MINIMIZE 0x0206
74 /* Generic Desktop Page(0x01) - system power control */
75 #define SYSTEM_POWER_DOWN 0x0081
76 #define SYSTEM_SLEEP 0x0082
77 #define SYSTEM_WAKE_UP 0x0083
80 #define NKRO_SHARED_EP
81 /* key report size(NKRO or boot mode) */
82 #if defined(NKRO_ENABLE)
83 #if defined(PROTOCOL_LUFA) || defined(PROTOCOL_CHIBIOS)
84 #include "protocol/usb_descriptor.h"
85 #define KEYBOARD_REPORT_BITS (SHARED_EPSIZE - 2)
86 #elif defined(PROTOCOL_ARM_ATSAM)
87 #include "protocol/arm_atsam/usb/udi_device_epsize.h"
88 #define KEYBOARD_REPORT_BITS (NKRO_EPSIZE - 1)
90 #undef MOUSE_SHARED_EP
92 #error "NKRO not supported with this protocol"
96 #ifdef KEYBOARD_SHARED_EP
97 # define KEYBOARD_REPORT_SIZE 9
99 # define KEYBOARD_REPORT_SIZE 8
102 #define KEYBOARD_REPORT_KEYS 6
104 /* VUSB hardcodes keyboard and mouse+extrakey only */
105 #if defined(PROTOCOL_VUSB)
106 #undef KEYBOARD_SHARED_EP
107 #undef MOUSE_SHARED_EP
115 * keyboard report is 8-byte array retains state of 8 modifiers and 6 keys.
117 * byte |0 |1 |2 |3 |4 |5 |6 |7
118 * -----+--------+--------+--------+--------+--------+--------+--------+--------
119 * desc |mods |reserved|keys[0] |keys[1] |keys[2] |keys[3] |keys[4] |keys[5]
121 * It is exended to 16 bytes to retain 120keys+8mods when NKRO mode.
123 * byte |0 |1 |2 |3 |4 |5 |6 |7 ... |15
124 * -----+--------+--------+--------+--------+--------+--------+--------+-------- +--------
125 * desc |mods |bits[0] |bits[1] |bits[2] |bits[3] |bits[4] |bits[5] |bits[6] ... |bit[14]
127 * mods retains state of 8 modifiers.
129 * bit |0 |1 |2 |3 |4 |5 |6 |7
130 * -----+--------+--------+--------+--------+--------+--------+--------+--------
131 * desc |Lcontrol|Lshift |Lalt |Lgui |Rcontrol|Rshift |Ralt |Rgui
135 uint8_t raw[KEYBOARD_REPORT_SIZE];
137 #ifdef KEYBOARD_SHARED_EP
142 uint8_t keys[KEYBOARD_REPORT_KEYS];
146 #ifdef NKRO_SHARED_EP
150 uint8_t bits[KEYBOARD_REPORT_BITS];
153 } __attribute__ ((packed)) report_keyboard_t;
156 #ifdef MOUSE_SHARED_EP
164 } __attribute__ ((packed)) report_mouse_t;
167 /* keycode to system usage */
168 #define KEYCODE2SYSTEM(key) \
169 (key == KC_SYSTEM_POWER ? SYSTEM_POWER_DOWN : \
170 (key == KC_SYSTEM_SLEEP ? SYSTEM_SLEEP : \
171 (key == KC_SYSTEM_WAKE ? SYSTEM_WAKE_UP : 0)))
173 /* keycode to consumer usage */
174 #define KEYCODE2CONSUMER(key) \
175 (key == KC_AUDIO_MUTE ? AUDIO_MUTE : \
176 (key == KC_AUDIO_VOL_UP ? AUDIO_VOL_UP : \
177 (key == KC_AUDIO_VOL_DOWN ? AUDIO_VOL_DOWN : \
178 (key == KC_MEDIA_NEXT_TRACK ? TRANSPORT_NEXT_TRACK : \
179 (key == KC_MEDIA_PREV_TRACK ? TRANSPORT_PREV_TRACK : \
180 (key == KC_MEDIA_FAST_FORWARD ? TRANSPORT_FAST_FORWARD : \
181 (key == KC_MEDIA_REWIND ? TRANSPORT_REWIND : \
182 (key == KC_MEDIA_STOP ? TRANSPORT_STOP : \
183 (key == KC_MEDIA_EJECT ? TRANSPORT_STOP_EJECT : \
184 (key == KC_MEDIA_PLAY_PAUSE ? TRANSPORT_PLAY_PAUSE : \
185 (key == KC_MEDIA_SELECT ? AL_CC_CONFIG : \
186 (key == KC_MAIL ? AL_EMAIL : \
187 (key == KC_CALCULATOR ? AL_CALCULATOR : \
188 (key == KC_MY_COMPUTER ? AL_LOCAL_BROWSER : \
189 (key == KC_WWW_SEARCH ? AC_SEARCH : \
190 (key == KC_WWW_HOME ? AC_HOME : \
191 (key == KC_WWW_BACK ? AC_BACK : \
192 (key == KC_WWW_FORWARD ? AC_FORWARD : \
193 (key == KC_WWW_STOP ? AC_STOP : \
194 (key == KC_WWW_REFRESH ? AC_REFRESH : \
195 (key == KC_BRIGHTNESS_UP ? BRIGHTNESS_UP : \
196 (key == KC_BRIGHTNESS_DOWN ? BRIGHTNESS_DOWN : \
197 (key == KC_WWW_FAVORITES ? AC_BOOKMARKS : 0)))))))))))))))))))))))
199 uint8_t has_anykey(report_keyboard_t* keyboard_report);
200 uint8_t get_first_key(report_keyboard_t* keyboard_report);
202 void add_key_byte(report_keyboard_t* keyboard_report, uint8_t code);
203 void del_key_byte(report_keyboard_t* keyboard_report, uint8_t code);
205 void add_key_bit(report_keyboard_t* keyboard_report, uint8_t code);
206 void del_key_bit(report_keyboard_t* keyboard_report, uint8_t code);
209 void add_key_to_report(report_keyboard_t* keyboard_report, uint8_t key);
210 void del_key_from_report(report_keyboard_t* keyboard_report, uint8_t key);
211 void clear_keys_from_report(report_keyboard_t* keyboard_report);