[linux-block.git] / drivers / hid / hid-elecom.c

// SPDX-License-Identifier: GPL-2.0-or-later
/*
 *  HID driver for ELECOM devices:
 *  - BM084 Bluetooth Mouse
 *  - EX-G Trackballs (M-XT3DRBK, M-XT3URBK, M-XT4DRBK)
 *  - DEFT Trackballs (M-DT1DRBK, M-DT1URBK, M-DT2DRBK, M-DT2URBK)
 *  - HUGE Trackballs (M-HT1DRBK, M-HT1URBK)
 *
 *  Copyright (c) 2010 Richard Nauber <Richard.Nauber@gmail.com>
 *  Copyright (c) 2016 Yuxuan Shui <yshuiv7@gmail.com>
 *  Copyright (c) 2017 Diego Elio Pettenò <flameeyes@flameeyes.eu>
 *  Copyright (c) 2017 Alex Manoussakis <amanou@gnu.org>
 *  Copyright (c) 2017 Tomasz Kramkowski <tk@the-tk.com>
 *  Copyright (c) 2020 YOSHIOKA Takuma <lo48576@hard-wi.red>
 */

/*
 */

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

#include "hid-ids.h"

/*
 * Certain ELECOM mice misreport their button count meaning that they only work
 * correctly with the ELECOM mouse assistant software which is unavailable for
 * Linux. A four extra INPUT reports and a FEATURE report are described by the
 * report descriptor but it does not appear that these enable software to
 * control what the extra buttons map to. The only simple and straightforward
 * solution seems to involve fixing up the report descriptor.
 */
#define MOUSE_BUTTONS_MAX 8
static void mouse_button_fixup(struct hid_device *hdev,
			       __u8 *rdesc, unsigned int rsize,
			       unsigned int button_bit_count,
			       unsigned int padding_bit,
			       unsigned int button_report_size,
			       unsigned int button_usage_maximum,
			       int nbuttons)
{
	if (rsize < 32 || rdesc[button_bit_count] != 0x95 ||
	    rdesc[button_report_size] != 0x75 ||
	    rdesc[button_report_size + 1] != 0x01 ||
	    rdesc[button_usage_maximum] != 0x29 || rdesc[padding_bit] != 0x75)
		return;
	hid_info(hdev, "Fixing up Elecom mouse button count\n");
	nbuttons = clamp(nbuttons, 0, MOUSE_BUTTONS_MAX);
	rdesc[button_bit_count + 1] = nbuttons;
	rdesc[button_usage_maximum + 1] = nbuttons;
	rdesc[padding_bit + 1] = MOUSE_BUTTONS_MAX - nbuttons;
}

static __u8 *elecom_report_fixup(struct hid_device *hdev, __u8 *rdesc,
		unsigned int *rsize)
{
	switch (hdev->product) {
	case USB_DEVICE_ID_ELECOM_BM084:
		/* The BM084 Bluetooth mouse includes a non-existing horizontal
		 * wheel in the HID descriptor. */
		if (*rsize >= 48 && rdesc[46] == 0x05 && rdesc[47] == 0x0c) {
			hid_info(hdev, "Fixing up Elecom BM084 report descriptor\n");
			rdesc[47] = 0x00;
		}
		break;
	case USB_DEVICE_ID_ELECOM_M_XGL20DLBK:
		/*
		 * Report descriptor format:
		 * 20: button bit count
		 * 28: padding bit count
		 * 22: button report size
		 * 14: button usage maximum
		 */
		mouse_button_fixup(hdev, rdesc, *rsize, 20, 28, 22, 14, 8);
		break;
	case USB_DEVICE_ID_ELECOM_M_XT3URBK:
	case USB_DEVICE_ID_ELECOM_M_XT3DRBK:
	case USB_DEVICE_ID_ELECOM_M_XT4DRBK:
		/*
		 * Report descriptor format:
		 * 12: button bit count
		 * 30: padding bit count
		 * 14: button report size
		 * 20: button usage maximum
		 */
		mouse_button_fixup(hdev, rdesc, *rsize, 12, 30, 14, 20, 6);
		break;
	case USB_DEVICE_ID_ELECOM_M_DT1URBK:
	case USB_DEVICE_ID_ELECOM_M_DT1DRBK:
	case USB_DEVICE_ID_ELECOM_M_HT1URBK:
	case USB_DEVICE_ID_ELECOM_M_HT1DRBK:
		/*
		 * Report descriptor format:
		 * 12: button bit count
		 * 30: padding bit count
		 * 14: button report size
		 * 20: button usage maximum
		 */
		mouse_button_fixup(hdev, rdesc, *rsize, 12, 30, 14, 20, 8);
		break;
	}
	return rdesc;
}

