Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
wacom_sys.c
Go to the documentation of this file.
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 {
40 };
41 
42 struct hid_descriptor {
43  struct usb_descriptor_header header;
44  __le16 bcdHID;
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),
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),
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 /*
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)
232 {
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);
237 
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  }
242 }
243 
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)
252 {
253  features->x_phy = (features->x_max * 100) / features->x_resolution;
254  features->y_phy = (features->y_max * 100) / features->y_resolution;
255 }
256 
257 static int wacom_parse_logical_collection(unsigned char *report,
258  struct wacom_features *features)
259 {
260  int length = 0;
261 
262  if (features->type == BAMBOO_PT) {
263 
264  /* Logical collection is only used by 3rd gen Bamboo Touch */
265  features->pktlen = WACOM_PKGLEN_BBTOUCH3;
266  features->device_type = BTN_TOOL_FINGER;
267 
268  wacom_set_phy_from_res(features);
269 
270  features->x_max = features->y_max =
271  get_unaligned_le16(&report[10]);
272 
273  length = 11;
274  }
275  return length;
276 }
277 
278 static void wacom_retrieve_report_data(struct usb_interface *intf,
279  struct wacom_features *features)
280 {
281  int result = 0;
282  unsigned char *rep_data;
283 
284  rep_data = kmalloc(2, GFP_KERNEL);
285  if (rep_data) {
286 
287  rep_data[0] = 12;
288  result = wacom_get_report(intf, WAC_HID_FEATURE_REPORT,
289  rep_data[0], rep_data, 2,
291 
292  if (result >= 0 && rep_data[1] > 2)
293  features->touch_max = rep_data[1];
294 
295  kfree(rep_data);
296  }
297 }
298 
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)
338 {
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;
345 
346  report = kzalloc(hid_desc->wDescriptorLength, GFP_KERNEL);
347  if (!report)
348  return -ENOMEM;
349 
350  /* retrive report descriptors */
351  do {
352  result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
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);
361 
362  /* No need to parse the Descriptor. It isn't an error though */
363  if (result < 0)
364  goto out;
365 
366  for (i = 0; i < hid_desc->wDescriptorLength; i++) {
367 
368  switch (report[i]) {
369  case HID_USAGE_PAGE:
370  switch (report[i + 1]) {
373  i++;
374  break;
375 
377  usage = WCM_DESKTOP;
378  i++;
379  break;
380  }
381  break;
382 
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  }
393 
394  if (features->type == MTSCREEN || features->type == WACOM_24HDT)
395  features->pktlen = WACOM_PKGLEN_MTOUCH;
396 
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 if (features->type == WACOM_24HDT) {
406  features->x_max =
407  get_unaligned_le16(&report[i + 3]);
408  features->x_phy =
409  get_unaligned_le16(&report[i + 8]);
410  features->unit = report[i - 1];
411  features->unitExpo = report[i - 3];
412  i += 12;
413  } else {
414  features->x_max =
415  get_unaligned_le16(&report[i + 3]);
416  features->x_phy =
417  get_unaligned_le16(&report[i + 6]);
418  features->unit = report[i + 9];
419  features->unitExpo = report[i + 11];
420  i += 12;
421  }
422  } else if (pen) {
423  /* penabled only accepts exact bytes of data */
424  if (features->type == TABLETPC2FG)
425  features->pktlen = WACOM_PKGLEN_GRAPHIRE;
426  features->device_type = BTN_TOOL_PEN;
427  features->x_max =
428  get_unaligned_le16(&report[i + 3]);
429  i += 4;
430  }
431  }
432  break;
433 
434  case HID_USAGE_Y:
435  if (usage == WCM_DESKTOP) {
436  if (finger) {
437  int type = features->type;
438 
439  if (type == TABLETPC2FG || type == MTSCREEN) {
440  features->y_max =
441  get_unaligned_le16(&report[i + 3]);
442  features->y_phy =
443  get_unaligned_le16(&report[i + 6]);
444  i += 7;
445  } else if (type == WACOM_24HDT) {
446  features->y_max =
447  get_unaligned_le16(&report[i + 3]);
448  features->y_phy =
449  get_unaligned_le16(&report[i - 2]);
450  i += 7;
451  } else if (type == BAMBOO_PT) {
452  features->y_phy =
453  get_unaligned_le16(&report[i + 3]);
454  features->y_max =
455  get_unaligned_le16(&report[i + 6]);
456  i += 12;
457  } else {
458  features->y_max =
459  features->x_max;
460  features->y_phy =
461  get_unaligned_le16(&report[i + 3]);
462  i += 4;
463  }
464  } else if (pen) {
465  features->y_max =
466  get_unaligned_le16(&report[i + 3]);
467  i += 4;
468  }
469  }
470  break;
471 
472  case HID_USAGE_FINGER:
473  finger = 1;
474  i++;
475  break;
476 
477  /*
478  * Requiring Stylus Usage will ignore boot mouse
479  * X/Y values and some cases of invalid Digitizer X/Y
480  * values commonly reported.
481  */
482  case HID_USAGE_STYLUS:
483  pen = 1;
484  i++;
485  break;
486 
488  /* leave touch_max as is if predefined */
489  if (!features->touch_max)
490  wacom_retrieve_report_data(intf, features);
491  i++;
492  break;
493  }
494  break;
495 
496  case HID_COLLECTION_END:
497  /* reset UsagePage and Finger */
498  finger = usage = 0;
499  break;
500 
501  case HID_COLLECTION:
502  i++;
503  switch (report[i]) {
505  i += wacom_parse_logical_collection(&report[i],
506  features);
507  break;
508  }
509  break;
510  }
511  }
512 
513  out:
514  result = 0;
515  kfree(report);
516  return result;
517 }
518 
519 static int wacom_set_device_mode(struct usb_interface *intf, int report_id, int length, int mode)
520 {
521  unsigned char *rep_data;
522  int error = -ENOMEM, limit = 0;
523 
524  rep_data = kzalloc(length, GFP_KERNEL);
525  if (!rep_data)
526  return error;
527 
528  rep_data[0] = report_id;
529  rep_data[1] = mode;
530 
531  do {
532  error = wacom_set_report(intf, WAC_HID_FEATURE_REPORT,
533  report_id, rep_data, length, 1);
534  if (error >= 0)
535  error = wacom_get_report(intf, WAC_HID_FEATURE_REPORT,
536  report_id, rep_data, length, 1);
537  } while ((error < 0 || rep_data[1] != mode) && limit++ < WAC_MSG_RETRIES);
538 
539  kfree(rep_data);
540 
541  return error < 0 ? error : 0;
542 }
543 
544 /*
545  * Switch the tablet into its most-capable mode. Wacom tablets are
546  * typically configured to power-up in a mode which sends mouse-like
547  * reports to the OS. To get absolute position, pressure data, etc.
548  * from the tablet, it is necessary to switch the tablet out of this
549  * mode and into one which sends the full range of tablet data.
550  */
551 static int wacom_query_tablet_data(struct usb_interface *intf, struct wacom_features *features)
552 {
553  if (features->device_type == BTN_TOOL_FINGER) {
554  if (features->type > TABLETPC) {
555  /* MT Tablet PC touch */
556  return wacom_set_device_mode(intf, 3, 4, 4);
557  }
558  else if (features->type == WACOM_24HDT) {
559  return wacom_set_device_mode(intf, 18, 3, 2);
560  }
561  } else if (features->device_type == BTN_TOOL_PEN) {
562  if (features->type <= BAMBOO_PT && features->type != WIRELESS) {
563  return wacom_set_device_mode(intf, 2, 2, 2);
564  }
565  }
566 
567  return 0;
568 }
569 
570 static int wacom_retrieve_hid_descriptor(struct usb_interface *intf,
571  struct wacom_features *features)
572 {
573  int error = 0;
574  struct usb_host_interface *interface = intf->cur_altsetting;
575  struct hid_descriptor *hid_desc;
576 
577  /* default features */
578  features->device_type = BTN_TOOL_PEN;
579  features->x_fuzz = 4;
580  features->y_fuzz = 4;
581  features->pressure_fuzz = 0;
582  features->distance_fuzz = 0;
583 
584  /*
585  * The wireless device HID is basic and layout conflicts with
586  * other tablets (monitor and touch interface can look like pen).
587  * Skip the query for this type and modify defaults based on
588  * interface number.
589  */
590  if (features->type == WIRELESS) {
591  if (intf->cur_altsetting->desc.bInterfaceNumber == 0) {
592  features->device_type = 0;
593  } else if (intf->cur_altsetting->desc.bInterfaceNumber == 2) {
594  features->device_type = BTN_TOOL_FINGER;
595  features->pktlen = WACOM_PKGLEN_BBTOUCH3;
596  }
597  }
598 
599  /* only devices that support touch need to retrieve the info */
600  if (features->type < BAMBOO_PT) {
601  goto out;
602  }
603 
604  error = usb_get_extra_descriptor(interface, HID_DEVICET_HID, &hid_desc);
605  if (error) {
606  error = usb_get_extra_descriptor(&interface->endpoint[0],
607  HID_DEVICET_REPORT, &hid_desc);
608  if (error) {
609  dev_err(&intf->dev,
610  "can not retrieve extra class descriptor\n");
611  goto out;
612  }
613  }
614  error = wacom_parse_hid(intf, hid_desc, features);
615  if (error)
616  goto out;
617  wacom_fix_phy_from_hid(features);
618 
619  out:
620  return error;
621 }
622 
624  struct list_head list;
625  struct kref kref;
626  struct usb_device *dev;
628 };
629 
630 static LIST_HEAD(wacom_udev_list);
631 static DEFINE_MUTEX(wacom_udev_list_lock);
632 
633 static struct usb_device *wacom_get_sibling(struct usb_device *dev, int vendor, int product)
634 {
635  int port1;
636  struct usb_device *sibling;
637 
638  if (vendor == 0 && product == 0)
639  return dev;
640 
641  if (dev->parent == NULL)
642  return NULL;
643 
644  usb_hub_for_each_child(dev->parent, port1, sibling) {
645  struct usb_device_descriptor *d;
646  if (sibling == NULL)
647  continue;
648 
649  d = &sibling->descriptor;
650  if (d->idVendor == vendor && d->idProduct == product)
651  return sibling;
652  }
653 
654  return NULL;
655 }
656 
657 static struct wacom_usbdev_data *wacom_get_usbdev_data(struct usb_device *dev)
658 {
659  struct wacom_usbdev_data *data;
660 
661  list_for_each_entry(data, &wacom_udev_list, list) {
662  if (data->dev == dev) {
663  kref_get(&data->kref);
664  return data;
665  }
666  }
667 
668  return NULL;
669 }
670 
671 static int wacom_add_shared_data(struct wacom_wac *wacom,
672  struct usb_device *dev)
673 {
674  struct wacom_usbdev_data *data;
675  int retval = 0;
676 
677  mutex_lock(&wacom_udev_list_lock);
678 
679  data = wacom_get_usbdev_data(dev);
680  if (!data) {
681  data = kzalloc(sizeof(struct wacom_usbdev_data), GFP_KERNEL);
682  if (!data) {
683  retval = -ENOMEM;
684  goto out;
685  }
686 
687  kref_init(&data->kref);
688  data->dev = dev;
689  list_add_tail(&data->list, &wacom_udev_list);
690  }
691 
692  wacom->shared = &data->shared;
693 
694 out:
695  mutex_unlock(&wacom_udev_list_lock);
696  return retval;
697 }
698 
699 static void wacom_release_shared_data(struct kref *kref)
700 {
701  struct wacom_usbdev_data *data =
702  container_of(kref, struct wacom_usbdev_data, kref);
703 
704  mutex_lock(&wacom_udev_list_lock);
705  list_del(&data->list);
706  mutex_unlock(&wacom_udev_list_lock);
707 
708  kfree(data);
709 }
710 
711 static void wacom_remove_shared_data(struct wacom_wac *wacom)
712 {
713  struct wacom_usbdev_data *data;
714 
715  if (wacom->shared) {
716  data = container_of(wacom->shared, struct wacom_usbdev_data, shared);
717  kref_put(&data->kref, wacom_release_shared_data);
718  wacom->shared = NULL;
719  }
720 }
721 
722 static int wacom_led_control(struct wacom *wacom)
723 {
724  unsigned char *buf;
725  int retval;
726 
727  buf = kzalloc(9, GFP_KERNEL);
728  if (!buf)
729  return -ENOMEM;
730 
731  if (wacom->wacom_wac.features.type >= INTUOS5S &&
732  wacom->wacom_wac.features.type <= INTUOS5L) {
733  /*
734  * Touch Ring and crop mark LED luminance may take on
735  * one of four values:
736  * 0 = Low; 1 = Medium; 2 = High; 3 = Off
737  */
738  int ring_led = wacom->led.select[0] & 0x03;
739  int ring_lum = (((wacom->led.llv & 0x60) >> 5) - 1) & 0x03;
740  int crop_lum = 0;
741 
742  buf[0] = WAC_CMD_LED_CONTROL;
743  buf[1] = (crop_lum << 4) | (ring_lum << 2) | (ring_led);
744  }
745  else {
746  int led = wacom->led.select[0] | 0x4;
747 
748  if (wacom->wacom_wac.features.type == WACOM_21UX2 ||
749  wacom->wacom_wac.features.type == WACOM_24HD)
750  led |= (wacom->led.select[1] << 4) | 0x40;
751 
752  buf[0] = WAC_CMD_LED_CONTROL;
753  buf[1] = led;
754  buf[2] = wacom->led.llv;
755  buf[3] = wacom->led.hlv;
756  buf[4] = wacom->led.img_lum;
757  }
758 
759  retval = wacom_set_report(wacom->intf, 0x03, WAC_CMD_LED_CONTROL,
760  buf, 9, WAC_CMD_RETRIES);
761  kfree(buf);
762 
763  return retval;
764 }
765 
766 static int wacom_led_putimage(struct wacom *wacom, int button_id, const void *img)
767 {
768  unsigned char *buf;
769  int i, retval;
770 
771  buf = kzalloc(259, GFP_KERNEL);
772  if (!buf)
773  return -ENOMEM;
774 
775  /* Send 'start' command */
776  buf[0] = WAC_CMD_ICON_START;
777  buf[1] = 1;
778  retval = wacom_set_report(wacom->intf, 0x03, WAC_CMD_ICON_START,
779  buf, 2, WAC_CMD_RETRIES);
780  if (retval < 0)
781  goto out;
782 
783  buf[0] = WAC_CMD_ICON_XFER;
784  buf[1] = button_id & 0x07;
785  for (i = 0; i < 4; i++) {
786  buf[2] = i;
787  memcpy(buf + 3, img + i * 256, 256);
788 
789  retval = wacom_set_report(wacom->intf, 0x03, WAC_CMD_ICON_XFER,
790  buf, 259, WAC_CMD_RETRIES);
791  if (retval < 0)
792  break;
793  }
794 
795  /* Send 'stop' */
796  buf[0] = WAC_CMD_ICON_START;
797  buf[1] = 0;
798  wacom_set_report(wacom->intf, 0x03, WAC_CMD_ICON_START,
799  buf, 2, WAC_CMD_RETRIES);
800 
801 out:
802  kfree(buf);
803  return retval;
804 }
805 
806 static ssize_t wacom_led_select_store(struct device *dev, int set_id,
807  const char *buf, size_t count)
808 {
809  struct wacom *wacom = dev_get_drvdata(dev);
810  unsigned int id;
811  int err;
812 
813  err = kstrtouint(buf, 10, &id);
814  if (err)
815  return err;
816 
817  mutex_lock(&wacom->lock);
818 
819  wacom->led.select[set_id] = id & 0x3;
820  err = wacom_led_control(wacom);
821 
822  mutex_unlock(&wacom->lock);
823 
824  return err < 0 ? err : count;
825 }
826 
827 #define DEVICE_LED_SELECT_ATTR(SET_ID) \
828 static ssize_t wacom_led##SET_ID##_select_store(struct device *dev, \
829  struct device_attribute *attr, const char *buf, size_t count) \
830 { \
831  return wacom_led_select_store(dev, SET_ID, buf, count); \
832 } \
833 static ssize_t wacom_led##SET_ID##_select_show(struct device *dev, \
834  struct device_attribute *attr, char *buf) \
835 { \
836  struct wacom *wacom = dev_get_drvdata(dev); \
837  return snprintf(buf, 2, "%d\n", wacom->led.select[SET_ID]); \
838 } \
839 static DEVICE_ATTR(status_led##SET_ID##_select, S_IWUSR | S_IRUSR, \
840  wacom_led##SET_ID##_select_show, \
841  wacom_led##SET_ID##_select_store)
842 
845 
846 static ssize_t wacom_luminance_store(struct wacom *wacom, u8 *dest,
847  const char *buf, size_t count)
848 {
849  unsigned int value;
850  int err;
851 
852  err = kstrtouint(buf, 10, &value);
853  if (err)
854  return err;
855 
856  mutex_lock(&wacom->lock);
857 
858  *dest = value & 0x7f;
859  err = wacom_led_control(wacom);
860 
861  mutex_unlock(&wacom->lock);
862 
863  return err < 0 ? err : count;
864 }
865 
866 #define DEVICE_LUMINANCE_ATTR(name, field) \
867 static ssize_t wacom_##name##_luminance_store(struct device *dev, \
868  struct device_attribute *attr, const char *buf, size_t count) \
869 { \
870  struct wacom *wacom = dev_get_drvdata(dev); \
871  \
872  return wacom_luminance_store(wacom, &wacom->led.field, \
873  buf, count); \
874 } \
875 static DEVICE_ATTR(name##_luminance, S_IWUSR, \
876  NULL, wacom_##name##_luminance_store)
877 
881 
882 static ssize_t wacom_button_image_store(struct device *dev, int button_id,
883  const char *buf, size_t count)
884 {
885  struct wacom *wacom = dev_get_drvdata(dev);
886  int err;
887 
888  if (count != 1024)
889  return -EINVAL;
890 
891  mutex_lock(&wacom->lock);
892 
893  err = wacom_led_putimage(wacom, button_id, buf);
894 
895  mutex_unlock(&wacom->lock);
896 
897  return err < 0 ? err : count;
898 }
899 
900 #define DEVICE_BTNIMG_ATTR(BUTTON_ID) \
901 static ssize_t wacom_btnimg##BUTTON_ID##_store(struct device *dev, \
902  struct device_attribute *attr, const char *buf, size_t count) \
903 { \
904  return wacom_button_image_store(dev, BUTTON_ID, buf, count); \
905 } \
906 static DEVICE_ATTR(button##BUTTON_ID##_rawimg, S_IWUSR, \
907  NULL, wacom_btnimg##BUTTON_ID##_store)
908 
917 
918 static struct attribute *cintiq_led_attrs[] = {
919  &dev_attr_status_led0_select.attr,
920  &dev_attr_status_led1_select.attr,
921  NULL
922 };
923 
924 static struct attribute_group cintiq_led_attr_group = {
925  .name = "wacom_led",
926  .attrs = cintiq_led_attrs,
927 };
928 
929 static struct attribute *intuos4_led_attrs[] = {
930  &dev_attr_status0_luminance.attr,
931  &dev_attr_status1_luminance.attr,
932  &dev_attr_status_led0_select.attr,
933  &dev_attr_buttons_luminance.attr,
934  &dev_attr_button0_rawimg.attr,
935  &dev_attr_button1_rawimg.attr,
936  &dev_attr_button2_rawimg.attr,
937  &dev_attr_button3_rawimg.attr,
938  &dev_attr_button4_rawimg.attr,
939  &dev_attr_button5_rawimg.attr,
940  &dev_attr_button6_rawimg.attr,
941  &dev_attr_button7_rawimg.attr,
942  NULL
943 };
944 
945 static struct attribute_group intuos4_led_attr_group = {
946  .name = "wacom_led",
947  .attrs = intuos4_led_attrs,
948 };
949 
950 static struct attribute *intuos5_led_attrs[] = {
951  &dev_attr_status0_luminance.attr,
952  &dev_attr_status_led0_select.attr,
953  NULL
954 };
955 
956 static struct attribute_group intuos5_led_attr_group = {
957  .name = "wacom_led",
958  .attrs = intuos5_led_attrs,
959 };
960 
961 static int wacom_initialize_leds(struct wacom *wacom)
962 {
963  int error;
964 
965  /* Initialize default values */
966  switch (wacom->wacom_wac.features.type) {
967  case INTUOS4S:
968  case INTUOS4:
969  case INTUOS4L:
970  wacom->led.select[0] = 0;
971  wacom->led.select[1] = 0;
972  wacom->led.llv = 10;
973  wacom->led.hlv = 20;
974  wacom->led.img_lum = 10;
975  error = sysfs_create_group(&wacom->intf->dev.kobj,
976  &intuos4_led_attr_group);
977  break;
978 
979  case WACOM_24HD:
980  case WACOM_21UX2:
981  wacom->led.select[0] = 0;
982  wacom->led.select[1] = 0;
983  wacom->led.llv = 0;
984  wacom->led.hlv = 0;
985  wacom->led.img_lum = 0;
986 
987  error = sysfs_create_group(&wacom->intf->dev.kobj,
988  &cintiq_led_attr_group);
989  break;
990 
991  case INTUOS5S:
992  case INTUOS5:
993  case INTUOS5L:
994  wacom->led.select[0] = 0;
995  wacom->led.select[1] = 0;
996  wacom->led.llv = 32;
997  wacom->led.hlv = 0;
998  wacom->led.img_lum = 0;
999 
1000  error = sysfs_create_group(&wacom->intf->dev.kobj,
1001  &intuos5_led_attr_group);
1002  break;
1003 
1004  default:
1005  return 0;
1006  }
1007 
1008  if (error) {
1009  dev_err(&wacom->intf->dev,
1010  "cannot create sysfs group err: %d\n", error);
1011  return error;
1012  }
1013  wacom_led_control(wacom);
1014 
1015  return 0;
1016 }
1017 
1018 static void wacom_destroy_leds(struct wacom *wacom)
1019 {
1020  switch (wacom->wacom_wac.features.type) {
1021  case INTUOS4S:
1022  case INTUOS4:
1023  case INTUOS4L:
1024  sysfs_remove_group(&wacom->intf->dev.kobj,
1025  &intuos4_led_attr_group);
1026  break;
1027 
1028  case WACOM_24HD:
1029  case WACOM_21UX2:
1030  sysfs_remove_group(&wacom->intf->dev.kobj,
1031  &cintiq_led_attr_group);
1032  break;
1033 
1034  case INTUOS5S:
1035  case INTUOS5:
1036  case INTUOS5L:
1037  sysfs_remove_group(&wacom->intf->dev.kobj,
1038  &intuos5_led_attr_group);
1039  break;
1040  }
1041 }
1042 
1043 static enum power_supply_property wacom_battery_props[] = {
1045 };
1046 
1047 static int wacom_battery_get_property(struct power_supply *psy,
1048  enum power_supply_property psp,
1049  union power_supply_propval *val)
1050 {
1051  struct wacom *wacom = container_of(psy, struct wacom, battery);
1052  int ret = 0;
1053 
1054  switch (psp) {
1056  val->intval =
1057  wacom->wacom_wac.battery_capacity * 100 / 31;
1058  break;
1059  default:
1060  ret = -EINVAL;
1061  break;
1062  }
1063 
1064  return ret;
1065 }
1066 
1067 static int wacom_initialize_battery(struct wacom *wacom)
1068 {
1069  int error = 0;
1070 
1071  if (wacom->wacom_wac.features.quirks & WACOM_QUIRK_MONITOR) {
1072  wacom->battery.properties = wacom_battery_props;
1073  wacom->battery.num_properties = ARRAY_SIZE(wacom_battery_props);
1074  wacom->battery.get_property = wacom_battery_get_property;
1075  wacom->battery.name = "wacom_battery";
1076  wacom->battery.type = POWER_SUPPLY_TYPE_BATTERY;
1077  wacom->battery.use_for_apm = 0;
1078 
1079  error = power_supply_register(&wacom->usbdev->dev,
1080  &wacom->battery);
1081 
1082  if (!error)
1083  power_supply_powers(&wacom->battery,
1084  &wacom->usbdev->dev);
1085  }
1086 
1087  return error;
1088 }
1089 
1090 static void wacom_destroy_battery(struct wacom *wacom)
1091 {
1092  if (wacom->wacom_wac.features.quirks & WACOM_QUIRK_MONITOR &&
1093  wacom->battery.dev) {
1095  wacom->battery.dev = NULL;
1096  }
1097 }
1098 
1099 static int wacom_register_input(struct wacom *wacom)
1100 {
1101  struct input_dev *input_dev;
1102  struct usb_interface *intf = wacom->intf;
1103  struct usb_device *dev = interface_to_usbdev(intf);
1104  struct wacom_wac *wacom_wac = &(wacom->wacom_wac);
1105  int error;
1106 
1107  input_dev = input_allocate_device();
1108  if (!input_dev) {
1109  error = -ENOMEM;
1110  goto fail1;
1111  }
1112 
1113  input_dev->name = wacom_wac->name;
1114  input_dev->dev.parent = &intf->dev;
1115  input_dev->open = wacom_open;
1116  input_dev->close = wacom_close;
1117  usb_to_input_id(dev, &input_dev->id);
1118  input_set_drvdata(input_dev, wacom);
1119 
1120  wacom_wac->input = input_dev;
1121  error = wacom_setup_input_capabilities(input_dev, wacom_wac);
1122  if (error)
1123  goto fail1;
1124 
1125  error = input_register_device(input_dev);
1126  if (error)
1127  goto fail2;
1128 
1129  return 0;
1130 
1131 fail2:
1132  input_free_device(input_dev);
1133  wacom_wac->input = NULL;
1134 fail1:
1135  return error;
1136 }
1137 
1138 static void wacom_wireless_work(struct work_struct *work)
1139 {
1140  struct wacom *wacom = container_of(work, struct wacom, work);
1141  struct usb_device *usbdev = wacom->usbdev;
1142  struct wacom_wac *wacom_wac = &wacom->wacom_wac;
1143  struct wacom *wacom1, *wacom2;
1144  struct wacom_wac *wacom_wac1, *wacom_wac2;
1145  int error;
1146 
1147  /*
1148  * Regardless if this is a disconnect or a new tablet,
1149  * remove any existing input and battery devices.
1150  */
1151 
1152  wacom_destroy_battery(wacom);
1153 
1154  /* Stylus interface */
1155  wacom1 = usb_get_intfdata(usbdev->config->interface[1]);
1156  wacom_wac1 = &(wacom1->wacom_wac);
1157  if (wacom_wac1->input)
1158  input_unregister_device(wacom_wac1->input);
1159  wacom_wac1->input = NULL;
1160 
1161  /* Touch interface */
1162  wacom2 = usb_get_intfdata(usbdev->config->interface[2]);
1163  wacom_wac2 = &(wacom2->wacom_wac);
1164  if (wacom_wac2->input)
1165  input_unregister_device(wacom_wac2->input);
1166  wacom_wac2->input = NULL;
1167 
1168  if (wacom_wac->pid == 0) {
1169  dev_info(&wacom->intf->dev, "wireless tablet disconnected\n");
1170  } else {
1171  const struct usb_device_id *id = wacom_ids;
1172 
1173  dev_info(&wacom->intf->dev,
1174  "wireless tablet connected with PID %x\n",
1175  wacom_wac->pid);
1176 
1177  while (id->match_flags) {
1178  if (id->idVendor == USB_VENDOR_ID_WACOM &&
1179  id->idProduct == wacom_wac->pid)
1180  break;
1181  id++;
1182  }
1183 
1184  if (!id->match_flags) {
1185  dev_info(&wacom->intf->dev,
1186  "ignoring unknown PID.\n");
1187  return;
1188  }
1189 
1190  /* Stylus interface */
1191  wacom_wac1->features =
1192  *((struct wacom_features *)id->driver_info);
1193  wacom_wac1->features.device_type = BTN_TOOL_PEN;
1194  error = wacom_register_input(wacom1);
1195  if (error)
1196  goto fail1;
1197 
1198  /* Touch interface */
1199  wacom_wac2->features =
1200  *((struct wacom_features *)id->driver_info);
1201  wacom_wac2->features.pktlen = WACOM_PKGLEN_BBTOUCH3;
1202  wacom_wac2->features.device_type = BTN_TOOL_FINGER;
1203  wacom_set_phy_from_res(&wacom_wac2->features);
1204  wacom_wac2->features.x_max = wacom_wac2->features.y_max = 4096;
1205  error = wacom_register_input(wacom2);
1206  if (error)
1207  goto fail2;
1208 
1209  error = wacom_initialize_battery(wacom);
1210  if (error)
1211  goto fail3;
1212  }
1213 
1214  return;
1215 
1216 fail3:
1217  input_unregister_device(wacom_wac2->input);
1218  wacom_wac2->input = NULL;
1219 fail2:
1220  input_unregister_device(wacom_wac1->input);
1221  wacom_wac1->input = NULL;
1222 fail1:
1223  return;
1224 }
1225 
1226 static int wacom_probe(struct usb_interface *intf, const struct usb_device_id *id)
1227 {
1228  struct usb_device *dev = interface_to_usbdev(intf);
1230  struct wacom *wacom;
1231  struct wacom_wac *wacom_wac;
1232  struct wacom_features *features;
1233  int error;
1234 
1235  if (!id->driver_info)
1236  return -EINVAL;
1237 
1238  wacom = kzalloc(sizeof(struct wacom), GFP_KERNEL);
1239  if (!wacom)
1240  return -ENOMEM;
1241 
1242  wacom_wac = &wacom->wacom_wac;
1243  wacom_wac->features = *((struct wacom_features *)id->driver_info);
1244  features = &wacom_wac->features;
1245  if (features->pktlen > WACOM_PKGLEN_MAX) {
1246  error = -EINVAL;
1247  goto fail1;
1248  }
1249 
1250  wacom_wac->data = usb_alloc_coherent(dev, WACOM_PKGLEN_MAX,
1251  GFP_KERNEL, &wacom->data_dma);
1252  if (!wacom_wac->data) {
1253  error = -ENOMEM;
1254  goto fail1;
1255  }
1256 
1257  wacom->irq = usb_alloc_urb(0, GFP_KERNEL);
1258  if (!wacom->irq) {
1259  error = -ENOMEM;
1260  goto fail2;
1261  }
1262 
1263  wacom->usbdev = dev;
1264  wacom->intf = intf;
1265  mutex_init(&wacom->lock);
1266  INIT_WORK(&wacom->work, wacom_wireless_work);
1267  usb_make_path(dev, wacom->phys, sizeof(wacom->phys));
1268  strlcat(wacom->phys, "/input0", sizeof(wacom->phys));
1269 
1270  endpoint = &intf->cur_altsetting->endpoint[0].desc;
1271 
1272  /* Retrieve the physical and logical size for touch devices */
1273  error = wacom_retrieve_hid_descriptor(intf, features);
1274  if (error)
1275  goto fail3;
1276 
1277  /*
1278  * Intuos5 has no useful data about its touch interface in its
1279  * HID descriptor. If this is the touch interface (wMaxPacketSize
1280  * of WACOM_PKGLEN_BBTOUCH3), override the table values.
1281  */
1282  if (features->type >= INTUOS5S && features->type <= INTUOS5L) {
1283  if (endpoint->wMaxPacketSize == WACOM_PKGLEN_BBTOUCH3) {
1284  features->device_type = BTN_TOOL_FINGER;
1285  features->pktlen = WACOM_PKGLEN_BBTOUCH3;
1286 
1287  wacom_set_phy_from_res(features);
1288 
1289  features->x_max = 4096;
1290  features->y_max = 4096;
1291  } else {
1292  features->device_type = BTN_TOOL_PEN;
1293  }
1294  }
1295 
1296  wacom_setup_device_quirks(features);
1297 
1298  strlcpy(wacom_wac->name, features->name, sizeof(wacom_wac->name));
1299 
1300  if (features->quirks & WACOM_QUIRK_MULTI_INPUT) {
1301  struct usb_device *other_dev;
1302 
1303  /* Append the device type to the name */
1304  strlcat(wacom_wac->name,
1305  features->device_type == BTN_TOOL_PEN ?
1306  " Pen" : " Finger",
1307  sizeof(wacom_wac->name));
1308 
1309 
1310  other_dev = wacom_get_sibling(dev, features->oVid, features->oPid);
1311  if (other_dev == NULL || wacom_get_usbdev_data(other_dev) == NULL)
1312  other_dev = dev;
1313  error = wacom_add_shared_data(wacom_wac, other_dev);
1314  if (error)
1315  goto fail3;
1316  }
1317 
1318  usb_fill_int_urb(wacom->irq, dev,
1319  usb_rcvintpipe(dev, endpoint->bEndpointAddress),
1320  wacom_wac->data, features->pktlen,
1321  wacom_sys_irq, wacom, endpoint->bInterval);
1322  wacom->irq->transfer_dma = wacom->data_dma;
1323  wacom->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1324 
1325  error = wacom_initialize_leds(wacom);
1326  if (error)
1327  goto fail4;
1328 
1329  if (!(features->quirks & WACOM_QUIRK_NO_INPUT)) {
1330  error = wacom_register_input(wacom);
1331  if (error)
1332  goto fail5;
1333  }
1334 
1335  /* Note that if query fails it is not a hard failure */
1336  wacom_query_tablet_data(intf, features);
1337 
1338  usb_set_intfdata(intf, wacom);
1339 
1340  if (features->quirks & WACOM_QUIRK_MONITOR) {
1341  if (usb_submit_urb(wacom->irq, GFP_KERNEL))
1342  goto fail5;
1343  }
1344 
1345  return 0;
1346 
1347  fail5: wacom_destroy_leds(wacom);
1348  fail4: wacom_remove_shared_data(wacom_wac);
1349  fail3: usb_free_urb(wacom->irq);
1350  fail2: usb_free_coherent(dev, WACOM_PKGLEN_MAX, wacom_wac->data, wacom->data_dma);
1351  fail1: kfree(wacom);
1352  return error;
1353 }
1354 
1355 static void wacom_disconnect(struct usb_interface *intf)
1356 {
1357  struct wacom *wacom = usb_get_intfdata(intf);
1358 
1359  usb_set_intfdata(intf, NULL);
1360 
1361  usb_kill_urb(wacom->irq);
1362  cancel_work_sync(&wacom->work);
1363  if (wacom->wacom_wac.input)
1364  input_unregister_device(wacom->wacom_wac.input);
1365  wacom_destroy_battery(wacom);
1366  wacom_destroy_leds(wacom);
1367  usb_free_urb(wacom->irq);
1368  usb_free_coherent(interface_to_usbdev(intf), WACOM_PKGLEN_MAX,
1369  wacom->wacom_wac.data, wacom->data_dma);
1370  wacom_remove_shared_data(&wacom->wacom_wac);
1371  kfree(wacom);
1372 }
1373 
1374 static int wacom_suspend(struct usb_interface *intf, pm_message_t message)
1375 {
1376  struct wacom *wacom = usb_get_intfdata(intf);
1377 
1378  mutex_lock(&wacom->lock);
1379  usb_kill_urb(wacom->irq);
1380  mutex_unlock(&wacom->lock);
1381 
1382  return 0;
1383 }
1384 
1385 static int wacom_resume(struct usb_interface *intf)
1386 {
1387  struct wacom *wacom = usb_get_intfdata(intf);
1388  struct wacom_features *features = &wacom->wacom_wac.features;
1389  int rv = 0;
1390 
1391  mutex_lock(&wacom->lock);
1392 
1393  /* switch to wacom mode first */
1394  wacom_query_tablet_data(intf, features);
1395  wacom_led_control(wacom);
1396 
1397  if ((wacom->open || features->quirks & WACOM_QUIRK_MONITOR)
1398  && usb_submit_urb(wacom->irq, GFP_NOIO) < 0)
1399  rv = -EIO;
1400 
1401  mutex_unlock(&wacom->lock);
1402 
1403  return rv;
1404 }
1405 
1406 static int wacom_reset_resume(struct usb_interface *intf)
1407 {
1408  return wacom_resume(intf);
1409 }
1410 
1411 static struct usb_driver wacom_driver = {
1412  .name = "wacom",
1413  .id_table = wacom_ids,
1414  .probe = wacom_probe,
1415  .disconnect = wacom_disconnect,
1416  .suspend = wacom_suspend,
1417  .resume = wacom_resume,
1418  .reset_resume = wacom_reset_resume,
1419  .supports_autosuspend = 1,
1420 };
1421 
1422 module_usb_driver(wacom_driver);