[linux.git] / drivers / hid / hid-holtek-mouse.c

/*
 * HID driver for Holtek gaming mice
 * Copyright (c) 2013 Christian Ohm
 * Heavily inspired by various other HID drivers that adjust the report
 * descriptor.
*/

/*
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the Free
 * Software Foundation; either version 2 of the License, or (at your option)
 * any later version.
 */

#include <linux/hid.h>
#include <linux/module.h>
#include <linux/usb.h>

#include "hid-ids.h"

/*
 * The report descriptor of some Holtek based gaming mice specifies an
 * excessively large number of consumer usages (2^15), which is more than
 * HID_MAX_USAGES. This prevents proper parsing of the report descriptor.
 *
 * This driver fixes the report descriptor for:
 * - USB ID 04d9:a067, sold as Sharkoon Drakonia and Perixx MX-2000
 * - USB ID 04d9:a04a, sold as Tracer Sniper TRM-503, NOVA Gaming Slider X200
 *   and Zalman ZM-GM1
 * - USB ID 04d9:a081, sold as SHARKOON DarkGlider Gaming mouse
 * - USB ID 04d9:a072, sold as LEETGION Hellion Gaming Mouse
 * - USB ID 04d9:a0c2, sold as ETEKCITY Scroll T-140 Gaming Mouse
 */

static __u8 *holtek_mouse_report_fixup(struct hid_device *hdev, __u8 *rdesc,
		unsigned int *rsize)
{
	struct usb_interface *intf = to_usb_interface(hdev->dev.parent);

	if (intf->cur_altsetting->desc.bInterfaceNumber == 1) {
		/* Change usage maximum and logical maximum from 0x7fff to
		 * 0x2fff, so they don't exceed HID_MAX_USAGES */
		switch (hdev->product) {
		case USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A067:
		case USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A072:
		case USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A0C2:
			if (*rsize >= 122 && rdesc[115] == 0xff && rdesc[116] == 0x7f
					&& rdesc[120] == 0xff && rdesc[121] == 0x7f) {
				hid_info(hdev, "Fixing up report descriptor\n");
				rdesc[116] = rdesc[121] = 0x2f;
			}
			break;
		case USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A04A:
		case USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A070:
		case USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A081:
			if (*rsize >= 113 && rdesc[106] == 0xff && rdesc[107] == 0x7f
					&& rdesc[111] == 0xff && rdesc[112] == 0x7f) {
				hid_info(hdev, "Fixing up report descriptor\n");
				rdesc[107] = rdesc[112] = 0x2f;
			}
			break;
		}

	}
	return rdesc;
}

static const struct hid_device_id holtek_mouse_devices[] = {
	{ HID_USB_DEVICE(USB_VENDOR_ID_HOLTEK_ALT,
			USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A067) },
        { HID_USB_DEVICE(USB_VENDOR_ID_HOLTEK_ALT,
			USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A070) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_HOLTEK_ALT,
			USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A04A) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_HOLTEK_ALT,
			USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A072) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_HOLTEK_ALT,
			USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A081) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_HOLTEK_ALT,
			USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A0C2) },
	{ }
};
MODULE_DEVICE_TABLE(hid, holtek_mouse_devices);

static struct hid_driver holtek_mouse_driver = {
	.name = "holtek_mouse",
	.id_table = holtek_mouse_devices,
	.report_fixup = holtek_mouse_report_fixup,
};

module_hid_driver(holtek_mouse_driver);
MODULE_LICENSE("GPL");
Commit	Line	Data
41de326e CO	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	*
d4f51890 CO	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
7da7cbbb	30	* - USB ID 04d9:a081, sold as SHARKOON DarkGlider Gaming mouse
f1a4914b	31	* - USB ID 04d9:a072, sold as LEETGION Hellion Gaming Mouse
5df4eb05	32	* - USB ID 04d9:a0c2, sold as ETEKCITY Scroll T-140 Gaming Mouse
41de326e CO	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 */
d4f51890 CO	43	switch (hdev->product) {
d4f51890 CO	44	case USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A067:
f1a4914b	45	case USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A072:
5df4eb05	46	case USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A0C2:
d4f51890 CO	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:
274be3eb	54	case USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A070:
7da7cbbb	55	case USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A081:
d4f51890 CO	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;
41de326e	62	}
d4f51890	63
41de326e CO	64	}
	65	return rdesc;
	66	}
	67
	68	static const struct hid_device_id holtek_mouse_devices[] = {
	69	{ HID_USB_DEVICE(USB_VENDOR_ID_HOLTEK_ALT,
	70	USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A067) },
274be3eb KA	71	{ HID_USB_DEVICE(USB_VENDOR_ID_HOLTEK_ALT,
274be3eb KA	72	USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A070) },
d4f51890 CO	73	{ HID_USB_DEVICE(USB_VENDOR_ID_HOLTEK_ALT,
d4f51890 CO	74	USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A04A) },
f1a4914b AK	75	{ HID_USB_DEVICE(USB_VENDOR_ID_HOLTEK_ALT,
f1a4914b AK	76	USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A072) },
7da7cbbb AK	77	{ HID_USB_DEVICE(USB_VENDOR_ID_HOLTEK_ALT,
7da7cbbb AK	78	USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A081) },
5df4eb05 JD	79	{ HID_USB_DEVICE(USB_VENDOR_ID_HOLTEK_ALT,
5df4eb05 JD	80	USB_DEVICE_ID_HOLTEK_ALT_MOUSE_A0C2) },
41de326e CO	81	{ }
	82	};
	83	MODULE_DEVICE_TABLE(hid, holtek_mouse_devices);
	84
	85	static struct hid_driver holtek_mouse_driver = {
	86	.name = "holtek_mouse",
	87	.id_table = holtek_mouse_devices,
	88	.report_fixup = holtek_mouse_report_fixup,
	89	};
	90
c99f8188	91	module_hid_driver(holtek_mouse_driver);
41de326e	92	MODULE_LICENSE("GPL");