static const struct hid_device_id elecom_devices[] = {
	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_ELECOM, USB_DEVICE_ID_ELECOM_BM084) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_ELECOM, USB_DEVICE_ID_ELECOM_M_XGL20DLBK) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_ELECOM, USB_DEVICE_ID_ELECOM_M_XT3URBK) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_ELECOM, USB_DEVICE_ID_ELECOM_M_XT3DRBK) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_ELECOM, USB_DEVICE_ID_ELECOM_M_XT4DRBK) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_ELECOM, USB_DEVICE_ID_ELECOM_M_DT1URBK) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_ELECOM, USB_DEVICE_ID_ELECOM_M_DT1DRBK) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_ELECOM, USB_DEVICE_ID_ELECOM_M_HT1URBK) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_ELECOM, USB_DEVICE_ID_ELECOM_M_HT1DRBK) },
	{ }
};
MODULE_DEVICE_TABLE(hid, elecom_devices);

static struct hid_driver elecom_driver = {
	.name = "elecom",
	.id_table = elecom_devices,
	.report_fixup = elecom_report_fixup
};
module_hid_driver(elecom_driver);

MODULE_LICENSE("GPL");
Commit	Line	Data
2874c5fd	1	// SPDX-License-Identifier: GPL-2.0-or-later
64b386ea	2	/*
ac58eec2 TK	3	* HID driver for ELECOM devices:
ac58eec2 TK	4	* - BM084 Bluetooth Mouse
fbb77e88	5	* - EX-G Trackballs (M-XT3DRBK, M-XT3URBK, M-XT4DRBK)
79837ede TK	6	* - DEFT Trackballs (M-DT1DRBK, M-DT1URBK, M-DT2DRBK, M-DT2URBK)
79837ede TK	7	* - HUGE Trackballs (M-HT1DRBK, M-HT1URBK)
ac58eec2	8	*
64b386ea	9	* Copyright (c) 2010 Richard Nauber <Richard.Nauber@gmail.com>
0bb7a37f DEP	10	* Copyright (c) 2016 Yuxuan Shui <yshuiv7@gmail.com>
0bb7a37f DEP	11	* Copyright (c) 2017 Diego Elio Pettenò <flameeyes@flameeyes.eu>
a0933a45	12	* Copyright (c) 2017 Alex Manoussakis <amanou@gnu.org>
ac58eec2	13	* Copyright (c) 2017 Tomasz Kramkowski <tk@the-tk.com>
68d09380	14	* Copyright (c) 2020 YOSHIOKA Takuma <lo48576@hard-wi.red>
64b386ea RN	15	*/
	16
	17	/*
64b386ea RN	18	*/
	19
	20	#include <linux/device.h>
	21	#include <linux/hid.h>
	22	#include <linux/module.h>
	23
	24	#include "hid-ids.h"
	25
