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