hw/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 #include "hw.h"
  25 #include "console.h"
  26 #include "ps2.h"
  27 #include "pc.h"
  28
  29 /* debug only vmmouse */
  30 //#define DEBUG_VMMOUSE
  31
  32 /* VMMouse Commands */
  33 #define VMMOUSE_GETVERSION      10
  34 #define VMMOUSE_DATA            39
  35 #define VMMOUSE_STATUS          40
  36 #define VMMOUSE_COMMAND         41
  37
  38 #define VMMOUSE_READ_ID                 0x45414552
  39 #define VMMOUSE_DISABLE                 0x000000f5
  40 #define VMMOUSE_REQUEST_RELATIVE        0x4c455252
  41 #define VMMOUSE_REQUEST_ABSOLUTE        0x53424152
  42
  43 #define VMMOUSE_QUEUE_SIZE      1024
  44
  45 #define VMMOUSE_VERSION         0x3442554a
  46
  47 #ifdef DEBUG_VMMOUSE
  48 #define DPRINTF(fmt, ...) printf(fmt, ## __VA_ARGS__)
  49 #else
  50 #define DPRINTF(fmt, ...) do { } while (0)
  51 #endif
  52
  53 typedef struct _VMMouseState
  54 {
  55     uint32_t queue[VMMOUSE_QUEUE_SIZE];
  56     int32_t queue_size;
  57     uint16_t nb_queue;
  58     uint16_t status;
  59     uint8_t absolute;
  60     QEMUPutMouseEntry *entry;
  61     void *ps2_mouse;
  62 } VMMouseState;
  63
  64 static uint32_t vmmouse_get_status(VMMouseState *s)
  65 {
  66     DPRINTF("vmmouse_get_status()\n");
  67     return (s->status << 16) | s->nb_queue;
  68 }
  69
  70 static void vmmouse_mouse_event(void *opaque, int x, int y, int dz, int buttons_state)
  71 {
  72     VMMouseState *s = opaque;
  73     int buttons = 0;
  74
  75     if (s->nb_queue > (VMMOUSE_QUEUE_SIZE - 4))
  76         return;
  77
  78     DPRINTF("vmmouse_mouse_event(%d, %d, %d, %d)\n",
  79             x, y, dz, buttons_state);
  80
  81     if ((buttons_state & MOUSE_EVENT_LBUTTON))
  82         buttons |= 0x20;
  83     if ((buttons_state & MOUSE_EVENT_RBUTTON))
  84         buttons |= 0x10;
  85     if ((buttons_state & MOUSE_EVENT_MBUTTON))
  86         buttons |= 0x08;
  87
  88     if (s->absolute) {
  89         x <<= 1;
  90         y <<= 1;
  91     }
  92
  93     s->queue[s->nb_queue++] = buttons;
  94     s->queue[s->nb_queue++] = x;
  95     s->queue[s->nb_queue++] = y;
  96     s->queue[s->nb_queue++] = dz;
  97
  98     /* need to still generate PS2 events to notify driver to
  99        read from queue */
 100     ps2_mouse_fake_event(s->ps2_mouse);
 101 }
 102
 103 static void vmmouse_update_handler(VMMouseState *s)
 104 {
 105     if (s->entry) {
 106         qemu_remove_mouse_event_handler(s->entry);
 107         s->entry = NULL;
 108     }
 109     if (s->status == 0)
 110         s->entry = qemu_add_mouse_event_handler(vmmouse_mouse_event,
 111                                                 s, s->absolute,
 112                                                 "vmmouse");
 113 }
 114
 115 static void vmmouse_read_id(VMMouseState *s)
 116 {
 117     DPRINTF("vmmouse_read_id()\n");
 118
 119     if (s->nb_queue == VMMOUSE_QUEUE_SIZE)
 120         return;
 121
 122     s->queue[s->nb_queue++] = VMMOUSE_VERSION;
 123     s->status = 0;
 124     vmmouse_update_handler(s);
 125 }
 126
 127 static void vmmouse_request_relative(VMMouseState *s)
 128 {
 129     DPRINTF("vmmouse_request_relative()\n");
 130     s->absolute = 0;
 131     vmmouse_update_handler(s);
 132 }
 133
 134 static void vmmouse_request_absolute(VMMouseState *s)
 135 {
 136     DPRINTF("vmmouse_request_absolute()\n");
 137     s->absolute = 1;
 138     vmmouse_update_handler(s);
 139 }
 140
 141 static void vmmouse_disable(VMMouseState *s)
 142 {
 143     DPRINTF("vmmouse_disable()\n");
 144     s->status = 0xffff;
 145     vmmouse_update_handler(s);
 146 }
 147
 148 static void vmmouse_data(VMMouseState *s, uint32_t *data, uint32_t size)
 149 {
 150     int i;
 151
 152     DPRINTF("vmmouse_data(%d)\n", size);
 153
 154     if (size == 0 || size > 6 || size > s->nb_queue) {
 155         printf("vmmouse: driver requested too much data %d\n", size);
 156         s->status = 0xffff;
 157         vmmouse_update_handler(s);
 158         return;
 159     }
 160
 161     for (i = 0; i < size; i++)
 162         data[i] = s->queue[i];
 163
 164     s->nb_queue -= size;
 165     if (s->nb_queue)
 166         memmove(s->queue, &s->queue[size], sizeof(s->queue[0]) * s->nb_queue);
 167 }
 168
 169 static void vmmouse_get_data(uint32_t *data)
 170 {
 171     CPUState *env = cpu_single_env;
 172
 173     data[0] = env->regs[R_EAX]; data[1] = env->regs[R_EBX];
 174     data[2] = env->regs[R_ECX]; data[3] = env->regs[R_EDX];
 175     data[4] = env->regs[R_ESI]; data[5] = env->regs[R_EDI];
 176
 177     DPRINTF("get_data = {%x, %x, %x, %x, %x, %x}\n",
 178             data[0], data[1], data[2], data[3], data[4], data[5]);
 179 }
 180
 181 static void vmmouse_set_data(const uint32_t *data)
 182 {
 183     CPUState *env = cpu_single_env;
 184
 185     DPRINTF("set_data = {%x, %x, %x, %x, %x, %x}\n",
 186             data[0], data[1], data[2], data[3], data[4], data[5]);
 187
 188     env->regs[R_EAX] = data[0]; env->regs[R_EBX] = data[1];
 189     env->regs[R_ECX] = data[2]; env->regs[R_EDX] = data[3];
 190     env->regs[R_ESI] = data[4]; env->regs[R_EDI] = data[5];
 191 }
 192
 193 static uint32_t vmmouse_ioport_read(void *opaque, uint32_t addr)
 194 {
 195     VMMouseState *s = opaque;
 196     uint32_t data[6];
 197     uint16_t command;
 198
 199     vmmouse_get_data(data);
 200
 201     command = data[2] & 0xFFFF;
 202
 203     switch (command) {
 204     case VMMOUSE_STATUS:
 205         data[0] = vmmouse_get_status(s);
 206         break;
 207     case VMMOUSE_COMMAND:
 208         switch (data[1]) {
 209         case VMMOUSE_DISABLE:
 210             vmmouse_disable(s);
 211             break;
 212         case VMMOUSE_READ_ID:
 213             vmmouse_read_id(s);
 214             break;
 215         case VMMOUSE_REQUEST_RELATIVE:
 216             vmmouse_request_relative(s);
 217             break;
 218         case VMMOUSE_REQUEST_ABSOLUTE:
 219             vmmouse_request_absolute(s);
 220             break;
 221         default:
 222             printf("vmmouse: unknown command %x\n", data[1]);
 223             break;
 224         }
 225         break;
 226     case VMMOUSE_DATA:
 227         vmmouse_data(s, data, data[1]);
 228         break;
 229     default:
 230         printf("vmmouse: unknown command %x\n", command);
 231         break;
 232     }
 233
 234     vmmouse_set_data(data);
 235     return data[0];
 236 }
 237
 238 static int vmmouse_post_load(void *opaque, int version_id)
 239 {
 240     VMMouseState *s = opaque;
 241
 242     vmmouse_update_handler(s);
 243     return 0;
 244 }
 245
 246 static const VMStateDescription vmstate_vmmouse = {
 247     .name = "vmmouse",
 248     .version_id = 0,
 249     .minimum_version_id = 0,
 250     .minimum_version_id_old = 0,
 251     .post_load = vmmouse_post_load,
 252     .fields      = (VMStateField []) {
 253         VMSTATE_INT32_EQUAL(queue_size, VMMouseState),
 254         VMSTATE_UINT32_ARRAY(queue, VMMouseState, VMMOUSE_QUEUE_SIZE),
 255         VMSTATE_UINT16(nb_queue, VMMouseState),
 256         VMSTATE_UINT16(status, VMMouseState),
 257         VMSTATE_UINT8(absolute, VMMouseState),
 258         VMSTATE_END_OF_LIST()
 259     }
 260 };
 261
 262 void *vmmouse_init(void *m)
 263 {
 264     VMMouseState *s = NULL;
 265
 266     DPRINTF("vmmouse_init\n");
 267
 268     s = qemu_mallocz(sizeof(VMMouseState));
 269
 270     s->status = 0xffff;
 271     s->ps2_mouse = m;
 272     s->queue_size = VMMOUSE_QUEUE_SIZE;
 273
 274     vmport_register(VMMOUSE_STATUS, vmmouse_ioport_read, s);
 275     vmport_register(VMMOUSE_COMMAND, vmmouse_ioport_read, s);
 276     vmport_register(VMMOUSE_DATA, vmmouse_ioport_read, s);
 277     vmstate_register(0, &vmstate_vmmouse, s);
 278
 279     return s;
 280 }