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