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"
16 #include <linux/input/mt.h>
18 #define WAC_MSG_RETRIES 5
19 #define WAC_CMD_RETRIES 10
21 #define DEV_ATTR_RW_PERM (S_IRUGO | S_IWUSR | S_IWGRP)
22 #define DEV_ATTR_WO_PERM (S_IWUSR | S_IWGRP)
23 #define DEV_ATTR_RO_PERM (S_IRUSR | S_IRGRP)
25 static int wacom_get_report(struct hid_device *hdev, u8 type, u8 *buf,
26 size_t size, unsigned int retries)
31 retval = hid_hw_raw_request(hdev, buf[0], buf, size, type,
33 } while ((retval == -ETIMEDOUT || retval == -EAGAIN) && --retries);
36 hid_err(hdev, "wacom_get_report: ran out of retries "
37 "(last error = %d)\n", retval);
42 static int wacom_set_report(struct hid_device *hdev, u8 type, u8 *buf,
43 size_t size, unsigned int retries)
48 retval = hid_hw_raw_request(hdev, buf[0], buf, size, type,
50 } while ((retval == -ETIMEDOUT || retval == -EAGAIN) && --retries);
53 hid_err(hdev, "wacom_set_report: ran out of retries "
54 "(last error = %d)\n", retval);
59 static int wacom_raw_event(struct hid_device *hdev, struct hid_report *report,
60 u8 *raw_data, int size)
62 struct wacom *wacom = hid_get_drvdata(hdev);
64 if (size > WACOM_PKGLEN_MAX)
67 memcpy(wacom->wacom_wac.data, raw_data, size);
69 wacom_wac_irq(&wacom->wacom_wac, size);
74 static int wacom_open(struct input_dev *dev)
76 struct wacom *wacom = input_get_drvdata(dev);
78 return hid_hw_open(wacom->hdev);
81 static void wacom_close(struct input_dev *dev)
83 struct wacom *wacom = input_get_drvdata(dev);
86 * wacom->hdev should never be null, but surprisingly, I had the case
87 * once while unplugging the Wacom Wireless Receiver.
90 hid_hw_close(wacom->hdev);
94 * Calculate the resolution of the X or Y axis using hidinput_calc_abs_res.
96 static int wacom_calc_hid_res(int logical_extents, int physical_extents,
97 unsigned unit, int exponent)
99 struct hid_field field = {
100 .logical_maximum = logical_extents,
101 .physical_maximum = physical_extents,
103 .unit_exponent = exponent,
106 return hidinput_calc_abs_res(&field, ABS_X);
109 static void wacom_feature_mapping(struct hid_device *hdev,
110 struct hid_field *field, struct hid_usage *usage)
112 struct wacom *wacom = hid_get_drvdata(hdev);
113 struct wacom_features *features = &wacom->wacom_wac.features;
114 struct hid_data *hid_data = &wacom->wacom_wac.hid_data;
115 unsigned int equivalent_usage = wacom_equivalent_usage(usage->hid);
120 switch (equivalent_usage) {
121 case HID_DG_CONTACTMAX:
122 /* leave touch_max as is if predefined */
123 if (!features->touch_max) {
125 data = kzalloc(2, GFP_KERNEL);
128 data[0] = field->report->id;
129 ret = wacom_get_report(hdev, HID_FEATURE_REPORT,
130 data, 2, WAC_CMD_RETRIES);
132 features->touch_max = data[1];
134 features->touch_max = 16;
135 hid_warn(hdev, "wacom_feature_mapping: "
136 "could not get HID_DG_CONTACTMAX, "
137 "defaulting to %d\n",
138 features->touch_max);
143 case HID_DG_INPUTMODE:
144 /* Ignore if value index is out of bounds. */
145 if (usage->usage_index >= field->report_count) {
146 dev_err(&hdev->dev, "HID_DG_INPUTMODE out of range\n");
150 hid_data->inputmode = field->report->id;
151 hid_data->inputmode_index = usage->usage_index;
154 case HID_UP_DIGITIZER:
155 if (field->report->id == 0x0B &&
156 (field->application == WACOM_HID_G9_PEN ||
157 field->application == WACOM_HID_G11_PEN)) {
158 wacom->wacom_wac.mode_report = field->report->id;
159 wacom->wacom_wac.mode_value = 0;
163 case WACOM_HID_WD_DATAMODE:
164 wacom->wacom_wac.mode_report = field->report->id;
165 wacom->wacom_wac.mode_value = 2;
168 case WACOM_HID_UP_G9:
169 case WACOM_HID_UP_G11:
170 if (field->report->id == 0x03 &&
171 (field->application == WACOM_HID_G9_TOUCHSCREEN ||
172 field->application == WACOM_HID_G11_TOUCHSCREEN)) {
173 wacom->wacom_wac.mode_report = field->report->id;
174 wacom->wacom_wac.mode_value = 0;
177 case WACOM_HID_WD_OFFSETLEFT:
178 case WACOM_HID_WD_OFFSETTOP:
179 case WACOM_HID_WD_OFFSETRIGHT:
180 case WACOM_HID_WD_OFFSETBOTTOM:
182 n = hid_report_len(field->report);
183 data = hid_alloc_report_buf(field->report, GFP_KERNEL);
186 data[0] = field->report->id;
187 ret = wacom_get_report(hdev, HID_FEATURE_REPORT,
188 data, n, WAC_CMD_RETRIES);
190 ret = hid_report_raw_event(hdev, HID_FEATURE_REPORT,
193 hid_warn(hdev, "%s: could not retrieve sensor offsets\n",
202 * Interface Descriptor of wacom devices can be incomplete and
203 * inconsistent so wacom_features table is used to store stylus
204 * device's packet lengths, various maximum values, and tablet
205 * resolution based on product ID's.
207 * For devices that contain 2 interfaces, wacom_features table is
208 * inaccurate for the touch interface. Since the Interface Descriptor
209 * for touch interfaces has pretty complete data, this function exists
210 * to query tablet for this missing information instead of hard coding in
211 * an additional table.
213 * A typical Interface Descriptor for a stylus will contain a
214 * boot mouse application collection that is not of interest and this
215 * function will ignore it.
217 * It also contains a digitizer application collection that also is not
218 * of interest since any information it contains would be duplicate
219 * of what is in wacom_features. Usually it defines a report of an array
220 * of bytes that could be used as max length of the stylus packet returned.
221 * If it happens to define a Digitizer-Stylus Physical Collection then
222 * the X and Y logical values contain valid data but it is ignored.
224 * A typical Interface Descriptor for a touch interface will contain a
225 * Digitizer-Finger Physical Collection which will define both logical
226 * X/Y maximum as well as the physical size of tablet. Since touch
227 * interfaces haven't supported pressure or distance, this is enough
228 * information to override invalid values in the wacom_features table.
230 * Intuos5 touch interface and 3rd gen Bamboo Touch do not contain useful
231 * data. We deal with them after returning from this function.
233 static void wacom_usage_mapping(struct hid_device *hdev,
234 struct hid_field *field, struct hid_usage *usage)
236 struct wacom *wacom = hid_get_drvdata(hdev);
237 struct wacom_features *features = &wacom->wacom_wac.features;
238 bool finger = WACOM_FINGER_FIELD(field);
239 bool pen = WACOM_PEN_FIELD(field);
242 * Requiring Stylus Usage will ignore boot mouse
243 * X/Y values and some cases of invalid Digitizer X/Y
244 * values commonly reported.
247 features->device_type |= WACOM_DEVICETYPE_PEN;
249 features->device_type |= WACOM_DEVICETYPE_TOUCH;
254 * Bamboo models do not support HID_DG_CONTACTMAX.
255 * And, Bamboo Pen only descriptor contains touch.
257 if (features->type > BAMBOO_PT) {
258 /* ISDv4 touch devices at least supports one touch point */
259 if (finger && !features->touch_max)
260 features->touch_max = 1;
264 * ISDv4 devices which predate HID's adoption of the
265 * HID_DG_BARELSWITCH2 usage use 0x000D0000 in its
266 * position instead. We can accurately detect if a
267 * usage with that value should be HID_DG_BARRELSWITCH2
268 * based on the surrounding usages, which have remained
269 * constant across generations.
271 if (features->type == HID_GENERIC &&
272 usage->hid == 0x000D0000 &&
273 field->application == HID_DG_PEN &&
274 field->physical == HID_DG_STYLUS) {
275 int i = usage->usage_index;
277 if (i-4 >= 0 && i+1 < field->maxusage &&
278 field->usage[i-4].hid == HID_DG_TIPSWITCH &&
279 field->usage[i-3].hid == HID_DG_BARRELSWITCH &&
280 field->usage[i-2].hid == HID_DG_ERASER &&
281 field->usage[i-1].hid == HID_DG_INVERT &&
282 field->usage[i+1].hid == HID_DG_INRANGE) {
283 usage->hid = HID_DG_BARRELSWITCH2;
287 switch (usage->hid) {
289 features->x_max = field->logical_maximum;
291 features->x_phy = field->physical_maximum;
292 if ((features->type != BAMBOO_PT) &&
293 (features->type != BAMBOO_TOUCH)) {
294 features->unit = field->unit;
295 features->unitExpo = field->unit_exponent;
300 features->y_max = field->logical_maximum;
302 features->y_phy = field->physical_maximum;
303 if ((features->type != BAMBOO_PT) &&
304 (features->type != BAMBOO_TOUCH)) {
305 features->unit = field->unit;
306 features->unitExpo = field->unit_exponent;
310 case HID_DG_TIPPRESSURE:
312 features->pressure_max = field->logical_maximum;
316 if (features->type == HID_GENERIC)
317 wacom_wac_usage_mapping(hdev, field, usage);
320 static void wacom_post_parse_hid(struct hid_device *hdev,
321 struct wacom_features *features)
323 struct wacom *wacom = hid_get_drvdata(hdev);
324 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
326 if (features->type == HID_GENERIC) {
327 /* Any last-minute generic device setup */
328 if (features->touch_max > 1) {
329 if (features->device_type & WACOM_DEVICETYPE_DIRECT)
330 input_mt_init_slots(wacom_wac->touch_input,
331 wacom_wac->features.touch_max,
334 input_mt_init_slots(wacom_wac->touch_input,
335 wacom_wac->features.touch_max,
341 static void wacom_parse_hid(struct hid_device *hdev,
342 struct wacom_features *features)
344 struct hid_report_enum *rep_enum;
345 struct hid_report *hreport;
348 /* check features first */
349 rep_enum = &hdev->report_enum[HID_FEATURE_REPORT];
350 list_for_each_entry(hreport, &rep_enum->report_list, list) {
351 for (i = 0; i < hreport->maxfield; i++) {
352 /* Ignore if report count is out of bounds. */
353 if (hreport->field[i]->report_count < 1)
356 for (j = 0; j < hreport->field[i]->maxusage; j++) {
357 wacom_feature_mapping(hdev, hreport->field[i],
358 hreport->field[i]->usage + j);
363 /* now check the input usages */
364 rep_enum = &hdev->report_enum[HID_INPUT_REPORT];
365 list_for_each_entry(hreport, &rep_enum->report_list, list) {
367 if (!hreport->maxfield)
370 for (i = 0; i < hreport->maxfield; i++)
371 for (j = 0; j < hreport->field[i]->maxusage; j++)
372 wacom_usage_mapping(hdev, hreport->field[i],
373 hreport->field[i]->usage + j);
376 wacom_post_parse_hid(hdev, features);
379 static int wacom_hid_set_device_mode(struct hid_device *hdev)
381 struct wacom *wacom = hid_get_drvdata(hdev);
382 struct hid_data *hid_data = &wacom->wacom_wac.hid_data;
383 struct hid_report *r;
384 struct hid_report_enum *re;
386 if (hid_data->inputmode < 0)
389 re = &(hdev->report_enum[HID_FEATURE_REPORT]);
390 r = re->report_id_hash[hid_data->inputmode];
392 r->field[0]->value[hid_data->inputmode_index] = 2;
393 hid_hw_request(hdev, r, HID_REQ_SET_REPORT);
398 static int wacom_set_device_mode(struct hid_device *hdev,
399 struct wacom_wac *wacom_wac)
402 struct hid_report *r;
403 struct hid_report_enum *re;
405 int error = -ENOMEM, limit = 0;
407 if (wacom_wac->mode_report < 0)
410 re = &(hdev->report_enum[HID_FEATURE_REPORT]);
411 r = re->report_id_hash[wacom_wac->mode_report];
415 rep_data = hid_alloc_report_buf(r, GFP_KERNEL);
419 length = hid_report_len(r);
422 rep_data[0] = wacom_wac->mode_report;
423 rep_data[1] = wacom_wac->mode_value;
425 error = wacom_set_report(hdev, HID_FEATURE_REPORT, rep_data,
428 error = wacom_get_report(hdev, HID_FEATURE_REPORT,
429 rep_data, length, 1);
430 } while (error >= 0 &&
431 rep_data[1] != wacom_wac->mode_report &&
432 limit++ < WAC_MSG_RETRIES);
436 return error < 0 ? error : 0;
439 static int wacom_bt_query_tablet_data(struct hid_device *hdev, u8 speed,
440 struct wacom_features *features)
442 struct wacom *wacom = hid_get_drvdata(hdev);
446 switch (features->type) {
450 ret = wacom_set_report(hdev, HID_FEATURE_REPORT, rep_data, 2,
454 rep_data[0] = speed == 0 ? 0x05 : 0x06;
457 ret = wacom_set_report(hdev, HID_FEATURE_REPORT,
461 wacom->wacom_wac.bt_high_speed = speed;
467 * Note that if the raw queries fail, it's not a hard failure
468 * and it is safe to continue
470 hid_warn(hdev, "failed to poke device, command %d, err %d\n",
475 wacom->wacom_wac.bt_features &= ~0x20;
477 wacom->wacom_wac.bt_features |= 0x20;
480 rep_data[1] = wacom->wacom_wac.bt_features;
482 ret = wacom_set_report(hdev, HID_FEATURE_REPORT, rep_data, 2,
485 wacom->wacom_wac.bt_high_speed = speed;
493 * Switch the tablet into its most-capable mode. Wacom tablets are
494 * typically configured to power-up in a mode which sends mouse-like
495 * reports to the OS. To get absolute position, pressure data, etc.
496 * from the tablet, it is necessary to switch the tablet out of this
497 * mode and into one which sends the full range of tablet data.
499 static int _wacom_query_tablet_data(struct wacom *wacom)
501 struct hid_device *hdev = wacom->hdev;
502 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
503 struct wacom_features *features = &wacom_wac->features;
505 if (hdev->bus == BUS_BLUETOOTH)
506 return wacom_bt_query_tablet_data(hdev, 1, features);
508 if (features->type != HID_GENERIC) {
509 if (features->device_type & WACOM_DEVICETYPE_TOUCH) {
510 if (features->type > TABLETPC) {
511 /* MT Tablet PC touch */
512 wacom_wac->mode_report = 3;
513 wacom_wac->mode_value = 4;
514 } else if (features->type == WACOM_24HDT) {
515 wacom_wac->mode_report = 18;
516 wacom_wac->mode_value = 2;
517 } else if (features->type == WACOM_27QHDT) {
518 wacom_wac->mode_report = 131;
519 wacom_wac->mode_value = 2;
520 } else if (features->type == BAMBOO_PAD) {
521 wacom_wac->mode_report = 2;
522 wacom_wac->mode_value = 2;
524 } else if (features->device_type & WACOM_DEVICETYPE_PEN) {
525 if (features->type <= BAMBOO_PT) {
526 wacom_wac->mode_report = 2;
527 wacom_wac->mode_value = 2;
532 wacom_set_device_mode(hdev, wacom_wac);
534 if (features->type == HID_GENERIC)
535 return wacom_hid_set_device_mode(hdev);
540 static void wacom_retrieve_hid_descriptor(struct hid_device *hdev,
541 struct wacom_features *features)
543 struct wacom *wacom = hid_get_drvdata(hdev);
544 struct usb_interface *intf = wacom->intf;
546 /* default features */
547 features->x_fuzz = 4;
548 features->y_fuzz = 4;
549 features->pressure_fuzz = 0;
550 features->distance_fuzz = 1;
551 features->tilt_fuzz = 1;
554 * The wireless device HID is basic and layout conflicts with
555 * other tablets (monitor and touch interface can look like pen).
556 * Skip the query for this type and modify defaults based on
559 if (features->type == WIRELESS) {
560 if (intf->cur_altsetting->desc.bInterfaceNumber == 0)
561 features->device_type = WACOM_DEVICETYPE_WL_MONITOR;
563 features->device_type = WACOM_DEVICETYPE_NONE;
567 wacom_parse_hid(hdev, features);
570 struct wacom_hdev_data {
571 struct list_head list;
573 struct hid_device *dev;
574 struct wacom_shared shared;
577 static LIST_HEAD(wacom_udev_list);
578 static DEFINE_MUTEX(wacom_udev_list_lock);
580 static bool compare_device_paths(struct hid_device *hdev_a,
581 struct hid_device *hdev_b, char separator)
583 int n1 = strrchr(hdev_a->phys, separator) - hdev_a->phys;
584 int n2 = strrchr(hdev_b->phys, separator) - hdev_b->phys;
586 if (n1 != n2 || n1 <= 0 || n2 <= 0)
589 return !strncmp(hdev_a->phys, hdev_b->phys, n1);
592 static bool wacom_are_sibling(struct hid_device *hdev,
593 struct hid_device *sibling)
595 struct wacom *wacom = hid_get_drvdata(hdev);
596 struct wacom_features *features = &wacom->wacom_wac.features;
597 struct wacom *sibling_wacom = hid_get_drvdata(sibling);
598 struct wacom_features *sibling_features = &sibling_wacom->wacom_wac.features;
599 __u32 oVid = features->oVid ? features->oVid : hdev->vendor;
600 __u32 oPid = features->oPid ? features->oPid : hdev->product;
602 /* The defined oVid/oPid must match that of the sibling */
603 if (features->oVid != HID_ANY_ID && sibling->vendor != oVid)
605 if (features->oPid != HID_ANY_ID && sibling->product != oPid)
609 * Devices with the same VID/PID must share the same physical
610 * device path, while those with different VID/PID must share
611 * the same physical parent device path.
613 if (hdev->vendor == sibling->vendor && hdev->product == sibling->product) {
614 if (!compare_device_paths(hdev, sibling, '/'))
617 if (!compare_device_paths(hdev, sibling, '.'))
621 /* Skip the remaining heuristics unless you are a HID_GENERIC device */
622 if (features->type != HID_GENERIC)
626 * Direct-input devices may not be siblings of indirect-input
629 if ((features->device_type & WACOM_DEVICETYPE_DIRECT) &&
630 !(sibling_features->device_type & WACOM_DEVICETYPE_DIRECT))
634 * Indirect-input devices may not be siblings of direct-input
637 if (!(features->device_type & WACOM_DEVICETYPE_DIRECT) &&
638 (sibling_features->device_type & WACOM_DEVICETYPE_DIRECT))
641 /* Pen devices may only be siblings of touch devices */
642 if ((features->device_type & WACOM_DEVICETYPE_PEN) &&
643 !(sibling_features->device_type & WACOM_DEVICETYPE_TOUCH))
646 /* Touch devices may only be siblings of pen devices */
647 if ((features->device_type & WACOM_DEVICETYPE_TOUCH) &&
648 !(sibling_features->device_type & WACOM_DEVICETYPE_PEN))
652 * No reason could be found for these two devices to NOT be
653 * siblings, so there's a good chance they ARE siblings
658 static struct wacom_hdev_data *wacom_get_hdev_data(struct hid_device *hdev)
660 struct wacom_hdev_data *data;
662 /* Try to find an already-probed interface from the same device */
663 list_for_each_entry(data, &wacom_udev_list, list) {
664 if (compare_device_paths(hdev, data->dev, '/'))
668 /* Fallback to finding devices that appear to be "siblings" */
669 list_for_each_entry(data, &wacom_udev_list, list) {
670 if (wacom_are_sibling(hdev, data->dev)) {
671 kref_get(&data->kref);
679 static void wacom_release_shared_data(struct kref *kref)
681 struct wacom_hdev_data *data =
682 container_of(kref, struct wacom_hdev_data, kref);
684 mutex_lock(&wacom_udev_list_lock);
685 list_del(&data->list);
686 mutex_unlock(&wacom_udev_list_lock);
691 static void wacom_remove_shared_data(void *res)
693 struct wacom *wacom = res;
694 struct wacom_hdev_data *data;
695 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
697 if (wacom_wac->shared) {
698 data = container_of(wacom_wac->shared, struct wacom_hdev_data,
701 if (wacom_wac->shared->touch == wacom->hdev)
702 wacom_wac->shared->touch = NULL;
703 else if (wacom_wac->shared->pen == wacom->hdev)
704 wacom_wac->shared->pen = NULL;
706 kref_put(&data->kref, wacom_release_shared_data);
707 wacom_wac->shared = NULL;
711 static int wacom_add_shared_data(struct hid_device *hdev)
713 struct wacom *wacom = hid_get_drvdata(hdev);
714 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
715 struct wacom_hdev_data *data;
718 mutex_lock(&wacom_udev_list_lock);
720 data = wacom_get_hdev_data(hdev);
722 data = kzalloc(sizeof(struct wacom_hdev_data), GFP_KERNEL);
728 kref_init(&data->kref);
730 list_add_tail(&data->list, &wacom_udev_list);
733 wacom_wac->shared = &data->shared;
735 retval = devm_add_action(&hdev->dev, wacom_remove_shared_data, wacom);
737 mutex_unlock(&wacom_udev_list_lock);
738 wacom_remove_shared_data(wacom);
742 if (wacom_wac->features.device_type & WACOM_DEVICETYPE_TOUCH)
743 wacom_wac->shared->touch = hdev;
744 else if (wacom_wac->features.device_type & WACOM_DEVICETYPE_PEN)
745 wacom_wac->shared->pen = hdev;
748 mutex_unlock(&wacom_udev_list_lock);
752 static int wacom_led_control(struct wacom *wacom)
756 unsigned char report_id = WAC_CMD_LED_CONTROL;
759 if (!wacom->led.groups)
762 if (wacom->wacom_wac.pid) { /* wireless connected */
763 report_id = WAC_CMD_WL_LED_CONTROL;
766 else if (wacom->wacom_wac.features.type == INTUOSP2_BT) {
767 report_id = WAC_CMD_WL_INTUOSP2;
770 buf = kzalloc(buf_size, GFP_KERNEL);
774 if (wacom->wacom_wac.features.type >= INTUOS5S &&
775 wacom->wacom_wac.features.type <= INTUOSPL) {
777 * Touch Ring and crop mark LED luminance may take on
778 * one of four values:
779 * 0 = Low; 1 = Medium; 2 = High; 3 = Off
781 int ring_led = wacom->led.groups[0].select & 0x03;
782 int ring_lum = (((wacom->led.llv & 0x60) >> 5) - 1) & 0x03;
784 unsigned char led_bits = (crop_lum << 4) | (ring_lum << 2) | (ring_led);
787 if (wacom->wacom_wac.pid) {
788 wacom_get_report(wacom->hdev, HID_FEATURE_REPORT,
789 buf, buf_size, WAC_CMD_RETRIES);
795 else if (wacom->wacom_wac.features.type == INTUOSP2_BT) {
797 buf[4] = 100; // Power Connection LED (ORANGE)
798 buf[5] = 100; // BT Connection LED (BLUE)
799 buf[6] = 100; // Paper Mode (RED?)
800 buf[7] = 100; // Paper Mode (GREEN?)
801 buf[8] = 100; // Paper Mode (BLUE?)
802 buf[9] = wacom->led.llv;
803 buf[10] = wacom->led.groups[0].select & 0x03;
806 int led = wacom->led.groups[0].select | 0x4;
808 if (wacom->wacom_wac.features.type == WACOM_21UX2 ||
809 wacom->wacom_wac.features.type == WACOM_24HD)
810 led |= (wacom->led.groups[1].select << 4) | 0x40;
814 buf[2] = wacom->led.llv;
815 buf[3] = wacom->led.hlv;
816 buf[4] = wacom->led.img_lum;
819 retval = wacom_set_report(wacom->hdev, HID_FEATURE_REPORT, buf, buf_size,
826 static int wacom_led_putimage(struct wacom *wacom, int button_id, u8 xfer_id,
827 const unsigned len, const void *img)
831 const unsigned chunk_len = len / 4; /* 4 chunks are needed to be sent */
833 buf = kzalloc(chunk_len + 3 , GFP_KERNEL);
837 /* Send 'start' command */
838 buf[0] = WAC_CMD_ICON_START;
840 retval = wacom_set_report(wacom->hdev, HID_FEATURE_REPORT, buf, 2,
846 buf[1] = button_id & 0x07;
847 for (i = 0; i < 4; i++) {
849 memcpy(buf + 3, img + i * chunk_len, chunk_len);
851 retval = wacom_set_report(wacom->hdev, HID_FEATURE_REPORT,
852 buf, chunk_len + 3, WAC_CMD_RETRIES);
858 buf[0] = WAC_CMD_ICON_START;
860 wacom_set_report(wacom->hdev, HID_FEATURE_REPORT, buf, 2,
868 static ssize_t wacom_led_select_store(struct device *dev, int set_id,
869 const char *buf, size_t count)
871 struct hid_device *hdev = to_hid_device(dev);
872 struct wacom *wacom = hid_get_drvdata(hdev);
876 err = kstrtouint(buf, 10, &id);
880 mutex_lock(&wacom->lock);
882 wacom->led.groups[set_id].select = id & 0x3;
883 err = wacom_led_control(wacom);
885 mutex_unlock(&wacom->lock);
887 return err < 0 ? err : count;
890 #define DEVICE_LED_SELECT_ATTR(SET_ID) \
891 static ssize_t wacom_led##SET_ID##_select_store(struct device *dev, \
892 struct device_attribute *attr, const char *buf, size_t count) \
894 return wacom_led_select_store(dev, SET_ID, buf, count); \
896 static ssize_t wacom_led##SET_ID##_select_show(struct device *dev, \
897 struct device_attribute *attr, char *buf) \
899 struct hid_device *hdev = to_hid_device(dev);\
900 struct wacom *wacom = hid_get_drvdata(hdev); \
901 return scnprintf(buf, PAGE_SIZE, "%d\n", \
902 wacom->led.groups[SET_ID].select); \
904 static DEVICE_ATTR(status_led##SET_ID##_select, DEV_ATTR_RW_PERM, \
905 wacom_led##SET_ID##_select_show, \
906 wacom_led##SET_ID##_select_store)
908 DEVICE_LED_SELECT_ATTR(0);
909 DEVICE_LED_SELECT_ATTR(1);
911 static ssize_t wacom_luminance_store(struct wacom *wacom, u8 *dest,
912 const char *buf, size_t count)
917 err = kstrtouint(buf, 10, &value);
921 mutex_lock(&wacom->lock);
923 *dest = value & 0x7f;
924 err = wacom_led_control(wacom);
926 mutex_unlock(&wacom->lock);
928 return err < 0 ? err : count;
931 #define DEVICE_LUMINANCE_ATTR(name, field) \
932 static ssize_t wacom_##name##_luminance_store(struct device *dev, \
933 struct device_attribute *attr, const char *buf, size_t count) \
935 struct hid_device *hdev = to_hid_device(dev);\
936 struct wacom *wacom = hid_get_drvdata(hdev); \
938 return wacom_luminance_store(wacom, &wacom->led.field, \
941 static ssize_t wacom_##name##_luminance_show(struct device *dev, \
942 struct device_attribute *attr, char *buf) \
944 struct wacom *wacom = dev_get_drvdata(dev); \
945 return scnprintf(buf, PAGE_SIZE, "%d\n", wacom->led.field); \
947 static DEVICE_ATTR(name##_luminance, DEV_ATTR_RW_PERM, \
948 wacom_##name##_luminance_show, \
949 wacom_##name##_luminance_store)
951 DEVICE_LUMINANCE_ATTR(status0, llv);
952 DEVICE_LUMINANCE_ATTR(status1, hlv);
953 DEVICE_LUMINANCE_ATTR(buttons, img_lum);
955 static ssize_t wacom_button_image_store(struct device *dev, int button_id,
956 const char *buf, size_t count)
958 struct hid_device *hdev = to_hid_device(dev);
959 struct wacom *wacom = hid_get_drvdata(hdev);
964 if (hdev->bus == BUS_BLUETOOTH) {
966 xfer_id = WAC_CMD_ICON_BT_XFER;
969 xfer_id = WAC_CMD_ICON_XFER;
975 mutex_lock(&wacom->lock);
977 err = wacom_led_putimage(wacom, button_id, xfer_id, len, buf);
979 mutex_unlock(&wacom->lock);
981 return err < 0 ? err : count;
984 #define DEVICE_BTNIMG_ATTR(BUTTON_ID) \
985 static ssize_t wacom_btnimg##BUTTON_ID##_store(struct device *dev, \
986 struct device_attribute *attr, const char *buf, size_t count) \
988 return wacom_button_image_store(dev, BUTTON_ID, buf, count); \
990 static DEVICE_ATTR(button##BUTTON_ID##_rawimg, DEV_ATTR_WO_PERM, \
991 NULL, wacom_btnimg##BUTTON_ID##_store)
993 DEVICE_BTNIMG_ATTR(0);
994 DEVICE_BTNIMG_ATTR(1);
995 DEVICE_BTNIMG_ATTR(2);
996 DEVICE_BTNIMG_ATTR(3);
997 DEVICE_BTNIMG_ATTR(4);
998 DEVICE_BTNIMG_ATTR(5);
999 DEVICE_BTNIMG_ATTR(6);
1000 DEVICE_BTNIMG_ATTR(7);
1002 static struct attribute *cintiq_led_attrs[] = {
1003 &dev_attr_status_led0_select.attr,
1004 &dev_attr_status_led1_select.attr,
1008 static struct attribute_group cintiq_led_attr_group = {
1009 .name = "wacom_led",
1010 .attrs = cintiq_led_attrs,
1013 static struct attribute *intuos4_led_attrs[] = {
1014 &dev_attr_status0_luminance.attr,
1015 &dev_attr_status1_luminance.attr,
1016 &dev_attr_status_led0_select.attr,
1017 &dev_attr_buttons_luminance.attr,
1018 &dev_attr_button0_rawimg.attr,
1019 &dev_attr_button1_rawimg.attr,
1020 &dev_attr_button2_rawimg.attr,
1021 &dev_attr_button3_rawimg.attr,
1022 &dev_attr_button4_rawimg.attr,
1023 &dev_attr_button5_rawimg.attr,
1024 &dev_attr_button6_rawimg.attr,
1025 &dev_attr_button7_rawimg.attr,
1029 static struct attribute_group intuos4_led_attr_group = {
1030 .name = "wacom_led",
1031 .attrs = intuos4_led_attrs,
1034 static struct attribute *intuos5_led_attrs[] = {
1035 &dev_attr_status0_luminance.attr,
1036 &dev_attr_status_led0_select.attr,
1040 static struct attribute_group intuos5_led_attr_group = {
1041 .name = "wacom_led",
1042 .attrs = intuos5_led_attrs,
1045 struct wacom_sysfs_group_devres {
1046 struct attribute_group *group;
1047 struct kobject *root;
1050 static void wacom_devm_sysfs_group_release(struct device *dev, void *res)
1052 struct wacom_sysfs_group_devres *devres = res;
1053 struct kobject *kobj = devres->root;
1055 dev_dbg(dev, "%s: dropping reference to %s\n",
1056 __func__, devres->group->name);
1057 sysfs_remove_group(kobj, devres->group);
1060 static int __wacom_devm_sysfs_create_group(struct wacom *wacom,
1061 struct kobject *root,
1062 struct attribute_group *group)
1064 struct wacom_sysfs_group_devres *devres;
1067 devres = devres_alloc(wacom_devm_sysfs_group_release,
1068 sizeof(struct wacom_sysfs_group_devres),
1073 devres->group = group;
1074 devres->root = root;
1076 error = sysfs_create_group(devres->root, group);
1080 devres_add(&wacom->hdev->dev, devres);
1085 static int wacom_devm_sysfs_create_group(struct wacom *wacom,
1086 struct attribute_group *group)
1088 return __wacom_devm_sysfs_create_group(wacom, &wacom->hdev->dev.kobj,
1092 enum led_brightness wacom_leds_brightness_get(struct wacom_led *led)
1094 struct wacom *wacom = led->wacom;
1096 if (wacom->led.max_hlv)
1097 return led->hlv * LED_FULL / wacom->led.max_hlv;
1099 if (wacom->led.max_llv)
1100 return led->llv * LED_FULL / wacom->led.max_llv;
1102 /* device doesn't support brightness tuning */
1106 static enum led_brightness __wacom_led_brightness_get(struct led_classdev *cdev)
1108 struct wacom_led *led = container_of(cdev, struct wacom_led, cdev);
1109 struct wacom *wacom = led->wacom;
1111 if (wacom->led.groups[led->group].select != led->id)
1114 return wacom_leds_brightness_get(led);
1117 static int wacom_led_brightness_set(struct led_classdev *cdev,
1118 enum led_brightness brightness)
1120 struct wacom_led *led = container_of(cdev, struct wacom_led, cdev);
1121 struct wacom *wacom = led->wacom;
1124 mutex_lock(&wacom->lock);
1126 if (!wacom->led.groups || (brightness == LED_OFF &&
1127 wacom->led.groups[led->group].select != led->id)) {
1132 led->llv = wacom->led.llv = wacom->led.max_llv * brightness / LED_FULL;
1133 led->hlv = wacom->led.hlv = wacom->led.max_hlv * brightness / LED_FULL;
1135 wacom->led.groups[led->group].select = led->id;
1137 error = wacom_led_control(wacom);
1140 mutex_unlock(&wacom->lock);
1145 static void wacom_led_readonly_brightness_set(struct led_classdev *cdev,
1146 enum led_brightness brightness)
1150 static int wacom_led_register_one(struct device *dev, struct wacom *wacom,
1151 struct wacom_led *led, unsigned int group,
1152 unsigned int id, bool read_only)
1157 name = devm_kasprintf(dev, GFP_KERNEL,
1166 led->trigger.name = name;
1167 error = devm_led_trigger_register(dev, &led->trigger);
1169 hid_err(wacom->hdev,
1170 "failed to register LED trigger %s: %d\n",
1171 led->cdev.name, error);
1179 led->llv = wacom->led.llv;
1180 led->hlv = wacom->led.hlv;
1181 led->cdev.name = name;
1182 led->cdev.max_brightness = LED_FULL;
1183 led->cdev.flags = LED_HW_PLUGGABLE;
1184 led->cdev.brightness_get = __wacom_led_brightness_get;
1186 led->cdev.brightness_set_blocking = wacom_led_brightness_set;
1187 led->cdev.default_trigger = led->cdev.name;
1189 led->cdev.brightness_set = wacom_led_readonly_brightness_set;
1192 error = devm_led_classdev_register(dev, &led->cdev);
1194 hid_err(wacom->hdev,
1195 "failed to register LED %s: %d\n",
1196 led->cdev.name, error);
1197 led->cdev.name = NULL;
1204 static void wacom_led_groups_release_one(void *data)
1206 struct wacom_group_leds *group = data;
1208 devres_release_group(group->dev, group);
1211 static int wacom_led_groups_alloc_and_register_one(struct device *dev,
1212 struct wacom *wacom,
1213 int group_id, int count,
1216 struct wacom_led *leds;
1219 if (group_id >= wacom->led.count || count <= 0)
1222 if (!devres_open_group(dev, &wacom->led.groups[group_id], GFP_KERNEL))
1225 leds = devm_kzalloc(dev, sizeof(struct wacom_led) * count, GFP_KERNEL);
1231 wacom->led.groups[group_id].leds = leds;
1232 wacom->led.groups[group_id].count = count;
1234 for (i = 0; i < count; i++) {
1235 error = wacom_led_register_one(dev, wacom, &leds[i],
1236 group_id, i, read_only);
1241 wacom->led.groups[group_id].dev = dev;
1243 devres_close_group(dev, &wacom->led.groups[group_id]);
1246 * There is a bug (?) in devm_led_classdev_register() in which its
1247 * increments the refcount of the parent. If the parent is an input
1248 * device, that means the ref count never reaches 0 when
1249 * devm_input_device_release() gets called.
1250 * This means that the LEDs are still there after disconnect.
1251 * Manually force the release of the group so that the leds are released
1252 * once we are done using them.
1254 error = devm_add_action_or_reset(&wacom->hdev->dev,
1255 wacom_led_groups_release_one,
1256 &wacom->led.groups[group_id]);
1263 devres_release_group(dev, &wacom->led.groups[group_id]);
1267 struct wacom_led *wacom_led_find(struct wacom *wacom, unsigned int group_id,
1270 struct wacom_group_leds *group;
1272 if (group_id >= wacom->led.count)
1275 group = &wacom->led.groups[group_id];
1282 return &group->leds[id];
1286 * wacom_led_next: gives the next available led with a wacom trigger.
1288 * returns the next available struct wacom_led which has its default trigger
1289 * or the current one if none is available.
1291 struct wacom_led *wacom_led_next(struct wacom *wacom, struct wacom_led *cur)
1293 struct wacom_led *next_led;
1303 next_led = wacom_led_find(wacom, group, ++next);
1304 if (!next_led || next_led == cur)
1306 } while (next_led->cdev.trigger != &next_led->trigger);
1311 static void wacom_led_groups_release(void *data)
1313 struct wacom *wacom = data;
1315 wacom->led.groups = NULL;
1316 wacom->led.count = 0;
1319 static int wacom_led_groups_allocate(struct wacom *wacom, int count)
1321 struct device *dev = &wacom->hdev->dev;
1322 struct wacom_group_leds *groups;
1325 groups = devm_kzalloc(dev, sizeof(struct wacom_group_leds) * count,
1330 error = devm_add_action_or_reset(dev, wacom_led_groups_release, wacom);
1334 wacom->led.groups = groups;
1335 wacom->led.count = count;
1340 static int wacom_leds_alloc_and_register(struct wacom *wacom, int group_count,
1341 int led_per_group, bool read_only)
1346 if (!wacom->wacom_wac.pad_input)
1349 dev = &wacom->wacom_wac.pad_input->dev;
1351 error = wacom_led_groups_allocate(wacom, group_count);
1355 for (i = 0; i < group_count; i++) {
1356 error = wacom_led_groups_alloc_and_register_one(dev, wacom, i,
1366 static int wacom_initialize_leds(struct wacom *wacom)
1370 if (!(wacom->wacom_wac.features.device_type & WACOM_DEVICETYPE_PAD))
1373 /* Initialize default values */
1374 switch (wacom->wacom_wac.features.type) {
1379 wacom->led.llv = 10;
1380 wacom->led.hlv = 20;
1381 wacom->led.max_llv = 127;
1382 wacom->led.max_hlv = 127;
1383 wacom->led.img_lum = 10;
1385 error = wacom_leds_alloc_and_register(wacom, 1, 4, false);
1387 hid_err(wacom->hdev,
1388 "cannot create leds err: %d\n", error);
1392 error = wacom_devm_sysfs_create_group(wacom,
1393 &intuos4_led_attr_group);
1400 wacom->led.img_lum = 0;
1402 error = wacom_leds_alloc_and_register(wacom, 2, 4, false);
1404 hid_err(wacom->hdev,
1405 "cannot create leds err: %d\n", error);
1409 error = wacom_devm_sysfs_create_group(wacom,
1410 &cintiq_led_attr_group);
1419 wacom->led.llv = 32;
1420 wacom->led.max_llv = 96;
1422 error = wacom_leds_alloc_and_register(wacom, 1, 4, false);
1424 hid_err(wacom->hdev,
1425 "cannot create leds err: %d\n", error);
1429 error = wacom_devm_sysfs_create_group(wacom,
1430 &intuos5_led_attr_group);
1434 wacom->led.llv = 50;
1435 wacom->led.max_llv = 100;
1436 error = wacom_leds_alloc_and_register(wacom, 1, 4, false);
1438 hid_err(wacom->hdev,
1439 "cannot create leds err: %d\n", error);
1445 wacom->led.llv = 255;
1446 wacom->led.max_llv = 255;
1447 error = wacom_led_groups_allocate(wacom, 5);
1449 hid_err(wacom->hdev,
1450 "cannot create leds err: %d\n", error);
1460 hid_err(wacom->hdev,
1461 "cannot create sysfs group err: %d\n", error);
1468 static void wacom_init_work(struct work_struct *work)
1470 struct wacom *wacom = container_of(work, struct wacom, init_work.work);
1472 _wacom_query_tablet_data(wacom);
1473 wacom_led_control(wacom);
1476 static void wacom_query_tablet_data(struct wacom *wacom)
1478 schedule_delayed_work(&wacom->init_work, msecs_to_jiffies(1000));
1481 static enum power_supply_property wacom_battery_props[] = {
1482 POWER_SUPPLY_PROP_MODEL_NAME,
1483 POWER_SUPPLY_PROP_PRESENT,
1484 POWER_SUPPLY_PROP_STATUS,
1485 POWER_SUPPLY_PROP_SCOPE,
1486 POWER_SUPPLY_PROP_CAPACITY
1489 static int wacom_battery_get_property(struct power_supply *psy,
1490 enum power_supply_property psp,
1491 union power_supply_propval *val)
1493 struct wacom_battery *battery = power_supply_get_drvdata(psy);
1497 case POWER_SUPPLY_PROP_MODEL_NAME:
1498 val->strval = battery->wacom->wacom_wac.name;
1500 case POWER_SUPPLY_PROP_PRESENT:
1501 val->intval = battery->bat_connected;
1503 case POWER_SUPPLY_PROP_SCOPE:
1504 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
1506 case POWER_SUPPLY_PROP_CAPACITY:
1507 val->intval = battery->battery_capacity;
1509 case POWER_SUPPLY_PROP_STATUS:
1510 if (battery->bat_charging)
1511 val->intval = POWER_SUPPLY_STATUS_CHARGING;
1512 else if (battery->battery_capacity == 100 &&
1513 battery->ps_connected)
1514 val->intval = POWER_SUPPLY_STATUS_FULL;
1515 else if (battery->ps_connected)
1516 val->intval = POWER_SUPPLY_STATUS_NOT_CHARGING;
1518 val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
1528 static int __wacom_initialize_battery(struct wacom *wacom,
1529 struct wacom_battery *battery)
1531 static atomic_t battery_no = ATOMIC_INIT(0);
1532 struct device *dev = &wacom->hdev->dev;
1533 struct power_supply_config psy_cfg = { .drv_data = battery, };
1534 struct power_supply *ps_bat;
1535 struct power_supply_desc *bat_desc = &battery->bat_desc;
1539 if (!devres_open_group(dev, bat_desc, GFP_KERNEL))
1542 battery->wacom = wacom;
1544 n = atomic_inc_return(&battery_no) - 1;
1546 bat_desc->properties = wacom_battery_props;
1547 bat_desc->num_properties = ARRAY_SIZE(wacom_battery_props);
1548 bat_desc->get_property = wacom_battery_get_property;
1549 sprintf(battery->bat_name, "wacom_battery_%ld", n);
1550 bat_desc->name = battery->bat_name;
1551 bat_desc->type = POWER_SUPPLY_TYPE_USB;
1552 bat_desc->use_for_apm = 0;
1554 ps_bat = devm_power_supply_register(dev, bat_desc, &psy_cfg);
1555 if (IS_ERR(ps_bat)) {
1556 error = PTR_ERR(ps_bat);
1560 power_supply_powers(ps_bat, &wacom->hdev->dev);
1562 battery->battery = ps_bat;
1564 devres_close_group(dev, bat_desc);
1568 devres_release_group(dev, bat_desc);
1572 static int wacom_initialize_battery(struct wacom *wacom)
1574 if (wacom->wacom_wac.features.quirks & WACOM_QUIRK_BATTERY)
1575 return __wacom_initialize_battery(wacom, &wacom->battery);
1580 static void wacom_destroy_battery(struct wacom *wacom)
1582 if (wacom->battery.battery) {
1583 devres_release_group(&wacom->hdev->dev,
1584 &wacom->battery.bat_desc);
1585 wacom->battery.battery = NULL;
1589 static ssize_t wacom_show_speed(struct device *dev,
1590 struct device_attribute
1593 struct hid_device *hdev = to_hid_device(dev);
1594 struct wacom *wacom = hid_get_drvdata(hdev);
1596 return snprintf(buf, PAGE_SIZE, "%i\n", wacom->wacom_wac.bt_high_speed);
1599 static ssize_t wacom_store_speed(struct device *dev,
1600 struct device_attribute *attr,
1601 const char *buf, size_t count)
1603 struct hid_device *hdev = to_hid_device(dev);
1604 struct wacom *wacom = hid_get_drvdata(hdev);
1607 if (kstrtou8(buf, 0, &new_speed))
1610 if (new_speed != 0 && new_speed != 1)
1613 wacom_bt_query_tablet_data(hdev, new_speed, &wacom->wacom_wac.features);
1618 static DEVICE_ATTR(speed, DEV_ATTR_RW_PERM,
1619 wacom_show_speed, wacom_store_speed);
1622 static ssize_t wacom_show_remote_mode(struct kobject *kobj,
1623 struct kobj_attribute *kattr,
1624 char *buf, int index)
1626 struct device *dev = kobj_to_dev(kobj->parent);
1627 struct hid_device *hdev = to_hid_device(dev);
1628 struct wacom *wacom = hid_get_drvdata(hdev);
1631 mode = wacom->led.groups[index].select;
1632 if (mode >= 0 && mode < 3)
1633 return snprintf(buf, PAGE_SIZE, "%d\n", mode);
1635 return snprintf(buf, PAGE_SIZE, "%d\n", -1);
1638 #define DEVICE_EKR_ATTR_GROUP(SET_ID) \
1639 static ssize_t wacom_show_remote##SET_ID##_mode(struct kobject *kobj, \
1640 struct kobj_attribute *kattr, char *buf) \
1642 return wacom_show_remote_mode(kobj, kattr, buf, SET_ID); \
1644 static struct kobj_attribute remote##SET_ID##_mode_attr = { \
1645 .attr = {.name = "remote_mode", \
1646 .mode = DEV_ATTR_RO_PERM}, \
1647 .show = wacom_show_remote##SET_ID##_mode, \
1649 static struct attribute *remote##SET_ID##_serial_attrs[] = { \
1650 &remote##SET_ID##_mode_attr.attr, \
1653 static struct attribute_group remote##SET_ID##_serial_group = { \
1655 .attrs = remote##SET_ID##_serial_attrs, \
1658 DEVICE_EKR_ATTR_GROUP(0);
1659 DEVICE_EKR_ATTR_GROUP(1);
1660 DEVICE_EKR_ATTR_GROUP(2);
1661 DEVICE_EKR_ATTR_GROUP(3);
1662 DEVICE_EKR_ATTR_GROUP(4);
1664 static int wacom_remote_create_attr_group(struct wacom *wacom, __u32 serial,
1668 struct wacom_remote *remote = wacom->remote;
1670 remote->remotes[index].group.name = devm_kasprintf(&wacom->hdev->dev,
1673 if (!remote->remotes[index].group.name)
1676 error = __wacom_devm_sysfs_create_group(wacom, remote->remote_dir,
1677 &remote->remotes[index].group);
1679 remote->remotes[index].group.name = NULL;
1680 hid_err(wacom->hdev,
1681 "cannot create sysfs group err: %d\n", error);
1688 static int wacom_cmd_unpair_remote(struct wacom *wacom, unsigned char selector)
1690 const size_t buf_size = 2;
1694 buf = kzalloc(buf_size, GFP_KERNEL);
1698 buf[0] = WAC_CMD_DELETE_PAIRING;
1701 retval = wacom_set_report(wacom->hdev, HID_OUTPUT_REPORT, buf,
1702 buf_size, WAC_CMD_RETRIES);
1708 static ssize_t wacom_store_unpair_remote(struct kobject *kobj,
1709 struct kobj_attribute *attr,
1710 const char *buf, size_t count)
1712 unsigned char selector = 0;
1713 struct device *dev = kobj_to_dev(kobj->parent);
1714 struct hid_device *hdev = to_hid_device(dev);
1715 struct wacom *wacom = hid_get_drvdata(hdev);
1718 if (!strncmp(buf, "*\n", 2)) {
1719 selector = WAC_CMD_UNPAIR_ALL;
1721 hid_info(wacom->hdev, "remote: unrecognized unpair code: %s\n",
1726 mutex_lock(&wacom->lock);
1728 err = wacom_cmd_unpair_remote(wacom, selector);
1729 mutex_unlock(&wacom->lock);
1731 return err < 0 ? err : count;
1734 static struct kobj_attribute unpair_remote_attr = {
1735 .attr = {.name = "unpair_remote", .mode = 0200},
1736 .store = wacom_store_unpair_remote,
1739 static const struct attribute *remote_unpair_attrs[] = {
1740 &unpair_remote_attr.attr,
1744 static void wacom_remotes_destroy(void *data)
1746 struct wacom *wacom = data;
1747 struct wacom_remote *remote = wacom->remote;
1752 kobject_put(remote->remote_dir);
1753 kfifo_free(&remote->remote_fifo);
1754 wacom->remote = NULL;
1757 static int wacom_initialize_remotes(struct wacom *wacom)
1760 struct wacom_remote *remote;
1763 if (wacom->wacom_wac.features.type != REMOTE)
1766 remote = devm_kzalloc(&wacom->hdev->dev, sizeof(*wacom->remote),
1771 wacom->remote = remote;
1773 spin_lock_init(&remote->remote_lock);
1775 error = kfifo_alloc(&remote->remote_fifo,
1776 5 * sizeof(struct wacom_remote_data),
1779 hid_err(wacom->hdev, "failed allocating remote_fifo\n");
1783 remote->remotes[0].group = remote0_serial_group;
1784 remote->remotes[1].group = remote1_serial_group;
1785 remote->remotes[2].group = remote2_serial_group;
1786 remote->remotes[3].group = remote3_serial_group;
1787 remote->remotes[4].group = remote4_serial_group;
1789 remote->remote_dir = kobject_create_and_add("wacom_remote",
1790 &wacom->hdev->dev.kobj);
1791 if (!remote->remote_dir)
1794 error = sysfs_create_files(remote->remote_dir, remote_unpair_attrs);
1797 hid_err(wacom->hdev,
1798 "cannot create sysfs group err: %d\n", error);
1802 for (i = 0; i < WACOM_MAX_REMOTES; i++) {
1803 wacom->led.groups[i].select = WACOM_STATUS_UNKNOWN;
1804 remote->remotes[i].serial = 0;
1807 error = devm_add_action_or_reset(&wacom->hdev->dev,
1808 wacom_remotes_destroy, wacom);
1815 static struct input_dev *wacom_allocate_input(struct wacom *wacom)
1817 struct input_dev *input_dev;
1818 struct hid_device *hdev = wacom->hdev;
1819 struct wacom_wac *wacom_wac = &(wacom->wacom_wac);
1821 input_dev = devm_input_allocate_device(&hdev->dev);
1825 input_dev->name = wacom_wac->features.name;
1826 input_dev->phys = hdev->phys;
1827 input_dev->dev.parent = &hdev->dev;
1828 input_dev->open = wacom_open;
1829 input_dev->close = wacom_close;
1830 input_dev->uniq = hdev->uniq;
1831 input_dev->id.bustype = hdev->bus;
1832 input_dev->id.vendor = hdev->vendor;
1833 input_dev->id.product = wacom_wac->pid ? wacom_wac->pid : hdev->product;
1834 input_dev->id.version = hdev->version;
1835 input_set_drvdata(input_dev, wacom);
1840 static int wacom_allocate_inputs(struct wacom *wacom)
1842 struct wacom_wac *wacom_wac = &(wacom->wacom_wac);
1844 wacom_wac->pen_input = wacom_allocate_input(wacom);
1845 wacom_wac->touch_input = wacom_allocate_input(wacom);
1846 wacom_wac->pad_input = wacom_allocate_input(wacom);
1847 if (!wacom_wac->pen_input ||
1848 !wacom_wac->touch_input ||
1849 !wacom_wac->pad_input)
1852 wacom_wac->pen_input->name = wacom_wac->pen_name;
1853 wacom_wac->touch_input->name = wacom_wac->touch_name;
1854 wacom_wac->pad_input->name = wacom_wac->pad_name;
1859 static int wacom_register_inputs(struct wacom *wacom)
1861 struct input_dev *pen_input_dev, *touch_input_dev, *pad_input_dev;
1862 struct wacom_wac *wacom_wac = &(wacom->wacom_wac);
1865 pen_input_dev = wacom_wac->pen_input;
1866 touch_input_dev = wacom_wac->touch_input;
1867 pad_input_dev = wacom_wac->pad_input;
1869 if (!pen_input_dev || !touch_input_dev || !pad_input_dev)
1872 error = wacom_setup_pen_input_capabilities(pen_input_dev, wacom_wac);
1874 /* no pen in use on this interface */
1875 input_free_device(pen_input_dev);
1876 wacom_wac->pen_input = NULL;
1877 pen_input_dev = NULL;
1879 error = input_register_device(pen_input_dev);
1884 error = wacom_setup_touch_input_capabilities(touch_input_dev, wacom_wac);
1886 /* no touch in use on this interface */
1887 input_free_device(touch_input_dev);
1888 wacom_wac->touch_input = NULL;
1889 touch_input_dev = NULL;
1891 error = input_register_device(touch_input_dev);
1896 error = wacom_setup_pad_input_capabilities(pad_input_dev, wacom_wac);
1898 /* no pad in use on this interface */
1899 input_free_device(pad_input_dev);
1900 wacom_wac->pad_input = NULL;
1901 pad_input_dev = NULL;
1903 error = input_register_device(pad_input_dev);
1911 wacom_wac->pad_input = NULL;
1912 wacom_wac->touch_input = NULL;
1913 wacom_wac->pen_input = NULL;
1918 * Not all devices report physical dimensions from HID.
1919 * Compute the default from hardcoded logical dimension
1920 * and resolution before driver overwrites them.
1922 static void wacom_set_default_phy(struct wacom_features *features)
1924 if (features->x_resolution) {
1925 features->x_phy = (features->x_max * 100) /
1926 features->x_resolution;
1927 features->y_phy = (features->y_max * 100) /
1928 features->y_resolution;
1932 static void wacom_calculate_res(struct wacom_features *features)
1934 /* set unit to "100th of a mm" for devices not reported by HID */
1935 if (!features->unit) {
1936 features->unit = 0x11;
1937 features->unitExpo = -3;
1940 features->x_resolution = wacom_calc_hid_res(features->x_max,
1943 features->unitExpo);
1944 features->y_resolution = wacom_calc_hid_res(features->y_max,
1947 features->unitExpo);
1950 void wacom_battery_work(struct work_struct *work)
1952 struct wacom *wacom = container_of(work, struct wacom, battery_work);
1954 if ((wacom->wacom_wac.features.quirks & WACOM_QUIRK_BATTERY) &&
1955 !wacom->battery.battery) {
1956 wacom_initialize_battery(wacom);
1958 else if (!(wacom->wacom_wac.features.quirks & WACOM_QUIRK_BATTERY) &&
1959 wacom->battery.battery) {
1960 wacom_destroy_battery(wacom);
1964 static size_t wacom_compute_pktlen(struct hid_device *hdev)
1966 struct hid_report_enum *report_enum;
1967 struct hid_report *report;
1970 report_enum = hdev->report_enum + HID_INPUT_REPORT;
1972 list_for_each_entry(report, &report_enum->report_list, list) {
1973 size_t report_size = hid_report_len(report);
1974 if (report_size > size)
1981 static void wacom_update_name(struct wacom *wacom, const char *suffix)
1983 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
1984 struct wacom_features *features = &wacom_wac->features;
1985 char name[WACOM_NAME_MAX];
1987 /* Generic devices name unspecified */
1988 if ((features->type == HID_GENERIC) && !strcmp("Wacom HID", features->name)) {
1989 if (strstr(wacom->hdev->name, "Wacom") ||
1990 strstr(wacom->hdev->name, "wacom") ||
1991 strstr(wacom->hdev->name, "WACOM")) {
1992 /* name is in HID descriptor, use it */
1993 strlcpy(name, wacom->hdev->name, sizeof(name));
1995 /* strip out excess whitespaces */
1997 char *gap = strstr(name, " ");
2000 /* shift everything including the terminator */
2001 memmove(gap, gap+1, strlen(gap));
2004 /* strip off excessive prefixing */
2005 if (strstr(name, "Wacom Co.,Ltd. Wacom ") == name) {
2006 int n = strlen(name);
2007 int x = strlen("Wacom Co.,Ltd. ");
2008 memmove(name, name+x, n-x+1);
2010 if (strstr(name, "Wacom Co., Ltd. Wacom ") == name) {
2011 int n = strlen(name);
2012 int x = strlen("Wacom Co., Ltd. ");
2013 memmove(name, name+x, n-x+1);
2016 /* get rid of trailing whitespace */
2017 if (name[strlen(name)-1] == ' ')
2018 name[strlen(name)-1] = '\0';
2020 /* no meaningful name retrieved. use product ID */
2021 snprintf(name, sizeof(name),
2022 "%s %X", features->name, wacom->hdev->product);
2025 strlcpy(name, features->name, sizeof(name));
2028 snprintf(wacom_wac->name, sizeof(wacom_wac->name), "%s%s",
2031 /* Append the device type to the name */
2032 snprintf(wacom_wac->pen_name, sizeof(wacom_wac->pen_name),
2033 "%s%s Pen", name, suffix);
2034 snprintf(wacom_wac->touch_name, sizeof(wacom_wac->touch_name),
2035 "%s%s Finger", name, suffix);
2036 snprintf(wacom_wac->pad_name, sizeof(wacom_wac->pad_name),
2037 "%s%s Pad", name, suffix);
2040 static void wacom_release_resources(struct wacom *wacom)
2042 struct hid_device *hdev = wacom->hdev;
2044 if (!wacom->resources)
2047 devres_release_group(&hdev->dev, wacom);
2049 wacom->resources = false;
2051 wacom->wacom_wac.pen_input = NULL;
2052 wacom->wacom_wac.touch_input = NULL;
2053 wacom->wacom_wac.pad_input = NULL;
2056 static int wacom_parse_and_register(struct wacom *wacom, bool wireless)
2058 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
2059 struct wacom_features *features = &wacom_wac->features;
2060 struct hid_device *hdev = wacom->hdev;
2062 unsigned int connect_mask = HID_CONNECT_HIDRAW;
2064 features->pktlen = wacom_compute_pktlen(hdev);
2065 if (features->pktlen > WACOM_PKGLEN_MAX)
2068 if (!devres_open_group(&hdev->dev, wacom, GFP_KERNEL))
2071 wacom->resources = true;
2073 error = wacom_allocate_inputs(wacom);
2078 * Bamboo Pad has a generic hid handling for the Pen, and we switch it
2079 * into debug mode for the touch part.
2080 * We ignore the other interfaces.
2082 if (features->type == BAMBOO_PAD) {
2083 if (features->pktlen == WACOM_PKGLEN_PENABLED) {
2084 features->type = HID_GENERIC;
2085 } else if ((features->pktlen != WACOM_PKGLEN_BPAD_TOUCH) &&
2086 (features->pktlen != WACOM_PKGLEN_BPAD_TOUCH_USB)) {
2092 /* set the default size in case we do not get them from hid */
2093 wacom_set_default_phy(features);
2095 /* Retrieve the physical and logical size for touch devices */
2096 wacom_retrieve_hid_descriptor(hdev, features);
2097 wacom_setup_device_quirks(wacom);
2099 if (features->device_type == WACOM_DEVICETYPE_NONE &&
2100 features->type != WIRELESS) {
2101 error = features->type == HID_GENERIC ? -ENODEV : 0;
2103 dev_warn(&hdev->dev, "Unknown device_type for '%s'. %s.",
2105 error ? "Ignoring" : "Assuming pen");
2110 features->device_type |= WACOM_DEVICETYPE_PEN;
2113 wacom_calculate_res(features);
2115 wacom_update_name(wacom, wireless ? " (WL)" : "");
2117 error = wacom_add_shared_data(hdev);
2121 if (!(features->device_type & WACOM_DEVICETYPE_WL_MONITOR) &&
2122 (features->quirks & WACOM_QUIRK_BATTERY)) {
2123 error = wacom_initialize_battery(wacom);
2128 error = wacom_register_inputs(wacom);
2132 if (wacom->wacom_wac.features.device_type & WACOM_DEVICETYPE_PAD) {
2133 error = wacom_initialize_leds(wacom);
2137 error = wacom_initialize_remotes(wacom);
2142 if (features->type == HID_GENERIC)
2143 connect_mask |= HID_CONNECT_DRIVER;
2145 /* Regular HID work starts now */
2146 error = hid_hw_start(hdev, connect_mask);
2148 hid_err(hdev, "hw start failed\n");
2153 /* Note that if query fails it is not a hard failure */
2154 wacom_query_tablet_data(wacom);
2157 /* touch only Bamboo doesn't support pen */
2158 if ((features->type == BAMBOO_TOUCH) &&
2159 (features->device_type & WACOM_DEVICETYPE_PEN)) {
2164 /* pen only Bamboo neither support touch nor pad */
2165 if ((features->type == BAMBOO_PEN) &&
2166 ((features->device_type & WACOM_DEVICETYPE_TOUCH) ||
2167 (features->device_type & WACOM_DEVICETYPE_PAD))) {
2172 if (features->device_type & WACOM_DEVICETYPE_WL_MONITOR)
2173 error = hid_hw_open(hdev);
2175 if ((wacom_wac->features.type == INTUOSHT ||
2176 wacom_wac->features.type == INTUOSHT2) &&
2177 (wacom_wac->features.device_type & WACOM_DEVICETYPE_TOUCH)) {
2178 wacom_wac->shared->type = wacom_wac->features.type;
2179 wacom_wac->shared->touch_input = wacom_wac->touch_input;
2182 devres_close_group(&hdev->dev, wacom);
2189 wacom_release_resources(wacom);
2193 static void wacom_wireless_work(struct work_struct *work)
2195 struct wacom *wacom = container_of(work, struct wacom, wireless_work);
2196 struct usb_device *usbdev = wacom->usbdev;
2197 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
2198 struct hid_device *hdev1, *hdev2;
2199 struct wacom *wacom1, *wacom2;
2200 struct wacom_wac *wacom_wac1, *wacom_wac2;
2204 * Regardless if this is a disconnect or a new tablet,
2205 * remove any existing input and battery devices.
2208 wacom_destroy_battery(wacom);
2210 /* Stylus interface */
2211 hdev1 = usb_get_intfdata(usbdev->config->interface[1]);
2212 wacom1 = hid_get_drvdata(hdev1);
2213 wacom_wac1 = &(wacom1->wacom_wac);
2214 wacom_release_resources(wacom1);
2216 /* Touch interface */
2217 hdev2 = usb_get_intfdata(usbdev->config->interface[2]);
2218 wacom2 = hid_get_drvdata(hdev2);
2219 wacom_wac2 = &(wacom2->wacom_wac);
2220 wacom_release_resources(wacom2);
2222 if (wacom_wac->pid == 0) {
2223 hid_info(wacom->hdev, "wireless tablet disconnected\n");
2225 const struct hid_device_id *id = wacom_ids;
2227 hid_info(wacom->hdev, "wireless tablet connected with PID %x\n",
2231 if (id->vendor == USB_VENDOR_ID_WACOM &&
2232 id->product == wacom_wac->pid)
2238 hid_info(wacom->hdev, "ignoring unknown PID.\n");
2242 /* Stylus interface */
2243 wacom_wac1->features =
2244 *((struct wacom_features *)id->driver_data);
2246 wacom_wac1->pid = wacom_wac->pid;
2248 error = wacom_parse_and_register(wacom1, true);
2252 /* Touch interface */
2253 if (wacom_wac1->features.touch_max ||
2254 (wacom_wac1->features.type >= INTUOSHT &&
2255 wacom_wac1->features.type <= BAMBOO_PT)) {
2256 wacom_wac2->features =
2257 *((struct wacom_features *)id->driver_data);
2258 wacom_wac2->pid = wacom_wac->pid;
2260 error = wacom_parse_and_register(wacom2, true);
2265 strlcpy(wacom_wac->name, wacom_wac1->name,
2266 sizeof(wacom_wac->name));
2267 error = wacom_initialize_battery(wacom);
2275 wacom_release_resources(wacom1);
2276 wacom_release_resources(wacom2);
2280 static void wacom_remote_destroy_one(struct wacom *wacom, unsigned int index)
2282 struct wacom_remote *remote = wacom->remote;
2283 u32 serial = remote->remotes[index].serial;
2285 unsigned long flags;
2287 spin_lock_irqsave(&remote->remote_lock, flags);
2288 remote->remotes[index].registered = false;
2289 spin_unlock_irqrestore(&remote->remote_lock, flags);
2291 if (remote->remotes[index].battery.battery)
2292 devres_release_group(&wacom->hdev->dev,
2293 &remote->remotes[index].battery.bat_desc);
2295 if (remote->remotes[index].group.name)
2296 devres_release_group(&wacom->hdev->dev,
2297 &remote->remotes[index]);
2299 for (i = 0; i < WACOM_MAX_REMOTES; i++) {
2300 if (remote->remotes[i].serial == serial) {
2301 remote->remotes[i].serial = 0;
2302 remote->remotes[i].group.name = NULL;
2303 remote->remotes[i].registered = false;
2304 remote->remotes[i].battery.battery = NULL;
2305 wacom->led.groups[i].select = WACOM_STATUS_UNKNOWN;
2310 static int wacom_remote_create_one(struct wacom *wacom, u32 serial,
2313 struct wacom_remote *remote = wacom->remote;
2314 struct device *dev = &wacom->hdev->dev;
2317 /* A remote can pair more than once with an EKR,
2318 * check to make sure this serial isn't already paired.
2320 for (k = 0; k < WACOM_MAX_REMOTES; k++) {
2321 if (remote->remotes[k].serial == serial)
2325 if (k < WACOM_MAX_REMOTES) {
2326 remote->remotes[index].serial = serial;
2330 if (!devres_open_group(dev, &remote->remotes[index], GFP_KERNEL))
2333 error = wacom_remote_create_attr_group(wacom, serial, index);
2337 remote->remotes[index].input = wacom_allocate_input(wacom);
2338 if (!remote->remotes[index].input) {
2342 remote->remotes[index].input->uniq = remote->remotes[index].group.name;
2343 remote->remotes[index].input->name = wacom->wacom_wac.pad_name;
2345 if (!remote->remotes[index].input->name) {
2350 error = wacom_setup_pad_input_capabilities(remote->remotes[index].input,
2355 remote->remotes[index].serial = serial;
2357 error = input_register_device(remote->remotes[index].input);
2361 error = wacom_led_groups_alloc_and_register_one(
2362 &remote->remotes[index].input->dev,
2363 wacom, index, 3, true);
2367 remote->remotes[index].registered = true;
2369 devres_close_group(dev, &remote->remotes[index]);
2373 devres_release_group(dev, &remote->remotes[index]);
2374 remote->remotes[index].serial = 0;
2378 static int wacom_remote_attach_battery(struct wacom *wacom, int index)
2380 struct wacom_remote *remote = wacom->remote;
2383 if (!remote->remotes[index].registered)
2386 if (remote->remotes[index].battery.battery)
2389 if (wacom->led.groups[index].select == WACOM_STATUS_UNKNOWN)
2392 error = __wacom_initialize_battery(wacom,
2393 &wacom->remote->remotes[index].battery);
2400 static void wacom_remote_work(struct work_struct *work)
2402 struct wacom *wacom = container_of(work, struct wacom, remote_work);
2403 struct wacom_remote *remote = wacom->remote;
2404 struct wacom_remote_data data;
2405 unsigned long flags;
2410 spin_lock_irqsave(&remote->remote_lock, flags);
2412 count = kfifo_out(&remote->remote_fifo, &data, sizeof(data));
2414 if (count != sizeof(data)) {
2415 hid_err(wacom->hdev,
2416 "workitem triggered without status available\n");
2417 spin_unlock_irqrestore(&remote->remote_lock, flags);
2421 if (!kfifo_is_empty(&remote->remote_fifo))
2422 wacom_schedule_work(&wacom->wacom_wac, WACOM_WORKER_REMOTE);
2424 spin_unlock_irqrestore(&remote->remote_lock, flags);
2426 for (i = 0; i < WACOM_MAX_REMOTES; i++) {
2427 serial = data.remote[i].serial;
2428 if (data.remote[i].connected) {
2430 if (remote->remotes[i].serial == serial) {
2431 wacom_remote_attach_battery(wacom, i);
2435 if (remote->remotes[i].serial)
2436 wacom_remote_destroy_one(wacom, i);
2438 wacom_remote_create_one(wacom, serial, i);
2440 } else if (remote->remotes[i].serial) {
2441 wacom_remote_destroy_one(wacom, i);
2446 static int wacom_probe(struct hid_device *hdev,
2447 const struct hid_device_id *id)
2449 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
2450 struct usb_device *dev = interface_to_usbdev(intf);
2451 struct wacom *wacom;
2452 struct wacom_wac *wacom_wac;
2453 struct wacom_features *features;
2456 if (!id->driver_data)
2459 hdev->quirks |= HID_QUIRK_NO_INIT_REPORTS;
2461 /* hid-core sets this quirk for the boot interface */
2462 hdev->quirks &= ~HID_QUIRK_NOGET;
2464 wacom = devm_kzalloc(&hdev->dev, sizeof(struct wacom), GFP_KERNEL);
2468 hid_set_drvdata(hdev, wacom);
2471 wacom_wac = &wacom->wacom_wac;
2472 wacom_wac->features = *((struct wacom_features *)id->driver_data);
2473 features = &wacom_wac->features;
2475 if (features->check_for_hid_type && features->hid_type != hdev->type) {
2480 wacom_wac->hid_data.inputmode = -1;
2481 wacom_wac->mode_report = -1;
2483 wacom->usbdev = dev;
2485 mutex_init(&wacom->lock);
2486 INIT_DELAYED_WORK(&wacom->init_work, wacom_init_work);
2487 INIT_WORK(&wacom->wireless_work, wacom_wireless_work);
2488 INIT_WORK(&wacom->battery_work, wacom_battery_work);
2489 INIT_WORK(&wacom->remote_work, wacom_remote_work);
2491 /* ask for the report descriptor to be loaded by HID */
2492 error = hid_parse(hdev);
2494 hid_err(hdev, "parse failed\n");
2498 error = wacom_parse_and_register(wacom, false);
2502 if (hdev->bus == BUS_BLUETOOTH) {
2503 error = device_create_file(&hdev->dev, &dev_attr_speed);
2506 "can't create sysfs speed attribute err: %d\n",
2513 hid_set_drvdata(hdev, NULL);
2517 static void wacom_remove(struct hid_device *hdev)
2519 struct wacom *wacom = hid_get_drvdata(hdev);
2520 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
2521 struct wacom_features *features = &wacom_wac->features;
2523 if (features->device_type & WACOM_DEVICETYPE_WL_MONITOR)
2528 cancel_delayed_work_sync(&wacom->init_work);
2529 cancel_work_sync(&wacom->wireless_work);
2530 cancel_work_sync(&wacom->battery_work);
2531 cancel_work_sync(&wacom->remote_work);
2532 if (hdev->bus == BUS_BLUETOOTH)
2533 device_remove_file(&hdev->dev, &dev_attr_speed);
2535 /* make sure we don't trigger the LEDs */
2536 wacom_led_groups_release(wacom);
2537 wacom_release_resources(wacom);
2539 hid_set_drvdata(hdev, NULL);
2543 static int wacom_resume(struct hid_device *hdev)
2545 struct wacom *wacom = hid_get_drvdata(hdev);
2547 mutex_lock(&wacom->lock);
2549 /* switch to wacom mode first */
2550 _wacom_query_tablet_data(wacom);
2551 wacom_led_control(wacom);
2553 mutex_unlock(&wacom->lock);
2558 static int wacom_reset_resume(struct hid_device *hdev)
2560 return wacom_resume(hdev);
2562 #endif /* CONFIG_PM */
2564 static struct hid_driver wacom_driver = {
2566 .id_table = wacom_ids,
2567 .probe = wacom_probe,
2568 .remove = wacom_remove,
2569 .report = wacom_wac_report,
2571 .resume = wacom_resume,
2572 .reset_resume = wacom_reset_resume,
2574 .raw_event = wacom_raw_event,
2576 module_hid_driver(wacom_driver);
2578 MODULE_VERSION(DRIVER_VERSION);
2579 MODULE_AUTHOR(DRIVER_AUTHOR);
2580 MODULE_DESCRIPTION(DRIVER_DESC);
2581 MODULE_LICENSE(DRIVER_LICENSE);