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                                 wacom_retrieve_report_data(intf, features);
 405                                 i++;
 406                                 break;
 407                         }
 408                         break;
 409
 410                 case HID_COLLECTION_END:
 411                         /* reset UsagePage and Finger */
 412                         finger = usage = 0;
 413                         break;
 414
 415                 case HID_COLLECTION:
 416                         i++;
 417                         switch (report[i]) {
 418                         case HID_COLLECTION_LOGICAL:
 419                                 i += wacom_parse_logical_collection(&report[i],
 420                                                                     features);
 421                                 break;
 422                         }
 423                         break;
 424                 }
 425         }
 426
 427  out:
 428         result = 0;
 429         kfree(report);
 430         return result;
 431 }
 432
 433 static int wacom_query_tablet_data(struct usb_interface *intf, struct wacom_features *features)
 434 {
 435         unsigned char *rep_data;
 436         int limit = 0, report_id = 2;
 437         int error = -ENOMEM;
 438
 439         rep_data = kmalloc(4, GFP_KERNEL);
 440         if (!rep_data)
 441                 return error;
 442
 443         /* ask to report Wacom data */
 444         if (features->device_type == BTN_TOOL_FINGER) {
 445                 /* if it is an MT Tablet PC touch */
 446                 if (features->type == TABLETPC2FG ||
 447                     features->type == MTSCREEN) {
 448                         do {
 449                                 rep_data[0] = 3;
 450                                 rep_data[1] = 4;
 451                                 rep_data[2] = 0;
 452                                 rep_data[3] = 0;
 453                                 report_id = 3;
 454                                 error = wacom_set_report(intf,
 455                                                          WAC_HID_FEATURE_REPORT,
 456                                                          report_id,
 457                                                          rep_data, 4, 1);
 458                                 if (error >= 0)
 459                                         error = wacom_get_report(intf,
 460                                                         WAC_HID_FEATURE_REPORT,
 461                                                         report_id,
 462                                                         rep_data, 4, 1);
 463                         } while ((error < 0 || rep_data[1] != 4) &&
 464                                  limit++ < WAC_MSG_RETRIES);
 465                 }
 466         } else if (features->type != TABLETPC &&
 467                    features->type != WIRELESS &&
 468                    features->device_type == BTN_TOOL_PEN) {
 469                 do {
 470                         rep_data[0] = 2;
 471                         rep_data[1] = 2;
 472                         error = wacom_set_report(intf, WAC_HID_FEATURE_REPORT,
 473                                                  report_id, rep_data, 2, 1);
 474                         if (error >= 0)
 475                                 error = wacom_get_report(intf,
 476                                                 WAC_HID_FEATURE_REPORT,
 477                                                 report_id, rep_data, 2, 1);
 478                 } while ((error < 0 || rep_data[1] != 2) && limit++ < WAC_MSG_RETRIES);
 479         }
 480
 481         kfree(rep_data);
 482
 483         return error < 0 ? error : 0;
 484 }
 485
 486 static int wacom_retrieve_hid_descriptor(struct usb_interface *intf,
 487                                          struct wacom_features *features)
 488 {
 489         int error = 0;
 490         struct usb_host_interface *interface = intf->cur_altsetting;
 491         struct hid_descriptor *hid_desc;
 492
 493         /* default features */
 494         features->device_type = BTN_TOOL_PEN;
 495         features->x_fuzz = 4;
 496         features->y_fuzz = 4;
 497         features->pressure_fuzz = 0;
 498         features->distance_fuzz = 0;
 499
 500         /*
 501          * The wireless device HID is basic and layout conflicts with
 502          * other tablets (monitor and touch interface can look like pen).
 503          * Skip the query for this type and modify defaults based on
 504          * interface number.
 505          */
 506         if (features->type == WIRELESS) {
 507                 if (intf->cur_altsetting->desc.bInterfaceNumber == 0) {
 508                         features->device_type = 0;
 509                 } else if (intf->cur_altsetting->desc.bInterfaceNumber == 2) {
 510                         features->device_type = BTN_TOOL_DOUBLETAP;
 511                         features->pktlen = WACOM_PKGLEN_BBTOUCH3;
 512                 }
 513         }
 514
 515         /* only devices that support touch need to retrieve the info */
 516         if (features->type != TABLETPC &&
 517             features->type != TABLETPC2FG &&
 518             features->type != BAMBOO_PT &&
 519             features->type != MTSCREEN) {
 520                 goto out;
 521         }
 522
 523         error = usb_get_extra_descriptor(interface, HID_DEVICET_HID, &hid_desc);
 524         if (error) {
 525                 error = usb_get_extra_descriptor(&interface->endpoint[0],
 526                                                  HID_DEVICET_REPORT, &hid_desc);
 527                 if (error) {
 528                         dev_err(&intf->dev,
 529                                 "can not retrieve extra class descriptor\n");
 530                         goto out;
 531                 }
 532         }
 533         error = wacom_parse_hid(intf, hid_desc, features);
 534         if (error)
 535                 goto out;
 536
 537  out:
 538         return error;
 539 }
 540
 541 struct wacom_usbdev_data {
 542         struct list_head list;
 543         struct kref kref;
 544         struct usb_device *dev;
 545         struct wacom_shared shared;
 546 };
 547
 548 static LIST_HEAD(wacom_udev_list);
 549 static DEFINE_MUTEX(wacom_udev_list_lock);
 550
 551 static struct wacom_usbdev_data *wacom_get_usbdev_data(struct usb_device *dev)
 552 {
 553         struct wacom_usbdev_data *data;
 554
 555         list_for_each_entry(data, &wacom_udev_list, list) {
 556                 if (data->dev == dev) {
 557                         kref_get(&data->kref);
 558                         return data;
 559                 }
 560         }
 561
 562         return NULL;
 563 }
 564
 565 static int wacom_add_shared_data(struct wacom_wac *wacom,
 566                                  struct usb_device *dev)
 567 {
 568         struct wacom_usbdev_data *data;
 569         int retval = 0;
 570
 571         mutex_lock(&wacom_udev_list_lock);
 572
 573         data = wacom_get_usbdev_data(dev);
 574         if (!data) {
 575                 data = kzalloc(sizeof(struct wacom_usbdev_data), GFP_KERNEL);
 576                 if (!data) {
 577                         retval = -ENOMEM;
 578                         goto out;
 579                 }
 580
 581                 kref_init(&data->kref);
 582                 data->dev = dev;
 583                 list_add_tail(&data->list, &wacom_udev_list);
 584         }
 585
 586         wacom->shared = &data->shared;
 587
 588 out:
 589         mutex_unlock(&wacom_udev_list_lock);
 590         return retval;
 591 }
 592
 593 static void wacom_release_shared_data(struct kref *kref)
 594 {
 595         struct wacom_usbdev_data *data =
 596                 container_of(kref, struct wacom_usbdev_data, kref);
 597
 598         mutex_lock(&wacom_udev_list_lock);
 599         list_del(&data->list);
 600         mutex_unlock(&wacom_udev_list_lock);
 601
 602         kfree(data);
 603 }
 604
 605 static void wacom_remove_shared_data(struct wacom_wac *wacom)
 606 {
 607         struct wacom_usbdev_data *data;
 608
 609         if (wacom->shared) {
 610                 data = container_of(wacom->shared, struct wacom_usbdev_data, shared);
 611                 kref_put(&data->kref, wacom_release_shared_data);
 612                 wacom->shared = NULL;
 613         }
 614 }
 615
 616 static int wacom_led_control(struct wacom *wacom)
 617 {
 618         unsigned char *buf;
 619         int retval;
 620
 621         buf = kzalloc(9, GFP_KERNEL);
 622         if (!buf)
 623                 return -ENOMEM;
 624
 625         if (wacom->wacom_wac.features.type >= INTUOS5S &&
 626             wacom->wacom_wac.features.type <= INTUOS5L) {
 627                 /*
 628                  * Touch Ring and crop mark LED luminance may take on
 629                  * one of four values:
 630                  *    0 = Low; 1 = Medium; 2 = High; 3 = Off
 631                  */
 632                 int ring_led = wacom->led.select[0] & 0x03;
 633                 int ring_lum = (((wacom->led.llv & 0x60) >> 5) - 1) & 0x03;
 634                 int crop_lum = 0;
 635
 636                 buf[0] = WAC_CMD_LED_CONTROL;
 637                 buf[1] = (crop_lum << 4) | (ring_lum << 2) | (ring_led);
 638         }
 639         else {
 640                 int led = wacom->led.select[0] | 0x4;
 641
 642                 if (wacom->wacom_wac.features.type == WACOM_21UX2 ||
 643                     wacom->wacom_wac.features.type == WACOM_24HD)
 644                         led |= (wacom->led.select[1] << 4) | 0x40;
 645
 646                 buf[0] = WAC_CMD_LED_CONTROL;
 647                 buf[1] = led;
 648                 buf[2] = wacom->led.llv;
 649                 buf[3] = wacom->led.hlv;
 650                 buf[4] = wacom->led.img_lum;
 651         }
 652
 653         retval = wacom_set_report(wacom->intf, 0x03, WAC_CMD_LED_CONTROL,
 654                                   buf, 9, WAC_CMD_RETRIES);
 655         kfree(buf);
 656
 657         return retval;
 658 }
 659
 660 static int wacom_led_putimage(struct wacom *wacom, int button_id, const void *img)
 661 {
 662         unsigned char *buf;
 663         int i, retval;
 664
 665         buf = kzalloc(259, GFP_KERNEL);
 666         if (!buf)
 667                 return -ENOMEM;
 668
 669         /* Send 'start' command */
 670         buf[0] = WAC_CMD_ICON_START;
 671         buf[1] = 1;
 672         retval = wacom_set_report(wacom->intf, 0x03, WAC_CMD_ICON_START,
 673                                   buf, 2, WAC_CMD_RETRIES);
 674         if (retval < 0)
 675                 goto out;
 676
 677         buf[0] = WAC_CMD_ICON_XFER;
 678         buf[1] = button_id & 0x07;
 679         for (i = 0; i < 4; i++) {
 680                 buf[2] = i;
 681                 memcpy(buf + 3, img + i * 256, 256);
 682
 683                 retval = wacom_set_report(wacom->intf, 0x03, WAC_CMD_ICON_XFER,
 684                                           buf, 259, WAC_CMD_RETRIES);
 685                 if (retval < 0)
 686                         break;
 687         }
 688
 689         /* Send 'stop' */
 690         buf[0] = WAC_CMD_ICON_START;
 691         buf[1] = 0;
 692         wacom_set_report(wacom->intf, 0x03, WAC_CMD_ICON_START,
 693                          buf, 2, WAC_CMD_RETRIES);
 694
 695 out:
 696         kfree(buf);
 697         return retval;
 698 }
 699
 700 static ssize_t wacom_led_select_store(struct device *dev, int set_id,
 701                                       const char *buf, size_t count)
 702 {
 703         struct wacom *wacom = dev_get_drvdata(dev);
 704         unsigned int id;
 705         int err;
 706
 707         err = kstrtouint(buf, 10, &id);
 708         if (err)
 709                 return err;
 710
 711         mutex_lock(&wacom->lock);
 712
 713         wacom->led.select[set_id] = id & 0x3;
 714         err = wacom_led_control(wacom);
 715
 716         mutex_unlock(&wacom->lock);
 717
 718         return err < 0 ? err : count;
 719 }
 720
 721 #define DEVICE_LED_SELECT_ATTR(SET_ID)                                  \
 722 static ssize_t wacom_led##SET_ID##_select_store(struct device *dev,     \
 723         struct device_attribute *attr, const char *buf, size_t count)   \
 724 {                                                                       \
 725         return wacom_led_select_store(dev, SET_ID, buf, count);         \
 726 }                                                                       \
 727 static ssize_t wacom_led##SET_ID##_select_show(struct device *dev,      \
 728         struct device_attribute *attr, char *buf)                       \
 729 {                                                                       \
 730         struct wacom *wacom = dev_get_drvdata(dev);                     \
 731         return snprintf(buf, 2, "%d\n", wacom->led.select[SET_ID]);     \
 732 }                                                                       \
 733 static DEVICE_ATTR(status_led##SET_ID##_select, S_IWUSR | S_IRUSR,      \
 734                     wacom_led##SET_ID##_select_show,                    \
 735                     wacom_led##SET_ID##_select_store)
 736
 737 DEVICE_LED_SELECT_ATTR(0);
 738 DEVICE_LED_SELECT_ATTR(1);
 739
 740 static ssize_t wacom_luminance_store(struct wacom *wacom, u8 *dest,
 741                                      const char *buf, size_t count)
 742 {
 743         unsigned int value;
 744         int err;
 745
 746         err = kstrtouint(buf, 10, &value);
 747         if (err)
 748                 return err;
 749
 750         mutex_lock(&wacom->lock);
 751
 752         *dest = value & 0x7f;
 753         err = wacom_led_control(wacom);
 754
 755         mutex_unlock(&wacom->lock);
 756
 757         return err < 0 ? err : count;
 758 }
 759
 760 #define DEVICE_LUMINANCE_ATTR(name, field)                              \
 761 static ssize_t wacom_##name##_luminance_store(struct device *dev,       \
 762         struct device_attribute *attr, const char *buf, size_t count)   \
 763 {                                                                       \
 764         struct wacom *wacom = dev_get_drvdata(dev);                     \
 765                                                                         \
 766         return wacom_luminance_store(wacom, &wacom->led.field,          \
 767                                      buf, count);                       \
 768 }                                                                       \
 769 static DEVICE_ATTR(name##_luminance, S_IWUSR,                           \
 770                    NULL, wacom_##name##_luminance_store)
 771
 772 DEVICE_LUMINANCE_ATTR(status0, llv);
 773 DEVICE_LUMINANCE_ATTR(status1, hlv);
 774 DEVICE_LUMINANCE_ATTR(buttons, img_lum);
 775
 776 static ssize_t wacom_button_image_store(struct device *dev, int button_id,
 777                                         const char *buf, size_t count)
 778 {
 779         struct wacom *wacom = dev_get_drvdata(dev);
 780         int err;
 781
 782         if (count != 1024)
 783                 return -EINVAL;
 784
 785         mutex_lock(&wacom->lock);
 786
 787         err = wacom_led_putimage(wacom, button_id, buf);
 788
 789         mutex_unlock(&wacom->lock);
 790
 791         return err < 0 ? err : count;
 792 }
 793
 794 #define DEVICE_BTNIMG_ATTR(BUTTON_ID)                                   \
 795 static ssize_t wacom_btnimg##BUTTON_ID##_store(struct device *dev,      \
 796         struct device_attribute *attr, const char *buf, size_t count)   \
 797 {                                                                       \
 798         return wacom_button_image_store(dev, BUTTON_ID, buf, count);    \
 799 }                                                                       \
 800 static DEVICE_ATTR(button##BUTTON_ID##_rawimg, S_IWUSR,                 \
 801                    NULL, wacom_btnimg##BUTTON_ID##_store)
 802
 803 DEVICE_BTNIMG_ATTR(0);
 804 DEVICE_BTNIMG_ATTR(1);
 805 DEVICE_BTNIMG_ATTR(2);
 806 DEVICE_BTNIMG_ATTR(3);
 807 DEVICE_BTNIMG_ATTR(4);
 808 DEVICE_BTNIMG_ATTR(5);
 809 DEVICE_BTNIMG_ATTR(6);
 810 DEVICE_BTNIMG_ATTR(7);
 811
 812 static struct attribute *cintiq_led_attrs[] = {
 813         &dev_attr_status_led0_select.attr,
 814         &dev_attr_status_led1_select.attr,
 815         NULL
 816 };
 817
 818 static struct attribute_group cintiq_led_attr_group = {
 819         .name = "wacom_led",
 820         .attrs = cintiq_led_attrs,
 821 };
 822
 823 static struct attribute *intuos4_led_attrs[] = {
 824         &dev_attr_status0_luminance.attr,
 825         &dev_attr_status1_luminance.attr,
 826         &dev_attr_status_led0_select.attr,
 827         &dev_attr_buttons_luminance.attr,
 828         &dev_attr_button0_rawimg.attr,
 829         &dev_attr_button1_rawimg.attr,
 830         &dev_attr_button2_rawimg.attr,
 831         &dev_attr_button3_rawimg.attr,
 832         &dev_attr_button4_rawimg.attr,
 833         &dev_attr_button5_rawimg.attr,
 834         &dev_attr_button6_rawimg.attr,
 835         &dev_attr_button7_rawimg.attr,
 836         NULL
 837 };
 838
 839 static struct attribute_group intuos4_led_attr_group = {
 840         .name = "wacom_led",
 841         .attrs = intuos4_led_attrs,
 842 };
 843
 844 static struct attribute *intuos5_led_attrs[] = {
 845         &dev_attr_status0_luminance.attr,
 846         &dev_attr_status_led0_select.attr,
 847         NULL
 848 };
 849
 850 static struct attribute_group intuos5_led_attr_group = {
 851         .name = "wacom_led",
 852         .attrs = intuos5_led_attrs,
 853 };
 854
 855 static int wacom_initialize_leds(struct wacom *wacom)
 856 {
 857         int error;
 858
 859         /* Initialize default values */
 860         switch (wacom->wacom_wac.features.type) {
 861         case INTUOS4:
 862         case INTUOS4L:
 863                 wacom->led.select[0] = 0;
 864                 wacom->led.select[1] = 0;
 865                 wacom->led.llv = 10;
 866                 wacom->led.hlv = 20;
 867                 wacom->led.img_lum = 10;
 868                 error = sysfs_create_group(&wacom->intf->dev.kobj,
 869                                            &intuos4_led_attr_group);
 870                 break;
 871
 872         case WACOM_24HD:
 873         case WACOM_21UX2:
 874                 wacom->led.select[0] = 0;
 875                 wacom->led.select[1] = 0;
 876                 wacom->led.llv = 0;
 877                 wacom->led.hlv = 0;
 878                 wacom->led.img_lum = 0;
 879
 880                 error = sysfs_create_group(&wacom->intf->dev.kobj,
 881                                            &cintiq_led_attr_group);
 882                 break;
 883
 884         case INTUOS5S:
 885         case INTUOS5:
 886         case INTUOS5L:
 887                 wacom->led.select[0] = 0;
 888                 wacom->led.select[1] = 0;
 889                 wacom->led.llv = 32;
 890                 wacom->led.hlv = 0;
 891                 wacom->led.img_lum = 0;
 892
 893                 error = sysfs_create_group(&wacom->intf->dev.kobj,
 894                                            &intuos5_led_attr_group);
 895                 break;
 896
 897         default:
 898                 return 0;
 899         }
 900
 901         if (error) {
 902                 dev_err(&wacom->intf->dev,
 903                         "cannot create sysfs group err: %d\n", error);
 904                 return error;
 905         }
 906         wacom_led_control(wacom);
 907
 908         return 0;
 909 }
 910
 911 static void wacom_destroy_leds(struct wacom *wacom)
 912 {
 913         switch (wacom->wacom_wac.features.type) {
 914         case INTUOS4:
 915         case INTUOS4L:
 916                 sysfs_remove_group(&wacom->intf->dev.kobj,
 917                                    &intuos4_led_attr_group);
 918                 break;
 919
 920         case WACOM_24HD:
 921         case WACOM_21UX2:
 922                 sysfs_remove_group(&wacom->intf->dev.kobj,
 923                                    &cintiq_led_attr_group);
 924                 break;
 925
 926         case INTUOS5S:
 927         case INTUOS5:
 928         case INTUOS5L:
 929                 sysfs_remove_group(&wacom->intf->dev.kobj,
 930                                    &intuos5_led_attr_group);
 931                 break;
 932         }
 933 }
 934
 935 static enum power_supply_property wacom_battery_props[] = {
 936         POWER_SUPPLY_PROP_CAPACITY
 937 };
 938
 939 static int wacom_battery_get_property(struct power_supply *psy,
 940                                       enum power_supply_property psp,
 941                                       union power_supply_propval *val)
 942 {
 943         struct wacom *wacom = container_of(psy, struct wacom, battery);
 944         int ret = 0;
 945
 946         switch (psp) {
 947                 case POWER_SUPPLY_PROP_CAPACITY:
 948                         val->intval =
 949                                 wacom->wacom_wac.battery_capacity * 100 / 31;
 950                         break;
 951                 default:
 952                         ret = -EINVAL;
 953                         break;
 954         }
 955
 956         return ret;
 957 }
 958
 959 static int wacom_initialize_battery(struct wacom *wacom)
 960 {
 961         int error = 0;
 962
 963         if (wacom->wacom_wac.features.quirks & WACOM_QUIRK_MONITOR) {
 964                 wacom->battery.properties = wacom_battery_props;
 965                 wacom->battery.num_properties = ARRAY_SIZE(wacom_battery_props);
 966                 wacom->battery.get_property = wacom_battery_get_property;
 967                 wacom->battery.name = "wacom_battery";
 968                 wacom->battery.type = POWER_SUPPLY_TYPE_BATTERY;
 969                 wacom->battery.use_for_apm = 0;
 970
 971                 error = power_supply_register(&wacom->usbdev->dev,
 972                                               &wacom->battery);
 973         }
 974
 975         return error;
 976 }
 977
 978 static void wacom_destroy_battery(struct wacom *wacom)
 979 {
 980         if (wacom->wacom_wac.features.quirks & WACOM_QUIRK_MONITOR)
 981                 power_supply_unregister(&wacom->battery);
 982 }
 983
 984 static int wacom_register_input(struct wacom *wacom)
 985 {
 986         struct input_dev *input_dev;
 987         struct usb_interface *intf = wacom->intf;
 988         struct usb_device *dev = interface_to_usbdev(intf);
 989         struct wacom_wac *wacom_wac = &(wacom->wacom_wac);
 990         int error;
 991
 992         input_dev = input_allocate_device();
 993         if (!input_dev) {
 994                 error = -ENOMEM;
 995                 goto fail1;
 996         }
 997
 998         input_dev->name = wacom_wac->name;
 999         input_dev->dev.parent = &intf->dev;
1000         input_dev->open = wacom_open;
1001         input_dev->close = wacom_close;
1002         usb_to_input_id(dev, &input_dev->id);
1003         input_set_drvdata(input_dev, wacom);
1004
1005         wacom_wac->input = input_dev;
1006         error = wacom_setup_input_capabilities(input_dev, wacom_wac);
1007         if (error)
1008                 goto fail1;
1009
1010         error = input_register_device(input_dev);
1011         if (error)
1012                 goto fail2;
1013
1014         return 0;
1015
1016 fail2:
1017         input_free_device(input_dev);
1018         wacom_wac->input = NULL;
1019 fail1:
1020         return error;
1021 }
1022
1023 static void wacom_wireless_work(struct work_struct *work)
1024 {
1025         struct wacom *wacom = container_of(work, struct wacom, work);
1026         struct usb_device *usbdev = wacom->usbdev;
1027         struct wacom_wac *wacom_wac = &wacom->wacom_wac;
1028
1029         /*
1030          * Regardless if this is a disconnect or a new tablet,
1031          * remove any existing input devices.
1032          */
1033
1034         /* Stylus interface */
1035         wacom = usb_get_intfdata(usbdev->config->interface[1]);
1036         if (wacom->wacom_wac.input)
1037                 input_unregister_device(wacom->wacom_wac.input);
1038         wacom->wacom_wac.input = NULL;
1039
1040         /* Touch interface */
1041         wacom = usb_get_intfdata(usbdev->config->interface[2]);
1042         if (wacom->wacom_wac.input)
1043                 input_unregister_device(wacom->wacom_wac.input);
1044         wacom->wacom_wac.input = NULL;
1045
1046         if (wacom_wac->pid == 0) {
1047                 dev_info(&wacom->intf->dev, "wireless tablet disconnected\n");
1048         } else {
1049                 const struct usb_device_id *id = wacom_ids;
1050
1051                 dev_info(&wacom->intf->dev,
1052                          "wireless tablet connected with PID %x\n",
1053                          wacom_wac->pid);
1054
1055                 while (id->match_flags) {
1056                         if (id->idVendor == USB_VENDOR_ID_WACOM &&
1057                             id->idProduct == wacom_wac->pid)
1058                                 break;
1059                         id++;
1060                 }
1061
1062                 if (!id->match_flags) {
1063                         dev_info(&wacom->intf->dev,
1064                                  "ignoring unknown PID.\n");
1065                         return;
1066                 }
1067
1068                 /* Stylus interface */
1069                 wacom = usb_get_intfdata(usbdev->config->interface[1]);
1070                 wacom_wac = &wacom->wacom_wac;
1071                 wacom_wac->features =
1072                         *((struct wacom_features *)id->driver_info);
1073                 wacom_wac->features.device_type = BTN_TOOL_PEN;
1074                 wacom_register_input(wacom);
1075
1076                 /* Touch interface */
1077                 wacom = usb_get_intfdata(usbdev->config->interface[2]);
1078                 wacom_wac = &wacom->wacom_wac;
1079                 wacom_wac->features =
1080                         *((struct wacom_features *)id->driver_info);
1081                 wacom_wac->features.pktlen = WACOM_PKGLEN_BBTOUCH3;
1082                 wacom_wac->features.device_type = BTN_TOOL_FINGER;
1083                 wacom_set_phy_from_res(&wacom_wac->features);
1084                 wacom_wac->features.x_max = wacom_wac->features.y_max = 4096;
1085                 wacom_register_input(wacom);
1086         }
1087 }
1088
1089 static int wacom_probe(struct usb_interface *intf, const struct usb_device_id *id)
1090 {
1091         struct usb_device *dev = interface_to_usbdev(intf);
1092         struct usb_endpoint_descriptor *endpoint;
1093         struct wacom *wacom;
1094         struct wacom_wac *wacom_wac;
1095         struct wacom_features *features;
1096         int error;
1097
1098         if (!id->driver_info)
1099                 return -EINVAL;
1100
1101         wacom = kzalloc(sizeof(struct wacom), GFP_KERNEL);
1102         if (!wacom)
1103                 return -ENOMEM;
1104
1105         wacom_wac = &wacom->wacom_wac;
1106         wacom_wac->features = *((struct wacom_features *)id->driver_info);
1107         features = &wacom_wac->features;
1108         if (features->pktlen > WACOM_PKGLEN_MAX) {
1109                 error = -EINVAL;
1110                 goto fail1;
1111         }
1112
1113         wacom_wac->data = usb_alloc_coherent(dev, WACOM_PKGLEN_MAX,
1114                                              GFP_KERNEL, &wacom->data_dma);
1115         if (!wacom_wac->data) {
1116                 error = -ENOMEM;
1117                 goto fail1;
1118         }
1119
1120         wacom->irq = usb_alloc_urb(0, GFP_KERNEL);
1121         if (!wacom->irq) {
1122                 error = -ENOMEM;
1123                 goto fail2;
1124         }
1125
1126         wacom->usbdev = dev;
1127         wacom->intf = intf;
1128         mutex_init(&wacom->lock);
1129         INIT_WORK(&wacom->work, wacom_wireless_work);
1130         usb_make_path(dev, wacom->phys, sizeof(wacom->phys));
1131         strlcat(wacom->phys, "/input0", sizeof(wacom->phys));
1132
1133         endpoint = &intf->cur_altsetting->endpoint[0].desc;
1134
1135         /* Retrieve the physical and logical size for touch devices */
1136         error = wacom_retrieve_hid_descriptor(intf, features);
1137         if (error)
1138                 goto fail3;
1139
1140         /*
1141          * Intuos5 has no useful data about its touch interface in its
1142          * HID descriptor. If this is the touch interface (wMaxPacketSize
1143          * of WACOM_PKGLEN_BBTOUCH3), override the table values.
1144          */
1145         if (features->type >= INTUOS5S && features->type <= INTUOS5L) {
1146                 if (endpoint->wMaxPacketSize == WACOM_PKGLEN_BBTOUCH3) {
1147                         features->device_type = BTN_TOOL_FINGER;
1148                         features->pktlen = WACOM_PKGLEN_BBTOUCH3;
1149
1150                         features->x_phy =
1151                                 (features->x_max * 100) / features->x_resolution;
1152                         features->y_phy =
1153                                 (features->y_max * 100) / features->y_resolution;
1154
1155                         features->x_max = 4096;
1156                         features->y_max = 4096;
1157                 } else {
1158                         features->device_type = BTN_TOOL_PEN;
1159                 }
1160         }
1161
1162         wacom_setup_device_quirks(features);
1163
1164         strlcpy(wacom_wac->name, features->name, sizeof(wacom_wac->name));
1165
1166         if (features->quirks & WACOM_QUIRK_MULTI_INPUT) {
1167                 /* Append the device type to the name */
1168                 strlcat(wacom_wac->name,
1169                         features->device_type == BTN_TOOL_PEN ?
1170                                 " Pen" : " Finger",
1171                         sizeof(wacom_wac->name));
1172
1173                 error = wacom_add_shared_data(wacom_wac, dev);
1174                 if (error)
1175                         goto fail3;
1176         }
1177
1178         usb_fill_int_urb(wacom->irq, dev,
1179                          usb_rcvintpipe(dev, endpoint->bEndpointAddress),
1180                          wacom_wac->data, features->pktlen,
1181                          wacom_sys_irq, wacom, endpoint->bInterval);
1182         wacom->irq->transfer_dma = wacom->data_dma;
1183         wacom->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
1184
1185         error = wacom_initialize_leds(wacom);
1186         if (error)
1187                 goto fail4;
1188
1189         error = wacom_initialize_battery(wacom);
1190         if (error)
1191                 goto fail5;
1192
1193         if (!(features->quirks & WACOM_QUIRK_NO_INPUT)) {
1194                 error = wacom_register_input(wacom);
1195                 if (error)
1196                         goto fail6;
1197         }
1198
1199         /* Note that if query fails it is not a hard failure */
1200         wacom_query_tablet_data(intf, features);
1201
1202         usb_set_intfdata(intf, wacom);
1203
1204         if (features->quirks & WACOM_QUIRK_MONITOR) {
1205                 if (usb_submit_urb(wacom->irq, GFP_KERNEL))
1206                         goto fail5;
1207         }
1208
1209         return 0;
1210
1211  fail6: wacom_destroy_battery(wacom);
1212  fail5: wacom_destroy_leds(wacom);
1213  fail4: wacom_remove_shared_data(wacom_wac);
1214  fail3: usb_free_urb(wacom->irq);
1215  fail2: usb_free_coherent(dev, WACOM_PKGLEN_MAX, wacom_wac->data, wacom->data_dma);
1216  fail1: kfree(wacom);
1217         return error;
1218 }
1219
1220 static void wacom_disconnect(struct usb_interface *intf)
1221 {
1222         struct wacom *wacom = usb_get_intfdata(intf);
1223
1224         usb_set_intfdata(intf, NULL);
1225
1226         usb_kill_urb(wacom->irq);
1227         cancel_work_sync(&wacom->work);
1228         if (wacom->wacom_wac.input)
1229                 input_unregister_device(wacom->wacom_wac.input);
1230         wacom_destroy_battery(wacom);
1231         wacom_destroy_leds(wacom);
1232         usb_free_urb(wacom->irq);
1233         usb_free_coherent(interface_to_usbdev(intf), WACOM_PKGLEN_MAX,
1234                         wacom->wacom_wac.data, wacom->data_dma);
1235         wacom_remove_shared_data(&wacom->wacom_wac);
1236         kfree(wacom);
1237 }
1238
1239 static int wacom_suspend(struct usb_interface *intf, pm_message_t message)
1240 {
1241         struct wacom *wacom = usb_get_intfdata(intf);
1242
1243         mutex_lock(&wacom->lock);
1244         usb_kill_urb(wacom->irq);
1245         mutex_unlock(&wacom->lock);
1246
1247         return 0;
1248 }
1249
1250 static int wacom_resume(struct usb_interface *intf)
1251 {
1252         struct wacom *wacom = usb_get_intfdata(intf);
1253         struct wacom_features *features = &wacom->wacom_wac.features;
1254         int rv = 0;
1255
1256         mutex_lock(&wacom->lock);
1257
1258         /* switch to wacom mode first */
1259         wacom_query_tablet_data(intf, features);
1260         wacom_led_control(wacom);
1261
1262         if ((wacom->open || features->quirks & WACOM_QUIRK_MONITOR)
1263              && usb_submit_urb(wacom->irq, GFP_NOIO) < 0)
1264                 rv = -EIO;
1265
1266         mutex_unlock(&wacom->lock);
1267
1268         return rv;
1269 }
1270
1271 static int wacom_reset_resume(struct usb_interface *intf)
1272 {
1273         return wacom_resume(intf);
1274 }
1275
1276 static struct usb_driver wacom_driver = {
1277         .name =         "wacom",
1278         .id_table =     wacom_ids,
1279         .probe =        wacom_probe,
1280         .disconnect =   wacom_disconnect,
1281         .suspend =      wacom_suspend,
1282         .resume =       wacom_resume,
1283         .reset_resume = wacom_reset_resume,
1284         .supports_autosuspend = 1,
1285 };
1286
1287 module_usb_driver(wacom_driver);