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