Loading...
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
36enum {
37 WCM_UNDEFINED = 0,
38 WCM_DESKTOP,
39 WCM_DIGITIZER,
40};
41
42struct 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
63static 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
82static 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
100static 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
133static 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
151out:
152 mutex_unlock(&wacom->lock);
153 usb_autopm_put_interface(wacom->intf);
154 return retval;
155}
156
157static 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 * Static values for max X/Y and resolution of Pen interface is stored in
176 * features. This mean physical size of active area can be computed.
177 * This is useful to do when Pen and Touch have same active area of tablet.
178 * This means for Touch device, we only need to find max X/Y value and we
179 * have enough information to compute resolution of touch.
180 */
181static void wacom_set_phy_from_res(struct wacom_features *features)
182{
183 features->x_phy = (features->x_max * 100) / features->x_resolution;
184 features->y_phy = (features->y_max * 100) / features->y_resolution;
185}
186
187static int wacom_parse_logical_collection(unsigned char *report,
188 struct wacom_features *features)
189{
190 int length = 0;
191
192 if (features->type == BAMBOO_PT) {
193
194 /* Logical collection is only used by 3rd gen Bamboo Touch */
195 features->pktlen = WACOM_PKGLEN_BBTOUCH3;
196 features->device_type = BTN_TOOL_FINGER;
197
198 wacom_set_phy_from_res(features);
199
200 features->x_max = features->y_max =
201 get_unaligned_le16(&report[10]);
202
203 length = 11;
204 }
205 return length;
206}
207
208static void wacom_retrieve_report_data(struct usb_interface *intf,
209 struct wacom_features *features)
210{
211 int result = 0;
212 unsigned char *rep_data;
213
214 rep_data = kmalloc(2, GFP_KERNEL);
215 if (rep_data) {
216
217 rep_data[0] = 12;
218 result = wacom_get_report(intf, WAC_HID_FEATURE_REPORT,
219 rep_data[0], rep_data, 2,
220 WAC_MSG_RETRIES);
221
222 if (result >= 0 && rep_data[1] > 2)
223 features->touch_max = rep_data[1];
224
225 kfree(rep_data);
226 }
227}
228
229/*
230 * Interface Descriptor of wacom devices can be incomplete and
231 * inconsistent so wacom_features table is used to store stylus
232 * device's packet lengths, various maximum values, and tablet
233 * resolution based on product ID's.
234 *
235 * For devices that contain 2 interfaces, wacom_features table is
236 * inaccurate for the touch interface. Since the Interface Descriptor
237 * for touch interfaces has pretty complete data, this function exists
238 * to query tablet for this missing information instead of hard coding in
239 * an additional table.
240 *
241 * A typical Interface Descriptor for a stylus will contain a
242 * boot mouse application collection that is not of interest and this
243 * function will ignore it.
244 *
245 * It also contains a digitizer application collection that also is not
246 * of interest since any information it contains would be duplicate
247 * of what is in wacom_features. Usually it defines a report of an array
248 * of bytes that could be used as max length of the stylus packet returned.
249 * If it happens to define a Digitizer-Stylus Physical Collection then
250 * the X and Y logical values contain valid data but it is ignored.
251 *
252 * A typical Interface Descriptor for a touch interface will contain a
253 * Digitizer-Finger Physical Collection which will define both logical
254 * X/Y maximum as well as the physical size of tablet. Since touch
255 * interfaces haven't supported pressure or distance, this is enough
256 * information to override invalid values in the wacom_features table.
257 *
258 * 3rd gen Bamboo Touch no longer define a Digitizer-Finger Pysical
259 * Collection. Instead they define a Logical Collection with a single
260 * Logical Maximum for both X and Y.
261 *
262 * Intuos5 touch interface does not contain useful data. We deal with
263 * this after returning from this function.
264 */
265static int wacom_parse_hid(struct usb_interface *intf,
266 struct hid_descriptor *hid_desc,
267 struct wacom_features *features)
268{
269 struct usb_device *dev = interface_to_usbdev(intf);
270 char limit = 0;
271 /* result has to be defined as int for some devices */
272 int result = 0;
273 int i = 0, usage = WCM_UNDEFINED, finger = 0, pen = 0;
274 unsigned char *report;
275
276 report = kzalloc(hid_desc->wDescriptorLength, GFP_KERNEL);
277 if (!report)
278 return -ENOMEM;
279
280 /* retrive report descriptors */
281 do {
282 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
283 USB_REQ_GET_DESCRIPTOR,
284 USB_RECIP_INTERFACE | USB_DIR_IN,
285 HID_DEVICET_REPORT << 8,
286 intf->altsetting[0].desc.bInterfaceNumber, /* interface */
287 report,
288 hid_desc->wDescriptorLength,
289 5000); /* 5 secs */
290 } while (result < 0 && limit++ < WAC_MSG_RETRIES);
291
292 /* No need to parse the Descriptor. It isn't an error though */
293 if (result < 0)
294 goto out;
295
296 for (i = 0; i < hid_desc->wDescriptorLength; i++) {
297
298 switch (report[i]) {
299 case HID_USAGE_PAGE:
300 switch (report[i + 1]) {
301 case HID_USAGE_PAGE_DIGITIZER:
302 usage = WCM_DIGITIZER;
303 i++;
304 break;
305
306 case HID_USAGE_PAGE_DESKTOP:
307 usage = WCM_DESKTOP;
308 i++;
309 break;
310 }
311 break;
312
313 case HID_USAGE:
314 switch (report[i + 1]) {
315 case HID_USAGE_X:
316 if (usage == WCM_DESKTOP) {
317 if (finger) {
318 features->device_type = BTN_TOOL_FINGER;
319 if (features->type == TABLETPC2FG) {
320 /* need to reset back */
321 features->pktlen = WACOM_PKGLEN_TPC2FG;
322 }
323
324 if (features->type == MTSCREEN)
325 features->pktlen = WACOM_PKGLEN_MTOUCH;
326
327 if (features->type == BAMBOO_PT) {
328 /* need to reset back */
329 features->pktlen = WACOM_PKGLEN_BBTOUCH;
330 features->x_phy =
331 get_unaligned_le16(&report[i + 5]);
332 features->x_max =
333 get_unaligned_le16(&report[i + 8]);
334 i += 15;
335 } else {
336 features->x_max =
337 get_unaligned_le16(&report[i + 3]);
338 features->x_phy =
339 get_unaligned_le16(&report[i + 6]);
340 features->unit = report[i + 9];
341 features->unitExpo = report[i + 11];
342 i += 12;
343 }
344 } else if (pen) {
345 /* penabled only accepts exact bytes of data */
346 if (features->type == TABLETPC2FG)
347 features->pktlen = WACOM_PKGLEN_GRAPHIRE;
348 features->device_type = BTN_TOOL_PEN;
349 features->x_max =
350 get_unaligned_le16(&report[i + 3]);
351 i += 4;
352 }
353 }
354 break;
355
356 case HID_USAGE_Y:
357 if (usage == WCM_DESKTOP) {
358 if (finger) {
359 int type = features->type;
360
361 if (type == TABLETPC2FG || type == MTSCREEN) {
362 features->y_max =
363 get_unaligned_le16(&report[i + 3]);
364 features->y_phy =
365 get_unaligned_le16(&report[i + 6]);
366 i += 7;
367 } else if (type == BAMBOO_PT) {
368 features->y_phy =
369 get_unaligned_le16(&report[i + 3]);
370 features->y_max =
371 get_unaligned_le16(&report[i + 6]);
372 i += 12;
373 } else {
374 features->y_max =
375 features->x_max;
376 features->y_phy =
377 get_unaligned_le16(&report[i + 3]);
378 i += 4;
379 }
380 } else if (pen) {
381 features->y_max =
382 get_unaligned_le16(&report[i + 3]);
383 i += 4;
384 }
385 }
386 break;
387
388 case HID_USAGE_FINGER:
389 finger = 1;
390 i++;
391 break;
392
393 /*
394 * Requiring Stylus Usage will ignore boot mouse
395 * X/Y values and some cases of invalid Digitizer X/Y
396 * values commonly reported.
397 */
398 case HID_USAGE_STYLUS:
399 pen = 1;
400 i++;
401 break;
402
403 case HID_USAGE_CONTACTMAX:
404 /* leave touch_max as is if predefined */
405 if (!features->touch_max)
406 wacom_retrieve_report_data(intf, features);
407 i++;
408 break;
409 }
410 break;
411
412 case HID_COLLECTION_END:
413 /* reset UsagePage and Finger */
414 finger = usage = 0;
415 break;
416
417 case HID_COLLECTION:
418 i++;
419 switch (report[i]) {
420 case HID_COLLECTION_LOGICAL:
421 i += wacom_parse_logical_collection(&report[i],
422 features);
423 break;
424 }
425 break;
426 }
427 }
428
429 out:
430 result = 0;
431 kfree(report);
432 return result;
433}
434
435static int wacom_query_tablet_data(struct usb_interface *intf, struct wacom_features *features)
436{
437 unsigned char *rep_data;
438 int limit = 0, report_id = 2;
439 int error = -ENOMEM;
440
441 rep_data = kmalloc(4, GFP_KERNEL);
442 if (!rep_data)
443 return error;
444
445 /* ask to report Wacom data */
446 if (features->device_type == BTN_TOOL_FINGER) {
447 /* if it is an MT Tablet PC touch */
448 if (features->type > TABLETPC) {
449 do {
450 rep_data[0] = 3;
451 rep_data[1] = 4;
452 rep_data[2] = 0;
453 rep_data[3] = 0;
454 report_id = 3;
455 error = wacom_set_report(intf,
456 WAC_HID_FEATURE_REPORT,
457 report_id,
458 rep_data, 4, 1);
459 if (error >= 0)
460 error = wacom_get_report(intf,
461 WAC_HID_FEATURE_REPORT,
462 report_id,
463 rep_data, 4, 1);
464 } while ((error < 0 || rep_data[1] != 4) &&
465 limit++ < WAC_MSG_RETRIES);
466 }
467 } else if (features->type <= BAMBOO_PT &&
468 features->type != WIRELESS &&
469 features->device_type == BTN_TOOL_PEN) {
470 do {
471 rep_data[0] = 2;
472 rep_data[1] = 2;
473 error = wacom_set_report(intf, WAC_HID_FEATURE_REPORT,
474 report_id, rep_data, 2, 1);
475 if (error >= 0)
476 error = wacom_get_report(intf,
477 WAC_HID_FEATURE_REPORT,
478 report_id, rep_data, 2, 1);
479 } while ((error < 0 || rep_data[1] != 2) && limit++ < WAC_MSG_RETRIES);
480 }
481
482 kfree(rep_data);
483
484 return error < 0 ? error : 0;
485}
486
487static int wacom_retrieve_hid_descriptor(struct usb_interface *intf,
488 struct wacom_features *features)
489{
490 int error = 0;
491 struct usb_host_interface *interface = intf->cur_altsetting;
492 struct hid_descriptor *hid_desc;
493
494 /* default features */
495 features->device_type = BTN_TOOL_PEN;
496 features->x_fuzz = 4;
497 features->y_fuzz = 4;
498 features->pressure_fuzz = 0;
499 features->distance_fuzz = 0;
500
501 /*
502 * The wireless device HID is basic and layout conflicts with
503 * other tablets (monitor and touch interface can look like pen).
504 * Skip the query for this type and modify defaults based on
505 * interface number.
506 */
507 if (features->type == WIRELESS) {
508 if (intf->cur_altsetting->desc.bInterfaceNumber == 0) {
509 features->device_type = 0;
510 } else if (intf->cur_altsetting->desc.bInterfaceNumber == 2) {
511 features->device_type = BTN_TOOL_DOUBLETAP;
512 features->pktlen = WACOM_PKGLEN_BBTOUCH3;
513 }
514 }
515
516 /* only devices that support touch need to retrieve the info */
517 if (features->type < BAMBOO_PT) {
518 goto out;
519 }
520
521 error = usb_get_extra_descriptor(interface, HID_DEVICET_HID, &hid_desc);
522 if (error) {
523 error = usb_get_extra_descriptor(&interface->endpoint[0],
524 HID_DEVICET_REPORT, &hid_desc);
525 if (error) {
526 dev_err(&intf->dev,
527 "can not retrieve extra class descriptor\n");
528 goto out;
529 }
530 }
531 error = wacom_parse_hid(intf, hid_desc, features);
532 if (error)
533 goto out;
534
535 out:
536 return error;
537}
538
539struct wacom_usbdev_data {
540 struct list_head list;
541 struct kref kref;
542 struct usb_device *dev;
543 struct wacom_shared shared;
544};
545
546static LIST_HEAD(wacom_udev_list);
547static DEFINE_MUTEX(wacom_udev_list_lock);
548
549static struct wacom_usbdev_data *wacom_get_usbdev_data(struct usb_device *dev)
550{
551 struct wacom_usbdev_data *data;
552
553 list_for_each_entry(data, &wacom_udev_list, list) {
554 if (data->dev == dev) {
555 kref_get(&data->kref);
556 return data;
557 }
558 }
559
560 return NULL;
561}
562
563static int wacom_add_shared_data(struct wacom_wac *wacom,
564 struct usb_device *dev)
565{
566 struct wacom_usbdev_data *data;
567 int retval = 0;
568
569 mutex_lock(&wacom_udev_list_lock);
570
571 data = wacom_get_usbdev_data(dev);
572 if (!data) {
573 data = kzalloc(sizeof(struct wacom_usbdev_data), GFP_KERNEL);
574 if (!data) {
575 retval = -ENOMEM;
576 goto out;
577 }
578
579 kref_init(&data->kref);
580 data->dev = dev;
581 list_add_tail(&data->list, &wacom_udev_list);
582 }
583
584 wacom->shared = &data->shared;
585
586out:
587 mutex_unlock(&wacom_udev_list_lock);
588 return retval;
589}
590
591static void wacom_release_shared_data(struct kref *kref)
592{
593 struct wacom_usbdev_data *data =
594 container_of(kref, struct wacom_usbdev_data, kref);
595
596 mutex_lock(&wacom_udev_list_lock);
597 list_del(&data->list);
598 mutex_unlock(&wacom_udev_list_lock);
599
600 kfree(data);
601}
602
603static void wacom_remove_shared_data(struct wacom_wac *wacom)
604{
605 struct wacom_usbdev_data *data;
606
607 if (wacom->shared) {
608 data = container_of(wacom->shared, struct wacom_usbdev_data, shared);
609 kref_put(&data->kref, wacom_release_shared_data);
610 wacom->shared = NULL;
611 }
612}
613
614static int wacom_led_control(struct wacom *wacom)
615{
616 unsigned char *buf;
617 int retval;
618
619 buf = kzalloc(9, GFP_KERNEL);
620 if (!buf)
621 return -ENOMEM;
622
623 if (wacom->wacom_wac.features.type >= INTUOS5S &&
624 wacom->wacom_wac.features.type <= INTUOS5L) {
625 /*
626 * Touch Ring and crop mark LED luminance may take on
627 * one of four values:
628 * 0 = Low; 1 = Medium; 2 = High; 3 = Off
629 */
630 int ring_led = wacom->led.select[0] & 0x03;
631 int ring_lum = (((wacom->led.llv & 0x60) >> 5) - 1) & 0x03;
632 int crop_lum = 0;
633
634 buf[0] = WAC_CMD_LED_CONTROL;
635 buf[1] = (crop_lum << 4) | (ring_lum << 2) | (ring_led);
636 }
637 else {
638 int led = wacom->led.select[0] | 0x4;
639
640 if (wacom->wacom_wac.features.type == WACOM_21UX2 ||
641 wacom->wacom_wac.features.type == WACOM_24HD)
642 led |= (wacom->led.select[1] << 4) | 0x40;
643
644 buf[0] = WAC_CMD_LED_CONTROL;
645 buf[1] = led;
646 buf[2] = wacom->led.llv;
647 buf[3] = wacom->led.hlv;
648 buf[4] = wacom->led.img_lum;
649 }
650
651 retval = wacom_set_report(wacom->intf, 0x03, WAC_CMD_LED_CONTROL,
652 buf, 9, WAC_CMD_RETRIES);
653 kfree(buf);
654
655 return retval;
656}
657
658static int wacom_led_putimage(struct wacom *wacom, int button_id, const void *img)
659{
660 unsigned char *buf;
661 int i, retval;
662
663 buf = kzalloc(259, GFP_KERNEL);
664 if (!buf)
665 return -ENOMEM;
666
667 /* Send 'start' command */
668 buf[0] = WAC_CMD_ICON_START;
669 buf[1] = 1;
670 retval = wacom_set_report(wacom->intf, 0x03, WAC_CMD_ICON_START,
671 buf, 2, WAC_CMD_RETRIES);
672 if (retval < 0)
673 goto out;
674
675 buf[0] = WAC_CMD_ICON_XFER;
676 buf[1] = button_id & 0x07;
677 for (i = 0; i < 4; i++) {
678 buf[2] = i;
679 memcpy(buf + 3, img + i * 256, 256);
680
681 retval = wacom_set_report(wacom->intf, 0x03, WAC_CMD_ICON_XFER,
682 buf, 259, WAC_CMD_RETRIES);
683 if (retval < 0)
684 break;
685 }
686
687 /* Send 'stop' */
688 buf[0] = WAC_CMD_ICON_START;
689 buf[1] = 0;
690 wacom_set_report(wacom->intf, 0x03, WAC_CMD_ICON_START,
691 buf, 2, WAC_CMD_RETRIES);
692
693out:
694 kfree(buf);
695 return retval;
696}
697
698static ssize_t wacom_led_select_store(struct device *dev, int set_id,
699 const char *buf, size_t count)
700{
701 struct wacom *wacom = dev_get_drvdata(dev);
702 unsigned int id;
703 int err;
704
705 err = kstrtouint(buf, 10, &id);
706 if (err)
707 return err;
708
709 mutex_lock(&wacom->lock);
710
711 wacom->led.select[set_id] = id & 0x3;
712 err = wacom_led_control(wacom);
713
714 mutex_unlock(&wacom->lock);
715
716 return err < 0 ? err : count;
717}
718
719#define DEVICE_LED_SELECT_ATTR(SET_ID) \
720static ssize_t wacom_led##SET_ID##_select_store(struct device *dev, \
721 struct device_attribute *attr, const char *buf, size_t count) \
722{ \
723 return wacom_led_select_store(dev, SET_ID, buf, count); \
724} \
725static ssize_t wacom_led##SET_ID##_select_show(struct device *dev, \
726 struct device_attribute *attr, char *buf) \
727{ \
728 struct wacom *wacom = dev_get_drvdata(dev); \
729 return snprintf(buf, 2, "%d\n", wacom->led.select[SET_ID]); \
730} \
731static DEVICE_ATTR(status_led##SET_ID##_select, S_IWUSR | S_IRUSR, \
732 wacom_led##SET_ID##_select_show, \
733 wacom_led##SET_ID##_select_store)
734
735DEVICE_LED_SELECT_ATTR(0);
736DEVICE_LED_SELECT_ATTR(1);
737
738static ssize_t wacom_luminance_store(struct wacom *wacom, u8 *dest,
739 const char *buf, size_t count)
740{
741 unsigned int value;
742 int err;
743
744 err = kstrtouint(buf, 10, &value);
745 if (err)
746 return err;
747
748 mutex_lock(&wacom->lock);
749
750 *dest = value & 0x7f;
751 err = wacom_led_control(wacom);
752
753 mutex_unlock(&wacom->lock);
754
755 return err < 0 ? err : count;
756}
757
758#define DEVICE_LUMINANCE_ATTR(name, field) \
759static ssize_t wacom_##name##_luminance_store(struct device *dev, \
760 struct device_attribute *attr, const char *buf, size_t count) \
761{ \
762 struct wacom *wacom = dev_get_drvdata(dev); \
763 \
764 return wacom_luminance_store(wacom, &wacom->led.field, \
765 buf, count); \
766} \
767static DEVICE_ATTR(name##_luminance, S_IWUSR, \
768 NULL, wacom_##name##_luminance_store)
769
770DEVICE_LUMINANCE_ATTR(status0, llv);
771DEVICE_LUMINANCE_ATTR(status1, hlv);
772DEVICE_LUMINANCE_ATTR(buttons, img_lum);
773
774static ssize_t wacom_button_image_store(struct device *dev, int button_id,
775 const char *buf, size_t count)
776{
777 struct wacom *wacom = dev_get_drvdata(dev);
778 int err;
779
780 if (count != 1024)
781 return -EINVAL;
782
783 mutex_lock(&wacom->lock);
784
785 err = wacom_led_putimage(wacom, button_id, buf);
786
787 mutex_unlock(&wacom->lock);
788
789 return err < 0 ? err : count;
790}
791
792#define DEVICE_BTNIMG_ATTR(BUTTON_ID) \
793static ssize_t wacom_btnimg##BUTTON_ID##_store(struct device *dev, \
794 struct device_attribute *attr, const char *buf, size_t count) \
795{ \
796 return wacom_button_image_store(dev, BUTTON_ID, buf, count); \
797} \
798static DEVICE_ATTR(button##BUTTON_ID##_rawimg, S_IWUSR, \
799 NULL, wacom_btnimg##BUTTON_ID##_store)
800
801DEVICE_BTNIMG_ATTR(0);
802DEVICE_BTNIMG_ATTR(1);
803DEVICE_BTNIMG_ATTR(2);
804DEVICE_BTNIMG_ATTR(3);
805DEVICE_BTNIMG_ATTR(4);
806DEVICE_BTNIMG_ATTR(5);
807DEVICE_BTNIMG_ATTR(6);
808DEVICE_BTNIMG_ATTR(7);
809
810static struct attribute *cintiq_led_attrs[] = {
811 &dev_attr_status_led0_select.attr,
812 &dev_attr_status_led1_select.attr,
813 NULL
814};
815
816static struct attribute_group cintiq_led_attr_group = {
817 .name = "wacom_led",
818 .attrs = cintiq_led_attrs,
819};
820
821static struct attribute *intuos4_led_attrs[] = {
822 &dev_attr_status0_luminance.attr,
823 &dev_attr_status1_luminance.attr,
824 &dev_attr_status_led0_select.attr,
825 &dev_attr_buttons_luminance.attr,
826 &dev_attr_button0_rawimg.attr,
827 &dev_attr_button1_rawimg.attr,
828 &dev_attr_button2_rawimg.attr,
829 &dev_attr_button3_rawimg.attr,
830 &dev_attr_button4_rawimg.attr,
831 &dev_attr_button5_rawimg.attr,
832 &dev_attr_button6_rawimg.attr,
833 &dev_attr_button7_rawimg.attr,
834 NULL
835};
836
837static struct attribute_group intuos4_led_attr_group = {
838 .name = "wacom_led",
839 .attrs = intuos4_led_attrs,
840};
841
842static struct attribute *intuos5_led_attrs[] = {
843 &dev_attr_status0_luminance.attr,
844 &dev_attr_status_led0_select.attr,
845 NULL
846};
847
848static struct attribute_group intuos5_led_attr_group = {
849 .name = "wacom_led",
850 .attrs = intuos5_led_attrs,
851};
852
853static int wacom_initialize_leds(struct wacom *wacom)
854{
855 int error;
856
857 /* Initialize default values */
858 switch (wacom->wacom_wac.features.type) {
859 case INTUOS4:
860 case INTUOS4L:
861 wacom->led.select[0] = 0;
862 wacom->led.select[1] = 0;
863 wacom->led.llv = 10;
864 wacom->led.hlv = 20;
865 wacom->led.img_lum = 10;
866 error = sysfs_create_group(&wacom->intf->dev.kobj,
867 &intuos4_led_attr_group);
868 break;
869
870 case WACOM_24HD:
871 case WACOM_21UX2:
872 wacom->led.select[0] = 0;
873 wacom->led.select[1] = 0;
874 wacom->led.llv = 0;
875 wacom->led.hlv = 0;
876 wacom->led.img_lum = 0;
877
878 error = sysfs_create_group(&wacom->intf->dev.kobj,
879 &cintiq_led_attr_group);
880 break;
881
882 case INTUOS5S:
883 case INTUOS5:
884 case INTUOS5L:
885 wacom->led.select[0] = 0;
886 wacom->led.select[1] = 0;
887 wacom->led.llv = 32;
888 wacom->led.hlv = 0;
889 wacom->led.img_lum = 0;
890
891 error = sysfs_create_group(&wacom->intf->dev.kobj,
892 &intuos5_led_attr_group);
893 break;
894
895 default:
896 return 0;
897 }
898
899 if (error) {
900 dev_err(&wacom->intf->dev,
901 "cannot create sysfs group err: %d\n", error);
902 return error;
903 }
904 wacom_led_control(wacom);
905
906 return 0;
907}
908
909static void wacom_destroy_leds(struct wacom *wacom)
910{
911 switch (wacom->wacom_wac.features.type) {
912 case INTUOS4:
913 case INTUOS4L:
914 sysfs_remove_group(&wacom->intf->dev.kobj,
915 &intuos4_led_attr_group);
916 break;
917
918 case WACOM_24HD:
919 case WACOM_21UX2:
920 sysfs_remove_group(&wacom->intf->dev.kobj,
921 &cintiq_led_attr_group);
922 break;
923
924 case INTUOS5S:
925 case INTUOS5:
926 case INTUOS5L:
927 sysfs_remove_group(&wacom->intf->dev.kobj,
928 &intuos5_led_attr_group);
929 break;
930 }
931}
932
933static enum power_supply_property wacom_battery_props[] = {
934 POWER_SUPPLY_PROP_CAPACITY
935};
936
937static int wacom_battery_get_property(struct power_supply *psy,
938 enum power_supply_property psp,
939 union power_supply_propval *val)
940{
941 struct wacom *wacom = container_of(psy, struct wacom, battery);
942 int ret = 0;
943
944 switch (psp) {
945 case POWER_SUPPLY_PROP_CAPACITY:
946 val->intval =
947 wacom->wacom_wac.battery_capacity * 100 / 31;
948 break;
949 default:
950 ret = -EINVAL;
951 break;
952 }
953
954 return ret;
955}
956
957static int wacom_initialize_battery(struct wacom *wacom)
958{
959 int error = 0;
960
961 if (wacom->wacom_wac.features.quirks & WACOM_QUIRK_MONITOR) {
962 wacom->battery.properties = wacom_battery_props;
963 wacom->battery.num_properties = ARRAY_SIZE(wacom_battery_props);
964 wacom->battery.get_property = wacom_battery_get_property;
965 wacom->battery.name = "wacom_battery";
966 wacom->battery.type = POWER_SUPPLY_TYPE_BATTERY;
967 wacom->battery.use_for_apm = 0;
968
969 error = power_supply_register(&wacom->usbdev->dev,
970 &wacom->battery);
971 }
972
973 return error;
974}
975
976static void wacom_destroy_battery(struct wacom *wacom)
977{
978 if (wacom->wacom_wac.features.quirks & WACOM_QUIRK_MONITOR)
979 power_supply_unregister(&wacom->battery);
980}
981
982static int wacom_register_input(struct wacom *wacom)
983{
984 struct input_dev *input_dev;
985 struct usb_interface *intf = wacom->intf;
986 struct usb_device *dev = interface_to_usbdev(intf);
987 struct wacom_wac *wacom_wac = &(wacom->wacom_wac);
988 int error;
989
990 input_dev = input_allocate_device();
991 if (!input_dev) {
992 error = -ENOMEM;
993 goto fail1;
994 }
995
996 input_dev->name = wacom_wac->name;
997 input_dev->dev.parent = &intf->dev;
998 input_dev->open = wacom_open;
999 input_dev->close = wacom_close;
1000 usb_to_input_id(dev, &input_dev->id);
1001 input_set_drvdata(input_dev, wacom);
1002
1003 wacom_wac->input = input_dev;
1004 error = wacom_setup_input_capabilities(input_dev, wacom_wac);
1005 if (error)
1006 goto fail1;
1007
1008 error = input_register_device(input_dev);
1009 if (error)
1010 goto fail2;
1011
1012 return 0;
1013
1014fail2:
1015 input_free_device(input_dev);
1016 wacom_wac->input = NULL;
1017fail1:
1018 return error;
1019}
1020
1021static void wacom_wireless_work(struct work_struct *work)
1022{
1023 struct wacom *wacom = container_of(work, struct wacom, work);
1024 struct usb_device *usbdev = wacom->usbdev;
1025 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
1026
1027 /*
1028 * Regardless if this is a disconnect or a new tablet,
1029 * remove any existing input devices.
1030 */
1031
1032 /* Stylus interface */
1033 wacom = usb_get_intfdata(usbdev->config->interface[1]);
1034 if (wacom->wacom_wac.input)
1035 input_unregister_device(wacom->wacom_wac.input);
1036 wacom->wacom_wac.input = NULL;
1037
1038 /* Touch interface */
1039 wacom = usb_get_intfdata(usbdev->config->interface[2]);
1040 if (wacom->wacom_wac.input)
1041 input_unregister_device(wacom->wacom_wac.input);
1042 wacom->wacom_wac.input = NULL;
1043
1044 if (wacom_wac->pid == 0) {
1045 dev_info(&wacom->intf->dev, "wireless tablet disconnected\n");
1046 } else {
1047 const struct usb_device_id *id = wacom_ids;
1048
1049 dev_info(&wacom->intf->dev,
1050 "wireless tablet connected with PID %x\n",
1051 wacom_wac->pid);
1052
1053 while (id->match_flags) {
1054 if (id->idVendor == USB_VENDOR_ID_WACOM &&
1055 id->idProduct == wacom_wac->pid)
1056 break;
1057 id++;
1058 }
1059
1060 if (!id->match_flags) {
1061 dev_info(&wacom->intf->dev,
1062 "ignoring unknown PID.\n");
1063 return;
1064 }
1065
1066 /* Stylus interface */
1067 wacom = usb_get_intfdata(usbdev->config->interface[1]);
1068 wacom_wac = &wacom->wacom_wac;
1069 wacom_wac->features =
1070 *((struct wacom_features *)id->driver_info);
1071 wacom_wac->features.device_type = BTN_TOOL_PEN;
1072 wacom_register_input(wacom);
1073
1074 /* Touch interface */
1075 wacom = usb_get_intfdata(usbdev->config->interface[2]);
1076 wacom_wac = &wacom->wacom_wac;
1077 wacom_wac->features =
1078 *((struct wacom_features *)id->driver_info);
1079 wacom_wac->features.pktlen = WACOM_PKGLEN_BBTOUCH3;
1080 wacom_wac->features.device_type = BTN_TOOL_FINGER;
1081 wacom_set_phy_from_res(&wacom_wac->features);
1082 wacom_wac->features.x_max = wacom_wac->features.y_max = 4096;
1083 wacom_register_input(wacom);
1084 }
1085}
1086
1087static int wacom_probe(struct usb_interface *intf, const struct usb_device_id *id)
1088{
1089 struct usb_device *dev = interface_to_usbdev(intf);
1090 struct usb_endpoint_descriptor *endpoint;
1091 struct wacom *wacom;
1092 struct wacom_wac *wacom_wac;
1093 struct wacom_features *features;
1094 int error;
1095
1096 if (!id->driver_info)
1097 return -EINVAL;
1098
1099 wacom = kzalloc(sizeof(struct wacom), GFP_KERNEL);
1100 if (!wacom)
1101 return -ENOMEM;
1102
1103 wacom_wac = &wacom->wacom_wac;
1104 wacom_wac->features = *((struct wacom_features *)id->driver_info);
1105 features = &wacom_wac->features;
1106 if (features->pktlen > WACOM_PKGLEN_MAX) {
1107 error = -EINVAL;
1108 goto fail1;
1109 }
1110
1111 wacom_wac->data = usb_alloc_coherent(dev, WACOM_PKGLEN_MAX,
1112 GFP_KERNEL, &wacom->data_dma);
1113 if (!wacom_wac->data) {
1114 error = -ENOMEM;
1115 goto fail1;
1116 }
1117
1118 wacom->irq = usb_alloc_urb(0, GFP_KERNEL);
1119 if (!wacom->irq) {
1120 error = -ENOMEM;
1121 goto fail2;
1122 }
1123
1124 wacom->usbdev = dev;
1125 wacom->intf = intf;
1126 mutex_init(&wacom->lock);
1127 INIT_WORK(&wacom->work, wacom_wireless_work);
1128 usb_make_path(dev, wacom->phys, sizeof(wacom->phys));
1129 strlcat(wacom->phys, "/input0", sizeof(wacom->phys));
1130
1131 endpoint = &intf->cur_altsetting->endpoint[0].desc;
1132
1133 /* Retrieve the physical and logical size for touch devices */
1134 error = wacom_retrieve_hid_descriptor(intf, features);
1135 if (error)
1136 goto fail3;
1137
1138 /*
1139 * Intuos5 has no useful data about its touch interface in its
1140 * HID descriptor. If this is the touch interface (wMaxPacketSize
1141 * of WACOM_PKGLEN_BBTOUCH3), override the table values.
1142 */
1143 if (features->type >= INTUOS5S && features->type <= INTUOS5L) {
1144 if (endpoint->wMaxPacketSize == WACOM_PKGLEN_BBTOUCH3) {
1145 features->device_type = BTN_TOOL_FINGER;
1146 features->pktlen = WACOM_PKGLEN_BBTOUCH3;
1147
1148 features->x_phy =
1149 (features->x_max * 100) / features->x_resolution;
1150 features->y_phy =
1151 (features->y_max * 100) / features->y_resolution;
1152
1153 features->x_max = 4096;
1154 features->y_max = 4096;
1155 } else {
1156 features->device_type = BTN_TOOL_PEN;
1157 }
1158 }
1159
1160 wacom_setup_device_quirks(features);
1161
1162 strlcpy(wacom_wac->name, features->name, sizeof(wacom_wac->name));
1163
1164 if (features->quirks & WACOM_QUIRK_MULTI_INPUT) {
1165 /* Append the device type to the name */
1166 strlcat(wacom_wac->name,
1167 features->device_type == BTN_TOOL_PEN ?
1168 " Pen" : " Finger",
1169 sizeof(wacom_wac->name));
1170
1171 error = wacom_add_shared_data(wacom_wac, dev);
1172 if (error)
1173 goto fail3;
1174 }
1175
1176 usb_fill_int_urb(wacom->irq, dev,
1177 usb_rcvintpipe(dev, endpoint->bEndpointAddress),
1178 wacom_wac->data, features->pktlen,
1179 wacom_sys_irq, wacom, endpoint->bInterval);
1180 wacom->irq->transfer_dma = wacom->data_dma;
1181 wacom->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1182
1183 error = wacom_initialize_leds(wacom);
1184 if (error)
1185 goto fail4;
1186
1187 error = wacom_initialize_battery(wacom);
1188 if (error)
1189 goto fail5;
1190
1191 if (!(features->quirks & WACOM_QUIRK_NO_INPUT)) {
1192 error = wacom_register_input(wacom);
1193 if (error)
1194 goto fail6;
1195 }
1196
1197 /* Note that if query fails it is not a hard failure */
1198 wacom_query_tablet_data(intf, features);
1199
1200 usb_set_intfdata(intf, wacom);
1201
1202 if (features->quirks & WACOM_QUIRK_MONITOR) {
1203 if (usb_submit_urb(wacom->irq, GFP_KERNEL))
1204 goto fail5;
1205 }
1206
1207 return 0;
1208
1209 fail6: wacom_destroy_battery(wacom);
1210 fail5: wacom_destroy_leds(wacom);
1211 fail4: wacom_remove_shared_data(wacom_wac);
1212 fail3: usb_free_urb(wacom->irq);
1213 fail2: usb_free_coherent(dev, WACOM_PKGLEN_MAX, wacom_wac->data, wacom->data_dma);
1214 fail1: kfree(wacom);
1215 return error;
1216}
1217
1218static void wacom_disconnect(struct usb_interface *intf)
1219{
1220 struct wacom *wacom = usb_get_intfdata(intf);
1221
1222 usb_set_intfdata(intf, NULL);
1223
1224 usb_kill_urb(wacom->irq);
1225 cancel_work_sync(&wacom->work);
1226 if (wacom->wacom_wac.input)
1227 input_unregister_device(wacom->wacom_wac.input);
1228 wacom_destroy_battery(wacom);
1229 wacom_destroy_leds(wacom);
1230 usb_free_urb(wacom->irq);
1231 usb_free_coherent(interface_to_usbdev(intf), WACOM_PKGLEN_MAX,
1232 wacom->wacom_wac.data, wacom->data_dma);
1233 wacom_remove_shared_data(&wacom->wacom_wac);
1234 kfree(wacom);
1235}
1236
1237static int wacom_suspend(struct usb_interface *intf, pm_message_t message)
1238{
1239 struct wacom *wacom = usb_get_intfdata(intf);
1240
1241 mutex_lock(&wacom->lock);
1242 usb_kill_urb(wacom->irq);
1243 mutex_unlock(&wacom->lock);
1244
1245 return 0;
1246}
1247
1248static int wacom_resume(struct usb_interface *intf)
1249{
1250 struct wacom *wacom = usb_get_intfdata(intf);
1251 struct wacom_features *features = &wacom->wacom_wac.features;
1252 int rv = 0;
1253
1254 mutex_lock(&wacom->lock);
1255
1256 /* switch to wacom mode first */
1257 wacom_query_tablet_data(intf, features);
1258 wacom_led_control(wacom);
1259
1260 if ((wacom->open || features->quirks & WACOM_QUIRK_MONITOR)
1261 && usb_submit_urb(wacom->irq, GFP_NOIO) < 0)
1262 rv = -EIO;
1263
1264 mutex_unlock(&wacom->lock);
1265
1266 return rv;
1267}
1268
1269static int wacom_reset_resume(struct usb_interface *intf)
1270{
1271 return wacom_resume(intf);
1272}
1273
1274static struct usb_driver wacom_driver = {
1275 .name = "wacom",
1276 .id_table = wacom_ids,
1277 .probe = wacom_probe,
1278 .disconnect = wacom_disconnect,
1279 .suspend = wacom_suspend,
1280 .resume = wacom_resume,
1281 .reset_resume = wacom_reset_resume,
1282 .supports_autosuspend = 1,
1283};
1284
1285module_usb_driver(wacom_driver);