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) {
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 wacom_are_sibling(struct hid_device *hdev,
531 struct hid_device *sibling)
533 struct wacom *wacom = hid_get_drvdata(hdev);
534 struct wacom_features *features = &wacom->wacom_wac.features;
535 int vid = features->oVid;
536 int pid = features->oPid;
539 if (vid == 0 && pid == 0) {
544 if (vid != sibling->vendor || pid != sibling->product)
547 /* Compare the physical path. */
548 n1 = strrchr(hdev->phys, '.') - hdev->phys;
549 n2 = strrchr(sibling->phys, '.') - sibling->phys;
550 if (n1 != n2 || n1 <= 0 || n2 <= 0)
553 return !strncmp(hdev->phys, sibling->phys, n1);
556 static struct wacom_hdev_data *wacom_get_hdev_data(struct hid_device *hdev)
558 struct wacom_hdev_data *data;
560 list_for_each_entry(data, &wacom_udev_list, list) {
561 if (wacom_are_sibling(hdev, data->dev)) {
562 kref_get(&data->kref);
570 static void wacom_release_shared_data(struct kref *kref)
572 struct wacom_hdev_data *data =
573 container_of(kref, struct wacom_hdev_data, kref);
575 mutex_lock(&wacom_udev_list_lock);
576 list_del(&data->list);
577 mutex_unlock(&wacom_udev_list_lock);
582 static void wacom_remove_shared_data(void *res)
584 struct wacom *wacom = res;
585 struct wacom_hdev_data *data;
586 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
588 if (wacom_wac->shared) {
589 data = container_of(wacom_wac->shared, struct wacom_hdev_data,
592 if (wacom_wac->shared->touch == wacom->hdev)
593 wacom_wac->shared->touch = NULL;
594 else if (wacom_wac->shared->pen == wacom->hdev)
595 wacom_wac->shared->pen = NULL;
597 kref_put(&data->kref, wacom_release_shared_data);
598 wacom_wac->shared = NULL;
602 static int wacom_add_shared_data(struct hid_device *hdev)
604 struct wacom *wacom = hid_get_drvdata(hdev);
605 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
606 struct wacom_hdev_data *data;
609 mutex_lock(&wacom_udev_list_lock);
611 data = wacom_get_hdev_data(hdev);
613 data = kzalloc(sizeof(struct wacom_hdev_data), GFP_KERNEL);
619 kref_init(&data->kref);
621 list_add_tail(&data->list, &wacom_udev_list);
624 wacom_wac->shared = &data->shared;
626 retval = devm_add_action(&hdev->dev, wacom_remove_shared_data, wacom);
628 mutex_unlock(&wacom_udev_list_lock);
629 wacom_remove_shared_data(wacom);
633 if (wacom_wac->features.device_type & WACOM_DEVICETYPE_TOUCH)
634 wacom_wac->shared->touch = hdev;
635 else if (wacom_wac->features.device_type & WACOM_DEVICETYPE_PEN)
636 wacom_wac->shared->pen = hdev;
639 mutex_unlock(&wacom_udev_list_lock);
643 static int wacom_led_control(struct wacom *wacom)
647 unsigned char report_id = WAC_CMD_LED_CONTROL;
650 if (!hid_get_drvdata(wacom->hdev))
653 if (!wacom->led.groups)
656 if (wacom->wacom_wac.pid) { /* wireless connected */
657 report_id = WAC_CMD_WL_LED_CONTROL;
660 buf = kzalloc(buf_size, GFP_KERNEL);
664 if (wacom->wacom_wac.features.type >= INTUOS5S &&
665 wacom->wacom_wac.features.type <= INTUOSPL) {
667 * Touch Ring and crop mark LED luminance may take on
668 * one of four values:
669 * 0 = Low; 1 = Medium; 2 = High; 3 = Off
671 int ring_led = wacom->led.groups[0].select & 0x03;
672 int ring_lum = (((wacom->led.llv & 0x60) >> 5) - 1) & 0x03;
674 unsigned char led_bits = (crop_lum << 4) | (ring_lum << 2) | (ring_led);
677 if (wacom->wacom_wac.pid) {
678 wacom_get_report(wacom->hdev, HID_FEATURE_REPORT,
679 buf, buf_size, WAC_CMD_RETRIES);
686 int led = wacom->led.groups[0].select | 0x4;
688 if (wacom->wacom_wac.features.type == WACOM_21UX2 ||
689 wacom->wacom_wac.features.type == WACOM_24HD)
690 led |= (wacom->led.groups[1].select << 4) | 0x40;
694 buf[2] = wacom->led.llv;
695 buf[3] = wacom->led.hlv;
696 buf[4] = wacom->led.img_lum;
699 retval = wacom_set_report(wacom->hdev, HID_FEATURE_REPORT, buf, buf_size,
706 static int wacom_led_putimage(struct wacom *wacom, int button_id, u8 xfer_id,
707 const unsigned len, const void *img)
711 const unsigned chunk_len = len / 4; /* 4 chunks are needed to be sent */
713 buf = kzalloc(chunk_len + 3 , GFP_KERNEL);
717 /* Send 'start' command */
718 buf[0] = WAC_CMD_ICON_START;
720 retval = wacom_set_report(wacom->hdev, HID_FEATURE_REPORT, buf, 2,
726 buf[1] = button_id & 0x07;
727 for (i = 0; i < 4; i++) {
729 memcpy(buf + 3, img + i * chunk_len, chunk_len);
731 retval = wacom_set_report(wacom->hdev, HID_FEATURE_REPORT,
732 buf, chunk_len + 3, WAC_CMD_RETRIES);
738 buf[0] = WAC_CMD_ICON_START;
740 wacom_set_report(wacom->hdev, HID_FEATURE_REPORT, buf, 2,
748 static ssize_t wacom_led_select_store(struct device *dev, int set_id,
749 const char *buf, size_t count)
751 struct hid_device *hdev = to_hid_device(dev);
752 struct wacom *wacom = hid_get_drvdata(hdev);
756 err = kstrtouint(buf, 10, &id);
760 mutex_lock(&wacom->lock);
762 wacom->led.groups[set_id].select = id & 0x3;
763 err = wacom_led_control(wacom);
765 mutex_unlock(&wacom->lock);
767 return err < 0 ? err : count;
770 #define DEVICE_LED_SELECT_ATTR(SET_ID) \
771 static ssize_t wacom_led##SET_ID##_select_store(struct device *dev, \
772 struct device_attribute *attr, const char *buf, size_t count) \
774 return wacom_led_select_store(dev, SET_ID, buf, count); \
776 static ssize_t wacom_led##SET_ID##_select_show(struct device *dev, \
777 struct device_attribute *attr, char *buf) \
779 struct hid_device *hdev = to_hid_device(dev);\
780 struct wacom *wacom = hid_get_drvdata(hdev); \
781 return scnprintf(buf, PAGE_SIZE, "%d\n", \
782 wacom->led.groups[SET_ID].select); \
784 static DEVICE_ATTR(status_led##SET_ID##_select, DEV_ATTR_RW_PERM, \
785 wacom_led##SET_ID##_select_show, \
786 wacom_led##SET_ID##_select_store)
788 DEVICE_LED_SELECT_ATTR(0);
789 DEVICE_LED_SELECT_ATTR(1);
791 static ssize_t wacom_luminance_store(struct wacom *wacom, u8 *dest,
792 const char *buf, size_t count)
797 err = kstrtouint(buf, 10, &value);
801 mutex_lock(&wacom->lock);
803 *dest = value & 0x7f;
804 err = wacom_led_control(wacom);
806 mutex_unlock(&wacom->lock);
808 return err < 0 ? err : count;
811 #define DEVICE_LUMINANCE_ATTR(name, field) \
812 static ssize_t wacom_##name##_luminance_store(struct device *dev, \
813 struct device_attribute *attr, const char *buf, size_t count) \
815 struct hid_device *hdev = to_hid_device(dev);\
816 struct wacom *wacom = hid_get_drvdata(hdev); \
818 return wacom_luminance_store(wacom, &wacom->led.field, \
821 static ssize_t wacom_##name##_luminance_show(struct device *dev, \
822 struct device_attribute *attr, char *buf) \
824 struct wacom *wacom = dev_get_drvdata(dev); \
825 return scnprintf(buf, PAGE_SIZE, "%d\n", wacom->led.field); \
827 static DEVICE_ATTR(name##_luminance, DEV_ATTR_RW_PERM, \
828 wacom_##name##_luminance_show, \
829 wacom_##name##_luminance_store)
831 DEVICE_LUMINANCE_ATTR(status0, llv);
832 DEVICE_LUMINANCE_ATTR(status1, hlv);
833 DEVICE_LUMINANCE_ATTR(buttons, img_lum);
835 static ssize_t wacom_button_image_store(struct device *dev, int button_id,
836 const char *buf, size_t count)
838 struct hid_device *hdev = to_hid_device(dev);
839 struct wacom *wacom = hid_get_drvdata(hdev);
844 if (hdev->bus == BUS_BLUETOOTH) {
846 xfer_id = WAC_CMD_ICON_BT_XFER;
849 xfer_id = WAC_CMD_ICON_XFER;
855 mutex_lock(&wacom->lock);
857 err = wacom_led_putimage(wacom, button_id, xfer_id, len, buf);
859 mutex_unlock(&wacom->lock);
861 return err < 0 ? err : count;
864 #define DEVICE_BTNIMG_ATTR(BUTTON_ID) \
865 static ssize_t wacom_btnimg##BUTTON_ID##_store(struct device *dev, \
866 struct device_attribute *attr, const char *buf, size_t count) \
868 return wacom_button_image_store(dev, BUTTON_ID, buf, count); \
870 static DEVICE_ATTR(button##BUTTON_ID##_rawimg, DEV_ATTR_WO_PERM, \
871 NULL, wacom_btnimg##BUTTON_ID##_store)
873 DEVICE_BTNIMG_ATTR(0);
874 DEVICE_BTNIMG_ATTR(1);
875 DEVICE_BTNIMG_ATTR(2);
876 DEVICE_BTNIMG_ATTR(3);
877 DEVICE_BTNIMG_ATTR(4);
878 DEVICE_BTNIMG_ATTR(5);
879 DEVICE_BTNIMG_ATTR(6);
880 DEVICE_BTNIMG_ATTR(7);
882 static struct attribute *cintiq_led_attrs[] = {
883 &dev_attr_status_led0_select.attr,
884 &dev_attr_status_led1_select.attr,
888 static struct attribute_group cintiq_led_attr_group = {
890 .attrs = cintiq_led_attrs,
893 static struct attribute *intuos4_led_attrs[] = {
894 &dev_attr_status0_luminance.attr,
895 &dev_attr_status1_luminance.attr,
896 &dev_attr_status_led0_select.attr,
897 &dev_attr_buttons_luminance.attr,
898 &dev_attr_button0_rawimg.attr,
899 &dev_attr_button1_rawimg.attr,
900 &dev_attr_button2_rawimg.attr,
901 &dev_attr_button3_rawimg.attr,
902 &dev_attr_button4_rawimg.attr,
903 &dev_attr_button5_rawimg.attr,
904 &dev_attr_button6_rawimg.attr,
905 &dev_attr_button7_rawimg.attr,
909 static struct attribute_group intuos4_led_attr_group = {
911 .attrs = intuos4_led_attrs,
914 static struct attribute *intuos5_led_attrs[] = {
915 &dev_attr_status0_luminance.attr,
916 &dev_attr_status_led0_select.attr,
920 static struct attribute_group intuos5_led_attr_group = {
922 .attrs = intuos5_led_attrs,
925 struct wacom_sysfs_group_devres {
926 struct attribute_group *group;
927 struct kobject *root;
930 static void wacom_devm_sysfs_group_release(struct device *dev, void *res)
932 struct wacom_sysfs_group_devres *devres = res;
933 struct kobject *kobj = devres->root;
935 dev_dbg(dev, "%s: dropping reference to %s\n",
936 __func__, devres->group->name);
937 sysfs_remove_group(kobj, devres->group);
940 static int __wacom_devm_sysfs_create_group(struct wacom *wacom,
941 struct kobject *root,
942 struct attribute_group *group)
944 struct wacom_sysfs_group_devres *devres;
947 devres = devres_alloc(wacom_devm_sysfs_group_release,
948 sizeof(struct wacom_sysfs_group_devres),
953 devres->group = group;
956 error = sysfs_create_group(devres->root, group);
960 devres_add(&wacom->hdev->dev, devres);
965 static int wacom_devm_sysfs_create_group(struct wacom *wacom,
966 struct attribute_group *group)
968 return __wacom_devm_sysfs_create_group(wacom, &wacom->hdev->dev.kobj,
972 enum led_brightness wacom_leds_brightness_get(struct wacom_led *led)
974 struct wacom *wacom = led->wacom;
976 if (wacom->led.max_hlv)
977 return led->hlv * LED_FULL / wacom->led.max_hlv;
979 if (wacom->led.max_llv)
980 return led->llv * LED_FULL / wacom->led.max_llv;
982 /* device doesn't support brightness tuning */
986 static enum led_brightness __wacom_led_brightness_get(struct led_classdev *cdev)
988 struct wacom_led *led = container_of(cdev, struct wacom_led, cdev);
989 struct wacom *wacom = led->wacom;
991 if (wacom->led.groups[led->group].select != led->id)
994 return wacom_leds_brightness_get(led);
997 static int wacom_led_brightness_set(struct led_classdev *cdev,
998 enum led_brightness brightness)
1000 struct wacom_led *led = container_of(cdev, struct wacom_led, cdev);
1001 struct wacom *wacom = led->wacom;
1004 mutex_lock(&wacom->lock);
1006 if (!wacom->led.groups || (brightness == LED_OFF &&
1007 wacom->led.groups[led->group].select != led->id)) {
1012 led->llv = wacom->led.llv = wacom->led.max_llv * brightness / LED_FULL;
1013 led->hlv = wacom->led.hlv = wacom->led.max_hlv * brightness / LED_FULL;
1015 wacom->led.groups[led->group].select = led->id;
1017 error = wacom_led_control(wacom);
1020 mutex_unlock(&wacom->lock);
1025 static void wacom_led_readonly_brightness_set(struct led_classdev *cdev,
1026 enum led_brightness brightness)
1030 static int wacom_led_register_one(struct device *dev, struct wacom *wacom,
1031 struct wacom_led *led, unsigned int group,
1032 unsigned int id, bool read_only)
1037 name = devm_kasprintf(dev, GFP_KERNEL,
1046 led->trigger.name = name;
1047 error = devm_led_trigger_register(dev, &led->trigger);
1049 hid_err(wacom->hdev,
1050 "failed to register LED trigger %s: %d\n",
1051 led->cdev.name, error);
1059 led->llv = wacom->led.llv;
1060 led->hlv = wacom->led.hlv;
1061 led->cdev.name = name;
1062 led->cdev.max_brightness = LED_FULL;
1063 led->cdev.flags = LED_HW_PLUGGABLE;
1064 led->cdev.brightness_get = __wacom_led_brightness_get;
1066 led->cdev.brightness_set_blocking = wacom_led_brightness_set;
1067 led->cdev.default_trigger = led->cdev.name;
1069 led->cdev.brightness_set = wacom_led_readonly_brightness_set;
1072 error = devm_led_classdev_register(dev, &led->cdev);
1074 hid_err(wacom->hdev,
1075 "failed to register LED %s: %d\n",
1076 led->cdev.name, error);
1077 led->cdev.name = NULL;
1084 static void wacom_led_groups_release_one(void *data)
1086 struct wacom_group_leds *group = data;
1088 devres_release_group(group->dev, group);
1091 static int wacom_led_groups_alloc_and_register_one(struct device *dev,
1092 struct wacom *wacom,
1093 int group_id, int count,
1096 struct wacom_led *leds;
1099 if (group_id >= wacom->led.count || count <= 0)
1102 if (!devres_open_group(dev, &wacom->led.groups[group_id], GFP_KERNEL))
1105 leds = devm_kzalloc(dev, sizeof(struct wacom_led) * count, GFP_KERNEL);
1111 wacom->led.groups[group_id].leds = leds;
1112 wacom->led.groups[group_id].count = count;
1114 for (i = 0; i < count; i++) {
1115 error = wacom_led_register_one(dev, wacom, &leds[i],
1116 group_id, i, read_only);
1121 wacom->led.groups[group_id].dev = dev;
1123 devres_close_group(dev, &wacom->led.groups[group_id]);
1126 * There is a bug (?) in devm_led_classdev_register() in which its
1127 * increments the refcount of the parent. If the parent is an input
1128 * device, that means the ref count never reaches 0 when
1129 * devm_input_device_release() gets called.
1130 * This means that the LEDs are still there after disconnect.
1131 * Manually force the release of the group so that the leds are released
1132 * once we are done using them.
1134 error = devm_add_action_or_reset(&wacom->hdev->dev,
1135 wacom_led_groups_release_one,
1136 &wacom->led.groups[group_id]);
1143 devres_release_group(dev, &wacom->led.groups[group_id]);
1147 struct wacom_led *wacom_led_find(struct wacom *wacom, unsigned int group_id,
1150 struct wacom_group_leds *group;
1152 if (group_id >= wacom->led.count)
1155 group = &wacom->led.groups[group_id];
1162 return &group->leds[id];
1166 * wacom_led_next: gives the next available led with a wacom trigger.
1168 * returns the next available struct wacom_led which has its default trigger
1169 * or the current one if none is available.
1171 struct wacom_led *wacom_led_next(struct wacom *wacom, struct wacom_led *cur)
1173 struct wacom_led *next_led;
1183 next_led = wacom_led_find(wacom, group, ++next);
1184 if (!next_led || next_led == cur)
1186 } while (next_led->cdev.trigger != &next_led->trigger);
1191 static void wacom_led_groups_release(void *data)
1193 struct wacom *wacom = data;
1195 wacom->led.groups = NULL;
1196 wacom->led.count = 0;
1199 static int wacom_led_groups_allocate(struct wacom *wacom, int count)
1201 struct device *dev = &wacom->hdev->dev;
1202 struct wacom_group_leds *groups;
1205 groups = devm_kzalloc(dev, sizeof(struct wacom_group_leds) * count,
1210 error = devm_add_action_or_reset(dev, wacom_led_groups_release, wacom);
1214 wacom->led.groups = groups;
1215 wacom->led.count = count;
1220 static int wacom_leds_alloc_and_register(struct wacom *wacom, int group_count,
1221 int led_per_group, bool read_only)
1226 if (!wacom->wacom_wac.pad_input)
1229 dev = &wacom->wacom_wac.pad_input->dev;
1231 error = wacom_led_groups_allocate(wacom, group_count);
1235 for (i = 0; i < group_count; i++) {
1236 error = wacom_led_groups_alloc_and_register_one(dev, wacom, i,
1246 static int wacom_initialize_leds(struct wacom *wacom)
1250 if (!(wacom->wacom_wac.features.device_type & WACOM_DEVICETYPE_PAD))
1253 /* Initialize default values */
1254 switch (wacom->wacom_wac.features.type) {
1259 wacom->led.llv = 10;
1260 wacom->led.hlv = 20;
1261 wacom->led.max_llv = 127;
1262 wacom->led.max_hlv = 127;
1263 wacom->led.img_lum = 10;
1265 error = wacom_leds_alloc_and_register(wacom, 1, 4, false);
1267 hid_err(wacom->hdev,
1268 "cannot create leds err: %d\n", error);
1272 error = wacom_devm_sysfs_create_group(wacom,
1273 &intuos4_led_attr_group);
1280 wacom->led.img_lum = 0;
1282 error = wacom_leds_alloc_and_register(wacom, 2, 4, false);
1284 hid_err(wacom->hdev,
1285 "cannot create leds err: %d\n", error);
1289 error = wacom_devm_sysfs_create_group(wacom,
1290 &cintiq_led_attr_group);
1299 wacom->led.llv = 32;
1300 wacom->led.max_llv = 96;
1302 error = wacom_leds_alloc_and_register(wacom, 1, 4, false);
1304 hid_err(wacom->hdev,
1305 "cannot create leds err: %d\n", error);
1309 error = wacom_devm_sysfs_create_group(wacom,
1310 &intuos5_led_attr_group);
1314 wacom->led.llv = 255;
1315 wacom->led.max_llv = 255;
1316 error = wacom_led_groups_allocate(wacom, 5);
1318 hid_err(wacom->hdev,
1319 "cannot create leds err: %d\n", error);
1329 hid_err(wacom->hdev,
1330 "cannot create sysfs group err: %d\n", error);
1333 wacom_led_control(wacom);
1338 static enum power_supply_property wacom_battery_props[] = {
1339 POWER_SUPPLY_PROP_PRESENT,
1340 POWER_SUPPLY_PROP_STATUS,
1341 POWER_SUPPLY_PROP_SCOPE,
1342 POWER_SUPPLY_PROP_CAPACITY
1345 static enum power_supply_property wacom_ac_props[] = {
1346 POWER_SUPPLY_PROP_PRESENT,
1347 POWER_SUPPLY_PROP_ONLINE,
1348 POWER_SUPPLY_PROP_SCOPE,
1351 static int wacom_battery_get_property(struct power_supply *psy,
1352 enum power_supply_property psp,
1353 union power_supply_propval *val)
1355 struct wacom_battery *battery = power_supply_get_drvdata(psy);
1359 case POWER_SUPPLY_PROP_PRESENT:
1360 val->intval = battery->bat_connected;
1362 case POWER_SUPPLY_PROP_SCOPE:
1363 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
1365 case POWER_SUPPLY_PROP_CAPACITY:
1366 val->intval = battery->battery_capacity;
1368 case POWER_SUPPLY_PROP_STATUS:
1369 if (battery->bat_charging)
1370 val->intval = POWER_SUPPLY_STATUS_CHARGING;
1371 else if (battery->battery_capacity == 100 &&
1372 battery->ps_connected)
1373 val->intval = POWER_SUPPLY_STATUS_FULL;
1374 else if (battery->ps_connected)
1375 val->intval = POWER_SUPPLY_STATUS_NOT_CHARGING;
1377 val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
1387 static int wacom_ac_get_property(struct power_supply *psy,
1388 enum power_supply_property psp,
1389 union power_supply_propval *val)
1391 struct wacom_battery *battery = power_supply_get_drvdata(psy);
1395 case POWER_SUPPLY_PROP_PRESENT:
1397 case POWER_SUPPLY_PROP_ONLINE:
1398 val->intval = battery->ps_connected;
1400 case POWER_SUPPLY_PROP_SCOPE:
1401 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
1410 static int __wacom_initialize_battery(struct wacom *wacom,
1411 struct wacom_battery *battery)
1413 static atomic_t battery_no = ATOMIC_INIT(0);
1414 struct device *dev = &wacom->hdev->dev;
1415 struct power_supply_config psy_cfg = { .drv_data = battery, };
1416 struct power_supply *ps_bat, *ps_ac;
1417 struct power_supply_desc *bat_desc = &battery->bat_desc;
1418 struct power_supply_desc *ac_desc = &battery->ac_desc;
1422 if (!devres_open_group(dev, bat_desc, GFP_KERNEL))
1425 n = atomic_inc_return(&battery_no) - 1;
1427 bat_desc->properties = wacom_battery_props;
1428 bat_desc->num_properties = ARRAY_SIZE(wacom_battery_props);
1429 bat_desc->get_property = wacom_battery_get_property;
1430 sprintf(battery->bat_name, "wacom_battery_%ld", n);
1431 bat_desc->name = battery->bat_name;
1432 bat_desc->type = POWER_SUPPLY_TYPE_BATTERY;
1433 bat_desc->use_for_apm = 0;
1435 ac_desc->properties = wacom_ac_props;
1436 ac_desc->num_properties = ARRAY_SIZE(wacom_ac_props);
1437 ac_desc->get_property = wacom_ac_get_property;
1438 sprintf(battery->ac_name, "wacom_ac_%ld", n);
1439 ac_desc->name = battery->ac_name;
1440 ac_desc->type = POWER_SUPPLY_TYPE_MAINS;
1441 ac_desc->use_for_apm = 0;
1443 ps_bat = devm_power_supply_register(dev, bat_desc, &psy_cfg);
1444 if (IS_ERR(ps_bat)) {
1445 error = PTR_ERR(ps_bat);
1449 ps_ac = devm_power_supply_register(dev, ac_desc, &psy_cfg);
1450 if (IS_ERR(ps_ac)) {
1451 error = PTR_ERR(ps_ac);
1455 power_supply_powers(ps_bat, &wacom->hdev->dev);
1456 power_supply_powers(ps_ac, &wacom->hdev->dev);
1458 battery->battery = ps_bat;
1459 battery->ac = ps_ac;
1461 devres_close_group(dev, bat_desc);
1465 devres_release_group(dev, bat_desc);
1469 static int wacom_initialize_battery(struct wacom *wacom)
1471 if (wacom->wacom_wac.features.quirks & WACOM_QUIRK_BATTERY)
1472 return __wacom_initialize_battery(wacom, &wacom->battery);
1477 static void wacom_destroy_battery(struct wacom *wacom)
1479 if (wacom->battery.battery) {
1480 devres_release_group(&wacom->hdev->dev,
1481 &wacom->battery.bat_desc);
1482 wacom->battery.battery = NULL;
1483 wacom->battery.ac = NULL;
1487 static ssize_t wacom_show_speed(struct device *dev,
1488 struct device_attribute
1491 struct hid_device *hdev = to_hid_device(dev);
1492 struct wacom *wacom = hid_get_drvdata(hdev);
1494 return snprintf(buf, PAGE_SIZE, "%i\n", wacom->wacom_wac.bt_high_speed);
1497 static ssize_t wacom_store_speed(struct device *dev,
1498 struct device_attribute *attr,
1499 const char *buf, size_t count)
1501 struct hid_device *hdev = to_hid_device(dev);
1502 struct wacom *wacom = hid_get_drvdata(hdev);
1505 if (kstrtou8(buf, 0, &new_speed))
1508 if (new_speed != 0 && new_speed != 1)
1511 wacom_bt_query_tablet_data(hdev, new_speed, &wacom->wacom_wac.features);
1516 static DEVICE_ATTR(speed, DEV_ATTR_RW_PERM,
1517 wacom_show_speed, wacom_store_speed);
1520 static ssize_t wacom_show_remote_mode(struct kobject *kobj,
1521 struct kobj_attribute *kattr,
1522 char *buf, int index)
1524 struct device *dev = kobj_to_dev(kobj->parent);
1525 struct hid_device *hdev = to_hid_device(dev);
1526 struct wacom *wacom = hid_get_drvdata(hdev);
1529 mode = wacom->led.groups[index].select;
1530 if (mode >= 0 && mode < 3)
1531 return snprintf(buf, PAGE_SIZE, "%d\n", mode);
1533 return snprintf(buf, PAGE_SIZE, "%d\n", -1);
1536 #define DEVICE_EKR_ATTR_GROUP(SET_ID) \
1537 static ssize_t wacom_show_remote##SET_ID##_mode(struct kobject *kobj, \
1538 struct kobj_attribute *kattr, char *buf) \
1540 return wacom_show_remote_mode(kobj, kattr, buf, SET_ID); \
1542 static struct kobj_attribute remote##SET_ID##_mode_attr = { \
1543 .attr = {.name = "remote_mode", \
1544 .mode = DEV_ATTR_RO_PERM}, \
1545 .show = wacom_show_remote##SET_ID##_mode, \
1547 static struct attribute *remote##SET_ID##_serial_attrs[] = { \
1548 &remote##SET_ID##_mode_attr.attr, \
1551 static struct attribute_group remote##SET_ID##_serial_group = { \
1553 .attrs = remote##SET_ID##_serial_attrs, \
1556 DEVICE_EKR_ATTR_GROUP(0);
1557 DEVICE_EKR_ATTR_GROUP(1);
1558 DEVICE_EKR_ATTR_GROUP(2);
1559 DEVICE_EKR_ATTR_GROUP(3);
1560 DEVICE_EKR_ATTR_GROUP(4);
1562 static int wacom_remote_create_attr_group(struct wacom *wacom, __u32 serial,
1566 struct wacom_remote *remote = wacom->remote;
1568 remote->remotes[index].group.name = devm_kasprintf(&wacom->hdev->dev,
1571 if (!remote->remotes[index].group.name)
1574 error = __wacom_devm_sysfs_create_group(wacom, remote->remote_dir,
1575 &remote->remotes[index].group);
1577 remote->remotes[index].group.name = NULL;
1578 hid_err(wacom->hdev,
1579 "cannot create sysfs group err: %d\n", error);
1586 static int wacom_cmd_unpair_remote(struct wacom *wacom, unsigned char selector)
1588 const size_t buf_size = 2;
1592 buf = kzalloc(buf_size, GFP_KERNEL);
1596 buf[0] = WAC_CMD_DELETE_PAIRING;
1599 retval = wacom_set_report(wacom->hdev, HID_OUTPUT_REPORT, buf,
1600 buf_size, WAC_CMD_RETRIES);
1606 static ssize_t wacom_store_unpair_remote(struct kobject *kobj,
1607 struct kobj_attribute *attr,
1608 const char *buf, size_t count)
1610 unsigned char selector = 0;
1611 struct device *dev = kobj_to_dev(kobj->parent);
1612 struct hid_device *hdev = to_hid_device(dev);
1613 struct wacom *wacom = hid_get_drvdata(hdev);
1616 if (!strncmp(buf, "*\n", 2)) {
1617 selector = WAC_CMD_UNPAIR_ALL;
1619 hid_info(wacom->hdev, "remote: unrecognized unpair code: %s\n",
1624 mutex_lock(&wacom->lock);
1626 err = wacom_cmd_unpair_remote(wacom, selector);
1627 mutex_unlock(&wacom->lock);
1629 return err < 0 ? err : count;
1632 static struct kobj_attribute unpair_remote_attr = {
1633 .attr = {.name = "unpair_remote", .mode = 0200},
1634 .store = wacom_store_unpair_remote,
1637 static const struct attribute *remote_unpair_attrs[] = {
1638 &unpair_remote_attr.attr,
1642 static void wacom_remotes_destroy(void *data)
1644 struct wacom *wacom = data;
1645 struct wacom_remote *remote = wacom->remote;
1650 kobject_put(remote->remote_dir);
1651 kfifo_free(&remote->remote_fifo);
1652 wacom->remote = NULL;
1655 static int wacom_initialize_remotes(struct wacom *wacom)
1658 struct wacom_remote *remote;
1661 if (wacom->wacom_wac.features.type != REMOTE)
1664 remote = devm_kzalloc(&wacom->hdev->dev, sizeof(*wacom->remote),
1669 wacom->remote = remote;
1671 spin_lock_init(&remote->remote_lock);
1673 error = kfifo_alloc(&remote->remote_fifo,
1674 5 * sizeof(struct wacom_remote_data),
1677 hid_err(wacom->hdev, "failed allocating remote_fifo\n");
1681 remote->remotes[0].group = remote0_serial_group;
1682 remote->remotes[1].group = remote1_serial_group;
1683 remote->remotes[2].group = remote2_serial_group;
1684 remote->remotes[3].group = remote3_serial_group;
1685 remote->remotes[4].group = remote4_serial_group;
1687 remote->remote_dir = kobject_create_and_add("wacom_remote",
1688 &wacom->hdev->dev.kobj);
1689 if (!remote->remote_dir)
1692 error = sysfs_create_files(remote->remote_dir, remote_unpair_attrs);
1695 hid_err(wacom->hdev,
1696 "cannot create sysfs group err: %d\n", error);
1700 for (i = 0; i < WACOM_MAX_REMOTES; i++) {
1701 wacom->led.groups[i].select = WACOM_STATUS_UNKNOWN;
1702 remote->remotes[i].serial = 0;
1705 error = devm_add_action_or_reset(&wacom->hdev->dev,
1706 wacom_remotes_destroy, wacom);
1713 static struct input_dev *wacom_allocate_input(struct wacom *wacom)
1715 struct input_dev *input_dev;
1716 struct hid_device *hdev = wacom->hdev;
1717 struct wacom_wac *wacom_wac = &(wacom->wacom_wac);
1719 input_dev = devm_input_allocate_device(&hdev->dev);
1723 input_dev->name = wacom_wac->features.name;
1724 input_dev->phys = hdev->phys;
1725 input_dev->dev.parent = &hdev->dev;
1726 input_dev->open = wacom_open;
1727 input_dev->close = wacom_close;
1728 input_dev->uniq = hdev->uniq;
1729 input_dev->id.bustype = hdev->bus;
1730 input_dev->id.vendor = hdev->vendor;
1731 input_dev->id.product = wacom_wac->pid ? wacom_wac->pid : hdev->product;
1732 input_dev->id.version = hdev->version;
1733 input_set_drvdata(input_dev, wacom);
1738 static int wacom_allocate_inputs(struct wacom *wacom)
1740 struct wacom_wac *wacom_wac = &(wacom->wacom_wac);
1742 wacom_wac->pen_input = wacom_allocate_input(wacom);
1743 wacom_wac->touch_input = wacom_allocate_input(wacom);
1744 wacom_wac->pad_input = wacom_allocate_input(wacom);
1745 if (!wacom_wac->pen_input ||
1746 !wacom_wac->touch_input ||
1747 !wacom_wac->pad_input)
1750 wacom_wac->pen_input->name = wacom_wac->pen_name;
1751 wacom_wac->touch_input->name = wacom_wac->touch_name;
1752 wacom_wac->pad_input->name = wacom_wac->pad_name;
1757 static int wacom_register_inputs(struct wacom *wacom)
1759 struct input_dev *pen_input_dev, *touch_input_dev, *pad_input_dev;
1760 struct wacom_wac *wacom_wac = &(wacom->wacom_wac);
1763 pen_input_dev = wacom_wac->pen_input;
1764 touch_input_dev = wacom_wac->touch_input;
1765 pad_input_dev = wacom_wac->pad_input;
1767 if (!pen_input_dev || !touch_input_dev || !pad_input_dev)
1770 error = wacom_setup_pen_input_capabilities(pen_input_dev, wacom_wac);
1772 /* no pen in use on this interface */
1773 input_free_device(pen_input_dev);
1774 wacom_wac->pen_input = NULL;
1775 pen_input_dev = NULL;
1777 error = input_register_device(pen_input_dev);
1782 error = wacom_setup_touch_input_capabilities(touch_input_dev, wacom_wac);
1784 /* no touch in use on this interface */
1785 input_free_device(touch_input_dev);
1786 wacom_wac->touch_input = NULL;
1787 touch_input_dev = NULL;
1789 error = input_register_device(touch_input_dev);
1794 error = wacom_setup_pad_input_capabilities(pad_input_dev, wacom_wac);
1796 /* no pad in use on this interface */
1797 input_free_device(pad_input_dev);
1798 wacom_wac->pad_input = NULL;
1799 pad_input_dev = NULL;
1801 error = input_register_device(pad_input_dev);
1809 wacom_wac->pad_input = NULL;
1810 wacom_wac->touch_input = NULL;
1811 wacom_wac->pen_input = NULL;
1816 * Not all devices report physical dimensions from HID.
1817 * Compute the default from hardcoded logical dimension
1818 * and resolution before driver overwrites them.
1820 static void wacom_set_default_phy(struct wacom_features *features)
1822 if (features->x_resolution) {
1823 features->x_phy = (features->x_max * 100) /
1824 features->x_resolution;
1825 features->y_phy = (features->y_max * 100) /
1826 features->y_resolution;
1830 static void wacom_calculate_res(struct wacom_features *features)
1832 /* set unit to "100th of a mm" for devices not reported by HID */
1833 if (!features->unit) {
1834 features->unit = 0x11;
1835 features->unitExpo = -3;
1838 features->x_resolution = wacom_calc_hid_res(features->x_max,
1841 features->unitExpo);
1842 features->y_resolution = wacom_calc_hid_res(features->y_max,
1845 features->unitExpo);
1848 void wacom_battery_work(struct work_struct *work)
1850 struct wacom *wacom = container_of(work, struct wacom, battery_work);
1852 if ((wacom->wacom_wac.features.quirks & WACOM_QUIRK_BATTERY) &&
1853 !wacom->battery.battery) {
1854 wacom_initialize_battery(wacom);
1856 else if (!(wacom->wacom_wac.features.quirks & WACOM_QUIRK_BATTERY) &&
1857 wacom->battery.battery) {
1858 wacom_destroy_battery(wacom);
1862 static size_t wacom_compute_pktlen(struct hid_device *hdev)
1864 struct hid_report_enum *report_enum;
1865 struct hid_report *report;
1868 report_enum = hdev->report_enum + HID_INPUT_REPORT;
1870 list_for_each_entry(report, &report_enum->report_list, list) {
1871 size_t report_size = hid_report_len(report);
1872 if (report_size > size)
1879 static void wacom_update_name(struct wacom *wacom, const char *suffix)
1881 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
1882 struct wacom_features *features = &wacom_wac->features;
1883 char name[WACOM_NAME_MAX];
1885 /* Generic devices name unspecified */
1886 if ((features->type == HID_GENERIC) && !strcmp("Wacom HID", features->name)) {
1887 if (strstr(wacom->hdev->name, "Wacom") ||
1888 strstr(wacom->hdev->name, "wacom") ||
1889 strstr(wacom->hdev->name, "WACOM")) {
1890 /* name is in HID descriptor, use it */
1891 strlcpy(name, wacom->hdev->name, sizeof(name));
1893 /* strip out excess whitespaces */
1895 char *gap = strstr(name, " ");
1898 /* shift everything including the terminator */
1899 memmove(gap, gap+1, strlen(gap));
1901 /* get rid of trailing whitespace */
1902 if (name[strlen(name)-1] == ' ')
1903 name[strlen(name)-1] = '\0';
1905 /* no meaningful name retrieved. use product ID */
1906 snprintf(name, sizeof(name),
1907 "%s %X", features->name, wacom->hdev->product);
1910 strlcpy(name, features->name, sizeof(name));
1913 /* Append the device type to the name */
1914 snprintf(wacom_wac->pen_name, sizeof(wacom_wac->pen_name),
1915 "%s%s Pen", name, suffix);
1916 snprintf(wacom_wac->touch_name, sizeof(wacom_wac->touch_name),
1917 "%s%s Finger", name, suffix);
1918 snprintf(wacom_wac->pad_name, sizeof(wacom_wac->pad_name),
1919 "%s%s Pad", name, suffix);
1922 static void wacom_release_resources(struct wacom *wacom)
1924 struct hid_device *hdev = wacom->hdev;
1926 if (!wacom->resources)
1929 devres_release_group(&hdev->dev, wacom);
1931 wacom->resources = false;
1933 wacom->wacom_wac.pen_input = NULL;
1934 wacom->wacom_wac.touch_input = NULL;
1935 wacom->wacom_wac.pad_input = NULL;
1938 static int wacom_parse_and_register(struct wacom *wacom, bool wireless)
1940 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
1941 struct wacom_features *features = &wacom_wac->features;
1942 struct hid_device *hdev = wacom->hdev;
1944 unsigned int connect_mask = HID_CONNECT_HIDRAW;
1946 features->pktlen = wacom_compute_pktlen(hdev);
1947 if (features->pktlen > WACOM_PKGLEN_MAX)
1950 if (!devres_open_group(&hdev->dev, wacom, GFP_KERNEL))
1953 wacom->resources = true;
1955 error = wacom_allocate_inputs(wacom);
1960 * Bamboo Pad has a generic hid handling for the Pen, and we switch it
1961 * into debug mode for the touch part.
1962 * We ignore the other interfaces.
1964 if (features->type == BAMBOO_PAD) {
1965 if (features->pktlen == WACOM_PKGLEN_PENABLED) {
1966 features->type = HID_GENERIC;
1967 } else if ((features->pktlen != WACOM_PKGLEN_BPAD_TOUCH) &&
1968 (features->pktlen != WACOM_PKGLEN_BPAD_TOUCH_USB)) {
1974 /* set the default size in case we do not get them from hid */
1975 wacom_set_default_phy(features);
1977 /* Retrieve the physical and logical size for touch devices */
1978 wacom_retrieve_hid_descriptor(hdev, features);
1979 wacom_setup_device_quirks(wacom);
1981 if (features->device_type == WACOM_DEVICETYPE_NONE &&
1982 features->type != WIRELESS) {
1983 error = features->type == HID_GENERIC ? -ENODEV : 0;
1985 dev_warn(&hdev->dev, "Unknown device_type for '%s'. %s.",
1987 error ? "Ignoring" : "Assuming pen");
1992 features->device_type |= WACOM_DEVICETYPE_PEN;
1995 wacom_calculate_res(features);
1997 wacom_update_name(wacom, wireless ? " (WL)" : "");
1999 error = wacom_add_shared_data(hdev);
2003 if (!(features->device_type & WACOM_DEVICETYPE_WL_MONITOR) &&
2004 (features->quirks & WACOM_QUIRK_BATTERY)) {
2005 error = wacom_initialize_battery(wacom);
2010 error = wacom_register_inputs(wacom);
2014 if (wacom->wacom_wac.features.device_type & WACOM_DEVICETYPE_PAD) {
2015 error = wacom_initialize_leds(wacom);
2019 error = wacom_initialize_remotes(wacom);
2024 if (features->type == HID_GENERIC)
2025 connect_mask |= HID_CONNECT_DRIVER;
2027 /* Regular HID work starts now */
2028 error = hid_hw_start(hdev, connect_mask);
2030 hid_err(hdev, "hw start failed\n");
2035 /* Note that if query fails it is not a hard failure */
2036 wacom_query_tablet_data(hdev, features);
2039 /* touch only Bamboo doesn't support pen */
2040 if ((features->type == BAMBOO_TOUCH) &&
2041 (features->device_type & WACOM_DEVICETYPE_PEN)) {
2046 /* pen only Bamboo neither support touch nor pad */
2047 if ((features->type == BAMBOO_PEN) &&
2048 ((features->device_type & WACOM_DEVICETYPE_TOUCH) ||
2049 (features->device_type & WACOM_DEVICETYPE_PAD))) {
2054 if (features->device_type & WACOM_DEVICETYPE_WL_MONITOR)
2055 error = hid_hw_open(hdev);
2057 if ((wacom_wac->features.type == INTUOSHT ||
2058 wacom_wac->features.type == INTUOSHT2) &&
2059 (wacom_wac->features.device_type & WACOM_DEVICETYPE_TOUCH)) {
2060 wacom_wac->shared->type = wacom_wac->features.type;
2061 wacom_wac->shared->touch_input = wacom_wac->touch_input;
2064 devres_close_group(&hdev->dev, wacom);
2071 wacom_release_resources(wacom);
2075 static void wacom_wireless_work(struct work_struct *work)
2077 struct wacom *wacom = container_of(work, struct wacom, wireless_work);
2078 struct usb_device *usbdev = wacom->usbdev;
2079 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
2080 struct hid_device *hdev1, *hdev2;
2081 struct wacom *wacom1, *wacom2;
2082 struct wacom_wac *wacom_wac1, *wacom_wac2;
2086 * Regardless if this is a disconnect or a new tablet,
2087 * remove any existing input and battery devices.
2090 wacom_destroy_battery(wacom);
2092 /* Stylus interface */
2093 hdev1 = usb_get_intfdata(usbdev->config->interface[1]);
2094 wacom1 = hid_get_drvdata(hdev1);
2095 wacom_wac1 = &(wacom1->wacom_wac);
2096 wacom_release_resources(wacom1);
2098 /* Touch interface */
2099 hdev2 = usb_get_intfdata(usbdev->config->interface[2]);
2100 wacom2 = hid_get_drvdata(hdev2);
2101 wacom_wac2 = &(wacom2->wacom_wac);
2102 wacom_release_resources(wacom2);
2104 if (wacom_wac->pid == 0) {
2105 hid_info(wacom->hdev, "wireless tablet disconnected\n");
2107 const struct hid_device_id *id = wacom_ids;
2109 hid_info(wacom->hdev, "wireless tablet connected with PID %x\n",
2113 if (id->vendor == USB_VENDOR_ID_WACOM &&
2114 id->product == wacom_wac->pid)
2120 hid_info(wacom->hdev, "ignoring unknown PID.\n");
2124 /* Stylus interface */
2125 wacom_wac1->features =
2126 *((struct wacom_features *)id->driver_data);
2128 wacom_wac1->pid = wacom_wac->pid;
2130 error = wacom_parse_and_register(wacom1, true);
2134 /* Touch interface */
2135 if (wacom_wac1->features.touch_max ||
2136 (wacom_wac1->features.type >= INTUOSHT &&
2137 wacom_wac1->features.type <= BAMBOO_PT)) {
2138 wacom_wac2->features =
2139 *((struct wacom_features *)id->driver_data);
2140 wacom_wac2->pid = wacom_wac->pid;
2142 error = wacom_parse_and_register(wacom2, true);
2147 error = wacom_initialize_battery(wacom);
2155 wacom_release_resources(wacom1);
2156 wacom_release_resources(wacom2);
2160 static void wacom_remote_destroy_one(struct wacom *wacom, unsigned int index)
2162 struct wacom_remote *remote = wacom->remote;
2163 u32 serial = remote->remotes[index].serial;
2165 unsigned long flags;
2167 spin_lock_irqsave(&remote->remote_lock, flags);
2168 remote->remotes[index].registered = false;
2169 spin_unlock_irqrestore(&remote->remote_lock, flags);
2171 if (remote->remotes[index].battery.battery)
2172 devres_release_group(&wacom->hdev->dev,
2173 &remote->remotes[index].battery.bat_desc);
2175 if (remote->remotes[index].group.name)
2176 devres_release_group(&wacom->hdev->dev,
2177 &remote->remotes[index]);
2179 for (i = 0; i < WACOM_MAX_REMOTES; i++) {
2180 if (remote->remotes[i].serial == serial) {
2181 remote->remotes[i].serial = 0;
2182 remote->remotes[i].group.name = NULL;
2183 remote->remotes[i].registered = false;
2184 remote->remotes[i].battery.battery = NULL;
2185 wacom->led.groups[i].select = WACOM_STATUS_UNKNOWN;
2190 static int wacom_remote_create_one(struct wacom *wacom, u32 serial,
2193 struct wacom_remote *remote = wacom->remote;
2194 struct device *dev = &wacom->hdev->dev;
2197 /* A remote can pair more than once with an EKR,
2198 * check to make sure this serial isn't already paired.
2200 for (k = 0; k < WACOM_MAX_REMOTES; k++) {
2201 if (remote->remotes[k].serial == serial)
2205 if (k < WACOM_MAX_REMOTES) {
2206 remote->remotes[index].serial = serial;
2210 if (!devres_open_group(dev, &remote->remotes[index], GFP_KERNEL))
2213 error = wacom_remote_create_attr_group(wacom, serial, index);
2217 remote->remotes[index].input = wacom_allocate_input(wacom);
2218 if (!remote->remotes[index].input) {
2222 remote->remotes[index].input->uniq = remote->remotes[index].group.name;
2223 remote->remotes[index].input->name = wacom->wacom_wac.pad_name;
2225 if (!remote->remotes[index].input->name) {
2230 error = wacom_setup_pad_input_capabilities(remote->remotes[index].input,
2235 remote->remotes[index].serial = serial;
2237 error = input_register_device(remote->remotes[index].input);
2241 error = wacom_led_groups_alloc_and_register_one(
2242 &remote->remotes[index].input->dev,
2243 wacom, index, 3, true);
2247 remote->remotes[index].registered = true;
2249 devres_close_group(dev, &remote->remotes[index]);
2253 devres_release_group(dev, &remote->remotes[index]);
2254 remote->remotes[index].serial = 0;
2258 static int wacom_remote_attach_battery(struct wacom *wacom, int index)
2260 struct wacom_remote *remote = wacom->remote;
2263 if (!remote->remotes[index].registered)
2266 if (remote->remotes[index].battery.battery)
2269 if (wacom->led.groups[index].select == WACOM_STATUS_UNKNOWN)
2272 error = __wacom_initialize_battery(wacom,
2273 &wacom->remote->remotes[index].battery);
2280 static void wacom_remote_work(struct work_struct *work)
2282 struct wacom *wacom = container_of(work, struct wacom, remote_work);
2283 struct wacom_remote *remote = wacom->remote;
2284 struct wacom_remote_data data;
2285 unsigned long flags;
2290 spin_lock_irqsave(&remote->remote_lock, flags);
2292 count = kfifo_out(&remote->remote_fifo, &data, sizeof(data));
2294 if (count != sizeof(data)) {
2295 hid_err(wacom->hdev,
2296 "workitem triggered without status available\n");
2297 spin_unlock_irqrestore(&remote->remote_lock, flags);
2301 if (!kfifo_is_empty(&remote->remote_fifo))
2302 wacom_schedule_work(&wacom->wacom_wac, WACOM_WORKER_REMOTE);
2304 spin_unlock_irqrestore(&remote->remote_lock, flags);
2306 for (i = 0; i < WACOM_MAX_REMOTES; i++) {
2307 serial = data.remote[i].serial;
2308 if (data.remote[i].connected) {
2310 if (remote->remotes[i].serial == serial) {
2311 wacom_remote_attach_battery(wacom, i);
2315 if (remote->remotes[i].serial)
2316 wacom_remote_destroy_one(wacom, i);
2318 wacom_remote_create_one(wacom, serial, i);
2320 } else if (remote->remotes[i].serial) {
2321 wacom_remote_destroy_one(wacom, i);
2326 static int wacom_probe(struct hid_device *hdev,
2327 const struct hid_device_id *id)
2329 struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
2330 struct usb_device *dev = interface_to_usbdev(intf);
2331 struct wacom *wacom;
2332 struct wacom_wac *wacom_wac;
2333 struct wacom_features *features;
2336 if (!id->driver_data)
2339 hdev->quirks |= HID_QUIRK_NO_INIT_REPORTS;
2341 /* hid-core sets this quirk for the boot interface */
2342 hdev->quirks &= ~HID_QUIRK_NOGET;
2344 wacom = devm_kzalloc(&hdev->dev, sizeof(struct wacom), GFP_KERNEL);
2348 hid_set_drvdata(hdev, wacom);
2351 wacom_wac = &wacom->wacom_wac;
2352 wacom_wac->features = *((struct wacom_features *)id->driver_data);
2353 features = &wacom_wac->features;
2355 if (features->check_for_hid_type && features->hid_type != hdev->type) {
2360 wacom_wac->hid_data.inputmode = -1;
2361 wacom_wac->mode_report = -1;
2363 wacom->usbdev = dev;
2365 mutex_init(&wacom->lock);
2366 INIT_WORK(&wacom->wireless_work, wacom_wireless_work);
2367 INIT_WORK(&wacom->battery_work, wacom_battery_work);
2368 INIT_WORK(&wacom->remote_work, wacom_remote_work);
2370 /* ask for the report descriptor to be loaded by HID */
2371 error = hid_parse(hdev);
2373 hid_err(hdev, "parse failed\n");
2377 error = wacom_parse_and_register(wacom, false);
2381 if (hdev->bus == BUS_BLUETOOTH) {
2382 error = device_create_file(&hdev->dev, &dev_attr_speed);
2385 "can't create sysfs speed attribute err: %d\n",
2392 hid_set_drvdata(hdev, NULL);
2396 static void wacom_remove(struct hid_device *hdev)
2398 struct wacom *wacom = hid_get_drvdata(hdev);
2399 struct wacom_wac *wacom_wac = &wacom->wacom_wac;
2400 struct wacom_features *features = &wacom_wac->features;
2402 if (features->device_type & WACOM_DEVICETYPE_WL_MONITOR)
2407 cancel_work_sync(&wacom->wireless_work);
2408 cancel_work_sync(&wacom->battery_work);
2409 cancel_work_sync(&wacom->remote_work);
2410 if (hdev->bus == BUS_BLUETOOTH)
2411 device_remove_file(&hdev->dev, &dev_attr_speed);
2413 hid_set_drvdata(hdev, NULL);
2417 static int wacom_resume(struct hid_device *hdev)
2419 struct wacom *wacom = hid_get_drvdata(hdev);
2420 struct wacom_features *features = &wacom->wacom_wac.features;
2422 mutex_lock(&wacom->lock);
2424 /* switch to wacom mode first */
2425 wacom_query_tablet_data(hdev, features);
2426 wacom_led_control(wacom);
2428 mutex_unlock(&wacom->lock);
2433 static int wacom_reset_resume(struct hid_device *hdev)
2435 return wacom_resume(hdev);
2437 #endif /* CONFIG_PM */
2439 static struct hid_driver wacom_driver = {
2441 .id_table = wacom_ids,
2442 .probe = wacom_probe,
2443 .remove = wacom_remove,
2444 .report = wacom_wac_report,
2446 .resume = wacom_resume,
2447 .reset_resume = wacom_reset_resume,
2449 .raw_event = wacom_raw_event,
2451 module_hid_driver(wacom_driver);
2453 MODULE_VERSION(DRIVER_VERSION);
2454 MODULE_AUTHOR(DRIVER_AUTHOR);
2455 MODULE_DESCRIPTION(DRIVER_DESC);
2456 MODULE_LICENSE(DRIVER_LICENSE);