Input: wacom - support EMR and MFT sensors of Cintiq Companion Hybrid
[deliverable/linux.git] / drivers / input / tablet / wacom_sys.c
1 /*
2 * drivers/input/tablet/wacom_sys.c
3 *
4 * USB Wacom tablet support - system specific code
5 */
6
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.
12 */
13
14 #include "wacom_wac.h"
15 #include "wacom.h"
16
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
35
36 enum {
37 WCM_UNDEFINED = 0,
38 WCM_DESKTOP,
39 WCM_DIGITIZER,
40 };
41
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));
50
51 /* defines to get/set USB message */
52 #define USB_REQ_GET_REPORT 0x01
53 #define USB_REQ_SET_REPORT 0x09
54
55 #define WAC_HID_FEATURE_REPORT 0x03
56 #define WAC_MSG_RETRIES 5
57
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
62
63 static int wacom_get_report(struct usb_interface *intf, u8 type, u8 id,
64 void *buf, size_t size, unsigned int retries)
65 {
66 struct usb_device *dev = interface_to_usbdev(intf);
67 int retval;
68
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);
78
79 return retval;
80 }
81
82 static int wacom_set_report(struct usb_interface *intf, u8 type, u8 id,
83 void *buf, size_t size, unsigned int retries)
84 {
85 struct usb_device *dev = interface_to_usbdev(intf);
86 int retval;
87
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);
96
97 return retval;
98 }
99
100 static void wacom_sys_irq(struct urb *urb)
101 {
102 struct wacom *wacom = urb->context;
103 struct device *dev = &wacom->intf->dev;
104 int retval;
105
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;
121 }
122
123 wacom_wac_irq(&wacom->wacom_wac, urb->actual_length);
124
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);
131 }
132
133 static int wacom_open(struct input_dev *dev)
134 {
135 struct wacom *wacom = input_get_drvdata(dev);
136 int retval = 0;
137
138 if (usb_autopm_get_interface(wacom->intf) < 0)
139 return -EIO;
140
141 mutex_lock(&wacom->lock);
142
143 if (usb_submit_urb(wacom->irq, GFP_KERNEL)) {
144 retval = -EIO;
145 goto out;
146 }
147
148 wacom->open = true;
149 wacom->intf->needs_remote_wakeup = 1;
150
151 out:
152 mutex_unlock(&wacom->lock);
153 usb_autopm_put_interface(wacom->intf);
154 return retval;
155 }
156
157 static void wacom_close(struct input_dev *dev)
158 {
159 struct wacom *wacom = input_get_drvdata(dev);
160 int autopm_error;
161
162 autopm_error = usb_autopm_get_interface(wacom->intf);
163
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);
169
170 if (!autopm_error)
171 usb_autopm_put_interface(wacom->intf);
172 }
173
174 /*
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.
177 */
178 static int wacom_calc_hid_res(int logical_extents, int physical_extents,
179 unsigned char unit, unsigned char exponent)
180 {
181 int prev, unit_exponent;
182
183 /* Check if the extents are sane */
184 if (logical_extents <= 0 || physical_extents <= 0)
185 return 0;
186
187 /* Get signed value of nybble-sized twos-compliment exponent */
188 unit_exponent = exponent;
189 if (unit_exponent > 7)
190 unit_exponent -= 16;
191
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;
203 }
204
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;
211 }
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;
218 }
219
220 /* Calculate resolution */
221 return logical_extents / physical_extents;
222 }
223
224 static int wacom_parse_logical_collection(unsigned char *report,
225 struct wacom_features *features)
226 {
227 int length = 0;
228
229 if (features->type == BAMBOO_PT) {
230
231 /* Logical collection is only used by 3rd gen Bamboo Touch */
232 features->pktlen = WACOM_PKGLEN_BBTOUCH3;
233 features->device_type = BTN_TOOL_FINGER;
234
235 features->x_max = features->y_max =
236 get_unaligned_le16(&report[10]);
237
238 length = 11;
239 }
240 return length;
241 }
242
243 static void wacom_retrieve_report_data(struct usb_interface *intf,
244 struct wacom_features *features)
245 {
246 int result = 0;
247 unsigned char *rep_data;
248
249 rep_data = kmalloc(2, GFP_KERNEL);
250 if (rep_data) {
251
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);
256
257 if (result >= 0 && rep_data[1] > 2)
258 features->touch_max = rep_data[1];
259
260 kfree(rep_data);
261 }
262 }
263
264 /*
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.
269 *
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.
275 *
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.
279 *
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.
286 *
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.
292 *
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.
296 *
297 * Intuos5 touch interface does not contain useful data. We deal with
298 * this after returning from this function.
299 */
300 static int wacom_parse_hid(struct usb_interface *intf,
301 struct hid_descriptor *hid_desc,
302 struct wacom_features *features)
303 {
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;
310
311 report = kzalloc(hid_desc->wDescriptorLength, GFP_KERNEL);
312 if (!report)
313 return -ENOMEM;
314
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);
326
327 /* No need to parse the Descriptor. It isn't an error though */
328 if (result < 0)
329 goto out;
330
331 for (i = 0; i < hid_desc->wDescriptorLength; i++) {
332
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;
340
341 case HID_USAGE_PAGE_DESKTOP:
342 usage = WCM_DESKTOP;
343 i++;
344 break;
345 }
346 break;
347
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
355 switch (features->type) {
356 case TABLETPC2FG:
357 features->pktlen = WACOM_PKGLEN_TPC2FG;
358 break;
359
360 case MTSCREEN:
361 case WACOM_24HDT:
362 features->pktlen = WACOM_PKGLEN_MTOUCH;
363 break;
364
365 case MTTPC:
366 features->pktlen = WACOM_PKGLEN_MTTPC;
367 break;
368
369 case BAMBOO_PT:
370 features->pktlen = WACOM_PKGLEN_BBTOUCH;
371 break;
372
373 default:
374 features->pktlen = WACOM_PKGLEN_GRAPHIRE;
375 break;
376 }
377
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;
386
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;
396
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;
406 }
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;
415 }
416 }
417 break;
418
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;
432
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;
440
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;
448
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;
456 }
457 } else if (pen) {
458 features->y_max =
459 get_unaligned_le16(&report[i + 3]);
460 i += 4;
461 }
462 }
463 break;
464
465 case HID_USAGE_FINGER:
466 finger = 1;
467 i++;
468 break;
469
470 /*
471 * Requiring Stylus Usage will ignore boot mouse
472 * X/Y values and some cases of invalid Digitizer X/Y
473 * values commonly reported.
474 */
475 case HID_USAGE_STYLUS:
476 pen = 1;
477 i++;
478 break;
479
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;
486 }
487 break;
488
489 case HID_COLLECTION_END:
490 /* reset UsagePage and Finger */
491 finger = usage = 0;
492 break;
493
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;
501 }
502 break;
503 }
504 }
505
506 out:
507 result = 0;
508 kfree(report);
509 return result;
510 }
511
512 static int wacom_set_device_mode(struct usb_interface *intf, int report_id, int length, int mode)
513 {
514 unsigned char *rep_data;
515 int error = -ENOMEM, limit = 0;
516
517 rep_data = kzalloc(length, GFP_KERNEL);
518 if (!rep_data)
519 return error;
520
521 do {
522 rep_data[0] = report_id;
523 rep_data[1] = mode;
524
525 error = wacom_set_report(intf, WAC_HID_FEATURE_REPORT,
526 report_id, rep_data, length, 1);
527 if (error >= 0)
528 error = wacom_get_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);
531
532 kfree(rep_data);
533
534 return error < 0 ? error : 0;
535 }
536
537 /*
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.
543 */
544 static int wacom_query_tablet_data(struct usb_interface *intf, struct wacom_features *features)
545 {
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);
550 }
551 else if (features->type == WACOM_24HDT || features->type == CINTIQ_HYBRID) {
552 return wacom_set_device_mode(intf, 18, 3, 2);
553 }
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);
557 }
558 }
559
560 return 0;
561 }
562
563 static int wacom_retrieve_hid_descriptor(struct usb_interface *intf,
564 struct wacom_features *features)
565 {
566 int error = 0;
567 struct usb_host_interface *interface = intf->cur_altsetting;
568 struct hid_descriptor *hid_desc;
569
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;
576
577 /*
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.
582 */
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;
589 }
590 }
591
592 /* only devices that support touch need to retrieve the info */
593 if (features->type < BAMBOO_PT) {
594 goto out;
595 }
596
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;
605 }
606 }
607 error = wacom_parse_hid(intf, hid_desc, features);
608
609 out:
610 return error;
611 }
612
613 struct wacom_usbdev_data {
614 struct list_head list;
615 struct kref kref;
616 struct usb_device *dev;
617 struct wacom_shared shared;
618 };
619
620 static LIST_HEAD(wacom_udev_list);
621 static DEFINE_MUTEX(wacom_udev_list_lock);
622
623 static struct usb_device *wacom_get_sibling(struct usb_device *dev, int vendor, int product)
624 {
625 int port1;
626 struct usb_device *sibling;
627
628 if (vendor == 0 && product == 0)
629 return dev;
630
631 if (dev->parent == NULL)
632 return NULL;
633
634 usb_hub_for_each_child(dev->parent, port1, sibling) {
635 struct usb_device_descriptor *d;
636 if (sibling == NULL)
637 continue;
638
639 d = &sibling->descriptor;
640 if (d->idVendor == vendor && d->idProduct == product)
641 return sibling;
642 }
643
644 return NULL;
645 }
646
647 static struct wacom_usbdev_data *wacom_get_usbdev_data(struct usb_device *dev)
648 {
649 struct wacom_usbdev_data *data;
650
651 list_for_each_entry(data, &wacom_udev_list, list) {
652 if (data->dev == dev) {
653 kref_get(&data->kref);
654 return data;
655 }
656 }
657
658 return NULL;
659 }
660
661 static int wacom_add_shared_data(struct wacom_wac *wacom,
662 struct usb_device *dev)
663 {
664 struct wacom_usbdev_data *data;
665 int retval = 0;
666
667 mutex_lock(&wacom_udev_list_lock);
668
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;
675 }
676
677 kref_init(&data->kref);
678 data->dev = dev;
679 list_add_tail(&data->list, &wacom_udev_list);
680 }
681
682 wacom->shared = &data->shared;
683
684 out:
685 mutex_unlock(&wacom_udev_list_lock);
686 return retval;
687 }
688
689 static void wacom_release_shared_data(struct kref *kref)
690 {
691 struct wacom_usbdev_data *data =
692 container_of(kref, struct wacom_usbdev_data, kref);
693
694 mutex_lock(&wacom_udev_list_lock);
695 list_del(&data->list);
696 mutex_unlock(&wacom_udev_list_lock);
697
698 kfree(data);
699 }
700
701 static void wacom_remove_shared_data(struct wacom_wac *wacom)
702 {
703 struct wacom_usbdev_data *data;
704
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;
709 }
710 }
711
712 static int wacom_led_control(struct wacom *wacom)
713 {
714 unsigned char *buf;
715 int retval;
716
717 buf = kzalloc(9, GFP_KERNEL);
718 if (!buf)
719 return -ENOMEM;
720
721 if (wacom->wacom_wac.features.type >= INTUOS5S &&
722 wacom->wacom_wac.features.type <= INTUOS5L) {
723 /*
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
727 */
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;
731
732 buf[0] = WAC_CMD_LED_CONTROL;
733 buf[1] = (crop_lum << 4) | (ring_lum << 2) | (ring_led);
734 }
735 else {
736 int led = wacom->led.select[0] | 0x4;
737
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;
741
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;
747 }
748
749 retval = wacom_set_report(wacom->intf, 0x03, WAC_CMD_LED_CONTROL,
750 buf, 9, WAC_CMD_RETRIES);
751 kfree(buf);
752
753 return retval;
754 }
755
756 static int wacom_led_putimage(struct wacom *wacom, int button_id, const void *img)
757 {
758 unsigned char *buf;
759 int i, retval;
760
761 buf = kzalloc(259, GFP_KERNEL);
762 if (!buf)
763 return -ENOMEM;
764
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;
772
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);
778
779 retval = wacom_set_report(wacom->intf, 0x03, WAC_CMD_ICON_XFER,
780 buf, 259, WAC_CMD_RETRIES);
781 if (retval < 0)
782 break;
783 }
784
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);
790
791 out:
792 kfree(buf);
793 return retval;
794 }
795
796 static ssize_t wacom_led_select_store(struct device *dev, int set_id,
797 const char *buf, size_t count)
798 {
799 struct wacom *wacom = dev_get_drvdata(dev);
800 unsigned int id;
801 int err;
802
803 err = kstrtouint(buf, 10, &id);
804 if (err)
805 return err;
806
807 mutex_lock(&wacom->lock);
808
809 wacom->led.select[set_id] = id & 0x3;
810 err = wacom_led_control(wacom);
811
812 mutex_unlock(&wacom->lock);
813
814 return err < 0 ? err : count;
815 }
816
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) \
820 { \
821 return wacom_led_select_store(dev, SET_ID, buf, count); \
822 } \
823 static ssize_t wacom_led##SET_ID##_select_show(struct device *dev, \
824 struct device_attribute *attr, char *buf) \
825 { \
826 struct wacom *wacom = dev_get_drvdata(dev); \
827 return snprintf(buf, 2, "%d\n", wacom->led.select[SET_ID]); \
828 } \
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)
832
833 DEVICE_LED_SELECT_ATTR(0);
834 DEVICE_LED_SELECT_ATTR(1);
835
836 static ssize_t wacom_luminance_store(struct wacom *wacom, u8 *dest,
837 const char *buf, size_t count)
838 {
839 unsigned int value;
840 int err;
841
842 err = kstrtouint(buf, 10, &value);
843 if (err)
844 return err;
845
846 mutex_lock(&wacom->lock);
847
848 *dest = value & 0x7f;
849 err = wacom_led_control(wacom);
850
851 mutex_unlock(&wacom->lock);
852
853 return err < 0 ? err : count;
854 }
855
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) \
859 { \
860 struct wacom *wacom = dev_get_drvdata(dev); \
861 \
862 return wacom_luminance_store(wacom, &wacom->led.field, \
863 buf, count); \
864 } \
865 static DEVICE_ATTR(name##_luminance, S_IWUSR, \
866 NULL, wacom_##name##_luminance_store)
867
868 DEVICE_LUMINANCE_ATTR(status0, llv);
869 DEVICE_LUMINANCE_ATTR(status1, hlv);
870 DEVICE_LUMINANCE_ATTR(buttons, img_lum);
871
872 static ssize_t wacom_button_image_store(struct device *dev, int button_id,
873 const char *buf, size_t count)
874 {
875 struct wacom *wacom = dev_get_drvdata(dev);
876 int err;
877
878 if (count != 1024)
879 return -EINVAL;
880
881 mutex_lock(&wacom->lock);
882
883 err = wacom_led_putimage(wacom, button_id, buf);
884
885 mutex_unlock(&wacom->lock);
886
887 return err < 0 ? err : count;
888 }
889
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) \
893 { \
894 return wacom_button_image_store(dev, BUTTON_ID, buf, count); \
895 } \
896 static DEVICE_ATTR(button##BUTTON_ID##_rawimg, S_IWUSR, \
897 NULL, wacom_btnimg##BUTTON_ID##_store)
898
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);
907
908 static struct attribute *cintiq_led_attrs[] = {
909 &dev_attr_status_led0_select.attr,
910 &dev_attr_status_led1_select.attr,
911 NULL
912 };
913
914 static struct attribute_group cintiq_led_attr_group = {
915 .name = "wacom_led",
916 .attrs = cintiq_led_attrs,
917 };
918
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
933 };
934
935 static struct attribute_group intuos4_led_attr_group = {
936 .name = "wacom_led",
937 .attrs = intuos4_led_attrs,
938 };
939
940 static struct attribute *intuos5_led_attrs[] = {
941 &dev_attr_status0_luminance.attr,
942 &dev_attr_status_led0_select.attr,
943 NULL
944 };
945
946 static struct attribute_group intuos5_led_attr_group = {
947 .name = "wacom_led",
948 .attrs = intuos5_led_attrs,
949 };
950
951 static int wacom_initialize_leds(struct wacom *wacom)
952 {
953 int error;
954
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;
968
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;
976
977 error = sysfs_create_group(&wacom->intf->dev.kobj,
978 &cintiq_led_attr_group);
979 break;
980
981 case INTUOS5S:
982 case INTUOS5:
983 case INTUOS5L:
984 wacom->led.select[0] = 0;
985 wacom->led.select[1] = 0;
986 wacom->led.llv = 32;
987 wacom->led.hlv = 0;
988 wacom->led.img_lum = 0;
989
990 error = sysfs_create_group(&wacom->intf->dev.kobj,
991 &intuos5_led_attr_group);
992 break;
993
994 default:
995 return 0;
996 }
997
998 if (error) {
999 dev_err(&wacom->intf->dev,
1000 "cannot create sysfs group err: %d\n", error);
1001 return error;
1002 }
1003 wacom_led_control(wacom);
1004
1005 return 0;
1006 }
1007
1008 static void wacom_destroy_leds(struct wacom *wacom)
1009 {
1010 switch (wacom->wacom_wac.features.type) {
1011 case INTUOS4S:
1012 case INTUOS4:
1013 case INTUOS4L:
1014 sysfs_remove_group(&wacom->intf->dev.kobj,
1015 &intuos4_led_attr_group);
1016 break;
1017
1018 case WACOM_24HD:
1019 case WACOM_21UX2:
1020 sysfs_remove_group(&wacom->intf->dev.kobj,
1021 &cintiq_led_attr_group);
1022 break;
1023
1024 case INTUOS5S:
1025 case INTUOS5:
1026 case INTUOS5L:
1027 sysfs_remove_group(&wacom->intf->dev.kobj,
1028 &intuos5_led_attr_group);
1029 break;
1030 }
1031 }
1032
1033 static enum power_supply_property wacom_battery_props[] = {
1034 POWER_SUPPLY_PROP_CAPACITY
1035 };
1036
1037 static int wacom_battery_get_property(struct power_supply *psy,
1038 enum power_supply_property psp,
1039 union power_supply_propval *val)
1040 {
1041 struct wacom *wacom = container_of(psy, struct wacom, battery);
1042 int ret = 0;
1043
1044 switch (psp) {
1045 case POWER_SUPPLY_PROP_CAPACITY:
1046 val->intval =
1047 wacom->wacom_wac.battery_capacity * 100 / 31;
1048 break;
1049 default:
1050 ret = -EINVAL;
1051 break;
1052 }
1053
1054 return ret;
1055 }
1056
1057 static int wacom_initialize_battery(struct wacom *wacom)
1058 {
1059 int error = 0;
1060
1061 if (wacom->wacom_wac.features.quirks & WACOM_QUIRK_MONITOR) {
1062 wacom->battery.properties = wacom_battery_props;
1063 wacom->battery.num_properties = ARRAY_SIZE(wacom_battery_props);
1064 wacom->battery.get_property = wacom_battery_get_property;
1065 wacom->battery.name = "wacom_battery";
1066 wacom->battery.type = POWER_SUPPLY_TYPE_BATTERY;
1067 wacom->battery.use_for_apm = 0;
1068
1069 error = power_supply_register(&wacom->usbdev->dev,
1070 &wacom->battery);
1071
1072 if (!error)
1073 power_supply_powers(&wacom->battery,
1074 &wacom->usbdev->dev);
1075 }
1076
1077 return error;
1078 }
1079
1080 static void wacom_destroy_battery(struct wacom *wacom)
1081 {
1082 if (wacom->wacom_wac.features.quirks & WACOM_QUIRK_MONITOR &&
1083 wacom->battery.dev) {
1084 power_supply_unregister(&wacom->battery);
1085 wacom->battery.dev = NULL;
1086 }
1087 }
1088
1089 static int wacom_register_input(struct wacom *wacom)
1090 {
1091 struct input_dev *input_dev;
1092 struct usb_interface *intf = wacom->intf;
1093 struct usb_device *dev = interface_to_usbdev(intf);
1094 struct wacom_wac *wacom_wac = &(wacom->wacom_wac);
1095 int error;
1096
1097 input_dev = input_allocate_device();
1098 if (!input_dev) {
1099 error = -ENOMEM;
1100 goto fail1;
1101 }
1102
1103 input_dev->name = wacom_wac->name;
1104 input_dev->dev.parent = &intf->dev;
1105 input_dev->open = wacom_open;
1106 input_dev->close = wacom_close;
1107 usb_to_input_id(dev, &input_dev->id);
1108 input_set_drvdata(input_dev, wacom);
1109
1110 wacom_wac->input = input_dev;
1111 error = wacom_setup_input_capabilities(input_dev, wacom_wac);
1112 if (error)
1113 goto fail1;
1114
1115 error = input_register_device(input_dev);
1116 if (error)
1117 goto fail2;
1118
1119 return 0;
1120
1121 fail2:
1122 input_free_device(input_dev);
1123 wacom_wac->input = NULL;
1124 fail1:
1125 return error;
1126 }
1127
1128 static void wacom_wireless_work(struct work_struct *work)
1129 {
1130 struct wacom *wacom = container_of(work, struct wacom, work);
1131 struct usb_device *usbdev = wacom->usbdev;
1132 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
1133 struct wacom *wacom1, *wacom2;
1134 struct wacom_wac *wacom_wac1, *wacom_wac2;
1135 int error;
1136
1137 /*
1138 * Regardless if this is a disconnect or a new tablet,
1139 * remove any existing input and battery devices.
1140 */
1141
1142 wacom_destroy_battery(wacom);
1143
1144 /* Stylus interface */
1145 wacom1 = usb_get_intfdata(usbdev->config->interface[1]);
1146 wacom_wac1 = &(wacom1->wacom_wac);
1147 if (wacom_wac1->input)
1148 input_unregister_device(wacom_wac1->input);
1149 wacom_wac1->input = NULL;
1150
1151 /* Touch interface */
1152 wacom2 = usb_get_intfdata(usbdev->config->interface[2]);
1153 wacom_wac2 = &(wacom2->wacom_wac);
1154 if (wacom_wac2->input)
1155 input_unregister_device(wacom_wac2->input);
1156 wacom_wac2->input = NULL;
1157
1158 if (wacom_wac->pid == 0) {
1159 dev_info(&wacom->intf->dev, "wireless tablet disconnected\n");
1160 } else {
1161 const struct usb_device_id *id = wacom_ids;
1162
1163 dev_info(&wacom->intf->dev,
1164 "wireless tablet connected with PID %x\n",
1165 wacom_wac->pid);
1166
1167 while (id->match_flags) {
1168 if (id->idVendor == USB_VENDOR_ID_WACOM &&
1169 id->idProduct == wacom_wac->pid)
1170 break;
1171 id++;
1172 }
1173
1174 if (!id->match_flags) {
1175 dev_info(&wacom->intf->dev,
1176 "ignoring unknown PID.\n");
1177 return;
1178 }
1179
1180 /* Stylus interface */
1181 wacom_wac1->features =
1182 *((struct wacom_features *)id->driver_info);
1183 wacom_wac1->features.device_type = BTN_TOOL_PEN;
1184 error = wacom_register_input(wacom1);
1185 if (error)
1186 goto fail1;
1187
1188 /* Touch interface */
1189 wacom_wac2->features =
1190 *((struct wacom_features *)id->driver_info);
1191 wacom_wac2->features.pktlen = WACOM_PKGLEN_BBTOUCH3;
1192 wacom_wac2->features.device_type = BTN_TOOL_FINGER;
1193 wacom_wac2->features.x_max = wacom_wac2->features.y_max = 4096;
1194 error = wacom_register_input(wacom2);
1195 if (error)
1196 goto fail2;
1197
1198 error = wacom_initialize_battery(wacom);
1199 if (error)
1200 goto fail3;
1201 }
1202
1203 return;
1204
1205 fail3:
1206 input_unregister_device(wacom_wac2->input);
1207 wacom_wac2->input = NULL;
1208 fail2:
1209 input_unregister_device(wacom_wac1->input);
1210 wacom_wac1->input = NULL;
1211 fail1:
1212 return;
1213 }
1214
1215 /*
1216 * Not all devices report physical dimensions from HID.
1217 * Compute the default from hardcoded logical dimension
1218 * and resolution before driver overwrites them.
1219 */
1220 static void wacom_set_default_phy(struct wacom_features *features)
1221 {
1222 if (features->x_resolution) {
1223 features->x_phy = (features->x_max * 100) /
1224 features->x_resolution;
1225 features->y_phy = (features->y_max * 100) /
1226 features->y_resolution;
1227 }
1228 }
1229
1230 static void wacom_calculate_res(struct wacom_features *features)
1231 {
1232 features->x_resolution = wacom_calc_hid_res(features->x_max,
1233 features->x_phy,
1234 features->unit,
1235 features->unitExpo);
1236 features->y_resolution = wacom_calc_hid_res(features->y_max,
1237 features->y_phy,
1238 features->unit,
1239 features->unitExpo);
1240 }
1241
1242 static int wacom_probe(struct usb_interface *intf, const struct usb_device_id *id)
1243 {
1244 struct usb_device *dev = interface_to_usbdev(intf);
1245 struct usb_endpoint_descriptor *endpoint;
1246 struct wacom *wacom;
1247 struct wacom_wac *wacom_wac;
1248 struct wacom_features *features;
1249 int error;
1250
1251 if (!id->driver_info)
1252 return -EINVAL;
1253
1254 wacom = kzalloc(sizeof(struct wacom), GFP_KERNEL);
1255 if (!wacom)
1256 return -ENOMEM;
1257
1258 wacom_wac = &wacom->wacom_wac;
1259 wacom_wac->features = *((struct wacom_features *)id->driver_info);
1260 features = &wacom_wac->features;
1261 if (features->pktlen > WACOM_PKGLEN_MAX) {
1262 error = -EINVAL;
1263 goto fail1;
1264 }
1265
1266 wacom_wac->data = usb_alloc_coherent(dev, WACOM_PKGLEN_MAX,
1267 GFP_KERNEL, &wacom->data_dma);
1268 if (!wacom_wac->data) {
1269 error = -ENOMEM;
1270 goto fail1;
1271 }
1272
1273 wacom->irq = usb_alloc_urb(0, GFP_KERNEL);
1274 if (!wacom->irq) {
1275 error = -ENOMEM;
1276 goto fail2;
1277 }
1278
1279 wacom->usbdev = dev;
1280 wacom->intf = intf;
1281 mutex_init(&wacom->lock);
1282 INIT_WORK(&wacom->work, wacom_wireless_work);
1283 usb_make_path(dev, wacom->phys, sizeof(wacom->phys));
1284 strlcat(wacom->phys, "/input0", sizeof(wacom->phys));
1285
1286 endpoint = &intf->cur_altsetting->endpoint[0].desc;
1287
1288 /* set the default size in case we do not get them from hid */
1289 wacom_set_default_phy(features);
1290
1291 /* Retrieve the physical and logical size for touch devices */
1292 error = wacom_retrieve_hid_descriptor(intf, features);
1293 if (error)
1294 goto fail3;
1295
1296 /*
1297 * Intuos5 has no useful data about its touch interface in its
1298 * HID descriptor. If this is the touch interface (wMaxPacketSize
1299 * of WACOM_PKGLEN_BBTOUCH3), override the table values.
1300 */
1301 if (features->type >= INTUOS5S && features->type <= INTUOS5L) {
1302 if (endpoint->wMaxPacketSize == WACOM_PKGLEN_BBTOUCH3) {
1303 features->device_type = BTN_TOOL_FINGER;
1304 features->pktlen = WACOM_PKGLEN_BBTOUCH3;
1305
1306 features->x_max = 4096;
1307 features->y_max = 4096;
1308 } else {
1309 features->device_type = BTN_TOOL_PEN;
1310 }
1311 }
1312
1313 wacom_setup_device_quirks(features);
1314
1315 /* set unit to "100th of a mm" for devices not reported by HID */
1316 if (!features->unit) {
1317 features->unit = 0x11;
1318 features->unitExpo = 16 - 3;
1319 }
1320 wacom_calculate_res(features);
1321
1322 strlcpy(wacom_wac->name, features->name, sizeof(wacom_wac->name));
1323
1324 if (features->quirks & WACOM_QUIRK_MULTI_INPUT) {
1325 struct usb_device *other_dev;
1326
1327 /* Append the device type to the name */
1328 strlcat(wacom_wac->name,
1329 features->device_type == BTN_TOOL_PEN ?
1330 " Pen" : " Finger",
1331 sizeof(wacom_wac->name));
1332
1333 other_dev = wacom_get_sibling(dev, features->oVid, features->oPid);
1334 if (other_dev == NULL || wacom_get_usbdev_data(other_dev) == NULL)
1335 other_dev = dev;
1336 error = wacom_add_shared_data(wacom_wac, other_dev);
1337 if (error)
1338 goto fail3;
1339 }
1340
1341 usb_fill_int_urb(wacom->irq, dev,
1342 usb_rcvintpipe(dev, endpoint->bEndpointAddress),
1343 wacom_wac->data, features->pktlen,
1344 wacom_sys_irq, wacom, endpoint->bInterval);
1345 wacom->irq->transfer_dma = wacom->data_dma;
1346 wacom->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1347
1348 error = wacom_initialize_leds(wacom);
1349 if (error)
1350 goto fail4;
1351
1352 if (!(features->quirks & WACOM_QUIRK_NO_INPUT)) {
1353 error = wacom_register_input(wacom);
1354 if (error)
1355 goto fail5;
1356 }
1357
1358 /* Note that if query fails it is not a hard failure */
1359 wacom_query_tablet_data(intf, features);
1360
1361 usb_set_intfdata(intf, wacom);
1362
1363 if (features->quirks & WACOM_QUIRK_MONITOR) {
1364 if (usb_submit_urb(wacom->irq, GFP_KERNEL)) {
1365 error = -EIO;
1366 goto fail5;
1367 }
1368 }
1369
1370 return 0;
1371
1372 fail5: wacom_destroy_leds(wacom);
1373 fail4: wacom_remove_shared_data(wacom_wac);
1374 fail3: usb_free_urb(wacom->irq);
1375 fail2: usb_free_coherent(dev, WACOM_PKGLEN_MAX, wacom_wac->data, wacom->data_dma);
1376 fail1: kfree(wacom);
1377 return error;
1378 }
1379
1380 static void wacom_disconnect(struct usb_interface *intf)
1381 {
1382 struct wacom *wacom = usb_get_intfdata(intf);
1383
1384 usb_set_intfdata(intf, NULL);
1385
1386 usb_kill_urb(wacom->irq);
1387 cancel_work_sync(&wacom->work);
1388 if (wacom->wacom_wac.input)
1389 input_unregister_device(wacom->wacom_wac.input);
1390 wacom_destroy_battery(wacom);
1391 wacom_destroy_leds(wacom);
1392 usb_free_urb(wacom->irq);
1393 usb_free_coherent(interface_to_usbdev(intf), WACOM_PKGLEN_MAX,
1394 wacom->wacom_wac.data, wacom->data_dma);
1395 wacom_remove_shared_data(&wacom->wacom_wac);
1396 kfree(wacom);
1397 }
1398
1399 static int wacom_suspend(struct usb_interface *intf, pm_message_t message)
1400 {
1401 struct wacom *wacom = usb_get_intfdata(intf);
1402
1403 mutex_lock(&wacom->lock);
1404 usb_kill_urb(wacom->irq);
1405 mutex_unlock(&wacom->lock);
1406
1407 return 0;
1408 }
1409
1410 static int wacom_resume(struct usb_interface *intf)
1411 {
1412 struct wacom *wacom = usb_get_intfdata(intf);
1413 struct wacom_features *features = &wacom->wacom_wac.features;
1414 int rv = 0;
1415
1416 mutex_lock(&wacom->lock);
1417
1418 /* switch to wacom mode first */
1419 wacom_query_tablet_data(intf, features);
1420 wacom_led_control(wacom);
1421
1422 if ((wacom->open || (features->quirks & WACOM_QUIRK_MONITOR)) &&
1423 usb_submit_urb(wacom->irq, GFP_NOIO) < 0)
1424 rv = -EIO;
1425
1426 mutex_unlock(&wacom->lock);
1427
1428 return rv;
1429 }
1430
1431 static int wacom_reset_resume(struct usb_interface *intf)
1432 {
1433 return wacom_resume(intf);
1434 }
1435
1436 static struct usb_driver wacom_driver = {
1437 .name = "wacom",
1438 .id_table = wacom_ids,
1439 .probe = wacom_probe,
1440 .disconnect = wacom_disconnect,
1441 .suspend = wacom_suspend,
1442 .resume = wacom_resume,
1443 .reset_resume = wacom_reset_resume,
1444 .supports_autosuspend = 1,
1445 };
1446
1447 module_usb_driver(wacom_driver);
This page took 0.080827 seconds and 5 git commands to generate.