drivers/hid/wacom_sys.c

   1 /*
   2  * drivers/input/tablet/wacom_sys.c
   3  *
   4  *  USB Wacom tablet support - system specific code
   5  */
   6
   7 /*
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  */
  13
  14 #include "wacom_wac.h"
  15 #include "wacom.h"
  16 #include <linux/hid.h>
  17
  18 #define WAC_MSG_RETRIES         5
  19
  20 #define WAC_CMD_LED_CONTROL     0x20
  21 #define WAC_CMD_ICON_START      0x21
  22 #define WAC_CMD_ICON_XFER       0x23
  23 #define WAC_CMD_RETRIES         10
  24
  25 static int wacom_get_report(struct hid_device *hdev, u8 type, u8 id,
  26                             void *buf, size_t size, unsigned int retries)
  27 {
  28         int retval;
  29
  30         do {
  31                 retval = hid_hw_raw_request(hdev, id, buf, size, type,
  32                                 HID_REQ_GET_REPORT);
  33         } while ((retval == -ETIMEDOUT || retval == -EPIPE) && --retries);
  34
  35         return retval;
  36 }
  37
  38 static int wacom_set_report(struct hid_device *hdev, u8 type, u8 id,
  39                             void *buf, size_t size, unsigned int retries)
  40 {
  41         int retval;
  42
  43         do {
  44                 retval = hid_hw_raw_request(hdev, id, buf, size, type,
  45                                 HID_REQ_SET_REPORT);
  46         } while ((retval == -ETIMEDOUT || retval == -EPIPE) && --retries);
  47
  48         return retval;
  49 }
  50
  51 static int wacom_raw_event(struct hid_device *hdev, struct hid_report *report,
  52                 u8 *raw_data, int size)
  53 {
  54         struct wacom *wacom = hid_get_drvdata(hdev);
  55
  56         if (size > WACOM_PKGLEN_MAX)
  57                 return 1;
  58
  59         memcpy(wacom->wacom_wac.data, raw_data, size);
  60
  61         wacom_wac_irq(&wacom->wacom_wac, size);
  62
  63         return 0;
  64 }
  65
  66 static int wacom_open(struct input_dev *dev)
  67 {
  68         struct wacom *wacom = input_get_drvdata(dev);
  69         int retval;
  70
  71         mutex_lock(&wacom->lock);
  72         retval = hid_hw_open(wacom->hdev);
  73         mutex_unlock(&wacom->lock);
  74
  75         return retval;
  76 }
  77
  78 static void wacom_close(struct input_dev *dev)
  79 {
  80         struct wacom *wacom = input_get_drvdata(dev);
  81
  82         mutex_lock(&wacom->lock);
  83         hid_hw_close(wacom->hdev);
  84         mutex_unlock(&wacom->lock);
  85 }
  86
  87 /*
  88  * Calculate the resolution of the X or Y axis using hidinput_calc_abs_res.
  89  */
  90 static int wacom_calc_hid_res(int logical_extents, int physical_extents,
  91                                unsigned unit, int exponent)
  92 {
  93         struct hid_field field = {
  94                 .logical_maximum = logical_extents,
  95                 .physical_maximum = physical_extents,
  96                 .unit = unit,
  97                 .unit_exponent = exponent,
  98         };
  99
 100         return hidinput_calc_abs_res(&field, ABS_X);
 101 }
 102
 103 static void wacom_feature_mapping(struct hid_device *hdev,
 104                 struct hid_field *field, struct hid_usage *usage)
 105 {
 106         struct wacom *wacom = hid_get_drvdata(hdev);
 107         struct wacom_features *features = &wacom->wacom_wac.features;
 108
 109         switch (usage->hid) {
 110         case HID_DG_CONTACTMAX:
 111                 /* leave touch_max as is if predefined */
 112                 if (!features->touch_max)
 113                         features->touch_max = field->value[0];
 114                 break;
 115         }
 116 }
 117
 118 /*
 119  * Interface Descriptor of wacom devices can be incomplete and
 120  * inconsistent so wacom_features table is used to store stylus
 121  * device's packet lengths, various maximum values, and tablet
 122  * resolution based on product ID's.
 123  *
 124  * For devices that contain 2 interfaces, wacom_features table is
 125  * inaccurate for the touch interface.  Since the Interface Descriptor
 126  * for touch interfaces has pretty complete data, this function exists
 127  * to query tablet for this missing information instead of hard coding in
 128  * an additional table.
 129  *
 130  * A typical Interface Descriptor for a stylus will contain a
 131  * boot mouse application collection that is not of interest and this
 132  * function will ignore it.
 133  *
 134  * It also contains a digitizer application collection that also is not
 135  * of interest since any information it contains would be duplicate
 136  * of what is in wacom_features. Usually it defines a report of an array
 137  * of bytes that could be used as max length of the stylus packet returned.
 138  * If it happens to define a Digitizer-Stylus Physical Collection then
 139  * the X and Y logical values contain valid data but it is ignored.
 140  *
 141  * A typical Interface Descriptor for a touch interface will contain a
 142  * Digitizer-Finger Physical Collection which will define both logical
 143  * X/Y maximum as well as the physical size of tablet. Since touch
 144  * interfaces haven't supported pressure or distance, this is enough
 145  * information to override invalid values in the wacom_features table.
 146  *
 147  * Intuos5 touch interface and 3rd gen Bamboo Touch do not contain useful
 148  * data. We deal with them after returning from this function.
 149  */
 150 static void wacom_usage_mapping(struct hid_device *hdev,
 151                 struct hid_field *field, struct hid_usage *usage)
 152 {
 153         struct wacom *wacom = hid_get_drvdata(hdev);
 154         struct wacom_features *features = &wacom->wacom_wac.features;
 155         bool finger = (field->logical == HID_DG_FINGER) ||
 156                       (field->physical == HID_DG_FINGER);
 157         bool pen = (field->logical == HID_DG_STYLUS) ||
 158                    (field->physical == HID_DG_STYLUS);
 159
 160         /*
 161         * Requiring Stylus Usage will ignore boot mouse
 162         * X/Y values and some cases of invalid Digitizer X/Y
 163         * values commonly reported.
 164         */
 165         if (!pen && !finger)
 166                 return;
 167
 168         if (finger && !features->touch_max)
 169                 /* touch device at least supports one touch point */
 170                 features->touch_max = 1;
 171
 172         switch (usage->hid) {
 173         case HID_GD_X:
 174                 features->x_max = field->logical_maximum;
 175                 if (finger) {
 176                         features->device_type = BTN_TOOL_FINGER;
 177                         features->x_phy = field->physical_maximum;
 178                         if (features->type != BAMBOO_PT) {
 179                                 features->unit = field->unit;
 180                                 features->unitExpo = field->unit_exponent;
 181                         }
 182                 } else {
 183                         features->device_type = BTN_TOOL_PEN;
 184                 }
 185                 break;
 186         case HID_GD_Y:
 187                 features->y_max = field->logical_maximum;
 188                 if (finger) {
 189                         features->y_phy = field->physical_maximum;
 190                         if (features->type != BAMBOO_PT) {
 191                                 features->unit = field->unit;
 192                                 features->unitExpo = field->unit_exponent;
 193                         }
 194                 }
 195                 break;
 196         case HID_DG_TIPPRESSURE:
 197                 if (pen)
 198                         features->pressure_max = field->logical_maximum;
 199                 break;
 200         }
 201 }
 202
 203 static void wacom_parse_hid(struct hid_device *hdev,
 204                            struct wacom_features *features)
 205 {
 206         struct hid_report_enum *rep_enum;
 207         struct hid_report *hreport;
 208         int i, j;
 209
 210         /* check features first */
 211         rep_enum = &hdev->report_enum[HID_FEATURE_REPORT];
 212         list_for_each_entry(hreport, &rep_enum->report_list, list) {
 213                 for (i = 0; i < hreport->maxfield; i++) {
 214                         /* Ignore if report count is out of bounds. */
 215                         if (hreport->field[i]->report_count < 1)
 216                                 continue;
 217
 218                         for (j = 0; j < hreport->field[i]->maxusage; j++) {
 219                                 wacom_feature_mapping(hdev, hreport->field[i],
 220                                                 hreport->field[i]->usage + j);
 221                         }
 222                 }
 223         }
 224
 225         /* now check the input usages */
 226         rep_enum = &hdev->report_enum[HID_INPUT_REPORT];
 227         list_for_each_entry(hreport, &rep_enum->report_list, list) {
 228
 229                 if (!hreport->maxfield)
 230                         continue;
 231
 232                 for (i = 0; i < hreport->maxfield; i++)
 233                         for (j = 0; j < hreport->field[i]->maxusage; j++)
 234                                 wacom_usage_mapping(hdev, hreport->field[i],
 235                                                 hreport->field[i]->usage + j);
 236         }
 237 }
 238
 239 static int wacom_set_device_mode(struct hid_device *hdev, int report_id,
 240                 int length, int mode)
 241 {
 242         unsigned char *rep_data;
 243         int error = -ENOMEM, limit = 0;
 244
 245         rep_data = kzalloc(length, GFP_KERNEL);
 246         if (!rep_data)
 247                 return error;
 248
 249         do {
 250                 rep_data[0] = report_id;
 251                 rep_data[1] = mode;
 252
 253                 error = wacom_set_report(hdev, HID_FEATURE_REPORT,
 254                                          report_id, rep_data, length, 1);
 255                 if (error >= 0)
 256                         error = wacom_get_report(hdev, HID_FEATURE_REPORT,
 257                                                  report_id, rep_data, length, 1);
 258         } while ((error < 0 || rep_data[1] != mode) && limit++ < WAC_MSG_RETRIES);
 259
 260         kfree(rep_data);
 261
 262         return error < 0 ? error : 0;
 263 }
 264
 265 /*
 266  * Switch the tablet into its most-capable mode. Wacom tablets are
 267  * typically configured to power-up in a mode which sends mouse-like
 268  * reports to the OS. To get absolute position, pressure data, etc.
 269  * from the tablet, it is necessary to switch the tablet out of this
 270  * mode and into one which sends the full range of tablet data.
 271  */
 272 static int wacom_query_tablet_data(struct hid_device *hdev,
 273                 struct wacom_features *features)
 274 {
 275         if (features->device_type == BTN_TOOL_FINGER) {
 276                 if (features->type > TABLETPC) {
 277                         /* MT Tablet PC touch */
 278                         return wacom_set_device_mode(hdev, 3, 4, 4);
 279                 }
 280                 else if (features->type == WACOM_24HDT || features->type == CINTIQ_HYBRID) {
 281                         return wacom_set_device_mode(hdev, 18, 3, 2);
 282                 }
 283         } else if (features->device_type == BTN_TOOL_PEN) {
 284                 if (features->type <= BAMBOO_PT && features->type != WIRELESS) {
 285                         return wacom_set_device_mode(hdev, 2, 2, 2);
 286                 }
 287         }
 288
 289         return 0;
 290 }
 291
 292 static void wacom_retrieve_hid_descriptor(struct hid_device *hdev,
 293                                          struct wacom_features *features)
 294 {
 295         struct wacom *wacom = hid_get_drvdata(hdev);
 296         struct usb_interface *intf = wacom->intf;
 297
 298         /* default features */
 299         features->device_type = BTN_TOOL_PEN;
 300         features->x_fuzz = 4;
 301         features->y_fuzz = 4;
 302         features->pressure_fuzz = 0;
 303         features->distance_fuzz = 0;
 304
 305         /*
 306          * The wireless device HID is basic and layout conflicts with
 307          * other tablets (monitor and touch interface can look like pen).
 308          * Skip the query for this type and modify defaults based on
 309          * interface number.
 310          */
 311         if (features->type == WIRELESS) {
 312                 if (intf->cur_altsetting->desc.bInterfaceNumber == 0) {
 313                         features->device_type = 0;
 314                 } else if (intf->cur_altsetting->desc.bInterfaceNumber == 2) {
 315                         features->device_type = BTN_TOOL_FINGER;
 316                         features->pktlen = WACOM_PKGLEN_BBTOUCH3;
 317                 }
 318         }
 319
 320         /* only devices that support touch need to retrieve the info */
 321         if (features->type < BAMBOO_PT)
 322                 return;
 323
 324         wacom_parse_hid(hdev, features);
 325 }
 326
 327 struct wacom_hdev_data {
 328         struct list_head list;
 329         struct kref kref;
 330         struct hid_device *dev;
 331         struct wacom_shared shared;
 332 };
 333
 334 static LIST_HEAD(wacom_udev_list);
 335 static DEFINE_MUTEX(wacom_udev_list_lock);
 336
 337 static bool wacom_are_sibling(struct hid_device *hdev,
 338                 struct hid_device *sibling)
 339 {
 340         struct wacom *wacom = hid_get_drvdata(hdev);
 341         struct wacom_features *features = &wacom->wacom_wac.features;
 342         int vid = features->oVid;
 343         int pid = features->oPid;
 344         int n1,n2;
 345
 346         if (vid == 0 && pid == 0) {
 347                 vid = hdev->vendor;
 348                 pid = hdev->product;
 349         }
 350
 351         if (vid != sibling->vendor || pid != sibling->product)
 352                 return false;
 353
 354         /* Compare the physical path. */
 355         n1 = strrchr(hdev->phys, '.') - hdev->phys;
 356         n2 = strrchr(sibling->phys, '.') - sibling->phys;
 357         if (n1 != n2 || n1 <= 0 || n2 <= 0)
 358                 return false;
 359
 360         return !strncmp(hdev->phys, sibling->phys, n1);
 361 }
 362
 363 static struct wacom_hdev_data *wacom_get_hdev_data(struct hid_device *hdev)
 364 {
 365         struct wacom_hdev_data *data;
 366
 367         list_for_each_entry(data, &wacom_udev_list, list) {
 368                 if (wacom_are_sibling(hdev, data->dev)) {
 369                         kref_get(&data->kref);
 370                         return data;
 371                 }
 372         }
 373
 374         return NULL;
 375 }
 376
 377 static int wacom_add_shared_data(struct hid_device *hdev)
 378 {
 379         struct wacom *wacom = hid_get_drvdata(hdev);
 380         struct wacom_wac *wacom_wac = &wacom->wacom_wac;
 381         struct wacom_hdev_data *data;
 382         int retval = 0;
 383
 384         mutex_lock(&wacom_udev_list_lock);
 385
 386         data = wacom_get_hdev_data(hdev);
 387         if (!data) {
 388                 data = kzalloc(sizeof(struct wacom_hdev_data), GFP_KERNEL);
 389                 if (!data) {
 390                         retval = -ENOMEM;
 391                         goto out;
 392                 }
 393
 394                 kref_init(&data->kref);
 395                 data->dev = hdev;
 396                 list_add_tail(&data->list, &wacom_udev_list);
 397         }
 398
 399         wacom_wac->shared = &data->shared;
 400
 401 out:
 402         mutex_unlock(&wacom_udev_list_lock);
 403         return retval;
 404 }
 405
 406 static void wacom_release_shared_data(struct kref *kref)
 407 {
 408         struct wacom_hdev_data *data =
 409                 container_of(kref, struct wacom_hdev_data, kref);
 410
 411         mutex_lock(&wacom_udev_list_lock);
 412         list_del(&data->list);
 413         mutex_unlock(&wacom_udev_list_lock);
 414
 415         kfree(data);
 416 }
 417
 418 static void wacom_remove_shared_data(struct wacom_wac *wacom)
 419 {
 420         struct wacom_hdev_data *data;
 421
 422         if (wacom->shared) {
 423                 data = container_of(wacom->shared, struct wacom_hdev_data, shared);
 424                 kref_put(&data->kref, wacom_release_shared_data);
 425                 wacom->shared = NULL;
 426         }
 427 }
 428
 429 static int wacom_led_control(struct wacom *wacom)
 430 {
 431         unsigned char *buf;
 432         int retval;
 433
 434         buf = kzalloc(9, GFP_KERNEL);
 435         if (!buf)
 436                 return -ENOMEM;
 437
 438         if (wacom->wacom_wac.features.type >= INTUOS5S &&
 439             wacom->wacom_wac.features.type <= INTUOSPL) {
 440                 /*
 441                  * Touch Ring and crop mark LED luminance may take on
 442                  * one of four values:
 443                  *    0 = Low; 1 = Medium; 2 = High; 3 = Off
 444                  */
 445                 int ring_led = wacom->led.select[0] & 0x03;
 446                 int ring_lum = (((wacom->led.llv & 0x60) >> 5) - 1) & 0x03;
 447                 int crop_lum = 0;
 448
 449                 buf[0] = WAC_CMD_LED_CONTROL;
 450                 buf[1] = (crop_lum << 4) | (ring_lum << 2) | (ring_led);
 451         }
 452         else {
 453                 int led = wacom->led.select[0] | 0x4;
 454
 455                 if (wacom->wacom_wac.features.type == WACOM_21UX2 ||
 456                     wacom->wacom_wac.features.type == WACOM_24HD)
 457                         led |= (wacom->led.select[1] << 4) | 0x40;
 458
 459                 buf[0] = WAC_CMD_LED_CONTROL;
 460                 buf[1] = led;
 461                 buf[2] = wacom->led.llv;
 462                 buf[3] = wacom->led.hlv;
 463                 buf[4] = wacom->led.img_lum;
 464         }
 465
 466         retval = wacom_set_report(wacom->hdev, HID_FEATURE_REPORT,
 467                                   WAC_CMD_LED_CONTROL, buf, 9, WAC_CMD_RETRIES);
 468         kfree(buf);
 469
 470         return retval;
 471 }
 472
 473 static int wacom_led_putimage(struct wacom *wacom, int button_id, const void *img)
 474 {
 475         unsigned char *buf;
 476         int i, retval;
 477
 478         buf = kzalloc(259, GFP_KERNEL);
 479         if (!buf)
 480                 return -ENOMEM;
 481
 482         /* Send 'start' command */
 483         buf[0] = WAC_CMD_ICON_START;
 484         buf[1] = 1;
 485         retval = wacom_set_report(wacom->hdev, HID_FEATURE_REPORT,
 486                                   WAC_CMD_ICON_START, buf, 2, WAC_CMD_RETRIES);
 487         if (retval < 0)
 488                 goto out;
 489
 490         buf[0] = WAC_CMD_ICON_XFER;
 491         buf[1] = button_id & 0x07;
 492         for (i = 0; i < 4; i++) {
 493                 buf[2] = i;
 494                 memcpy(buf + 3, img + i * 256, 256);
 495
 496                 retval = wacom_set_report(wacom->hdev, HID_FEATURE_REPORT,
 497                                           WAC_CMD_ICON_XFER,
 498                                           buf, 259, WAC_CMD_RETRIES);
 499                 if (retval < 0)
 500                         break;
 501         }
 502
 503         /* Send 'stop' */
 504         buf[0] = WAC_CMD_ICON_START;
 505         buf[1] = 0;
 506         wacom_set_report(wacom->hdev, HID_FEATURE_REPORT, WAC_CMD_ICON_START,
 507                          buf, 2, WAC_CMD_RETRIES);
 508
 509 out:
 510         kfree(buf);
 511         return retval;
 512 }
 513
 514 static ssize_t wacom_led_select_store(struct device *dev, int set_id,
 515                                       const char *buf, size_t count)
 516 {
 517         struct hid_device *hdev = container_of(dev, struct hid_device, dev);
 518         struct wacom *wacom = hid_get_drvdata(hdev);
 519         unsigned int id;
 520         int err;
 521
 522         err = kstrtouint(buf, 10, &id);
 523         if (err)
 524                 return err;
 525
 526         mutex_lock(&wacom->lock);
 527
 528         wacom->led.select[set_id] = id & 0x3;
 529         err = wacom_led_control(wacom);
 530
 531         mutex_unlock(&wacom->lock);
 532
 533         return err < 0 ? err : count;
 534 }
 535
 536 #define DEVICE_LED_SELECT_ATTR(SET_ID)                                  \
 537 static ssize_t wacom_led##SET_ID##_select_store(struct device *dev,     \
 538         struct device_attribute *attr, const char *buf, size_t count)   \
 539 {                                                                       \
 540         return wacom_led_select_store(dev, SET_ID, buf, count);         \
 541 }                                                                       \
 542 static ssize_t wacom_led##SET_ID##_select_show(struct device *dev,      \
 543         struct device_attribute *attr, char *buf)                       \
 544 {                                                                       \
 545         struct hid_device *hdev = container_of(dev, struct hid_device, dev);\
 546         struct wacom *wacom = hid_get_drvdata(hdev);                    \
 547         return snprintf(buf, 2, "%d\n", wacom->led.select[SET_ID]);     \
 548 }                                                                       \
 549 static DEVICE_ATTR(status_led##SET_ID##_select, S_IWUSR | S_IRUSR,      \
 550                     wacom_led##SET_ID##_select_show,                    \
 551                     wacom_led##SET_ID##_select_store)
 552
 553 DEVICE_LED_SELECT_ATTR(0);
 554 DEVICE_LED_SELECT_ATTR(1);
 555
 556 static ssize_t wacom_luminance_store(struct wacom *wacom, u8 *dest,
 557                                      const char *buf, size_t count)
 558 {
 559         unsigned int value;
 560         int err;
 561
 562         err = kstrtouint(buf, 10, &value);
 563         if (err)
 564                 return err;
 565
 566         mutex_lock(&wacom->lock);
 567
 568         *dest = value & 0x7f;
 569         err = wacom_led_control(wacom);
 570
 571         mutex_unlock(&wacom->lock);
 572
 573         return err < 0 ? err : count;
 574 }
 575
 576 #define DEVICE_LUMINANCE_ATTR(name, field)                              \
 577 static ssize_t wacom_##name##_luminance_store(struct device *dev,       \
 578         struct device_attribute *attr, const char *buf, size_t count)   \
 579 {                                                                       \
 580         struct hid_device *hdev = container_of(dev, struct hid_device, dev);\
 581         struct wacom *wacom = hid_get_drvdata(hdev);                    \
 582                                                                         \
 583         return wacom_luminance_store(wacom, &wacom->led.field,          \
 584                                      buf, count);                       \
 585 }                                                                       \
 586 static DEVICE_ATTR(name##_luminance, S_IWUSR,                           \
 587                    NULL, wacom_##name##_luminance_store)
 588
 589 DEVICE_LUMINANCE_ATTR(status0, llv);
 590 DEVICE_LUMINANCE_ATTR(status1, hlv);
 591 DEVICE_LUMINANCE_ATTR(buttons, img_lum);
 592
 593 static ssize_t wacom_button_image_store(struct device *dev, int button_id,
 594                                         const char *buf, size_t count)
 595 {
 596         struct hid_device *hdev = container_of(dev, struct hid_device, dev);
 597         struct wacom *wacom = hid_get_drvdata(hdev);
 598         int err;
 599
 600         if (count != 1024)
 601                 return -EINVAL;
 602
 603         mutex_lock(&wacom->lock);
 604
 605         err = wacom_led_putimage(wacom, button_id, buf);
 606
 607         mutex_unlock(&wacom->lock);
 608
 609         return err < 0 ? err : count;
 610 }
 611
 612 #define DEVICE_BTNIMG_ATTR(BUTTON_ID)                                   \
 613 static ssize_t wacom_btnimg##BUTTON_ID##_store(struct device *dev,      \
 614         struct device_attribute *attr, const char *buf, size_t count)   \
 615 {                                                                       \
 616         return wacom_button_image_store(dev, BUTTON_ID, buf, count);    \
 617 }                                                                       \
 618 static DEVICE_ATTR(button##BUTTON_ID##_rawimg, S_IWUSR,                 \
 619                    NULL, wacom_btnimg##BUTTON_ID##_store)
 620
 621 DEVICE_BTNIMG_ATTR(0);
 622 DEVICE_BTNIMG_ATTR(1);
 623 DEVICE_BTNIMG_ATTR(2);
 624 DEVICE_BTNIMG_ATTR(3);
 625 DEVICE_BTNIMG_ATTR(4);
 626 DEVICE_BTNIMG_ATTR(5);
 627 DEVICE_BTNIMG_ATTR(6);
 628 DEVICE_BTNIMG_ATTR(7);
 629
 630 static struct attribute *cintiq_led_attrs[] = {
 631         &dev_attr_status_led0_select.attr,
 632         &dev_attr_status_led1_select.attr,
 633         NULL
 634 };
 635
 636 static struct attribute_group cintiq_led_attr_group = {
 637         .name = "wacom_led",
 638         .attrs = cintiq_led_attrs,
 639 };
 640
 641 static struct attribute *intuos4_led_attrs[] = {
 642         &dev_attr_status0_luminance.attr,
 643         &dev_attr_status1_luminance.attr,
 644         &dev_attr_status_led0_select.attr,
 645         &dev_attr_buttons_luminance.attr,
 646         &dev_attr_button0_rawimg.attr,
 647         &dev_attr_button1_rawimg.attr,
 648         &dev_attr_button2_rawimg.attr,
 649         &dev_attr_button3_rawimg.attr,
 650         &dev_attr_button4_rawimg.attr,
 651         &dev_attr_button5_rawimg.attr,
 652         &dev_attr_button6_rawimg.attr,
 653         &dev_attr_button7_rawimg.attr,
 654         NULL
 655 };
 656
 657 static struct attribute_group intuos4_led_attr_group = {
 658         .name = "wacom_led",
 659         .attrs = intuos4_led_attrs,
 660 };
 661
 662 static struct attribute *intuos5_led_attrs[] = {
 663         &dev_attr_status0_luminance.attr,
 664         &dev_attr_status_led0_select.attr,
 665         NULL
 666 };
 667
 668 static struct attribute_group intuos5_led_attr_group = {
 669         .name = "wacom_led",
 670         .attrs = intuos5_led_attrs,
 671 };
 672
 673 static int wacom_initialize_leds(struct wacom *wacom)
 674 {
 675         int error;
 676
 677         /* Initialize default values */
 678         switch (wacom->wacom_wac.features.type) {
 679         case INTUOS4S:
 680         case INTUOS4:
 681         case INTUOS4L:
 682                 wacom->led.select[0] = 0;
 683                 wacom->led.select[1] = 0;
 684                 wacom->led.llv = 10;
 685                 wacom->led.hlv = 20;
 686                 wacom->led.img_lum = 10;
 687                 error = sysfs_create_group(&wacom->hdev->dev.kobj,
 688                                            &intuos4_led_attr_group);
 689                 break;
 690
 691         case WACOM_24HD:
 692         case WACOM_21UX2:
 693                 wacom->led.select[0] = 0;
 694                 wacom->led.select[1] = 0;
 695                 wacom->led.llv = 0;
 696                 wacom->led.hlv = 0;
 697                 wacom->led.img_lum = 0;
 698
 699                 error = sysfs_create_group(&wacom->hdev->dev.kobj,
 700                                            &cintiq_led_attr_group);
 701                 break;
 702
 703         case INTUOS5S:
 704         case INTUOS5:
 705         case INTUOS5L:
 706         case INTUOSPS:
 707         case INTUOSPM:
 708         case INTUOSPL:
 709                 if (wacom->wacom_wac.features.device_type == BTN_TOOL_PEN) {
 710                         wacom->led.select[0] = 0;
 711                         wacom->led.select[1] = 0;
 712                         wacom->led.llv = 32;
 713                         wacom->led.hlv = 0;
 714                         wacom->led.img_lum = 0;
 715
 716                         error = sysfs_create_group(&wacom->hdev->dev.kobj,
 717                                                   &intuos5_led_attr_group);
 718                 } else
 719                         return 0;
 720                 break;
 721
 722         default:
 723                 return 0;
 724         }
 725
 726         if (error) {
 727                 hid_err(wacom->hdev,
 728                         "cannot create sysfs group err: %d\n", error);
 729                 return error;
 730         }
 731         wacom_led_control(wacom);
 732         wacom->led_initialized = true;
 733
 734         return 0;
 735 }
 736
 737 static void wacom_destroy_leds(struct wacom *wacom)
 738 {
 739         if (!wacom->led_initialized)
 740                 return;
 741
 742         wacom->led_initialized = false;
 743
 744         switch (wacom->wacom_wac.features.type) {
 745         case INTUOS4S:
 746         case INTUOS4:
 747         case INTUOS4L:
 748                 sysfs_remove_group(&wacom->hdev->dev.kobj,
 749                                    &intuos4_led_attr_group);
 750                 break;
 751
 752         case WACOM_24HD:
 753         case WACOM_21UX2:
 754                 sysfs_remove_group(&wacom->hdev->dev.kobj,
 755                                    &cintiq_led_attr_group);
 756                 break;
 757
 758         case INTUOS5S:
 759         case INTUOS5:
 760         case INTUOS5L:
 761         case INTUOSPS:
 762         case INTUOSPM:
 763         case INTUOSPL:
 764                 if (wacom->wacom_wac.features.device_type == BTN_TOOL_PEN)
 765                         sysfs_remove_group(&wacom->hdev->dev.kobj,
 766                                            &intuos5_led_attr_group);
 767                 break;
 768         }
 769 }
 770
 771 static enum power_supply_property wacom_battery_props[] = {
 772         POWER_SUPPLY_PROP_STATUS,
 773         POWER_SUPPLY_PROP_SCOPE,
 774         POWER_SUPPLY_PROP_CAPACITY
 775 };
 776
 777 static int wacom_battery_get_property(struct power_supply *psy,
 778                                       enum power_supply_property psp,
 779                                       union power_supply_propval *val)
 780 {
 781         struct wacom *wacom = container_of(psy, struct wacom, battery);
 782         int ret = 0;
 783
 784         switch (psp) {
 785                 case POWER_SUPPLY_PROP_SCOPE:
 786                         val->intval = POWER_SUPPLY_SCOPE_DEVICE;
 787                         break;
 788                 case POWER_SUPPLY_PROP_CAPACITY:
 789                         val->intval =
 790                                 wacom->wacom_wac.battery_capacity;
 791                         break;
 792                 case POWER_SUPPLY_PROP_STATUS:
 793                         if (wacom->wacom_wac.bat_charging)
 794                                 val->intval = POWER_SUPPLY_STATUS_CHARGING;
 795                         else if (wacom->wacom_wac.battery_capacity == 100 &&
 796                                     wacom->wacom_wac.ps_connected)
 797                                 val->intval = POWER_SUPPLY_STATUS_FULL;
 798                         else
 799                                 val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
 800                         break;
 801                 default:
 802                         ret = -EINVAL;
 803                         break;
 804         }
 805
 806         return ret;
 807 }
 808
 809 static int wacom_initialize_battery(struct wacom *wacom)
 810 {
 811         int error = 0;
 812
 813         if (wacom->wacom_wac.features.quirks & WACOM_QUIRK_BATTERY) {
 814                 wacom->battery.properties = wacom_battery_props;
 815                 wacom->battery.num_properties = ARRAY_SIZE(wacom_battery_props);
 816                 wacom->battery.get_property = wacom_battery_get_property;
 817                 wacom->battery.name = "wacom_battery";
 818                 wacom->battery.type = POWER_SUPPLY_TYPE_BATTERY;
 819                 wacom->battery.use_for_apm = 0;
 820
 821                 error = power_supply_register(&wacom->hdev->dev,
 822                                               &wacom->battery);
 823
 824                 if (!error)
 825                         power_supply_powers(&wacom->battery,
 826                                             &wacom->hdev->dev);
 827         }
 828
 829         return error;
 830 }
 831
 832 static void wacom_destroy_battery(struct wacom *wacom)
 833 {
 834         if ((wacom->wacom_wac.features.quirks & WACOM_QUIRK_BATTERY) &&
 835              wacom->battery.dev) {
 836                 power_supply_unregister(&wacom->battery);
 837                 wacom->battery.dev = NULL;
 838         }
 839 }
 840
 841 static struct input_dev *wacom_allocate_input(struct wacom *wacom)
 842 {
 843         struct input_dev *input_dev;
 844         struct hid_device *hdev = wacom->hdev;
 845         struct wacom_wac *wacom_wac = &(wacom->wacom_wac);
 846
 847         input_dev = input_allocate_device();
 848         if (!input_dev)
 849                 return NULL;
 850
 851         input_dev->name = wacom_wac->name;
 852         input_dev->phys = hdev->phys;
 853         input_dev->dev.parent = &hdev->dev;
 854         input_dev->open = wacom_open;
 855         input_dev->close = wacom_close;
 856         input_dev->uniq = hdev->uniq;
 857         input_dev->id.bustype = hdev->bus;
 858         input_dev->id.vendor  = hdev->vendor;
 859         input_dev->id.product = hdev->product;
 860         input_dev->id.version = hdev->version;
 861         input_set_drvdata(input_dev, wacom);
 862
 863         return input_dev;
 864 }
 865
 866 static void wacom_unregister_inputs(struct wacom *wacom)
 867 {
 868         if (wacom->wacom_wac.input)
 869                 input_unregister_device(wacom->wacom_wac.input);
 870         if (wacom->wacom_wac.pad_input)
 871                 input_unregister_device(wacom->wacom_wac.pad_input);
 872         wacom->wacom_wac.input = NULL;
 873         wacom->wacom_wac.pad_input = NULL;
 874 }
 875
 876 static int wacom_register_inputs(struct wacom *wacom)
 877 {
 878         struct input_dev *input_dev, *pad_input_dev;
 879         struct wacom_wac *wacom_wac = &(wacom->wacom_wac);
 880         int error;
 881
 882         input_dev = wacom_allocate_input(wacom);
 883         pad_input_dev = wacom_allocate_input(wacom);
 884         if (!input_dev || !pad_input_dev) {
 885                 error = -ENOMEM;
 886                 goto fail1;
 887         }
 888
 889         wacom_wac->input = input_dev;
 890         wacom_wac->pad_input = pad_input_dev;
 891         wacom_wac->pad_input->name = wacom_wac->pad_name;
 892
 893         error = wacom_setup_input_capabilities(input_dev, wacom_wac);
 894         if (error)
 895                 goto fail2;
 896
 897         error = input_register_device(input_dev);
 898         if (error)
 899                 goto fail2;
 900
 901         error = wacom_setup_pad_input_capabilities(pad_input_dev, wacom_wac);
 902         if (error) {
 903                 /* no pad in use on this interface */
 904                 input_free_device(pad_input_dev);
 905                 wacom_wac->pad_input = NULL;
 906                 pad_input_dev = NULL;
 907         } else {
 908                 error = input_register_device(pad_input_dev);
 909                 if (error)
 910                         goto fail3;
 911         }
 912
 913         return 0;
 914
 915 fail3:
 916         input_unregister_device(input_dev);
 917         input_dev = NULL;
 918 fail2:
 919         wacom_wac->input = NULL;
 920         wacom_wac->pad_input = NULL;
 921 fail1:
 922         if (input_dev)
 923                 input_free_device(input_dev);
 924         if (pad_input_dev)
 925                 input_free_device(pad_input_dev);
 926         return error;
 927 }
 928
 929 static void wacom_wireless_work(struct work_struct *work)
 930 {
 931         struct wacom *wacom = container_of(work, struct wacom, work);
 932         struct usb_device *usbdev = wacom->usbdev;
 933         struct wacom_wac *wacom_wac = &wacom->wacom_wac;
 934         struct hid_device *hdev1, *hdev2;
 935         struct wacom *wacom1, *wacom2;
 936         struct wacom_wac *wacom_wac1, *wacom_wac2;
 937         int error;
 938
 939         /*
 940          * Regardless if this is a disconnect or a new tablet,
 941          * remove any existing input and battery devices.
 942          */
 943
 944         wacom_destroy_battery(wacom);
 945
 946         /* Stylus interface */
 947         hdev1 = usb_get_intfdata(usbdev->config->interface[1]);
 948         wacom1 = hid_get_drvdata(hdev1);
 949         wacom_wac1 = &(wacom1->wacom_wac);
 950         wacom_unregister_inputs(wacom1);
 951
 952         /* Touch interface */
 953         hdev2 = usb_get_intfdata(usbdev->config->interface[2]);
 954         wacom2 = hid_get_drvdata(hdev2);
 955         wacom_wac2 = &(wacom2->wacom_wac);
 956         wacom_unregister_inputs(wacom2);
 957
 958         if (wacom_wac->pid == 0) {
 959                 hid_info(wacom->hdev, "wireless tablet disconnected\n");
 960                 wacom_wac1->shared->type = 0;
 961         } else {
 962                 const struct hid_device_id *id = wacom_ids;
 963
 964                 hid_info(wacom->hdev, "wireless tablet connected with PID %x\n",
 965                          wacom_wac->pid);
 966
 967                 while (id->bus) {
 968                         if (id->vendor == USB_VENDOR_ID_WACOM &&
 969                             id->product == wacom_wac->pid)
 970                                 break;
 971                         id++;
 972                 }
 973
 974                 if (!id->bus) {
 975                         hid_info(wacom->hdev, "ignoring unknown PID.\n");
 976                         return;
 977                 }
 978
 979                 /* Stylus interface */
 980                 wacom_wac1->features =
 981                         *((struct wacom_features *)id->driver_data);
 982                 wacom_wac1->features.device_type = BTN_TOOL_PEN;
 983                 snprintf(wacom_wac1->name, WACOM_NAME_MAX, "%s (WL) Pen",
 984                          wacom_wac1->features.name);
 985                 snprintf(wacom_wac1->pad_name, WACOM_NAME_MAX, "%s (WL) Pad",
 986                          wacom_wac1->features.name);
 987                 wacom_wac1->shared->touch_max = wacom_wac1->features.touch_max;
 988                 wacom_wac1->shared->type = wacom_wac1->features.type;
 989                 error = wacom_register_inputs(wacom1);
 990                 if (error)
 991                         goto fail;
 992
 993                 /* Touch interface */
 994                 if (wacom_wac1->features.touch_max ||
 995                     wacom_wac1->features.type == INTUOSHT) {
 996                         wacom_wac2->features =
 997                                 *((struct wacom_features *)id->driver_data);
 998                         wacom_wac2->features.pktlen = WACOM_PKGLEN_BBTOUCH3;
 999                         wacom_wac2->features.device_type = BTN_TOOL_FINGER;
1000                         wacom_wac2->features.x_max = wacom_wac2->features.y_max = 4096;
1001                         if (wacom_wac2->features.touch_max)
1002                                 snprintf(wacom_wac2->name, WACOM_NAME_MAX,
1003                                          "%s (WL) Finger",wacom_wac2->features.name);
1004                         else
1005                                 snprintf(wacom_wac2->name, WACOM_NAME_MAX,
1006                                          "%s (WL) Pad",wacom_wac2->features.name);
1007                         snprintf(wacom_wac2->pad_name, WACOM_NAME_MAX,
1008                                  "%s (WL) Pad", wacom_wac2->features.name);
1009                         error = wacom_register_inputs(wacom2);
1010                         if (error)
1011                                 goto fail;
1012
1013                         if (wacom_wac1->features.type == INTUOSHT &&
1014                             wacom_wac1->features.touch_max)
1015                                 wacom_wac->shared->touch_input = wacom_wac2->input;
1016                 }
1017
1018                 error = wacom_initialize_battery(wacom);
1019                 if (error)
1020                         goto fail;
1021         }
1022
1023         return;
1024
1025 fail:
1026         wacom_unregister_inputs(wacom1);
1027         wacom_unregister_inputs(wacom2);
1028         return;
1029 }
1030
1031 /*
1032  * Not all devices report physical dimensions from HID.
1033  * Compute the default from hardcoded logical dimension
1034  * and resolution before driver overwrites them.
1035  */
1036 static void wacom_set_default_phy(struct wacom_features *features)
1037 {
1038         if (features->x_resolution) {
1039                 features->x_phy = (features->x_max * 100) /
1040                                         features->x_resolution;
1041                 features->y_phy = (features->y_max * 100) /
1042                                         features->y_resolution;
1043         }
1044 }
1045
1046 static void wacom_calculate_res(struct wacom_features *features)
1047 {
1048         features->x_resolution = wacom_calc_hid_res(features->x_max,
1049                                                     features->x_phy,
1050                                                     features->unit,
1051                                                     features->unitExpo);
1052         features->y_resolution = wacom_calc_hid_res(features->y_max,
1053                                                     features->y_phy,
1054                                                     features->unit,
1055                                                     features->unitExpo);
1056 }
1057
1058 static int wacom_hid_report_len(struct hid_report *report)
1059 {
1060         /* equivalent to DIV_ROUND_UP(report->size, 8) + !!(report->id > 0) */
1061         return ((report->size - 1) >> 3) + 1 + (report->id > 0);
1062 }
1063
1064 static size_t wacom_compute_pktlen(struct hid_device *hdev)
1065 {
1066         struct hid_report_enum *report_enum;
1067         struct hid_report *report;
1068         size_t size = 0;
1069
1070         report_enum = hdev->report_enum + HID_INPUT_REPORT;
1071
1072         list_for_each_entry(report, &report_enum->report_list, list) {
1073                 size_t report_size = wacom_hid_report_len(report);
1074                 if (report_size > size)
1075                         size = report_size;
1076         }
1077
1078         return size;
1079 }
1080
1081 static int wacom_probe(struct hid_device *hdev,
1082                 const struct hid_device_id *id)
1083 {
1084         struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
1085         struct usb_device *dev = interface_to_usbdev(intf);
1086         struct wacom *wacom;
1087         struct wacom_wac *wacom_wac;
1088         struct wacom_features *features;
1089         int error;
1090
1091         if (!id->driver_data)
1092                 return -EINVAL;
1093
1094         wacom = kzalloc(sizeof(struct wacom), GFP_KERNEL);
1095         if (!wacom)
1096                 return -ENOMEM;
1097
1098         hid_set_drvdata(hdev, wacom);
1099         wacom->hdev = hdev;
1100
1101         /* ask for the report descriptor to be loaded by HID */
1102         error = hid_parse(hdev);
1103         if (error) {
1104                 hid_err(hdev, "parse failed\n");
1105                 goto fail1;
1106         }
1107
1108         wacom_wac = &wacom->wacom_wac;
1109         wacom_wac->features = *((struct wacom_features *)id->driver_data);
1110         features = &wacom_wac->features;
1111         features->pktlen = wacom_compute_pktlen(hdev);
1112         if (features->pktlen > WACOM_PKGLEN_MAX) {
1113                 error = -EINVAL;
1114                 goto fail1;
1115         }
1116
1117         if (features->check_for_hid_type && features->hid_type != hdev->type) {
1118                 error = -ENODEV;
1119                 goto fail1;
1120         }
1121
1122         wacom->usbdev = dev;
1123         wacom->intf = intf;
1124         mutex_init(&wacom->lock);
1125         INIT_WORK(&wacom->work, wacom_wireless_work);
1126
1127         /* set the default size in case we do not get them from hid */
1128         wacom_set_default_phy(features);
1129
1130         /* Retrieve the physical and logical size for touch devices */
1131         wacom_retrieve_hid_descriptor(hdev, features);
1132
1133         /*
1134          * Intuos5 has no useful data about its touch interface in its
1135          * HID descriptor. If this is the touch interface (PacketSize
1136          * of WACOM_PKGLEN_BBTOUCH3), override the table values.
1137          */
1138         if (features->type >= INTUOS5S && features->type <= INTUOSHT) {
1139                 if (features->pktlen == WACOM_PKGLEN_BBTOUCH3) {
1140                         features->device_type = BTN_TOOL_FINGER;
1141
1142                         features->x_max = 4096;
1143                         features->y_max = 4096;
1144                 } else {
1145                         features->device_type = BTN_TOOL_PEN;
1146                 }
1147         }
1148
1149         /*
1150          * Same thing for Bamboo 3rd gen.
1151          */
1152         if ((features->type == BAMBOO_PT) &&
1153             (features->pktlen == WACOM_PKGLEN_BBTOUCH3) &&
1154             (features->device_type == BTN_TOOL_PEN)) {
1155                 features->device_type = BTN_TOOL_FINGER;
1156
1157                 features->x_max = 4096;
1158                 features->y_max = 4096;
1159         }
1160
1161         wacom_setup_device_quirks(features);
1162
1163         /* set unit to "100th of a mm" for devices not reported by HID */
1164         if (!features->unit) {
1165                 features->unit = 0x11;
1166                 features->unitExpo = -3;
1167         }
1168         wacom_calculate_res(features);
1169
1170         strlcpy(wacom_wac->name, features->name, sizeof(wacom_wac->name));
1171         snprintf(wacom_wac->pad_name, sizeof(wacom_wac->pad_name),
1172                 "%s Pad", features->name);
1173
1174         if (features->quirks & WACOM_QUIRK_MULTI_INPUT) {
1175                 /* Append the device type to the name */
1176                 if (features->device_type != BTN_TOOL_FINGER)
1177                         strlcat(wacom_wac->name, " Pen", WACOM_NAME_MAX);
1178                 else if (features->touch_max)
1179                         strlcat(wacom_wac->name, " Finger", WACOM_NAME_MAX);
1180                 else
1181                         strlcat(wacom_wac->name, " Pad", WACOM_NAME_MAX);
1182
1183                 error = wacom_add_shared_data(hdev);
1184                 if (error)
1185                         goto fail1;
1186         }
1187
1188         error = wacom_initialize_leds(wacom);
1189         if (error)
1190                 goto fail2;
1191
1192         if (!(features->quirks & WACOM_QUIRK_NO_INPUT)) {
1193                 error = wacom_register_inputs(wacom);
1194                 if (error)
1195                         goto fail3;
1196         }
1197
1198         /* Note that if query fails it is not a hard failure */
1199         wacom_query_tablet_data(hdev, features);
1200
1201         /* Regular HID work starts now */
1202         error = hid_hw_start(hdev, HID_CONNECT_HIDRAW);
1203         if (error) {
1204                 hid_err(hdev, "hw start failed\n");
1205                 goto fail4;
1206         }
1207
1208         if (features->quirks & WACOM_QUIRK_MONITOR)
1209                 error = hid_hw_open(hdev);
1210
1211         if (wacom_wac->features.type == INTUOSHT && wacom_wac->features.touch_max) {
1212                 if (wacom_wac->features.device_type == BTN_TOOL_FINGER)
1213                         wacom_wac->shared->touch_input = wacom_wac->input;
1214         }
1215
1216         return 0;
1217
1218  fail4: wacom_unregister_inputs(wacom);
1219  fail3: wacom_destroy_leds(wacom);
1220  fail2: wacom_remove_shared_data(wacom_wac);
1221  fail1: kfree(wacom);
1222         hid_set_drvdata(hdev, NULL);
1223         return error;
1224 }
1225
1226 static void wacom_remove(struct hid_device *hdev)
1227 {
1228         struct wacom *wacom = hid_get_drvdata(hdev);
1229
1230         hid_hw_stop(hdev);
1231
1232         cancel_work_sync(&wacom->work);
1233         wacom_unregister_inputs(wacom);
1234         wacom_destroy_battery(wacom);
1235         wacom_destroy_leds(wacom);
1236         wacom_remove_shared_data(&wacom->wacom_wac);
1237
1238         hid_set_drvdata(hdev, NULL);
1239         kfree(wacom);
1240 }
1241
1242 static int wacom_resume(struct hid_device *hdev)
1243 {
1244         struct wacom *wacom = hid_get_drvdata(hdev);
1245         struct wacom_features *features = &wacom->wacom_wac.features;
1246
1247         mutex_lock(&wacom->lock);
1248
1249         /* switch to wacom mode first */
1250         wacom_query_tablet_data(hdev, features);
1251         wacom_led_control(wacom);
1252
1253         mutex_unlock(&wacom->lock);
1254
1255         return 0;
1256 }
1257
1258 static int wacom_reset_resume(struct hid_device *hdev)
1259 {
1260         return wacom_resume(hdev);
1261 }
1262
1263 static struct hid_driver wacom_driver = {
1264         .name =         "wacom",
1265         .id_table =     wacom_ids,
1266         .probe =        wacom_probe,
1267         .remove =       wacom_remove,
1268 #ifdef CONFIG_PM
1269         .resume =       wacom_resume,
1270         .reset_resume = wacom_reset_resume,
1271 #endif
1272         .raw_event =    wacom_raw_event,
1273 };
1274 module_hid_driver(wacom_driver);