blob: 6338efa1c396d1b33c41333f0dba466a0b57ce61 [file] [log] [blame]
ths548df2a2007-03-20 16:45:27 +00001/*
2 * QEMU VMMouse emulation
ths5fafdf22007-09-16 21:08:06 +00003 *
ths548df2a2007-03-20 16:45:27 +00004 * Copyright (C) 2007 Anthony Liguori <anthony@codemonkey.ws>
ths5fafdf22007-09-16 21:08:06 +00005 *
ths548df2a2007-03-20 16:45:27 +00006 * 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 */
pbrook87ecb682007-11-17 17:14:51 +000024#include "hw.h"
25#include "console.h"
26#include "ps2.h"
27#include "pc.h"
Blue Swirl91c9e092011-02-05 14:34:45 +000028#include "qdev.h"
ths548df2a2007-03-20 16:45:27 +000029
30/* debug only vmmouse */
31//#define DEBUG_VMMOUSE
32
33/* VMMouse Commands */
34#define VMMOUSE_GETVERSION 10
35#define VMMOUSE_DATA 39
36#define VMMOUSE_STATUS 40
37#define VMMOUSE_COMMAND 41
38
39#define VMMOUSE_READ_ID 0x45414552
40#define VMMOUSE_DISABLE 0x000000f5
41#define VMMOUSE_REQUEST_RELATIVE 0x4c455252
42#define VMMOUSE_REQUEST_ABSOLUTE 0x53424152
43
44#define VMMOUSE_QUEUE_SIZE 1024
45
ths548df2a2007-03-20 16:45:27 +000046#define VMMOUSE_VERSION 0x3442554a
47
48#ifdef DEBUG_VMMOUSE
49#define DPRINTF(fmt, ...) printf(fmt, ## __VA_ARGS__)
50#else
51#define DPRINTF(fmt, ...) do { } while (0)
52#endif
53
54typedef struct _VMMouseState
55{
Blue Swirl91c9e092011-02-05 14:34:45 +000056 ISADevice dev;
ths548df2a2007-03-20 16:45:27 +000057 uint32_t queue[VMMOUSE_QUEUE_SIZE];
Juan Quintelabcb58d92009-09-10 03:04:40 +020058 int32_t queue_size;
ths548df2a2007-03-20 16:45:27 +000059 uint16_t nb_queue;
60 uint16_t status;
61 uint8_t absolute;
62 QEMUPutMouseEntry *entry;
63 void *ps2_mouse;
64} VMMouseState;
65
ths548df2a2007-03-20 16:45:27 +000066static uint32_t vmmouse_get_status(VMMouseState *s)
67{
68 DPRINTF("vmmouse_get_status()\n");
69 return (s->status << 16) | s->nb_queue;
70}
71
72static void vmmouse_mouse_event(void *opaque, int x, int y, int dz, int buttons_state)
73{
74 VMMouseState *s = opaque;
75 int buttons = 0;
76
77 if (s->nb_queue > (VMMOUSE_QUEUE_SIZE - 4))
ths4ed59aa2007-08-26 17:45:23 +000078 return;
ths548df2a2007-03-20 16:45:27 +000079
80 DPRINTF("vmmouse_mouse_event(%d, %d, %d, %d)\n",
ths4ed59aa2007-08-26 17:45:23 +000081 x, y, dz, buttons_state);
ths548df2a2007-03-20 16:45:27 +000082
83 if ((buttons_state & MOUSE_EVENT_LBUTTON))
ths4ed59aa2007-08-26 17:45:23 +000084 buttons |= 0x20;
ths548df2a2007-03-20 16:45:27 +000085 if ((buttons_state & MOUSE_EVENT_RBUTTON))
ths4ed59aa2007-08-26 17:45:23 +000086 buttons |= 0x10;
ths548df2a2007-03-20 16:45:27 +000087 if ((buttons_state & MOUSE_EVENT_MBUTTON))
ths4ed59aa2007-08-26 17:45:23 +000088 buttons |= 0x08;
ths548df2a2007-03-20 16:45:27 +000089
90 if (s->absolute) {
ths4ed59aa2007-08-26 17:45:23 +000091 x <<= 1;
92 y <<= 1;
ths548df2a2007-03-20 16:45:27 +000093 }
94
95 s->queue[s->nb_queue++] = buttons;
96 s->queue[s->nb_queue++] = x;
97 s->queue[s->nb_queue++] = y;
98 s->queue[s->nb_queue++] = dz;
99
100 /* need to still generate PS2 events to notify driver to
101 read from queue */
Blue Swirl956a3e62010-05-22 07:59:01 +0000102 i8042_isa_mouse_fake_event(s->ps2_mouse);
ths548df2a2007-03-20 16:45:27 +0000103}
104
Gerd Hoffmanncd496922010-10-08 12:30:13 +0200105static void vmmouse_remove_handler(VMMouseState *s)
ths548df2a2007-03-20 16:45:27 +0000106{
107 if (s->entry) {
ths4ed59aa2007-08-26 17:45:23 +0000108 qemu_remove_mouse_event_handler(s->entry);
109 s->entry = NULL;
ths548df2a2007-03-20 16:45:27 +0000110 }
Gerd Hoffmanncd496922010-10-08 12:30:13 +0200111}
112
113static void vmmouse_update_handler(VMMouseState *s, int absolute)
114{
115 if (s->status != 0) {
116 return;
117 }
118 if (s->absolute != absolute) {
119 s->absolute = absolute;
120 vmmouse_remove_handler(s);
121 }
122 if (s->entry == NULL) {
ths4ed59aa2007-08-26 17:45:23 +0000123 s->entry = qemu_add_mouse_event_handler(vmmouse_mouse_event,
124 s, s->absolute,
125 "vmmouse");
Gerd Hoffmanncd496922010-10-08 12:30:13 +0200126 qemu_activate_mouse_event_handler(s->entry);
127 }
ths548df2a2007-03-20 16:45:27 +0000128}
129
130static void vmmouse_read_id(VMMouseState *s)
131{
132 DPRINTF("vmmouse_read_id()\n");
133
134 if (s->nb_queue == VMMOUSE_QUEUE_SIZE)
ths4ed59aa2007-08-26 17:45:23 +0000135 return;
ths548df2a2007-03-20 16:45:27 +0000136
137 s->queue[s->nb_queue++] = VMMOUSE_VERSION;
138 s->status = 0;
ths548df2a2007-03-20 16:45:27 +0000139}
140
141static void vmmouse_request_relative(VMMouseState *s)
142{
143 DPRINTF("vmmouse_request_relative()\n");
Gerd Hoffmanncd496922010-10-08 12:30:13 +0200144 vmmouse_update_handler(s, 0);
ths548df2a2007-03-20 16:45:27 +0000145}
146
147static void vmmouse_request_absolute(VMMouseState *s)
148{
149 DPRINTF("vmmouse_request_absolute()\n");
Gerd Hoffmanncd496922010-10-08 12:30:13 +0200150 vmmouse_update_handler(s, 1);
ths548df2a2007-03-20 16:45:27 +0000151}
152
153static void vmmouse_disable(VMMouseState *s)
154{
155 DPRINTF("vmmouse_disable()\n");
156 s->status = 0xffff;
Gerd Hoffmanncd496922010-10-08 12:30:13 +0200157 vmmouse_remove_handler(s);
ths548df2a2007-03-20 16:45:27 +0000158}
159
160static void vmmouse_data(VMMouseState *s, uint32_t *data, uint32_t size)
161{
162 int i;
163
164 DPRINTF("vmmouse_data(%d)\n", size);
165
166 if (size == 0 || size > 6 || size > s->nb_queue) {
ths4ed59aa2007-08-26 17:45:23 +0000167 printf("vmmouse: driver requested too much data %d\n", size);
168 s->status = 0xffff;
Gerd Hoffmanncd496922010-10-08 12:30:13 +0200169 vmmouse_remove_handler(s);
ths4ed59aa2007-08-26 17:45:23 +0000170 return;
ths548df2a2007-03-20 16:45:27 +0000171 }
172
173 for (i = 0; i < size; i++)
ths4ed59aa2007-08-26 17:45:23 +0000174 data[i] = s->queue[i];
ths548df2a2007-03-20 16:45:27 +0000175
176 s->nb_queue -= size;
177 if (s->nb_queue)
ths4ed59aa2007-08-26 17:45:23 +0000178 memmove(s->queue, &s->queue[size], sizeof(s->queue[0]) * s->nb_queue);
ths548df2a2007-03-20 16:45:27 +0000179}
180
ths548df2a2007-03-20 16:45:27 +0000181static uint32_t vmmouse_ioport_read(void *opaque, uint32_t addr)
182{
183 VMMouseState *s = opaque;
184 uint32_t data[6];
185 uint16_t command;
186
187 vmmouse_get_data(data);
ths548df2a2007-03-20 16:45:27 +0000188
189 command = data[2] & 0xFFFF;
190
191 switch (command) {
ths548df2a2007-03-20 16:45:27 +0000192 case VMMOUSE_STATUS:
ths4ed59aa2007-08-26 17:45:23 +0000193 data[0] = vmmouse_get_status(s);
194 break;
ths548df2a2007-03-20 16:45:27 +0000195 case VMMOUSE_COMMAND:
ths4ed59aa2007-08-26 17:45:23 +0000196 switch (data[1]) {
197 case VMMOUSE_DISABLE:
198 vmmouse_disable(s);
199 break;
200 case VMMOUSE_READ_ID:
201 vmmouse_read_id(s);
202 break;
203 case VMMOUSE_REQUEST_RELATIVE:
204 vmmouse_request_relative(s);
205 break;
206 case VMMOUSE_REQUEST_ABSOLUTE:
207 vmmouse_request_absolute(s);
208 break;
209 default:
210 printf("vmmouse: unknown command %x\n", data[1]);
211 break;
212 }
213 break;
ths548df2a2007-03-20 16:45:27 +0000214 case VMMOUSE_DATA:
ths4ed59aa2007-08-26 17:45:23 +0000215 vmmouse_data(s, data, data[1]);
216 break;
ths548df2a2007-03-20 16:45:27 +0000217 default:
ths4ed59aa2007-08-26 17:45:23 +0000218 printf("vmmouse: unknown command %x\n", command);
219 break;
ths548df2a2007-03-20 16:45:27 +0000220 }
221
ths548df2a2007-03-20 16:45:27 +0000222 vmmouse_set_data(data);
223 return data[0];
224}
225
Juan Quintelae59fb372009-09-29 22:48:21 +0200226static int vmmouse_post_load(void *opaque, int version_id)
ths548df2a2007-03-20 16:45:27 +0000227{
228 VMMouseState *s = opaque;
ths548df2a2007-03-20 16:45:27 +0000229
Gerd Hoffmanncd496922010-10-08 12:30:13 +0200230 vmmouse_remove_handler(s);
231 vmmouse_update_handler(s, s->absolute);
ths548df2a2007-03-20 16:45:27 +0000232 return 0;
233}
234
Juan Quintelabcb58d92009-09-10 03:04:40 +0200235static const VMStateDescription vmstate_vmmouse = {
236 .name = "vmmouse",
237 .version_id = 0,
238 .minimum_version_id = 0,
239 .minimum_version_id_old = 0,
240 .post_load = vmmouse_post_load,
241 .fields = (VMStateField []) {
242 VMSTATE_INT32_EQUAL(queue_size, VMMouseState),
243 VMSTATE_UINT32_ARRAY(queue, VMMouseState, VMMOUSE_QUEUE_SIZE),
244 VMSTATE_UINT16(nb_queue, VMMouseState),
245 VMSTATE_UINT16(status, VMMouseState),
246 VMSTATE_UINT8(absolute, VMMouseState),
247 VMSTATE_END_OF_LIST()
248 }
249};
250
Blue Swirl91c9e092011-02-05 14:34:45 +0000251static void vmmouse_reset(DeviceState *d)
ths548df2a2007-03-20 16:45:27 +0000252{
Blue Swirl91c9e092011-02-05 14:34:45 +0000253 VMMouseState *s = container_of(d, VMMouseState, dev.qdev);
ths548df2a2007-03-20 16:45:27 +0000254
255 s->status = 0xffff;
Blue Swirl8668f612011-02-12 17:44:11 +0000256 s->queue_size = VMMOUSE_QUEUE_SIZE;
Gerhard Wiesinger069ab0e2012-01-25 21:04:14 +0100257
258 vmmouse_disable(s);
Blue Swirl91c9e092011-02-05 14:34:45 +0000259}
260
261static int vmmouse_initfn(ISADevice *dev)
262{
263 VMMouseState *s = DO_UPCAST(VMMouseState, dev, dev);
264
265 DPRINTF("vmmouse_init\n");
ths548df2a2007-03-20 16:45:27 +0000266
ths93342802007-08-26 17:46:38 +0000267 vmport_register(VMMOUSE_STATUS, vmmouse_ioport_read, s);
268 vmport_register(VMMOUSE_COMMAND, vmmouse_ioport_read, s);
269 vmport_register(VMMOUSE_DATA, vmmouse_ioport_read, s);
ths548df2a2007-03-20 16:45:27 +0000270
Blue Swirl91c9e092011-02-05 14:34:45 +0000271 return 0;
ths548df2a2007-03-20 16:45:27 +0000272}
Blue Swirl91c9e092011-02-05 14:34:45 +0000273
Anthony Liguori39bffca2011-12-07 21:34:16 -0600274static Property vmmouse_properties[] = {
275 DEFINE_PROP_PTR("ps2_mouse", VMMouseState, ps2_mouse),
276 DEFINE_PROP_END_OF_LIST(),
277};
278
Anthony Liguori8f04ee02011-12-04 11:52:49 -0600279static void vmmouse_class_initfn(ObjectClass *klass, void *data)
280{
Anthony Liguori39bffca2011-12-07 21:34:16 -0600281 DeviceClass *dc = DEVICE_CLASS(klass);
Anthony Liguori8f04ee02011-12-04 11:52:49 -0600282 ISADeviceClass *ic = ISA_DEVICE_CLASS(klass);
283 ic->init = vmmouse_initfn;
Anthony Liguori39bffca2011-12-07 21:34:16 -0600284 dc->no_user = 1;
285 dc->reset = vmmouse_reset;
286 dc->vmsd = &vmstate_vmmouse;
287 dc->props = vmmouse_properties;
Anthony Liguori8f04ee02011-12-04 11:52:49 -0600288}
289
Anthony Liguori39bffca2011-12-07 21:34:16 -0600290static TypeInfo vmmouse_info = {
291 .name = "vmmouse",
292 .parent = TYPE_ISA_DEVICE,
293 .instance_size = sizeof(VMMouseState),
294 .class_init = vmmouse_class_initfn,
Blue Swirl91c9e092011-02-05 14:34:45 +0000295};
296
Andreas Färber83f7d432012-02-09 15:20:55 +0100297static void vmmouse_register_types(void)
Blue Swirl91c9e092011-02-05 14:34:45 +0000298{
Anthony Liguori39bffca2011-12-07 21:34:16 -0600299 type_register_static(&vmmouse_info);
Blue Swirl91c9e092011-02-05 14:34:45 +0000300}
Andreas Färber83f7d432012-02-09 15:20:55 +0100301
302type_init(vmmouse_register_types)