drivers/hid/hid-kye.c

   1 /*
   2  *  HID driver for Kye/Genius devices not fully compliant with HID standard
   3  *
   4  *  Copyright (c) 2009 Jiri Kosina
   5  *  Copyright (c) 2009 Tomas Hanak
   6  *  Copyright (c) 2012 Nikolai Kondrashov
   7  */
   8
   9 /*
  10  * This program is free software; you can redistribute it and/or modify it
  11  * under the terms of the GNU General Public License as published by the Free
  12  * Software Foundation; either version 2 of the License, or (at your option)
  13  * any later version.
  14  */
  15
  16 #include <linux/device.h>
  17 #include <linux/hid.h>
  18 #include <linux/module.h>
  19
  20 #include "hid-ids.h"
  21
  22 /*
  23  * See EasyPen i405X description, device and HID report descriptors at
  24  * http://sf.net/apps/mediawiki/digimend/?title=KYE_EasyPen_i405X
  25  */
  26
  27 /* Original EasyPen i405X report descriptor size */
  28 #define EASYPEN_I405X_RDESC_ORIG_SIZE   476
  29
  30 /* Fixed EasyPen i405X report descriptor */
  31 static __u8 easypen_i405x_rdesc_fixed[] = {
  32         0x06, 0x00, 0xFF, /*  Usage Page (FF00h),             */
  33         0x09, 0x01,       /*  Usage (01h),                    */
  34         0xA1, 0x01,       /*  Collection (Application),       */
  35         0x85, 0x05,       /*    Report ID (5),                */
  36         0x09, 0x01,       /*    Usage (01h),                  */
  37         0x15, 0x80,       /*    Logical Minimum (-128),       */
  38         0x25, 0x7F,       /*    Logical Maximum (127),        */
  39         0x75, 0x08,       /*    Report Size (8),              */
  40         0x95, 0x07,       /*    Report Count (7),             */
  41         0xB1, 0x02,       /*    Feature (Variable),           */
  42         0xC0,             /*  End Collection,                 */
  43         0x05, 0x0D,       /*  Usage Page (Digitizer),         */
  44         0x09, 0x02,       /*  Usage (Pen),                    */
  45         0xA1, 0x01,       /*  Collection (Application),       */
  46         0x85, 0x10,       /*    Report ID (16),               */
  47         0x09, 0x20,       /*    Usage (Stylus),               */
  48         0xA0,             /*    Collection (Physical),        */
  49         0x14,             /*      Logical Minimum (0),        */
  50         0x25, 0x01,       /*      Logical Maximum (1),        */
  51         0x75, 0x01,       /*      Report Size (1),            */
  52         0x09, 0x42,       /*      Usage (Tip Switch),         */
  53         0x09, 0x44,       /*      Usage (Barrel Switch),      */
  54         0x09, 0x46,       /*      Usage (Tablet Pick),        */
  55         0x95, 0x03,       /*      Report Count (3),           */
  56         0x81, 0x02,       /*      Input (Variable),           */
  57         0x95, 0x04,       /*      Report Count (4),           */
  58         0x81, 0x03,       /*      Input (Constant, Variable), */
  59         0x09, 0x32,       /*      Usage (In Range),           */
  60         0x95, 0x01,       /*      Report Count (1),           */
  61         0x81, 0x02,       /*      Input (Variable),           */
  62         0x75, 0x10,       /*      Report Size (16),           */
  63         0x95, 0x01,       /*      Report Count (1),           */
  64         0xA4,             /*      Push,                       */
  65         0x05, 0x01,       /*      Usage Page (Desktop),       */
  66         0x55, 0xFD,       /*      Unit Exponent (-3),         */
  67         0x65, 0x13,       /*      Unit (Inch),                */
  68         0x34,             /*      Physical Minimum (0),       */
  69         0x09, 0x30,       /*      Usage (X),                  */
  70         0x46, 0x7C, 0x15, /*      Physical Maximum (5500),    */
  71         0x26, 0x00, 0x37, /*      Logical Maximum (14080),    */
  72         0x81, 0x02,       /*      Input (Variable),           */
  73         0x09, 0x31,       /*      Usage (Y),                  */
  74         0x46, 0xA0, 0x0F, /*      Physical Maximum (4000),    */
  75         0x26, 0x00, 0x28, /*      Logical Maximum (10240),    */
  76         0x81, 0x02,       /*      Input (Variable),           */
  77         0xB4,             /*      Pop,                        */
  78         0x09, 0x30,       /*      Usage (Tip Pressure),       */
  79         0x26, 0xFF, 0x03, /*      Logical Maximum (1023),     */
  80         0x81, 0x02,       /*      Input (Variable),           */
  81         0xC0,             /*    End Collection,               */
  82         0xC0              /*  End Collection                  */
  83 };
  84
  85 /*
  86  * See MousePen i608X description, device and HID report descriptors at
  87  * http://sf.net/apps/mediawiki/digimend/?title=KYE_MousePen_i608X
  88  */
  89
  90 /* Original MousePen i608X report descriptor size */
  91 #define MOUSEPEN_I608X_RDESC_ORIG_SIZE  476
  92
  93 /* Fixed MousePen i608X report descriptor */
  94 static __u8 mousepen_i608x_rdesc_fixed[] = {
  95         0x06, 0x00, 0xFF, /*  Usage Page (FF00h),             */
  96         0x09, 0x01,       /*  Usage (01h),                    */
  97         0xA1, 0x01,       /*  Collection (Application),       */
  98         0x85, 0x05,       /*    Report ID (5),                */
  99         0x09, 0x01,       /*    Usage (01h),                  */
 100         0x15, 0x80,       /*    Logical Minimum (-128),       */
 101         0x25, 0x7F,       /*    Logical Maximum (127),        */
 102         0x75, 0x08,       /*    Report Size (8),              */
 103         0x95, 0x07,       /*    Report Count (7),             */
 104         0xB1, 0x02,       /*    Feature (Variable),           */
 105         0xC0,             /*  End Collection,                 */
 106         0x05, 0x0D,       /*  Usage Page (Digitizer),         */
 107         0x09, 0x02,       /*  Usage (Pen),                    */
 108         0xA1, 0x01,       /*  Collection (Application),       */
 109         0x85, 0x10,       /*    Report ID (16),               */
 110         0x09, 0x20,       /*    Usage (Stylus),               */
 111         0xA0,             /*    Collection (Physical),        */
 112         0x14,             /*      Logical Minimum (0),        */
 113         0x25, 0x01,       /*      Logical Maximum (1),        */
 114         0x75, 0x01,       /*      Report Size (1),            */
 115         0x09, 0x42,       /*      Usage (Tip Switch),         */
 116         0x09, 0x44,       /*      Usage (Barrel Switch),      */
 117         0x09, 0x46,       /*      Usage (Tablet Pick),        */
 118         0x95, 0x03,       /*      Report Count (3),           */
 119         0x81, 0x02,       /*      Input (Variable),           */
 120         0x95, 0x04,       /*      Report Count (4),           */
 121         0x81, 0x03,       /*      Input (Constant, Variable), */
 122         0x09, 0x32,       /*      Usage (In Range),           */
 123         0x95, 0x01,       /*      Report Count (1),           */
 124         0x81, 0x02,       /*      Input (Variable),           */
 125         0x75, 0x10,       /*      Report Size (16),           */
 126         0x95, 0x01,       /*      Report Count (1),           */
 127         0xA4,             /*      Push,                       */
 128         0x05, 0x01,       /*      Usage Page (Desktop),       */
 129         0x55, 0xFD,       /*      Unit Exponent (-3),         */
 130         0x65, 0x13,       /*      Unit (Inch),                */
 131         0x34,             /*      Physical Minimum (0),       */
 132         0x09, 0x30,       /*      Usage (X),                  */
 133         0x46, 0x40, 0x1F, /*      Physical Maximum (8000),    */
 134         0x26, 0x00, 0x50, /*      Logical Maximum (20480),    */
 135         0x81, 0x02,       /*      Input (Variable),           */
 136         0x09, 0x31,       /*      Usage (Y),                  */
 137         0x46, 0x70, 0x17, /*      Physical Maximum (6000),    */
 138         0x26, 0x00, 0x3C, /*      Logical Maximum (15360),    */
 139         0x81, 0x02,       /*      Input (Variable),           */
 140         0xB4,             /*      Pop,                        */
 141         0x09, 0x30,       /*      Usage (Tip Pressure),       */
 142         0x26, 0xFF, 0x03, /*      Logical Maximum (1023),     */
 143         0x81, 0x02,       /*      Input (Variable),           */
 144         0xC0,             /*    End Collection,               */
 145         0xC0,             /*  End Collection,                 */
 146         0x05, 0x01,       /*  Usage Page (Desktop),           */
 147         0x09, 0x02,       /*  Usage (Mouse),                  */
 148         0xA1, 0x01,       /*  Collection (Application),       */
 149         0x85, 0x11,       /*    Report ID (17),               */
 150         0x09, 0x01,       /*    Usage (Pointer),              */
 151         0xA0,             /*    Collection (Physical),        */
 152         0x14,             /*      Logical Minimum (0),        */
 153         0xA4,             /*      Push,                       */
 154         0x05, 0x09,       /*      Usage Page (Button),        */
 155         0x75, 0x01,       /*      Report Size (1),            */
 156         0x19, 0x01,       /*      Usage Minimum (01h),        */
 157         0x29, 0x03,       /*      Usage Maximum (03h),        */
 158         0x25, 0x01,       /*      Logical Maximum (1),        */
 159         0x95, 0x03,       /*      Report Count (3),           */
 160         0x81, 0x02,       /*      Input (Variable),           */
 161         0x95, 0x05,       /*      Report Count (5),           */
 162         0x81, 0x01,       /*      Input (Constant),           */
 163         0xB4,             /*      Pop,                        */
 164         0x95, 0x01,       /*      Report Count (1),           */
 165         0xA4,             /*      Push,                       */
 166         0x55, 0xFD,       /*      Unit Exponent (-3),         */
 167         0x65, 0x13,       /*      Unit (Inch),                */
 168         0x34,             /*      Physical Minimum (0),       */
 169         0x75, 0x10,       /*      Report Size (16),           */
 170         0x09, 0x30,       /*      Usage (X),                  */
 171         0x46, 0x40, 0x1F, /*      Physical Maximum (8000),    */
 172         0x26, 0x00, 0x50, /*      Logical Maximum (20480),    */
 173         0x81, 0x02,       /*      Input (Variable),           */
 174         0x09, 0x31,       /*      Usage (Y),                  */
 175         0x46, 0x70, 0x17, /*      Physical Maximum (6000),    */
 176         0x26, 0x00, 0x3C, /*      Logical Maximum (15360),    */
 177         0x81, 0x02,       /*      Input (Variable),           */
 178         0xB4,             /*      Pop,                        */
 179         0x75, 0x08,       /*      Report Size (8),            */
 180         0x09, 0x38,       /*      Usage (Wheel),              */
 181         0x15, 0xFF,       /*      Logical Minimum (-1),       */
 182         0x25, 0x01,       /*      Logical Maximum (1),        */
 183         0x81, 0x06,       /*      Input (Variable, Relative), */
 184         0x81, 0x01,       /*      Input (Constant),           */
 185         0xC0,             /*    End Collection,               */
 186         0xC0              /*  End Collection                  */
 187 };
 188
 189 /*
 190  * See EasyPen M610X description, device and HID report descriptors at
 191  * http://sf.net/apps/mediawiki/digimend/?title=KYE_EasyPen_M610X
 192  */
 193
 194 /* Original EasyPen M610X report descriptor size */
 195 #define EASYPEN_M610X_RDESC_ORIG_SIZE   476
 196
 197 /* Fixed EasyPen M610X report descriptor */
 198 static __u8 easypen_m610x_rdesc_fixed[] = {
 199         0x06, 0x00, 0xFF,             /*  Usage Page (FF00h),             */
 200         0x09, 0x01,                   /*  Usage (01h),                    */
 201         0xA1, 0x01,                   /*  Collection (Application),       */
 202         0x85, 0x05,                   /*    Report ID (5),                */
 203         0x09, 0x01,                   /*    Usage (01h),                  */
 204         0x15, 0x80,                   /*    Logical Minimum (-128),       */
 205         0x25, 0x7F,                   /*    Logical Maximum (127),        */
 206         0x75, 0x08,                   /*    Report Size (8),              */
 207         0x95, 0x07,                   /*    Report Count (7),             */
 208         0xB1, 0x02,                   /*    Feature (Variable),           */
 209         0xC0,                         /*  End Collection,                 */
 210         0x05, 0x0D,                   /*  Usage Page (Digitizer),         */
 211         0x09, 0x02,                   /*  Usage (Pen),                    */
 212         0xA1, 0x01,                   /*  Collection (Application),       */
 213         0x85, 0x10,                   /*    Report ID (16),               */
 214         0x09, 0x20,                   /*    Usage (Stylus),               */
 215         0xA0,                         /*    Collection (Physical),        */
 216         0x14,                         /*      Logical Minimum (0),        */
 217         0x25, 0x01,                   /*      Logical Maximum (1),        */
 218         0x75, 0x01,                   /*      Report Size (1),            */
 219         0x09, 0x42,                   /*      Usage (Tip Switch),         */
 220         0x09, 0x44,                   /*      Usage (Barrel Switch),      */
 221         0x09, 0x46,                   /*      Usage (Tablet Pick),        */
 222         0x95, 0x03,                   /*      Report Count (3),           */
 223         0x81, 0x02,                   /*      Input (Variable),           */
 224         0x95, 0x04,                   /*      Report Count (4),           */
 225         0x81, 0x03,                   /*      Input (Constant, Variable), */
 226         0x09, 0x32,                   /*      Usage (In Range),           */
 227         0x95, 0x01,                   /*      Report Count (1),           */
 228         0x81, 0x02,                   /*      Input (Variable),           */
 229         0x75, 0x10,                   /*      Report Size (16),           */
 230         0x95, 0x01,                   /*      Report Count (1),           */
 231         0xA4,                         /*      Push,                       */
 232         0x05, 0x01,                   /*      Usage Page (Desktop),       */
 233         0x55, 0xFD,                   /*      Unit Exponent (-3),         */
 234         0x65, 0x13,                   /*      Unit (Inch),                */
 235         0x34,                         /*      Physical Minimum (0),       */
 236         0x09, 0x30,                   /*      Usage (X),                  */
 237         0x46, 0x10, 0x27,             /*      Physical Maximum (10000),   */
 238         0x27, 0x00, 0xA0, 0x00, 0x00, /*      Logical Maximum (40960),    */
 239         0x81, 0x02,                   /*      Input (Variable),           */
 240         0x09, 0x31,                   /*      Usage (Y),                  */
 241         0x46, 0x6A, 0x18,             /*      Physical Maximum (6250),    */
 242         0x26, 0x00, 0x64,             /*      Logical Maximum (25600),    */
 243         0x81, 0x02,                   /*      Input (Variable),           */
 244         0xB4,                         /*      Pop,                        */
 245         0x09, 0x30,                   /*      Usage (Tip Pressure),       */
 246         0x26, 0xFF, 0x03,             /*      Logical Maximum (1023),     */
 247         0x81, 0x02,                   /*      Input (Variable),           */
 248         0xC0,                         /*    End Collection,               */
 249         0xC0,                         /*  End Collection,                 */
 250         0x05, 0x0C,                   /*  Usage Page (Consumer),          */
 251         0x09, 0x01,                   /*  Usage (Consumer Control),       */
 252         0xA1, 0x01,                   /*  Collection (Application),       */
 253         0x85, 0x12,                   /*    Report ID (18),               */
 254         0x14,                         /*    Logical Minimum (0),          */
 255         0x25, 0x01,                   /*    Logical Maximum (1),          */
 256         0x75, 0x01,                   /*    Report Size (1),              */
 257         0x95, 0x04,                   /*    Report Count (4),             */
 258         0x0A, 0x1A, 0x02,             /*    Usage (AC Undo),              */
 259         0x0A, 0x79, 0x02,             /*    Usage (AC Redo Or Repeat),    */
 260         0x0A, 0x2D, 0x02,             /*    Usage (AC Zoom In),           */
 261         0x0A, 0x2E, 0x02,             /*    Usage (AC Zoom Out),          */
 262         0x81, 0x02,                   /*    Input (Variable),             */
 263         0x95, 0x01,                   /*    Report Count (1),             */
 264         0x75, 0x14,                   /*    Report Size (20),             */
 265         0x81, 0x03,                   /*    Input (Constant, Variable),   */
 266         0x75, 0x20,                   /*    Report Size (32),             */
 267         0x81, 0x03,                   /*    Input (Constant, Variable),   */
 268         0xC0                          /*  End Collection                  */
 269 };
 270
 271 static __u8 *kye_report_fixup(struct hid_device *hdev, __u8 *rdesc,
 272                 unsigned int *rsize)
 273 {
 274         switch (hdev->product) {
 275         case USB_DEVICE_ID_KYE_ERGO_525V:
 276                 /* the fixups that need to be done:
 277                  *   - change led usage page to button for extra buttons
 278                  *   - report size 8 count 1 must be size 1 count 8 for button
 279                  *     bitfield
 280                  *   - change the button usage range to 4-7 for the extra
 281                  *     buttons
 282                  */
 283                 if (*rsize >= 74 &&
 284                         rdesc[61] == 0x05 && rdesc[62] == 0x08 &&
 285                         rdesc[63] == 0x19 && rdesc[64] == 0x08 &&
 286                         rdesc[65] == 0x29 && rdesc[66] == 0x0f &&
 287                         rdesc[71] == 0x75 && rdesc[72] == 0x08 &&
 288                         rdesc[73] == 0x95 && rdesc[74] == 0x01) {
 289                         hid_info(hdev,
 290                                  "fixing up Kye/Genius Ergo Mouse "
 291                                  "report descriptor\n");
 292                         rdesc[62] = 0x09;
 293                         rdesc[64] = 0x04;
 294                         rdesc[66] = 0x07;
 295                         rdesc[72] = 0x01;
 296                         rdesc[74] = 0x08;
 297                 }
 298                 break;
 299         case USB_DEVICE_ID_KYE_EASYPEN_I405X:
 300                 if (*rsize == EASYPEN_I405X_RDESC_ORIG_SIZE) {
 301                         rdesc = easypen_i405x_rdesc_fixed;
 302                         *rsize = sizeof(easypen_i405x_rdesc_fixed);
 303                 }
 304                 break;
 305         case USB_DEVICE_ID_KYE_MOUSEPEN_I608X:
 306                 if (*rsize == MOUSEPEN_I608X_RDESC_ORIG_SIZE) {
 307                         rdesc = mousepen_i608x_rdesc_fixed;
 308                         *rsize = sizeof(mousepen_i608x_rdesc_fixed);
 309                 }
 310                 break;
 311         case USB_DEVICE_ID_KYE_EASYPEN_M610X:
 312                 if (*rsize == EASYPEN_M610X_RDESC_ORIG_SIZE) {
 313                         rdesc = easypen_m610x_rdesc_fixed;
 314                         *rsize = sizeof(easypen_m610x_rdesc_fixed);
 315                 }
 316                 break;
 317         case USB_DEVICE_ID_GENIUS_GILA_GAMING_MOUSE:
 318                 /*
 319                  * the fixup that need to be done:
 320                  *   - change Usage Maximum in the Comsumer Control
 321                  *     (report ID 3) to a reasonable value
 322                  */
 323                 if (*rsize >= 135 &&
 324                         /* Usage Page (Consumer Devices) */
 325                         rdesc[104] == 0x05 && rdesc[105] == 0x0c &&
 326                         /* Usage (Consumer Control) */
 327                         rdesc[106] == 0x09 && rdesc[107] == 0x01 &&
 328                         /*   Usage Maximum > 12287 */
 329                         rdesc[114] == 0x2a && rdesc[116] > 0x2f) {
 330                         hid_info(hdev,
 331                                  "fixing up Genius Gila Gaming Mouse "
 332                                  "report descriptor\n");
 333                         rdesc[116] = 0x2f;
 334                 }
 335                 break;
 336         }
 337         return rdesc;
 338 }
 339
 340 /**
 341  * Enable fully-functional tablet mode by setting a special feature report.
 342  *
 343  * @hdev:       HID device
 344  *
 345  * The specific report ID and data were discovered by sniffing the
 346  * Windows driver traffic.
 347  */
 348 static int kye_tablet_enable(struct hid_device *hdev)
 349 {
 350         struct list_head *list;
 351         struct list_head *head;
 352         struct hid_report *report;
 353         __s32 *value;
 354
 355         list = &hdev->report_enum[HID_FEATURE_REPORT].report_list;
 356         list_for_each(head, list) {
 357                 report = list_entry(head, struct hid_report, list);
 358                 if (report->id == 5)
 359                         break;
 360         }
 361
 362         if (head == list) {
 363                 hid_err(hdev, "tablet-enabling feature report not found\n");
 364                 return -ENODEV;
 365         }
 366
 367         if (report->maxfield < 1 || report->field[0]->report_count < 7) {
 368                 hid_err(hdev, "invalid tablet-enabling feature report\n");
 369                 return -ENODEV;
 370         }
 371
 372         value = report->field[0]->value;
 373
 374         value[0] = 0x12;
 375         value[1] = 0x10;
 376         value[2] = 0x11;
 377         value[3] = 0x12;
 378         value[4] = 0x00;
 379         value[5] = 0x00;
 380         value[6] = 0x00;
 381         hid_hw_request(hdev, report, HID_REQ_SET_REPORT);
 382
 383         return 0;
 384 }
 385
 386 static int kye_probe(struct hid_device *hdev, const struct hid_device_id *id)
 387 {
 388         int ret;
 389
 390         ret = hid_parse(hdev);
 391         if (ret) {
 392                 hid_err(hdev, "parse failed\n");
 393                 goto err;
 394         }
 395
 396         ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
 397         if (ret) {
 398                 hid_err(hdev, "hw start failed\n");
 399                 goto err;
 400         }
 401
 402         switch (id->product) {
 403         case USB_DEVICE_ID_KYE_EASYPEN_I405X:
 404         case USB_DEVICE_ID_KYE_MOUSEPEN_I608X:
 405         case USB_DEVICE_ID_KYE_EASYPEN_M610X:
 406                 ret = kye_tablet_enable(hdev);
 407                 if (ret) {
 408                         hid_err(hdev, "tablet enabling failed\n");
 409                         goto enabling_err;
 410                 }
 411                 break;
 412         }
 413
 414         return 0;
 415 enabling_err:
 416         hid_hw_stop(hdev);
 417 err:
 418         return ret;
 419 }
 420
 421 static const struct hid_device_id kye_devices[] = {
 422         { HID_USB_DEVICE(USB_VENDOR_ID_KYE, USB_DEVICE_ID_KYE_ERGO_525V) },
 423         { HID_USB_DEVICE(USB_VENDOR_ID_KYE,
 424                                 USB_DEVICE_ID_KYE_EASYPEN_I405X) },
 425         { HID_USB_DEVICE(USB_VENDOR_ID_KYE,
 426                                 USB_DEVICE_ID_KYE_MOUSEPEN_I608X) },
 427         { HID_USB_DEVICE(USB_VENDOR_ID_KYE,
 428                                 USB_DEVICE_ID_KYE_EASYPEN_M610X) },
 429         { HID_USB_DEVICE(USB_VENDOR_ID_KYE,
 430                                 USB_DEVICE_ID_GENIUS_GILA_GAMING_MOUSE) },
 431         { }
 432 };
 433 MODULE_DEVICE_TABLE(hid, kye_devices);
 434
 435 static struct hid_driver kye_driver = {
 436         .name = "kye",
 437         .id_table = kye_devices,
 438         .probe = kye_probe,
 439         .report_fixup = kye_report_fixup,
 440 };
 441 module_hid_driver(kye_driver);
 442
 443 MODULE_LICENSE("GPL");