2 * drivers/input/tablet/wacom_sys.c
4 * USB Wacom tablet support - system specific code
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
14 #include "wacom_wac.h"
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
42 struct hid_descriptor
{
43 struct usb_descriptor_header header
;
48 __le16 wDescriptorLength
;
49 } __attribute__ ((packed
));
51 /* defines to get/set USB message */
52 #define USB_REQ_GET_REPORT 0x01
53 #define USB_REQ_SET_REPORT 0x09
55 #define WAC_HID_FEATURE_REPORT 0x03
56 #define WAC_MSG_RETRIES 5
58 #define WAC_CMD_LED_CONTROL 0x20
59 #define WAC_CMD_ICON_START 0x21
60 #define WAC_CMD_ICON_XFER 0x23
61 #define WAC_CMD_RETRIES 10
63 static int wacom_get_report(struct usb_interface
*intf
, u8 type
, u8 id
,
64 void *buf
, size_t size
, unsigned int retries
)
66 struct usb_device
*dev
= interface_to_usbdev(intf
);
70 retval
= usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
72 USB_DIR_IN
| USB_TYPE_CLASS
|
75 intf
->altsetting
[0].desc
.bInterfaceNumber
,
77 } while ((retval
== -ETIMEDOUT
|| retval
== -EPIPE
) && --retries
);
82 static int wacom_set_report(struct usb_interface
*intf
, u8 type
, u8 id
,
83 void *buf
, size_t size
, unsigned int retries
)
85 struct usb_device
*dev
= interface_to_usbdev(intf
);
89 retval
= usb_control_msg(dev
, usb_sndctrlpipe(dev
, 0),
91 USB_TYPE_CLASS
| USB_RECIP_INTERFACE
,
93 intf
->altsetting
[0].desc
.bInterfaceNumber
,
95 } while ((retval
== -ETIMEDOUT
|| retval
== -EPIPE
) && --retries
);
100 static void wacom_sys_irq(struct urb
*urb
)
102 struct wacom
*wacom
= urb
->context
;
103 struct device
*dev
= &wacom
->intf
->dev
;
106 switch (urb
->status
) {
113 /* this urb is terminated, clean up */
114 dev_dbg(dev
, "%s - urb shutting down with status: %d\n",
115 __func__
, urb
->status
);
118 dev_dbg(dev
, "%s - nonzero urb status received: %d\n",
119 __func__
, urb
->status
);
123 wacom_wac_irq(&wacom
->wacom_wac
, urb
->actual_length
);
126 usb_mark_last_busy(wacom
->usbdev
);
127 retval
= usb_submit_urb(urb
, GFP_ATOMIC
);
129 dev_err(dev
, "%s - usb_submit_urb failed with result %d\n",
133 static int wacom_open(struct input_dev
*dev
)
135 struct wacom
*wacom
= input_get_drvdata(dev
);
138 if (usb_autopm_get_interface(wacom
->intf
) < 0)
141 mutex_lock(&wacom
->lock
);
143 if (usb_submit_urb(wacom
->irq
, GFP_KERNEL
)) {
149 wacom
->intf
->needs_remote_wakeup
= 1;
152 mutex_unlock(&wacom
->lock
);
153 usb_autopm_put_interface(wacom
->intf
);
157 static void wacom_close(struct input_dev
*dev
)
159 struct wacom
*wacom
= input_get_drvdata(dev
);
162 autopm_error
= usb_autopm_get_interface(wacom
->intf
);
164 mutex_lock(&wacom
->lock
);
165 usb_kill_urb(wacom
->irq
);
167 wacom
->intf
->needs_remote_wakeup
= 0;
168 mutex_unlock(&wacom
->lock
);
171 usb_autopm_put_interface(wacom
->intf
);
175 * Calculate the resolution of the X or Y axis, given appropriate HID data.
176 * This function is little more than hidinput_calc_abs_res stripped down.
178 static int wacom_calc_hid_res(int logical_extents
, int physical_extents
,
179 unsigned char unit
, unsigned char exponent
)
181 int prev
, unit_exponent
;
183 /* Check if the extents are sane */
184 if (logical_extents
<= 0 || physical_extents
<= 0)
187 /* Get signed value of nybble-sized twos-compliment exponent */
188 unit_exponent
= exponent
;
189 if (unit_exponent
> 7)
192 /* Convert physical_extents to millimeters */
193 if (unit
== 0x11) { /* If centimeters */
195 } else if (unit
== 0x13) { /* If inches */
196 prev
= physical_extents
;
197 physical_extents
*= 254;
198 if (physical_extents
< prev
)
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
)
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
)
220 /* Calculate resolution */
221 return logical_extents
/ physical_extents
;
224 static int wacom_parse_logical_collection(unsigned char *report
,
225 struct wacom_features
*features
)
229 if (features
->type
== BAMBOO_PT
) {
231 /* Logical collection is only used by 3rd gen Bamboo Touch */
232 features
->pktlen
= WACOM_PKGLEN_BBTOUCH3
;
233 features
->device_type
= BTN_TOOL_FINGER
;
235 features
->x_max
= features
->y_max
=
236 get_unaligned_le16(&report
[10]);
243 static void wacom_retrieve_report_data(struct usb_interface
*intf
,
244 struct wacom_features
*features
)
247 unsigned char *rep_data
;
249 rep_data
= kmalloc(2, GFP_KERNEL
);
253 result
= wacom_get_report(intf
, WAC_HID_FEATURE_REPORT
,
254 rep_data
[0], rep_data
, 2,
257 if (result
>= 0 && rep_data
[1] > 2)
258 features
->touch_max
= rep_data
[1];
265 * Interface Descriptor of wacom devices can be incomplete and
266 * inconsistent so wacom_features table is used to store stylus
267 * device's packet lengths, various maximum values, and tablet
268 * resolution based on product ID's.
270 * For devices that contain 2 interfaces, wacom_features table is
271 * inaccurate for the touch interface. Since the Interface Descriptor
272 * for touch interfaces has pretty complete data, this function exists
273 * to query tablet for this missing information instead of hard coding in
274 * an additional table.
276 * A typical Interface Descriptor for a stylus will contain a
277 * boot mouse application collection that is not of interest and this
278 * function will ignore it.
280 * It also contains a digitizer application collection that also is not
281 * of interest since any information it contains would be duplicate
282 * of what is in wacom_features. Usually it defines a report of an array
283 * of bytes that could be used as max length of the stylus packet returned.
284 * If it happens to define a Digitizer-Stylus Physical Collection then
285 * the X and Y logical values contain valid data but it is ignored.
287 * A typical Interface Descriptor for a touch interface will contain a
288 * Digitizer-Finger Physical Collection which will define both logical
289 * X/Y maximum as well as the physical size of tablet. Since touch
290 * interfaces haven't supported pressure or distance, this is enough
291 * information to override invalid values in the wacom_features table.
293 * 3rd gen Bamboo Touch no longer define a Digitizer-Finger Pysical
294 * Collection. Instead they define a Logical Collection with a single
295 * Logical Maximum for both X and Y.
297 * Intuos5 touch interface does not contain useful data. We deal with
298 * this after returning from this function.
300 static int wacom_parse_hid(struct usb_interface
*intf
,
301 struct hid_descriptor
*hid_desc
,
302 struct wacom_features
*features
)
304 struct usb_device
*dev
= interface_to_usbdev(intf
);
306 /* result has to be defined as int for some devices */
308 int i
= 0, usage
= WCM_UNDEFINED
, finger
= 0, pen
= 0;
309 unsigned char *report
;
311 report
= kzalloc(hid_desc
->wDescriptorLength
, GFP_KERNEL
);
315 /* retrive report descriptors */
317 result
= usb_control_msg(dev
, usb_rcvctrlpipe(dev
, 0),
318 USB_REQ_GET_DESCRIPTOR
,
319 USB_RECIP_INTERFACE
| USB_DIR_IN
,
320 HID_DEVICET_REPORT
<< 8,
321 intf
->altsetting
[0].desc
.bInterfaceNumber
, /* interface */
323 hid_desc
->wDescriptorLength
,
325 } while (result
< 0 && limit
++ < WAC_MSG_RETRIES
);
327 /* No need to parse the Descriptor. It isn't an error though */
331 for (i
= 0; i
< hid_desc
->wDescriptorLength
; i
++) {
335 switch (report
[i
+ 1]) {
336 case HID_USAGE_PAGE_DIGITIZER
:
337 usage
= WCM_DIGITIZER
;
341 case HID_USAGE_PAGE_DESKTOP
:
349 switch (report
[i
+ 1]) {
351 if (usage
== WCM_DESKTOP
) {
353 features
->device_type
= BTN_TOOL_FINGER
;
355 switch (features
->type
) {
357 features
->pktlen
= WACOM_PKGLEN_TPC2FG
;
362 features
->pktlen
= WACOM_PKGLEN_MTOUCH
;
366 features
->pktlen
= WACOM_PKGLEN_MTTPC
;
370 features
->pktlen
= WACOM_PKGLEN_BBTOUCH
;
374 features
->pktlen
= WACOM_PKGLEN_GRAPHIRE
;
378 switch (features
->type
) {
381 get_unaligned_le16(&report
[i
+ 5]);
383 get_unaligned_le16(&report
[i
+ 8]);
389 get_unaligned_le16(&report
[i
+ 3]);
391 get_unaligned_le16(&report
[i
+ 8]);
392 features
->unit
= report
[i
- 1];
393 features
->unitExpo
= report
[i
- 3];
399 get_unaligned_le16(&report
[i
+ 3]);
401 get_unaligned_le16(&report
[i
+ 6]);
402 features
->unit
= report
[i
+ 9];
403 features
->unitExpo
= report
[i
+ 11];
408 /* penabled only accepts exact bytes of data */
409 if (features
->type
>= TABLETPC
)
410 features
->pktlen
= WACOM_PKGLEN_GRAPHIRE
;
411 features
->device_type
= BTN_TOOL_PEN
;
413 get_unaligned_le16(&report
[i
+ 3]);
420 if (usage
== WCM_DESKTOP
) {
422 switch (features
->type
) {
427 get_unaligned_le16(&report
[i
+ 3]);
429 get_unaligned_le16(&report
[i
+ 6]);
435 get_unaligned_le16(&report
[i
+ 3]);
437 get_unaligned_le16(&report
[i
- 2]);
443 get_unaligned_le16(&report
[i
+ 3]);
445 get_unaligned_le16(&report
[i
+ 6]);
453 get_unaligned_le16(&report
[i
+ 3]);
459 get_unaligned_le16(&report
[i
+ 3]);
465 case HID_USAGE_FINGER
:
471 * Requiring Stylus Usage will ignore boot mouse
472 * X/Y values and some cases of invalid Digitizer X/Y
473 * values commonly reported.
475 case HID_USAGE_STYLUS
:
480 case HID_USAGE_CONTACTMAX
:
481 /* leave touch_max as is if predefined */
482 if (!features
->touch_max
)
483 wacom_retrieve_report_data(intf
, features
);
489 case HID_COLLECTION_END
:
490 /* reset UsagePage and Finger */
497 case HID_COLLECTION_LOGICAL
:
498 i
+= wacom_parse_logical_collection(&report
[i
],
512 static int wacom_set_device_mode(struct usb_interface
*intf
, int report_id
, int length
, int mode
)
514 unsigned char *rep_data
;
515 int error
= -ENOMEM
, limit
= 0;
517 rep_data
= kzalloc(length
, GFP_KERNEL
);
522 rep_data
[0] = report_id
;
525 error
= wacom_set_report(intf
, WAC_HID_FEATURE_REPORT
,
526 report_id
, rep_data
, length
, 1);
527 } while ((error
< 0 || rep_data
[1] != mode
) && limit
++ < WAC_MSG_RETRIES
);
531 return error
< 0 ? error
: 0;
535 * Switch the tablet into its most-capable mode. Wacom tablets are
536 * typically configured to power-up in a mode which sends mouse-like
537 * reports to the OS. To get absolute position, pressure data, etc.
538 * from the tablet, it is necessary to switch the tablet out of this
539 * mode and into one which sends the full range of tablet data.
541 static int wacom_query_tablet_data(struct usb_interface
*intf
, struct wacom_features
*features
)
543 if (features
->device_type
== BTN_TOOL_FINGER
) {
544 if (features
->type
> TABLETPC
) {
545 /* MT Tablet PC touch */
546 return wacom_set_device_mode(intf
, 3, 4, 4);
548 else if (features
->type
== WACOM_24HDT
|| features
->type
== CINTIQ_HYBRID
) {
549 return wacom_set_device_mode(intf
, 18, 3, 2);
551 } else if (features
->device_type
== BTN_TOOL_PEN
) {
552 if (features
->type
<= BAMBOO_PT
&& features
->type
!= WIRELESS
) {
553 return wacom_set_device_mode(intf
, 2, 2, 2);
560 static int wacom_retrieve_hid_descriptor(struct usb_interface
*intf
,
561 struct wacom_features
*features
)
564 struct usb_host_interface
*interface
= intf
->cur_altsetting
;
565 struct hid_descriptor
*hid_desc
;
567 /* default features */
568 features
->device_type
= BTN_TOOL_PEN
;
569 features
->x_fuzz
= 4;
570 features
->y_fuzz
= 4;
571 features
->pressure_fuzz
= 0;
572 features
->distance_fuzz
= 0;
575 * The wireless device HID is basic and layout conflicts with
576 * other tablets (monitor and touch interface can look like pen).
577 * Skip the query for this type and modify defaults based on
580 if (features
->type
== WIRELESS
) {
581 if (intf
->cur_altsetting
->desc
.bInterfaceNumber
== 0) {
582 features
->device_type
= 0;
583 } else if (intf
->cur_altsetting
->desc
.bInterfaceNumber
== 2) {
584 features
->device_type
= BTN_TOOL_FINGER
;
585 features
->pktlen
= WACOM_PKGLEN_BBTOUCH3
;
589 /* only devices that support touch need to retrieve the info */
590 if (features
->type
< BAMBOO_PT
) {
594 error
= usb_get_extra_descriptor(interface
, HID_DEVICET_HID
, &hid_desc
);
596 error
= usb_get_extra_descriptor(&interface
->endpoint
[0],
597 HID_DEVICET_REPORT
, &hid_desc
);
600 "can not retrieve extra class descriptor\n");
604 error
= wacom_parse_hid(intf
, hid_desc
, features
);
610 struct wacom_usbdev_data
{
611 struct list_head list
;
613 struct usb_device
*dev
;
614 struct wacom_shared shared
;
617 static LIST_HEAD(wacom_udev_list
);
618 static DEFINE_MUTEX(wacom_udev_list_lock
);
620 static struct usb_device
*wacom_get_sibling(struct usb_device
*dev
, int vendor
, int product
)
623 struct usb_device
*sibling
;
625 if (vendor
== 0 && product
== 0)
628 if (dev
->parent
== NULL
)
631 usb_hub_for_each_child(dev
->parent
, port1
, sibling
) {
632 struct usb_device_descriptor
*d
;
636 d
= &sibling
->descriptor
;
637 if (d
->idVendor
== vendor
&& d
->idProduct
== product
)
644 static struct wacom_usbdev_data
*wacom_get_usbdev_data(struct usb_device
*dev
)
646 struct wacom_usbdev_data
*data
;
648 list_for_each_entry(data
, &wacom_udev_list
, list
) {
649 if (data
->dev
== dev
) {
650 kref_get(&data
->kref
);
658 static int wacom_add_shared_data(struct wacom_wac
*wacom
,
659 struct usb_device
*dev
)
661 struct wacom_usbdev_data
*data
;
664 mutex_lock(&wacom_udev_list_lock
);
666 data
= wacom_get_usbdev_data(dev
);
668 data
= kzalloc(sizeof(struct wacom_usbdev_data
), GFP_KERNEL
);
674 kref_init(&data
->kref
);
676 list_add_tail(&data
->list
, &wacom_udev_list
);
679 wacom
->shared
= &data
->shared
;
682 mutex_unlock(&wacom_udev_list_lock
);
686 static void wacom_release_shared_data(struct kref
*kref
)
688 struct wacom_usbdev_data
*data
=
689 container_of(kref
, struct wacom_usbdev_data
, kref
);
691 mutex_lock(&wacom_udev_list_lock
);
692 list_del(&data
->list
);
693 mutex_unlock(&wacom_udev_list_lock
);
698 static void wacom_remove_shared_data(struct wacom_wac
*wacom
)
700 struct wacom_usbdev_data
*data
;
703 data
= container_of(wacom
->shared
, struct wacom_usbdev_data
, shared
);
704 kref_put(&data
->kref
, wacom_release_shared_data
);
705 wacom
->shared
= NULL
;
709 static int wacom_led_control(struct wacom
*wacom
)
714 buf
= kzalloc(9, GFP_KERNEL
);
718 if (wacom
->wacom_wac
.features
.type
>= INTUOS5S
&&
719 wacom
->wacom_wac
.features
.type
<= INTUOSPL
) {
721 * Touch Ring and crop mark LED luminance may take on
722 * one of four values:
723 * 0 = Low; 1 = Medium; 2 = High; 3 = Off
725 int ring_led
= wacom
->led
.select
[0] & 0x03;
726 int ring_lum
= (((wacom
->led
.llv
& 0x60) >> 5) - 1) & 0x03;
729 buf
[0] = WAC_CMD_LED_CONTROL
;
730 buf
[1] = (crop_lum
<< 4) | (ring_lum
<< 2) | (ring_led
);
733 int led
= wacom
->led
.select
[0] | 0x4;
735 if (wacom
->wacom_wac
.features
.type
== WACOM_21UX2
||
736 wacom
->wacom_wac
.features
.type
== WACOM_24HD
)
737 led
|= (wacom
->led
.select
[1] << 4) | 0x40;
739 buf
[0] = WAC_CMD_LED_CONTROL
;
741 buf
[2] = wacom
->led
.llv
;
742 buf
[3] = wacom
->led
.hlv
;
743 buf
[4] = wacom
->led
.img_lum
;
746 retval
= wacom_set_report(wacom
->intf
, 0x03, WAC_CMD_LED_CONTROL
,
747 buf
, 9, WAC_CMD_RETRIES
);
753 static int wacom_led_putimage(struct wacom
*wacom
, int button_id
, const void *img
)
758 buf
= kzalloc(259, GFP_KERNEL
);
762 /* Send 'start' command */
763 buf
[0] = WAC_CMD_ICON_START
;
765 retval
= wacom_set_report(wacom
->intf
, 0x03, WAC_CMD_ICON_START
,
766 buf
, 2, WAC_CMD_RETRIES
);
770 buf
[0] = WAC_CMD_ICON_XFER
;
771 buf
[1] = button_id
& 0x07;
772 for (i
= 0; i
< 4; i
++) {
774 memcpy(buf
+ 3, img
+ i
* 256, 256);
776 retval
= wacom_set_report(wacom
->intf
, 0x03, WAC_CMD_ICON_XFER
,
777 buf
, 259, WAC_CMD_RETRIES
);
783 buf
[0] = WAC_CMD_ICON_START
;
785 wacom_set_report(wacom
->intf
, 0x03, WAC_CMD_ICON_START
,
786 buf
, 2, WAC_CMD_RETRIES
);
793 static ssize_t
wacom_led_select_store(struct device
*dev
, int set_id
,
794 const char *buf
, size_t count
)
796 struct wacom
*wacom
= dev_get_drvdata(dev
);
800 err
= kstrtouint(buf
, 10, &id
);
804 mutex_lock(&wacom
->lock
);
806 wacom
->led
.select
[set_id
] = id
& 0x3;
807 err
= wacom_led_control(wacom
);
809 mutex_unlock(&wacom
->lock
);
811 return err
< 0 ? err
: count
;
814 #define DEVICE_LED_SELECT_ATTR(SET_ID) \
815 static ssize_t wacom_led##SET_ID##_select_store(struct device *dev, \
816 struct device_attribute *attr, const char *buf, size_t count) \
818 return wacom_led_select_store(dev, SET_ID, buf, count); \
820 static ssize_t wacom_led##SET_ID##_select_show(struct device *dev, \
821 struct device_attribute *attr, char *buf) \
823 struct wacom *wacom = dev_get_drvdata(dev); \
824 return snprintf(buf, 2, "%d\n", wacom->led.select[SET_ID]); \
826 static DEVICE_ATTR(status_led##SET_ID##_select, S_IWUSR | S_IRUSR, \
827 wacom_led##SET_ID##_select_show, \
828 wacom_led##SET_ID##_select_store)
830 DEVICE_LED_SELECT_ATTR(0);
831 DEVICE_LED_SELECT_ATTR(1);
833 static ssize_t
wacom_luminance_store(struct wacom
*wacom
, u8
*dest
,
834 const char *buf
, size_t count
)
839 err
= kstrtouint(buf
, 10, &value
);
843 mutex_lock(&wacom
->lock
);
845 *dest
= value
& 0x7f;
846 err
= wacom_led_control(wacom
);
848 mutex_unlock(&wacom
->lock
);
850 return err
< 0 ? err
: count
;
853 #define DEVICE_LUMINANCE_ATTR(name, field) \
854 static ssize_t wacom_##name##_luminance_store(struct device *dev, \
855 struct device_attribute *attr, const char *buf, size_t count) \
857 struct wacom *wacom = dev_get_drvdata(dev); \
859 return wacom_luminance_store(wacom, &wacom->led.field, \
862 static DEVICE_ATTR(name##_luminance, S_IWUSR, \
863 NULL, wacom_##name##_luminance_store)
865 DEVICE_LUMINANCE_ATTR(status0
, llv
);
866 DEVICE_LUMINANCE_ATTR(status1
, hlv
);
867 DEVICE_LUMINANCE_ATTR(buttons
, img_lum
);
869 static ssize_t
wacom_button_image_store(struct device
*dev
, int button_id
,
870 const char *buf
, size_t count
)
872 struct wacom
*wacom
= dev_get_drvdata(dev
);
878 mutex_lock(&wacom
->lock
);
880 err
= wacom_led_putimage(wacom
, button_id
, buf
);
882 mutex_unlock(&wacom
->lock
);
884 return err
< 0 ? err
: count
;
887 #define DEVICE_BTNIMG_ATTR(BUTTON_ID) \
888 static ssize_t wacom_btnimg##BUTTON_ID##_store(struct device *dev, \
889 struct device_attribute *attr, const char *buf, size_t count) \
891 return wacom_button_image_store(dev, BUTTON_ID, buf, count); \
893 static DEVICE_ATTR(button##BUTTON_ID##_rawimg, S_IWUSR, \
894 NULL, wacom_btnimg##BUTTON_ID##_store)
896 DEVICE_BTNIMG_ATTR(0);
897 DEVICE_BTNIMG_ATTR(1);
898 DEVICE_BTNIMG_ATTR(2);
899 DEVICE_BTNIMG_ATTR(3);
900 DEVICE_BTNIMG_ATTR(4);
901 DEVICE_BTNIMG_ATTR(5);
902 DEVICE_BTNIMG_ATTR(6);
903 DEVICE_BTNIMG_ATTR(7);
905 static struct attribute
*cintiq_led_attrs
[] = {
906 &dev_attr_status_led0_select
.attr
,
907 &dev_attr_status_led1_select
.attr
,
911 static struct attribute_group cintiq_led_attr_group
= {
913 .attrs
= cintiq_led_attrs
,
916 static struct attribute
*intuos4_led_attrs
[] = {
917 &dev_attr_status0_luminance
.attr
,
918 &dev_attr_status1_luminance
.attr
,
919 &dev_attr_status_led0_select
.attr
,
920 &dev_attr_buttons_luminance
.attr
,
921 &dev_attr_button0_rawimg
.attr
,
922 &dev_attr_button1_rawimg
.attr
,
923 &dev_attr_button2_rawimg
.attr
,
924 &dev_attr_button3_rawimg
.attr
,
925 &dev_attr_button4_rawimg
.attr
,
926 &dev_attr_button5_rawimg
.attr
,
927 &dev_attr_button6_rawimg
.attr
,
928 &dev_attr_button7_rawimg
.attr
,
932 static struct attribute_group intuos4_led_attr_group
= {
934 .attrs
= intuos4_led_attrs
,
937 static struct attribute
*intuos5_led_attrs
[] = {
938 &dev_attr_status0_luminance
.attr
,
939 &dev_attr_status_led0_select
.attr
,
943 static struct attribute_group intuos5_led_attr_group
= {
945 .attrs
= intuos5_led_attrs
,
948 static int wacom_initialize_leds(struct wacom
*wacom
)
952 /* Initialize default values */
953 switch (wacom
->wacom_wac
.features
.type
) {
957 wacom
->led
.select
[0] = 0;
958 wacom
->led
.select
[1] = 0;
961 wacom
->led
.img_lum
= 10;
962 error
= sysfs_create_group(&wacom
->intf
->dev
.kobj
,
963 &intuos4_led_attr_group
);
968 wacom
->led
.select
[0] = 0;
969 wacom
->led
.select
[1] = 0;
972 wacom
->led
.img_lum
= 0;
974 error
= sysfs_create_group(&wacom
->intf
->dev
.kobj
,
975 &cintiq_led_attr_group
);
984 if (wacom
->wacom_wac
.features
.device_type
== BTN_TOOL_PEN
) {
985 wacom
->led
.select
[0] = 0;
986 wacom
->led
.select
[1] = 0;
989 wacom
->led
.img_lum
= 0;
991 error
= sysfs_create_group(&wacom
->intf
->dev
.kobj
,
992 &intuos5_led_attr_group
);
1002 dev_err(&wacom
->intf
->dev
,
1003 "cannot create sysfs group err: %d\n", error
);
1006 wacom_led_control(wacom
);
1011 static void wacom_destroy_leds(struct wacom
*wacom
)
1013 switch (wacom
->wacom_wac
.features
.type
) {
1017 sysfs_remove_group(&wacom
->intf
->dev
.kobj
,
1018 &intuos4_led_attr_group
);
1023 sysfs_remove_group(&wacom
->intf
->dev
.kobj
,
1024 &cintiq_led_attr_group
);
1033 if (wacom
->wacom_wac
.features
.device_type
== BTN_TOOL_PEN
)
1034 sysfs_remove_group(&wacom
->intf
->dev
.kobj
,
1035 &intuos5_led_attr_group
);
1040 static enum power_supply_property wacom_battery_props
[] = {
1041 POWER_SUPPLY_PROP_SCOPE
,
1042 POWER_SUPPLY_PROP_CAPACITY
1045 static int wacom_battery_get_property(struct power_supply
*psy
,
1046 enum power_supply_property psp
,
1047 union power_supply_propval
*val
)
1049 struct wacom
*wacom
= container_of(psy
, struct wacom
, battery
);
1053 case POWER_SUPPLY_PROP_SCOPE
:
1054 val
->intval
= POWER_SUPPLY_SCOPE_DEVICE
;
1056 case POWER_SUPPLY_PROP_CAPACITY
:
1058 wacom
->wacom_wac
.battery_capacity
* 100 / 31;
1068 static int wacom_initialize_battery(struct wacom
*wacom
)
1072 if (wacom
->wacom_wac
.features
.quirks
& WACOM_QUIRK_MONITOR
) {
1073 wacom
->battery
.properties
= wacom_battery_props
;
1074 wacom
->battery
.num_properties
= ARRAY_SIZE(wacom_battery_props
);
1075 wacom
->battery
.get_property
= wacom_battery_get_property
;
1076 wacom
->battery
.name
= "wacom_battery";
1077 wacom
->battery
.type
= POWER_SUPPLY_TYPE_BATTERY
;
1078 wacom
->battery
.use_for_apm
= 0;
1080 error
= power_supply_register(&wacom
->usbdev
->dev
,
1084 power_supply_powers(&wacom
->battery
,
1085 &wacom
->usbdev
->dev
);
1091 static void wacom_destroy_battery(struct wacom
*wacom
)
1093 if (wacom
->wacom_wac
.features
.quirks
& WACOM_QUIRK_MONITOR
&&
1094 wacom
->battery
.dev
) {
1095 power_supply_unregister(&wacom
->battery
);
1096 wacom
->battery
.dev
= NULL
;
1100 static int wacom_register_input(struct wacom
*wacom
)
1102 struct input_dev
*input_dev
;
1103 struct usb_interface
*intf
= wacom
->intf
;
1104 struct usb_device
*dev
= interface_to_usbdev(intf
);
1105 struct wacom_wac
*wacom_wac
= &(wacom
->wacom_wac
);
1108 input_dev
= input_allocate_device();
1114 input_dev
->name
= wacom_wac
->name
;
1115 input_dev
->dev
.parent
= &intf
->dev
;
1116 input_dev
->open
= wacom_open
;
1117 input_dev
->close
= wacom_close
;
1118 usb_to_input_id(dev
, &input_dev
->id
);
1119 input_set_drvdata(input_dev
, wacom
);
1121 wacom_wac
->input
= input_dev
;
1122 error
= wacom_setup_input_capabilities(input_dev
, wacom_wac
);
1126 error
= input_register_device(input_dev
);
1133 input_free_device(input_dev
);
1134 wacom_wac
->input
= NULL
;
1139 static void wacom_wireless_work(struct work_struct
*work
)
1141 struct wacom
*wacom
= container_of(work
, struct wacom
, work
);
1142 struct usb_device
*usbdev
= wacom
->usbdev
;
1143 struct wacom_wac
*wacom_wac
= &wacom
->wacom_wac
;
1144 struct wacom
*wacom1
, *wacom2
;
1145 struct wacom_wac
*wacom_wac1
, *wacom_wac2
;
1149 * Regardless if this is a disconnect or a new tablet,
1150 * remove any existing input and battery devices.
1153 wacom_destroy_battery(wacom
);
1155 /* Stylus interface */
1156 wacom1
= usb_get_intfdata(usbdev
->config
->interface
[1]);
1157 wacom_wac1
= &(wacom1
->wacom_wac
);
1158 if (wacom_wac1
->input
)
1159 input_unregister_device(wacom_wac1
->input
);
1160 wacom_wac1
->input
= NULL
;
1162 /* Touch interface */
1163 wacom2
= usb_get_intfdata(usbdev
->config
->interface
[2]);
1164 wacom_wac2
= &(wacom2
->wacom_wac
);
1165 if (wacom_wac2
->input
)
1166 input_unregister_device(wacom_wac2
->input
);
1167 wacom_wac2
->input
= NULL
;
1169 if (wacom_wac
->pid
== 0) {
1170 dev_info(&wacom
->intf
->dev
, "wireless tablet disconnected\n");
1172 const struct usb_device_id
*id
= wacom_ids
;
1174 dev_info(&wacom
->intf
->dev
,
1175 "wireless tablet connected with PID %x\n",
1178 while (id
->match_flags
) {
1179 if (id
->idVendor
== USB_VENDOR_ID_WACOM
&&
1180 id
->idProduct
== wacom_wac
->pid
)
1185 if (!id
->match_flags
) {
1186 dev_info(&wacom
->intf
->dev
,
1187 "ignoring unknown PID.\n");
1191 /* Stylus interface */
1192 wacom_wac1
->features
=
1193 *((struct wacom_features
*)id
->driver_info
);
1194 wacom_wac1
->features
.device_type
= BTN_TOOL_PEN
;
1195 snprintf(wacom_wac1
->name
, WACOM_NAME_MAX
, "%s (WL) Pen",
1196 wacom_wac1
->features
.name
);
1197 error
= wacom_register_input(wacom1
);
1201 /* Touch interface */
1202 if (wacom_wac1
->features
.touch_max
) {
1203 wacom_wac2
->features
=
1204 *((struct wacom_features
*)id
->driver_info
);
1205 wacom_wac2
->features
.pktlen
= WACOM_PKGLEN_BBTOUCH3
;
1206 wacom_wac2
->features
.device_type
= BTN_TOOL_FINGER
;
1207 wacom_wac2
->features
.x_max
= wacom_wac2
->features
.y_max
= 4096;
1208 if (wacom_wac2
->features
.touch_max
)
1209 snprintf(wacom_wac2
->name
, WACOM_NAME_MAX
,
1210 "%s (WL) Finger",wacom_wac2
->features
.name
);
1212 snprintf(wacom_wac2
->name
, WACOM_NAME_MAX
,
1213 "%s (WL) Pad",wacom_wac2
->features
.name
);
1214 error
= wacom_register_input(wacom2
);
1219 error
= wacom_initialize_battery(wacom
);
1227 if (wacom_wac2
->input
) {
1228 input_unregister_device(wacom_wac2
->input
);
1229 wacom_wac2
->input
= NULL
;
1232 if (wacom_wac1
->input
) {
1233 input_unregister_device(wacom_wac1
->input
);
1234 wacom_wac1
->input
= NULL
;
1240 * Not all devices report physical dimensions from HID.
1241 * Compute the default from hardcoded logical dimension
1242 * and resolution before driver overwrites them.
1244 static void wacom_set_default_phy(struct wacom_features
*features
)
1246 if (features
->x_resolution
) {
1247 features
->x_phy
= (features
->x_max
* 100) /
1248 features
->x_resolution
;
1249 features
->y_phy
= (features
->y_max
* 100) /
1250 features
->y_resolution
;
1254 static void wacom_calculate_res(struct wacom_features
*features
)
1256 features
->x_resolution
= wacom_calc_hid_res(features
->x_max
,
1259 features
->unitExpo
);
1260 features
->y_resolution
= wacom_calc_hid_res(features
->y_max
,
1263 features
->unitExpo
);
1266 static int wacom_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1268 struct usb_device
*dev
= interface_to_usbdev(intf
);
1269 struct usb_endpoint_descriptor
*endpoint
;
1270 struct wacom
*wacom
;
1271 struct wacom_wac
*wacom_wac
;
1272 struct wacom_features
*features
;
1275 if (!id
->driver_info
)
1278 wacom
= kzalloc(sizeof(struct wacom
), GFP_KERNEL
);
1282 wacom_wac
= &wacom
->wacom_wac
;
1283 wacom_wac
->features
= *((struct wacom_features
*)id
->driver_info
);
1284 features
= &wacom_wac
->features
;
1285 if (features
->pktlen
> WACOM_PKGLEN_MAX
) {
1290 wacom_wac
->data
= usb_alloc_coherent(dev
, WACOM_PKGLEN_MAX
,
1291 GFP_KERNEL
, &wacom
->data_dma
);
1292 if (!wacom_wac
->data
) {
1297 wacom
->irq
= usb_alloc_urb(0, GFP_KERNEL
);
1303 wacom
->usbdev
= dev
;
1305 mutex_init(&wacom
->lock
);
1306 INIT_WORK(&wacom
->work
, wacom_wireless_work
);
1307 usb_make_path(dev
, wacom
->phys
, sizeof(wacom
->phys
));
1308 strlcat(wacom
->phys
, "/input0", sizeof(wacom
->phys
));
1310 endpoint
= &intf
->cur_altsetting
->endpoint
[0].desc
;
1312 /* set the default size in case we do not get them from hid */
1313 wacom_set_default_phy(features
);
1315 /* Retrieve the physical and logical size for touch devices */
1316 error
= wacom_retrieve_hid_descriptor(intf
, features
);
1321 * Intuos5 has no useful data about its touch interface in its
1322 * HID descriptor. If this is the touch interface (wMaxPacketSize
1323 * of WACOM_PKGLEN_BBTOUCH3), override the table values.
1325 if (features
->type
>= INTUOS5S
&& features
->type
<= INTUOSPL
) {
1326 if (endpoint
->wMaxPacketSize
== WACOM_PKGLEN_BBTOUCH3
) {
1327 features
->device_type
= BTN_TOOL_FINGER
;
1328 features
->pktlen
= WACOM_PKGLEN_BBTOUCH3
;
1330 features
->x_max
= 4096;
1331 features
->y_max
= 4096;
1333 features
->device_type
= BTN_TOOL_PEN
;
1337 wacom_setup_device_quirks(features
);
1339 /* set unit to "100th of a mm" for devices not reported by HID */
1340 if (!features
->unit
) {
1341 features
->unit
= 0x11;
1342 features
->unitExpo
= 16 - 3;
1344 wacom_calculate_res(features
);
1346 strlcpy(wacom_wac
->name
, features
->name
, sizeof(wacom_wac
->name
));
1348 if (features
->quirks
& WACOM_QUIRK_MULTI_INPUT
) {
1349 struct usb_device
*other_dev
;
1351 /* Append the device type to the name */
1352 if (features
->device_type
!= BTN_TOOL_FINGER
)
1353 strlcat(wacom_wac
->name
, " Pen", WACOM_NAME_MAX
);
1354 else if (features
->touch_max
)
1355 strlcat(wacom_wac
->name
, " Finger", WACOM_NAME_MAX
);
1357 strlcat(wacom_wac
->name
, " Pad", WACOM_NAME_MAX
);
1359 other_dev
= wacom_get_sibling(dev
, features
->oVid
, features
->oPid
);
1360 if (other_dev
== NULL
|| wacom_get_usbdev_data(other_dev
) == NULL
)
1362 error
= wacom_add_shared_data(wacom_wac
, other_dev
);
1367 usb_fill_int_urb(wacom
->irq
, dev
,
1368 usb_rcvintpipe(dev
, endpoint
->bEndpointAddress
),
1369 wacom_wac
->data
, features
->pktlen
,
1370 wacom_sys_irq
, wacom
, endpoint
->bInterval
);
1371 wacom
->irq
->transfer_dma
= wacom
->data_dma
;
1372 wacom
->irq
->transfer_flags
|= URB_NO_TRANSFER_DMA_MAP
;
1374 error
= wacom_initialize_leds(wacom
);
1378 if (!(features
->quirks
& WACOM_QUIRK_NO_INPUT
)) {
1379 error
= wacom_register_input(wacom
);
1384 /* Note that if query fails it is not a hard failure */
1385 wacom_query_tablet_data(intf
, features
);
1387 usb_set_intfdata(intf
, wacom
);
1389 if (features
->quirks
& WACOM_QUIRK_MONITOR
) {
1390 if (usb_submit_urb(wacom
->irq
, GFP_KERNEL
)) {
1398 fail5
: wacom_destroy_leds(wacom
);
1399 fail4
: wacom_remove_shared_data(wacom_wac
);
1400 fail3
: usb_free_urb(wacom
->irq
);
1401 fail2
: usb_free_coherent(dev
, WACOM_PKGLEN_MAX
, wacom_wac
->data
, wacom
->data_dma
);
1402 fail1
: kfree(wacom
);
1406 static void wacom_disconnect(struct usb_interface
*intf
)
1408 struct wacom
*wacom
= usb_get_intfdata(intf
);
1410 usb_set_intfdata(intf
, NULL
);
1412 usb_kill_urb(wacom
->irq
);
1413 cancel_work_sync(&wacom
->work
);
1414 if (wacom
->wacom_wac
.input
)
1415 input_unregister_device(wacom
->wacom_wac
.input
);
1416 wacom_destroy_battery(wacom
);
1417 wacom_destroy_leds(wacom
);
1418 usb_free_urb(wacom
->irq
);
1419 usb_free_coherent(interface_to_usbdev(intf
), WACOM_PKGLEN_MAX
,
1420 wacom
->wacom_wac
.data
, wacom
->data_dma
);
1421 wacom_remove_shared_data(&wacom
->wacom_wac
);
1425 static int wacom_suspend(struct usb_interface
*intf
, pm_message_t message
)
1427 struct wacom
*wacom
= usb_get_intfdata(intf
);
1429 mutex_lock(&wacom
->lock
);
1430 usb_kill_urb(wacom
->irq
);
1431 mutex_unlock(&wacom
->lock
);
1436 static int wacom_resume(struct usb_interface
*intf
)
1438 struct wacom
*wacom
= usb_get_intfdata(intf
);
1439 struct wacom_features
*features
= &wacom
->wacom_wac
.features
;
1442 mutex_lock(&wacom
->lock
);
1444 /* switch to wacom mode first */
1445 wacom_query_tablet_data(intf
, features
);
1446 wacom_led_control(wacom
);
1448 if ((wacom
->open
|| (features
->quirks
& WACOM_QUIRK_MONITOR
)) &&
1449 usb_submit_urb(wacom
->irq
, GFP_NOIO
) < 0)
1452 mutex_unlock(&wacom
->lock
);
1457 static int wacom_reset_resume(struct usb_interface
*intf
)
1459 return wacom_resume(intf
);
1462 static struct usb_driver wacom_driver
= {
1464 .id_table
= wacom_ids
,
1465 .probe
= wacom_probe
,
1466 .disconnect
= wacom_disconnect
,
1467 .suspend
= wacom_suspend
,
1468 .resume
= wacom_resume
,
1469 .reset_resume
= wacom_reset_resume
,
1470 .supports_autosuspend
= 1,
1473 module_usb_driver(wacom_driver
);