xref: /qemu/include/hw/input/hid.h (revision 95a9457fd44ad97c518858a4e1586a5498f9773c)
1dcfda673SGerd Hoffmann #ifndef QEMU_HID_H
2dcfda673SGerd Hoffmann #define QEMU_HID_H
3dcfda673SGerd Hoffmann 
4*1ff5eeddSGerd Hoffmann #include "ui/input.h"
5701a8f76SPaolo Bonzini 
6dcfda673SGerd Hoffmann #define HID_MOUSE     1
7dcfda673SGerd Hoffmann #define HID_TABLET    2
8dcfda673SGerd Hoffmann #define HID_KEYBOARD  3
9dcfda673SGerd Hoffmann 
10dcfda673SGerd Hoffmann typedef struct HIDPointerEvent {
11dcfda673SGerd Hoffmann     int32_t xdx, ydy; /* relative iff it's a mouse, otherwise absolute */
12dcfda673SGerd Hoffmann     int32_t dz, buttons_state;
13dcfda673SGerd Hoffmann } HIDPointerEvent;
14dcfda673SGerd Hoffmann 
15dcfda673SGerd Hoffmann #define QUEUE_LENGTH    16 /* should be enough for a triple-click */
16dcfda673SGerd Hoffmann #define QUEUE_MASK      (QUEUE_LENGTH-1u)
17dcfda673SGerd Hoffmann #define QUEUE_INCR(v)   ((v)++, (v) &= QUEUE_MASK)
18dcfda673SGerd Hoffmann 
19dcfda673SGerd Hoffmann typedef struct HIDState HIDState;
20dcfda673SGerd Hoffmann typedef void (*HIDEventFunc)(HIDState *s);
21dcfda673SGerd Hoffmann 
22dcfda673SGerd Hoffmann typedef struct HIDMouseState {
23dcfda673SGerd Hoffmann     HIDPointerEvent queue[QUEUE_LENGTH];
24dcfda673SGerd Hoffmann     int mouse_grabbed;
25dcfda673SGerd Hoffmann } HIDMouseState;
26dcfda673SGerd Hoffmann 
27dcfda673SGerd Hoffmann typedef struct HIDKeyboardState {
28dcfda673SGerd Hoffmann     uint32_t keycodes[QUEUE_LENGTH];
29dcfda673SGerd Hoffmann     uint16_t modifiers;
30dcfda673SGerd Hoffmann     uint8_t leds;
31dcfda673SGerd Hoffmann     uint8_t key[16];
32dcfda673SGerd Hoffmann     int32_t keys;
33dcfda673SGerd Hoffmann } HIDKeyboardState;
34dcfda673SGerd Hoffmann 
35dcfda673SGerd Hoffmann struct HIDState {
36dcfda673SGerd Hoffmann     union {
37dcfda673SGerd Hoffmann         HIDMouseState ptr;
38dcfda673SGerd Hoffmann         HIDKeyboardState kbd;
39dcfda673SGerd Hoffmann     };
40dcfda673SGerd Hoffmann     uint32_t head; /* index into circular queue */
41dcfda673SGerd Hoffmann     uint32_t n;
42dcfda673SGerd Hoffmann     int kind;
43b069d348SGerd Hoffmann     int32_t protocol;
44b069d348SGerd Hoffmann     uint8_t idle;
45027c03f7SHans de Goede     bool idle_pending;
46027c03f7SHans de Goede     QEMUTimer *idle_timer;
47dcfda673SGerd Hoffmann     HIDEventFunc event;
48*1ff5eeddSGerd Hoffmann     QemuInputHandlerState *s;
49dcfda673SGerd Hoffmann };
50dcfda673SGerd Hoffmann 
51dcfda673SGerd Hoffmann void hid_init(HIDState *hs, int kind, HIDEventFunc event);
52dcfda673SGerd Hoffmann void hid_reset(HIDState *hs);
53dcfda673SGerd Hoffmann void hid_free(HIDState *hs);
54dcfda673SGerd Hoffmann 
55dcfda673SGerd Hoffmann bool hid_has_events(HIDState *hs);
56027c03f7SHans de Goede void hid_set_next_idle(HIDState *hs);
5721635e12SGerd Hoffmann void hid_pointer_activate(HIDState *hs);
58dcfda673SGerd Hoffmann int hid_pointer_poll(HIDState *hs, uint8_t *buf, int len);
59dcfda673SGerd Hoffmann int hid_keyboard_poll(HIDState *hs, uint8_t *buf, int len);
60dcfda673SGerd Hoffmann int hid_keyboard_write(HIDState *hs, uint8_t *buf, int len);
61dcfda673SGerd Hoffmann 
62701a8f76SPaolo Bonzini extern const VMStateDescription vmstate_hid_keyboard_device;
63701a8f76SPaolo Bonzini 
64701a8f76SPaolo Bonzini #define VMSTATE_HID_KEYBOARD_DEVICE(_field, _state) {                \
65701a8f76SPaolo Bonzini     .name       = (stringify(_field)),                               \
66701a8f76SPaolo Bonzini     .size       = sizeof(HIDState),                                  \
67701a8f76SPaolo Bonzini     .vmsd       = &vmstate_hid_keyboard_device,                      \
68701a8f76SPaolo Bonzini     .flags      = VMS_STRUCT,                                        \
69701a8f76SPaolo Bonzini     .offset     = vmstate_offset_value(_state, _field, HIDState),    \
70701a8f76SPaolo Bonzini }
71701a8f76SPaolo Bonzini 
72701a8f76SPaolo Bonzini extern const VMStateDescription vmstate_hid_ptr_device;
73701a8f76SPaolo Bonzini 
74701a8f76SPaolo Bonzini #define VMSTATE_HID_POINTER_DEVICE(_field, _state) {                 \
75701a8f76SPaolo Bonzini     .name       = (stringify(_field)),                               \
76701a8f76SPaolo Bonzini     .size       = sizeof(HIDState),                                  \
77701a8f76SPaolo Bonzini     .vmsd       = &vmstate_hid_ptr_device,                           \
78701a8f76SPaolo Bonzini     .flags      = VMS_STRUCT,                                        \
79701a8f76SPaolo Bonzini     .offset     = vmstate_offset_value(_state, _field, HIDState),    \
80701a8f76SPaolo Bonzini }
81701a8f76SPaolo Bonzini 
82701a8f76SPaolo Bonzini 
83dcfda673SGerd Hoffmann #endif /* QEMU_HID_H */
84