ac58eec2 TK	26	/*
	27	* Certain ELECOM mice misreport their button count meaning that they only work
	28	* correctly with the ELECOM mouse assistant software which is unavailable for
	29	* Linux. A four extra INPUT reports and a FEATURE report are described by the
	30	* report descriptor but it does not appear that these enable software to
	31	* control what the extra buttons map to. The only simple and straightforward
	32	* solution seems to involve fixing up the report descriptor.
ac58eec2 TK	33	*/
	34	#define MOUSE_BUTTONS_MAX 8
	35	static void mouse_button_fixup(struct hid_device *hdev,
	36	__u8 *rdesc, unsigned int rsize,
68d09380 YT	37	unsigned int button_bit_count,
	38	unsigned int padding_bit,
	39	unsigned int button_report_size,
	40	unsigned int button_usage_maximum,
ac58eec2 TK	41	int nbuttons)
ac58eec2 TK	42	{
68d09380 YT	43	if (rsize < 32 \|\| rdesc[button_bit_count] != 0x95 \|\|
	44	rdesc[button_report_size] != 0x75 \|\|
	45	rdesc[button_report_size + 1] != 0x01 \|\|
	46	rdesc[button_usage_maximum] != 0x29 \|\| rdesc[padding_bit] != 0x75)
ac58eec2 TK	47	return;
	48	hid_info(hdev, "Fixing up Elecom mouse button count\n");
	49	nbuttons = clamp(nbuttons, 0, MOUSE_BUTTONS_MAX);
68d09380 YT	50	rdesc[button_bit_count + 1] = nbuttons;
	51	rdesc[button_usage_maximum + 1] = nbuttons;
	52	rdesc[padding_bit + 1] = MOUSE_BUTTONS_MAX - nbuttons;
ac58eec2 TK	53	}
ac58eec2 TK	54
73e4008d NK	55	static __u8 elecom_report_fixup(struct hid_device hdev, __u8 *rdesc,
73e4008d NK	56	unsigned int *rsize)
64b386ea	57	{
0bb7a37f DEP	58	switch (hdev->product) {
	59	case USB_DEVICE_ID_ELECOM_BM084:
	60	/* The BM084 Bluetooth mouse includes a non-existing horizontal
	61	* wheel in the HID descriptor. */
	62	if (*rsize >= 48 && rdesc[46] == 0x05 && rdesc[47] == 0x0c) {
	63	hid_info(hdev, "Fixing up Elecom BM084 report descriptor\n");
	64	rdesc[47] = 0x00;
	65	}
	66	break;
55633e68 YT	67	case USB_DEVICE_ID_ELECOM_M_XGL20DLBK:
	68	/*
	69	* Report descriptor format:
	70	* 20: button bit count
	71	* 28: padding bit count
	72	* 22: button report size
	73	* 14: button usage maximum
	74	*/
	75	mouse_button_fixup(hdev, rdesc, *rsize, 20, 28, 22, 14, 8);
	76	break;
79837ede TK	77	case USB_DEVICE_ID_ELECOM_M_XT3URBK:
79837ede TK	78	case USB_DEVICE_ID_ELECOM_M_XT3DRBK:
fbb77e88	79	case USB_DEVICE_ID_ELECOM_M_XT4DRBK:
68d09380 YT	80	/*
	81	* Report descriptor format:
	82	* 12: button bit count
	83	* 30: padding bit count
	84	* 14: button report size
	85	* 20: button usage maximum
	86	*/
	87	mouse_button_fixup(hdev, rdesc, *rsize, 12, 30, 14, 20, 6);
ac58eec2	88	break;
79837ede TK	89	case USB_DEVICE_ID_ELECOM_M_DT1URBK:
	90	case USB_DEVICE_ID_ELECOM_M_DT1DRBK:
	91	case USB_DEVICE_ID_ELECOM_M_HT1URBK:
	92	case USB_DEVICE_ID_ELECOM_M_HT1DRBK:
68d09380 YT	93	/*
	94	* Report descriptor format:
	95	* 12: button bit count
	96	* 30: padding bit count
	97	* 14: button report size
	98	* 20: button usage maximum
	99	*/
	100	mouse_button_fixup(hdev, rdesc, *rsize, 12, 30, 14, 20, 8);
0bb7a37f	101	break;
64b386ea	102	}
636a89d4	103	return rdesc;
64b386ea RN	104	}
	105
	106	static const struct hid_device_id elecom_devices[] = {
0bb7a37f	107	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_ELECOM, USB_DEVICE_ID_ELECOM_BM084) },
55633e68	108	{ HID_USB_DEVICE(USB_VENDOR_ID_ELECOM, USB_DEVICE_ID_ELECOM_M_XGL20DLBK) },
79837ede TK	109	{ HID_USB_DEVICE(USB_VENDOR_ID_ELECOM, USB_DEVICE_ID_ELECOM_M_XT3URBK) },
79837ede TK	110	{ HID_USB_DEVICE(USB_VENDOR_ID_ELECOM, USB_DEVICE_ID_ELECOM_M_XT3DRBK) },
fbb77e88	111	{ HID_USB_DEVICE(USB_VENDOR_ID_ELECOM, USB_DEVICE_ID_ELECOM_M_XT4DRBK) },
79837ede TK	112	{ HID_USB_DEVICE(USB_VENDOR_ID_ELECOM, USB_DEVICE_ID_ELECOM_M_DT1URBK) },
	113	{ HID_USB_DEVICE(USB_VENDOR_ID_ELECOM, USB_DEVICE_ID_ELECOM_M_DT1DRBK) },
	114	{ HID_USB_DEVICE(USB_VENDOR_ID_ELECOM, USB_DEVICE_ID_ELECOM_M_HT1URBK) },
	115	{ HID_USB_DEVICE(USB_VENDOR_ID_ELECOM, USB_DEVICE_ID_ELECOM_M_HT1DRBK) },
64b386ea RN	116	{ }
	117	};
	118	MODULE_DEVICE_TABLE(hid, elecom_devices);
	119
	120	static struct hid_driver elecom_driver = {
	121	.name = "elecom",
	122	.id_table = elecom_devices,
	123	.report_fixup = elecom_report_fixup
	124	};
f425458e	125	module_hid_driver(elecom_driver);
64b386ea	126
64b386ea	127	MODULE_LICENSE("GPL");