1 /* Copyright (c) 2010-2011 mbed.org, MIT License
3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
4 * and associated documentation files (the "Software"), to deal in the Software without
5 * restriction, including without limitation the rights to use, copy, modify, merge, publish,
6 * distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the
7 * Software is furnished to do so, subject to the following conditions:
9 * The above copyright notice and this permission notice shall be included in all copies or
10 * substantial portions of the Software.
12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
20 #include "USBMouseKeyboard.h"
24 unsigned char modifier
;
28 /* US keyboard (as HID standard) */
29 #define KEYMAP_SIZE (148)
30 const KEYMAP keymap
[KEYMAP_SIZE
] = {
39 {0x2a, 0}, /* BS */ /* Keyboard Delete (Backspace) */
40 {0x2b, 0}, /* TAB */ /* Keyboard Tab */
41 {0x28, 0}, /* LF */ /* Keyboard Return (Enter) */
64 {0x1e, KEY_SHIFT
}, /* ! */
65 {0x34, KEY_SHIFT
}, /* " */
66 {0x20, KEY_SHIFT
}, /* # */
67 {0x21, KEY_SHIFT
}, /* $ */
68 {0x22, KEY_SHIFT
}, /* % */
69 {0x24, KEY_SHIFT
}, /* & */
71 {0x26, KEY_SHIFT
}, /* ( */
72 {0x27, KEY_SHIFT
}, /* ) */
73 {0x25, KEY_SHIFT
}, /* * */
74 {0x2e, KEY_SHIFT
}, /* + */
89 {0x33, KEY_SHIFT
}, /* : */
91 {0x36, KEY_SHIFT
}, /* < */
93 {0x37, KEY_SHIFT
}, /* > */
94 {0x38, KEY_SHIFT
}, /* ? */
95 {0x1f, KEY_SHIFT
}, /* @ */
96 {0x04, KEY_SHIFT
}, /* A */
97 {0x05, KEY_SHIFT
}, /* B */
98 {0x06, KEY_SHIFT
}, /* C */
99 {0x07, KEY_SHIFT
}, /* D */
100 {0x08, KEY_SHIFT
}, /* E */
101 {0x09, KEY_SHIFT
}, /* F */
102 {0x0a, KEY_SHIFT
}, /* G */
103 {0x0b, KEY_SHIFT
}, /* H */
104 {0x0c, KEY_SHIFT
}, /* I */
105 {0x0d, KEY_SHIFT
}, /* J */
106 {0x0e, KEY_SHIFT
}, /* K */
107 {0x0f, KEY_SHIFT
}, /* L */
108 {0x10, KEY_SHIFT
}, /* M */
109 {0x11, KEY_SHIFT
}, /* N */
110 {0x12, KEY_SHIFT
}, /* O */
111 {0x13, KEY_SHIFT
}, /* P */
112 {0x14, KEY_SHIFT
}, /* Q */
113 {0x15, KEY_SHIFT
}, /* R */
114 {0x16, KEY_SHIFT
}, /* S */
115 {0x17, KEY_SHIFT
}, /* T */
116 {0x18, KEY_SHIFT
}, /* U */
117 {0x19, KEY_SHIFT
}, /* V */
118 {0x1a, KEY_SHIFT
}, /* W */
119 {0x1b, KEY_SHIFT
}, /* X */
120 {0x1c, KEY_SHIFT
}, /* Y */
121 {0x1d, KEY_SHIFT
}, /* Z */
125 {0x23, KEY_SHIFT
}, /* ^ */
126 {0x2d, KEY_SHIFT
}, /* _ */
154 {0x2f, KEY_SHIFT
}, /* { */
155 {0x31, KEY_SHIFT
}, /* | */
156 {0x30, KEY_SHIFT
}, /* } */
157 {0x35, KEY_SHIFT
}, /* ~ */
173 {0x46, 0}, /* PRINT_SCREEN */
174 {0x47, 0}, /* SCROLL_LOCK */
175 {0x39, 0}, /* CAPS_LOCK */
176 {0x53, 0}, /* NUM_LOCK */
177 {0x49, 0}, /* INSERT */
178 {0x4a, 0}, /* HOME */
179 {0x4b, 0}, /* PAGE_UP */
180 {0x4e, 0}, /* PAGE_DOWN */
185 #define KEYMAP_SIZE (148)
186 const KEYMAP keymap
[KEYMAP_SIZE
] = {
195 {0x2a, 0}, /* BS */ /* Keyboard Delete (Backspace) */
196 {0x2b, 0}, /* TAB */ /* Keyboard Tab */
197 {0x28, 0}, /* LF */ /* Keyboard Return (Enter) */
220 {0x1e, KEY_SHIFT
}, /* ! */
221 {0x1f, KEY_SHIFT
}, /* " */
223 {0x21, KEY_SHIFT
}, /* $ */
224 {0x22, KEY_SHIFT
}, /* % */
225 {0x24, KEY_SHIFT
}, /* & */
227 {0x26, KEY_SHIFT
}, /* ( */
228 {0x27, KEY_SHIFT
}, /* ) */
229 {0x25, KEY_SHIFT
}, /* * */
230 {0x2e, KEY_SHIFT
}, /* + */
245 {0x33, KEY_SHIFT
}, /* : */
247 {0x36, KEY_SHIFT
}, /* < */
249 {0x37, KEY_SHIFT
}, /* > */
250 {0x38, KEY_SHIFT
}, /* ? */
251 {0x34, KEY_SHIFT
}, /* @ */
252 {0x04, KEY_SHIFT
}, /* A */
253 {0x05, KEY_SHIFT
}, /* B */
254 {0x06, KEY_SHIFT
}, /* C */
255 {0x07, KEY_SHIFT
}, /* D */
256 {0x08, KEY_SHIFT
}, /* E */
257 {0x09, KEY_SHIFT
}, /* F */
258 {0x0a, KEY_SHIFT
}, /* G */
259 {0x0b, KEY_SHIFT
}, /* H */
260 {0x0c, KEY_SHIFT
}, /* I */
261 {0x0d, KEY_SHIFT
}, /* J */
262 {0x0e, KEY_SHIFT
}, /* K */
263 {0x0f, KEY_SHIFT
}, /* L */
264 {0x10, KEY_SHIFT
}, /* M */
265 {0x11, KEY_SHIFT
}, /* N */
266 {0x12, KEY_SHIFT
}, /* O */
267 {0x13, KEY_SHIFT
}, /* P */
268 {0x14, KEY_SHIFT
}, /* Q */
269 {0x15, KEY_SHIFT
}, /* R */
270 {0x16, KEY_SHIFT
}, /* S */
271 {0x17, KEY_SHIFT
}, /* T */
272 {0x18, KEY_SHIFT
}, /* U */
273 {0x19, KEY_SHIFT
}, /* V */
274 {0x1a, KEY_SHIFT
}, /* W */
275 {0x1b, KEY_SHIFT
}, /* X */
276 {0x1c, KEY_SHIFT
}, /* Y */
277 {0x1d, KEY_SHIFT
}, /* Z */
281 {0x23, KEY_SHIFT
}, /* ^ */
282 {0x2d, KEY_SHIFT
}, /* _ */
310 {0x2f, KEY_SHIFT
}, /* { */
311 {0x64, KEY_SHIFT
}, /* | */
312 {0x30, KEY_SHIFT
}, /* } */
313 {0x32, KEY_SHIFT
}, /* ~ */
329 {0x46, 0}, /* PRINT_SCREEN */
330 {0x47, 0}, /* SCROLL_LOCK */
331 {0x39, 0}, /* CAPS_LOCK */
332 {0x53, 0}, /* NUM_LOCK */
333 {0x49, 0}, /* INSERT */
334 {0x4a, 0}, /* HOME */
335 {0x4b, 0}, /* PAGE_UP */
336 {0x4e, 0}, /* PAGE_DOWN */
341 uint8_t * USBMouseKeyboard::reportDesc() {
342 if (mouse_type
== REL_MOUSE
) {
343 static uint8_t reportDescriptor
[] = {
348 REPORT_ID(1), REPORT_ID_KEYBOARD
,
350 USAGE_MINIMUM(1), 0xE0,
351 USAGE_MAXIMUM(1), 0xE7,
352 LOGICAL_MINIMUM(1), 0x00,
353 LOGICAL_MAXIMUM(1), 0x01,
354 REPORT_SIZE(1), 0x01,
355 REPORT_COUNT(1), 0x08,
357 REPORT_COUNT(1), 0x01,
358 REPORT_SIZE(1), 0x08,
360 REPORT_COUNT(1), 0x05,
361 REPORT_SIZE(1), 0x01,
363 USAGE_MINIMUM(1), 0x01,
364 USAGE_MAXIMUM(1), 0x05,
366 REPORT_COUNT(1), 0x01,
367 REPORT_SIZE(1), 0x03,
369 REPORT_COUNT(1), 0x06,
370 REPORT_SIZE(1), 0x08,
371 LOGICAL_MINIMUM(1), 0x00,
372 LOGICAL_MAXIMUM(2), 0xff, 0x00,
374 USAGE_MINIMUM(1), 0x00,
375 USAGE_MAXIMUM(2), 0xff, 0x00,
380 USAGE_PAGE(1), 0x01, // Generic Desktop
381 USAGE(1), 0x02, // Mouse
382 COLLECTION(1), 0x01, // Application
383 USAGE(1), 0x01, // Pointer
384 COLLECTION(1), 0x00, // Physical
385 REPORT_ID(1), REPORT_ID_MOUSE
,
386 REPORT_COUNT(1), 0x03,
387 REPORT_SIZE(1), 0x01,
388 USAGE_PAGE(1), 0x09, // Buttons
389 USAGE_MINIMUM(1), 0x1,
390 USAGE_MAXIMUM(1), 0x3,
391 LOGICAL_MINIMUM(1), 0x00,
392 LOGICAL_MAXIMUM(1), 0x01,
394 REPORT_COUNT(1), 0x01,
395 REPORT_SIZE(1), 0x05,
397 REPORT_COUNT(1), 0x03,
398 REPORT_SIZE(1), 0x08,
402 USAGE(1), 0x38, // scroll
403 LOGICAL_MINIMUM(1), 0x81,
404 LOGICAL_MAXIMUM(1), 0x7f,
414 REPORT_ID(1), REPORT_ID_VOLUME
,
416 LOGICAL_MINIMUM(1), 0x00,
417 LOGICAL_MAXIMUM(1), 0x01,
418 REPORT_SIZE(1), 0x01,
419 REPORT_COUNT(1), 0x07,
420 USAGE(1), 0xB5, // Next Track
421 USAGE(1), 0xB6, // Previous Track
422 USAGE(1), 0xB7, // Stop
423 USAGE(1), 0xCD, // Play / Pause
424 USAGE(1), 0xE2, // Mute
425 USAGE(1), 0xE9, // Volume Up
426 USAGE(1), 0xEA, // Volume Down
427 INPUT(1), 0x02, // Input (Data, Variable, Absolute)
428 REPORT_COUNT(1), 0x01,
432 reportLength
= sizeof(reportDescriptor
);
433 return reportDescriptor
;
434 } else if (mouse_type
== ABS_MOUSE
) {
435 static uint8_t reportDescriptor
[] = {
441 REPORT_ID(1), REPORT_ID_KEYBOARD
,
443 USAGE_MINIMUM(1), 0xE0,
444 USAGE_MAXIMUM(1), 0xE7,
445 LOGICAL_MINIMUM(1), 0x00,
446 LOGICAL_MAXIMUM(1), 0x01,
447 REPORT_SIZE(1), 0x01,
448 REPORT_COUNT(1), 0x08,
450 REPORT_COUNT(1), 0x01,
451 REPORT_SIZE(1), 0x08,
453 REPORT_COUNT(1), 0x05,
454 REPORT_SIZE(1), 0x01,
456 USAGE_MINIMUM(1), 0x01,
457 USAGE_MAXIMUM(1), 0x05,
459 REPORT_COUNT(1), 0x01,
460 REPORT_SIZE(1), 0x03,
462 REPORT_COUNT(1), 0x06,
463 REPORT_SIZE(1), 0x08,
464 LOGICAL_MINIMUM(1), 0x00,
465 LOGICAL_MAXIMUM(2), 0xff, 0x00,
467 USAGE_MINIMUM(1), 0x00,
468 USAGE_MAXIMUM(2), 0xff, 0x00,
473 USAGE_PAGE(1), 0x01, // Generic Desktop
474 USAGE(1), 0x02, // Mouse
475 COLLECTION(1), 0x01, // Application
476 USAGE(1), 0x01, // Pointer
477 COLLECTION(1), 0x00, // Physical
478 REPORT_ID(1), REPORT_ID_MOUSE
,
480 USAGE_PAGE(1), 0x01, // Generic Desktop
483 LOGICAL_MINIMUM(1), 0x00, // 0
484 LOGICAL_MAXIMUM(2), 0xff, 0x7f, // 32767
485 REPORT_SIZE(1), 0x10,
486 REPORT_COUNT(1), 0x02,
487 INPUT(1), 0x02, // Data, Variable, Absolute
489 USAGE_PAGE(1), 0x01, // Generic Desktop
490 USAGE(1), 0x38, // scroll
491 LOGICAL_MINIMUM(1), 0x81, // -127
492 LOGICAL_MAXIMUM(1), 0x7f, // 127
493 REPORT_SIZE(1), 0x08,
494 REPORT_COUNT(1), 0x01,
495 INPUT(1), 0x06, // Data, Variable, Relative
497 USAGE_PAGE(1), 0x09, // Buttons
498 USAGE_MINIMUM(1), 0x01,
499 USAGE_MAXIMUM(1), 0x03,
500 LOGICAL_MINIMUM(1), 0x00, // 0
501 LOGICAL_MAXIMUM(1), 0x01, // 1
502 REPORT_COUNT(1), 0x03,
503 REPORT_SIZE(1), 0x01,
504 INPUT(1), 0x02, // Data, Variable, Absolute
505 REPORT_COUNT(1), 0x01,
506 REPORT_SIZE(1), 0x05,
507 INPUT(1), 0x01, // Constant
516 REPORT_ID(1), REPORT_ID_VOLUME
,
518 LOGICAL_MINIMUM(1), 0x00,
519 LOGICAL_MAXIMUM(1), 0x01,
520 REPORT_SIZE(1), 0x01,
521 REPORT_COUNT(1), 0x07,
522 USAGE(1), 0xB5, // Next Track
523 USAGE(1), 0xB6, // Previous Track
524 USAGE(1), 0xB7, // Stop
525 USAGE(1), 0xCD, // Play / Pause
526 USAGE(1), 0xE2, // Mute
527 USAGE(1), 0xE9, // Volume Up
528 USAGE(1), 0xEA, // Volume Down
529 INPUT(1), 0x02, // Input (Data, Variable, Absolute)
530 REPORT_COUNT(1), 0x01,
534 reportLength
= sizeof(reportDescriptor
);
535 return reportDescriptor
;
541 bool USBMouseKeyboard::EP1_OUT_callback() {
542 uint16_t bytesRead
= 0;
544 USBDevice::readEP(EPINT_OUT
, led
, &bytesRead
, MAX_HID_REPORT_SIZE
);
546 // we take led[1] because led[0] is the report ID
547 lock_status
= led
[1] & 0x07;
549 // We activate the endpoint to be able to recceive data
550 if (!readStart(EPINT_OUT
, MAX_HID_REPORT_SIZE
))
555 uint8_t USBMouseKeyboard::lockStatus() {
559 bool USBMouseKeyboard::update(int16_t x
, int16_t y
, uint8_t button
, int8_t z
) {
560 switch (mouse_type
) {
563 if (!mouseSend(127, 0, button
, z
)) return false;
567 if (!mouseSend(-128, 0, button
, z
)) return false;
571 if (!mouseSend(0, 127, button
, z
)) return false;
575 if (!mouseSend(0, -128, button
, z
)) return false;
578 return mouseSend(x
, y
, button
, z
);
582 report
.data
[0] = REPORT_ID_MOUSE
;
583 report
.data
[1] = x
& 0xff;
584 report
.data
[2] = (x
>> 8) & 0xff;
585 report
.data
[3] = y
& 0xff;
586 report
.data
[4] = (y
>> 8) & 0xff;
588 report
.data
[6] = button
& 0x07;
592 return send(&report
);
598 bool USBMouseKeyboard::mouseSend(int8_t x
, int8_t y
, uint8_t buttons
, int8_t z
) {
600 report
.data
[0] = REPORT_ID_MOUSE
;
601 report
.data
[1] = buttons
& 0x07;
604 report
.data
[4] = -z
; // >0 to scroll down, <0 to scroll up
608 return send(&report
);
611 bool USBMouseKeyboard::move(int16_t x
, int16_t y
) {
612 return update(x
, y
, button
, 0);
615 bool USBMouseKeyboard::scroll(int8_t z
) {
616 return update(0, 0, button
, z
);
619 bool USBMouseKeyboard::doubleClick() {
620 if (!click(MOUSE_LEFT
))
623 return click(MOUSE_LEFT
);
626 bool USBMouseKeyboard::click(uint8_t button
) {
627 if (!update(0, 0, button
, 0))
630 return update(0, 0, 0, 0);
633 bool USBMouseKeyboard::press(uint8_t button_
) {
634 button
= button_
& 0x07;
635 return update(0, 0, button
, 0);
638 bool USBMouseKeyboard::release(uint8_t button_
) {
639 button
= (button
& (~button_
)) & 0x07;
640 return update(0, 0, button
, 0);
643 int USBMouseKeyboard::_putc(int c
) {
644 return keyCode(c
, keymap
[c
].modifier
);
647 bool USBMouseKeyboard::keyCode(uint8_t key
, uint8_t modifier
) {
648 // Send a simulated keyboard keypress. Returns true if successful.
652 report
.data
[0] = REPORT_ID_KEYBOARD
;
653 report
.data
[1] = modifier
;
655 report
.data
[3] = keymap
[key
].usage
;
664 if (!send(&report
)) {
671 if (!send(&report
)) {
680 bool USBMouseKeyboard::mediaControl(MEDIA_KEY key
) {
683 report
.data
[0] = REPORT_ID_VOLUME
;
684 report
.data
[1] = (1 << key
) & 0x7f;
690 report
.data
[0] = REPORT_ID_VOLUME
;
695 return send(&report
);