]> git.proxmox.com Git - mirror_qemu.git/blame - hw/usb/dev-wacom.c
add pc-1.4
[mirror_qemu.git] / hw / usb / dev-wacom.c
CommitLineData
f6d2a316
AZ
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 */
f1ae32a1 28#include "hw/hw.h"
87ecb68b 29#include "console.h"
f1ae32a1
GH
30#include "hw/usb.h"
31#include "hw/usb/desc.h"
f6d2a316
AZ
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
44typedef struct USBWacomState {
45 USBDevice dev;
46 QEMUPutMouseEntry *eh_entry;
47 int dx, dy, dz, buttons_state;
48 int x, y;
49 int mouse_grabbed;
50 enum {
51 WACOM_MODE_HID = 1,
52 WACOM_MODE_WACOM = 2,
53 } mode;
2ca2078e
FR
54 uint8_t idle;
55 int changed;
f6d2a316
AZ
56} USBWacomState;
57
037a5203
GH
58enum {
59 STR_MANUFACTURER = 1,
60 STR_PRODUCT,
61 STR_SERIALNUMBER,
62};
f6d2a316 63
037a5203 64static const USBDescStrings desc_strings = {
93bfef4c 65 [STR_MANUFACTURER] = "QEMU",
037a5203
GH
66 [STR_PRODUCT] = "Wacom PenPartner",
67 [STR_SERIALNUMBER] = "1",
68};
f6d2a316 69
037a5203
GH
70static const USBDescIface desc_iface_wacom = {
71 .bInterfaceNumber = 0,
72 .bNumEndpoints = 1,
73 .bInterfaceClass = USB_CLASS_HID,
74 .bInterfaceSubClass = 0x01, /* boot */
75 .bInterfaceProtocol = 0x02,
76 .ndesc = 1,
77 .descs = (USBDescOther[]) {
78 {
79 /* HID descriptor */
80 .data = (uint8_t[]) {
81 0x09, /* u8 bLength */
82 0x21, /* u8 bDescriptorType */
83 0x01, 0x10, /* u16 HID_class */
84 0x00, /* u8 country_code */
85 0x01, /* u8 num_descriptors */
86 0x22, /* u8 type: Report */
87 0x6e, 0, /* u16 len */
88 },
89 },
90 },
91 .eps = (USBDescEndpoint[]) {
92 {
93 .bEndpointAddress = USB_DIR_IN | 0x01,
94 .bmAttributes = USB_ENDPOINT_XFER_INT,
95 .wMaxPacketSize = 8,
96 .bInterval = 0x0a,
97 },
98 },
99};
f6d2a316 100
037a5203
GH
101static const USBDescDevice desc_device_wacom = {
102 .bcdUSB = 0x0110,
103 .bMaxPacketSize0 = 8,
104 .bNumConfigurations = 1,
105 .confs = (USBDescConfig[]) {
106 {
107 .bNumInterfaces = 1,
108 .bConfigurationValue = 1,
109 .bmAttributes = 0x80,
110 .bMaxPower = 40,
add75088 111 .nif = 1,
037a5203
GH
112 .ifs = &desc_iface_wacom,
113 },
114 },
f6d2a316
AZ
115};
116
037a5203
GH
117static const USBDesc desc_wacom = {
118 .id = {
119 .idVendor = 0x056a,
120 .idProduct = 0x0000,
121 .bcdDevice = 0x4210,
122 .iManufacturer = STR_MANUFACTURER,
123 .iProduct = STR_PRODUCT,
124 .iSerialNumber = STR_SERIALNUMBER,
125 },
126 .full = &desc_device_wacom,
127 .str = desc_strings,
f6d2a316
AZ
128};
129
130static void usb_mouse_event(void *opaque,
131 int dx1, int dy1, int dz1, int buttons_state)
132{
133 USBWacomState *s = opaque;
134
135 s->dx += dx1;
136 s->dy += dy1;
137 s->dz += dz1;
138 s->buttons_state = buttons_state;
2ca2078e 139 s->changed = 1;
f6d2a316
AZ
140}
141
142static void usb_wacom_event(void *opaque,
143 int x, int y, int dz, int buttons_state)
144{
145 USBWacomState *s = opaque;
146
2ca2078e
FR
147 /* scale to Penpartner resolution */
148 s->x = (x * 5040 / 0x7FFF);
149 s->y = (y * 3780 / 0x7FFF);
f6d2a316
AZ
150 s->dz += dz;
151 s->buttons_state = buttons_state;
2ca2078e 152 s->changed = 1;
f6d2a316
AZ
153}
154
155static inline int int_clamp(int val, int vmin, int vmax)
156{
157 if (val < vmin)
158 return vmin;
159 else if (val > vmax)
160 return vmax;
161 else
162 return val;
163}
164
165static int usb_mouse_poll(USBWacomState *s, uint8_t *buf, int len)
166{
167 int dx, dy, dz, b, l;
168
169 if (!s->mouse_grabbed) {
170 s->eh_entry = qemu_add_mouse_event_handler(usb_mouse_event, s, 0,
171 "QEMU PenPartner tablet");
b2d4d832 172 qemu_activate_mouse_event_handler(s->eh_entry);
f6d2a316
AZ
173 s->mouse_grabbed = 1;
174 }
175
176 dx = int_clamp(s->dx, -128, 127);
177 dy = int_clamp(s->dy, -128, 127);
178 dz = int_clamp(s->dz, -128, 127);
179
180 s->dx -= dx;
181 s->dy -= dy;
182 s->dz -= dz;
183
184 b = 0;
185 if (s->buttons_state & MOUSE_EVENT_LBUTTON)
186 b |= 0x01;
187 if (s->buttons_state & MOUSE_EVENT_RBUTTON)
188 b |= 0x02;
189 if (s->buttons_state & MOUSE_EVENT_MBUTTON)
190 b |= 0x04;
191
192 buf[0] = b;
193 buf[1] = dx;
194 buf[2] = dy;
195 l = 3;
196 if (len >= 4) {
197 buf[3] = dz;
198 l = 4;
199 }
200 return l;
201}
202
203static int usb_wacom_poll(USBWacomState *s, uint8_t *buf, int len)
204{
205 int b;
206
207 if (!s->mouse_grabbed) {
208 s->eh_entry = qemu_add_mouse_event_handler(usb_wacom_event, s, 1,
209 "QEMU PenPartner tablet");
b2d4d832 210 qemu_activate_mouse_event_handler(s->eh_entry);
f6d2a316
AZ
211 s->mouse_grabbed = 1;
212 }
213
214 b = 0;
215 if (s->buttons_state & MOUSE_EVENT_LBUTTON)
216 b |= 0x01;
217 if (s->buttons_state & MOUSE_EVENT_RBUTTON)
2ca2078e 218 b |= 0x40;
f6d2a316 219 if (s->buttons_state & MOUSE_EVENT_MBUTTON)
2ca2078e 220 b |= 0x20; /* eraser */
f6d2a316
AZ
221
222 if (len < 7)
223 return 0;
224
225 buf[0] = s->mode;
2ca2078e
FR
226 buf[5] = 0x00 | (b & 0xf0);
227 buf[1] = s->x & 0xff;
228 buf[2] = s->x >> 8;
229 buf[3] = s->y & 0xff;
230 buf[4] = s->y >> 8;
231 if (b & 0x3f) {
f6d2a316
AZ
232 buf[6] = 0;
233 } else {
f6d2a316
AZ
234 buf[6] = (unsigned char) -127;
235 }
236
237 return 7;
238}
239
240static void usb_wacom_handle_reset(USBDevice *dev)
241{
242 USBWacomState *s = (USBWacomState *) dev;
243
244 s->dx = 0;
245 s->dy = 0;
246 s->dz = 0;
247 s->x = 0;
248 s->y = 0;
249 s->buttons_state = 0;
250 s->mode = WACOM_MODE_HID;
251}
252
9a77a0f5 253static void usb_wacom_handle_control(USBDevice *dev, USBPacket *p,
007fd62f 254 int request, int value, int index, int length, uint8_t *data)
f6d2a316
AZ
255{
256 USBWacomState *s = (USBWacomState *) dev;
037a5203
GH
257 int ret;
258
007fd62f 259 ret = usb_desc_handle_control(dev, p, request, value, index, length, data);
037a5203 260 if (ret >= 0) {
9a77a0f5 261 return;
037a5203 262 }
f6d2a316
AZ
263
264 switch (request) {
f6d2a316 265 case WACOM_SET_REPORT:
b2d4d832
GH
266 if (s->mouse_grabbed) {
267 qemu_remove_mouse_event_handler(s->eh_entry);
268 s->mouse_grabbed = 0;
269 }
f6d2a316 270 s->mode = data[0];
f6d2a316
AZ
271 break;
272 case WACOM_GET_REPORT:
273 data[0] = 0;
274 data[1] = s->mode;
9a77a0f5 275 p->actual_length = 2;
f6d2a316
AZ
276 break;
277 /* USB HID requests */
278 case HID_GET_REPORT:
279 if (s->mode == WACOM_MODE_HID)
9a77a0f5 280 p->actual_length = usb_mouse_poll(s, data, length);
f6d2a316 281 else if (s->mode == WACOM_MODE_WACOM)
9a77a0f5 282 p->actual_length = usb_wacom_poll(s, data, length);
f6d2a316 283 break;
2ca2078e 284 case HID_GET_IDLE:
2ca2078e 285 data[0] = s->idle;
9a77a0f5 286 p->actual_length = 1;
2ca2078e 287 break;
f6d2a316 288 case HID_SET_IDLE:
2ca2078e 289 s->idle = (uint8_t) (value >> 8);
f6d2a316
AZ
290 break;
291 default:
9a77a0f5 292 p->status = USB_RET_STALL;
f6d2a316
AZ
293 break;
294 }
f6d2a316
AZ
295}
296
9a77a0f5 297static void usb_wacom_handle_data(USBDevice *dev, USBPacket *p)
f6d2a316
AZ
298{
299 USBWacomState *s = (USBWacomState *) dev;
4f4321c1 300 uint8_t buf[p->iov.size];
9a77a0f5 301 int len = 0;
f6d2a316
AZ
302
303 switch (p->pid) {
304 case USB_TOKEN_IN:
079d0b7f 305 if (p->ep->nr == 1) {
9a77a0f5
HG
306 if (!(s->changed || s->idle)) {
307 p->status = USB_RET_NAK;
308 return;
309 }
2ca2078e 310 s->changed = 0;
f6d2a316 311 if (s->mode == WACOM_MODE_HID)
9a77a0f5 312 len = usb_mouse_poll(s, buf, p->iov.size);
f6d2a316 313 else if (s->mode == WACOM_MODE_WACOM)
9a77a0f5
HG
314 len = usb_wacom_poll(s, buf, p->iov.size);
315 usb_packet_copy(p, buf, len);
f6d2a316
AZ
316 break;
317 }
318 /* Fall through. */
319 case USB_TOKEN_OUT:
320 default:
9a77a0f5 321 p->status = USB_RET_STALL;
f6d2a316 322 }
f6d2a316
AZ
323}
324
325static void usb_wacom_handle_destroy(USBDevice *dev)
326{
327 USBWacomState *s = (USBWacomState *) dev;
328
b2d4d832
GH
329 if (s->mouse_grabbed) {
330 qemu_remove_mouse_event_handler(s->eh_entry);
331 s->mouse_grabbed = 0;
332 }
f6d2a316
AZ
333}
334
806b6024 335static int usb_wacom_initfn(USBDevice *dev)
f6d2a316 336{
806b6024 337 USBWacomState *s = DO_UPCAST(USBWacomState, dev, dev);
9d55d1ad 338 usb_desc_create_serial(dev);
a980a065 339 usb_desc_init(dev);
2ca2078e 340 s->changed = 1;
806b6024
GH
341 return 0;
342}
f6d2a316 343
ccce9fd2
GH
344static const VMStateDescription vmstate_usb_wacom = {
345 .name = "usb-wacom",
346 .unmigratable = 1,
347};
348
39bffca2 349static void usb_wacom_class_init(ObjectClass *klass, void *data)
62aed765 350{
39bffca2
AL
351 DeviceClass *dc = DEVICE_CLASS(klass);
352 USBDeviceClass *uc = USB_DEVICE_CLASS(klass);
62aed765
AL
353
354 uc->product_desc = "QEMU PenPartner Tablet";
355 uc->usb_desc = &desc_wacom;
356 uc->init = usb_wacom_initfn;
62aed765
AL
357 uc->handle_reset = usb_wacom_handle_reset;
358 uc->handle_control = usb_wacom_handle_control;
359 uc->handle_data = usb_wacom_handle_data;
360 uc->handle_destroy = usb_wacom_handle_destroy;
39bffca2
AL
361 dc->desc = "QEMU PenPartner Tablet";
362 dc->vmsd = &vmstate_usb_wacom;
62aed765
AL
363}
364
39bffca2
AL
365static TypeInfo wacom_info = {
366 .name = "usb-wacom-tablet",
367 .parent = TYPE_USB_DEVICE,
368 .instance_size = sizeof(USBWacomState),
369 .class_init = usb_wacom_class_init,
806b6024 370};
f6d2a316 371
83f7d43a 372static void usb_wacom_register_types(void)
806b6024 373{
39bffca2 374 type_register_static(&wacom_info);
ba02430f 375 usb_legacy_register("usb-wacom-tablet", "wacom-tablet", NULL);
f6d2a316 376}
83f7d43a
AF
377
378type_init(usb_wacom_register_types)