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_COLLECTION                  0xc0
  32
  33 enum {
  34         WCM_UNDEFINED = 0,
  35         WCM_DESKTOP,
  36         WCM_DIGITIZER,
  37 };
  38
  39 struct hid_descriptor {
  40         struct usb_descriptor_header header;
  41         __le16   bcdHID;
  42         u8       bCountryCode;
  43         u8       bNumDescriptors;
  44         u8       bDescriptorType;
  45         __le16   wDescriptorLength;
  46 } __attribute__ ((packed));
  47
  48 /* defines to get/set USB message */
  49 #define USB_REQ_GET_REPORT      0x01
  50 #define USB_REQ_SET_REPORT      0x09
  51 #define WAC_HID_FEATURE_REPORT  0x03
  52 #define WAC_MSG_RETRIES         5
  53
  54 static int usb_get_report(struct usb_interface *intf, unsigned char type,
  55                                 unsigned char id, void *buf, int size)
  56 {
  57         return usb_control_msg(interface_to_usbdev(intf),
  58                 usb_rcvctrlpipe(interface_to_usbdev(intf), 0),
  59                 USB_REQ_GET_REPORT, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  60                 (type << 8) + id, intf->altsetting[0].desc.bInterfaceNumber,
  61                 buf, size, 100);
  62 }
  63
  64 static int usb_set_report(struct usb_interface *intf, unsigned char type,
  65                                 unsigned char id, void *buf, int size)
  66 {
  67         return usb_control_msg(interface_to_usbdev(intf),
  68                 usb_sndctrlpipe(interface_to_usbdev(intf), 0),
  69                 USB_REQ_SET_REPORT, USB_TYPE_CLASS | USB_RECIP_INTERFACE,
  70                 (type << 8) + id, intf->altsetting[0].desc.bInterfaceNumber,
  71                 buf, size, 1000);
  72 }
  73
  74 static void wacom_sys_irq(struct urb *urb)
  75 {
  76         struct wacom *wacom = urb->context;
  77         int retval;
  78
  79         switch (urb->status) {
  80         case 0:
  81                 /* success */
  82                 break;
  83         case -ECONNRESET:
  84         case -ENOENT:
  85         case -ESHUTDOWN:
  86                 /* this urb is terminated, clean up */
  87                 dbg("%s - urb shutting down with status: %d", __func__, urb->status);
  88                 return;
  89         default:
  90                 dbg("%s - nonzero urb status received: %d", __func__, urb->status);
  91                 goto exit;
  92         }
  93
  94         wacom_wac_irq(&wacom->wacom_wac, urb->actual_length);
  95
  96  exit:
  97         usb_mark_last_busy(wacom->usbdev);
  98         retval = usb_submit_urb(urb, GFP_ATOMIC);
  99         if (retval)
 100                 err ("%s - usb_submit_urb failed with result %d",
 101                      __func__, retval);
 102 }
 103
 104 static int wacom_open(struct input_dev *dev)
 105 {
 106         struct wacom *wacom = input_get_drvdata(dev);
 107         int retval = 0;
 108
 109         if (usb_autopm_get_interface(wacom->intf) < 0)
 110                 return -EIO;
 111
 112         mutex_lock(&wacom->lock);
 113
 114         if (usb_submit_urb(wacom->irq, GFP_KERNEL)) {
 115                 retval = -EIO;
 116                 goto out;
 117         }
 118
 119         wacom->open = true;
 120         wacom->intf->needs_remote_wakeup = 1;
 121
 122 out:
 123         mutex_unlock(&wacom->lock);
 124         usb_autopm_put_interface(wacom->intf);
 125         return retval;
 126 }
 127
 128 static void wacom_close(struct input_dev *dev)
 129 {
 130         struct wacom *wacom = input_get_drvdata(dev);
 131         int autopm_error;
 132
 133         autopm_error = usb_autopm_get_interface(wacom->intf);
 134
 135         mutex_lock(&wacom->lock);
 136         usb_kill_urb(wacom->irq);
 137         wacom->open = false;
 138         wacom->intf->needs_remote_wakeup = 0;
 139         mutex_unlock(&wacom->lock);
 140
 141         if (!autopm_error)
 142                 usb_autopm_put_interface(wacom->intf);
 143 }
 144
 145 static int wacom_parse_hid(struct usb_interface *intf, struct hid_descriptor *hid_desc,
 146                            struct wacom_features *features)
 147 {
 148         struct usb_device *dev = interface_to_usbdev(intf);
 149         char limit = 0;
 150         /* result has to be defined as int for some devices */
 151         int result = 0;
 152         int i = 0, usage = WCM_UNDEFINED, finger = 0, pen = 0;
 153         unsigned char *report;
 154
 155         report = kzalloc(hid_desc->wDescriptorLength, GFP_KERNEL);
 156         if (!report)
 157                 return -ENOMEM;
 158
 159         /* retrive report descriptors */
 160         do {
 161                 result = usb_control_msg(dev, usb_rcvctrlpipe(dev, 0),
 162                         USB_REQ_GET_DESCRIPTOR,
 163                         USB_RECIP_INTERFACE | USB_DIR_IN,
 164                         HID_DEVICET_REPORT << 8,
 165                         intf->altsetting[0].desc.bInterfaceNumber, /* interface */
 166                         report,
 167                         hid_desc->wDescriptorLength,
 168                         5000); /* 5 secs */
 169         } while (result < 0 && limit++ < WAC_MSG_RETRIES);
 170
 171         /* No need to parse the Descriptor. It isn't an error though */
 172         if (result < 0)
 173                 goto out;
 174
 175         for (i = 0; i < hid_desc->wDescriptorLength; i++) {
 176
 177                 switch (report[i]) {
 178                 case HID_USAGE_PAGE:
 179                         switch (report[i + 1]) {
 180                         case HID_USAGE_PAGE_DIGITIZER:
 181                                 usage = WCM_DIGITIZER;
 182                                 i++;
 183                                 break;
 184
 185                         case HID_USAGE_PAGE_DESKTOP:
 186                                 usage = WCM_DESKTOP;
 187                                 i++;
 188                                 break;
 189                         }
 190                         break;
 191
 192                 case HID_USAGE:
 193                         switch (report[i + 1]) {
 194                         case HID_USAGE_X:
 195                                 if (usage == WCM_DESKTOP) {
 196                                         if (finger) {
 197                                                 features->device_type = BTN_TOOL_FINGER;
 198                                                 if (features->type == TABLETPC2FG) {
 199                                                         /* need to reset back */
 200                                                         features->pktlen = WACOM_PKGLEN_TPC2FG;
 201                                                         features->device_type = BTN_TOOL_DOUBLETAP;
 202                                                 }
 203                                                 if (features->type == BAMBOO_PT) {
 204                                                         /* need to reset back */
 205                                                         features->pktlen = WACOM_PKGLEN_BBTOUCH;
 206                                                         features->device_type = BTN_TOOL_DOUBLETAP;
 207                                                         features->x_phy =
 208                                                                 get_unaligned_le16(&report[i + 5]);
 209                                                         features->x_max =
 210                                                                 get_unaligned_le16(&report[i + 8]);
 211                                                         i += 15;
 212                                                 } else {
 213                                                         features->x_max =
 214                                                                 get_unaligned_le16(&report[i + 3]);
 215                                                         features->x_phy =
 216                                                                 get_unaligned_le16(&report[i + 6]);
 217                                                         features->unit = report[i + 9];
 218                                                         features->unitExpo = report[i + 11];
 219                                                         i += 12;
 220                                                 }
 221                                         } else if (pen) {
 222                                                 /* penabled only accepts exact bytes of data */
 223                                                 if (features->type == TABLETPC2FG)
 224                                                         features->pktlen = WACOM_PKGLEN_GRAPHIRE;
 225                                                 if (features->type == BAMBOO_PT)
 226                                                         features->pktlen = WACOM_PKGLEN_BBFUN;
 227                                                 features->device_type = BTN_TOOL_PEN;
 228                                                 features->x_max =
 229                                                         get_unaligned_le16(&report[i + 3]);
 230                                                 i += 4;
 231                                         }
 232                                 }
 233                                 break;
 234
 235                         case HID_USAGE_Y:
 236                                 if (usage == WCM_DESKTOP) {
 237                                         if (finger) {
 238                                                 features->device_type = BTN_TOOL_FINGER;
 239                                                 if (features->type == TABLETPC2FG) {
 240                                                         /* need to reset back */
 241                                                         features->pktlen = WACOM_PKGLEN_TPC2FG;
 242                                                         features->device_type = BTN_TOOL_DOUBLETAP;
 243                                                         features->y_max =
 244                                                                 get_unaligned_le16(&report[i + 3]);
 245                                                         features->y_phy =
 246                                                                 get_unaligned_le16(&report[i + 6]);
 247                                                         i += 7;
 248                                                 } else if (features->type == BAMBOO_PT) {
 249                                                         /* need to reset back */
 250                                                         features->pktlen = WACOM_PKGLEN_BBTOUCH;
 251                                                         features->device_type = BTN_TOOL_DOUBLETAP;
 252                                                         features->y_phy =
 253                                                                 get_unaligned_le16(&report[i + 3]);
 254                                                         features->y_max =
 255                                                                 get_unaligned_le16(&report[i + 6]);
 256                                                         i += 12;
 257                                                 } else {
 258                                                         features->y_max =
 259                                                                 features->x_max;
 260                                                         features->y_phy =
 261                                                                 get_unaligned_le16(&report[i + 3]);
 262                                                         i += 4;
 263                                                 }
 264                                         } else if (pen) {
 265                                                 /* penabled only accepts exact bytes of data */
 266                                                 if (features->type == TABLETPC2FG)
 267                                                         features->pktlen = WACOM_PKGLEN_GRAPHIRE;
 268                                                 if (features->type == BAMBOO_PT)
 269                                                         features->pktlen = WACOM_PKGLEN_BBFUN;
 270                                                 features->device_type = BTN_TOOL_PEN;
 271                                                 features->y_max =
 272                                                         get_unaligned_le16(&report[i + 3]);
 273                                                 i += 4;
 274                                         }
 275                                 }
 276                                 break;
 277
 278                         case HID_USAGE_FINGER:
 279                                 finger = 1;
 280                                 i++;
 281                                 break;
 282
 283                         case HID_USAGE_STYLUS:
 284                                 pen = 1;
 285                                 i++;
 286                                 break;
 287                         }
 288                         break;
 289
 290                 case HID_COLLECTION:
 291                         /* reset UsagePage and Finger */
 292                         finger = usage = 0;
 293                         break;
 294                 }
 295         }
 296
 297  out:
 298         result = 0;
 299         kfree(report);
 300         return result;
 301 }
 302
 303 static int wacom_query_tablet_data(struct usb_interface *intf, struct wacom_features *features)
 304 {
 305         unsigned char *rep_data;
 306         int limit = 0, report_id = 2;
 307         int error = -ENOMEM;
 308
 309         rep_data = kmalloc(4, GFP_KERNEL);
 310         if (!rep_data)
 311                 return error;
 312
 313         /* ask to report tablet data if it is MT Tablet PC or
 314          * not a Tablet PC */
 315         if (features->type == TABLETPC2FG) {
 316                 do {
 317                         rep_data[0] = 3;
 318                         rep_data[1] = 4;
 319                         rep_data[2] = 0;
 320                         rep_data[3] = 0;
 321                         report_id = 3;
 322                         error = usb_set_report(intf, WAC_HID_FEATURE_REPORT,
 323                                 report_id, rep_data, 4);
 324                         if (error >= 0)
 325                                 error = usb_get_report(intf,
 326                                         WAC_HID_FEATURE_REPORT, report_id,
 327                                         rep_data, 4);
 328                 } while ((error < 0 || rep_data[1] != 4) && limit++ < WAC_MSG_RETRIES);
 329         } else if (features->type != TABLETPC) {
 330                 do {
 331                         rep_data[0] = 2;
 332                         rep_data[1] = 2;
 333                         error = usb_set_report(intf, WAC_HID_FEATURE_REPORT,
 334                                 report_id, rep_data, 2);
 335                         if (error >= 0)
 336                                 error = usb_get_report(intf,
 337                                         WAC_HID_FEATURE_REPORT, report_id,
 338                                         rep_data, 2);
 339                 } while ((error < 0 || rep_data[1] != 2) && limit++ < WAC_MSG_RETRIES);
 340         }
 341
 342         kfree(rep_data);
 343
 344         return error < 0 ? error : 0;
 345 }
 346
 347 static int wacom_retrieve_hid_descriptor(struct usb_interface *intf,
 348                 struct wacom_features *features)
 349 {
 350         int error = 0;
 351         struct usb_host_interface *interface = intf->cur_altsetting;
 352         struct hid_descriptor *hid_desc;
 353
 354         /* default features */
 355         features->device_type = BTN_TOOL_PEN;
 356         features->x_fuzz = 4;
 357         features->y_fuzz = 4;
 358         features->pressure_fuzz = 0;
 359         features->distance_fuzz = 0;
 360
 361         /* only Tablet PCs and Bamboo P&T need to retrieve the info */
 362         if ((features->type != TABLETPC) && (features->type != TABLETPC2FG) &&
 363             (features->type != BAMBOO_PT))
 364                 goto out;
 365
 366         if (usb_get_extra_descriptor(interface, HID_DEVICET_HID, &hid_desc)) {
 367                 if (usb_get_extra_descriptor(&interface->endpoint[0],
 368                                 HID_DEVICET_REPORT, &hid_desc)) {
 369                         printk("wacom: can not retrieve extra class descriptor\n");
 370                         error = 1;
 371                         goto out;
 372                 }
 373         }
 374         error = wacom_parse_hid(intf, hid_desc, features);
 375         if (error)
 376                 goto out;
 377
 378  out:
 379         return error;
 380 }
 381
 382 struct wacom_usbdev_data {
 383         struct list_head list;
 384         struct kref kref;
 385         struct usb_device *dev;
 386         struct wacom_shared shared;
 387 };
 388
 389 static LIST_HEAD(wacom_udev_list);
 390 static DEFINE_MUTEX(wacom_udev_list_lock);
 391
 392 static struct wacom_usbdev_data *wacom_get_usbdev_data(struct usb_device *dev)
 393 {
 394         struct wacom_usbdev_data *data;
 395
 396         list_for_each_entry(data, &wacom_udev_list, list) {
 397                 if (data->dev == dev) {
 398                         kref_get(&data->kref);
 399                         return data;
 400                 }
 401         }
 402
 403         return NULL;
 404 }
 405
 406 static int wacom_add_shared_data(struct wacom_wac *wacom,
 407                                  struct usb_device *dev)
 408 {
 409         struct wacom_usbdev_data *data;
 410         int retval = 0;
 411
 412         mutex_lock(&wacom_udev_list_lock);
 413
 414         data = wacom_get_usbdev_data(dev);
 415         if (!data) {
 416                 data = kzalloc(sizeof(struct wacom_usbdev_data), GFP_KERNEL);
 417                 if (!data) {
 418                         retval = -ENOMEM;
 419                         goto out;
 420                 }
 421
 422                 kref_init(&data->kref);
 423                 data->dev = dev;
 424                 list_add_tail(&data->list, &wacom_udev_list);
 425         }
 426
 427         wacom->shared = &data->shared;
 428
 429 out:
 430         mutex_unlock(&wacom_udev_list_lock);
 431         return retval;
 432 }
 433
 434 static void wacom_release_shared_data(struct kref *kref)
 435 {
 436         struct wacom_usbdev_data *data =
 437                 container_of(kref, struct wacom_usbdev_data, kref);
 438
 439         mutex_lock(&wacom_udev_list_lock);
 440         list_del(&data->list);
 441         mutex_unlock(&wacom_udev_list_lock);
 442
 443         kfree(data);
 444 }
 445
 446 static void wacom_remove_shared_data(struct wacom_wac *wacom)
 447 {
 448         struct wacom_usbdev_data *data;
 449
 450         if (wacom->shared) {
 451                 data = container_of(wacom->shared, struct wacom_usbdev_data, shared);
 452                 kref_put(&data->kref, wacom_release_shared_data);
 453                 wacom->shared = NULL;
 454         }
 455 }
 456
 457 static int wacom_probe(struct usb_interface *intf, const struct usb_device_id *id)
 458 {
 459         struct usb_device *dev = interface_to_usbdev(intf);
 460         struct usb_endpoint_descriptor *endpoint;
 461         struct wacom *wacom;
 462         struct wacom_wac *wacom_wac;
 463         struct wacom_features *features;
 464         struct input_dev *input_dev;
 465         int error;
 466
 467         if (!id->driver_info)
 468                 return -EINVAL;
 469
 470         wacom = kzalloc(sizeof(struct wacom), GFP_KERNEL);
 471         input_dev = input_allocate_device();
 472         if (!wacom || !input_dev) {
 473                 error = -ENOMEM;
 474                 goto fail1;
 475         }
 476
 477         wacom_wac = &wacom->wacom_wac;
 478         wacom_wac->features = *((struct wacom_features *)id->driver_info);
 479         features = &wacom_wac->features;
 480         if (features->pktlen > WACOM_PKGLEN_MAX) {
 481                 error = -EINVAL;
 482                 goto fail1;
 483         }
 484
 485         wacom_wac->data = usb_alloc_coherent(dev, WACOM_PKGLEN_MAX,
 486                                              GFP_KERNEL, &wacom->data_dma);
 487         if (!wacom_wac->data) {
 488                 error = -ENOMEM;
 489                 goto fail1;
 490         }
 491
 492         wacom->irq = usb_alloc_urb(0, GFP_KERNEL);
 493         if (!wacom->irq) {
 494                 error = -ENOMEM;
 495                 goto fail2;
 496         }
 497
 498         wacom->usbdev = dev;
 499         wacom->intf = intf;
 500         mutex_init(&wacom->lock);
 501         usb_make_path(dev, wacom->phys, sizeof(wacom->phys));
 502         strlcat(wacom->phys, "/input0", sizeof(wacom->phys));
 503
 504         wacom_wac->input = input_dev;
 505
 506         endpoint = &intf->cur_altsetting->endpoint[0].desc;
 507
 508         /* Retrieve the physical and logical size for OEM devices */
 509         error = wacom_retrieve_hid_descriptor(intf, features);
 510         if (error)
 511                 goto fail3;
 512
 513         wacom_setup_device_quirks(features);
 514
 515         strlcpy(wacom_wac->name, features->name, sizeof(wacom_wac->name));
 516
 517         if (features->quirks & WACOM_QUIRK_MULTI_INPUT) {
 518                 /* Append the device type to the name */
 519                 strlcat(wacom_wac->name,
 520                         features->device_type == BTN_TOOL_PEN ?
 521                                 " Pen" : " Finger",
 522                         sizeof(wacom_wac->name));
 523
 524                 error = wacom_add_shared_data(wacom_wac, dev);
 525                 if (error)
 526                         goto fail3;
 527         }
 528
 529         input_dev->name = wacom_wac->name;
 530         input_dev->dev.parent = &intf->dev;
 531         input_dev->open = wacom_open;
 532         input_dev->close = wacom_close;
 533         usb_to_input_id(dev, &input_dev->id);
 534         input_set_drvdata(input_dev, wacom);
 535
 536         wacom_setup_input_capabilities(input_dev, wacom_wac);
 537
 538         usb_fill_int_urb(wacom->irq, dev,
 539                          usb_rcvintpipe(dev, endpoint->bEndpointAddress),
 540                          wacom_wac->data, features->pktlen,
 541                          wacom_sys_irq, wacom, endpoint->bInterval);
 542         wacom->irq->transfer_dma = wacom->data_dma;
 543         wacom->irq->transfer_flags |= URB_NO_TRANSFER_DMA_MAP;
 544
 545         error = input_register_device(input_dev);
 546         if (error)
 547                 goto fail4;
 548
 549         /* Note that if query fails it is not a hard failure */
 550         wacom_query_tablet_data(intf, features);
 551
 552         usb_set_intfdata(intf, wacom);
 553         return 0;
 554
 555  fail4: wacom_remove_shared_data(wacom_wac);
 556  fail3: usb_free_urb(wacom->irq);
 557  fail2: usb_free_coherent(dev, WACOM_PKGLEN_MAX, wacom_wac->data, wacom->data_dma);
 558  fail1: input_free_device(input_dev);
 559         kfree(wacom);
 560         return error;
 561 }
 562
 563 static void wacom_disconnect(struct usb_interface *intf)
 564 {
 565         struct wacom *wacom = usb_get_intfdata(intf);
 566
 567         usb_set_intfdata(intf, NULL);
 568
 569         usb_kill_urb(wacom->irq);
 570         input_unregister_device(wacom->wacom_wac.input);
 571         usb_free_urb(wacom->irq);
 572         usb_free_coherent(interface_to_usbdev(intf), WACOM_PKGLEN_MAX,
 573                         wacom->wacom_wac.data, wacom->data_dma);
 574         wacom_remove_shared_data(&wacom->wacom_wac);
 575         kfree(wacom);
 576 }
 577
 578 static int wacom_suspend(struct usb_interface *intf, pm_message_t message)
 579 {
 580         struct wacom *wacom = usb_get_intfdata(intf);
 581
 582         mutex_lock(&wacom->lock);
 583         usb_kill_urb(wacom->irq);
 584         mutex_unlock(&wacom->lock);
 585
 586         return 0;
 587 }
 588
 589 static int wacom_resume(struct usb_interface *intf)
 590 {
 591         struct wacom *wacom = usb_get_intfdata(intf);
 592         struct wacom_features *features = &wacom->wacom_wac.features;
 593         int rv;
 594
 595         mutex_lock(&wacom->lock);
 596
 597         /* switch to wacom mode first */
 598         wacom_query_tablet_data(intf, features);
 599
 600         if (wacom->open)
 601                 rv = usb_submit_urb(wacom->irq, GFP_NOIO);
 602         else
 603                 rv = 0;
 604
 605         mutex_unlock(&wacom->lock);
 606
 607         return rv;
 608 }
 609
 610 static int wacom_reset_resume(struct usb_interface *intf)
 611 {
 612         return wacom_resume(intf);
 613 }
 614
 615 static struct usb_driver wacom_driver = {
 616         .name =         "wacom",
 617         .id_table =     wacom_ids,
 618         .probe =        wacom_probe,
 619         .disconnect =   wacom_disconnect,
 620         .suspend =      wacom_suspend,
 621         .resume =       wacom_resume,
 622         .reset_resume = wacom_reset_resume,
 623         .supports_autosuspend = 1,
 624 };
 625
 626 static int __init wacom_init(void)
 627 {
 628         int result;
 629
 630         result = usb_register(&wacom_driver);
 631         if (result == 0)
 632                 printk(KERN_INFO KBUILD_MODNAME ": " DRIVER_VERSION ":"
 633                        DRIVER_DESC "\n");
 634         return result;
 635 }
 636
 637 static void __exit wacom_exit(void)
 638 {
 639         usb_deregister(&wacom_driver);
 640 }
 641
 642 module_init(wacom_init);
 643 module_exit(wacom_exit);