drivers/hid/hid-holtek-mouse.c

   1 /*
   2  * HID driver for Holtek gaming mice
   3  * Copyright (c) 2013 Christian Ohm
   4  * Heavily inspired by various other HID drivers that adjust the report
   5  * descriptor.
   6 */
   7
   8 /*
   9  * This program is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU General Public License as published by the Free
  11  * Software Foundation; either version 2 of the License, or (at your option)
  12  * any later version.
  13  */
  14
  15 #include <linux/hid.h>
  16 #include <linux/module.h>
  17 #include <linux/usb.h>
  18
  19 #include "hid-ids.h"
  20
  21 /*
  22  * The report descriptor of some Holtek based gaming mice specifies an
  23  * excessively large number of consumer usages (2^15), which is more than
  24  * HID_MAX_USAGES. This prevents proper parsing of the report descriptor.
  25  *
  26  * This driver fixes the report descriptor for:
  27  * - USB ID 04d9:a067, sold as Sharkoon Drakonia and Perixx MX-2000
  28  * - USB ID 04d9:a04a, sold as Tracer Sniper TRM-503, NOVA Gaming Slider X200
  29  *   and Zalman ZM-GM1
  30  * - USB ID 04d9:a081, sold as SHARKOON DarkGlider Gaming mouse
  31  * - USB ID 04d9:a072, sold as LEETGION Hellion Gaming Mouse
  32  * - USB ID 04d9:a0c2, sold as ETEKCITY Scroll T-140 Gaming Mouse
  33  */
  34
  35 static __u8 *holtek_mouse_report_fixup(struct hid_device *hdev, __u8 *rdesc,
  36                 unsigned int *rsize)
  37 {
  38         struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
  39
  40         if (intf->cur_altsetting->desc.bInterfaceNumber == 1) {
  41                 /* Change usage maximum and logical maximum from 0x7fff to
  42                  * 0x2fff, so they don't exceed HID_MAX_USAGES */
  43                 switch (hdev->product) {
  44                 case USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A067:
  45                 case USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A072:
  46                 case USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A0C2:
  47                         if (*rsize >= 122 && rdesc[115] == 0xff && rdesc[116] == 0x7f
  48                                         && rdesc[120] == 0xff && rdesc[121] == 0x7f) {
  49                                 hid_info(hdev, "Fixing up report descriptor\n");
  50                                 rdesc[116] = rdesc[121] = 0x2f;
  51                         }
  52                         break;
  53                 case USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A04A:
  54                 case USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A070:
  55                 case USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A081:
  56                         if (*rsize >= 113 && rdesc[106] == 0xff && rdesc[107] == 0x7f
  57                                         && rdesc[111] == 0xff && rdesc[112] == 0x7f) {
  58                                 hid_info(hdev, "Fixing up report descriptor\n");
  59                                 rdesc[107] = rdesc[112] = 0x2f;
  60                         }
  61                         break;
  62                 }
  63
  64         }
  65         return rdesc;
  66 }
  67
  68 static int holtek_mouse_probe(struct hid_device *hdev,
  69                               const struct hid_device_id *id)
  70 {
  71         int ret;
  72
  73         if (!hid_is_usb(hdev))
  74                 return -EINVAL;
  75
  76         ret = hid_parse(hdev);
  77         if (ret) {
  78                 hid_err(hdev, "hid parse failed: %d\n", ret);
  79                 return ret;
  80         }
  81
  82         ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT);
  83         if (ret) {
  84                 hid_err(hdev, "hw start failed: %d\n", ret);
  85                 return ret;
  86         }
  87
  88         return 0;
  89 }
  90
  91 static const struct hid_device_id holtek_mouse_devices[] = {
  92         { HID_USB_DEVICE(USB_VENDOR_ID_HOLTEK_ALT,
  93                         USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A067) },
  94         { HID_USB_DEVICE(USB_VENDOR_ID_HOLTEK_ALT,
  95                         USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A070) },
  96         { HID_USB_DEVICE(USB_VENDOR_ID_HOLTEK_ALT,
  97                         USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A04A) },
  98         { HID_USB_DEVICE(USB_VENDOR_ID_HOLTEK_ALT,
  99                         USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A072) },
 100         { HID_USB_DEVICE(USB_VENDOR_ID_HOLTEK_ALT,
 101                         USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A081) },
 102         { HID_USB_DEVICE(USB_VENDOR_ID_HOLTEK_ALT,
 103                         USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A0C2) },
 104         { }
 105 };
 106 MODULE_DEVICE_TABLE(hid, holtek_mouse_devices);
 107
 108 static struct hid_driver holtek_mouse_driver = {
 109         .name = "holtek_mouse",
 110         .id_table = holtek_mouse_devices,
 111         .report_fixup = holtek_mouse_report_fixup,
 112         .probe = holtek_mouse_probe,
 113 };
 114
 115 module_hid_driver(holtek_mouse_driver);
 116 MODULE_LICENSE("GPL");