hw/i386/vmmouse.c

   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/pc.h"
  29 #include "hw/input/i8042.h"
  30 #include "hw/qdev-properties.h"
  31 #include "migration/vmstate.h"
  32 #include "vmport.h"
  33
  34 /* debug only vmmouse */
  35 //#define DEBUG_VMMOUSE
  36
  37 /* VMMouse Commands */
  38 #define VMMOUSE_GETVERSION      10
  39 #define VMMOUSE_DATA            39
  40 #define VMMOUSE_STATUS          40
  41 #define VMMOUSE_COMMAND         41
  42
  43 #define VMMOUSE_READ_ID                 0x45414552
  44 #define VMMOUSE_DISABLE                 0x000000f5
  45 #define VMMOUSE_REQUEST_RELATIVE        0x4c455252
  46 #define VMMOUSE_REQUEST_ABSOLUTE        0x53424152
  47
  48 #define VMMOUSE_QUEUE_SIZE      1024
  49
  50 #define VMMOUSE_VERSION         0x3442554a
  51
  52 #ifdef DEBUG_VMMOUSE
  53 #define DPRINTF(fmt, ...) printf(fmt, ## __VA_ARGS__)
  54 #else
  55 #define DPRINTF(fmt, ...) do { } while (0)
  56 #endif
  57
  58 #define TYPE_VMMOUSE "vmmouse"
  59 #define VMMOUSE(obj) OBJECT_CHECK(VMMouseState, (obj), TYPE_VMMOUSE)
  60
  61 typedef struct VMMouseState
  62 {
  63     ISADevice parent_obj;
  64
  65     uint32_t queue[VMMOUSE_QUEUE_SIZE];
  66     int32_t queue_size;
  67     uint16_t nb_queue;
  68     uint16_t status;
  69     uint8_t absolute;
  70     QEMUPutMouseEntry *entry;
  71     ISAKBDState *i8042;
  72 } VMMouseState;
  73
  74 static uint32_t vmmouse_get_status(VMMouseState *s)
  75 {
  76     DPRINTF("vmmouse_get_status()\n");
  77     return (s->status << 16) | s->nb_queue;
  78 }
  79
  80 static void vmmouse_mouse_event(void *opaque, int x, int y, int dz, int buttons_state)
  81 {
  82     VMMouseState *s = opaque;
  83     int buttons = 0;
  84
  85     if (s->nb_queue > (VMMOUSE_QUEUE_SIZE - 4))
  86         return;
  87
  88     DPRINTF("vmmouse_mouse_event(%d, %d, %d, %d)\n",
  89             x, y, dz, buttons_state);
  90
  91     if ((buttons_state & MOUSE_EVENT_LBUTTON))
  92         buttons |= 0x20;
  93     if ((buttons_state & MOUSE_EVENT_RBUTTON))
  94         buttons |= 0x10;
  95     if ((buttons_state & MOUSE_EVENT_MBUTTON))
  96         buttons |= 0x08;
  97
  98     if (s->absolute) {
  99         x <<= 1;
 100         y <<= 1;
 101     }
 102
 103     s->queue[s->nb_queue++] = buttons;
 104     s->queue[s->nb_queue++] = x;
 105     s->queue[s->nb_queue++] = y;
 106     s->queue[s->nb_queue++] = dz;
 107
 108     /* need to still generate PS2 events to notify driver to
 109        read from queue */
 110     i8042_isa_mouse_fake_event(s->i8042);
 111 }
 112
 113 static void vmmouse_remove_handler(VMMouseState *s)
 114 {
 115     if (s->entry) {
 116         qemu_remove_mouse_event_handler(s->entry);
 117         s->entry = NULL;
 118     }
 119 }
 120
 121 static void vmmouse_update_handler(VMMouseState *s, int absolute)
 122 {
 123     if (s->status != 0) {
 124         return;
 125     }
 126     if (s->absolute != absolute) {
 127         s->absolute = absolute;
 128         vmmouse_remove_handler(s);
 129     }
 130     if (s->entry == NULL) {
 131         s->entry = qemu_add_mouse_event_handler(vmmouse_mouse_event,
 132                                                 s, s->absolute,
 133                                                 "vmmouse");
 134         qemu_activate_mouse_event_handler(s->entry);
 135     }
 136 }
 137
 138 static void vmmouse_read_id(VMMouseState *s)
 139 {
 140     DPRINTF("vmmouse_read_id()\n");
 141
 142     if (s->nb_queue == VMMOUSE_QUEUE_SIZE)
 143         return;
 144
 145     s->queue[s->nb_queue++] = VMMOUSE_VERSION;
 146     s->status = 0;
 147 }
 148
 149 static void vmmouse_request_relative(VMMouseState *s)
 150 {
 151     DPRINTF("vmmouse_request_relative()\n");
 152     vmmouse_update_handler(s, 0);
 153 }
 154
 155 static void vmmouse_request_absolute(VMMouseState *s)
 156 {
 157     DPRINTF("vmmouse_request_absolute()\n");
 158     vmmouse_update_handler(s, 1);
 159 }
 160
 161 static void vmmouse_disable(VMMouseState *s)
 162 {
 163     DPRINTF("vmmouse_disable()\n");
 164     s->status = 0xffff;
 165     vmmouse_remove_handler(s);
 166 }
 167
 168 static void vmmouse_data(VMMouseState *s, uint32_t *data, uint32_t size)
 169 {
 170     int i;
 171
 172     DPRINTF("vmmouse_data(%d)\n", size);
 173
 174     if (size == 0 || size > 6 || size > s->nb_queue) {
 175         printf("vmmouse: driver requested too much data %d\n", size);
 176         s->status = 0xffff;
 177         vmmouse_remove_handler(s);
 178         return;
 179     }
 180
 181     for (i = 0; i < size; i++)
 182         data[i] = s->queue[i];
 183
 184     s->nb_queue -= size;
 185     if (s->nb_queue)
 186         memmove(s->queue, &s->queue[size], sizeof(s->queue[0]) * s->nb_queue);
 187 }
 188
 189 static uint32_t vmmouse_ioport_read(void *opaque, uint32_t addr)
 190 {
 191     VMMouseState *s = opaque;
 192     uint32_t data[6];
 193     uint16_t command;
 194
 195     vmmouse_get_data(data);
 196
 197     command = data[2] & 0xFFFF;
 198
 199     switch (command) {
 200     case VMMOUSE_STATUS:
 201         data[0] = vmmouse_get_status(s);
 202         break;
 203     case VMMOUSE_COMMAND:
 204         switch (data[1]) {
 205         case VMMOUSE_DISABLE:
 206             vmmouse_disable(s);
 207             break;
 208         case VMMOUSE_READ_ID:
 209             vmmouse_read_id(s);
 210             break;
 211         case VMMOUSE_REQUEST_RELATIVE:
 212             vmmouse_request_relative(s);
 213             break;
 214         case VMMOUSE_REQUEST_ABSOLUTE:
 215             vmmouse_request_absolute(s);
 216             break;
 217         default:
 218             printf("vmmouse: unknown command %x\n", data[1]);
 219             break;
 220         }
 221         break;
 222     case VMMOUSE_DATA:
 223         vmmouse_data(s, data, data[1]);
 224         break;
 225     default:
 226         printf("vmmouse: unknown command %x\n", command);
 227         break;
 228     }
 229
 230     vmmouse_set_data(data);
 231     return data[0];
 232 }
 233
 234 static int vmmouse_post_load(void *opaque, int version_id)
 235 {
 236     VMMouseState *s = opaque;
 237
 238     vmmouse_remove_handler(s);
 239     vmmouse_update_handler(s, s->absolute);
 240     return 0;
 241 }
 242
 243 static const VMStateDescription vmstate_vmmouse = {
 244     .name = "vmmouse",
 245     .version_id = 0,
 246     .minimum_version_id = 0,
 247     .post_load = vmmouse_post_load,
 248     .fields = (VMStateField[]) {
 249         VMSTATE_INT32_EQUAL(queue_size, VMMouseState, NULL),
 250         VMSTATE_UINT32_ARRAY(queue, VMMouseState, VMMOUSE_QUEUE_SIZE),
 251         VMSTATE_UINT16(nb_queue, VMMouseState),
 252         VMSTATE_UINT16(status, VMMouseState),
 253         VMSTATE_UINT8(absolute, VMMouseState),
 254         VMSTATE_END_OF_LIST()
 255     }
 256 };
 257
 258 static void vmmouse_reset(DeviceState *d)
 259 {
 260     VMMouseState *s = VMMOUSE(d);
 261
 262     s->queue_size = VMMOUSE_QUEUE_SIZE;
 263     s->nb_queue = 0;
 264
 265     vmmouse_disable(s);
 266 }
 267
 268 static void vmmouse_realizefn(DeviceState *dev, Error **errp)
 269 {
 270     VMMouseState *s = VMMOUSE(dev);
 271
 272     DPRINTF("vmmouse_init\n");
 273
 274     if (!object_resolve_path_type("", TYPE_VMPORT, NULL)) {
 275         error_setg(errp, "vmmouse needs a machine with vmport");
 276         return;
 277     }
 278
 279     vmport_register(VMMOUSE_STATUS, vmmouse_ioport_read, s);
 280     vmport_register(VMMOUSE_COMMAND, vmmouse_ioport_read, s);
 281     vmport_register(VMMOUSE_DATA, vmmouse_ioport_read, s);
 282 }
 283
 284 static Property vmmouse_properties[] = {
 285     DEFINE_PROP_LINK("i8042", VMMouseState, i8042, TYPE_I8042, ISAKBDState *),
 286     DEFINE_PROP_END_OF_LIST(),
 287 };
 288
 289 static void vmmouse_class_initfn(ObjectClass *klass, void *data)
 290 {
 291     DeviceClass *dc = DEVICE_CLASS(klass);
 292
 293     dc->realize = vmmouse_realizefn;
 294     dc->reset = vmmouse_reset;
 295     dc->vmsd = &vmstate_vmmouse;
 296     device_class_set_props(dc, vmmouse_properties);
 297 }
 298
 299 static const TypeInfo vmmouse_info = {
 300     .name          = TYPE_VMMOUSE,
 301     .parent        = TYPE_ISA_DEVICE,
 302     .instance_size = sizeof(VMMouseState),
 303     .class_init    = vmmouse_class_initfn,
 304 };
 305
 306 static void vmmouse_register_types(void)
 307 {
 308     type_register_static(&vmmouse_info);
 309 }
 310
 311 type_init(vmmouse_register_types)