xref: /openbmc/qemu/include/hw/input/ps2.h (revision 954a6c4f)
1 /*
2  * QEMU PS/2 keyboard/mouse emulation
3  *
4  * Copyright (C) 2003 Fabrice Bellard
5  *
6  * Permission is hereby granted, free of charge, to any person obtaining a copy
7  * of this software and associated documentation files (the "Software"), to deal
8  * in the Software without restriction, including without limitation the rights
9  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10  * copies of the Software, and to permit persons to whom the Software is
11  * furnished to do so, subject to the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be included in
14  * all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22  * THE SOFTWARE.
23  */
24 
25 #ifndef HW_PS2_H
26 #define HW_PS2_H
27 
28 #include "hw/sysbus.h"
29 
30 #define PS2_MOUSE_BUTTON_LEFT   0x01
31 #define PS2_MOUSE_BUTTON_RIGHT  0x02
32 #define PS2_MOUSE_BUTTON_MIDDLE 0x04
33 #define PS2_MOUSE_BUTTON_SIDE   0x08
34 #define PS2_MOUSE_BUTTON_EXTRA  0x10
35 
36 struct PS2DeviceClass {
37     SysBusDeviceClass parent_class;
38 
39     DeviceReset parent_reset;
40 };
41 
42 /*
43  * PS/2 buffer size. Keep 256 bytes for compatibility with
44  * older QEMU versions.
45  */
46 #define PS2_BUFFER_SIZE     256
47 
48 typedef struct {
49     uint8_t data[PS2_BUFFER_SIZE];
50     int rptr, wptr, cwptr, count;
51 } PS2Queue;
52 
53 /* Output IRQ */
54 #define PS2_DEVICE_IRQ      0
55 
56 struct PS2State {
57     SysBusDevice parent_obj;
58 
59     PS2Queue queue;
60     int32_t write_cmd;
61     qemu_irq irq;
62 };
63 
64 #define TYPE_PS2_DEVICE "ps2-device"
65 OBJECT_DECLARE_TYPE(PS2State, PS2DeviceClass, PS2_DEVICE)
66 
67 struct PS2KbdState {
68     PS2State parent_obj;
69 
70     int scan_enabled;
71     int translate;
72     int scancode_set; /* 1=XT, 2=AT, 3=PS/2 */
73     int ledstate;
74     bool need_high_bit;
75     unsigned int modifiers; /* bitmask of MOD_* constants above */
76 };
77 
78 #define TYPE_PS2_KBD_DEVICE "ps2-kbd"
79 OBJECT_DECLARE_SIMPLE_TYPE(PS2KbdState, PS2_KBD_DEVICE)
80 
81 struct PS2MouseState {
82     PS2State parent_obj;
83 
84     uint8_t mouse_status;
85     uint8_t mouse_resolution;
86     uint8_t mouse_sample_rate;
87     uint8_t mouse_wrap;
88     uint8_t mouse_type; /* 0 = PS2, 3 = IMPS/2, 4 = IMEX */
89     uint8_t mouse_detect_state;
90     int mouse_dx; /* current values, needed for 'poll' mode */
91     int mouse_dy;
92     int mouse_dz;
93     int mouse_dw;
94     uint8_t mouse_buttons;
95 };
96 
97 #define TYPE_PS2_MOUSE_DEVICE "ps2-mouse"
98 OBJECT_DECLARE_SIMPLE_TYPE(PS2MouseState, PS2_MOUSE_DEVICE)
99 
100 /* ps2.c */
101 void ps2_write_mouse(PS2MouseState *s, int val);
102 void ps2_write_keyboard(PS2KbdState *s, int val);
103 uint32_t ps2_read_data(PS2State *s);
104 void ps2_queue_noirq(PS2State *s, int b);
105 void ps2_queue(PS2State *s, int b);
106 void ps2_queue_2(PS2State *s, int b1, int b2);
107 void ps2_queue_3(PS2State *s, int b1, int b2, int b3);
108 void ps2_queue_4(PS2State *s, int b1, int b2, int b3, int b4);
109 void ps2_keyboard_set_translation(PS2KbdState *s, int mode);
110 void ps2_mouse_fake_event(PS2MouseState *s);
111 int ps2_queue_empty(PS2State *s);
112 
113 #endif /* HW_PS2_H */
114