1 /* 2 * Wacom PenPartner USB tablet emulation. 3 * 4 * Copyright (c) 2006 Openedhand Ltd. 5 * Author: Andrzej Zaborowski <balrog@zabor.org> 6 * 7 * Based on hw/usb-hid.c: 8 * Copyright (c) 2005 Fabrice Bellard 9 * 10 * Permission is hereby granted, free of charge, to any person obtaining a copy 11 * of this software and associated documentation files (the "Software"), to deal 12 * in the Software without restriction, including without limitation the rights 13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 14 * copies of the Software, and to permit persons to whom the Software is 15 * furnished to do so, subject to the following conditions: 16 * 17 * The above copyright notice and this permission notice shall be included in 18 * all copies or substantial portions of the Software. 19 * 20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 23 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN 26 * THE SOFTWARE. 27 */ 28 #include "hw/hw.h" 29 #include "ui/console.h" 30 #include "hw/usb.h" 31 #include "hw/usb/desc.h" 32 33 /* Interface requests */ 34 #define WACOM_GET_REPORT 0x2101 35 #define WACOM_SET_REPORT 0x2109 36 37 /* HID interface requests */ 38 #define HID_GET_REPORT 0xa101 39 #define HID_GET_IDLE 0xa102 40 #define HID_GET_PROTOCOL 0xa103 41 #define HID_SET_IDLE 0x210a 42 #define HID_SET_PROTOCOL 0x210b 43 44 typedef struct USBWacomState { 45 USBDevice dev; 46 USBEndpoint *intr; 47 QEMUPutMouseEntry *eh_entry; 48 int dx, dy, dz, buttons_state; 49 int x, y; 50 int mouse_grabbed; 51 enum { 52 WACOM_MODE_HID = 1, 53 WACOM_MODE_WACOM = 2, 54 } mode; 55 uint8_t idle; 56 int changed; 57 } USBWacomState; 58 59 enum { 60 STR_MANUFACTURER = 1, 61 STR_PRODUCT, 62 STR_SERIALNUMBER, 63 }; 64 65 static const USBDescStrings desc_strings = { 66 [STR_MANUFACTURER] = "QEMU", 67 [STR_PRODUCT] = "Wacom PenPartner", 68 [STR_SERIALNUMBER] = "1", 69 }; 70 71 static const USBDescIface desc_iface_wacom = { 72 .bInterfaceNumber = 0, 73 .bNumEndpoints = 1, 74 .bInterfaceClass = USB_CLASS_HID, 75 .bInterfaceSubClass = 0x01, /* boot */ 76 .bInterfaceProtocol = 0x02, 77 .ndesc = 1, 78 .descs = (USBDescOther[]) { 79 { 80 /* HID descriptor */ 81 .data = (uint8_t[]) { 82 0x09, /* u8 bLength */ 83 0x21, /* u8 bDescriptorType */ 84 0x01, 0x10, /* u16 HID_class */ 85 0x00, /* u8 country_code */ 86 0x01, /* u8 num_descriptors */ 87 0x22, /* u8 type: Report */ 88 0x6e, 0, /* u16 len */ 89 }, 90 }, 91 }, 92 .eps = (USBDescEndpoint[]) { 93 { 94 .bEndpointAddress = USB_DIR_IN | 0x01, 95 .bmAttributes = USB_ENDPOINT_XFER_INT, 96 .wMaxPacketSize = 8, 97 .bInterval = 0x0a, 98 }, 99 }, 100 }; 101 102 static const USBDescDevice desc_device_wacom = { 103 .bcdUSB = 0x0110, 104 .bMaxPacketSize0 = 8, 105 .bNumConfigurations = 1, 106 .confs = (USBDescConfig[]) { 107 { 108 .bNumInterfaces = 1, 109 .bConfigurationValue = 1, 110 .bmAttributes = USB_CFG_ATT_ONE, 111 .bMaxPower = 40, 112 .nif = 1, 113 .ifs = &desc_iface_wacom, 114 }, 115 }, 116 }; 117 118 static const USBDesc desc_wacom = { 119 .id = { 120 .idVendor = 0x056a, 121 .idProduct = 0x0000, 122 .bcdDevice = 0x4210, 123 .iManufacturer = STR_MANUFACTURER, 124 .iProduct = STR_PRODUCT, 125 .iSerialNumber = STR_SERIALNUMBER, 126 }, 127 .full = &desc_device_wacom, 128 .str = desc_strings, 129 }; 130 131 static void usb_mouse_event(void *opaque, 132 int dx1, int dy1, int dz1, int buttons_state) 133 { 134 USBWacomState *s = opaque; 135 136 s->dx += dx1; 137 s->dy += dy1; 138 s->dz += dz1; 139 s->buttons_state = buttons_state; 140 s->changed = 1; 141 usb_wakeup(s->intr, 0); 142 } 143 144 static void usb_wacom_event(void *opaque, 145 int x, int y, int dz, int buttons_state) 146 { 147 USBWacomState *s = opaque; 148 149 /* scale to Penpartner resolution */ 150 s->x = (x * 5040 / 0x7FFF); 151 s->y = (y * 3780 / 0x7FFF); 152 s->dz += dz; 153 s->buttons_state = buttons_state; 154 s->changed = 1; 155 usb_wakeup(s->intr, 0); 156 } 157 158 static inline int int_clamp(int val, int vmin, int vmax) 159 { 160 if (val < vmin) 161 return vmin; 162 else if (val > vmax) 163 return vmax; 164 else 165 return val; 166 } 167 168 static int usb_mouse_poll(USBWacomState *s, uint8_t *buf, int len) 169 { 170 int dx, dy, dz, b, l; 171 172 if (!s->mouse_grabbed) { 173 s->eh_entry = qemu_add_mouse_event_handler(usb_mouse_event, s, 0, 174 "QEMU PenPartner tablet"); 175 qemu_activate_mouse_event_handler(s->eh_entry); 176 s->mouse_grabbed = 1; 177 } 178 179 dx = int_clamp(s->dx, -128, 127); 180 dy = int_clamp(s->dy, -128, 127); 181 dz = int_clamp(s->dz, -128, 127); 182 183 s->dx -= dx; 184 s->dy -= dy; 185 s->dz -= dz; 186 187 b = 0; 188 if (s->buttons_state & MOUSE_EVENT_LBUTTON) 189 b |= 0x01; 190 if (s->buttons_state & MOUSE_EVENT_RBUTTON) 191 b |= 0x02; 192 if (s->buttons_state & MOUSE_EVENT_MBUTTON) 193 b |= 0x04; 194 195 buf[0] = b; 196 buf[1] = dx; 197 buf[2] = dy; 198 l = 3; 199 if (len >= 4) { 200 buf[3] = dz; 201 l = 4; 202 } 203 return l; 204 } 205 206 static int usb_wacom_poll(USBWacomState *s, uint8_t *buf, int len) 207 { 208 int b; 209 210 if (!s->mouse_grabbed) { 211 s->eh_entry = qemu_add_mouse_event_handler(usb_wacom_event, s, 1, 212 "QEMU PenPartner tablet"); 213 qemu_activate_mouse_event_handler(s->eh_entry); 214 s->mouse_grabbed = 1; 215 } 216 217 b = 0; 218 if (s->buttons_state & MOUSE_EVENT_LBUTTON) 219 b |= 0x01; 220 if (s->buttons_state & MOUSE_EVENT_RBUTTON) 221 b |= 0x40; 222 if (s->buttons_state & MOUSE_EVENT_MBUTTON) 223 b |= 0x20; /* eraser */ 224 225 if (len < 7) 226 return 0; 227 228 buf[0] = s->mode; 229 buf[5] = 0x00 | (b & 0xf0); 230 buf[1] = s->x & 0xff; 231 buf[2] = s->x >> 8; 232 buf[3] = s->y & 0xff; 233 buf[4] = s->y >> 8; 234 if (b & 0x3f) { 235 buf[6] = 0; 236 } else { 237 buf[6] = (unsigned char) -127; 238 } 239 240 return 7; 241 } 242 243 static void usb_wacom_handle_reset(USBDevice *dev) 244 { 245 USBWacomState *s = (USBWacomState *) dev; 246 247 s->dx = 0; 248 s->dy = 0; 249 s->dz = 0; 250 s->x = 0; 251 s->y = 0; 252 s->buttons_state = 0; 253 s->mode = WACOM_MODE_HID; 254 } 255 256 static void usb_wacom_handle_control(USBDevice *dev, USBPacket *p, 257 int request, int value, int index, int length, uint8_t *data) 258 { 259 USBWacomState *s = (USBWacomState *) dev; 260 int ret; 261 262 ret = usb_desc_handle_control(dev, p, request, value, index, length, data); 263 if (ret >= 0) { 264 return; 265 } 266 267 switch (request) { 268 case WACOM_SET_REPORT: 269 if (s->mouse_grabbed) { 270 qemu_remove_mouse_event_handler(s->eh_entry); 271 s->mouse_grabbed = 0; 272 } 273 s->mode = data[0]; 274 break; 275 case WACOM_GET_REPORT: 276 data[0] = 0; 277 data[1] = s->mode; 278 p->actual_length = 2; 279 break; 280 /* USB HID requests */ 281 case HID_GET_REPORT: 282 if (s->mode == WACOM_MODE_HID) 283 p->actual_length = usb_mouse_poll(s, data, length); 284 else if (s->mode == WACOM_MODE_WACOM) 285 p->actual_length = usb_wacom_poll(s, data, length); 286 break; 287 case HID_GET_IDLE: 288 data[0] = s->idle; 289 p->actual_length = 1; 290 break; 291 case HID_SET_IDLE: 292 s->idle = (uint8_t) (value >> 8); 293 break; 294 default: 295 p->status = USB_RET_STALL; 296 break; 297 } 298 } 299 300 static void usb_wacom_handle_data(USBDevice *dev, USBPacket *p) 301 { 302 USBWacomState *s = (USBWacomState *) dev; 303 uint8_t buf[p->iov.size]; 304 int len = 0; 305 306 switch (p->pid) { 307 case USB_TOKEN_IN: 308 if (p->ep->nr == 1) { 309 if (!(s->changed || s->idle)) { 310 p->status = USB_RET_NAK; 311 return; 312 } 313 s->changed = 0; 314 if (s->mode == WACOM_MODE_HID) 315 len = usb_mouse_poll(s, buf, p->iov.size); 316 else if (s->mode == WACOM_MODE_WACOM) 317 len = usb_wacom_poll(s, buf, p->iov.size); 318 usb_packet_copy(p, buf, len); 319 break; 320 } 321 /* Fall through. */ 322 case USB_TOKEN_OUT: 323 default: 324 p->status = USB_RET_STALL; 325 } 326 } 327 328 static void usb_wacom_handle_destroy(USBDevice *dev) 329 { 330 USBWacomState *s = (USBWacomState *) dev; 331 332 if (s->mouse_grabbed) { 333 qemu_remove_mouse_event_handler(s->eh_entry); 334 s->mouse_grabbed = 0; 335 } 336 } 337 338 static int usb_wacom_initfn(USBDevice *dev) 339 { 340 USBWacomState *s = DO_UPCAST(USBWacomState, dev, dev); 341 usb_desc_create_serial(dev); 342 usb_desc_init(dev); 343 s->intr = usb_ep_get(dev, USB_TOKEN_IN, 1); 344 s->changed = 1; 345 return 0; 346 } 347 348 static const VMStateDescription vmstate_usb_wacom = { 349 .name = "usb-wacom", 350 .unmigratable = 1, 351 }; 352 353 static void usb_wacom_class_init(ObjectClass *klass, void *data) 354 { 355 DeviceClass *dc = DEVICE_CLASS(klass); 356 USBDeviceClass *uc = USB_DEVICE_CLASS(klass); 357 358 uc->product_desc = "QEMU PenPartner Tablet"; 359 uc->usb_desc = &desc_wacom; 360 uc->init = usb_wacom_initfn; 361 uc->handle_reset = usb_wacom_handle_reset; 362 uc->handle_control = usb_wacom_handle_control; 363 uc->handle_data = usb_wacom_handle_data; 364 uc->handle_destroy = usb_wacom_handle_destroy; 365 set_bit(DEVICE_CATEGORY_INPUT, dc->categories); 366 dc->desc = "QEMU PenPartner Tablet"; 367 dc->vmsd = &vmstate_usb_wacom; 368 } 369 370 static const TypeInfo wacom_info = { 371 .name = "usb-wacom-tablet", 372 .parent = TYPE_USB_DEVICE, 373 .instance_size = sizeof(USBWacomState), 374 .class_init = usb_wacom_class_init, 375 }; 376 377 static void usb_wacom_register_types(void) 378 { 379 type_register_static(&wacom_info); 380 usb_legacy_register("usb-wacom-tablet", "wacom-tablet", NULL); 381 } 382 383 type_init(usb_wacom_register_types) 384