| 1 | /* |
| 2 | * QEMU VMMouse emulation |
| 3 | * |
| 4 | * Copyright (C) 2007 Anthony Liguori <anthony@codemonkey.ws> |
| 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 | #include "qemu/osdep.h" |
| 26 | #include "qapi/error.h" |
| 27 | #include "ui/console.h" |
| 28 | #include "hw/i386/vmport.h" |
| 29 | #include "hw/input/i8042.h" |
| 30 | #include "hw/core/qdev-properties.h" |
| 31 | #include "migration/vmstate.h" |
| 32 | #include "target/i386/cpu.h" |
| 33 | #include "qom/object.h" |
| 34 | |
| 35 | #include "trace.h" |
| 36 | |
| 37 | /* debug only vmmouse */ |
| 38 | //#define DEBUG_VMMOUSE |
| 39 | |
| 40 | #define VMMOUSE_READ_ID 0x45414552 |
| 41 | #define VMMOUSE_DISABLE 0x000000f5 |
| 42 | #define VMMOUSE_REQUEST_RELATIVE 0x4c455252 |
| 43 | #define VMMOUSE_REQUEST_ABSOLUTE 0x53424152 |
| 44 | |
| 45 | #define VMMOUSE_QUEUE_SIZE 1024 |
| 46 | |
| 47 | #define VMMOUSE_VERSION 0x3442554a |
| 48 | |
| 49 | #define VMMOUSE_RELATIVE_PACKET 0x00010000 |
| 50 | |
| 51 | #define VMMOUSE_LEFT_BUTTON 0x20 |
| 52 | #define VMMOUSE_RIGHT_BUTTON 0x10 |
| 53 | #define VMMOUSE_MIDDLE_BUTTON 0x08 |
| 54 | |
| 55 | #define VMMOUSE_MIN_X 0 |
| 56 | #define VMMOUSE_MIN_Y 0 |
| 57 | #define VMMOUSE_MAX_X 0xFFFF |
| 58 | #define VMMOUSE_MAX_Y 0xFFFF |
| 59 | |
| 60 | #define TYPE_VMMOUSE "vmmouse" |
| 61 | OBJECT_DECLARE_SIMPLE_TYPE(VMMouseState, VMMOUSE) |
| 62 | |
| 63 | struct VMMouseState { |
| 64 | ISADevice parent_obj; |
| 65 | |
| 66 | uint32_t queue[VMMOUSE_QUEUE_SIZE]; |
| 67 | int32_t queue_size; |
| 68 | uint16_t nb_queue; |
| 69 | uint16_t status; |
| 70 | uint8_t absolute; |
| 71 | QemuInputHandlerState *hs; |
| 72 | int axis[INPUT_AXIS__MAX]; |
| 73 | int dz; |
| 74 | bool btns[INPUT_BUTTON__MAX]; |
| 75 | ISAKBDState *i8042; |
| 76 | }; |
| 77 | |
| 78 | static void vmmouse_get_data(uint64_t *data) |
| 79 | { |
| 80 | X86CPU *cpu = X86_CPU(current_cpu); |
| 81 | CPUX86State *env = &cpu->env; |
| 82 | |
| 83 | data[0] = env->regs[R_EAX]; data[1] = env->regs[R_EBX]; |
| 84 | data[2] = env->regs[R_ECX]; data[3] = env->regs[R_EDX]; |
| 85 | data[4] = env->regs[R_ESI]; data[5] = env->regs[R_EDI]; |
| 86 | } |
| 87 | |
| 88 | static void vmmouse_set_data(const uint64_t *data) |
| 89 | { |
| 90 | X86CPU *cpu = X86_CPU(current_cpu); |
| 91 | CPUX86State *env = &cpu->env; |
| 92 | |
| 93 | env->regs[R_EAX] = data[0]; env->regs[R_EBX] = data[1]; |
| 94 | env->regs[R_ECX] = data[2]; env->regs[R_EDX] = data[3]; |
| 95 | env->regs[R_ESI] = data[4]; env->regs[R_EDI] = data[5]; |
| 96 | } |
| 97 | |
| 98 | static uint32_t vmmouse_get_status(VMMouseState *s) |
| 99 | { |
| 100 | trace_vmmouse_get_status(); |
| 101 | |
| 102 | return (s->status << 16) | s->nb_queue; |
| 103 | } |
| 104 | |
| 105 | static void vmmouse_input_event(DeviceState *dev, QemuConsole *src, |
| 106 | QemuInputEvent *evt) |
| 107 | { |
| 108 | VMMouseState *s = VMMOUSE(dev); |
| 109 | |
| 110 | switch (evt->type) { |
| 111 | case INPUT_EVENT_KIND_BTN: |
| 112 | if (evt->btn.down) { |
| 113 | if (evt->btn.button == INPUT_BUTTON_WHEEL_UP) { |
| 114 | s->dz--; |
| 115 | } else if (evt->btn.button == INPUT_BUTTON_WHEEL_DOWN) { |
| 116 | s->dz++; |
| 117 | } |
| 118 | } |
| 119 | s->btns[evt->btn.button] = evt->btn.down; |
| 120 | break; |
| 121 | case INPUT_EVENT_KIND_ABS: |
| 122 | if (evt->abs.axis == INPUT_AXIS_X) { |
| 123 | s->axis[INPUT_AXIS_X] = |
| 124 | qemu_input_scale_axis(evt->abs.value, |
| 125 | INPUT_EVENT_ABS_MIN, INPUT_EVENT_ABS_MAX, |
| 126 | VMMOUSE_MIN_X, VMMOUSE_MAX_X); |
| 127 | } else if (evt->abs.axis == INPUT_AXIS_Y) { |
| 128 | s->axis[INPUT_AXIS_Y] = |
| 129 | qemu_input_scale_axis(evt->abs.value, |
| 130 | INPUT_EVENT_ABS_MIN, INPUT_EVENT_ABS_MAX, |
| 131 | VMMOUSE_MIN_Y, VMMOUSE_MAX_Y); |
| 132 | } |
| 133 | break; |
| 134 | case INPUT_EVENT_KIND_REL: |
| 135 | s->axis[evt->rel.axis] += evt->rel.value; |
| 136 | break; |
| 137 | default: |
| 138 | break; |
| 139 | } |
| 140 | } |
| 141 | |
| 142 | static void vmmouse_input_sync(DeviceState *dev) |
| 143 | { |
| 144 | VMMouseState *s = VMMOUSE(dev); |
| 145 | int buttons = 0; |
| 146 | |
| 147 | if (s->nb_queue > (VMMOUSE_QUEUE_SIZE - 4)) { |
| 148 | return; |
| 149 | } |
| 150 | |
| 151 | if (s->btns[INPUT_BUTTON_LEFT]) { |
| 152 | buttons |= VMMOUSE_LEFT_BUTTON; |
| 153 | } |
| 154 | if (s->btns[INPUT_BUTTON_RIGHT]) { |
| 155 | buttons |= VMMOUSE_RIGHT_BUTTON; |
| 156 | } |
| 157 | if (s->btns[INPUT_BUTTON_MIDDLE]) { |
| 158 | buttons |= VMMOUSE_MIDDLE_BUTTON; |
| 159 | } |
| 160 | if (!s->absolute) { |
| 161 | buttons |= VMMOUSE_RELATIVE_PACKET; |
| 162 | } |
| 163 | |
| 164 | trace_vmmouse_queue_event(s->axis[INPUT_AXIS_X], s->axis[INPUT_AXIS_Y], |
| 165 | s->dz, buttons); |
| 166 | |
| 167 | s->queue[s->nb_queue++] = buttons; |
| 168 | s->queue[s->nb_queue++] = s->axis[INPUT_AXIS_X]; |
| 169 | s->queue[s->nb_queue++] = s->axis[INPUT_AXIS_Y]; |
| 170 | s->queue[s->nb_queue++] = s->dz; |
| 171 | s->dz = 0; |
| 172 | |
| 173 | if (!s->absolute) { |
| 174 | s->axis[INPUT_AXIS_X] = 0; |
| 175 | s->axis[INPUT_AXIS_Y] = 0; |
| 176 | } |
| 177 | |
| 178 | /* need to still generate PS2 events to notify driver to |
| 179 | read from queue */ |
| 180 | i8042_isa_mouse_fake_event(s->i8042); |
| 181 | } |
| 182 | |
| 183 | static void vmmouse_remove_handler(VMMouseState *s) |
| 184 | { |
| 185 | g_clear_pointer(&s->hs, qemu_input_handler_unregister); |
| 186 | } |
| 187 | |
| 188 | static void vmmouse_update_handler(VMMouseState *s, int absolute) |
| 189 | { |
| 190 | static const QemuInputHandler vmmouse_abs_handler = { |
| 191 | .name = "vmmouse", |
| 192 | .mask = INPUT_EVENT_MASK_BTN | INPUT_EVENT_MASK_ABS, |
| 193 | .event = vmmouse_input_event, |
| 194 | .sync = vmmouse_input_sync, |
| 195 | }; |
| 196 | |
| 197 | static const QemuInputHandler vmmouse_rel_handler = { |
| 198 | .name = "vmmouse", |
| 199 | .mask = INPUT_EVENT_MASK_BTN | INPUT_EVENT_MASK_REL, |
| 200 | .event = vmmouse_input_event, |
| 201 | .sync = vmmouse_input_sync, |
| 202 | }; |
| 203 | |
| 204 | if (s->status != 0) { |
| 205 | return; |
| 206 | } |
| 207 | if (s->absolute != absolute) { |
| 208 | s->absolute = absolute; |
| 209 | vmmouse_remove_handler(s); |
| 210 | } |
| 211 | if (s->hs == NULL) { |
| 212 | const QemuInputHandler *h = s->absolute ? |
| 213 | &vmmouse_abs_handler : &vmmouse_rel_handler; |
| 214 | s->hs = qemu_input_handler_register(DEVICE(s), h); |
| 215 | qemu_input_handler_activate(s->hs); |
| 216 | } |
| 217 | } |
| 218 | |
| 219 | static void vmmouse_read_id(VMMouseState *s) |
| 220 | { |
| 221 | trace_vmmouse_read_id(); |
| 222 | |
| 223 | if (s->nb_queue == VMMOUSE_QUEUE_SIZE) |
| 224 | return; |
| 225 | |
| 226 | s->queue[s->nb_queue++] = VMMOUSE_VERSION; |
| 227 | s->status = 0; |
| 228 | vmmouse_update_handler(s, s->absolute); |
| 229 | } |
| 230 | |
| 231 | static void vmmouse_request_relative(VMMouseState *s) |
| 232 | { |
| 233 | trace_vmmouse_request_relative(); |
| 234 | |
| 235 | vmmouse_update_handler(s, 0); |
| 236 | } |
| 237 | |
| 238 | static void vmmouse_request_absolute(VMMouseState *s) |
| 239 | { |
| 240 | trace_vmmouse_request_absolute(); |
| 241 | |
| 242 | vmmouse_update_handler(s, 1); |
| 243 | } |
| 244 | |
| 245 | static void vmmouse_disable(VMMouseState *s) |
| 246 | { |
| 247 | trace_vmmouse_disable(); |
| 248 | |
| 249 | s->status = 0xffff; |
| 250 | vmmouse_remove_handler(s); |
| 251 | } |
| 252 | |
| 253 | static void vmmouse_data(VMMouseState *s, uint64_t *data, uint32_t size) |
| 254 | { |
| 255 | int i; |
| 256 | |
| 257 | trace_vmmouse_data(size); |
| 258 | |
| 259 | if (size == 0 || size > 6 || size > s->nb_queue) { |
| 260 | printf("vmmouse: driver requested too much data %d\n", size); |
| 261 | s->status = 0xffff; |
| 262 | vmmouse_remove_handler(s); |
| 263 | return; |
| 264 | } |
| 265 | |
| 266 | for (i = 0; i < size; i++) |
| 267 | data[i] = s->queue[i]; |
| 268 | |
| 269 | s->nb_queue -= size; |
| 270 | if (s->nb_queue) |
| 271 | memmove(s->queue, &s->queue[size], sizeof(s->queue[0]) * s->nb_queue); |
| 272 | } |
| 273 | |
| 274 | static uint32_t vmmouse_ioport_read(void *opaque, uint32_t addr) |
| 275 | { |
| 276 | VMMouseState *s = opaque; |
| 277 | uint64_t data[6]; |
| 278 | uint16_t command; |
| 279 | |
| 280 | vmmouse_get_data(data); |
| 281 | |
| 282 | command = data[2] & 0xFFFF; |
| 283 | |
| 284 | switch (command) { |
| 285 | case VMPORT_CMD_VMMOUSE_STATUS: |
| 286 | data[0] = vmmouse_get_status(s); |
| 287 | break; |
| 288 | case VMPORT_CMD_VMMOUSE_COMMAND: |
| 289 | switch (data[1]) { |
| 290 | case VMMOUSE_DISABLE: |
| 291 | vmmouse_disable(s); |
| 292 | break; |
| 293 | case VMMOUSE_READ_ID: |
| 294 | vmmouse_read_id(s); |
| 295 | break; |
| 296 | case VMMOUSE_REQUEST_RELATIVE: |
| 297 | vmmouse_request_relative(s); |
| 298 | break; |
| 299 | case VMMOUSE_REQUEST_ABSOLUTE: |
| 300 | vmmouse_request_absolute(s); |
| 301 | break; |
| 302 | default: |
| 303 | printf("vmmouse: unknown command %" PRIx64 "\n", data[1]); |
| 304 | break; |
| 305 | } |
| 306 | break; |
| 307 | case VMPORT_CMD_VMMOUSE_DATA: |
| 308 | vmmouse_data(s, data, data[1]); |
| 309 | break; |
| 310 | default: |
| 311 | printf("vmmouse: unknown command %x\n", command); |
| 312 | break; |
| 313 | } |
| 314 | |
| 315 | vmmouse_set_data(data); |
| 316 | return data[0]; |
| 317 | } |
| 318 | |
| 319 | static int vmmouse_post_load(void *opaque, int version_id) |
| 320 | { |
| 321 | VMMouseState *s = opaque; |
| 322 | |
| 323 | vmmouse_remove_handler(s); |
| 324 | vmmouse_update_handler(s, s->absolute); |
| 325 | return 0; |
| 326 | } |
| 327 | |
| 328 | static const VMStateDescription vmstate_vmmouse = { |
| 329 | .name = "vmmouse", |
| 330 | .version_id = 0, |
| 331 | .minimum_version_id = 0, |
| 332 | .post_load = vmmouse_post_load, |
| 333 | .fields = (const VMStateField[]) { |
| 334 | VMSTATE_INT32_EQUAL(queue_size, VMMouseState), |
| 335 | VMSTATE_UINT32_ARRAY(queue, VMMouseState, VMMOUSE_QUEUE_SIZE), |
| 336 | VMSTATE_UINT16(nb_queue, VMMouseState), |
| 337 | VMSTATE_UINT16(status, VMMouseState), |
| 338 | VMSTATE_UINT8(absolute, VMMouseState), |
| 339 | VMSTATE_END_OF_LIST() |
| 340 | } |
| 341 | }; |
| 342 | |
| 343 | static void vmmouse_reset(DeviceState *d) |
| 344 | { |
| 345 | VMMouseState *s = VMMOUSE(d); |
| 346 | |
| 347 | s->queue_size = VMMOUSE_QUEUE_SIZE; |
| 348 | s->nb_queue = 0; |
| 349 | |
| 350 | vmmouse_disable(s); |
| 351 | } |
| 352 | |
| 353 | static void vmmouse_realizefn(DeviceState *dev, Error **errp) |
| 354 | { |
| 355 | VMMouseState *s = VMMOUSE(dev); |
| 356 | |
| 357 | trace_vmmouse_init(); |
| 358 | |
| 359 | if (!s->i8042) { |
| 360 | error_setg(errp, "'i8042' link is not set"); |
| 361 | return; |
| 362 | } |
| 363 | if (!object_resolve_path_type("", TYPE_VMPORT, NULL)) { |
| 364 | error_setg(errp, "vmmouse needs a machine with vmport"); |
| 365 | return; |
| 366 | } |
| 367 | |
| 368 | vmport_register(VMPORT_CMD_VMMOUSE_STATUS, vmmouse_ioport_read, s); |
| 369 | vmport_register(VMPORT_CMD_VMMOUSE_COMMAND, vmmouse_ioport_read, s); |
| 370 | vmport_register(VMPORT_CMD_VMMOUSE_DATA, vmmouse_ioport_read, s); |
| 371 | } |
| 372 | |
| 373 | static const Property vmmouse_properties[] = { |
| 374 | DEFINE_PROP_LINK("i8042", VMMouseState, i8042, TYPE_I8042, ISAKBDState *), |
| 375 | }; |
| 376 | |
| 377 | static void vmmouse_class_initfn(ObjectClass *klass, const void *data) |
| 378 | { |
| 379 | DeviceClass *dc = DEVICE_CLASS(klass); |
| 380 | |
| 381 | dc->realize = vmmouse_realizefn; |
| 382 | device_class_set_legacy_reset(dc, vmmouse_reset); |
| 383 | dc->vmsd = &vmstate_vmmouse; |
| 384 | device_class_set_props(dc, vmmouse_properties); |
| 385 | set_bit(DEVICE_CATEGORY_INPUT, dc->categories); |
| 386 | } |
| 387 | |
| 388 | static const TypeInfo vmmouse_info = { |
| 389 | .name = TYPE_VMMOUSE, |
| 390 | .parent = TYPE_ISA_DEVICE, |
| 391 | .instance_size = sizeof(VMMouseState), |
| 392 | .class_init = vmmouse_class_initfn, |
| 393 | }; |
| 394 | |
| 395 | static void vmmouse_register_types(void) |
| 396 | { |
| 397 | type_register_static(&vmmouse_info); |
| 398 | } |
| 399 | |
| 400 | type_init(vmmouse_register_types) |