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);
107 mutex_lock(&wacom->lock);
109 wacom->irq->dev = wacom->usbdev;
111 if (usb_autopm_get_interface(wacom->intf) < 0) {
112 mutex_unlock(&wacom->lock);
116 if (usb_submit_urb(wacom->irq, GFP_KERNEL)) {
117 usb_autopm_put_interface(wacom->intf);
118 mutex_unlock(&wacom->lock);
123 wacom->intf->needs_remote_wakeup = 1;
125 mutex_unlock(&wacom->lock);
129 static void wacom_close(struct input_dev *dev)
131 struct wacom *wacom = input_get_drvdata(dev);
133 mutex_lock(&wacom->lock);
134 usb_kill_urb(wacom->irq);
136 wacom->intf->needs_remote_wakeup = 0;
137 mutex_unlock(&wacom->lock);
140 static int wacom_parse_hid(struct usb_interface *intf, struct hid_descriptor *hid_desc,
141 struct wacom_features *features)
143 struct usb_device *dev = interface_to_usbdev(intf);
145 /* result has to be defined as int for some devices */
147 int i = 0, usage = WCM_UNDEFINED, finger = 0, pen = 0;
148 unsigned char *report;
150 report = kzalloc(hid_desc->wDescriptorLength, GFP_KERNEL);
154 /* retrive report descriptors */
156 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
157 USB_REQ_GET_DESCRIPTOR,
158 USB_RECIP_INTERFACE | USB_DIR_IN,
159 HID_DEVICET_REPORT << 8,
160 intf->altsetting[0].desc.bInterfaceNumber, /* interface */
162 hid_desc->wDescriptorLength,
164 } while (result < 0 && limit++ < 5);
166 /* No need to parse the Descriptor. It isn't an error though */
170 for (i = 0; i < hid_desc->wDescriptorLength; i++) {
174 switch (report[i + 1]) {
175 case HID_USAGE_PAGE_DIGITIZER:
176 usage = WCM_DIGITIZER;
180 case HID_USAGE_PAGE_DESKTOP:
188 switch (report[i + 1]) {
190 if (usage == WCM_DESKTOP) {
192 features->device_type = BTN_TOOL_DOUBLETAP;
193 if (features->type == TABLETPC2FG) {
194 /* need to reset back */
195 features->pktlen = WACOM_PKGLEN_TPC2FG;
196 features->device_type = BTN_TOOL_TRIPLETAP;
198 if (features->type == BAMBOO_PT) {
199 /* need to reset back */
200 features->pktlen = WACOM_PKGLEN_BBTOUCH;
201 features->device_type = BTN_TOOL_TRIPLETAP;
203 get_unaligned_le16(&report[i + 5]);
205 get_unaligned_le16(&report[i + 8]);
209 get_unaligned_le16(&report[i + 3]);
211 get_unaligned_le16(&report[i + 6]);
212 features->unit = report[i + 9];
213 features->unitExpo = report[i + 11];
217 /* penabled only accepts exact bytes of data */
218 if (features->type == TABLETPC2FG)
219 features->pktlen = WACOM_PKGLEN_GRAPHIRE;
220 if (features->type == BAMBOO_PT)
221 features->pktlen = WACOM_PKGLEN_BBFUN;
222 features->device_type = BTN_TOOL_PEN;
224 get_unaligned_le16(&report[i + 3]);
227 } else if (usage == WCM_DIGITIZER) {
228 /* max pressure isn't reported
229 features->pressure_max = (unsigned short)
230 (report[i+4] << 8 | report[i + 3]);
232 features->pressure_max = 255;
238 if (usage == WCM_DESKTOP) {
240 features->device_type = BTN_TOOL_DOUBLETAP;
241 if (features->type == TABLETPC2FG) {
242 /* need to reset back */
243 features->pktlen = WACOM_PKGLEN_TPC2FG;
244 features->device_type = BTN_TOOL_TRIPLETAP;
246 get_unaligned_le16(&report[i + 3]);
248 get_unaligned_le16(&report[i + 6]);
250 } else if (features->type == BAMBOO_PT) {
251 /* need to reset back */
252 features->pktlen = WACOM_PKGLEN_BBTOUCH;
253 features->device_type = BTN_TOOL_TRIPLETAP;
255 get_unaligned_le16(&report[i + 3]);
257 get_unaligned_le16(&report[i + 6]);
263 get_unaligned_le16(&report[i + 3]);
267 /* penabled only accepts exact bytes of data */
268 if (features->type == TABLETPC2FG)
269 features->pktlen = WACOM_PKGLEN_GRAPHIRE;
270 if (features->type == BAMBOO_PT)
271 features->pktlen = WACOM_PKGLEN_BBFUN;
272 features->device_type = BTN_TOOL_PEN;
274 get_unaligned_le16(&report[i + 3]);
280 case HID_USAGE_FINGER:
285 case HID_USAGE_STYLUS:
290 case HID_USAGE_UNDEFINED:
291 if (usage == WCM_DESKTOP && finger) /* capacity */
292 features->pressure_max =
293 get_unaligned_le16(&report[i + 3]);
300 /* reset UsagePage and Finger */
312 static int wacom_query_tablet_data(struct usb_interface *intf, struct wacom_features *features)
314 unsigned char *rep_data;
315 int limit = 0, report_id = 2;
318 rep_data = kmalloc(2, GFP_KERNEL);
322 /* ask to report tablet data if it is 2FGT or not a Tablet PC */
323 if (features->device_type == BTN_TOOL_TRIPLETAP) {
328 error = usb_set_report(intf, WAC_HID_FEATURE_REPORT,
329 report_id, rep_data, 2);
331 error = usb_get_report(intf,
332 WAC_HID_FEATURE_REPORT, report_id,
334 } while ((error < 0 || rep_data[1] != 4) && limit++ < 5);
335 } else if (features->type != TABLETPC && features->type != TABLETPC2FG) {
339 error = usb_set_report(intf, WAC_HID_FEATURE_REPORT,
340 report_id, rep_data, 2);
342 error = usb_get_report(intf,
343 WAC_HID_FEATURE_REPORT, report_id,
345 } while ((error < 0 || rep_data[1] != 2) && limit++ < 5);
350 return error < 0 ? error : 0;
353 static int wacom_retrieve_hid_descriptor(struct usb_interface *intf,
354 struct wacom_features *features)
357 struct usb_host_interface *interface = intf->cur_altsetting;
358 struct hid_descriptor *hid_desc;
360 /* default features */
361 features->device_type = BTN_TOOL_PEN;
362 features->x_fuzz = 4;
363 features->y_fuzz = 4;
364 features->pressure_fuzz = 0;
365 features->distance_fuzz = 0;
367 /* only Tablet PCs need to retrieve the info */
368 if ((features->type != TABLETPC) && (features->type != TABLETPC2FG) &&
369 (features->type != BAMBOO_PT))
372 if (usb_get_extra_descriptor(interface, HID_DEVICET_HID, &hid_desc)) {
373 if (usb_get_extra_descriptor(&interface->endpoint[0],
374 HID_DEVICET_REPORT, &hid_desc)) {
375 printk("wacom: can not retrieve extra class descriptor\n");
380 error = wacom_parse_hid(intf, hid_desc, features);
384 /* touch device found but size is not defined. use default */
385 if (features->device_type == BTN_TOOL_DOUBLETAP && !features->x_max) {
386 features->x_max = 1023;
387 features->y_max = 1023;
394 struct wacom_usbdev_data {
395 struct list_head list;
397 struct usb_device *dev;
398 struct wacom_shared shared;
401 static LIST_HEAD(wacom_udev_list);
402 static DEFINE_MUTEX(wacom_udev_list_lock);
404 static struct wacom_usbdev_data *wacom_get_usbdev_data(struct usb_device *dev)
406 struct wacom_usbdev_data *data;
408 list_for_each_entry(data, &wacom_udev_list, list) {
409 if (data->dev == dev) {
410 kref_get(&data->kref);
418 static int wacom_add_shared_data(struct wacom_wac *wacom,
419 struct usb_device *dev)
421 struct wacom_usbdev_data *data;
424 mutex_lock(&wacom_udev_list_lock);
426 data = wacom_get_usbdev_data(dev);
428 data = kzalloc(sizeof(struct wacom_usbdev_data), GFP_KERNEL);
434 kref_init(&data->kref);
436 list_add_tail(&data->list, &wacom_udev_list);
439 wacom->shared = &data->shared;
442 mutex_unlock(&wacom_udev_list_lock);
446 static void wacom_release_shared_data(struct kref *kref)
448 struct wacom_usbdev_data *data =
449 container_of(kref, struct wacom_usbdev_data, kref);
451 mutex_lock(&wacom_udev_list_lock);
452 list_del(&data->list);
453 mutex_unlock(&wacom_udev_list_lock);
458 static void wacom_remove_shared_data(struct wacom_wac *wacom)
460 struct wacom_usbdev_data *data;
463 data = container_of(wacom->shared, struct wacom_usbdev_data, shared);
464 kref_put(&data->kref, wacom_release_shared_data);
465 wacom->shared = NULL;
469 static int wacom_probe(struct usb_interface *intf, const struct usb_device_id *id)
471 struct usb_device *dev = interface_to_usbdev(intf);
472 struct usb_endpoint_descriptor *endpoint;
474 struct wacom_wac *wacom_wac;
475 struct wacom_features *features;
476 struct input_dev *input_dev;
479 if (!id->driver_info)
482 wacom = kzalloc(sizeof(struct wacom), GFP_KERNEL);
483 input_dev = input_allocate_device();
484 if (!wacom || !input_dev) {
489 wacom_wac = &wacom->wacom_wac;
490 wacom_wac->features = *((struct wacom_features *)id->driver_info);
491 features = &wacom_wac->features;
492 if (features->pktlen > WACOM_PKGLEN_MAX) {
497 wacom_wac->data = usb_alloc_coherent(dev, WACOM_PKGLEN_MAX,
498 GFP_KERNEL, &wacom->data_dma);
499 if (!wacom_wac->data) {
504 wacom->irq = usb_alloc_urb(0, GFP_KERNEL);
512 mutex_init(&wacom->lock);
513 usb_make_path(dev, wacom->phys, sizeof(wacom->phys));
514 strlcat(wacom->phys, "/input0", sizeof(wacom->phys));
516 wacom_wac->input = input_dev;
518 endpoint = &intf->cur_altsetting->endpoint[0].desc;
520 /* Retrieve the physical and logical size for OEM devices */
521 error = wacom_retrieve_hid_descriptor(intf, features);
525 strlcpy(wacom_wac->name, features->name, sizeof(wacom_wac->name));
527 if (features->type == TABLETPC || features->type == TABLETPC2FG ||
528 features->type == BAMBOO_PT) {
529 /* Append the device type to the name */
530 strlcat(wacom_wac->name,
531 features->device_type == BTN_TOOL_PEN ?
533 sizeof(wacom_wac->name));
535 error = wacom_add_shared_data(wacom_wac, dev);
540 input_dev->name = wacom_wac->name;
541 input_dev->dev.parent = &intf->dev;
542 input_dev->open = wacom_open;
543 input_dev->close = wacom_close;
544 usb_to_input_id(dev, &input_dev->id);
545 input_set_drvdata(input_dev, wacom);
547 wacom_setup_input_capabilities(input_dev, wacom_wac);
549 usb_fill_int_urb(wacom->irq, dev,
550 usb_rcvintpipe(dev, endpoint->bEndpointAddress),
551 wacom_wac->data, features->pktlen,
552 wacom_sys_irq, wacom, endpoint->bInterval);
553 wacom->irq->transfer_dma = wacom->data_dma;
554 wacom->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
556 error = input_register_device(input_dev);
560 /* Note that if query fails it is not a hard failure */
561 wacom_query_tablet_data(intf, features);
563 usb_set_intfdata(intf, wacom);
566 fail4: wacom_remove_shared_data(wacom_wac);
567 fail3: usb_free_urb(wacom->irq);
568 fail2: usb_free_coherent(dev, WACOM_PKGLEN_MAX, wacom_wac->data, wacom->data_dma);
569 fail1: input_free_device(input_dev);
574 static void wacom_disconnect(struct usb_interface *intf)
576 struct wacom *wacom = usb_get_intfdata(intf);
578 usb_set_intfdata(intf, NULL);
580 usb_kill_urb(wacom->irq);
581 input_unregister_device(wacom->wacom_wac.input);
582 usb_free_urb(wacom->irq);
583 usb_free_coherent(interface_to_usbdev(intf), WACOM_PKGLEN_MAX,
584 wacom->wacom_wac.data, wacom->data_dma);
585 wacom_remove_shared_data(&wacom->wacom_wac);
589 static int wacom_suspend(struct usb_interface *intf, pm_message_t message)
591 struct wacom *wacom = usb_get_intfdata(intf);
593 mutex_lock(&wacom->lock);
594 usb_kill_urb(wacom->irq);
595 mutex_unlock(&wacom->lock);
600 static int wacom_resume(struct usb_interface *intf)
602 struct wacom *wacom = usb_get_intfdata(intf);
603 struct wacom_features *features = &wacom->wacom_wac.features;
606 mutex_lock(&wacom->lock);
608 /* switch to wacom mode first */
609 wacom_query_tablet_data(intf, features);
612 rv = usb_submit_urb(wacom->irq, GFP_NOIO);
616 mutex_unlock(&wacom->lock);
621 static int wacom_reset_resume(struct usb_interface *intf)
623 return wacom_resume(intf);
626 static struct usb_driver wacom_driver = {
628 .id_table = wacom_ids,
629 .probe = wacom_probe,
630 .disconnect = wacom_disconnect,
631 .suspend = wacom_suspend,
632 .resume = wacom_resume,
633 .reset_resume = wacom_reset_resume,
634 .supports_autosuspend = 1,
637 static int __init wacom_init(void)
641 result = usb_register(&wacom_driver);
643 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
648 static void __exit wacom_exit(void)
650 usb_deregister(&wacom_driver);
653 module_init(wacom_init);
654 module_exit(wacom_exit);