master
c 621 lines 17.7 KB
Raw
1 /*
2 * QEMU HID devices
3 *
4 * Copyright (c) 2005 Fabrice Bellard
5 * Copyright (c) 2007 OpenMoko, Inc. (andrew@openedhand.com)
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23 * THE SOFTWARE.
24 */
25
26 #include "qemu/osdep.h"
27 #include "ui/console.h"
28 #include "ui/input.h"
29 #include "qemu/timer.h"
30 #include "hw/input/hid.h"
31 #include "migration/vmstate.h"
32 #include "trace.h"
33
34 #define HID_USAGE_ERROR_ROLLOVER 0x01
35 #define HID_USAGE_POSTFAIL 0x02
36 #define HID_USAGE_ERROR_UNDEFINED 0x03
37
38 /* Indices are QEMU keycodes, values are from HID Usage Table. Indices
39 * above 0x80 are for keys that come after 0xe0 or 0xe1+0x1d or 0xe1+0x9d. */
40 static const uint8_t hid_usage_keys[0x100] = {
41 0x00, 0x29, 0x1e, 0x1f, 0x20, 0x21, 0x22, 0x23,
42 0x24, 0x25, 0x26, 0x27, 0x2d, 0x2e, 0x2a, 0x2b,
43 0x14, 0x1a, 0x08, 0x15, 0x17, 0x1c, 0x18, 0x0c,
44 0x12, 0x13, 0x2f, 0x30, 0x28, 0xe0, 0x04, 0x16,
45 0x07, 0x09, 0x0a, 0x0b, 0x0d, 0x0e, 0x0f, 0x33,
46 0x34, 0x35, 0xe1, 0x31, 0x1d, 0x1b, 0x06, 0x19,
47 0x05, 0x11, 0x10, 0x36, 0x37, 0x38, 0xe5, 0x55,
48 0xe2, 0x2c, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e,
49 0x3f, 0x40, 0x41, 0x42, 0x43, 0x53, 0x47, 0x5f,
50 0x60, 0x61, 0x56, 0x5c, 0x5d, 0x5e, 0x57, 0x59,
51 0x5a, 0x5b, 0x62, 0x63, 0x46, 0x00, 0x64, 0x44,
52 0x45, 0x68, 0x69, 0x6a, 0x6b, 0x6c, 0x6d, 0x6e,
53 0xe8, 0xe9, 0x71, 0x72, 0x73, 0x00, 0x00, 0x00,
54 0x00, 0x00, 0x00, 0x85, 0x00, 0x00, 0x00, 0x00,
55 0x88, 0x00, 0x00, 0x87, 0x00, 0x00, 0x00, 0x00,
56 0x00, 0x8a, 0x00, 0x8b, 0x00, 0x89, 0xe7, 0x65,
57
58 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
59 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
60 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
61 0x00, 0x00, 0x00, 0x00, 0x58, 0xe4, 0x00, 0x00,
62 0x7f, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
63 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x81, 0x00,
64 0x80, 0x00, 0x00, 0x00, 0x00, 0x54, 0x00, 0x46,
65 0xe6, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
66 0x00, 0x00, 0x00, 0x00, 0x00, 0x48, 0x48, 0x4a,
67 0x52, 0x4b, 0x00, 0x50, 0x00, 0x4f, 0x00, 0x4d,
68 0x51, 0x4e, 0x49, 0x4c, 0x00, 0x00, 0x00, 0x00,
69 0x00, 0x00, 0x00, 0xe3, 0xe7, 0x65, 0x66, 0x00,
70 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
71 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
72 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
73 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
74 };
75
76 bool hid_has_events(HIDState *hs)
77 {
78 return hs->n > 0 || hs->idle_pending;
79 }
80
81 static void hid_idle_timer(void *opaque)
82 {
83 HIDState *hs = opaque;
84
85 hs->idle_pending = true;
86 hs->event(hs);
87 }
88
89 static void hid_del_idle_timer(HIDState *hs)
90 {
91 if (hs->idle_timer) {
92 timer_free(hs->idle_timer);
93 hs->idle_timer = NULL;
94 }
95 }
96
97 void hid_set_next_idle(HIDState *hs)
98 {
99 if (hs->idle) {
100 uint64_t expire_time = qemu_clock_get_ns(QEMU_CLOCK_VIRTUAL) +
101 NANOSECONDS_PER_SECOND * hs->idle * 4 / 1000;
102 if (!hs->idle_timer) {
103 hs->idle_timer = timer_new_ns(QEMU_CLOCK_VIRTUAL, hid_idle_timer, hs);
104 }
105 timer_mod_ns(hs->idle_timer, expire_time);
106 } else {
107 hid_del_idle_timer(hs);
108 }
109 }
110
111 static void hid_pointer_event(DeviceState *dev, QemuConsole *src,
112 QemuInputEvent *evt)
113 {
114 static const int bmap[INPUT_BUTTON__MAX] = {
115 [INPUT_BUTTON_LEFT] = 0x01,
116 [INPUT_BUTTON_RIGHT] = 0x02,
117 [INPUT_BUTTON_MIDDLE] = 0x04,
118 [INPUT_BUTTON_SIDE] = 0x08,
119 [INPUT_BUTTON_EXTRA] = 0x10,
120 };
121 HIDState *hs = (HIDState *)dev;
122 HIDPointerEvent *e;
123
124 assert(hs->n < QUEUE_LENGTH);
125 e = &hs->ptr.queue[(hs->head + hs->n) & QUEUE_MASK];
126
127 switch (evt->type) {
128 case INPUT_EVENT_KIND_REL:
129 if (evt->rel.axis == INPUT_AXIS_X) {
130 e->xdx += evt->rel.value;
131 } else if (evt->rel.axis == INPUT_AXIS_Y) {
132 e->ydy += evt->rel.value;
133 }
134 break;
135
136 case INPUT_EVENT_KIND_ABS:
137 if (evt->abs.axis == INPUT_AXIS_X) {
138 e->xdx = evt->abs.value;
139 } else if (evt->abs.axis == INPUT_AXIS_Y) {
140 e->ydy = evt->abs.value;
141 }
142 break;
143
144 case INPUT_EVENT_KIND_BTN:
145 if (evt->btn.down) {
146 e->buttons_state |= bmap[evt->btn.button];
147 if (evt->btn.button == INPUT_BUTTON_WHEEL_UP) {
148 e->dz--;
149 } else if (evt->btn.button == INPUT_BUTTON_WHEEL_DOWN) {
150 e->dz++;
151 }
152 } else {
153 e->buttons_state &= ~bmap[evt->btn.button];
154 }
155 break;
156
157 default:
158 /* keep gcc happy */
159 break;
160 }
161
162 }
163
164 static void hid_pointer_sync(DeviceState *dev)
165 {
166 HIDState *hs = (HIDState *)dev;
167 HIDPointerEvent *prev, *curr, *next;
168 bool event_compression = false;
169
170 if (hs->n == QUEUE_LENGTH-1) {
171 /*
172 * Queue full. We are losing information, but we at least
173 * keep track of most recent button state.
174 */
175 return;
176 }
177
178 prev = &hs->ptr.queue[(hs->head + hs->n - 1) & QUEUE_MASK];
179 curr = &hs->ptr.queue[(hs->head + hs->n) & QUEUE_MASK];
180 next = &hs->ptr.queue[(hs->head + hs->n + 1) & QUEUE_MASK];
181
182 if (hs->n > 0) {
183 /*
184 * No button state change between previous and current event
185 * (and previous wasn't seen by the guest yet), so there is
186 * motion information only and we can combine the two event
187 * into one.
188 */
189 if (curr->buttons_state == prev->buttons_state) {
190 event_compression = true;
191 }
192 }
193
194 if (event_compression) {
195 /* add current motion to previous, clear current */
196 if (hs->kind == HID_MOUSE) {
197 prev->xdx += curr->xdx;
198 curr->xdx = 0;
199 prev->ydy += curr->ydy;
200 curr->ydy = 0;
201 } else {
202 prev->xdx = curr->xdx;
203 prev->ydy = curr->ydy;
204 }
205 prev->dz += curr->dz;
206 curr->dz = 0;
207 } else {
208 /* prepare next (clear rel, copy abs + btns) */
209 if (hs->kind == HID_MOUSE) {
210 next->xdx = 0;
211 next->ydy = 0;
212 } else {
213 next->xdx = curr->xdx;
214 next->ydy = curr->ydy;
215 }
216 next->dz = 0;
217 next->buttons_state = curr->buttons_state;
218 /* make current guest visible, notify guest */
219 hs->n++;
220 hs->event(hs);
221 }
222 }
223
224 static void hid_keyboard_event(DeviceState *dev, QemuConsole *src,
225 QemuInputEvent *evt)
226 {
227 HIDState *hs = (HIDState *)dev;
228 int scancodes[3], i, count;
229 int slot;
230
231 count = qemu_input_linux_to_scancode(evt->key.key, evt->key.down,
232 scancodes);
233 if (hs->n + count > QUEUE_LENGTH) {
234 trace_hid_kbd_queue_full();
235 return;
236 }
237 for (i = 0; i < count; i++) {
238 slot = (hs->head + hs->n) & QUEUE_MASK; hs->n++;
239 hs->kbd.keycodes[slot] = scancodes[i];
240 }
241 hs->event(hs);
242 }
243
244 static void hid_keyboard_process_keycode(HIDState *hs)
245 {
246 uint8_t hid_code, index, key;
247 int i, keycode, slot;
248
249 if (hs->n == 0) {
250 return;
251 }
252 slot = hs->head & QUEUE_MASK; QUEUE_INCR(hs->head); hs->n--;
253 keycode = hs->kbd.keycodes[slot];
254
255 if (!hs->n) {
256 trace_hid_kbd_queue_empty();
257 }
258
259 key = keycode & 0x7f;
260 index = key | ((hs->kbd.modifiers & (1 << 8)) >> 1);
261 hid_code = hid_usage_keys[index];
262 hs->kbd.modifiers &= ~(1 << 8);
263
264 switch (hid_code) {
265 case 0x00:
266 return;
267
268 case 0xe0:
269 assert(key == 0x1d);
270 if (hs->kbd.modifiers & (1 << 9)) {
271 /* The hid_codes for the 0xe1/0x1d scancode sequence are 0xe9/0xe0.
272 * Here we're processing the second hid_code. By dropping bit 9
273 * and setting bit 8, the scancode after 0x1d will access the
274 * second half of the table.
275 */
276 hs->kbd.modifiers ^= (1 << 8) | (1 << 9);
277 return;
278 }
279 /* fall through to process Ctrl_L */
280 case 0xe1 ... 0xe7:
281 /* Ctrl_L/Ctrl_R, Shift_L/Shift_R, Alt_L/Alt_R, Win_L/Win_R.
282 * Handle releases here, or fall through to process presses.
283 */
284 if (keycode & (1 << 7)) {
285 hs->kbd.modifiers &= ~(1 << (hid_code & 0x0f));
286 return;
287 }
288 /* fall through */
289 case 0xe8 ... 0xe9:
290 /* USB modifiers are just 1 byte long. Bits 8 and 9 of
291 * hs->kbd.modifiers implement a state machine that detects the
292 * 0xe0 and 0xe1/0x1d sequences. These bits do not follow the
293 * usual rules where bit 7 marks released keys; they are cleared
294 * elsewhere in the function as the state machine dictates.
295 */
296 hs->kbd.modifiers |= 1 << (hid_code & 0x0f);
297 return;
298
299 case 0xea ... 0xef:
300 abort();
301
302 default:
303 break;
304 }
305
306 if (keycode & (1 << 7)) {
307 for (i = hs->kbd.keys - 1; i >= 0; i--) {
308 if (hs->kbd.key[i] == hid_code) {
309 hs->kbd.key[i] = hs->kbd.key[-- hs->kbd.keys];
310 hs->kbd.key[hs->kbd.keys] = 0x00;
311 break;
312 }
313 }
314 if (i < 0) {
315 return;
316 }
317 } else {
318 for (i = hs->kbd.keys - 1; i >= 0; i--) {
319 if (hs->kbd.key[i] == hid_code) {
320 break;
321 }
322 }
323 if (i < 0) {
324 if (hs->kbd.keys < sizeof(hs->kbd.key)) {
325 hs->kbd.key[hs->kbd.keys++] = hid_code;
326 }
327 } else {
328 return;
329 }
330 }
331 }
332
333 static inline int int_clamp(int val, int vmin, int vmax)
334 {
335 if (val < vmin) {
336 return vmin;
337 } else if (val > vmax) {
338 return vmax;
339 } else {
340 return val;
341 }
342 }
343
344 void hid_pointer_activate(HIDState *hs)
345 {
346 if (!hs->ptr.mouse_grabbed) {
347 qemu_input_handler_activate(hs->s);
348 hs->ptr.mouse_grabbed = 1;
349 }
350 }
351
352 int hid_pointer_poll(HIDState *hs, uint8_t *buf, int len)
353 {
354 int dx, dy, dz, l;
355 int index;
356 HIDPointerEvent *e;
357
358 hs->idle_pending = false;
359
360 hid_pointer_activate(hs);
361
362 /* When the buffer is empty, return the last event. Relative
363 movements will all be zero. */
364 index = (hs->n ? hs->head : hs->head - 1);
365 e = &hs->ptr.queue[index & QUEUE_MASK];
366
367 if (hs->kind == HID_MOUSE) {
368 dx = int_clamp(e->xdx, -127, 127);
369 dy = int_clamp(e->ydy, -127, 127);
370 e->xdx -= dx;
371 e->ydy -= dy;
372 } else {
373 dx = e->xdx;
374 dy = e->ydy;
375 }
376 dz = int_clamp(e->dz, -127, 127);
377 e->dz -= dz;
378
379 if (hs->n &&
380 !e->dz &&
381 (hs->kind == HID_TABLET || (!e->xdx && !e->ydy))) {
382 /* that deals with this event */
383 QUEUE_INCR(hs->head);
384 hs->n--;
385 }
386
387 /* Appears we have to invert the wheel direction */
388 dz = 0 - dz;
389 l = 0;
390 switch (hs->kind) {
391 case HID_MOUSE:
392 if (len > l) {
393 buf[l++] = e->buttons_state;
394 }
395 if (len > l) {
396 buf[l++] = dx;
397 }
398 if (len > l) {
399 buf[l++] = dy;
400 }
401 if (len > l) {
402 buf[l++] = dz;
403 }
404 break;
405
406 case HID_TABLET:
407 if (len > l) {
408 buf[l++] = e->buttons_state;
409 }
410 if (len > l) {
411 buf[l++] = dx & 0xff;
412 }
413 if (len > l) {
414 buf[l++] = dx >> 8;
415 }
416 if (len > l) {
417 buf[l++] = dy & 0xff;
418 }
419 if (len > l) {
420 buf[l++] = dy >> 8;
421 }
422 if (len > l) {
423 buf[l++] = dz;
424 }
425 break;
426
427 default:
428 abort();
429 }
430
431 return l;
432 }
433
434 int hid_keyboard_poll(HIDState *hs, uint8_t *buf, int len)
435 {
436 hs->idle_pending = false;
437
438 if (len < 2) {
439 return 0;
440 }
441
442 hid_keyboard_process_keycode(hs);
443
444 buf[0] = hs->kbd.modifiers & 0xff;
445 buf[1] = 0;
446 if (hs->kbd.keys > 6) {
447 memset(buf + 2, HID_USAGE_ERROR_ROLLOVER, MIN(8, len) - 2);
448 } else {
449 memcpy(buf + 2, hs->kbd.key, MIN(8, len) - 2);
450 }
451
452 return MIN(8, len);
453 }
454
455 int hid_keyboard_write(HIDState *hs, uint8_t *buf, int len)
456 {
457 if (len > 0) {
458 int ledstate = 0;
459 /* 0x01: Num Lock LED
460 * 0x02: Caps Lock LED
461 * 0x04: Scroll Lock LED
462 * 0x08: Compose LED
463 * 0x10: Kana LED */
464 hs->kbd.leds = buf[0];
465 if (hs->kbd.leds & 0x04) {
466 ledstate |= QEMU_SCROLL_LOCK_LED;
467 }
468 if (hs->kbd.leds & 0x01) {
469 ledstate |= QEMU_NUM_LOCK_LED;
470 }
471 if (hs->kbd.leds & 0x02) {
472 ledstate |= QEMU_CAPS_LOCK_LED;
473 }
474 qemu_input_handler_set_leds_mask(hs->s, ledstate);
475 return 1;
476 }
477 return 0;
478 }
479
480 void hid_reset(HIDState *hs)
481 {
482 switch (hs->kind) {
483 case HID_KEYBOARD:
484 memset(hs->kbd.keycodes, 0, sizeof(hs->kbd.keycodes));
485 memset(hs->kbd.key, 0, sizeof(hs->kbd.key));
486 hs->kbd.keys = 0;
487 hs->kbd.modifiers = 0;
488 break;
489 case HID_MOUSE:
490 case HID_TABLET:
491 memset(hs->ptr.queue, 0, sizeof(hs->ptr.queue));
492 break;
493 }
494 hs->head = 0;
495 hs->n = 0;
496 hs->protocol = 1;
497 hs->idle = 0;
498 hs->idle_pending = false;
499 hid_del_idle_timer(hs);
500 }
501
502 void hid_free(HIDState *hs)
503 {
504 qemu_input_handler_unregister(hs->s);
505 hid_del_idle_timer(hs);
506 }
507
508 static const QemuInputHandler hid_keyboard_handler = {
509 .name = "QEMU HID Keyboard",
510 .mask = INPUT_EVENT_MASK_KEY,
511 .event = hid_keyboard_event,
512 };
513
514 static const QemuInputHandler hid_mouse_handler = {
515 .name = "QEMU HID Mouse",
516 .mask = INPUT_EVENT_MASK_BTN | INPUT_EVENT_MASK_REL,
517 .event = hid_pointer_event,
518 .sync = hid_pointer_sync,
519 };
520
521 static const QemuInputHandler hid_tablet_handler = {
522 .name = "QEMU HID Tablet",
523 .mask = INPUT_EVENT_MASK_BTN | INPUT_EVENT_MASK_ABS,
524 .event = hid_pointer_event,
525 .sync = hid_pointer_sync,
526 };
527
528 void hid_init(HIDState *hs, int kind, HIDEventFunc event)
529 {
530 hs->kind = kind;
531 hs->event = event;
532
533 if (hs->kind == HID_KEYBOARD) {
534 hs->s = qemu_input_handler_register((DeviceState *)hs,
535 &hid_keyboard_handler);
536 qemu_input_handler_activate(hs->s);
537 } else if (hs->kind == HID_MOUSE) {
538 hs->s = qemu_input_handler_register((DeviceState *)hs,
539 &hid_mouse_handler);
540 } else if (hs->kind == HID_TABLET) {
541 hs->s = qemu_input_handler_register((DeviceState *)hs,
542 &hid_tablet_handler);
543 }
544 }
545
546 static int hid_post_load(void *opaque, int version_id)
547 {
548 HIDState *s = opaque;
549
550 hid_set_next_idle(s);
551
552 if (s->n == QUEUE_LENGTH && (s->kind == HID_TABLET ||
553 s->kind == HID_MOUSE)) {
554 /*
555 * Handle ptr device migration from old qemu with full queue.
556 *
557 * Throw away everything but the last event, so we propagate
558 * at least the current button state to the guest. Also keep
559 * current position for the tablet, signal "no motion" for the
560 * mouse.
561 */
562 HIDPointerEvent evt;
563 evt = s->ptr.queue[(s->head+s->n) & QUEUE_MASK];
564 if (s->kind == HID_MOUSE) {
565 evt.xdx = 0;
566 evt.ydy = 0;
567 }
568 s->ptr.queue[0] = evt;
569 s->head = 0;
570 s->n = 1;
571 }
572 return 0;
573 }
574
575 static const VMStateDescription vmstate_hid_ptr_queue = {
576 .name = "HIDPointerEventQueue",
577 .version_id = 1,
578 .minimum_version_id = 1,
579 .fields = (const VMStateField[]) {
580 VMSTATE_INT32(xdx, HIDPointerEvent),
581 VMSTATE_INT32(ydy, HIDPointerEvent),
582 VMSTATE_INT32(dz, HIDPointerEvent),
583 VMSTATE_INT32(buttons_state, HIDPointerEvent),
584 VMSTATE_END_OF_LIST()
585 }
586 };
587
588 const VMStateDescription vmstate_hid_ptr_device = {
589 .name = "HIDPointerDevice",
590 .version_id = 1,
591 .minimum_version_id = 1,
592 .post_load = hid_post_load,
593 .fields = (const VMStateField[]) {
594 VMSTATE_STRUCT_ARRAY(ptr.queue, HIDState, QUEUE_LENGTH, 0,
595 vmstate_hid_ptr_queue, HIDPointerEvent),
596 VMSTATE_UINT32(head, HIDState),
597 VMSTATE_UINT32(n, HIDState),
598 VMSTATE_INT32(protocol, HIDState),
599 VMSTATE_UINT8(idle, HIDState),
600 VMSTATE_END_OF_LIST(),
601 }
602 };
603
604 const VMStateDescription vmstate_hid_keyboard_device = {
605 .name = "HIDKeyboardDevice",
606 .version_id = 1,
607 .minimum_version_id = 1,
608 .post_load = hid_post_load,
609 .fields = (const VMStateField[]) {
610 VMSTATE_UINT32_ARRAY(kbd.keycodes, HIDState, QUEUE_LENGTH),
611 VMSTATE_UINT32(head, HIDState),
612 VMSTATE_UINT32(n, HIDState),
613 VMSTATE_UINT16(kbd.modifiers, HIDState),
614 VMSTATE_UINT8(kbd.leds, HIDState),
615 VMSTATE_UINT8_ARRAY(kbd.key, HIDState, 16),
616 VMSTATE_INT32(kbd.keys, HIDState),
617 VMSTATE_INT32(protocol, HIDState),
618 VMSTATE_UINT8(idle, HIDState),
619 VMSTATE_END_OF_LIST(),
620 }
621 };