2 * drivers/input/tablet/wacom_sys.c
4 * USB Wacom tablet support - system specific code
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
14 #include "wacom_wac.h"
17 /* defines to get HID report descriptor */
18 #define HID_DEVICET_HID (USB_TYPE_CLASS | 0x01)
19 #define HID_DEVICET_REPORT (USB_TYPE_CLASS | 0x02)
20 #define HID_USAGE_UNDEFINED 0x00
21 #define HID_USAGE_PAGE 0x05
22 #define HID_USAGE_PAGE_DIGITIZER 0x0d
23 #define HID_USAGE_PAGE_DESKTOP 0x01
24 #define HID_USAGE 0x09
25 #define HID_USAGE_X 0x30
26 #define HID_USAGE_Y 0x31
27 #define HID_USAGE_X_TILT 0x3d
28 #define HID_USAGE_Y_TILT 0x3e
29 #define HID_USAGE_FINGER 0x22
30 #define HID_USAGE_STYLUS 0x20
31 #define HID_COLLECTION 0xc0
39 struct hid_descriptor {
40 struct usb_descriptor_header header;
45 __le16 wDescriptorLength;
46 } __attribute__ ((packed));
48 /* defines to get/set USB message */
49 #define USB_REQ_GET_REPORT 0x01
50 #define USB_REQ_SET_REPORT 0x09
51 #define WAC_HID_FEATURE_REPORT 0x03
53 static int usb_get_report(struct usb_interface *intf, unsigned char type,
54 unsigned char id, void *buf, int size)
56 return usb_control_msg(interface_to_usbdev(intf),
57 usb_rcvctrlpipe(interface_to_usbdev(intf), 0),
58 USB_REQ_GET_REPORT, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
59 (type << 8) + id, intf->altsetting[0].desc.bInterfaceNumber,
63 static int usb_set_report(struct usb_interface *intf, unsigned char type,
64 unsigned char id, void *buf, int size)
66 return usb_control_msg(interface_to_usbdev(intf),
67 usb_sndctrlpipe(interface_to_usbdev(intf), 0),
68 USB_REQ_SET_REPORT, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
69 (type << 8) + id, intf->altsetting[0].desc.bInterfaceNumber,
73 static void wacom_sys_irq(struct urb *urb)
75 struct wacom *wacom = urb->context;
78 switch (urb->status) {
85 /* this urb is terminated, clean up */
86 dbg("%s - urb shutting down with status: %d", __func__, urb->status);
89 dbg("%s - nonzero urb status received: %d", __func__, urb->status);
93 wacom_wac_irq(&wacom->wacom_wac, urb->actual_length);
96 usb_mark_last_busy(wacom->usbdev);
97 retval = usb_submit_urb(urb, GFP_ATOMIC);
99 err ("%s - usb_submit_urb failed with result %d",
103 static int wacom_open(struct input_dev *dev)
105 struct wacom *wacom = input_get_drvdata(dev);
108 if (usb_autopm_get_interface(wacom->intf) < 0)
111 mutex_lock(&wacom->lock);
113 if (usb_submit_urb(wacom->irq, GFP_KERNEL)) {
119 wacom->intf->needs_remote_wakeup = 1;
122 mutex_unlock(&wacom->lock);
124 usb_autopm_put_interface(wacom->intf);
128 static void wacom_close(struct input_dev *dev)
130 struct wacom *wacom = input_get_drvdata(dev);
132 mutex_lock(&wacom->lock);
133 usb_kill_urb(wacom->irq);
135 wacom->intf->needs_remote_wakeup = 0;
136 mutex_unlock(&wacom->lock);
138 usb_autopm_put_interface(wacom->intf);
141 static int wacom_parse_hid(struct usb_interface *intf, struct hid_descriptor *hid_desc,
142 struct wacom_features *features)
144 struct usb_device *dev = interface_to_usbdev(intf);
146 /* result has to be defined as int for some devices */
148 int i = 0, usage = WCM_UNDEFINED, finger = 0, pen = 0;
149 unsigned char *report;
151 report = kzalloc(hid_desc->wDescriptorLength, GFP_KERNEL);
155 /* retrive report descriptors */
157 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
158 USB_REQ_GET_DESCRIPTOR,
159 USB_RECIP_INTERFACE | USB_DIR_IN,
160 HID_DEVICET_REPORT << 8,
161 intf->altsetting[0].desc.bInterfaceNumber, /* interface */
163 hid_desc->wDescriptorLength,
165 } while (result < 0 && limit++ < 5);
167 /* No need to parse the Descriptor. It isn't an error though */
171 for (i = 0; i < hid_desc->wDescriptorLength; i++) {
175 switch (report[i + 1]) {
176 case HID_USAGE_PAGE_DIGITIZER:
177 usage = WCM_DIGITIZER;
181 case HID_USAGE_PAGE_DESKTOP:
189 switch (report[i + 1]) {
191 if (usage == WCM_DESKTOP) {
193 features->device_type = BTN_TOOL_DOUBLETAP;
194 if (features->type == TABLETPC2FG) {
195 /* need to reset back */
196 features->pktlen = WACOM_PKGLEN_TPC2FG;
197 features->device_type = BTN_TOOL_TRIPLETAP;
200 get_unaligned_le16(&report[i + 3]);
202 get_unaligned_le16(&report[i + 6]);
203 features->unit = report[i + 9];
204 features->unitExpo = report[i + 11];
207 /* penabled only accepts exact bytes of data */
208 if (features->type == TABLETPC2FG)
209 features->pktlen = WACOM_PKGLEN_GRAPHIRE;
210 features->device_type = BTN_TOOL_PEN;
212 get_unaligned_le16(&report[i + 3]);
215 } else if (usage == WCM_DIGITIZER) {
216 /* max pressure isn't reported
217 features->pressure_max = (unsigned short)
218 (report[i+4] << 8 | report[i + 3]);
220 features->pressure_max = 255;
226 if (usage == WCM_DESKTOP) {
228 features->device_type = BTN_TOOL_DOUBLETAP;
229 if (features->type == TABLETPC2FG) {
230 /* need to reset back */
231 features->pktlen = WACOM_PKGLEN_TPC2FG;
232 features->device_type = BTN_TOOL_TRIPLETAP;
234 get_unaligned_le16(&report[i + 3]);
236 get_unaligned_le16(&report[i + 6]);
242 get_unaligned_le16(&report[i + 3]);
246 /* penabled only accepts exact bytes of data */
247 if (features->type == TABLETPC2FG)
248 features->pktlen = WACOM_PKGLEN_GRAPHIRE;
249 features->device_type = BTN_TOOL_PEN;
251 get_unaligned_le16(&report[i + 3]);
257 case HID_USAGE_FINGER:
262 case HID_USAGE_STYLUS:
267 case HID_USAGE_UNDEFINED:
268 if (usage == WCM_DESKTOP && finger) /* capacity */
269 features->pressure_max =
270 get_unaligned_le16(&report[i + 3]);
277 /* reset UsagePage and Finger */
289 static int wacom_query_tablet_data(struct usb_interface *intf, struct wacom_features *features)
291 unsigned char *rep_data;
292 int limit = 0, report_id = 2;
295 rep_data = kmalloc(2, GFP_KERNEL);
299 /* ask to report tablet data if it is 2FGT or not a Tablet PC */
300 if (features->device_type == BTN_TOOL_TRIPLETAP) {
305 error = usb_set_report(intf, WAC_HID_FEATURE_REPORT,
306 report_id, rep_data, 2);
308 error = usb_get_report(intf,
309 WAC_HID_FEATURE_REPORT, report_id,
311 } while ((error < 0 || rep_data[1] != 4) && limit++ < 5);
312 } else if (features->type != TABLETPC && features->type != TABLETPC2FG) {
316 error = usb_set_report(intf, WAC_HID_FEATURE_REPORT,
317 report_id, rep_data, 2);
319 error = usb_get_report(intf,
320 WAC_HID_FEATURE_REPORT, report_id,
322 } while ((error < 0 || rep_data[1] != 2) && limit++ < 5);
327 return error < 0 ? error : 0;
330 static int wacom_retrieve_hid_descriptor(struct usb_interface *intf,
331 struct wacom_features *features)
334 struct usb_host_interface *interface = intf->cur_altsetting;
335 struct hid_descriptor *hid_desc;
337 /* default device to penabled */
338 features->device_type = BTN_TOOL_PEN;
340 /* only Tablet PCs need to retrieve the info */
341 if ((features->type != TABLETPC) && (features->type != TABLETPC2FG))
344 if (usb_get_extra_descriptor(interface, HID_DEVICET_HID, &hid_desc)) {
345 if (usb_get_extra_descriptor(&interface->endpoint[0],
346 HID_DEVICET_REPORT, &hid_desc)) {
347 printk("wacom: can not retrieve extra class descriptor\n");
352 error = wacom_parse_hid(intf, hid_desc, features);
356 /* touch device found but size is not defined. use default */
357 if (features->device_type == BTN_TOOL_DOUBLETAP && !features->x_max) {
358 features->x_max = 1023;
359 features->y_max = 1023;
366 struct wacom_usbdev_data {
367 struct list_head list;
369 struct usb_device *dev;
370 struct wacom_shared shared;
373 static LIST_HEAD(wacom_udev_list);
374 static DEFINE_MUTEX(wacom_udev_list_lock);
376 static struct wacom_usbdev_data *wacom_get_usbdev_data(struct usb_device *dev)
378 struct wacom_usbdev_data *data;
380 list_for_each_entry(data, &wacom_udev_list, list) {
381 if (data->dev == dev) {
382 kref_get(&data->kref);
390 static int wacom_add_shared_data(struct wacom_wac *wacom,
391 struct usb_device *dev)
393 struct wacom_usbdev_data *data;
396 mutex_lock(&wacom_udev_list_lock);
398 data = wacom_get_usbdev_data(dev);
400 data = kzalloc(sizeof(struct wacom_usbdev_data), GFP_KERNEL);
406 kref_init(&data->kref);
408 list_add_tail(&data->list, &wacom_udev_list);
411 wacom->shared = &data->shared;
414 mutex_unlock(&wacom_udev_list_lock);
418 static void wacom_release_shared_data(struct kref *kref)
420 struct wacom_usbdev_data *data =
421 container_of(kref, struct wacom_usbdev_data, kref);
423 mutex_lock(&wacom_udev_list_lock);
424 list_del(&data->list);
425 mutex_unlock(&wacom_udev_list_lock);
430 static void wacom_remove_shared_data(struct wacom_wac *wacom)
432 struct wacom_usbdev_data *data;
435 data = container_of(wacom->shared, struct wacom_usbdev_data, shared);
436 kref_put(&data->kref, wacom_release_shared_data);
437 wacom->shared = NULL;
441 static int wacom_probe(struct usb_interface *intf, const struct usb_device_id *id)
443 struct usb_device *dev = interface_to_usbdev(intf);
444 struct usb_endpoint_descriptor *endpoint;
446 struct wacom_wac *wacom_wac;
447 struct wacom_features *features;
448 struct input_dev *input_dev;
451 if (!id->driver_info)
454 wacom = kzalloc(sizeof(struct wacom), GFP_KERNEL);
455 input_dev = input_allocate_device();
456 if (!wacom || !input_dev) {
461 wacom_wac = &wacom->wacom_wac;
462 wacom_wac->features = *((struct wacom_features *)id->driver_info);
463 features = &wacom_wac->features;
464 if (features->pktlen > WACOM_PKGLEN_MAX) {
469 wacom_wac->data = usb_alloc_coherent(dev, WACOM_PKGLEN_MAX,
470 GFP_KERNEL, &wacom->data_dma);
471 if (!wacom_wac->data) {
476 wacom->irq = usb_alloc_urb(0, GFP_KERNEL);
484 mutex_init(&wacom->lock);
485 usb_make_path(dev, wacom->phys, sizeof(wacom->phys));
486 strlcat(wacom->phys, "/input0", sizeof(wacom->phys));
488 wacom_wac->input = input_dev;
490 endpoint = &intf->cur_altsetting->endpoint[0].desc;
492 /* Retrieve the physical and logical size for OEM devices */
493 error = wacom_retrieve_hid_descriptor(intf, features);
497 strlcpy(wacom_wac->name, features->name, sizeof(wacom_wac->name));
499 if (features->type == TABLETPC || features->type == TABLETPC2FG) {
500 /* Append the device type to the name */
501 strlcat(wacom_wac->name,
502 features->device_type == BTN_TOOL_PEN ?
504 sizeof(wacom_wac->name));
506 error = wacom_add_shared_data(wacom_wac, dev);
511 input_dev->name = wacom_wac->name;
512 input_dev->dev.parent = &intf->dev;
513 input_dev->open = wacom_open;
514 input_dev->close = wacom_close;
515 usb_to_input_id(dev, &input_dev->id);
516 input_set_drvdata(input_dev, wacom);
518 wacom_setup_input_capabilities(input_dev, wacom_wac);
520 usb_fill_int_urb(wacom->irq, dev,
521 usb_rcvintpipe(dev, endpoint->bEndpointAddress),
522 wacom_wac->data, features->pktlen,
523 wacom_sys_irq, wacom, endpoint->bInterval);
524 wacom->irq->transfer_dma = wacom->data_dma;
525 wacom->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
527 error = input_register_device(input_dev);
531 /* Note that if query fails it is not a hard failure */
532 wacom_query_tablet_data(intf, features);
534 usb_set_intfdata(intf, wacom);
537 fail4: wacom_remove_shared_data(wacom_wac);
538 fail3: usb_free_urb(wacom->irq);
539 fail2: usb_free_coherent(dev, WACOM_PKGLEN_MAX, wacom_wac->data, wacom->data_dma);
540 fail1: input_free_device(input_dev);
545 static void wacom_disconnect(struct usb_interface *intf)
547 struct wacom *wacom = usb_get_intfdata(intf);
549 usb_set_intfdata(intf, NULL);
551 usb_kill_urb(wacom->irq);
552 input_unregister_device(wacom->wacom_wac.input);
553 usb_free_urb(wacom->irq);
554 usb_free_coherent(interface_to_usbdev(intf), WACOM_PKGLEN_MAX,
555 wacom->wacom_wac.data, wacom->data_dma);
556 wacom_remove_shared_data(&wacom->wacom_wac);
560 static int wacom_suspend(struct usb_interface *intf, pm_message_t message)
562 struct wacom *wacom = usb_get_intfdata(intf);
564 mutex_lock(&wacom->lock);
565 usb_kill_urb(wacom->irq);
566 mutex_unlock(&wacom->lock);
571 static int wacom_resume(struct usb_interface *intf)
573 struct wacom *wacom = usb_get_intfdata(intf);
574 struct wacom_features *features = &wacom->wacom_wac.features;
577 mutex_lock(&wacom->lock);
579 /* switch to wacom mode first */
580 wacom_query_tablet_data(intf, features);
583 rv = usb_submit_urb(wacom->irq, GFP_NOIO);
587 mutex_unlock(&wacom->lock);
592 static int wacom_reset_resume(struct usb_interface *intf)
594 return wacom_resume(intf);
597 static struct usb_driver wacom_driver = {
599 .id_table = wacom_ids,
600 .probe = wacom_probe,
601 .disconnect = wacom_disconnect,
602 .suspend = wacom_suspend,
603 .resume = wacom_resume,
604 .reset_resume = wacom_reset_resume,
605 .supports_autosuspend = 1,
608 static int __init wacom_init(void)
612 result = usb_register(&wacom_driver);
614 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
619 static void __exit wacom_exit(void)
621 usb_deregister(&wacom_driver);
624 module_init(wacom_init);
625 module_exit(wacom_exit);