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