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
20 #define WAC_CMD_WL_LED_CONTROL 0x03
21 #define WAC_CMD_LED_CONTROL 0x20
22 #define WAC_CMD_ICON_START 0x21
23 #define WAC_CMD_ICON_XFER 0x23
24 #define WAC_CMD_ICON_BT_XFER 0x26
25 #define WAC_CMD_RETRIES 10
26 #define WAC_CMD_DELETE_PAIRING 0x20
27 #define WAC_CMD_UNPAIR_ALL 0xFF
29 #define DEV_ATTR_RW_PERM (S_IRUGO | S_IWUSR | S_IWGRP)
30 #define DEV_ATTR_WO_PERM (S_IWUSR | S_IWGRP)
31 #define DEV_ATTR_RO_PERM (S_IRUSR | S_IRGRP)
33 static int wacom_get_report(struct hid_device *hdev, u8 type, u8 *buf,
34 size_t size, unsigned int retries)
39 retval = hid_hw_raw_request(hdev, buf[0], buf, size, type,
41 } while ((retval == -ETIMEDOUT || retval == -EAGAIN) && --retries);
44 hid_err(hdev, "wacom_get_report: ran out of retries "
45 "(last error = %d)\n", retval);
50 static int wacom_set_report(struct hid_device *hdev, u8 type, u8 *buf,
51 size_t size, unsigned int retries)
56 retval = hid_hw_raw_request(hdev, buf[0], buf, size, type,
58 } while ((retval == -ETIMEDOUT || retval == -EAGAIN) && --retries);
61 hid_err(hdev, "wacom_set_report: ran out of retries "
62 "(last error = %d)\n", retval);
67 static int wacom_raw_event(struct hid_device *hdev, struct hid_report *report,
68 u8 *raw_data, int size)
70 struct wacom *wacom = hid_get_drvdata(hdev);
72 if (size > WACOM_PKGLEN_MAX)
75 memcpy(wacom->wacom_wac.data, raw_data, size);
77 wacom_wac_irq(&wacom->wacom_wac, size);
82 static int wacom_open(struct input_dev *dev)
84 struct wacom *wacom = input_get_drvdata(dev);
86 return hid_hw_open(wacom->hdev);
89 static void wacom_close(struct input_dev *dev)
91 struct wacom *wacom = input_get_drvdata(dev);
94 * wacom->hdev should never be null, but surprisingly, I had the case
95 * once while unplugging the Wacom Wireless Receiver.
98 hid_hw_close(wacom->hdev);
102 * Calculate the resolution of the X or Y axis using hidinput_calc_abs_res.
104 static int wacom_calc_hid_res(int logical_extents, int physical_extents,
105 unsigned unit, int exponent)
107 struct hid_field field = {
108 .logical_maximum = logical_extents,
109 .physical_maximum = physical_extents,
111 .unit_exponent = exponent,
114 return hidinput_calc_abs_res(&field, ABS_X);
117 static void wacom_feature_mapping(struct hid_device *hdev,
118 struct hid_field *field, struct hid_usage *usage)
120 struct wacom *wacom = hid_get_drvdata(hdev);
121 struct wacom_features *features = &wacom->wacom_wac.features;
122 struct hid_data *hid_data = &wacom->wacom_wac.hid_data;
126 switch (usage->hid) {
127 case HID_DG_CONTACTMAX:
128 /* leave touch_max as is if predefined */
129 if (!features->touch_max) {
131 data = kzalloc(2, GFP_KERNEL);
134 data[0] = field->report->id;
135 ret = wacom_get_report(hdev, HID_FEATURE_REPORT,
136 data, 2, WAC_CMD_RETRIES);
138 features->touch_max = data[1];
140 features->touch_max = 16;
141 hid_warn(hdev, "wacom_feature_mapping: "
142 "could not get HID_DG_CONTACTMAX, "
143 "defaulting to %d\n",
144 features->touch_max);
149 case HID_DG_INPUTMODE:
150 /* Ignore if value index is out of bounds. */
151 if (usage->usage_index >= field->report_count) {
152 dev_err(&hdev->dev, "HID_DG_INPUTMODE out of range\n");
156 hid_data->inputmode = field->report->id;
157 hid_data->inputmode_index = usage->usage_index;
160 case HID_UP_DIGITIZER:
161 if (field->report->id == 0x0B &&
162 (field->application == WACOM_G9_DIGITIZER ||
163 field->application == WACOM_G11_DIGITIZER)) {
164 wacom->wacom_wac.mode_report = field->report->id;
165 wacom->wacom_wac.mode_value = 0;
171 if (field->report->id == 0x03 &&
172 (field->application == WACOM_G9_TOUCHSCREEN ||
173 field->application == WACOM_G11_TOUCHSCREEN)) {
174 wacom->wacom_wac.mode_report = field->report->id;
175 wacom->wacom_wac.mode_value = 0;
182 * Interface Descriptor of wacom devices can be incomplete and
183 * inconsistent so wacom_features table is used to store stylus
184 * device's packet lengths, various maximum values, and tablet
185 * resolution based on product ID's.
187 * For devices that contain 2 interfaces, wacom_features table is
188 * inaccurate for the touch interface. Since the Interface Descriptor
189 * for touch interfaces has pretty complete data, this function exists
190 * to query tablet for this missing information instead of hard coding in
191 * an additional table.
193 * A typical Interface Descriptor for a stylus will contain a
194 * boot mouse application collection that is not of interest and this
195 * function will ignore it.
197 * It also contains a digitizer application collection that also is not
198 * of interest since any information it contains would be duplicate
199 * of what is in wacom_features. Usually it defines a report of an array
200 * of bytes that could be used as max length of the stylus packet returned.
201 * If it happens to define a Digitizer-Stylus Physical Collection then
202 * the X and Y logical values contain valid data but it is ignored.
204 * A typical Interface Descriptor for a touch interface will contain a
205 * Digitizer-Finger Physical Collection which will define both logical
206 * X/Y maximum as well as the physical size of tablet. Since touch
207 * interfaces haven't supported pressure or distance, this is enough
208 * information to override invalid values in the wacom_features table.
210 * Intuos5 touch interface and 3rd gen Bamboo Touch do not contain useful
211 * data. We deal with them after returning from this function.
213 static void wacom_usage_mapping(struct hid_device *hdev,
214 struct hid_field *field, struct hid_usage *usage)
216 struct wacom *wacom = hid_get_drvdata(hdev);
217 struct wacom_features *features = &wacom->wacom_wac.features;
218 bool finger = WACOM_FINGER_FIELD(field);
219 bool pen = WACOM_PEN_FIELD(field);
222 * Requiring Stylus Usage will ignore boot mouse
223 * X/Y values and some cases of invalid Digitizer X/Y
224 * values commonly reported.
227 features->device_type |= WACOM_DEVICETYPE_PEN;
229 features->device_type |= WACOM_DEVICETYPE_TOUCH;
234 * Bamboo models do not support HID_DG_CONTACTMAX.
235 * And, Bamboo Pen only descriptor contains touch.
237 if (features->type > BAMBOO_PT) {
238 /* ISDv4 touch devices at least supports one touch point */
239 if (finger && !features->touch_max)
240 features->touch_max = 1;
243 switch (usage->hid) {
245 features->x_max = field->logical_maximum;
247 features->x_phy = field->physical_maximum;
248 if ((features->type != BAMBOO_PT) &&
249 (features->type != BAMBOO_TOUCH)) {
250 features->unit = field->unit;
251 features->unitExpo = field->unit_exponent;
256 features->y_max = field->logical_maximum;
258 features->y_phy = field->physical_maximum;
259 if ((features->type != BAMBOO_PT) &&
260 (features->type != BAMBOO_TOUCH)) {
261 features->unit = field->unit;
262 features->unitExpo = field->unit_exponent;
266 case HID_DG_TIPPRESSURE:
268 features->pressure_max = field->logical_maximum;
272 if (features->type == HID_GENERIC)
273 wacom_wac_usage_mapping(hdev, field, usage);
276 static void wacom_post_parse_hid(struct hid_device *hdev,
277 struct wacom_features *features)
279 struct wacom *wacom = hid_get_drvdata(hdev);
280 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
282 if (features->type == HID_GENERIC) {
283 /* Any last-minute generic device setup */
284 if (features->touch_max > 1) {
285 input_mt_init_slots(wacom_wac->touch_input, wacom_wac->features.touch_max,
291 static void wacom_parse_hid(struct hid_device *hdev,
292 struct wacom_features *features)
294 struct hid_report_enum *rep_enum;
295 struct hid_report *hreport;
298 /* check features first */
299 rep_enum = &hdev->report_enum[HID_FEATURE_REPORT];
300 list_for_each_entry(hreport, &rep_enum->report_list, list) {
301 for (i = 0; i < hreport->maxfield; i++) {
302 /* Ignore if report count is out of bounds. */
303 if (hreport->field[i]->report_count < 1)
306 for (j = 0; j < hreport->field[i]->maxusage; j++) {
307 wacom_feature_mapping(hdev, hreport->field[i],
308 hreport->field[i]->usage + j);
313 /* now check the input usages */
314 rep_enum = &hdev->report_enum[HID_INPUT_REPORT];
315 list_for_each_entry(hreport, &rep_enum->report_list, list) {
317 if (!hreport->maxfield)
320 for (i = 0; i < hreport->maxfield; i++)
321 for (j = 0; j < hreport->field[i]->maxusage; j++)
322 wacom_usage_mapping(hdev, hreport->field[i],
323 hreport->field[i]->usage + j);
326 wacom_post_parse_hid(hdev, features);
329 static int wacom_hid_set_device_mode(struct hid_device *hdev)
331 struct wacom *wacom = hid_get_drvdata(hdev);
332 struct hid_data *hid_data = &wacom->wacom_wac.hid_data;
333 struct hid_report *r;
334 struct hid_report_enum *re;
336 if (hid_data->inputmode < 0)
339 re = &(hdev->report_enum[HID_FEATURE_REPORT]);
340 r = re->report_id_hash[hid_data->inputmode];
342 r->field[0]->value[hid_data->inputmode_index] = 2;
343 hid_hw_request(hdev, r, HID_REQ_SET_REPORT);
348 static int wacom_set_device_mode(struct hid_device *hdev,
349 struct wacom_wac *wacom_wac)
352 struct hid_report *r;
353 struct hid_report_enum *re;
355 int error = -ENOMEM, limit = 0;
357 if (wacom_wac->mode_report < 0)
360 re = &(hdev->report_enum[HID_FEATURE_REPORT]);
361 r = re->report_id_hash[wacom_wac->mode_report];
365 rep_data = hid_alloc_report_buf(r, GFP_KERNEL);
369 length = hid_report_len(r);
372 rep_data[0] = wacom_wac->mode_report;
373 rep_data[1] = wacom_wac->mode_value;
375 error = wacom_set_report(hdev, HID_FEATURE_REPORT, rep_data,
378 error = wacom_get_report(hdev, HID_FEATURE_REPORT,
379 rep_data, length, 1);
380 } while (error >= 0 &&
381 rep_data[1] != wacom_wac->mode_report &&
382 limit++ < WAC_MSG_RETRIES);
386 return error < 0 ? error : 0;
389 static int wacom_bt_query_tablet_data(struct hid_device *hdev, u8 speed,
390 struct wacom_features *features)
392 struct wacom *wacom = hid_get_drvdata(hdev);
396 switch (features->type) {
400 ret = wacom_set_report(hdev, HID_FEATURE_REPORT, rep_data, 2,
404 rep_data[0] = speed == 0 ? 0x05 : 0x06;
407 ret = wacom_set_report(hdev, HID_FEATURE_REPORT,
411 wacom->wacom_wac.bt_high_speed = speed;
417 * Note that if the raw queries fail, it's not a hard failure
418 * and it is safe to continue
420 hid_warn(hdev, "failed to poke device, command %d, err %d\n",
425 wacom->wacom_wac.bt_features &= ~0x20;
427 wacom->wacom_wac.bt_features |= 0x20;
430 rep_data[1] = wacom->wacom_wac.bt_features;
432 ret = wacom_set_report(hdev, HID_FEATURE_REPORT, rep_data, 2,
435 wacom->wacom_wac.bt_high_speed = speed;
443 * Switch the tablet into its most-capable mode. Wacom tablets are
444 * typically configured to power-up in a mode which sends mouse-like
445 * reports to the OS. To get absolute position, pressure data, etc.
446 * from the tablet, it is necessary to switch the tablet out of this
447 * mode and into one which sends the full range of tablet data.
449 static int wacom_query_tablet_data(struct hid_device *hdev,
450 struct wacom_features *features)
452 struct wacom *wacom = hid_get_drvdata(hdev);
453 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
455 if (hdev->bus == BUS_BLUETOOTH)
456 return wacom_bt_query_tablet_data(hdev, 1, features);
458 if (features->type != HID_GENERIC) {
459 if (features->device_type & WACOM_DEVICETYPE_TOUCH) {
460 if (features->type > TABLETPC) {
461 /* MT Tablet PC touch */
462 wacom_wac->mode_report = 3;
463 wacom_wac->mode_value = 4;
464 } else if (features->type == WACOM_24HDT) {
465 wacom_wac->mode_report = 18;
466 wacom_wac->mode_value = 2;
467 } else if (features->type == WACOM_27QHDT) {
468 wacom_wac->mode_report = 131;
469 wacom_wac->mode_value = 2;
470 } else if (features->type == BAMBOO_PAD) {
471 wacom_wac->mode_report = 2;
472 wacom_wac->mode_value = 2;
474 } else if (features->device_type & WACOM_DEVICETYPE_PEN) {
475 if (features->type <= BAMBOO_PT) {
476 wacom_wac->mode_report = 2;
477 wacom_wac->mode_value = 2;
482 wacom_set_device_mode(hdev, wacom_wac);
484 if (features->type == HID_GENERIC)
485 return wacom_hid_set_device_mode(hdev);
490 static void wacom_retrieve_hid_descriptor(struct hid_device *hdev,
491 struct wacom_features *features)
493 struct wacom *wacom = hid_get_drvdata(hdev);
494 struct usb_interface *intf = wacom->intf;
496 /* default features */
497 features->x_fuzz = 4;
498 features->y_fuzz = 4;
499 features->pressure_fuzz = 0;
500 features->distance_fuzz = 1;
501 features->tilt_fuzz = 1;
504 * The wireless device HID is basic and layout conflicts with
505 * other tablets (monitor and touch interface can look like pen).
506 * Skip the query for this type and modify defaults based on
509 if (features->type == WIRELESS && intf) {
510 if (intf->cur_altsetting->desc.bInterfaceNumber == 0)
511 features->device_type = WACOM_DEVICETYPE_WL_MONITOR;
513 features->device_type = WACOM_DEVICETYPE_NONE;
517 wacom_parse_hid(hdev, features);
520 struct wacom_hdev_data {
521 struct list_head list;
523 struct hid_device *dev;
524 struct wacom_shared shared;
527 static LIST_HEAD(wacom_udev_list);
528 static DEFINE_MUTEX(wacom_udev_list_lock);
530 static bool compare_device_paths(struct hid_device *hdev_a,
531 struct hid_device *hdev_b, char separator)
533 int n1 = strrchr(hdev_a->phys, separator) - hdev_a->phys;
534 int n2 = strrchr(hdev_b->phys, separator) - hdev_b->phys;
536 if (n1 != n2 || n1 <= 0 || n2 <= 0)
539 return !strncmp(hdev_a->phys, hdev_b->phys, n1);
542 static bool wacom_are_sibling(struct hid_device *hdev,
543 struct hid_device *sibling)
545 struct wacom *wacom = hid_get_drvdata(hdev);
546 struct wacom_features *features = &wacom->wacom_wac.features;
547 struct wacom *sibling_wacom = hid_get_drvdata(sibling);
548 struct wacom_features *sibling_features = &sibling_wacom->wacom_wac.features;
549 __u32 oVid = features->oVid ? features->oVid : hdev->vendor;
550 __u32 oPid = features->oPid ? features->oPid : hdev->product;
552 /* The defined oVid/oPid must match that of the sibling */
553 if (features->oVid != HID_ANY_ID && sibling->vendor != oVid)
555 if (features->oPid != HID_ANY_ID && sibling->product != oPid)
559 * Devices with the same VID/PID must share the same physical
560 * device path, while those with different VID/PID must share
561 * the same physical parent device path.
563 if (hdev->vendor == sibling->vendor && hdev->product == sibling->product) {
564 if (!compare_device_paths(hdev, sibling, '/'))
567 if (!compare_device_paths(hdev, sibling, '.'))
571 /* Skip the remaining heuristics unless you are a HID_GENERIC device */
572 if (features->type != HID_GENERIC)
576 * Direct-input devices may not be siblings of indirect-input
579 if ((features->device_type & WACOM_DEVICETYPE_DIRECT) &&
580 !(sibling_features->device_type & WACOM_DEVICETYPE_DIRECT))
584 * Indirect-input devices may not be siblings of direct-input
587 if (!(features->device_type & WACOM_DEVICETYPE_DIRECT) &&
588 (sibling_features->device_type & WACOM_DEVICETYPE_DIRECT))
591 /* Pen devices may only be siblings of touch devices */
592 if ((features->device_type & WACOM_DEVICETYPE_PEN) &&
593 !(sibling_features->device_type & WACOM_DEVICETYPE_TOUCH))
596 /* Touch devices may only be siblings of pen devices */
597 if ((features->device_type & WACOM_DEVICETYPE_TOUCH) &&
598 !(sibling_features->device_type & WACOM_DEVICETYPE_PEN))
602 * No reason could be found for these two devices to NOT be
603 * siblings, so there's a good chance they ARE siblings
608 static struct wacom_hdev_data *wacom_get_hdev_data(struct hid_device *hdev)
610 struct wacom_hdev_data *data;
612 /* Try to find an already-probed interface from the same device */
613 list_for_each_entry(data, &wacom_udev_list, list) {
614 if (compare_device_paths(hdev, data->dev, '/')) {
615 kref_get(&data->kref);
620 /* Fallback to finding devices that appear to be "siblings" */
621 list_for_each_entry(data, &wacom_udev_list, list) {
622 if (wacom_are_sibling(hdev, data->dev)) {
623 kref_get(&data->kref);
631 static void wacom_release_shared_data(struct kref *kref)
633 struct wacom_hdev_data *data =
634 container_of(kref, struct wacom_hdev_data, kref);
636 mutex_lock(&wacom_udev_list_lock);
637 list_del(&data->list);
638 mutex_unlock(&wacom_udev_list_lock);
643 static void wacom_remove_shared_data(void *res)
645 struct wacom *wacom = res;
646 struct wacom_hdev_data *data;
647 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
649 if (wacom_wac->shared) {
650 data = container_of(wacom_wac->shared, struct wacom_hdev_data,
653 if (wacom_wac->shared->touch == wacom->hdev)
654 wacom_wac->shared->touch = NULL;
655 else if (wacom_wac->shared->pen == wacom->hdev)
656 wacom_wac->shared->pen = NULL;
658 kref_put(&data->kref, wacom_release_shared_data);
659 wacom_wac->shared = NULL;
663 static int wacom_add_shared_data(struct hid_device *hdev)
665 struct wacom *wacom = hid_get_drvdata(hdev);
666 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
667 struct wacom_hdev_data *data;
670 mutex_lock(&wacom_udev_list_lock);
672 data = wacom_get_hdev_data(hdev);
674 data = kzalloc(sizeof(struct wacom_hdev_data), GFP_KERNEL);
680 kref_init(&data->kref);
682 list_add_tail(&data->list, &wacom_udev_list);
685 wacom_wac->shared = &data->shared;
687 retval = devm_add_action(&hdev->dev, wacom_remove_shared_data, wacom);
689 mutex_unlock(&wacom_udev_list_lock);
690 wacom_remove_shared_data(wacom);
694 if (wacom_wac->features.device_type & WACOM_DEVICETYPE_TOUCH)
695 wacom_wac->shared->touch = hdev;
696 else if (wacom_wac->features.device_type & WACOM_DEVICETYPE_PEN)
697 wacom_wac->shared->pen = hdev;
700 mutex_unlock(&wacom_udev_list_lock);
704 static int wacom_led_control(struct wacom *wacom)
708 unsigned char report_id = WAC_CMD_LED_CONTROL;
711 if (!hid_get_drvdata(wacom->hdev))
714 if (!wacom->led.groups)
717 if (wacom->wacom_wac.features.type == REMOTE)
720 if (wacom->wacom_wac.pid) { /* wireless connected */
721 report_id = WAC_CMD_WL_LED_CONTROL;
724 buf = kzalloc(buf_size, GFP_KERNEL);
728 if (wacom->wacom_wac.features.type >= INTUOS5S &&
729 wacom->wacom_wac.features.type <= INTUOSPL) {
731 * Touch Ring and crop mark LED luminance may take on
732 * one of four values:
733 * 0 = Low; 1 = Medium; 2 = High; 3 = Off
735 int ring_led = wacom->led.groups[0].select & 0x03;
736 int ring_lum = (((wacom->led.llv & 0x60) >> 5) - 1) & 0x03;
738 unsigned char led_bits = (crop_lum << 4) | (ring_lum << 2) | (ring_led);
741 if (wacom->wacom_wac.pid) {
742 wacom_get_report(wacom->hdev, HID_FEATURE_REPORT,
743 buf, buf_size, WAC_CMD_RETRIES);
750 int led = wacom->led.groups[0].select | 0x4;
752 if (wacom->wacom_wac.features.type == WACOM_21UX2 ||
753 wacom->wacom_wac.features.type == WACOM_24HD)
754 led |= (wacom->led.groups[1].select << 4) | 0x40;
758 buf[2] = wacom->led.llv;
759 buf[3] = wacom->led.hlv;
760 buf[4] = wacom->led.img_lum;
763 retval = wacom_set_report(wacom->hdev, HID_FEATURE_REPORT, buf, buf_size,
770 static int wacom_led_putimage(struct wacom *wacom, int button_id, u8 xfer_id,
771 const unsigned len, const void *img)
775 const unsigned chunk_len = len / 4; /* 4 chunks are needed to be sent */
777 buf = kzalloc(chunk_len + 3 , GFP_KERNEL);
781 /* Send 'start' command */
782 buf[0] = WAC_CMD_ICON_START;
784 retval = wacom_set_report(wacom->hdev, HID_FEATURE_REPORT, buf, 2,
790 buf[1] = button_id & 0x07;
791 for (i = 0; i < 4; i++) {
793 memcpy(buf + 3, img + i * chunk_len, chunk_len);
795 retval = wacom_set_report(wacom->hdev, HID_FEATURE_REPORT,
796 buf, chunk_len + 3, WAC_CMD_RETRIES);
802 buf[0] = WAC_CMD_ICON_START;
804 wacom_set_report(wacom->hdev, HID_FEATURE_REPORT, buf, 2,
812 static ssize_t wacom_led_select_store(struct device *dev, int set_id,
813 const char *buf, size_t count)
815 struct hid_device *hdev = to_hid_device(dev);
816 struct wacom *wacom = hid_get_drvdata(hdev);
820 err = kstrtouint(buf, 10, &id);
824 mutex_lock(&wacom->lock);
826 wacom->led.groups[set_id].select = id & 0x3;
827 err = wacom_led_control(wacom);
829 mutex_unlock(&wacom->lock);
831 return err < 0 ? err : count;
834 #define DEVICE_LED_SELECT_ATTR(SET_ID) \
835 static ssize_t wacom_led##SET_ID##_select_store(struct device *dev, \
836 struct device_attribute *attr, const char *buf, size_t count) \
838 return wacom_led_select_store(dev, SET_ID, buf, count); \
840 static ssize_t wacom_led##SET_ID##_select_show(struct device *dev, \
841 struct device_attribute *attr, char *buf) \
843 struct hid_device *hdev = to_hid_device(dev);\
844 struct wacom *wacom = hid_get_drvdata(hdev); \
845 return scnprintf(buf, PAGE_SIZE, "%d\n", \
846 wacom->led.groups[SET_ID].select); \
848 static DEVICE_ATTR(status_led##SET_ID##_select, DEV_ATTR_RW_PERM, \
849 wacom_led##SET_ID##_select_show, \
850 wacom_led##SET_ID##_select_store)
852 DEVICE_LED_SELECT_ATTR(0);
853 DEVICE_LED_SELECT_ATTR(1);
855 static ssize_t wacom_luminance_store(struct wacom *wacom, u8 *dest,
856 const char *buf, size_t count)
861 err = kstrtouint(buf, 10, &value);
865 mutex_lock(&wacom->lock);
867 *dest = value & 0x7f;
868 err = wacom_led_control(wacom);
870 mutex_unlock(&wacom->lock);
872 return err < 0 ? err : count;
875 #define DEVICE_LUMINANCE_ATTR(name, field) \
876 static ssize_t wacom_##name##_luminance_store(struct device *dev, \
877 struct device_attribute *attr, const char *buf, size_t count) \
879 struct hid_device *hdev = to_hid_device(dev);\
880 struct wacom *wacom = hid_get_drvdata(hdev); \
882 return wacom_luminance_store(wacom, &wacom->led.field, \
885 static ssize_t wacom_##name##_luminance_show(struct device *dev, \
886 struct device_attribute *attr, char *buf) \
888 struct wacom *wacom = dev_get_drvdata(dev); \
889 return scnprintf(buf, PAGE_SIZE, "%d\n", wacom->led.field); \
891 static DEVICE_ATTR(name##_luminance, DEV_ATTR_RW_PERM, \
892 wacom_##name##_luminance_show, \
893 wacom_##name##_luminance_store)
895 DEVICE_LUMINANCE_ATTR(status0, llv);
896 DEVICE_LUMINANCE_ATTR(status1, hlv);
897 DEVICE_LUMINANCE_ATTR(buttons, img_lum);
899 static ssize_t wacom_button_image_store(struct device *dev, int button_id,
900 const char *buf, size_t count)
902 struct hid_device *hdev = to_hid_device(dev);
903 struct wacom *wacom = hid_get_drvdata(hdev);
908 if (hdev->bus == BUS_BLUETOOTH) {
910 xfer_id = WAC_CMD_ICON_BT_XFER;
913 xfer_id = WAC_CMD_ICON_XFER;
919 mutex_lock(&wacom->lock);
921 err = wacom_led_putimage(wacom, button_id, xfer_id, len, buf);
923 mutex_unlock(&wacom->lock);
925 return err < 0 ? err : count;
928 #define DEVICE_BTNIMG_ATTR(BUTTON_ID) \
929 static ssize_t wacom_btnimg##BUTTON_ID##_store(struct device *dev, \
930 struct device_attribute *attr, const char *buf, size_t count) \
932 return wacom_button_image_store(dev, BUTTON_ID, buf, count); \
934 static DEVICE_ATTR(button##BUTTON_ID##_rawimg, DEV_ATTR_WO_PERM, \
935 NULL, wacom_btnimg##BUTTON_ID##_store)
937 DEVICE_BTNIMG_ATTR(0);
938 DEVICE_BTNIMG_ATTR(1);
939 DEVICE_BTNIMG_ATTR(2);
940 DEVICE_BTNIMG_ATTR(3);
941 DEVICE_BTNIMG_ATTR(4);
942 DEVICE_BTNIMG_ATTR(5);
943 DEVICE_BTNIMG_ATTR(6);
944 DEVICE_BTNIMG_ATTR(7);
946 static struct attribute *cintiq_led_attrs[] = {
947 &dev_attr_status_led0_select.attr,
948 &dev_attr_status_led1_select.attr,
952 static struct attribute_group cintiq_led_attr_group = {
954 .attrs = cintiq_led_attrs,
957 static struct attribute *intuos4_led_attrs[] = {
958 &dev_attr_status0_luminance.attr,
959 &dev_attr_status1_luminance.attr,
960 &dev_attr_status_led0_select.attr,
961 &dev_attr_buttons_luminance.attr,
962 &dev_attr_button0_rawimg.attr,
963 &dev_attr_button1_rawimg.attr,
964 &dev_attr_button2_rawimg.attr,
965 &dev_attr_button3_rawimg.attr,
966 &dev_attr_button4_rawimg.attr,
967 &dev_attr_button5_rawimg.attr,
968 &dev_attr_button6_rawimg.attr,
969 &dev_attr_button7_rawimg.attr,
973 static struct attribute_group intuos4_led_attr_group = {
975 .attrs = intuos4_led_attrs,
978 static struct attribute *intuos5_led_attrs[] = {
979 &dev_attr_status0_luminance.attr,
980 &dev_attr_status_led0_select.attr,
984 static struct attribute_group intuos5_led_attr_group = {
986 .attrs = intuos5_led_attrs,
989 struct wacom_sysfs_group_devres {
990 struct attribute_group *group;
991 struct kobject *root;
994 static void wacom_devm_sysfs_group_release(struct device *dev, void *res)
996 struct wacom_sysfs_group_devres *devres = res;
997 struct kobject *kobj = devres->root;
999 dev_dbg(dev, "%s: dropping reference to %s\n",
1000 __func__, devres->group->name);
1001 sysfs_remove_group(kobj, devres->group);
1004 static int __wacom_devm_sysfs_create_group(struct wacom *wacom,
1005 struct kobject *root,
1006 struct attribute_group *group)
1008 struct wacom_sysfs_group_devres *devres;
1011 devres = devres_alloc(wacom_devm_sysfs_group_release,
1012 sizeof(struct wacom_sysfs_group_devres),
1017 devres->group = group;
1018 devres->root = root;
1020 error = sysfs_create_group(devres->root, group);
1024 devres_add(&wacom->hdev->dev, devres);
1029 static int wacom_devm_sysfs_create_group(struct wacom *wacom,
1030 struct attribute_group *group)
1032 return __wacom_devm_sysfs_create_group(wacom, &wacom->hdev->dev.kobj,
1036 enum led_brightness wacom_leds_brightness_get(struct wacom_led *led)
1038 struct wacom *wacom = led->wacom;
1040 if (wacom->led.max_hlv)
1041 return led->hlv * LED_FULL / wacom->led.max_hlv;
1043 if (wacom->led.max_llv)
1044 return led->llv * LED_FULL / wacom->led.max_llv;
1046 /* device doesn't support brightness tuning */
1050 static enum led_brightness __wacom_led_brightness_get(struct led_classdev *cdev)
1052 struct wacom_led *led = container_of(cdev, struct wacom_led, cdev);
1053 struct wacom *wacom = led->wacom;
1055 if (wacom->led.groups[led->group].select != led->id)
1058 return wacom_leds_brightness_get(led);
1061 static int wacom_led_brightness_set(struct led_classdev *cdev,
1062 enum led_brightness brightness)
1064 struct wacom_led *led = container_of(cdev, struct wacom_led, cdev);
1065 struct wacom *wacom = led->wacom;
1068 mutex_lock(&wacom->lock);
1070 if (!wacom->led.groups || (brightness == LED_OFF &&
1071 wacom->led.groups[led->group].select != led->id)) {
1076 led->llv = wacom->led.llv = wacom->led.max_llv * brightness / LED_FULL;
1077 led->hlv = wacom->led.hlv = wacom->led.max_hlv * brightness / LED_FULL;
1079 wacom->led.groups[led->group].select = led->id;
1081 error = wacom_led_control(wacom);
1084 mutex_unlock(&wacom->lock);
1089 static void wacom_led_readonly_brightness_set(struct led_classdev *cdev,
1090 enum led_brightness brightness)
1094 static int wacom_led_register_one(struct device *dev, struct wacom *wacom,
1095 struct wacom_led *led, unsigned int group,
1096 unsigned int id, bool read_only)
1101 name = devm_kasprintf(dev, GFP_KERNEL,
1110 led->trigger.name = name;
1111 error = devm_led_trigger_register(dev, &led->trigger);
1113 hid_err(wacom->hdev,
1114 "failed to register LED trigger %s: %d\n",
1115 led->cdev.name, error);
1123 led->llv = wacom->led.llv;
1124 led->hlv = wacom->led.hlv;
1125 led->cdev.name = name;
1126 led->cdev.max_brightness = LED_FULL;
1127 led->cdev.flags = LED_HW_PLUGGABLE;
1128 led->cdev.brightness_get = __wacom_led_brightness_get;
1130 led->cdev.brightness_set_blocking = wacom_led_brightness_set;
1131 led->cdev.default_trigger = led->cdev.name;
1133 led->cdev.brightness_set = wacom_led_readonly_brightness_set;
1136 error = devm_led_classdev_register(dev, &led->cdev);
1138 hid_err(wacom->hdev,
1139 "failed to register LED %s: %d\n",
1140 led->cdev.name, error);
1141 led->cdev.name = NULL;
1148 static void wacom_led_groups_release_one(void *data)
1150 struct wacom_group_leds *group = data;
1152 devres_release_group(group->dev, group);
1155 static int wacom_led_groups_alloc_and_register_one(struct device *dev,
1156 struct wacom *wacom,
1157 int group_id, int count,
1160 struct wacom_led *leds;
1163 if (group_id >= wacom->led.count || count <= 0)
1166 if (!devres_open_group(dev, &wacom->led.groups[group_id], GFP_KERNEL))
1169 leds = devm_kzalloc(dev, sizeof(struct wacom_led) * count, GFP_KERNEL);
1175 wacom->led.groups[group_id].leds = leds;
1176 wacom->led.groups[group_id].count = count;
1178 for (i = 0; i < count; i++) {
1179 error = wacom_led_register_one(dev, wacom, &leds[i],
1180 group_id, i, read_only);
1185 wacom->led.groups[group_id].dev = dev;
1187 devres_close_group(dev, &wacom->led.groups[group_id]);
1190 * There is a bug (?) in devm_led_classdev_register() in which its
1191 * increments the refcount of the parent. If the parent is an input
1192 * device, that means the ref count never reaches 0 when
1193 * devm_input_device_release() gets called.
1194 * This means that the LEDs are still there after disconnect.
1195 * Manually force the release of the group so that the leds are released
1196 * once we are done using them.
1198 error = devm_add_action_or_reset(&wacom->hdev->dev,
1199 wacom_led_groups_release_one,
1200 &wacom->led.groups[group_id]);
1207 devres_release_group(dev, &wacom->led.groups[group_id]);
1211 struct wacom_led *wacom_led_find(struct wacom *wacom, unsigned int group_id,
1214 struct wacom_group_leds *group;
1216 if (group_id >= wacom->led.count)
1219 group = &wacom->led.groups[group_id];
1226 return &group->leds[id];
1230 * wacom_led_next: gives the next available led with a wacom trigger.
1232 * returns the next available struct wacom_led which has its default trigger
1233 * or the current one if none is available.
1235 struct wacom_led *wacom_led_next(struct wacom *wacom, struct wacom_led *cur)
1237 struct wacom_led *next_led;
1247 next_led = wacom_led_find(wacom, group, ++next);
1248 if (!next_led || next_led == cur)
1250 } while (next_led->cdev.trigger != &next_led->trigger);
1255 static void wacom_led_groups_release(void *data)
1257 struct wacom *wacom = data;
1259 wacom->led.groups = NULL;
1260 wacom->led.count = 0;
1263 static int wacom_led_groups_allocate(struct wacom *wacom, int count)
1265 struct device *dev = &wacom->hdev->dev;
1266 struct wacom_group_leds *groups;
1269 groups = devm_kzalloc(dev, sizeof(struct wacom_group_leds) * count,
1274 error = devm_add_action_or_reset(dev, wacom_led_groups_release, wacom);
1278 wacom->led.groups = groups;
1279 wacom->led.count = count;
1284 static int wacom_leds_alloc_and_register(struct wacom *wacom, int group_count,
1285 int led_per_group, bool read_only)
1290 if (!wacom->wacom_wac.pad_input)
1293 dev = &wacom->wacom_wac.pad_input->dev;
1295 error = wacom_led_groups_allocate(wacom, group_count);
1299 for (i = 0; i < group_count; i++) {
1300 error = wacom_led_groups_alloc_and_register_one(dev, wacom, i,
1310 static int wacom_initialize_leds(struct wacom *wacom)
1314 if (!(wacom->wacom_wac.features.device_type & WACOM_DEVICETYPE_PAD))
1317 /* Initialize default values */
1318 switch (wacom->wacom_wac.features.type) {
1323 wacom->led.llv = 10;
1324 wacom->led.hlv = 20;
1325 wacom->led.max_llv = 127;
1326 wacom->led.max_hlv = 127;
1327 wacom->led.img_lum = 10;
1329 error = wacom_leds_alloc_and_register(wacom, 1, 4, false);
1331 hid_err(wacom->hdev,
1332 "cannot create leds err: %d\n", error);
1336 error = wacom_devm_sysfs_create_group(wacom,
1337 &intuos4_led_attr_group);
1344 wacom->led.img_lum = 0;
1346 error = wacom_leds_alloc_and_register(wacom, 2, 4, false);
1348 hid_err(wacom->hdev,
1349 "cannot create leds err: %d\n", error);
1353 error = wacom_devm_sysfs_create_group(wacom,
1354 &cintiq_led_attr_group);
1363 wacom->led.llv = 32;
1364 wacom->led.max_llv = 96;
1366 error = wacom_leds_alloc_and_register(wacom, 1, 4, false);
1368 hid_err(wacom->hdev,
1369 "cannot create leds err: %d\n", error);
1373 error = wacom_devm_sysfs_create_group(wacom,
1374 &intuos5_led_attr_group);
1378 wacom->led.llv = 255;
1379 wacom->led.max_llv = 255;
1380 error = wacom_led_groups_allocate(wacom, 5);
1382 hid_err(wacom->hdev,
1383 "cannot create leds err: %d\n", error);
1393 hid_err(wacom->hdev,
1394 "cannot create sysfs group err: %d\n", error);
1397 wacom_led_control(wacom);
1402 static enum power_supply_property wacom_battery_props[] = {
1403 POWER_SUPPLY_PROP_MODEL_NAME,
1404 POWER_SUPPLY_PROP_PRESENT,
1405 POWER_SUPPLY_PROP_STATUS,
1406 POWER_SUPPLY_PROP_SCOPE,
1407 POWER_SUPPLY_PROP_CAPACITY
1410 static int wacom_battery_get_property(struct power_supply *psy,
1411 enum power_supply_property psp,
1412 union power_supply_propval *val)
1414 struct wacom_battery *battery = power_supply_get_drvdata(psy);
1418 case POWER_SUPPLY_PROP_MODEL_NAME:
1419 val->strval = battery->wacom->wacom_wac.name;
1421 case POWER_SUPPLY_PROP_PRESENT:
1422 val->intval = battery->bat_connected;
1424 case POWER_SUPPLY_PROP_SCOPE:
1425 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
1427 case POWER_SUPPLY_PROP_CAPACITY:
1428 val->intval = battery->battery_capacity;
1430 case POWER_SUPPLY_PROP_STATUS:
1431 if (battery->bat_charging)
1432 val->intval = POWER_SUPPLY_STATUS_CHARGING;
1433 else if (battery->battery_capacity == 100 &&
1434 battery->ps_connected)
1435 val->intval = POWER_SUPPLY_STATUS_FULL;
1436 else if (battery->ps_connected)
1437 val->intval = POWER_SUPPLY_STATUS_NOT_CHARGING;
1439 val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
1449 static int __wacom_initialize_battery(struct wacom *wacom,
1450 struct wacom_battery *battery)
1452 static atomic_t battery_no = ATOMIC_INIT(0);
1453 struct device *dev = &wacom->hdev->dev;
1454 struct power_supply_config psy_cfg = { .drv_data = battery, };
1455 struct power_supply *ps_bat;
1456 struct power_supply_desc *bat_desc = &battery->bat_desc;
1460 if (!devres_open_group(dev, bat_desc, GFP_KERNEL))
1463 battery->wacom = wacom;
1465 n = atomic_inc_return(&battery_no) - 1;
1467 bat_desc->properties = wacom_battery_props;
1468 bat_desc->num_properties = ARRAY_SIZE(wacom_battery_props);
1469 bat_desc->get_property = wacom_battery_get_property;
1470 sprintf(battery->bat_name, "wacom_battery_%ld", n);
1471 bat_desc->name = battery->bat_name;
1472 bat_desc->type = POWER_SUPPLY_TYPE_USB;
1473 bat_desc->use_for_apm = 0;
1475 ps_bat = devm_power_supply_register(dev, bat_desc, &psy_cfg);
1476 if (IS_ERR(ps_bat)) {
1477 error = PTR_ERR(ps_bat);
1481 power_supply_powers(ps_bat, &wacom->hdev->dev);
1483 battery->battery = ps_bat;
1485 devres_close_group(dev, bat_desc);
1489 devres_release_group(dev, bat_desc);
1493 static int wacom_initialize_battery(struct wacom *wacom)
1495 if (wacom->wacom_wac.features.quirks & WACOM_QUIRK_BATTERY)
1496 return __wacom_initialize_battery(wacom, &wacom->battery);
1501 static void wacom_destroy_battery(struct wacom *wacom)
1503 if (wacom->battery.battery) {
1504 devres_release_group(&wacom->hdev->dev,
1505 &wacom->battery.bat_desc);
1506 wacom->battery.battery = NULL;
1510 static ssize_t wacom_show_speed(struct device *dev,
1511 struct device_attribute
1514 struct hid_device *hdev = to_hid_device(dev);
1515 struct wacom *wacom = hid_get_drvdata(hdev);
1517 return snprintf(buf, PAGE_SIZE, "%i\n", wacom->wacom_wac.bt_high_speed);
1520 static ssize_t wacom_store_speed(struct device *dev,
1521 struct device_attribute *attr,
1522 const char *buf, size_t count)
1524 struct hid_device *hdev = to_hid_device(dev);
1525 struct wacom *wacom = hid_get_drvdata(hdev);
1528 if (kstrtou8(buf, 0, &new_speed))
1531 if (new_speed != 0 && new_speed != 1)
1534 wacom_bt_query_tablet_data(hdev, new_speed, &wacom->wacom_wac.features);
1539 static DEVICE_ATTR(speed, DEV_ATTR_RW_PERM,
1540 wacom_show_speed, wacom_store_speed);
1543 static ssize_t wacom_show_remote_mode(struct kobject *kobj,
1544 struct kobj_attribute *kattr,
1545 char *buf, int index)
1547 struct device *dev = kobj_to_dev(kobj->parent);
1548 struct hid_device *hdev = to_hid_device(dev);
1549 struct wacom *wacom = hid_get_drvdata(hdev);
1552 mode = wacom->led.groups[index].select;
1553 if (mode >= 0 && mode < 3)
1554 return snprintf(buf, PAGE_SIZE, "%d\n", mode);
1556 return snprintf(buf, PAGE_SIZE, "%d\n", -1);
1559 #define DEVICE_EKR_ATTR_GROUP(SET_ID) \
1560 static ssize_t wacom_show_remote##SET_ID##_mode(struct kobject *kobj, \
1561 struct kobj_attribute *kattr, char *buf) \
1563 return wacom_show_remote_mode(kobj, kattr, buf, SET_ID); \
1565 static struct kobj_attribute remote##SET_ID##_mode_attr = { \
1566 .attr = {.name = "remote_mode", \
1567 .mode = DEV_ATTR_RO_PERM}, \
1568 .show = wacom_show_remote##SET_ID##_mode, \
1570 static struct attribute *remote##SET_ID##_serial_attrs[] = { \
1571 &remote##SET_ID##_mode_attr.attr, \
1574 static struct attribute_group remote##SET_ID##_serial_group = { \
1576 .attrs = remote##SET_ID##_serial_attrs, \
1579 DEVICE_EKR_ATTR_GROUP(0);
1580 DEVICE_EKR_ATTR_GROUP(1);
1581 DEVICE_EKR_ATTR_GROUP(2);
1582 DEVICE_EKR_ATTR_GROUP(3);
1583 DEVICE_EKR_ATTR_GROUP(4);
1585 static int wacom_remote_create_attr_group(struct wacom *wacom, __u32 serial,
1589 struct wacom_remote *remote = wacom->remote;
1591 remote->remotes[index].group.name = devm_kasprintf(&wacom->hdev->dev,
1594 if (!remote->remotes[index].group.name)
1597 error = __wacom_devm_sysfs_create_group(wacom, remote->remote_dir,
1598 &remote->remotes[index].group);
1600 remote->remotes[index].group.name = NULL;
1601 hid_err(wacom->hdev,
1602 "cannot create sysfs group err: %d\n", error);
1609 static int wacom_cmd_unpair_remote(struct wacom *wacom, unsigned char selector)
1611 const size_t buf_size = 2;
1615 buf = kzalloc(buf_size, GFP_KERNEL);
1619 buf[0] = WAC_CMD_DELETE_PAIRING;
1622 retval = wacom_set_report(wacom->hdev, HID_OUTPUT_REPORT, buf,
1623 buf_size, WAC_CMD_RETRIES);
1629 static ssize_t wacom_store_unpair_remote(struct kobject *kobj,
1630 struct kobj_attribute *attr,
1631 const char *buf, size_t count)
1633 unsigned char selector = 0;
1634 struct device *dev = kobj_to_dev(kobj->parent);
1635 struct hid_device *hdev = to_hid_device(dev);
1636 struct wacom *wacom = hid_get_drvdata(hdev);
1639 if (!strncmp(buf, "*\n", 2)) {
1640 selector = WAC_CMD_UNPAIR_ALL;
1642 hid_info(wacom->hdev, "remote: unrecognized unpair code: %s\n",
1647 mutex_lock(&wacom->lock);
1649 err = wacom_cmd_unpair_remote(wacom, selector);
1650 mutex_unlock(&wacom->lock);
1652 return err < 0 ? err : count;
1655 static struct kobj_attribute unpair_remote_attr = {
1656 .attr = {.name = "unpair_remote", .mode = 0200},
1657 .store = wacom_store_unpair_remote,
1660 static const struct attribute *remote_unpair_attrs[] = {
1661 &unpair_remote_attr.attr,
1665 static void wacom_remotes_destroy(void *data)
1667 struct wacom *wacom = data;
1668 struct wacom_remote *remote = wacom->remote;
1673 kobject_put(remote->remote_dir);
1674 kfifo_free(&remote->remote_fifo);
1675 wacom->remote = NULL;
1678 static int wacom_initialize_remotes(struct wacom *wacom)
1681 struct wacom_remote *remote;
1684 if (wacom->wacom_wac.features.type != REMOTE)
1687 remote = devm_kzalloc(&wacom->hdev->dev, sizeof(*wacom->remote),
1692 wacom->remote = remote;
1694 spin_lock_init(&remote->remote_lock);
1696 error = kfifo_alloc(&remote->remote_fifo,
1697 5 * sizeof(struct wacom_remote_data),
1700 hid_err(wacom->hdev, "failed allocating remote_fifo\n");
1704 remote->remotes[0].group = remote0_serial_group;
1705 remote->remotes[1].group = remote1_serial_group;
1706 remote->remotes[2].group = remote2_serial_group;
1707 remote->remotes[3].group = remote3_serial_group;
1708 remote->remotes[4].group = remote4_serial_group;
1710 remote->remote_dir = kobject_create_and_add("wacom_remote",
1711 &wacom->hdev->dev.kobj);
1712 if (!remote->remote_dir)
1715 error = sysfs_create_files(remote->remote_dir, remote_unpair_attrs);
1718 hid_err(wacom->hdev,
1719 "cannot create sysfs group err: %d\n", error);
1723 for (i = 0; i < WACOM_MAX_REMOTES; i++) {
1724 wacom->led.groups[i].select = WACOM_STATUS_UNKNOWN;
1725 remote->remotes[i].serial = 0;
1728 error = devm_add_action_or_reset(&wacom->hdev->dev,
1729 wacom_remotes_destroy, wacom);
1736 static struct input_dev *wacom_allocate_input(struct wacom *wacom)
1738 struct input_dev *input_dev;
1739 struct hid_device *hdev = wacom->hdev;
1740 struct wacom_wac *wacom_wac = &(wacom->wacom_wac);
1742 input_dev = devm_input_allocate_device(&hdev->dev);
1746 input_dev->name = wacom_wac->features.name;
1747 input_dev->phys = hdev->phys;
1748 input_dev->dev.parent = &hdev->dev;
1749 input_dev->open = wacom_open;
1750 input_dev->close = wacom_close;
1751 input_dev->uniq = hdev->uniq;
1752 input_dev->id.bustype = hdev->bus;
1753 input_dev->id.vendor = hdev->vendor;
1754 input_dev->id.product = wacom_wac->pid ? wacom_wac->pid : hdev->product;
1755 input_dev->id.version = hdev->version;
1756 input_set_drvdata(input_dev, wacom);
1761 static int wacom_allocate_inputs(struct wacom *wacom)
1763 struct wacom_wac *wacom_wac = &(wacom->wacom_wac);
1765 wacom_wac->pen_input = wacom_allocate_input(wacom);
1766 wacom_wac->touch_input = wacom_allocate_input(wacom);
1767 wacom_wac->pad_input = wacom_allocate_input(wacom);
1768 if (!wacom_wac->pen_input ||
1769 !wacom_wac->touch_input ||
1770 !wacom_wac->pad_input)
1773 wacom_wac->pen_input->name = wacom_wac->pen_name;
1774 wacom_wac->touch_input->name = wacom_wac->touch_name;
1775 wacom_wac->pad_input->name = wacom_wac->pad_name;
1780 static int wacom_register_inputs(struct wacom *wacom)
1782 struct input_dev *pen_input_dev, *touch_input_dev, *pad_input_dev;
1783 struct wacom_wac *wacom_wac = &(wacom->wacom_wac);
1786 pen_input_dev = wacom_wac->pen_input;
1787 touch_input_dev = wacom_wac->touch_input;
1788 pad_input_dev = wacom_wac->pad_input;
1790 if (!pen_input_dev || !touch_input_dev || !pad_input_dev)
1793 error = wacom_setup_pen_input_capabilities(pen_input_dev, wacom_wac);
1795 /* no pen in use on this interface */
1796 input_free_device(pen_input_dev);
1797 wacom_wac->pen_input = NULL;
1798 pen_input_dev = NULL;
1800 error = input_register_device(pen_input_dev);
1805 error = wacom_setup_touch_input_capabilities(touch_input_dev, wacom_wac);
1807 /* no touch in use on this interface */
1808 input_free_device(touch_input_dev);
1809 wacom_wac->touch_input = NULL;
1810 touch_input_dev = NULL;
1812 error = input_register_device(touch_input_dev);
1817 error = wacom_setup_pad_input_capabilities(pad_input_dev, wacom_wac);
1819 /* no pad in use on this interface */
1820 input_free_device(pad_input_dev);
1821 wacom_wac->pad_input = NULL;
1822 pad_input_dev = NULL;
1824 error = input_register_device(pad_input_dev);
1832 wacom_wac->pad_input = NULL;
1833 wacom_wac->touch_input = NULL;
1834 wacom_wac->pen_input = NULL;
1839 * Not all devices report physical dimensions from HID.
1840 * Compute the default from hardcoded logical dimension
1841 * and resolution before driver overwrites them.
1843 static void wacom_set_default_phy(struct wacom_features *features)
1845 if (features->x_resolution) {
1846 features->x_phy = (features->x_max * 100) /
1847 features->x_resolution;
1848 features->y_phy = (features->y_max * 100) /
1849 features->y_resolution;
1853 static void wacom_calculate_res(struct wacom_features *features)
1855 /* set unit to "100th of a mm" for devices not reported by HID */
1856 if (!features->unit) {
1857 features->unit = 0x11;
1858 features->unitExpo = -3;
1861 features->x_resolution = wacom_calc_hid_res(features->x_max,
1864 features->unitExpo);
1865 features->y_resolution = wacom_calc_hid_res(features->y_max,
1868 features->unitExpo);
1871 void wacom_battery_work(struct work_struct *work)
1873 struct wacom *wacom = container_of(work, struct wacom, battery_work);
1875 if ((wacom->wacom_wac.features.quirks & WACOM_QUIRK_BATTERY) &&
1876 !wacom->battery.battery) {
1877 wacom_initialize_battery(wacom);
1879 else if (!(wacom->wacom_wac.features.quirks & WACOM_QUIRK_BATTERY) &&
1880 wacom->battery.battery) {
1881 wacom_destroy_battery(wacom);
1885 static size_t wacom_compute_pktlen(struct hid_device *hdev)
1887 struct hid_report_enum *report_enum;
1888 struct hid_report *report;
1891 report_enum = hdev->report_enum + HID_INPUT_REPORT;
1893 list_for_each_entry(report, &report_enum->report_list, list) {
1894 size_t report_size = hid_report_len(report);
1895 if (report_size > size)
1902 static void wacom_update_name(struct wacom *wacom, const char *suffix)
1904 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
1905 struct wacom_features *features = &wacom_wac->features;
1906 char name[WACOM_NAME_MAX];
1908 /* Generic devices name unspecified */
1909 if ((features->type == HID_GENERIC) && !strcmp("Wacom HID", features->name)) {
1910 if (strstr(wacom->hdev->name, "Wacom") ||
1911 strstr(wacom->hdev->name, "wacom") ||
1912 strstr(wacom->hdev->name, "WACOM")) {
1913 /* name is in HID descriptor, use it */
1914 strlcpy(name, wacom->hdev->name, sizeof(name));
1916 /* strip out excess whitespaces */
1918 char *gap = strstr(name, " ");
1921 /* shift everything including the terminator */
1922 memmove(gap, gap+1, strlen(gap));
1924 /* get rid of trailing whitespace */
1925 if (name[strlen(name)-1] == ' ')
1926 name[strlen(name)-1] = '\0';
1928 /* no meaningful name retrieved. use product ID */
1929 snprintf(name, sizeof(name),
1930 "%s %X", features->name, wacom->hdev->product);
1933 strlcpy(name, features->name, sizeof(name));
1936 snprintf(wacom_wac->name, sizeof(wacom_wac->name), "%s%s",
1939 /* Append the device type to the name */
1940 snprintf(wacom_wac->pen_name, sizeof(wacom_wac->pen_name),
1941 "%s%s Pen", name, suffix);
1942 snprintf(wacom_wac->touch_name, sizeof(wacom_wac->touch_name),
1943 "%s%s Finger", name, suffix);
1944 snprintf(wacom_wac->pad_name, sizeof(wacom_wac->pad_name),
1945 "%s%s Pad", name, suffix);
1948 static void wacom_release_resources(struct wacom *wacom)
1950 struct hid_device *hdev = wacom->hdev;
1952 if (!wacom->resources)
1955 devres_release_group(&hdev->dev, wacom);
1957 wacom->resources = false;
1959 wacom->wacom_wac.pen_input = NULL;
1960 wacom->wacom_wac.touch_input = NULL;
1961 wacom->wacom_wac.pad_input = NULL;
1964 static int wacom_parse_and_register(struct wacom *wacom, bool wireless)
1966 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
1967 struct wacom_features *features = &wacom_wac->features;
1968 struct hid_device *hdev = wacom->hdev;
1970 unsigned int connect_mask = HID_CONNECT_HIDRAW;
1972 features->pktlen = wacom_compute_pktlen(hdev);
1973 if (features->pktlen > WACOM_PKGLEN_MAX)
1976 if (!devres_open_group(&hdev->dev, wacom, GFP_KERNEL))
1979 wacom->resources = true;
1981 error = wacom_allocate_inputs(wacom);
1986 * Bamboo Pad has a generic hid handling for the Pen, and we switch it
1987 * into debug mode for the touch part.
1988 * We ignore the other interfaces.
1990 if (features->type == BAMBOO_PAD) {
1991 if (features->pktlen == WACOM_PKGLEN_PENABLED) {
1992 features->type = HID_GENERIC;
1993 } else if ((features->pktlen != WACOM_PKGLEN_BPAD_TOUCH) &&
1994 (features->pktlen != WACOM_PKGLEN_BPAD_TOUCH_USB)) {
2000 /* set the default size in case we do not get them from hid */
2001 wacom_set_default_phy(features);
2003 /* Retrieve the physical and logical size for touch devices */
2004 wacom_retrieve_hid_descriptor(hdev, features);
2005 wacom_setup_device_quirks(wacom);
2007 if (features->device_type == WACOM_DEVICETYPE_NONE &&
2008 features->type != WIRELESS) {
2009 error = features->type == HID_GENERIC ? -ENODEV : 0;
2011 dev_warn(&hdev->dev, "Unknown device_type for '%s'. %s.",
2013 error ? "Ignoring" : "Assuming pen");
2018 features->device_type |= WACOM_DEVICETYPE_PEN;
2021 wacom_calculate_res(features);
2023 wacom_update_name(wacom, wireless ? " (WL)" : "");
2025 /* pen only Bamboo neither support touch nor pad */
2026 if ((features->type == BAMBOO_PEN) &&
2027 ((features->device_type & WACOM_DEVICETYPE_TOUCH) ||
2028 (features->device_type & WACOM_DEVICETYPE_PAD))) {
2033 error = wacom_add_shared_data(hdev);
2037 if (!(features->device_type & WACOM_DEVICETYPE_WL_MONITOR) &&
2038 (features->quirks & WACOM_QUIRK_BATTERY)) {
2039 error = wacom_initialize_battery(wacom);
2044 error = wacom_register_inputs(wacom);
2048 if (wacom->wacom_wac.features.device_type & WACOM_DEVICETYPE_PAD) {
2049 error = wacom_initialize_leds(wacom);
2053 error = wacom_initialize_remotes(wacom);
2058 if (features->type == HID_GENERIC)
2059 connect_mask |= HID_CONNECT_DRIVER;
2061 /* Regular HID work starts now */
2062 error = hid_hw_start(hdev, connect_mask);
2064 hid_err(hdev, "hw start failed\n");
2069 /* Note that if query fails it is not a hard failure */
2070 wacom_query_tablet_data(hdev, features);
2073 /* touch only Bamboo doesn't support pen */
2074 if ((features->type == BAMBOO_TOUCH) &&
2075 (features->device_type & WACOM_DEVICETYPE_PEN)) {
2080 if (features->device_type & WACOM_DEVICETYPE_WL_MONITOR)
2081 error = hid_hw_open(hdev);
2083 if ((wacom_wac->features.type == INTUOSHT ||
2084 wacom_wac->features.type == INTUOSHT2) &&
2085 (wacom_wac->features.device_type & WACOM_DEVICETYPE_TOUCH)) {
2086 wacom_wac->shared->type = wacom_wac->features.type;
2087 wacom_wac->shared->touch_input = wacom_wac->touch_input;
2090 devres_close_group(&hdev->dev, wacom);
2097 wacom_release_resources(wacom);
2101 static void wacom_wireless_work(struct work_struct *work)
2103 struct wacom *wacom = container_of(work, struct wacom, wireless_work);
2104 struct usb_device *usbdev = wacom->usbdev;
2105 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
2106 struct hid_device *hdev1, *hdev2;
2107 struct wacom *wacom1, *wacom2;
2108 struct wacom_wac *wacom_wac1, *wacom_wac2;
2112 * Regardless if this is a disconnect or a new tablet,
2113 * remove any existing input and battery devices.
2116 wacom_destroy_battery(wacom);
2121 /* Stylus interface */
2122 hdev1 = usb_get_intfdata(usbdev->config->interface[1]);
2123 wacom1 = hid_get_drvdata(hdev1);
2124 wacom_wac1 = &(wacom1->wacom_wac);
2125 wacom_release_resources(wacom1);
2127 /* Touch interface */
2128 hdev2 = usb_get_intfdata(usbdev->config->interface[2]);
2129 wacom2 = hid_get_drvdata(hdev2);
2130 wacom_wac2 = &(wacom2->wacom_wac);
2131 wacom_release_resources(wacom2);
2133 if (wacom_wac->pid == 0) {
2134 hid_info(wacom->hdev, "wireless tablet disconnected\n");
2136 const struct hid_device_id *id = wacom_ids;
2138 hid_info(wacom->hdev, "wireless tablet connected with PID %x\n",
2142 if (id->vendor == USB_VENDOR_ID_WACOM &&
2143 id->product == wacom_wac->pid)
2149 hid_info(wacom->hdev, "ignoring unknown PID.\n");
2153 /* Stylus interface */
2154 wacom_wac1->features =
2155 *((struct wacom_features *)id->driver_data);
2157 wacom_wac1->pid = wacom_wac->pid;
2159 error = wacom_parse_and_register(wacom1, true);
2163 /* Touch interface */
2164 if (wacom_wac1->features.touch_max ||
2165 (wacom_wac1->features.type >= INTUOSHT &&
2166 wacom_wac1->features.type <= BAMBOO_PT)) {
2167 wacom_wac2->features =
2168 *((struct wacom_features *)id->driver_data);
2169 wacom_wac2->pid = wacom_wac->pid;
2171 error = wacom_parse_and_register(wacom2, true);
2176 strlcpy(wacom_wac->name, wacom_wac1->name,
2177 sizeof(wacom_wac->name));
2178 error = wacom_initialize_battery(wacom);
2186 wacom_release_resources(wacom1);
2187 wacom_release_resources(wacom2);
2191 static void wacom_remote_destroy_one(struct wacom *wacom, unsigned int index)
2193 struct wacom_remote *remote = wacom->remote;
2194 u32 serial = remote->remotes[index].serial;
2196 unsigned long flags;
2198 for (i = 0; i < WACOM_MAX_REMOTES; i++) {
2199 if (remote->remotes[i].serial == serial) {
2201 spin_lock_irqsave(&remote->remote_lock, flags);
2202 remote->remotes[i].registered = false;
2203 spin_unlock_irqrestore(&remote->remote_lock, flags);
2205 if (remote->remotes[i].battery.battery)
2206 devres_release_group(&wacom->hdev->dev,
2207 &remote->remotes[i].battery.bat_desc);
2209 if (remote->remotes[i].group.name)
2210 devres_release_group(&wacom->hdev->dev,
2211 &remote->remotes[i]);
2213 remote->remotes[i].serial = 0;
2214 remote->remotes[i].group.name = NULL;
2215 remote->remotes[i].battery.battery = NULL;
2216 wacom->led.groups[i].select = WACOM_STATUS_UNKNOWN;
2221 static int wacom_remote_create_one(struct wacom *wacom, u32 serial,
2224 struct wacom_remote *remote = wacom->remote;
2225 struct device *dev = &wacom->hdev->dev;
2228 /* A remote can pair more than once with an EKR,
2229 * check to make sure this serial isn't already paired.
2231 for (k = 0; k < WACOM_MAX_REMOTES; k++) {
2232 if (remote->remotes[k].serial == serial)
2236 if (k < WACOM_MAX_REMOTES) {
2237 remote->remotes[index].serial = serial;
2241 if (!devres_open_group(dev, &remote->remotes[index], GFP_KERNEL))
2244 error = wacom_remote_create_attr_group(wacom, serial, index);
2248 remote->remotes[index].input = wacom_allocate_input(wacom);
2249 if (!remote->remotes[index].input) {
2253 remote->remotes[index].input->uniq = remote->remotes[index].group.name;
2254 remote->remotes[index].input->name = wacom->wacom_wac.pad_name;
2256 if (!remote->remotes[index].input->name) {
2261 error = wacom_setup_pad_input_capabilities(remote->remotes[index].input,
2266 remote->remotes[index].serial = serial;
2268 error = input_register_device(remote->remotes[index].input);
2272 error = wacom_led_groups_alloc_and_register_one(
2273 &remote->remotes[index].input->dev,
2274 wacom, index, 3, true);
2278 remote->remotes[index].registered = true;
2280 devres_close_group(dev, &remote->remotes[index]);
2284 devres_release_group(dev, &remote->remotes[index]);
2285 remote->remotes[index].serial = 0;
2289 static int wacom_remote_attach_battery(struct wacom *wacom, int index)
2291 struct wacom_remote *remote = wacom->remote;
2294 if (!remote->remotes[index].registered)
2297 if (remote->remotes[index].battery.battery)
2300 if (wacom->led.groups[index].select == WACOM_STATUS_UNKNOWN)
2303 error = __wacom_initialize_battery(wacom,
2304 &wacom->remote->remotes[index].battery);
2311 static void wacom_remote_work(struct work_struct *work)
2313 struct wacom *wacom = container_of(work, struct wacom, remote_work);
2314 struct wacom_remote *remote = wacom->remote;
2315 struct wacom_remote_data data;
2316 unsigned long flags;
2321 spin_lock_irqsave(&remote->remote_lock, flags);
2323 count = kfifo_out(&remote->remote_fifo, &data, sizeof(data));
2325 if (count != sizeof(data)) {
2326 hid_err(wacom->hdev,
2327 "workitem triggered without status available\n");
2328 spin_unlock_irqrestore(&remote->remote_lock, flags);
2332 if (!kfifo_is_empty(&remote->remote_fifo))
2333 wacom_schedule_work(&wacom->wacom_wac, WACOM_WORKER_REMOTE);
2335 spin_unlock_irqrestore(&remote->remote_lock, flags);
2337 for (i = 0; i < WACOM_MAX_REMOTES; i++) {
2338 serial = data.remote[i].serial;
2339 if (data.remote[i].connected) {
2341 if (remote->remotes[i].serial == serial) {
2342 wacom_remote_attach_battery(wacom, i);
2346 if (remote->remotes[i].serial)
2347 wacom_remote_destroy_one(wacom, i);
2349 wacom_remote_create_one(wacom, serial, i);
2351 } else if (remote->remotes[i].serial) {
2352 wacom_remote_destroy_one(wacom, i);
2357 static int wacom_probe(struct hid_device *hdev,
2358 const struct hid_device_id *id)
2360 struct wacom *wacom;
2361 struct wacom_wac *wacom_wac;
2362 struct wacom_features *features;
2365 if (!id->driver_data)
2368 hdev->quirks |= HID_QUIRK_NO_INIT_REPORTS;
2370 /* hid-core sets this quirk for the boot interface */
2371 hdev->quirks &= ~HID_QUIRK_NOGET;
2373 wacom = devm_kzalloc(&hdev->dev, sizeof(struct wacom), GFP_KERNEL);
2377 hid_set_drvdata(hdev, wacom);
2380 wacom_wac = &wacom->wacom_wac;
2381 wacom_wac->features = *((struct wacom_features *)id->driver_data);
2382 features = &wacom_wac->features;
2384 if (features->check_for_hid_type && features->hid_type != hdev->type) {
2389 wacom_wac->hid_data.inputmode = -1;
2390 wacom_wac->mode_report = -1;
2392 if (hid_is_usb(hdev)) {
2393 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
2394 struct usb_device *dev = interface_to_usbdev(intf);
2396 wacom->usbdev = dev;
2400 mutex_init(&wacom->lock);
2401 INIT_WORK(&wacom->wireless_work, wacom_wireless_work);
2402 INIT_WORK(&wacom->battery_work, wacom_battery_work);
2403 INIT_WORK(&wacom->remote_work, wacom_remote_work);
2405 /* ask for the report descriptor to be loaded by HID */
2406 error = hid_parse(hdev);
2408 hid_err(hdev, "parse failed\n");
2412 error = wacom_parse_and_register(wacom, false);
2416 if (hdev->bus == BUS_BLUETOOTH) {
2417 error = device_create_file(&hdev->dev, &dev_attr_speed);
2420 "can't create sysfs speed attribute err: %d\n",
2427 hid_set_drvdata(hdev, NULL);
2431 static void wacom_remove(struct hid_device *hdev)
2433 struct wacom *wacom = hid_get_drvdata(hdev);
2434 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
2435 struct wacom_features *features = &wacom_wac->features;
2437 if (features->device_type & WACOM_DEVICETYPE_WL_MONITOR)
2442 cancel_work_sync(&wacom->wireless_work);
2443 cancel_work_sync(&wacom->battery_work);
2444 cancel_work_sync(&wacom->remote_work);
2445 if (hdev->bus == BUS_BLUETOOTH)
2446 device_remove_file(&hdev->dev, &dev_attr_speed);
2448 wacom_release_resources(wacom);
2450 hid_set_drvdata(hdev, NULL);
2454 static int wacom_resume(struct hid_device *hdev)
2456 struct wacom *wacom = hid_get_drvdata(hdev);
2457 struct wacom_features *features = &wacom->wacom_wac.features;
2459 mutex_lock(&wacom->lock);
2461 /* switch to wacom mode first */
2462 wacom_query_tablet_data(hdev, features);
2463 wacom_led_control(wacom);
2465 mutex_unlock(&wacom->lock);
2470 static int wacom_reset_resume(struct hid_device *hdev)
2472 return wacom_resume(hdev);
2474 #endif /* CONFIG_PM */
2476 static struct hid_driver wacom_driver = {
2478 .id_table = wacom_ids,
2479 .probe = wacom_probe,
2480 .remove = wacom_remove,
2481 .report = wacom_wac_report,
2483 .resume = wacom_resume,
2484 .reset_resume = wacom_reset_resume,
2486 .raw_event = wacom_raw_event,
2488 module_hid_driver(wacom_driver);
2490 MODULE_VERSION(DRIVER_VERSION);
2491 MODULE_AUTHOR(DRIVER_AUTHOR);
2492 MODULE_DESCRIPTION(DRIVER_DESC);
2493 MODULE_LICENSE(DRIVER_LICENSE);