]> Gitweb @ Texas Instruments - Open Source Git Repositories - git.TI.com/gitweb - android-sdk/kernel-video.git/blob - drivers/input/tablet/wacom_sys.c
Merge tag 'arm64-uapi' of git://git.kernel.org/pub/scm/linux/kernel/git/cmarinas...
[android-sdk/kernel-video.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  */
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  */
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,
40 };
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)
65 {
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;
80 }
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;
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;
98 }
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;
121         }
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;
146         }
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);
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)
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;
203         }
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         }
220         /* Calculate resolution */
221         return logical_extents / physical_extents;
224 /*
225  * The physical dimension specified by the HID descriptor is likely not in
226  * the "100th of a mm" units expected by wacom_calculate_touch_res. This
227  * function adjusts the value of [xy]_phy based on the unit and exponent
228  * provided by the HID descriptor. If an error occurs durring conversion
229  * (e.g. from the unit being left unspecified) [xy]_phy is not modified.
230  */
231 static void wacom_fix_phy_from_hid(struct wacom_features *features)
233         int xres = wacom_calc_hid_res(features->x_max, features->x_phy,
234                                         features->unit, features->unitExpo);
235         int yres = wacom_calc_hid_res(features->y_max, features->y_phy,
236                                         features->unit, features->unitExpo);
238         if (xres > 0 && yres > 0) {
239                 features->x_phy = (100 * features->x_max) / xres;
240                 features->y_phy = (100 * features->y_max) / yres;
241         }
244 /*
245  * Static values for max X/Y and resolution of Pen interface is stored in
246  * features. This mean physical size of active area can be computed.
247  * This is useful to do when Pen and Touch have same active area of tablet.
248  * This means for Touch device, we only need to find max X/Y value and we
249  * have enough information to compute resolution of touch.
250  */
251 static void wacom_set_phy_from_res(struct wacom_features *features)
253         features->x_phy = (features->x_max * 100) / features->x_resolution;
254         features->y_phy = (features->y_max * 100) / features->y_resolution;
257 static int wacom_parse_logical_collection(unsigned char *report,
258                                           struct wacom_features *features)
260         int length = 0;
262         if (features->type == BAMBOO_PT) {
264                 /* Logical collection is only used by 3rd gen Bamboo Touch */
265                 features->pktlen = WACOM_PKGLEN_BBTOUCH3;
266                 features->device_type = BTN_TOOL_FINGER;
268                 wacom_set_phy_from_res(features);
270                 features->x_max = features->y_max =
271                         get_unaligned_le16(&report[10]);
273                 length = 11;
274         }
275         return length;
278 static void wacom_retrieve_report_data(struct usb_interface *intf,
279                                        struct wacom_features *features)
281         int result = 0;
282         unsigned char *rep_data;
284         rep_data = kmalloc(2, GFP_KERNEL);
285         if (rep_data) {
287                 rep_data[0] = 12;
288                 result = wacom_get_report(intf, WAC_HID_FEATURE_REPORT,
289                                           rep_data[0], rep_data, 2,
290                                           WAC_MSG_RETRIES);
292                 if (result >= 0 && rep_data[1] > 2)
293                         features->touch_max = rep_data[1];
295                 kfree(rep_data);
296         }
299 /*
300  * Interface Descriptor of wacom devices can be incomplete and
301  * inconsistent so wacom_features table is used to store stylus
302  * device's packet lengths, various maximum values, and tablet
303  * resolution based on product ID's.
304  *
305  * For devices that contain 2 interfaces, wacom_features table is
306  * inaccurate for the touch interface.  Since the Interface Descriptor
307  * for touch interfaces has pretty complete data, this function exists
308  * to query tablet for this missing information instead of hard coding in
309  * an additional table.
310  *
311  * A typical Interface Descriptor for a stylus will contain a
312  * boot mouse application collection that is not of interest and this
313  * function will ignore it.
314  *
315  * It also contains a digitizer application collection that also is not
316  * of interest since any information it contains would be duplicate
317  * of what is in wacom_features. Usually it defines a report of an array
318  * of bytes that could be used as max length of the stylus packet returned.
319  * If it happens to define a Digitizer-Stylus Physical Collection then
320  * the X and Y logical values contain valid data but it is ignored.
321  *
322  * A typical Interface Descriptor for a touch interface will contain a
323  * Digitizer-Finger Physical Collection which will define both logical
324  * X/Y maximum as well as the physical size of tablet. Since touch
325  * interfaces haven't supported pressure or distance, this is enough
326  * information to override invalid values in the wacom_features table.
327  *
328  * 3rd gen Bamboo Touch no longer define a Digitizer-Finger Pysical
329  * Collection. Instead they define a Logical Collection with a single
330  * Logical Maximum for both X and Y.
331  *
332  * Intuos5 touch interface does not contain useful data. We deal with
333  * this after returning from this function.
334  */
335 static int wacom_parse_hid(struct usb_interface *intf,
336                            struct hid_descriptor *hid_desc,
337                            struct wacom_features *features)
339         struct usb_device *dev = interface_to_usbdev(intf);
340         char limit = 0;
341         /* result has to be defined as int for some devices */
342         int result = 0;
343         int i = 0, usage = WCM_UNDEFINED, finger = 0, pen = 0;
344         unsigned char *report;
346         report = kzalloc(hid_desc->wDescriptorLength, GFP_KERNEL);
347         if (!report)
348                 return -ENOMEM;
350         /* retrive report descriptors */
351         do {
352                 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
353                         USB_REQ_GET_DESCRIPTOR,
354                         USB_RECIP_INTERFACE | USB_DIR_IN,
355                         HID_DEVICET_REPORT << 8,
356                         intf->altsetting[0].desc.bInterfaceNumber, /* interface */
357                         report,
358                         hid_desc->wDescriptorLength,
359                         5000); /* 5 secs */
360         } while (result < 0 && limit++ < WAC_MSG_RETRIES);
362         /* No need to parse the Descriptor. It isn't an error though */
363         if (result < 0)
364                 goto out;
366         for (i = 0; i < hid_desc->wDescriptorLength; i++) {
368                 switch (report[i]) {
369                 case HID_USAGE_PAGE:
370                         switch (report[i + 1]) {
371                         case HID_USAGE_PAGE_DIGITIZER:
372                                 usage = WCM_DIGITIZER;
373                                 i++;
374                                 break;
376                         case HID_USAGE_PAGE_DESKTOP:
377                                 usage = WCM_DESKTOP;
378                                 i++;
379                                 break;
380                         }
381                         break;
383                 case HID_USAGE:
384                         switch (report[i + 1]) {
385                         case HID_USAGE_X:
386                                 if (usage == WCM_DESKTOP) {
387                                         if (finger) {
388                                                 features->device_type = BTN_TOOL_FINGER;
389                                                 if (features->type == TABLETPC2FG) {
390                                                         /* need to reset back */
391                                                         features->pktlen = WACOM_PKGLEN_TPC2FG;
392                                                 }
394                                                 if (features->type == MTSCREEN)
395                                                         features->pktlen = WACOM_PKGLEN_MTOUCH;
397                                                 if (features->type == BAMBOO_PT) {
398                                                         /* need to reset back */
399                                                         features->pktlen = WACOM_PKGLEN_BBTOUCH;
400                                                         features->x_phy =
401                                                                 get_unaligned_le16(&report[i + 5]);
402                                                         features->x_max =
403                                                                 get_unaligned_le16(&report[i + 8]);
404                                                         i += 15;
405                                                 } else {
406                                                         features->x_max =
407                                                                 get_unaligned_le16(&report[i + 3]);
408                                                         features->x_phy =
409                                                                 get_unaligned_le16(&report[i + 6]);
410                                                         features->unit = report[i + 9];
411                                                         features->unitExpo = report[i + 11];
412                                                         i += 12;
413                                                 }
414                                         } else if (pen) {
415                                                 /* penabled only accepts exact bytes of data */
416                                                 if (features->type == TABLETPC2FG)
417                                                         features->pktlen = WACOM_PKGLEN_GRAPHIRE;
418                                                 features->device_type = BTN_TOOL_PEN;
419                                                 features->x_max =
420                                                         get_unaligned_le16(&report[i + 3]);
421                                                 i += 4;
422                                         }
423                                 }
424                                 break;
426                         case HID_USAGE_Y:
427                                 if (usage == WCM_DESKTOP) {
428                                         if (finger) {
429                                                 int type = features->type;
431                                                 if (type == TABLETPC2FG || type == MTSCREEN) {
432                                                         features->y_max =
433                                                                 get_unaligned_le16(&report[i + 3]);
434                                                         features->y_phy =
435                                                                 get_unaligned_le16(&report[i + 6]);
436                                                         i += 7;
437                                                 } else if (type == BAMBOO_PT) {
438                                                         features->y_phy =
439                                                                 get_unaligned_le16(&report[i + 3]);
440                                                         features->y_max =
441                                                                 get_unaligned_le16(&report[i + 6]);
442                                                         i += 12;
443                                                 } else {
444                                                         features->y_max =
445                                                                 features->x_max;
446                                                         features->y_phy =
447                                                                 get_unaligned_le16(&report[i + 3]);
448                                                         i += 4;
449                                                 }
450                                         } else if (pen) {
451                                                 features->y_max =
452                                                         get_unaligned_le16(&report[i + 3]);
453                                                 i += 4;
454                                         }
455                                 }
456                                 break;
458                         case HID_USAGE_FINGER:
459                                 finger = 1;
460                                 i++;
461                                 break;
463                         /*
464                          * Requiring Stylus Usage will ignore boot mouse
465                          * X/Y values and some cases of invalid Digitizer X/Y
466                          * values commonly reported.
467                          */
468                         case HID_USAGE_STYLUS:
469                                 pen = 1;
470                                 i++;
471                                 break;
473                         case HID_USAGE_CONTACTMAX:
474                                 /* leave touch_max as is if predefined */
475                                 if (!features->touch_max)
476                                         wacom_retrieve_report_data(intf, features);
477                                 i++;
478                                 break;
479                         }
480                         break;
482                 case HID_COLLECTION_END:
483                         /* reset UsagePage and Finger */
484                         finger = usage = 0;
485                         break;
487                 case HID_COLLECTION:
488                         i++;
489                         switch (report[i]) {
490                         case HID_COLLECTION_LOGICAL:
491                                 i += wacom_parse_logical_collection(&report[i],
492                                                                     features);
493                                 break;
494                         }
495                         break;
496                 }
497         }
499  out:
500         result = 0;
501         kfree(report);
502         return result;
505 static int wacom_set_device_mode(struct usb_interface *intf, int report_id, int length, int mode)
507         unsigned char *rep_data;
508         int error = -ENOMEM, limit = 0;
510         rep_data = kzalloc(length, GFP_KERNEL);
511         if (!rep_data)
512                 return error;
514         rep_data[0] = report_id;
515         rep_data[1] = mode;
517         do {
518                 error = wacom_set_report(intf, WAC_HID_FEATURE_REPORT,
519                                          report_id, rep_data, length, 1);
520                 if (error >= 0)
521                         error = wacom_get_report(intf, WAC_HID_FEATURE_REPORT,
522                                                  report_id, rep_data, length, 1);
523         } while ((error < 0 || rep_data[1] != mode) && limit++ < WAC_MSG_RETRIES);
525         kfree(rep_data);
527         return error < 0 ? error : 0;
530 /*
531  * Switch the tablet into its most-capable mode. Wacom tablets are
532  * typically configured to power-up in a mode which sends mouse-like
533  * reports to the OS. To get absolute position, pressure data, etc.
534  * from the tablet, it is necessary to switch the tablet out of this
535  * mode and into one which sends the full range of tablet data.
536  */
537 static int wacom_query_tablet_data(struct usb_interface *intf, struct wacom_features *features)
539         if (features->device_type == BTN_TOOL_FINGER) {
540                 if (features->type > TABLETPC) {
541                         /* MT Tablet PC touch */
542                         return wacom_set_device_mode(intf, 3, 4, 4);
543                 }
544         } else if (features->device_type == BTN_TOOL_PEN) {
545                 if (features->type <= BAMBOO_PT && features->type != WIRELESS) {
546                         return wacom_set_device_mode(intf, 2, 2, 2);
547                 }
548         }
550         return 0;
553 static int wacom_retrieve_hid_descriptor(struct usb_interface *intf,
554                                          struct wacom_features *features)
556         int error = 0;
557         struct usb_host_interface *interface = intf->cur_altsetting;
558         struct hid_descriptor *hid_desc;
560         /* default features */
561         features->device_type = BTN_TOOL_PEN;
562         features->x_fuzz = 4;
563         features->y_fuzz = 4;
564         features->pressure_fuzz = 0;
565         features->distance_fuzz = 0;
567         /*
568          * The wireless device HID is basic and layout conflicts with
569          * other tablets (monitor and touch interface can look like pen).
570          * Skip the query for this type and modify defaults based on
571          * interface number.
572          */
573         if (features->type == WIRELESS) {
574                 if (intf->cur_altsetting->desc.bInterfaceNumber == 0) {
575                         features->device_type = 0;
576                 } else if (intf->cur_altsetting->desc.bInterfaceNumber == 2) {
577                         features->device_type = BTN_TOOL_FINGER;
578                         features->pktlen = WACOM_PKGLEN_BBTOUCH3;
579                 }
580         }
582         /* only devices that support touch need to retrieve the info */
583         if (features->type < BAMBOO_PT) {
584                 goto out;
585         }
587         error = usb_get_extra_descriptor(interface, HID_DEVICET_HID, &hid_desc);
588         if (error) {
589                 error = usb_get_extra_descriptor(&interface->endpoint[0],
590                                                  HID_DEVICET_REPORT, &hid_desc);
591                 if (error) {
592                         dev_err(&intf->dev,
593                                 "can not retrieve extra class descriptor\n");
594                         goto out;
595                 }
596         }
597         error = wacom_parse_hid(intf, hid_desc, features);
598         if (error)
599                 goto out;
600         wacom_fix_phy_from_hid(features);
602  out:
603         return error;
606 struct wacom_usbdev_data {
607         struct list_head list;
608         struct kref kref;
609         struct usb_device *dev;
610         struct wacom_shared shared;
611 };
613 static LIST_HEAD(wacom_udev_list);
614 static DEFINE_MUTEX(wacom_udev_list_lock);
616 static struct wacom_usbdev_data *wacom_get_usbdev_data(struct usb_device *dev)
618         struct wacom_usbdev_data *data;
620         list_for_each_entry(data, &wacom_udev_list, list) {
621                 if (data->dev == dev) {
622                         kref_get(&data->kref);
623                         return data;
624                 }
625         }
627         return NULL;
630 static int wacom_add_shared_data(struct wacom_wac *wacom,
631                                  struct usb_device *dev)
633         struct wacom_usbdev_data *data;
634         int retval = 0;
636         mutex_lock(&wacom_udev_list_lock);
638         data = wacom_get_usbdev_data(dev);
639         if (!data) {
640                 data = kzalloc(sizeof(struct wacom_usbdev_data), GFP_KERNEL);
641                 if (!data) {
642                         retval = -ENOMEM;
643                         goto out;
644                 }
646                 kref_init(&data->kref);
647                 data->dev = dev;
648                 list_add_tail(&data->list, &wacom_udev_list);
649         }
651         wacom->shared = &data->shared;
653 out:
654         mutex_unlock(&wacom_udev_list_lock);
655         return retval;
658 static void wacom_release_shared_data(struct kref *kref)
660         struct wacom_usbdev_data *data =
661                 container_of(kref, struct wacom_usbdev_data, kref);
663         mutex_lock(&wacom_udev_list_lock);
664         list_del(&data->list);
665         mutex_unlock(&wacom_udev_list_lock);
667         kfree(data);
670 static void wacom_remove_shared_data(struct wacom_wac *wacom)
672         struct wacom_usbdev_data *data;
674         if (wacom->shared) {
675                 data = container_of(wacom->shared, struct wacom_usbdev_data, shared);
676                 kref_put(&data->kref, wacom_release_shared_data);
677                 wacom->shared = NULL;
678         }
681 static int wacom_led_control(struct wacom *wacom)
683         unsigned char *buf;
684         int retval;
686         buf = kzalloc(9, GFP_KERNEL);
687         if (!buf)
688                 return -ENOMEM;
690         if (wacom->wacom_wac.features.type >= INTUOS5S &&
691             wacom->wacom_wac.features.type <= INTUOS5L) {
692                 /*
693                  * Touch Ring and crop mark LED luminance may take on
694                  * one of four values:
695                  *    0 = Low; 1 = Medium; 2 = High; 3 = Off
696                  */
697                 int ring_led = wacom->led.select[0] & 0x03;
698                 int ring_lum = (((wacom->led.llv & 0x60) >> 5) - 1) & 0x03;
699                 int crop_lum = 0;
701                 buf[0] = WAC_CMD_LED_CONTROL;
702                 buf[1] = (crop_lum << 4) | (ring_lum << 2) | (ring_led);
703         }
704         else {
705                 int led = wacom->led.select[0] | 0x4;
707                 if (wacom->wacom_wac.features.type == WACOM_21UX2 ||
708                     wacom->wacom_wac.features.type == WACOM_24HD)
709                         led |= (wacom->led.select[1] << 4) | 0x40;
711                 buf[0] = WAC_CMD_LED_CONTROL;
712                 buf[1] = led;
713                 buf[2] = wacom->led.llv;
714                 buf[3] = wacom->led.hlv;
715                 buf[4] = wacom->led.img_lum;
716         }
718         retval = wacom_set_report(wacom->intf, 0x03, WAC_CMD_LED_CONTROL,
719                                   buf, 9, WAC_CMD_RETRIES);
720         kfree(buf);
722         return retval;
725 static int wacom_led_putimage(struct wacom *wacom, int button_id, const void *img)
727         unsigned char *buf;
728         int i, retval;
730         buf = kzalloc(259, GFP_KERNEL);
731         if (!buf)
732                 return -ENOMEM;
734         /* Send 'start' command */
735         buf[0] = WAC_CMD_ICON_START;
736         buf[1] = 1;
737         retval = wacom_set_report(wacom->intf, 0x03, WAC_CMD_ICON_START,
738                                   buf, 2, WAC_CMD_RETRIES);
739         if (retval < 0)
740                 goto out;
742         buf[0] = WAC_CMD_ICON_XFER;
743         buf[1] = button_id & 0x07;
744         for (i = 0; i < 4; i++) {
745                 buf[2] = i;
746                 memcpy(buf + 3, img + i * 256, 256);
748                 retval = wacom_set_report(wacom->intf, 0x03, WAC_CMD_ICON_XFER,
749                                           buf, 259, WAC_CMD_RETRIES);
750                 if (retval < 0)
751                         break;
752         }
754         /* Send 'stop' */
755         buf[0] = WAC_CMD_ICON_START;
756         buf[1] = 0;
757         wacom_set_report(wacom->intf, 0x03, WAC_CMD_ICON_START,
758                          buf, 2, WAC_CMD_RETRIES);
760 out:
761         kfree(buf);
762         return retval;
765 static ssize_t wacom_led_select_store(struct device *dev, int set_id,
766                                       const char *buf, size_t count)
768         struct wacom *wacom = dev_get_drvdata(dev);
769         unsigned int id;
770         int err;
772         err = kstrtouint(buf, 10, &id);
773         if (err)
774                 return err;
776         mutex_lock(&wacom->lock);
778         wacom->led.select[set_id] = id & 0x3;
779         err = wacom_led_control(wacom);
781         mutex_unlock(&wacom->lock);
783         return err < 0 ? err : count;
786 #define DEVICE_LED_SELECT_ATTR(SET_ID)                                  \
787 static ssize_t wacom_led##SET_ID##_select_store(struct device *dev,     \
788         struct device_attribute *attr, const char *buf, size_t count)   \
789 {                                                                       \
790         return wacom_led_select_store(dev, SET_ID, buf, count);         \
791 }                                                                       \
792 static ssize_t wacom_led##SET_ID##_select_show(struct device *dev,      \
793         struct device_attribute *attr, char *buf)                       \
794 {                                                                       \
795         struct wacom *wacom = dev_get_drvdata(dev);                     \
796         return snprintf(buf, 2, "%d\n", wacom->led.select[SET_ID]);     \
797 }                                                                       \
798 static DEVICE_ATTR(status_led##SET_ID##_select, S_IWUSR | S_IRUSR,      \
799                     wacom_led##SET_ID##_select_show,                    \
800                     wacom_led##SET_ID##_select_store)
802 DEVICE_LED_SELECT_ATTR(0);
803 DEVICE_LED_SELECT_ATTR(1);
805 static ssize_t wacom_luminance_store(struct wacom *wacom, u8 *dest,
806                                      const char *buf, size_t count)
808         unsigned int value;
809         int err;
811         err = kstrtouint(buf, 10, &value);
812         if (err)
813                 return err;
815         mutex_lock(&wacom->lock);
817         *dest = value & 0x7f;
818         err = wacom_led_control(wacom);
820         mutex_unlock(&wacom->lock);
822         return err < 0 ? err : count;
825 #define DEVICE_LUMINANCE_ATTR(name, field)                              \
826 static ssize_t wacom_##name##_luminance_store(struct device *dev,       \
827         struct device_attribute *attr, const char *buf, size_t count)   \
828 {                                                                       \
829         struct wacom *wacom = dev_get_drvdata(dev);                     \
830                                                                         \
831         return wacom_luminance_store(wacom, &wacom->led.field,          \
832                                      buf, count);                       \
833 }                                                                       \
834 static DEVICE_ATTR(name##_luminance, S_IWUSR,                           \
835                    NULL, wacom_##name##_luminance_store)
837 DEVICE_LUMINANCE_ATTR(status0, llv);
838 DEVICE_LUMINANCE_ATTR(status1, hlv);
839 DEVICE_LUMINANCE_ATTR(buttons, img_lum);
841 static ssize_t wacom_button_image_store(struct device *dev, int button_id,
842                                         const char *buf, size_t count)
844         struct wacom *wacom = dev_get_drvdata(dev);
845         int err;
847         if (count != 1024)
848                 return -EINVAL;
850         mutex_lock(&wacom->lock);
852         err = wacom_led_putimage(wacom, button_id, buf);
854         mutex_unlock(&wacom->lock);
856         return err < 0 ? err : count;
859 #define DEVICE_BTNIMG_ATTR(BUTTON_ID)                                   \
860 static ssize_t wacom_btnimg##BUTTON_ID##_store(struct device *dev,      \
861         struct device_attribute *attr, const char *buf, size_t count)   \
862 {                                                                       \
863         return wacom_button_image_store(dev, BUTTON_ID, buf, count);    \
864 }                                                                       \
865 static DEVICE_ATTR(button##BUTTON_ID##_rawimg, S_IWUSR,                 \
866                    NULL, wacom_btnimg##BUTTON_ID##_store)
868 DEVICE_BTNIMG_ATTR(0);
869 DEVICE_BTNIMG_ATTR(1);
870 DEVICE_BTNIMG_ATTR(2);
871 DEVICE_BTNIMG_ATTR(3);
872 DEVICE_BTNIMG_ATTR(4);
873 DEVICE_BTNIMG_ATTR(5);
874 DEVICE_BTNIMG_ATTR(6);
875 DEVICE_BTNIMG_ATTR(7);
877 static struct attribute *cintiq_led_attrs[] = {
878         &dev_attr_status_led0_select.attr,
879         &dev_attr_status_led1_select.attr,
880         NULL
881 };
883 static struct attribute_group cintiq_led_attr_group = {
884         .name = "wacom_led",
885         .attrs = cintiq_led_attrs,
886 };
888 static struct attribute *intuos4_led_attrs[] = {
889         &dev_attr_status0_luminance.attr,
890         &dev_attr_status1_luminance.attr,
891         &dev_attr_status_led0_select.attr,
892         &dev_attr_buttons_luminance.attr,
893         &dev_attr_button0_rawimg.attr,
894         &dev_attr_button1_rawimg.attr,
895         &dev_attr_button2_rawimg.attr,
896         &dev_attr_button3_rawimg.attr,
897         &dev_attr_button4_rawimg.attr,
898         &dev_attr_button5_rawimg.attr,
899         &dev_attr_button6_rawimg.attr,
900         &dev_attr_button7_rawimg.attr,
901         NULL
902 };
904 static struct attribute_group intuos4_led_attr_group = {
905         .name = "wacom_led",
906         .attrs = intuos4_led_attrs,
907 };
909 static struct attribute *intuos5_led_attrs[] = {
910         &dev_attr_status0_luminance.attr,
911         &dev_attr_status_led0_select.attr,
912         NULL
913 };
915 static struct attribute_group intuos5_led_attr_group = {
916         .name = "wacom_led",
917         .attrs = intuos5_led_attrs,
918 };
920 static int wacom_initialize_leds(struct wacom *wacom)
922         int error;
924         /* Initialize default values */
925         switch (wacom->wacom_wac.features.type) {
926         case INTUOS4S:
927         case INTUOS4:
928         case INTUOS4L:
929                 wacom->led.select[0] = 0;
930                 wacom->led.select[1] = 0;
931                 wacom->led.llv = 10;
932                 wacom->led.hlv = 20;
933                 wacom->led.img_lum = 10;
934                 error = sysfs_create_group(&wacom->intf->dev.kobj,
935                                            &intuos4_led_attr_group);
936                 break;
938         case WACOM_24HD:
939         case WACOM_21UX2:
940                 wacom->led.select[0] = 0;
941                 wacom->led.select[1] = 0;
942                 wacom->led.llv = 0;
943                 wacom->led.hlv = 0;
944                 wacom->led.img_lum = 0;
946                 error = sysfs_create_group(&wacom->intf->dev.kobj,
947                                            &cintiq_led_attr_group);
948                 break;
950         case INTUOS5S:
951         case INTUOS5:
952         case INTUOS5L:
953                 wacom->led.select[0] = 0;
954                 wacom->led.select[1] = 0;
955                 wacom->led.llv = 32;
956                 wacom->led.hlv = 0;
957                 wacom->led.img_lum = 0;
959                 error = sysfs_create_group(&wacom->intf->dev.kobj,
960                                            &intuos5_led_attr_group);
961                 break;
963         default:
964                 return 0;
965         }
967         if (error) {
968                 dev_err(&wacom->intf->dev,
969                         "cannot create sysfs group err: %d\n", error);
970                 return error;
971         }
972         wacom_led_control(wacom);
974         return 0;
977 static void wacom_destroy_leds(struct wacom *wacom)
979         switch (wacom->wacom_wac.features.type) {
980         case INTUOS4S:
981         case INTUOS4:
982         case INTUOS4L:
983                 sysfs_remove_group(&wacom->intf->dev.kobj,
984                                    &intuos4_led_attr_group);
985                 break;
987         case WACOM_24HD:
988         case WACOM_21UX2:
989                 sysfs_remove_group(&wacom->intf->dev.kobj,
990                                    &cintiq_led_attr_group);
991                 break;
993         case INTUOS5S:
994         case INTUOS5:
995         case INTUOS5L:
996                 sysfs_remove_group(&wacom->intf->dev.kobj,
997                                    &intuos5_led_attr_group);
998                 break;
999         }
1002 static enum power_supply_property wacom_battery_props[] = {
1003         POWER_SUPPLY_PROP_CAPACITY
1004 };
1006 static int wacom_battery_get_property(struct power_supply *psy,
1007                                       enum power_supply_property psp,
1008                                       union power_supply_propval *val)
1010         struct wacom *wacom = container_of(psy, struct wacom, battery);
1011         int ret = 0;
1013         switch (psp) {
1014                 case POWER_SUPPLY_PROP_CAPACITY:
1015                         val->intval =
1016                                 wacom->wacom_wac.battery_capacity * 100 / 31;
1017                         break;
1018                 default:
1019                         ret = -EINVAL;
1020                         break;
1021         }
1023         return ret;
1026 static int wacom_initialize_battery(struct wacom *wacom)
1028         int error = 0;
1030         if (wacom->wacom_wac.features.quirks & WACOM_QUIRK_MONITOR) {
1031                 wacom->battery.properties = wacom_battery_props;
1032                 wacom->battery.num_properties = ARRAY_SIZE(wacom_battery_props);
1033                 wacom->battery.get_property = wacom_battery_get_property;
1034                 wacom->battery.name = "wacom_battery";
1035                 wacom->battery.type = POWER_SUPPLY_TYPE_BATTERY;
1036                 wacom->battery.use_for_apm = 0;
1038                 error = power_supply_register(&wacom->usbdev->dev,
1039                                               &wacom->battery);
1041                 if (!error)
1042                         power_supply_powers(&wacom->battery,
1043                                             &wacom->usbdev->dev);
1044         }
1046         return error;
1049 static void wacom_destroy_battery(struct wacom *wacom)
1051         if (wacom->wacom_wac.features.quirks & WACOM_QUIRK_MONITOR &&
1052             wacom->battery.dev) {
1053                 power_supply_unregister(&wacom->battery);
1054                 wacom->battery.dev = NULL;
1055         }
1058 static int wacom_register_input(struct wacom *wacom)
1060         struct input_dev *input_dev;
1061         struct usb_interface *intf = wacom->intf;
1062         struct usb_device *dev = interface_to_usbdev(intf);
1063         struct wacom_wac *wacom_wac = &(wacom->wacom_wac);
1064         int error;
1066         input_dev = input_allocate_device();
1067         if (!input_dev) {
1068                 error = -ENOMEM;
1069                 goto fail1;
1070         }
1072         input_dev->name = wacom_wac->name;
1073         input_dev->dev.parent = &intf->dev;
1074         input_dev->open = wacom_open;
1075         input_dev->close = wacom_close;
1076         usb_to_input_id(dev, &input_dev->id);
1077         input_set_drvdata(input_dev, wacom);
1079         wacom_wac->input = input_dev;
1080         error = wacom_setup_input_capabilities(input_dev, wacom_wac);
1081         if (error)
1082                 goto fail1;
1084         error = input_register_device(input_dev);
1085         if (error)
1086                 goto fail2;
1088         return 0;
1090 fail2:
1091         input_free_device(input_dev);
1092         wacom_wac->input = NULL;
1093 fail1:
1094         return error;
1097 static void wacom_wireless_work(struct work_struct *work)
1099         struct wacom *wacom = container_of(work, struct wacom, work);
1100         struct usb_device *usbdev = wacom->usbdev;
1101         struct wacom_wac *wacom_wac = &wacom->wacom_wac;
1102         struct wacom *wacom1, *wacom2;
1103         struct wacom_wac *wacom_wac1, *wacom_wac2;
1104         int error;
1106         /*
1107          * Regardless if this is a disconnect or a new tablet,
1108          * remove any existing input and battery devices.
1109          */
1111         wacom_destroy_battery(wacom);
1113         /* Stylus interface */
1114         wacom1 = usb_get_intfdata(usbdev->config->interface[1]);
1115         wacom_wac1 = &(wacom1->wacom_wac);
1116         if (wacom_wac1->input)
1117                 input_unregister_device(wacom_wac1->input);
1118         wacom_wac1->input = NULL;
1120         /* Touch interface */
1121         wacom2 = usb_get_intfdata(usbdev->config->interface[2]);
1122         wacom_wac2 = &(wacom2->wacom_wac);
1123         if (wacom_wac2->input)
1124                 input_unregister_device(wacom_wac2->input);
1125         wacom_wac2->input = NULL;
1127         if (wacom_wac->pid == 0) {
1128                 dev_info(&wacom->intf->dev, "wireless tablet disconnected\n");
1129         } else {
1130                 const struct usb_device_id *id = wacom_ids;
1132                 dev_info(&wacom->intf->dev,
1133                          "wireless tablet connected with PID %x\n",
1134                          wacom_wac->pid);
1136                 while (id->match_flags) {
1137                         if (id->idVendor == USB_VENDOR_ID_WACOM &&
1138                             id->idProduct == wacom_wac->pid)
1139                                 break;
1140                         id++;
1141                 }
1143                 if (!id->match_flags) {
1144                         dev_info(&wacom->intf->dev,
1145                                  "ignoring unknown PID.\n");
1146                         return;
1147                 }
1149                 /* Stylus interface */
1150                 wacom_wac1->features =
1151                         *((struct wacom_features *)id->driver_info);
1152                 wacom_wac1->features.device_type = BTN_TOOL_PEN;
1153                 error = wacom_register_input(wacom1);
1154                 if (error)
1155                         goto fail1;
1157                 /* Touch interface */
1158                 wacom_wac2->features =
1159                         *((struct wacom_features *)id->driver_info);
1160                 wacom_wac2->features.pktlen = WACOM_PKGLEN_BBTOUCH3;
1161                 wacom_wac2->features.device_type = BTN_TOOL_FINGER;
1162                 wacom_set_phy_from_res(&wacom_wac2->features);
1163                 wacom_wac2->features.x_max = wacom_wac2->features.y_max = 4096;
1164                 error = wacom_register_input(wacom2);
1165                 if (error)
1166                         goto fail2;
1168                 error = wacom_initialize_battery(wacom);
1169                 if (error)
1170                         goto fail3;
1171         }
1173         return;
1175 fail3:
1176         input_unregister_device(wacom_wac2->input);
1177         wacom_wac2->input = NULL;
1178 fail2:
1179         input_unregister_device(wacom_wac1->input);
1180         wacom_wac1->input = NULL;
1181 fail1:
1182         return;
1185 static int wacom_probe(struct usb_interface *intf, const struct usb_device_id *id)
1187         struct usb_device *dev = interface_to_usbdev(intf);
1188         struct usb_endpoint_descriptor *endpoint;
1189         struct wacom *wacom;
1190         struct wacom_wac *wacom_wac;
1191         struct wacom_features *features;
1192         int error;
1194         if (!id->driver_info)
1195                 return -EINVAL;
1197         wacom = kzalloc(sizeof(struct wacom), GFP_KERNEL);
1198         if (!wacom)
1199                 return -ENOMEM;
1201         wacom_wac = &wacom->wacom_wac;
1202         wacom_wac->features = *((struct wacom_features *)id->driver_info);
1203         features = &wacom_wac->features;
1204         if (features->pktlen > WACOM_PKGLEN_MAX) {
1205                 error = -EINVAL;
1206                 goto fail1;
1207         }
1209         wacom_wac->data = usb_alloc_coherent(dev, WACOM_PKGLEN_MAX,
1210                                              GFP_KERNEL, &wacom->data_dma);
1211         if (!wacom_wac->data) {
1212                 error = -ENOMEM;
1213                 goto fail1;
1214         }
1216         wacom->irq = usb_alloc_urb(0, GFP_KERNEL);
1217         if (!wacom->irq) {
1218                 error = -ENOMEM;
1219                 goto fail2;
1220         }
1222         wacom->usbdev = dev;
1223         wacom->intf = intf;
1224         mutex_init(&wacom->lock);
1225         INIT_WORK(&wacom->work, wacom_wireless_work);
1226         usb_make_path(dev, wacom->phys, sizeof(wacom->phys));
1227         strlcat(wacom->phys, "/input0", sizeof(wacom->phys));
1229         endpoint = &intf->cur_altsetting->endpoint[0].desc;
1231         /* Retrieve the physical and logical size for touch devices */
1232         error = wacom_retrieve_hid_descriptor(intf, features);
1233         if (error)
1234                 goto fail3;
1236         /*
1237          * Intuos5 has no useful data about its touch interface in its
1238          * HID descriptor. If this is the touch interface (wMaxPacketSize
1239          * of WACOM_PKGLEN_BBTOUCH3), override the table values.
1240          */
1241         if (features->type >= INTUOS5S && features->type <= INTUOS5L) {
1242                 if (endpoint->wMaxPacketSize == WACOM_PKGLEN_BBTOUCH3) {
1243                         features->device_type = BTN_TOOL_FINGER;
1244                         features->pktlen = WACOM_PKGLEN_BBTOUCH3;
1246                         wacom_set_phy_from_res(features);
1248                         features->x_max = 4096;
1249                         features->y_max = 4096;
1250                 } else {
1251                         features->device_type = BTN_TOOL_PEN;
1252                 }
1253         }
1255         wacom_setup_device_quirks(features);
1257         strlcpy(wacom_wac->name, features->name, sizeof(wacom_wac->name));
1259         if (features->quirks & WACOM_QUIRK_MULTI_INPUT) {
1260                 /* Append the device type to the name */
1261                 strlcat(wacom_wac->name,
1262                         features->device_type == BTN_TOOL_PEN ?
1263                                 " Pen" : " Finger",
1264                         sizeof(wacom_wac->name));
1266                 error = wacom_add_shared_data(wacom_wac, dev);
1267                 if (error)
1268                         goto fail3;
1269         }
1271         usb_fill_int_urb(wacom->irq, dev,
1272                          usb_rcvintpipe(dev, endpoint->bEndpointAddress),
1273                          wacom_wac->data, features->pktlen,
1274                          wacom_sys_irq, wacom, endpoint->bInterval);
1275         wacom->irq->transfer_dma = wacom->data_dma;
1276         wacom->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1278         error = wacom_initialize_leds(wacom);
1279         if (error)
1280                 goto fail4;
1282         if (!(features->quirks & WACOM_QUIRK_NO_INPUT)) {
1283                 error = wacom_register_input(wacom);
1284                 if (error)
1285                         goto fail5;
1286         }
1288         /* Note that if query fails it is not a hard failure */
1289         wacom_query_tablet_data(intf, features);
1291         usb_set_intfdata(intf, wacom);
1293         if (features->quirks & WACOM_QUIRK_MONITOR) {
1294                 if (usb_submit_urb(wacom->irq, GFP_KERNEL))
1295                         goto fail5;
1296         }
1298         return 0;
1300  fail5: wacom_destroy_leds(wacom);
1301  fail4: wacom_remove_shared_data(wacom_wac);
1302  fail3: usb_free_urb(wacom->irq);
1303  fail2: usb_free_coherent(dev, WACOM_PKGLEN_MAX, wacom_wac->data, wacom->data_dma);
1304  fail1: kfree(wacom);
1305         return error;
1308 static void wacom_disconnect(struct usb_interface *intf)
1310         struct wacom *wacom = usb_get_intfdata(intf);
1312         usb_set_intfdata(intf, NULL);
1314         usb_kill_urb(wacom->irq);
1315         cancel_work_sync(&wacom->work);
1316         if (wacom->wacom_wac.input)
1317                 input_unregister_device(wacom->wacom_wac.input);
1318         wacom_destroy_battery(wacom);
1319         wacom_destroy_leds(wacom);
1320         usb_free_urb(wacom->irq);
1321         usb_free_coherent(interface_to_usbdev(intf), WACOM_PKGLEN_MAX,
1322                         wacom->wacom_wac.data, wacom->data_dma);
1323         wacom_remove_shared_data(&wacom->wacom_wac);
1324         kfree(wacom);
1327 static int wacom_suspend(struct usb_interface *intf, pm_message_t message)
1329         struct wacom *wacom = usb_get_intfdata(intf);
1331         mutex_lock(&wacom->lock);
1332         usb_kill_urb(wacom->irq);
1333         mutex_unlock(&wacom->lock);
1335         return 0;
1338 static int wacom_resume(struct usb_interface *intf)
1340         struct wacom *wacom = usb_get_intfdata(intf);
1341         struct wacom_features *features = &wacom->wacom_wac.features;
1342         int rv = 0;
1344         mutex_lock(&wacom->lock);
1346         /* switch to wacom mode first */
1347         wacom_query_tablet_data(intf, features);
1348         wacom_led_control(wacom);
1350         if ((wacom->open || features->quirks & WACOM_QUIRK_MONITOR)
1351              && usb_submit_urb(wacom->irq, GFP_NOIO) < 0)
1352                 rv = -EIO;
1354         mutex_unlock(&wacom->lock);
1356         return rv;
1359 static int wacom_reset_resume(struct usb_interface *intf)
1361         return wacom_resume(intf);
1364 static struct usb_driver wacom_driver = {
1365         .name =         "wacom",
1366         .id_table =     wacom_ids,
1367         .probe =        wacom_probe,
1368         .disconnect =   wacom_disconnect,
1369         .suspend =      wacom_suspend,
1370         .resume =       wacom_resume,
1371         .reset_resume = wacom_reset_resume,
1372         .supports_autosuspend = 1,
1373 };
1375 module_usb_driver(wacom_driver);