Merge branch 'core-urgent-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[linux/fpc-iii.git] / drivers / input / tablet / wacom_sys.c
blobb16ebef5b9111c7a999845300e1c33070f2a31b4
1 /*
2 * drivers/input/tablet/wacom_sys.c
4 * USB Wacom tablet support - system specific code
5 */
7 /*
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"
15 #include "wacom.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_USAGE_CONTACTMAX 0x55
32 #define HID_COLLECTION 0xa1
33 #define HID_COLLECTION_LOGICAL 0x02
34 #define HID_COLLECTION_END 0xc0
36 enum {
37 WCM_UNDEFINED = 0,
38 WCM_DESKTOP,
39 WCM_DIGITIZER,
42 struct hid_descriptor {
43 struct usb_descriptor_header header;
44 __le16 bcdHID;
45 u8 bCountryCode;
46 u8 bNumDescriptors;
47 u8 bDescriptorType;
48 __le16 wDescriptorLength;
49 } __attribute__ ((packed));
51 /* defines to get/set USB message */
52 #define USB_REQ_GET_REPORT 0x01
53 #define USB_REQ_SET_REPORT 0x09
55 #define WAC_HID_FEATURE_REPORT 0x03
56 #define WAC_MSG_RETRIES 5
58 #define WAC_CMD_LED_CONTROL 0x20
59 #define WAC_CMD_ICON_START 0x21
60 #define WAC_CMD_ICON_XFER 0x23
61 #define WAC_CMD_RETRIES 10
63 static int wacom_get_report(struct usb_interface *intf, u8 type, u8 id,
64 void *buf, size_t size, unsigned int retries)
66 struct usb_device *dev = interface_to_usbdev(intf);
67 int retval;
69 do {
70 retval = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
71 USB_REQ_GET_REPORT,
72 USB_DIR_IN | USB_TYPE_CLASS |
73 USB_RECIP_INTERFACE,
74 (type << 8) + id,
75 intf->altsetting[0].desc.bInterfaceNumber,
76 buf, size, 100);
77 } while ((retval == -ETIMEDOUT || retval == -EPIPE) && --retries);
79 return retval;
82 static int wacom_set_report(struct usb_interface *intf, u8 type, u8 id,
83 void *buf, size_t size, unsigned int retries)
85 struct usb_device *dev = interface_to_usbdev(intf);
86 int retval;
88 do {
89 retval = usb_control_msg(dev, usb_sndctrlpipe(dev, 0),
90 USB_REQ_SET_REPORT,
91 USB_TYPE_CLASS | USB_RECIP_INTERFACE,
92 (type << 8) + id,
93 intf->altsetting[0].desc.bInterfaceNumber,
94 buf, size, 1000);
95 } while ((retval == -ETIMEDOUT || retval == -EPIPE) && --retries);
97 return retval;
100 static void wacom_sys_irq(struct urb *urb)
102 struct wacom *wacom = urb->context;
103 struct device *dev = &wacom->intf->dev;
104 int retval;
106 switch (urb->status) {
107 case 0:
108 /* success */
109 break;
110 case -ECONNRESET:
111 case -ENOENT:
112 case -ESHUTDOWN:
113 /* this urb is terminated, clean up */
114 dev_dbg(dev, "%s - urb shutting down with status: %d\n",
115 __func__, urb->status);
116 return;
117 default:
118 dev_dbg(dev, "%s - nonzero urb status received: %d\n",
119 __func__, urb->status);
120 goto exit;
123 wacom_wac_irq(&wacom->wacom_wac, urb->actual_length);
125 exit:
126 usb_mark_last_busy(wacom->usbdev);
127 retval = usb_submit_urb(urb, GFP_ATOMIC);
128 if (retval)
129 dev_err(dev, "%s - usb_submit_urb failed with result %d\n",
130 __func__, retval);
133 static int wacom_open(struct input_dev *dev)
135 struct wacom *wacom = input_get_drvdata(dev);
136 int retval = 0;
138 if (usb_autopm_get_interface(wacom->intf) < 0)
139 return -EIO;
141 mutex_lock(&wacom->lock);
143 if (usb_submit_urb(wacom->irq, GFP_KERNEL)) {
144 retval = -EIO;
145 goto out;
148 wacom->open = true;
149 wacom->intf->needs_remote_wakeup = 1;
151 out:
152 mutex_unlock(&wacom->lock);
153 usb_autopm_put_interface(wacom->intf);
154 return retval;
157 static void wacom_close(struct input_dev *dev)
159 struct wacom *wacom = input_get_drvdata(dev);
160 int autopm_error;
162 autopm_error = usb_autopm_get_interface(wacom->intf);
164 mutex_lock(&wacom->lock);
165 usb_kill_urb(wacom->irq);
166 wacom->open = false;
167 wacom->intf->needs_remote_wakeup = 0;
168 mutex_unlock(&wacom->lock);
170 if (!autopm_error)
171 usb_autopm_put_interface(wacom->intf);
175 * Calculate the resolution of the X or Y axis, given appropriate HID data.
176 * This function is little more than hidinput_calc_abs_res stripped down.
178 static int wacom_calc_hid_res(int logical_extents, int physical_extents,
179 unsigned char unit, unsigned char exponent)
181 int prev, unit_exponent;
183 /* Check if the extents are sane */
184 if (logical_extents <= 0 || physical_extents <= 0)
185 return 0;
187 /* Get signed value of nybble-sized twos-compliment exponent */
188 unit_exponent = exponent;
189 if (unit_exponent > 7)
190 unit_exponent -= 16;
192 /* Convert physical_extents to millimeters */
193 if (unit == 0x11) { /* If centimeters */
194 unit_exponent += 1;
195 } else if (unit == 0x13) { /* If inches */
196 prev = physical_extents;
197 physical_extents *= 254;
198 if (physical_extents < prev)
199 return 0;
200 unit_exponent -= 1;
201 } else {
202 return 0;
205 /* Apply negative unit exponent */
206 for (; unit_exponent < 0; unit_exponent++) {
207 prev = logical_extents;
208 logical_extents *= 10;
209 if (logical_extents < prev)
210 return 0;
212 /* Apply positive unit exponent */
213 for (; unit_exponent > 0; unit_exponent--) {
214 prev = physical_extents;
215 physical_extents *= 10;
216 if (physical_extents < prev)
217 return 0;
220 /* Calculate resolution */
221 return logical_extents / physical_extents;
224 static int wacom_parse_logical_collection(unsigned char *report,
225 struct wacom_features *features)
227 int length = 0;
229 if (features->type == BAMBOO_PT) {
231 /* Logical collection is only used by 3rd gen Bamboo Touch */
232 features->pktlen = WACOM_PKGLEN_BBTOUCH3;
233 features->device_type = BTN_TOOL_FINGER;
235 features->x_max = features->y_max =
236 get_unaligned_le16(&report[10]);
238 length = 11;
240 return length;
243 static void wacom_retrieve_report_data(struct usb_interface *intf,
244 struct wacom_features *features)
246 int result = 0;
247 unsigned char *rep_data;
249 rep_data = kmalloc(2, GFP_KERNEL);
250 if (rep_data) {
252 rep_data[0] = 12;
253 result = wacom_get_report(intf, WAC_HID_FEATURE_REPORT,
254 rep_data[0], rep_data, 2,
255 WAC_MSG_RETRIES);
257 if (result >= 0 && rep_data[1] > 2)
258 features->touch_max = rep_data[1];
260 kfree(rep_data);
265 * Interface Descriptor of wacom devices can be incomplete and
266 * inconsistent so wacom_features table is used to store stylus
267 * device's packet lengths, various maximum values, and tablet
268 * resolution based on product ID's.
270 * For devices that contain 2 interfaces, wacom_features table is
271 * inaccurate for the touch interface. Since the Interface Descriptor
272 * for touch interfaces has pretty complete data, this function exists
273 * to query tablet for this missing information instead of hard coding in
274 * an additional table.
276 * A typical Interface Descriptor for a stylus will contain a
277 * boot mouse application collection that is not of interest and this
278 * function will ignore it.
280 * It also contains a digitizer application collection that also is not
281 * of interest since any information it contains would be duplicate
282 * of what is in wacom_features. Usually it defines a report of an array
283 * of bytes that could be used as max length of the stylus packet returned.
284 * If it happens to define a Digitizer-Stylus Physical Collection then
285 * the X and Y logical values contain valid data but it is ignored.
287 * A typical Interface Descriptor for a touch interface will contain a
288 * Digitizer-Finger Physical Collection which will define both logical
289 * X/Y maximum as well as the physical size of tablet. Since touch
290 * interfaces haven't supported pressure or distance, this is enough
291 * information to override invalid values in the wacom_features table.
293 * 3rd gen Bamboo Touch no longer define a Digitizer-Finger Pysical
294 * Collection. Instead they define a Logical Collection with a single
295 * Logical Maximum for both X and Y.
297 * Intuos5 touch interface does not contain useful data. We deal with
298 * this after returning from this function.
300 static int wacom_parse_hid(struct usb_interface *intf,
301 struct hid_descriptor *hid_desc,
302 struct wacom_features *features)
304 struct usb_device *dev = interface_to_usbdev(intf);
305 char limit = 0;
306 /* result has to be defined as int for some devices */
307 int result = 0, touch_max = 0;
308 int i = 0, usage = WCM_UNDEFINED, finger = 0, pen = 0;
309 unsigned char *report;
311 report = kzalloc(hid_desc->wDescriptorLength, GFP_KERNEL);
312 if (!report)
313 return -ENOMEM;
315 /* retrive report descriptors */
316 do {
317 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
318 USB_REQ_GET_DESCRIPTOR,
319 USB_RECIP_INTERFACE | USB_DIR_IN,
320 HID_DEVICET_REPORT << 8,
321 intf->altsetting[0].desc.bInterfaceNumber, /* interface */
322 report,
323 hid_desc->wDescriptorLength,
324 5000); /* 5 secs */
325 } while (result < 0 && limit++ < WAC_MSG_RETRIES);
327 /* No need to parse the Descriptor. It isn't an error though */
328 if (result < 0)
329 goto out;
331 for (i = 0; i < hid_desc->wDescriptorLength; i++) {
333 switch (report[i]) {
334 case HID_USAGE_PAGE:
335 switch (report[i + 1]) {
336 case HID_USAGE_PAGE_DIGITIZER:
337 usage = WCM_DIGITIZER;
338 i++;
339 break;
341 case HID_USAGE_PAGE_DESKTOP:
342 usage = WCM_DESKTOP;
343 i++;
344 break;
346 break;
348 case HID_USAGE:
349 switch (report[i + 1]) {
350 case HID_USAGE_X:
351 if (usage == WCM_DESKTOP) {
352 if (finger) {
353 features->device_type = BTN_TOOL_FINGER;
354 /* touch device at least supports one touch point */
355 touch_max = 1;
356 switch (features->type) {
357 case TABLETPC2FG:
358 features->pktlen = WACOM_PKGLEN_TPC2FG;
359 break;
361 case MTSCREEN:
362 case WACOM_24HDT:
363 features->pktlen = WACOM_PKGLEN_MTOUCH;
364 break;
366 case MTTPC:
367 features->pktlen = WACOM_PKGLEN_MTTPC;
368 break;
370 case BAMBOO_PT:
371 features->pktlen = WACOM_PKGLEN_BBTOUCH;
372 break;
374 default:
375 features->pktlen = WACOM_PKGLEN_GRAPHIRE;
376 break;
379 switch (features->type) {
380 case BAMBOO_PT:
381 features->x_phy =
382 get_unaligned_le16(&report[i + 5]);
383 features->x_max =
384 get_unaligned_le16(&report[i + 8]);
385 i += 15;
386 break;
388 case WACOM_24HDT:
389 features->x_max =
390 get_unaligned_le16(&report[i + 3]);
391 features->x_phy =
392 get_unaligned_le16(&report[i + 8]);
393 features->unit = report[i - 1];
394 features->unitExpo = report[i - 3];
395 i += 12;
396 break;
398 default:
399 features->x_max =
400 get_unaligned_le16(&report[i + 3]);
401 features->x_phy =
402 get_unaligned_le16(&report[i + 6]);
403 features->unit = report[i + 9];
404 features->unitExpo = report[i + 11];
405 i += 12;
406 break;
408 } else if (pen) {
409 /* penabled only accepts exact bytes of data */
410 if (features->type >= TABLETPC)
411 features->pktlen = WACOM_PKGLEN_GRAPHIRE;
412 features->device_type = BTN_TOOL_PEN;
413 features->x_max =
414 get_unaligned_le16(&report[i + 3]);
415 i += 4;
418 break;
420 case HID_USAGE_Y:
421 if (usage == WCM_DESKTOP) {
422 if (finger) {
423 switch (features->type) {
424 case TABLETPC2FG:
425 case MTSCREEN:
426 case MTTPC:
427 features->y_max =
428 get_unaligned_le16(&report[i + 3]);
429 features->y_phy =
430 get_unaligned_le16(&report[i + 6]);
431 i += 7;
432 break;
434 case WACOM_24HDT:
435 features->y_max =
436 get_unaligned_le16(&report[i + 3]);
437 features->y_phy =
438 get_unaligned_le16(&report[i - 2]);
439 i += 7;
440 break;
442 case BAMBOO_PT:
443 features->y_phy =
444 get_unaligned_le16(&report[i + 3]);
445 features->y_max =
446 get_unaligned_le16(&report[i + 6]);
447 i += 12;
448 break;
450 default:
451 features->y_max =
452 features->x_max;
453 features->y_phy =
454 get_unaligned_le16(&report[i + 3]);
455 i += 4;
456 break;
458 } else if (pen) {
459 features->y_max =
460 get_unaligned_le16(&report[i + 3]);
461 i += 4;
464 break;
466 case HID_USAGE_FINGER:
467 finger = 1;
468 i++;
469 break;
472 * Requiring Stylus Usage will ignore boot mouse
473 * X/Y values and some cases of invalid Digitizer X/Y
474 * values commonly reported.
476 case HID_USAGE_STYLUS:
477 pen = 1;
478 i++;
479 break;
481 case HID_USAGE_CONTACTMAX:
482 /* leave touch_max as is if predefined */
483 if (!features->touch_max)
484 wacom_retrieve_report_data(intf, features);
485 i++;
486 break;
488 break;
490 case HID_COLLECTION_END:
491 /* reset UsagePage and Finger */
492 finger = usage = 0;
493 break;
495 case HID_COLLECTION:
496 i++;
497 switch (report[i]) {
498 case HID_COLLECTION_LOGICAL:
499 i += wacom_parse_logical_collection(&report[i],
500 features);
501 break;
503 break;
507 out:
508 if (!features->touch_max && touch_max)
509 features->touch_max = touch_max;
510 result = 0;
511 kfree(report);
512 return result;
515 static int wacom_set_device_mode(struct usb_interface *intf, int report_id, int length, int mode)
517 unsigned char *rep_data;
518 int error = -ENOMEM, limit = 0;
520 rep_data = kzalloc(length, GFP_KERNEL);
521 if (!rep_data)
522 return error;
524 do {
525 rep_data[0] = report_id;
526 rep_data[1] = mode;
528 error = wacom_set_report(intf, WAC_HID_FEATURE_REPORT,
529 report_id, rep_data, length, 1);
530 } while ((error < 0 || rep_data[1] != mode) && limit++ < WAC_MSG_RETRIES);
532 kfree(rep_data);
534 return error < 0 ? error : 0;
538 * Switch the tablet into its most-capable mode. Wacom tablets are
539 * typically configured to power-up in a mode which sends mouse-like
540 * reports to the OS. To get absolute position, pressure data, etc.
541 * from the tablet, it is necessary to switch the tablet out of this
542 * mode and into one which sends the full range of tablet data.
544 static int wacom_query_tablet_data(struct usb_interface *intf, struct wacom_features *features)
546 if (features->device_type == BTN_TOOL_FINGER) {
547 if (features->type > TABLETPC) {
548 /* MT Tablet PC touch */
549 return wacom_set_device_mode(intf, 3, 4, 4);
551 else if (features->type == WACOM_24HDT || features->type == CINTIQ_HYBRID) {
552 return wacom_set_device_mode(intf, 18, 3, 2);
554 } else if (features->device_type == BTN_TOOL_PEN) {
555 if (features->type <= BAMBOO_PT && features->type != WIRELESS) {
556 return wacom_set_device_mode(intf, 2, 2, 2);
560 return 0;
563 static int wacom_retrieve_hid_descriptor(struct usb_interface *intf,
564 struct wacom_features *features)
566 int error = 0;
567 struct usb_host_interface *interface = intf->cur_altsetting;
568 struct hid_descriptor *hid_desc;
570 /* default features */
571 features->device_type = BTN_TOOL_PEN;
572 features->x_fuzz = 4;
573 features->y_fuzz = 4;
574 features->pressure_fuzz = 0;
575 features->distance_fuzz = 0;
578 * The wireless device HID is basic and layout conflicts with
579 * other tablets (monitor and touch interface can look like pen).
580 * Skip the query for this type and modify defaults based on
581 * interface number.
583 if (features->type == WIRELESS) {
584 if (intf->cur_altsetting->desc.bInterfaceNumber == 0) {
585 features->device_type = 0;
586 } else if (intf->cur_altsetting->desc.bInterfaceNumber == 2) {
587 features->device_type = BTN_TOOL_FINGER;
588 features->pktlen = WACOM_PKGLEN_BBTOUCH3;
592 /* only devices that support touch need to retrieve the info */
593 if (features->type < BAMBOO_PT) {
594 goto out;
597 error = usb_get_extra_descriptor(interface, HID_DEVICET_HID, &hid_desc);
598 if (error) {
599 error = usb_get_extra_descriptor(&interface->endpoint[0],
600 HID_DEVICET_REPORT, &hid_desc);
601 if (error) {
602 dev_err(&intf->dev,
603 "can not retrieve extra class descriptor\n");
604 goto out;
607 error = wacom_parse_hid(intf, hid_desc, features);
609 out:
610 return error;
613 struct wacom_usbdev_data {
614 struct list_head list;
615 struct kref kref;
616 struct usb_device *dev;
617 struct wacom_shared shared;
620 static LIST_HEAD(wacom_udev_list);
621 static DEFINE_MUTEX(wacom_udev_list_lock);
623 static struct usb_device *wacom_get_sibling(struct usb_device *dev, int vendor, int product)
625 int port1;
626 struct usb_device *sibling;
628 if (vendor == 0 && product == 0)
629 return dev;
631 if (dev->parent == NULL)
632 return NULL;
634 usb_hub_for_each_child(dev->parent, port1, sibling) {
635 struct usb_device_descriptor *d;
636 if (sibling == NULL)
637 continue;
639 d = &sibling->descriptor;
640 if (d->idVendor == vendor && d->idProduct == product)
641 return sibling;
644 return NULL;
647 static struct wacom_usbdev_data *wacom_get_usbdev_data(struct usb_device *dev)
649 struct wacom_usbdev_data *data;
651 list_for_each_entry(data, &wacom_udev_list, list) {
652 if (data->dev == dev) {
653 kref_get(&data->kref);
654 return data;
658 return NULL;
661 static int wacom_add_shared_data(struct wacom_wac *wacom,
662 struct usb_device *dev)
664 struct wacom_usbdev_data *data;
665 int retval = 0;
667 mutex_lock(&wacom_udev_list_lock);
669 data = wacom_get_usbdev_data(dev);
670 if (!data) {
671 data = kzalloc(sizeof(struct wacom_usbdev_data), GFP_KERNEL);
672 if (!data) {
673 retval = -ENOMEM;
674 goto out;
677 kref_init(&data->kref);
678 data->dev = dev;
679 list_add_tail(&data->list, &wacom_udev_list);
682 wacom->shared = &data->shared;
684 out:
685 mutex_unlock(&wacom_udev_list_lock);
686 return retval;
689 static void wacom_release_shared_data(struct kref *kref)
691 struct wacom_usbdev_data *data =
692 container_of(kref, struct wacom_usbdev_data, kref);
694 mutex_lock(&wacom_udev_list_lock);
695 list_del(&data->list);
696 mutex_unlock(&wacom_udev_list_lock);
698 kfree(data);
701 static void wacom_remove_shared_data(struct wacom_wac *wacom)
703 struct wacom_usbdev_data *data;
705 if (wacom->shared) {
706 data = container_of(wacom->shared, struct wacom_usbdev_data, shared);
707 kref_put(&data->kref, wacom_release_shared_data);
708 wacom->shared = NULL;
712 static int wacom_led_control(struct wacom *wacom)
714 unsigned char *buf;
715 int retval;
717 buf = kzalloc(9, GFP_KERNEL);
718 if (!buf)
719 return -ENOMEM;
721 if (wacom->wacom_wac.features.type >= INTUOS5S &&
722 wacom->wacom_wac.features.type <= INTUOSPL) {
724 * Touch Ring and crop mark LED luminance may take on
725 * one of four values:
726 * 0 = Low; 1 = Medium; 2 = High; 3 = Off
728 int ring_led = wacom->led.select[0] & 0x03;
729 int ring_lum = (((wacom->led.llv & 0x60) >> 5) - 1) & 0x03;
730 int crop_lum = 0;
732 buf[0] = WAC_CMD_LED_CONTROL;
733 buf[1] = (crop_lum << 4) | (ring_lum << 2) | (ring_led);
735 else {
736 int led = wacom->led.select[0] | 0x4;
738 if (wacom->wacom_wac.features.type == WACOM_21UX2 ||
739 wacom->wacom_wac.features.type == WACOM_24HD)
740 led |= (wacom->led.select[1] << 4) | 0x40;
742 buf[0] = WAC_CMD_LED_CONTROL;
743 buf[1] = led;
744 buf[2] = wacom->led.llv;
745 buf[3] = wacom->led.hlv;
746 buf[4] = wacom->led.img_lum;
749 retval = wacom_set_report(wacom->intf, 0x03, WAC_CMD_LED_CONTROL,
750 buf, 9, WAC_CMD_RETRIES);
751 kfree(buf);
753 return retval;
756 static int wacom_led_putimage(struct wacom *wacom, int button_id, const void *img)
758 unsigned char *buf;
759 int i, retval;
761 buf = kzalloc(259, GFP_KERNEL);
762 if (!buf)
763 return -ENOMEM;
765 /* Send 'start' command */
766 buf[0] = WAC_CMD_ICON_START;
767 buf[1] = 1;
768 retval = wacom_set_report(wacom->intf, 0x03, WAC_CMD_ICON_START,
769 buf, 2, WAC_CMD_RETRIES);
770 if (retval < 0)
771 goto out;
773 buf[0] = WAC_CMD_ICON_XFER;
774 buf[1] = button_id & 0x07;
775 for (i = 0; i < 4; i++) {
776 buf[2] = i;
777 memcpy(buf + 3, img + i * 256, 256);
779 retval = wacom_set_report(wacom->intf, 0x03, WAC_CMD_ICON_XFER,
780 buf, 259, WAC_CMD_RETRIES);
781 if (retval < 0)
782 break;
785 /* Send 'stop' */
786 buf[0] = WAC_CMD_ICON_START;
787 buf[1] = 0;
788 wacom_set_report(wacom->intf, 0x03, WAC_CMD_ICON_START,
789 buf, 2, WAC_CMD_RETRIES);
791 out:
792 kfree(buf);
793 return retval;
796 static ssize_t wacom_led_select_store(struct device *dev, int set_id,
797 const char *buf, size_t count)
799 struct wacom *wacom = dev_get_drvdata(dev);
800 unsigned int id;
801 int err;
803 err = kstrtouint(buf, 10, &id);
804 if (err)
805 return err;
807 mutex_lock(&wacom->lock);
809 wacom->led.select[set_id] = id & 0x3;
810 err = wacom_led_control(wacom);
812 mutex_unlock(&wacom->lock);
814 return err < 0 ? err : count;
817 #define DEVICE_LED_SELECT_ATTR(SET_ID) \
818 static ssize_t wacom_led##SET_ID##_select_store(struct device *dev, \
819 struct device_attribute *attr, const char *buf, size_t count) \
821 return wacom_led_select_store(dev, SET_ID, buf, count); \
823 static ssize_t wacom_led##SET_ID##_select_show(struct device *dev, \
824 struct device_attribute *attr, char *buf) \
826 struct wacom *wacom = dev_get_drvdata(dev); \
827 return snprintf(buf, 2, "%d\n", wacom->led.select[SET_ID]); \
829 static DEVICE_ATTR(status_led##SET_ID##_select, S_IWUSR | S_IRUSR, \
830 wacom_led##SET_ID##_select_show, \
831 wacom_led##SET_ID##_select_store)
833 DEVICE_LED_SELECT_ATTR(0);
834 DEVICE_LED_SELECT_ATTR(1);
836 static ssize_t wacom_luminance_store(struct wacom *wacom, u8 *dest,
837 const char *buf, size_t count)
839 unsigned int value;
840 int err;
842 err = kstrtouint(buf, 10, &value);
843 if (err)
844 return err;
846 mutex_lock(&wacom->lock);
848 *dest = value & 0x7f;
849 err = wacom_led_control(wacom);
851 mutex_unlock(&wacom->lock);
853 return err < 0 ? err : count;
856 #define DEVICE_LUMINANCE_ATTR(name, field) \
857 static ssize_t wacom_##name##_luminance_store(struct device *dev, \
858 struct device_attribute *attr, const char *buf, size_t count) \
860 struct wacom *wacom = dev_get_drvdata(dev); \
862 return wacom_luminance_store(wacom, &wacom->led.field, \
863 buf, count); \
865 static DEVICE_ATTR(name##_luminance, S_IWUSR, \
866 NULL, wacom_##name##_luminance_store)
868 DEVICE_LUMINANCE_ATTR(status0, llv);
869 DEVICE_LUMINANCE_ATTR(status1, hlv);
870 DEVICE_LUMINANCE_ATTR(buttons, img_lum);
872 static ssize_t wacom_button_image_store(struct device *dev, int button_id,
873 const char *buf, size_t count)
875 struct wacom *wacom = dev_get_drvdata(dev);
876 int err;
878 if (count != 1024)
879 return -EINVAL;
881 mutex_lock(&wacom->lock);
883 err = wacom_led_putimage(wacom, button_id, buf);
885 mutex_unlock(&wacom->lock);
887 return err < 0 ? err : count;
890 #define DEVICE_BTNIMG_ATTR(BUTTON_ID) \
891 static ssize_t wacom_btnimg##BUTTON_ID##_store(struct device *dev, \
892 struct device_attribute *attr, const char *buf, size_t count) \
894 return wacom_button_image_store(dev, BUTTON_ID, buf, count); \
896 static DEVICE_ATTR(button##BUTTON_ID##_rawimg, S_IWUSR, \
897 NULL, wacom_btnimg##BUTTON_ID##_store)
899 DEVICE_BTNIMG_ATTR(0);
900 DEVICE_BTNIMG_ATTR(1);
901 DEVICE_BTNIMG_ATTR(2);
902 DEVICE_BTNIMG_ATTR(3);
903 DEVICE_BTNIMG_ATTR(4);
904 DEVICE_BTNIMG_ATTR(5);
905 DEVICE_BTNIMG_ATTR(6);
906 DEVICE_BTNIMG_ATTR(7);
908 static struct attribute *cintiq_led_attrs[] = {
909 &dev_attr_status_led0_select.attr,
910 &dev_attr_status_led1_select.attr,
911 NULL
914 static struct attribute_group cintiq_led_attr_group = {
915 .name = "wacom_led",
916 .attrs = cintiq_led_attrs,
919 static struct attribute *intuos4_led_attrs[] = {
920 &dev_attr_status0_luminance.attr,
921 &dev_attr_status1_luminance.attr,
922 &dev_attr_status_led0_select.attr,
923 &dev_attr_buttons_luminance.attr,
924 &dev_attr_button0_rawimg.attr,
925 &dev_attr_button1_rawimg.attr,
926 &dev_attr_button2_rawimg.attr,
927 &dev_attr_button3_rawimg.attr,
928 &dev_attr_button4_rawimg.attr,
929 &dev_attr_button5_rawimg.attr,
930 &dev_attr_button6_rawimg.attr,
931 &dev_attr_button7_rawimg.attr,
932 NULL
935 static struct attribute_group intuos4_led_attr_group = {
936 .name = "wacom_led",
937 .attrs = intuos4_led_attrs,
940 static struct attribute *intuos5_led_attrs[] = {
941 &dev_attr_status0_luminance.attr,
942 &dev_attr_status_led0_select.attr,
943 NULL
946 static struct attribute_group intuos5_led_attr_group = {
947 .name = "wacom_led",
948 .attrs = intuos5_led_attrs,
951 static int wacom_initialize_leds(struct wacom *wacom)
953 int error;
955 /* Initialize default values */
956 switch (wacom->wacom_wac.features.type) {
957 case INTUOS4S:
958 case INTUOS4:
959 case INTUOS4L:
960 wacom->led.select[0] = 0;
961 wacom->led.select[1] = 0;
962 wacom->led.llv = 10;
963 wacom->led.hlv = 20;
964 wacom->led.img_lum = 10;
965 error = sysfs_create_group(&wacom->intf->dev.kobj,
966 &intuos4_led_attr_group);
967 break;
969 case WACOM_24HD:
970 case WACOM_21UX2:
971 wacom->led.select[0] = 0;
972 wacom->led.select[1] = 0;
973 wacom->led.llv = 0;
974 wacom->led.hlv = 0;
975 wacom->led.img_lum = 0;
977 error = sysfs_create_group(&wacom->intf->dev.kobj,
978 &cintiq_led_attr_group);
979 break;
981 case INTUOS5S:
982 case INTUOS5:
983 case INTUOS5L:
984 case INTUOSPS:
985 case INTUOSPM:
986 case INTUOSPL:
987 if (wacom->wacom_wac.features.device_type == BTN_TOOL_PEN) {
988 wacom->led.select[0] = 0;
989 wacom->led.select[1] = 0;
990 wacom->led.llv = 32;
991 wacom->led.hlv = 0;
992 wacom->led.img_lum = 0;
994 error = sysfs_create_group(&wacom->intf->dev.kobj,
995 &intuos5_led_attr_group);
996 } else
997 return 0;
998 break;
1000 default:
1001 return 0;
1004 if (error) {
1005 dev_err(&wacom->intf->dev,
1006 "cannot create sysfs group err: %d\n", error);
1007 return error;
1009 wacom_led_control(wacom);
1011 return 0;
1014 static void wacom_destroy_leds(struct wacom *wacom)
1016 switch (wacom->wacom_wac.features.type) {
1017 case INTUOS4S:
1018 case INTUOS4:
1019 case INTUOS4L:
1020 sysfs_remove_group(&wacom->intf->dev.kobj,
1021 &intuos4_led_attr_group);
1022 break;
1024 case WACOM_24HD:
1025 case WACOM_21UX2:
1026 sysfs_remove_group(&wacom->intf->dev.kobj,
1027 &cintiq_led_attr_group);
1028 break;
1030 case INTUOS5S:
1031 case INTUOS5:
1032 case INTUOS5L:
1033 case INTUOSPS:
1034 case INTUOSPM:
1035 case INTUOSPL:
1036 if (wacom->wacom_wac.features.device_type == BTN_TOOL_PEN)
1037 sysfs_remove_group(&wacom->intf->dev.kobj,
1038 &intuos5_led_attr_group);
1039 break;
1043 static enum power_supply_property wacom_battery_props[] = {
1044 POWER_SUPPLY_PROP_SCOPE,
1045 POWER_SUPPLY_PROP_CAPACITY
1048 static int wacom_battery_get_property(struct power_supply *psy,
1049 enum power_supply_property psp,
1050 union power_supply_propval *val)
1052 struct wacom *wacom = container_of(psy, struct wacom, battery);
1053 int ret = 0;
1055 switch (psp) {
1056 case POWER_SUPPLY_PROP_SCOPE:
1057 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
1058 break;
1059 case POWER_SUPPLY_PROP_CAPACITY:
1060 val->intval =
1061 wacom->wacom_wac.battery_capacity * 100 / 31;
1062 break;
1063 default:
1064 ret = -EINVAL;
1065 break;
1068 return ret;
1071 static int wacom_initialize_battery(struct wacom *wacom)
1073 int error = 0;
1075 if (wacom->wacom_wac.features.quirks & WACOM_QUIRK_MONITOR) {
1076 wacom->battery.properties = wacom_battery_props;
1077 wacom->battery.num_properties = ARRAY_SIZE(wacom_battery_props);
1078 wacom->battery.get_property = wacom_battery_get_property;
1079 wacom->battery.name = "wacom_battery";
1080 wacom->battery.type = POWER_SUPPLY_TYPE_BATTERY;
1081 wacom->battery.use_for_apm = 0;
1083 error = power_supply_register(&wacom->usbdev->dev,
1084 &wacom->battery);
1086 if (!error)
1087 power_supply_powers(&wacom->battery,
1088 &wacom->usbdev->dev);
1091 return error;
1094 static void wacom_destroy_battery(struct wacom *wacom)
1096 if (wacom->wacom_wac.features.quirks & WACOM_QUIRK_MONITOR &&
1097 wacom->battery.dev) {
1098 power_supply_unregister(&wacom->battery);
1099 wacom->battery.dev = NULL;
1103 static int wacom_register_input(struct wacom *wacom)
1105 struct input_dev *input_dev;
1106 struct usb_interface *intf = wacom->intf;
1107 struct usb_device *dev = interface_to_usbdev(intf);
1108 struct wacom_wac *wacom_wac = &(wacom->wacom_wac);
1109 int error;
1111 input_dev = input_allocate_device();
1112 if (!input_dev) {
1113 error = -ENOMEM;
1114 goto fail1;
1117 input_dev->name = wacom_wac->name;
1118 input_dev->dev.parent = &intf->dev;
1119 input_dev->open = wacom_open;
1120 input_dev->close = wacom_close;
1121 usb_to_input_id(dev, &input_dev->id);
1122 input_set_drvdata(input_dev, wacom);
1124 wacom_wac->input = input_dev;
1125 error = wacom_setup_input_capabilities(input_dev, wacom_wac);
1126 if (error)
1127 goto fail1;
1129 error = input_register_device(input_dev);
1130 if (error)
1131 goto fail2;
1133 return 0;
1135 fail2:
1136 input_free_device(input_dev);
1137 wacom_wac->input = NULL;
1138 fail1:
1139 return error;
1142 static void wacom_wireless_work(struct work_struct *work)
1144 struct wacom *wacom = container_of(work, struct wacom, work);
1145 struct usb_device *usbdev = wacom->usbdev;
1146 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
1147 struct wacom *wacom1, *wacom2;
1148 struct wacom_wac *wacom_wac1, *wacom_wac2;
1149 int error;
1152 * Regardless if this is a disconnect or a new tablet,
1153 * remove any existing input and battery devices.
1156 wacom_destroy_battery(wacom);
1158 /* Stylus interface */
1159 wacom1 = usb_get_intfdata(usbdev->config->interface[1]);
1160 wacom_wac1 = &(wacom1->wacom_wac);
1161 if (wacom_wac1->input)
1162 input_unregister_device(wacom_wac1->input);
1163 wacom_wac1->input = NULL;
1165 /* Touch interface */
1166 wacom2 = usb_get_intfdata(usbdev->config->interface[2]);
1167 wacom_wac2 = &(wacom2->wacom_wac);
1168 if (wacom_wac2->input)
1169 input_unregister_device(wacom_wac2->input);
1170 wacom_wac2->input = NULL;
1172 if (wacom_wac->pid == 0) {
1173 dev_info(&wacom->intf->dev, "wireless tablet disconnected\n");
1174 } else {
1175 const struct usb_device_id *id = wacom_ids;
1177 dev_info(&wacom->intf->dev,
1178 "wireless tablet connected with PID %x\n",
1179 wacom_wac->pid);
1181 while (id->match_flags) {
1182 if (id->idVendor == USB_VENDOR_ID_WACOM &&
1183 id->idProduct == wacom_wac->pid)
1184 break;
1185 id++;
1188 if (!id->match_flags) {
1189 dev_info(&wacom->intf->dev,
1190 "ignoring unknown PID.\n");
1191 return;
1194 /* Stylus interface */
1195 wacom_wac1->features =
1196 *((struct wacom_features *)id->driver_info);
1197 wacom_wac1->features.device_type = BTN_TOOL_PEN;
1198 snprintf(wacom_wac1->name, WACOM_NAME_MAX, "%s (WL) Pen",
1199 wacom_wac1->features.name);
1200 wacom_wac1->shared->touch_max = wacom_wac1->features.touch_max;
1201 wacom_wac1->shared->type = wacom_wac1->features.type;
1202 error = wacom_register_input(wacom1);
1203 if (error)
1204 goto fail;
1206 /* Touch interface */
1207 if (wacom_wac1->features.touch_max ||
1208 wacom_wac1->features.type == INTUOSHT) {
1209 wacom_wac2->features =
1210 *((struct wacom_features *)id->driver_info);
1211 wacom_wac2->features.pktlen = WACOM_PKGLEN_BBTOUCH3;
1212 wacom_wac2->features.device_type = BTN_TOOL_FINGER;
1213 wacom_wac2->features.x_max = wacom_wac2->features.y_max = 4096;
1214 if (wacom_wac2->features.touch_max)
1215 snprintf(wacom_wac2->name, WACOM_NAME_MAX,
1216 "%s (WL) Finger",wacom_wac2->features.name);
1217 else
1218 snprintf(wacom_wac2->name, WACOM_NAME_MAX,
1219 "%s (WL) Pad",wacom_wac2->features.name);
1220 error = wacom_register_input(wacom2);
1221 if (error)
1222 goto fail;
1224 if (wacom_wac1->features.type == INTUOSHT &&
1225 wacom_wac1->features.touch_max)
1226 wacom_wac->shared->touch_input = wacom_wac2->input;
1229 error = wacom_initialize_battery(wacom);
1230 if (error)
1231 goto fail;
1234 return;
1236 fail:
1237 if (wacom_wac2->input) {
1238 input_unregister_device(wacom_wac2->input);
1239 wacom_wac2->input = NULL;
1242 if (wacom_wac1->input) {
1243 input_unregister_device(wacom_wac1->input);
1244 wacom_wac1->input = NULL;
1246 return;
1250 * Not all devices report physical dimensions from HID.
1251 * Compute the default from hardcoded logical dimension
1252 * and resolution before driver overwrites them.
1254 static void wacom_set_default_phy(struct wacom_features *features)
1256 if (features->x_resolution) {
1257 features->x_phy = (features->x_max * 100) /
1258 features->x_resolution;
1259 features->y_phy = (features->y_max * 100) /
1260 features->y_resolution;
1264 static void wacom_calculate_res(struct wacom_features *features)
1266 features->x_resolution = wacom_calc_hid_res(features->x_max,
1267 features->x_phy,
1268 features->unit,
1269 features->unitExpo);
1270 features->y_resolution = wacom_calc_hid_res(features->y_max,
1271 features->y_phy,
1272 features->unit,
1273 features->unitExpo);
1276 static int wacom_probe(struct usb_interface *intf, const struct usb_device_id *id)
1278 struct usb_device *dev = interface_to_usbdev(intf);
1279 struct usb_endpoint_descriptor *endpoint;
1280 struct wacom *wacom;
1281 struct wacom_wac *wacom_wac;
1282 struct wacom_features *features;
1283 int error;
1285 if (!id->driver_info)
1286 return -EINVAL;
1288 wacom = kzalloc(sizeof(struct wacom), GFP_KERNEL);
1289 if (!wacom)
1290 return -ENOMEM;
1292 wacom_wac = &wacom->wacom_wac;
1293 wacom_wac->features = *((struct wacom_features *)id->driver_info);
1294 features = &wacom_wac->features;
1295 if (features->pktlen > WACOM_PKGLEN_MAX) {
1296 error = -EINVAL;
1297 goto fail1;
1300 wacom_wac->data = usb_alloc_coherent(dev, WACOM_PKGLEN_MAX,
1301 GFP_KERNEL, &wacom->data_dma);
1302 if (!wacom_wac->data) {
1303 error = -ENOMEM;
1304 goto fail1;
1307 wacom->irq = usb_alloc_urb(0, GFP_KERNEL);
1308 if (!wacom->irq) {
1309 error = -ENOMEM;
1310 goto fail2;
1313 wacom->usbdev = dev;
1314 wacom->intf = intf;
1315 mutex_init(&wacom->lock);
1316 INIT_WORK(&wacom->work, wacom_wireless_work);
1317 usb_make_path(dev, wacom->phys, sizeof(wacom->phys));
1318 strlcat(wacom->phys, "/input0", sizeof(wacom->phys));
1320 endpoint = &intf->cur_altsetting->endpoint[0].desc;
1322 /* set the default size in case we do not get them from hid */
1323 wacom_set_default_phy(features);
1325 /* Retrieve the physical and logical size for touch devices */
1326 error = wacom_retrieve_hid_descriptor(intf, features);
1327 if (error)
1328 goto fail3;
1331 * Intuos5 has no useful data about its touch interface in its
1332 * HID descriptor. If this is the touch interface (wMaxPacketSize
1333 * of WACOM_PKGLEN_BBTOUCH3), override the table values.
1335 if (features->type >= INTUOS5S && features->type <= INTUOSHT) {
1336 if (endpoint->wMaxPacketSize == WACOM_PKGLEN_BBTOUCH3) {
1337 features->device_type = BTN_TOOL_FINGER;
1338 features->pktlen = WACOM_PKGLEN_BBTOUCH3;
1340 features->x_max = 4096;
1341 features->y_max = 4096;
1342 } else {
1343 features->device_type = BTN_TOOL_PEN;
1347 wacom_setup_device_quirks(features);
1349 /* set unit to "100th of a mm" for devices not reported by HID */
1350 if (!features->unit) {
1351 features->unit = 0x11;
1352 features->unitExpo = 16 - 3;
1354 wacom_calculate_res(features);
1356 strlcpy(wacom_wac->name, features->name, sizeof(wacom_wac->name));
1358 if (features->quirks & WACOM_QUIRK_MULTI_INPUT) {
1359 struct usb_device *other_dev;
1361 /* Append the device type to the name */
1362 if (features->device_type != BTN_TOOL_FINGER)
1363 strlcat(wacom_wac->name, " Pen", WACOM_NAME_MAX);
1364 else if (features->touch_max)
1365 strlcat(wacom_wac->name, " Finger", WACOM_NAME_MAX);
1366 else
1367 strlcat(wacom_wac->name, " Pad", WACOM_NAME_MAX);
1369 other_dev = wacom_get_sibling(dev, features->oVid, features->oPid);
1370 if (other_dev == NULL || wacom_get_usbdev_data(other_dev) == NULL)
1371 other_dev = dev;
1372 error = wacom_add_shared_data(wacom_wac, other_dev);
1373 if (error)
1374 goto fail3;
1377 usb_fill_int_urb(wacom->irq, dev,
1378 usb_rcvintpipe(dev, endpoint->bEndpointAddress),
1379 wacom_wac->data, features->pktlen,
1380 wacom_sys_irq, wacom, endpoint->bInterval);
1381 wacom->irq->transfer_dma = wacom->data_dma;
1382 wacom->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1384 error = wacom_initialize_leds(wacom);
1385 if (error)
1386 goto fail4;
1388 if (!(features->quirks & WACOM_QUIRK_NO_INPUT)) {
1389 error = wacom_register_input(wacom);
1390 if (error)
1391 goto fail5;
1394 /* Note that if query fails it is not a hard failure */
1395 wacom_query_tablet_data(intf, features);
1397 usb_set_intfdata(intf, wacom);
1399 if (features->quirks & WACOM_QUIRK_MONITOR) {
1400 if (usb_submit_urb(wacom->irq, GFP_KERNEL)) {
1401 error = -EIO;
1402 goto fail5;
1406 if (wacom_wac->features.type == INTUOSHT && wacom_wac->features.touch_max) {
1407 if (wacom_wac->features.device_type == BTN_TOOL_FINGER)
1408 wacom_wac->shared->touch_input = wacom_wac->input;
1411 return 0;
1413 fail5: wacom_destroy_leds(wacom);
1414 fail4: wacom_remove_shared_data(wacom_wac);
1415 fail3: usb_free_urb(wacom->irq);
1416 fail2: usb_free_coherent(dev, WACOM_PKGLEN_MAX, wacom_wac->data, wacom->data_dma);
1417 fail1: kfree(wacom);
1418 return error;
1421 static void wacom_disconnect(struct usb_interface *intf)
1423 struct wacom *wacom = usb_get_intfdata(intf);
1425 usb_set_intfdata(intf, NULL);
1427 usb_kill_urb(wacom->irq);
1428 cancel_work_sync(&wacom->work);
1429 if (wacom->wacom_wac.input)
1430 input_unregister_device(wacom->wacom_wac.input);
1431 wacom_destroy_battery(wacom);
1432 wacom_destroy_leds(wacom);
1433 usb_free_urb(wacom->irq);
1434 usb_free_coherent(interface_to_usbdev(intf), WACOM_PKGLEN_MAX,
1435 wacom->wacom_wac.data, wacom->data_dma);
1436 wacom_remove_shared_data(&wacom->wacom_wac);
1437 kfree(wacom);
1440 static int wacom_suspend(struct usb_interface *intf, pm_message_t message)
1442 struct wacom *wacom = usb_get_intfdata(intf);
1444 mutex_lock(&wacom->lock);
1445 usb_kill_urb(wacom->irq);
1446 mutex_unlock(&wacom->lock);
1448 return 0;
1451 static int wacom_resume(struct usb_interface *intf)
1453 struct wacom *wacom = usb_get_intfdata(intf);
1454 struct wacom_features *features = &wacom->wacom_wac.features;
1455 int rv = 0;
1457 mutex_lock(&wacom->lock);
1459 /* switch to wacom mode first */
1460 wacom_query_tablet_data(intf, features);
1461 wacom_led_control(wacom);
1463 if ((wacom->open || (features->quirks & WACOM_QUIRK_MONITOR)) &&
1464 usb_submit_urb(wacom->irq, GFP_NOIO) < 0)
1465 rv = -EIO;
1467 mutex_unlock(&wacom->lock);
1469 return rv;
1472 static int wacom_reset_resume(struct usb_interface *intf)
1474 return wacom_resume(intf);
1477 static struct usb_driver wacom_driver = {
1478 .name = "wacom",
1479 .id_table = wacom_ids,
1480 .probe = wacom_probe,
1481 .disconnect = wacom_disconnect,
1482 .suspend = wacom_suspend,
1483 .resume = wacom_resume,
1484 .reset_resume = wacom_reset_resume,
1485 .supports_autosuspend = 1,
1488 module_usb_driver(wacom_driver);