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