Merge tag 'gpio-v3.13-3' of git://git.kernel.org/pub/scm/linux/kernel/git/linusw...
[linux-2.6.git] / drivers / input / tablet / wacom_sys.c
blob867e7c33ac55072b19f2ff339705c4e90f6b428d
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;
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;
355 switch (features->type) {
356 case TABLETPC2FG:
357 features->pktlen = WACOM_PKGLEN_TPC2FG;
358 break;
360 case MTSCREEN:
361 case WACOM_24HDT:
362 features->pktlen = WACOM_PKGLEN_MTOUCH;
363 break;
365 case MTTPC:
366 features->pktlen = WACOM_PKGLEN_MTTPC;
367 break;
369 case BAMBOO_PT:
370 features->pktlen = WACOM_PKGLEN_BBTOUCH;
371 break;
373 default:
374 features->pktlen = WACOM_PKGLEN_GRAPHIRE;
375 break;
378 switch (features->type) {
379 case BAMBOO_PT:
380 features->x_phy =
381 get_unaligned_le16(&report[i + 5]);
382 features->x_max =
383 get_unaligned_le16(&report[i + 8]);
384 i += 15;
385 break;
387 case WACOM_24HDT:
388 features->x_max =
389 get_unaligned_le16(&report[i + 3]);
390 features->x_phy =
391 get_unaligned_le16(&report[i + 8]);
392 features->unit = report[i - 1];
393 features->unitExpo = report[i - 3];
394 i += 12;
395 break;
397 default:
398 features->x_max =
399 get_unaligned_le16(&report[i + 3]);
400 features->x_phy =
401 get_unaligned_le16(&report[i + 6]);
402 features->unit = report[i + 9];
403 features->unitExpo = report[i + 11];
404 i += 12;
405 break;
407 } else if (pen) {
408 /* penabled only accepts exact bytes of data */
409 if (features->type >= TABLETPC)
410 features->pktlen = WACOM_PKGLEN_GRAPHIRE;
411 features->device_type = BTN_TOOL_PEN;
412 features->x_max =
413 get_unaligned_le16(&report[i + 3]);
414 i += 4;
417 break;
419 case HID_USAGE_Y:
420 if (usage == WCM_DESKTOP) {
421 if (finger) {
422 switch (features->type) {
423 case TABLETPC2FG:
424 case MTSCREEN:
425 case MTTPC:
426 features->y_max =
427 get_unaligned_le16(&report[i + 3]);
428 features->y_phy =
429 get_unaligned_le16(&report[i + 6]);
430 i += 7;
431 break;
433 case WACOM_24HDT:
434 features->y_max =
435 get_unaligned_le16(&report[i + 3]);
436 features->y_phy =
437 get_unaligned_le16(&report[i - 2]);
438 i += 7;
439 break;
441 case BAMBOO_PT:
442 features->y_phy =
443 get_unaligned_le16(&report[i + 3]);
444 features->y_max =
445 get_unaligned_le16(&report[i + 6]);
446 i += 12;
447 break;
449 default:
450 features->y_max =
451 features->x_max;
452 features->y_phy =
453 get_unaligned_le16(&report[i + 3]);
454 i += 4;
455 break;
457 } else if (pen) {
458 features->y_max =
459 get_unaligned_le16(&report[i + 3]);
460 i += 4;
463 break;
465 case HID_USAGE_FINGER:
466 finger = 1;
467 i++;
468 break;
471 * Requiring Stylus Usage will ignore boot mouse
472 * X/Y values and some cases of invalid Digitizer X/Y
473 * values commonly reported.
475 case HID_USAGE_STYLUS:
476 pen = 1;
477 i++;
478 break;
480 case HID_USAGE_CONTACTMAX:
481 /* leave touch_max as is if predefined */
482 if (!features->touch_max)
483 wacom_retrieve_report_data(intf, features);
484 i++;
485 break;
487 break;
489 case HID_COLLECTION_END:
490 /* reset UsagePage and Finger */
491 finger = usage = 0;
492 break;
494 case HID_COLLECTION:
495 i++;
496 switch (report[i]) {
497 case HID_COLLECTION_LOGICAL:
498 i += wacom_parse_logical_collection(&report[i],
499 features);
500 break;
502 break;
506 out:
507 result = 0;
508 kfree(report);
509 return result;
512 static int wacom_set_device_mode(struct usb_interface *intf, int report_id, int length, int mode)
514 unsigned char *rep_data;
515 int error = -ENOMEM, limit = 0;
517 rep_data = kzalloc(length, GFP_KERNEL);
518 if (!rep_data)
519 return error;
521 do {
522 rep_data[0] = report_id;
523 rep_data[1] = mode;
525 error = wacom_set_report(intf, WAC_HID_FEATURE_REPORT,
526 report_id, rep_data, length, 1);
527 } while ((error < 0 || rep_data[1] != mode) && limit++ < WAC_MSG_RETRIES);
529 kfree(rep_data);
531 return error < 0 ? error : 0;
535 * Switch the tablet into its most-capable mode. Wacom tablets are
536 * typically configured to power-up in a mode which sends mouse-like
537 * reports to the OS. To get absolute position, pressure data, etc.
538 * from the tablet, it is necessary to switch the tablet out of this
539 * mode and into one which sends the full range of tablet data.
541 static int wacom_query_tablet_data(struct usb_interface *intf, struct wacom_features *features)
543 if (features->device_type == BTN_TOOL_FINGER) {
544 if (features->type > TABLETPC) {
545 /* MT Tablet PC touch */
546 return wacom_set_device_mode(intf, 3, 4, 4);
548 else if (features->type == WACOM_24HDT || features->type == CINTIQ_HYBRID) {
549 return wacom_set_device_mode(intf, 18, 3, 2);
551 } else if (features->device_type == BTN_TOOL_PEN) {
552 if (features->type <= BAMBOO_PT && features->type != WIRELESS) {
553 return wacom_set_device_mode(intf, 2, 2, 2);
557 return 0;
560 static int wacom_retrieve_hid_descriptor(struct usb_interface *intf,
561 struct wacom_features *features)
563 int error = 0;
564 struct usb_host_interface *interface = intf->cur_altsetting;
565 struct hid_descriptor *hid_desc;
567 /* default features */
568 features->device_type = BTN_TOOL_PEN;
569 features->x_fuzz = 4;
570 features->y_fuzz = 4;
571 features->pressure_fuzz = 0;
572 features->distance_fuzz = 0;
575 * The wireless device HID is basic and layout conflicts with
576 * other tablets (monitor and touch interface can look like pen).
577 * Skip the query for this type and modify defaults based on
578 * interface number.
580 if (features->type == WIRELESS) {
581 if (intf->cur_altsetting->desc.bInterfaceNumber == 0) {
582 features->device_type = 0;
583 } else if (intf->cur_altsetting->desc.bInterfaceNumber == 2) {
584 features->device_type = BTN_TOOL_FINGER;
585 features->pktlen = WACOM_PKGLEN_BBTOUCH3;
589 /* only devices that support touch need to retrieve the info */
590 if (features->type < BAMBOO_PT) {
591 goto out;
594 error = usb_get_extra_descriptor(interface, HID_DEVICET_HID, &hid_desc);
595 if (error) {
596 error = usb_get_extra_descriptor(&interface->endpoint[0],
597 HID_DEVICET_REPORT, &hid_desc);
598 if (error) {
599 dev_err(&intf->dev,
600 "can not retrieve extra class descriptor\n");
601 goto out;
604 error = wacom_parse_hid(intf, hid_desc, features);
606 out:
607 return error;
610 struct wacom_usbdev_data {
611 struct list_head list;
612 struct kref kref;
613 struct usb_device *dev;
614 struct wacom_shared shared;
617 static LIST_HEAD(wacom_udev_list);
618 static DEFINE_MUTEX(wacom_udev_list_lock);
620 static struct usb_device *wacom_get_sibling(struct usb_device *dev, int vendor, int product)
622 int port1;
623 struct usb_device *sibling;
625 if (vendor == 0 && product == 0)
626 return dev;
628 if (dev->parent == NULL)
629 return NULL;
631 usb_hub_for_each_child(dev->parent, port1, sibling) {
632 struct usb_device_descriptor *d;
633 if (sibling == NULL)
634 continue;
636 d = &sibling->descriptor;
637 if (d->idVendor == vendor && d->idProduct == product)
638 return sibling;
641 return NULL;
644 static struct wacom_usbdev_data *wacom_get_usbdev_data(struct usb_device *dev)
646 struct wacom_usbdev_data *data;
648 list_for_each_entry(data, &wacom_udev_list, list) {
649 if (data->dev == dev) {
650 kref_get(&data->kref);
651 return data;
655 return NULL;
658 static int wacom_add_shared_data(struct wacom_wac *wacom,
659 struct usb_device *dev)
661 struct wacom_usbdev_data *data;
662 int retval = 0;
664 mutex_lock(&wacom_udev_list_lock);
666 data = wacom_get_usbdev_data(dev);
667 if (!data) {
668 data = kzalloc(sizeof(struct wacom_usbdev_data), GFP_KERNEL);
669 if (!data) {
670 retval = -ENOMEM;
671 goto out;
674 kref_init(&data->kref);
675 data->dev = dev;
676 list_add_tail(&data->list, &wacom_udev_list);
679 wacom->shared = &data->shared;
681 out:
682 mutex_unlock(&wacom_udev_list_lock);
683 return retval;
686 static void wacom_release_shared_data(struct kref *kref)
688 struct wacom_usbdev_data *data =
689 container_of(kref, struct wacom_usbdev_data, kref);
691 mutex_lock(&wacom_udev_list_lock);
692 list_del(&data->list);
693 mutex_unlock(&wacom_udev_list_lock);
695 kfree(data);
698 static void wacom_remove_shared_data(struct wacom_wac *wacom)
700 struct wacom_usbdev_data *data;
702 if (wacom->shared) {
703 data = container_of(wacom->shared, struct wacom_usbdev_data, shared);
704 kref_put(&data->kref, wacom_release_shared_data);
705 wacom->shared = NULL;
709 static int wacom_led_control(struct wacom *wacom)
711 unsigned char *buf;
712 int retval;
714 buf = kzalloc(9, GFP_KERNEL);
715 if (!buf)
716 return -ENOMEM;
718 if (wacom->wacom_wac.features.type >= INTUOS5S &&
719 wacom->wacom_wac.features.type <= INTUOSPL) {
721 * Touch Ring and crop mark LED luminance may take on
722 * one of four values:
723 * 0 = Low; 1 = Medium; 2 = High; 3 = Off
725 int ring_led = wacom->led.select[0] & 0x03;
726 int ring_lum = (((wacom->led.llv & 0x60) >> 5) - 1) & 0x03;
727 int crop_lum = 0;
729 buf[0] = WAC_CMD_LED_CONTROL;
730 buf[1] = (crop_lum << 4) | (ring_lum << 2) | (ring_led);
732 else {
733 int led = wacom->led.select[0] | 0x4;
735 if (wacom->wacom_wac.features.type == WACOM_21UX2 ||
736 wacom->wacom_wac.features.type == WACOM_24HD)
737 led |= (wacom->led.select[1] << 4) | 0x40;
739 buf[0] = WAC_CMD_LED_CONTROL;
740 buf[1] = led;
741 buf[2] = wacom->led.llv;
742 buf[3] = wacom->led.hlv;
743 buf[4] = wacom->led.img_lum;
746 retval = wacom_set_report(wacom->intf, 0x03, WAC_CMD_LED_CONTROL,
747 buf, 9, WAC_CMD_RETRIES);
748 kfree(buf);
750 return retval;
753 static int wacom_led_putimage(struct wacom *wacom, int button_id, const void *img)
755 unsigned char *buf;
756 int i, retval;
758 buf = kzalloc(259, GFP_KERNEL);
759 if (!buf)
760 return -ENOMEM;
762 /* Send 'start' command */
763 buf[0] = WAC_CMD_ICON_START;
764 buf[1] = 1;
765 retval = wacom_set_report(wacom->intf, 0x03, WAC_CMD_ICON_START,
766 buf, 2, WAC_CMD_RETRIES);
767 if (retval < 0)
768 goto out;
770 buf[0] = WAC_CMD_ICON_XFER;
771 buf[1] = button_id & 0x07;
772 for (i = 0; i < 4; i++) {
773 buf[2] = i;
774 memcpy(buf + 3, img + i * 256, 256);
776 retval = wacom_set_report(wacom->intf, 0x03, WAC_CMD_ICON_XFER,
777 buf, 259, WAC_CMD_RETRIES);
778 if (retval < 0)
779 break;
782 /* Send 'stop' */
783 buf[0] = WAC_CMD_ICON_START;
784 buf[1] = 0;
785 wacom_set_report(wacom->intf, 0x03, WAC_CMD_ICON_START,
786 buf, 2, WAC_CMD_RETRIES);
788 out:
789 kfree(buf);
790 return retval;
793 static ssize_t wacom_led_select_store(struct device *dev, int set_id,
794 const char *buf, size_t count)
796 struct wacom *wacom = dev_get_drvdata(dev);
797 unsigned int id;
798 int err;
800 err = kstrtouint(buf, 10, &id);
801 if (err)
802 return err;
804 mutex_lock(&wacom->lock);
806 wacom->led.select[set_id] = id & 0x3;
807 err = wacom_led_control(wacom);
809 mutex_unlock(&wacom->lock);
811 return err < 0 ? err : count;
814 #define DEVICE_LED_SELECT_ATTR(SET_ID) \
815 static ssize_t wacom_led##SET_ID##_select_store(struct device *dev, \
816 struct device_attribute *attr, const char *buf, size_t count) \
818 return wacom_led_select_store(dev, SET_ID, buf, count); \
820 static ssize_t wacom_led##SET_ID##_select_show(struct device *dev, \
821 struct device_attribute *attr, char *buf) \
823 struct wacom *wacom = dev_get_drvdata(dev); \
824 return snprintf(buf, 2, "%d\n", wacom->led.select[SET_ID]); \
826 static DEVICE_ATTR(status_led##SET_ID##_select, S_IWUSR | S_IRUSR, \
827 wacom_led##SET_ID##_select_show, \
828 wacom_led##SET_ID##_select_store)
830 DEVICE_LED_SELECT_ATTR(0);
831 DEVICE_LED_SELECT_ATTR(1);
833 static ssize_t wacom_luminance_store(struct wacom *wacom, u8 *dest,
834 const char *buf, size_t count)
836 unsigned int value;
837 int err;
839 err = kstrtouint(buf, 10, &value);
840 if (err)
841 return err;
843 mutex_lock(&wacom->lock);
845 *dest = value & 0x7f;
846 err = wacom_led_control(wacom);
848 mutex_unlock(&wacom->lock);
850 return err < 0 ? err : count;
853 #define DEVICE_LUMINANCE_ATTR(name, field) \
854 static ssize_t wacom_##name##_luminance_store(struct device *dev, \
855 struct device_attribute *attr, const char *buf, size_t count) \
857 struct wacom *wacom = dev_get_drvdata(dev); \
859 return wacom_luminance_store(wacom, &wacom->led.field, \
860 buf, count); \
862 static DEVICE_ATTR(name##_luminance, S_IWUSR, \
863 NULL, wacom_##name##_luminance_store)
865 DEVICE_LUMINANCE_ATTR(status0, llv);
866 DEVICE_LUMINANCE_ATTR(status1, hlv);
867 DEVICE_LUMINANCE_ATTR(buttons, img_lum);
869 static ssize_t wacom_button_image_store(struct device *dev, int button_id,
870 const char *buf, size_t count)
872 struct wacom *wacom = dev_get_drvdata(dev);
873 int err;
875 if (count != 1024)
876 return -EINVAL;
878 mutex_lock(&wacom->lock);
880 err = wacom_led_putimage(wacom, button_id, buf);
882 mutex_unlock(&wacom->lock);
884 return err < 0 ? err : count;
887 #define DEVICE_BTNIMG_ATTR(BUTTON_ID) \
888 static ssize_t wacom_btnimg##BUTTON_ID##_store(struct device *dev, \
889 struct device_attribute *attr, const char *buf, size_t count) \
891 return wacom_button_image_store(dev, BUTTON_ID, buf, count); \
893 static DEVICE_ATTR(button##BUTTON_ID##_rawimg, S_IWUSR, \
894 NULL, wacom_btnimg##BUTTON_ID##_store)
896 DEVICE_BTNIMG_ATTR(0);
897 DEVICE_BTNIMG_ATTR(1);
898 DEVICE_BTNIMG_ATTR(2);
899 DEVICE_BTNIMG_ATTR(3);
900 DEVICE_BTNIMG_ATTR(4);
901 DEVICE_BTNIMG_ATTR(5);
902 DEVICE_BTNIMG_ATTR(6);
903 DEVICE_BTNIMG_ATTR(7);
905 static struct attribute *cintiq_led_attrs[] = {
906 &dev_attr_status_led0_select.attr,
907 &dev_attr_status_led1_select.attr,
908 NULL
911 static struct attribute_group cintiq_led_attr_group = {
912 .name = "wacom_led",
913 .attrs = cintiq_led_attrs,
916 static struct attribute *intuos4_led_attrs[] = {
917 &dev_attr_status0_luminance.attr,
918 &dev_attr_status1_luminance.attr,
919 &dev_attr_status_led0_select.attr,
920 &dev_attr_buttons_luminance.attr,
921 &dev_attr_button0_rawimg.attr,
922 &dev_attr_button1_rawimg.attr,
923 &dev_attr_button2_rawimg.attr,
924 &dev_attr_button3_rawimg.attr,
925 &dev_attr_button4_rawimg.attr,
926 &dev_attr_button5_rawimg.attr,
927 &dev_attr_button6_rawimg.attr,
928 &dev_attr_button7_rawimg.attr,
929 NULL
932 static struct attribute_group intuos4_led_attr_group = {
933 .name = "wacom_led",
934 .attrs = intuos4_led_attrs,
937 static struct attribute *intuos5_led_attrs[] = {
938 &dev_attr_status0_luminance.attr,
939 &dev_attr_status_led0_select.attr,
940 NULL
943 static struct attribute_group intuos5_led_attr_group = {
944 .name = "wacom_led",
945 .attrs = intuos5_led_attrs,
948 static int wacom_initialize_leds(struct wacom *wacom)
950 int error;
952 /* Initialize default values */
953 switch (wacom->wacom_wac.features.type) {
954 case INTUOS4S:
955 case INTUOS4:
956 case INTUOS4L:
957 wacom->led.select[0] = 0;
958 wacom->led.select[1] = 0;
959 wacom->led.llv = 10;
960 wacom->led.hlv = 20;
961 wacom->led.img_lum = 10;
962 error = sysfs_create_group(&wacom->intf->dev.kobj,
963 &intuos4_led_attr_group);
964 break;
966 case WACOM_24HD:
967 case WACOM_21UX2:
968 wacom->led.select[0] = 0;
969 wacom->led.select[1] = 0;
970 wacom->led.llv = 0;
971 wacom->led.hlv = 0;
972 wacom->led.img_lum = 0;
974 error = sysfs_create_group(&wacom->intf->dev.kobj,
975 &cintiq_led_attr_group);
976 break;
978 case INTUOS5S:
979 case INTUOS5:
980 case INTUOS5L:
981 case INTUOSPS:
982 case INTUOSPM:
983 case INTUOSPL:
984 if (wacom->wacom_wac.features.device_type == BTN_TOOL_PEN) {
985 wacom->led.select[0] = 0;
986 wacom->led.select[1] = 0;
987 wacom->led.llv = 32;
988 wacom->led.hlv = 0;
989 wacom->led.img_lum = 0;
991 error = sysfs_create_group(&wacom->intf->dev.kobj,
992 &intuos5_led_attr_group);
993 } else
994 return 0;
995 break;
997 default:
998 return 0;
1001 if (error) {
1002 dev_err(&wacom->intf->dev,
1003 "cannot create sysfs group err: %d\n", error);
1004 return error;
1006 wacom_led_control(wacom);
1008 return 0;
1011 static void wacom_destroy_leds(struct wacom *wacom)
1013 switch (wacom->wacom_wac.features.type) {
1014 case INTUOS4S:
1015 case INTUOS4:
1016 case INTUOS4L:
1017 sysfs_remove_group(&wacom->intf->dev.kobj,
1018 &intuos4_led_attr_group);
1019 break;
1021 case WACOM_24HD:
1022 case WACOM_21UX2:
1023 sysfs_remove_group(&wacom->intf->dev.kobj,
1024 &cintiq_led_attr_group);
1025 break;
1027 case INTUOS5S:
1028 case INTUOS5:
1029 case INTUOS5L:
1030 case INTUOSPS:
1031 case INTUOSPM:
1032 case INTUOSPL:
1033 if (wacom->wacom_wac.features.device_type == BTN_TOOL_PEN)
1034 sysfs_remove_group(&wacom->intf->dev.kobj,
1035 &intuos5_led_attr_group);
1036 break;
1040 static enum power_supply_property wacom_battery_props[] = {
1041 POWER_SUPPLY_PROP_SCOPE,
1042 POWER_SUPPLY_PROP_CAPACITY
1045 static int wacom_battery_get_property(struct power_supply *psy,
1046 enum power_supply_property psp,
1047 union power_supply_propval *val)
1049 struct wacom *wacom = container_of(psy, struct wacom, battery);
1050 int ret = 0;
1052 switch (psp) {
1053 case POWER_SUPPLY_PROP_SCOPE:
1054 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
1055 break;
1056 case POWER_SUPPLY_PROP_CAPACITY:
1057 val->intval =
1058 wacom->wacom_wac.battery_capacity * 100 / 31;
1059 break;
1060 default:
1061 ret = -EINVAL;
1062 break;
1065 return ret;
1068 static int wacom_initialize_battery(struct wacom *wacom)
1070 int error = 0;
1072 if (wacom->wacom_wac.features.quirks & WACOM_QUIRK_MONITOR) {
1073 wacom->battery.properties = wacom_battery_props;
1074 wacom->battery.num_properties = ARRAY_SIZE(wacom_battery_props);
1075 wacom->battery.get_property = wacom_battery_get_property;
1076 wacom->battery.name = "wacom_battery";
1077 wacom->battery.type = POWER_SUPPLY_TYPE_BATTERY;
1078 wacom->battery.use_for_apm = 0;
1080 error = power_supply_register(&wacom->usbdev->dev,
1081 &wacom->battery);
1083 if (!error)
1084 power_supply_powers(&wacom->battery,
1085 &wacom->usbdev->dev);
1088 return error;
1091 static void wacom_destroy_battery(struct wacom *wacom)
1093 if (wacom->wacom_wac.features.quirks & WACOM_QUIRK_MONITOR &&
1094 wacom->battery.dev) {
1095 power_supply_unregister(&wacom->battery);
1096 wacom->battery.dev = NULL;
1100 static int wacom_register_input(struct wacom *wacom)
1102 struct input_dev *input_dev;
1103 struct usb_interface *intf = wacom->intf;
1104 struct usb_device *dev = interface_to_usbdev(intf);
1105 struct wacom_wac *wacom_wac = &(wacom->wacom_wac);
1106 int error;
1108 input_dev = input_allocate_device();
1109 if (!input_dev) {
1110 error = -ENOMEM;
1111 goto fail1;
1114 input_dev->name = wacom_wac->name;
1115 input_dev->dev.parent = &intf->dev;
1116 input_dev->open = wacom_open;
1117 input_dev->close = wacom_close;
1118 usb_to_input_id(dev, &input_dev->id);
1119 input_set_drvdata(input_dev, wacom);
1121 wacom_wac->input = input_dev;
1122 error = wacom_setup_input_capabilities(input_dev, wacom_wac);
1123 if (error)
1124 goto fail1;
1126 error = input_register_device(input_dev);
1127 if (error)
1128 goto fail2;
1130 return 0;
1132 fail2:
1133 input_free_device(input_dev);
1134 wacom_wac->input = NULL;
1135 fail1:
1136 return error;
1139 static void wacom_wireless_work(struct work_struct *work)
1141 struct wacom *wacom = container_of(work, struct wacom, work);
1142 struct usb_device *usbdev = wacom->usbdev;
1143 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
1144 struct wacom *wacom1, *wacom2;
1145 struct wacom_wac *wacom_wac1, *wacom_wac2;
1146 int error;
1149 * Regardless if this is a disconnect or a new tablet,
1150 * remove any existing input and battery devices.
1153 wacom_destroy_battery(wacom);
1155 /* Stylus interface */
1156 wacom1 = usb_get_intfdata(usbdev->config->interface[1]);
1157 wacom_wac1 = &(wacom1->wacom_wac);
1158 if (wacom_wac1->input)
1159 input_unregister_device(wacom_wac1->input);
1160 wacom_wac1->input = NULL;
1162 /* Touch interface */
1163 wacom2 = usb_get_intfdata(usbdev->config->interface[2]);
1164 wacom_wac2 = &(wacom2->wacom_wac);
1165 if (wacom_wac2->input)
1166 input_unregister_device(wacom_wac2->input);
1167 wacom_wac2->input = NULL;
1169 if (wacom_wac->pid == 0) {
1170 dev_info(&wacom->intf->dev, "wireless tablet disconnected\n");
1171 } else {
1172 const struct usb_device_id *id = wacom_ids;
1174 dev_info(&wacom->intf->dev,
1175 "wireless tablet connected with PID %x\n",
1176 wacom_wac->pid);
1178 while (id->match_flags) {
1179 if (id->idVendor == USB_VENDOR_ID_WACOM &&
1180 id->idProduct == wacom_wac->pid)
1181 break;
1182 id++;
1185 if (!id->match_flags) {
1186 dev_info(&wacom->intf->dev,
1187 "ignoring unknown PID.\n");
1188 return;
1191 /* Stylus interface */
1192 wacom_wac1->features =
1193 *((struct wacom_features *)id->driver_info);
1194 wacom_wac1->features.device_type = BTN_TOOL_PEN;
1195 snprintf(wacom_wac1->name, WACOM_NAME_MAX, "%s (WL) Pen",
1196 wacom_wac1->features.name);
1197 error = wacom_register_input(wacom1);
1198 if (error)
1199 goto fail;
1201 /* Touch interface */
1202 if (wacom_wac1->features.touch_max) {
1203 wacom_wac2->features =
1204 *((struct wacom_features *)id->driver_info);
1205 wacom_wac2->features.pktlen = WACOM_PKGLEN_BBTOUCH3;
1206 wacom_wac2->features.device_type = BTN_TOOL_FINGER;
1207 wacom_wac2->features.x_max = wacom_wac2->features.y_max = 4096;
1208 if (wacom_wac2->features.touch_max)
1209 snprintf(wacom_wac2->name, WACOM_NAME_MAX,
1210 "%s (WL) Finger",wacom_wac2->features.name);
1211 else
1212 snprintf(wacom_wac2->name, WACOM_NAME_MAX,
1213 "%s (WL) Pad",wacom_wac2->features.name);
1214 error = wacom_register_input(wacom2);
1215 if (error)
1216 goto fail;
1219 error = wacom_initialize_battery(wacom);
1220 if (error)
1221 goto fail;
1224 return;
1226 fail:
1227 if (wacom_wac2->input) {
1228 input_unregister_device(wacom_wac2->input);
1229 wacom_wac2->input = NULL;
1232 if (wacom_wac1->input) {
1233 input_unregister_device(wacom_wac1->input);
1234 wacom_wac1->input = NULL;
1236 return;
1240 * Not all devices report physical dimensions from HID.
1241 * Compute the default from hardcoded logical dimension
1242 * and resolution before driver overwrites them.
1244 static void wacom_set_default_phy(struct wacom_features *features)
1246 if (features->x_resolution) {
1247 features->x_phy = (features->x_max * 100) /
1248 features->x_resolution;
1249 features->y_phy = (features->y_max * 100) /
1250 features->y_resolution;
1254 static void wacom_calculate_res(struct wacom_features *features)
1256 features->x_resolution = wacom_calc_hid_res(features->x_max,
1257 features->x_phy,
1258 features->unit,
1259 features->unitExpo);
1260 features->y_resolution = wacom_calc_hid_res(features->y_max,
1261 features->y_phy,
1262 features->unit,
1263 features->unitExpo);
1266 static int wacom_probe(struct usb_interface *intf, const struct usb_device_id *id)
1268 struct usb_device *dev = interface_to_usbdev(intf);
1269 struct usb_endpoint_descriptor *endpoint;
1270 struct wacom *wacom;
1271 struct wacom_wac *wacom_wac;
1272 struct wacom_features *features;
1273 int error;
1275 if (!id->driver_info)
1276 return -EINVAL;
1278 wacom = kzalloc(sizeof(struct wacom), GFP_KERNEL);
1279 if (!wacom)
1280 return -ENOMEM;
1282 wacom_wac = &wacom->wacom_wac;
1283 wacom_wac->features = *((struct wacom_features *)id->driver_info);
1284 features = &wacom_wac->features;
1285 if (features->pktlen > WACOM_PKGLEN_MAX) {
1286 error = -EINVAL;
1287 goto fail1;
1290 wacom_wac->data = usb_alloc_coherent(dev, WACOM_PKGLEN_MAX,
1291 GFP_KERNEL, &wacom->data_dma);
1292 if (!wacom_wac->data) {
1293 error = -ENOMEM;
1294 goto fail1;
1297 wacom->irq = usb_alloc_urb(0, GFP_KERNEL);
1298 if (!wacom->irq) {
1299 error = -ENOMEM;
1300 goto fail2;
1303 wacom->usbdev = dev;
1304 wacom->intf = intf;
1305 mutex_init(&wacom->lock);
1306 INIT_WORK(&wacom->work, wacom_wireless_work);
1307 usb_make_path(dev, wacom->phys, sizeof(wacom->phys));
1308 strlcat(wacom->phys, "/input0", sizeof(wacom->phys));
1310 endpoint = &intf->cur_altsetting->endpoint[0].desc;
1312 /* set the default size in case we do not get them from hid */
1313 wacom_set_default_phy(features);
1315 /* Retrieve the physical and logical size for touch devices */
1316 error = wacom_retrieve_hid_descriptor(intf, features);
1317 if (error)
1318 goto fail3;
1321 * Intuos5 has no useful data about its touch interface in its
1322 * HID descriptor. If this is the touch interface (wMaxPacketSize
1323 * of WACOM_PKGLEN_BBTOUCH3), override the table values.
1325 if (features->type >= INTUOS5S && features->type <= INTUOSPL) {
1326 if (endpoint->wMaxPacketSize == WACOM_PKGLEN_BBTOUCH3) {
1327 features->device_type = BTN_TOOL_FINGER;
1328 features->pktlen = WACOM_PKGLEN_BBTOUCH3;
1330 features->x_max = 4096;
1331 features->y_max = 4096;
1332 } else {
1333 features->device_type = BTN_TOOL_PEN;
1337 wacom_setup_device_quirks(features);
1339 /* set unit to "100th of a mm" for devices not reported by HID */
1340 if (!features->unit) {
1341 features->unit = 0x11;
1342 features->unitExpo = 16 - 3;
1344 wacom_calculate_res(features);
1346 strlcpy(wacom_wac->name, features->name, sizeof(wacom_wac->name));
1348 if (features->quirks & WACOM_QUIRK_MULTI_INPUT) {
1349 struct usb_device *other_dev;
1351 /* Append the device type to the name */
1352 if (features->device_type != BTN_TOOL_FINGER)
1353 strlcat(wacom_wac->name, " Pen", WACOM_NAME_MAX);
1354 else if (features->touch_max)
1355 strlcat(wacom_wac->name, " Finger", WACOM_NAME_MAX);
1356 else
1357 strlcat(wacom_wac->name, " Pad", WACOM_NAME_MAX);
1359 other_dev = wacom_get_sibling(dev, features->oVid, features->oPid);
1360 if (other_dev == NULL || wacom_get_usbdev_data(other_dev) == NULL)
1361 other_dev = dev;
1362 error = wacom_add_shared_data(wacom_wac, other_dev);
1363 if (error)
1364 goto fail3;
1367 usb_fill_int_urb(wacom->irq, dev,
1368 usb_rcvintpipe(dev, endpoint->bEndpointAddress),
1369 wacom_wac->data, features->pktlen,
1370 wacom_sys_irq, wacom, endpoint->bInterval);
1371 wacom->irq->transfer_dma = wacom->data_dma;
1372 wacom->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1374 error = wacom_initialize_leds(wacom);
1375 if (error)
1376 goto fail4;
1378 if (!(features->quirks & WACOM_QUIRK_NO_INPUT)) {
1379 error = wacom_register_input(wacom);
1380 if (error)
1381 goto fail5;
1384 /* Note that if query fails it is not a hard failure */
1385 wacom_query_tablet_data(intf, features);
1387 usb_set_intfdata(intf, wacom);
1389 if (features->quirks & WACOM_QUIRK_MONITOR) {
1390 if (usb_submit_urb(wacom->irq, GFP_KERNEL)) {
1391 error = -EIO;
1392 goto fail5;
1396 return 0;
1398 fail5: wacom_destroy_leds(wacom);
1399 fail4: wacom_remove_shared_data(wacom_wac);
1400 fail3: usb_free_urb(wacom->irq);
1401 fail2: usb_free_coherent(dev, WACOM_PKGLEN_MAX, wacom_wac->data, wacom->data_dma);
1402 fail1: kfree(wacom);
1403 return error;
1406 static void wacom_disconnect(struct usb_interface *intf)
1408 struct wacom *wacom = usb_get_intfdata(intf);
1410 usb_set_intfdata(intf, NULL);
1412 usb_kill_urb(wacom->irq);
1413 cancel_work_sync(&wacom->work);
1414 if (wacom->wacom_wac.input)
1415 input_unregister_device(wacom->wacom_wac.input);
1416 wacom_destroy_battery(wacom);
1417 wacom_destroy_leds(wacom);
1418 usb_free_urb(wacom->irq);
1419 usb_free_coherent(interface_to_usbdev(intf), WACOM_PKGLEN_MAX,
1420 wacom->wacom_wac.data, wacom->data_dma);
1421 wacom_remove_shared_data(&wacom->wacom_wac);
1422 kfree(wacom);
1425 static int wacom_suspend(struct usb_interface *intf, pm_message_t message)
1427 struct wacom *wacom = usb_get_intfdata(intf);
1429 mutex_lock(&wacom->lock);
1430 usb_kill_urb(wacom->irq);
1431 mutex_unlock(&wacom->lock);
1433 return 0;
1436 static int wacom_resume(struct usb_interface *intf)
1438 struct wacom *wacom = usb_get_intfdata(intf);
1439 struct wacom_features *features = &wacom->wacom_wac.features;
1440 int rv = 0;
1442 mutex_lock(&wacom->lock);
1444 /* switch to wacom mode first */
1445 wacom_query_tablet_data(intf, features);
1446 wacom_led_control(wacom);
1448 if ((wacom->open || (features->quirks & WACOM_QUIRK_MONITOR)) &&
1449 usb_submit_urb(wacom->irq, GFP_NOIO) < 0)
1450 rv = -EIO;
1452 mutex_unlock(&wacom->lock);
1454 return rv;
1457 static int wacom_reset_resume(struct usb_interface *intf)
1459 return wacom_resume(intf);
1462 static struct usb_driver wacom_driver = {
1463 .name = "wacom",
1464 .id_table = wacom_ids,
1465 .probe = wacom_probe,
1466 .disconnect = wacom_disconnect,
1467 .suspend = wacom_suspend,
1468 .resume = wacom_resume,
1469 .reset_resume = wacom_reset_resume,
1470 .supports_autosuspend = 1,
1473 module_usb_driver(wacom_driver);