[deliverable/linux.git] / drivers / hid / hid-microsoft.c

/*
 *  HID driver for some microsoft "special" devices
 *
 *  Copyright (c) 1999 Andreas Gal
 *  Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
 *  Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
 *  Copyright (c) 2006-2007 Jiri Kosina
 *  Copyright (c) 2008 Jiri Slaby
 */

/*
 * 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/device.h>
#include <linux/input.h>
#include <linux/hid.h>
#include <linux/module.h>

#include "hid-ids.h"

#define MS_HIDINPUT		0x01
#define MS_ERGONOMY		0x02
#define MS_PRESENTER		0x04
#define MS_RDESC		0x08
#define MS_NOGET		0x10
#define MS_DUPLICATE_USAGES	0x20
#define MS_RDESC_3K		0x40

static __u8 *ms_report_fixup(struct hid_device *hdev, __u8 *rdesc,
		unsigned int *rsize)
{
	unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);

	/*
	 * Microsoft Wireless Desktop Receiver (Model 1028) has
	 * 'Usage Min/Max' where it ought to have 'Physical Min/Max'
	 */
	if ((quirks & MS_RDESC) && *rsize == 571 && rdesc[557] == 0x19 &&
			rdesc[559] == 0x29) {
		hid_info(hdev, "fixing up Microsoft Wireless Receiver Model 1028 report descriptor\n");
		rdesc[557] = 0x35;
		rdesc[559] = 0x45;
	}
	/* the same as above (s/usage/physical/) */
	if ((quirks & MS_RDESC_3K) && *rsize == 106 &&
			!memcmp((char []){ 0x19, 0x00, 0x29, 0xff },
				&rdesc[94], 4)) {
		rdesc[94] = 0x35;
		rdesc[96] = 0x45;
	}
	return rdesc;
}

#define ms_map_key_clear(c)	hid_map_usage_clear(hi, usage, bit, max, \
					EV_KEY, (c))
static int ms_ergonomy_kb_quirk(struct hid_input *hi, struct hid_usage *usage,
		unsigned long **bit, int *max)
{
	struct input_dev *input = hi->input;

	switch (usage->hid & HID_USAGE) {
	case 0xfd06: ms_map_key_clear(KEY_CHAT);	break;
	case 0xfd07: ms_map_key_clear(KEY_PHONE);	break;
	case 0xff05:
		set_bit(EV_REP, input->evbit);
		ms_map_key_clear(KEY_F13);
		set_bit(KEY_F14, input->keybit);
		set_bit(KEY_F15, input->keybit);
		set_bit(KEY_F16, input->keybit);
		set_bit(KEY_F17, input->keybit);
		set_bit(KEY_F18, input->keybit);
	default:
		return 0;
	}
	return 1;
}

static int ms_presenter_8k_quirk(struct hid_input *hi, struct hid_usage *usage,
		unsigned long **bit, int *max)
{
	set_bit(EV_REP, hi->input->evbit);
	switch (usage->hid & HID_USAGE) {
	case 0xfd08: ms_map_key_clear(KEY_FORWARD);	break;
	case 0xfd09: ms_map_key_clear(KEY_BACK);	break;
	case 0xfd0b: ms_map_key_clear(KEY_PLAYPAUSE);	break;
	case 0xfd0e: ms_map_key_clear(KEY_CLOSE);	break;
	case 0xfd0f: ms_map_key_clear(KEY_PLAY);	break;
	default:
		return 0;
	}
	return 1;
}

static int ms_input_mapping(struct hid_device *hdev, struct hid_input *hi,
		struct hid_field *field, struct hid_usage *usage,
		unsigned long **bit, int *max)
{
	unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);

	if ((usage->hid & HID_USAGE_PAGE) != HID_UP_MSVENDOR)
		return 0;

	if (quirks & MS_ERGONOMY) {
		int ret = ms_ergonomy_kb_quirk(hi, usage, bit, max);
		if (ret)
			return ret;
	}

	if ((quirks & MS_PRESENTER) &&
			ms_presenter_8k_quirk(hi, usage, bit, max))
		return 1;

	return 0;
}

static int ms_input_mapped(struct hid_device *hdev, struct hid_input *hi,
		struct hid_field *field, struct hid_usage *usage,
		unsigned long **bit, int *max)
{
	unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);

	if (quirks & MS_DUPLICATE_USAGES)
		clear_bit(usage->code, *bit);

	return 0;
}

static int ms_event(struct hid_device *hdev, struct hid_field *field,
		struct hid_usage *usage, __s32 value)
{
	unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);

	if (!(hdev->claimed & HID_CLAIMED_INPUT) || !field->hidinput ||
			!usage->type)
		return 0;

	/* Handling MS keyboards special buttons */
	if (quirks & MS_ERGONOMY && usage->hid == (HID_UP_MSVENDOR | 0xff05)) {
		struct input_dev *input = field->hidinput->input;
		static unsigned int last_key = 0;
		unsigned int key = 0;
		switch (value) {
		case 0x01: key = KEY_F14; break;
		case 0x02: key = KEY_F15; break;
		case 0x04: key = KEY_F16; break;
		case 0x08: key = KEY_F17; break;
		case 0x10: key = KEY_F18; break;
		}
		if (key) {
			input_event(input, usage->type, key, 1);
			last_key = key;
		} else
			input_event(input, usage->type, last_key, 0);

		return 1;
	}

	return 0;
}

static int ms_probe(struct hid_device *hdev, const struct hid_device_id *id)
{
	unsigned long quirks = id->driver_data;
	int ret;

	hid_set_drvdata(hdev, (void *)quirks);

	if (quirks & MS_NOGET)
		hdev->quirks |= HID_QUIRK_NOGET;

	ret = hid_parse(hdev);
	if (ret) {
		hid_err(hdev, "parse failed\n");
		goto err_free;
	}

	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT | ((quirks & MS_HIDINPUT) ?
				HID_CONNECT_HIDINPUT_FORCE : 0));
	if (ret) {
		hid_err(hdev, "hw start failed\n");
		goto err_free;
	}

	return 0;
err_free:
	return ret;
}

static const struct hid_device_id ms_devices[] = {
	{ HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_SIDEWINDER_GV),
		.driver_data = MS_HIDINPUT },
	{ HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_NE4K),
		.driver_data = MS_ERGONOMY },
	{ HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_LK6K),
		.driver_data = MS_ERGONOMY | MS_RDESC },
	{ HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_PRESENTER_8K_USB),
		.driver_data = MS_PRESENTER },
	{ HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_DIGITAL_MEDIA_3K),
		.driver_data = MS_ERGONOMY | MS_RDESC_3K },
	{ HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_WIRELESS_OPTICAL_DESKTOP_3_0),
		.driver_data = MS_NOGET },
	{ HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_COMFORT_MOUSE_4500),
		.driver_data = MS_DUPLICATE_USAGES },

	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_PRESENTER_8K_BT),
		.driver_data = MS_PRESENTER },
	{ }
};
MODULE_DEVICE_TABLE(hid, ms_devices);

static struct hid_driver ms_driver = {
	.name = "microsoft",
	.id_table = ms_devices,
	.report_fixup = ms_report_fixup,
	.input_mapping = ms_input_mapping,
	.input_mapped = ms_input_mapped,
	.event = ms_event,
	.probe = ms_probe,
};

static int __init ms_init(void)
{
	return hid_register_driver(&ms_driver);
}

static void __exit ms_exit(void)
{
	hid_unregister_driver(&ms_driver);
}

module_init(ms_init);
module_exit(ms_exit);
MODULE_LICENSE("GPL");
Commit	Line	Data
78a849a6 JS	1	/*
	2	* HID driver for some microsoft "special" devices
	3	*
	4	* Copyright (c) 1999 Andreas Gal
	5	* Copyright (c) 2000-2005 Vojtech Pavlik <vojtech@suse.cz>
	6	* Copyright (c) 2005 Michael Haboustak <mike-@cinci.rr.com> for Concept2, Inc
	7	* Copyright (c) 2006-2007 Jiri Kosina
78a849a6 JS	8	* Copyright (c) 2008 Jiri Slaby
	9	*/
	10
	11	/*
	12	* This program is free software; you can redistribute it and/or modify it
	13	* under the terms of the GNU General Public License as published by the Free
	14	* Software Foundation; either version 2 of the License, or (at your option)
	15	* any later version.
	16	*/
	17
	18	#include <linux/device.h>
	19	#include <linux/input.h>
	20	#include <linux/hid.h>
	21	#include <linux/module.h>
	22
	23	#include "hid-ids.h"
	24
23c10bec AS	25	#define MS_HIDINPUT 0x01
	26	#define MS_ERGONOMY 0x02
	27	#define MS_PRESENTER 0x04
	28	#define MS_RDESC 0x08
	29	#define MS_NOGET 0x10
	30	#define MS_DUPLICATE_USAGES 0x20
3ccc60f9	31	#define MS_RDESC_3K 0x40
78a849a6	32
73e4008d NK	33	static __u8 ms_report_fixup(struct hid_device hdev, __u8 *rdesc,
73e4008d NK	34	unsigned int *rsize)
78a849a6 JS	35	{
	36	unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);
	37
3ccc60f9 JS	38	/*
	39	* Microsoft Wireless Desktop Receiver (Model 1028) has
	40	* 'Usage Min/Max' where it ought to have 'Physical Min/Max'
	41	*/
73e4008d	42	if ((quirks & MS_RDESC) && *rsize == 571 && rdesc[557] == 0x19 &&
78a849a6	43	rdesc[559] == 0x29) {
4291ee30	44	hid_info(hdev, "fixing up Microsoft Wireless Receiver Model 1028 report descriptor\n");
0fb21de0 JK	45	rdesc[557] = 0x35;
0fb21de0 JK	46	rdesc[559] = 0x45;
78a849a6	47	}
3ccc60f9 JS	48	/* the same as above (s/usage/physical/) */
	49	if ((quirks & MS_RDESC_3K) && *rsize == 106 &&
	50	!memcmp((char []){ 0x19, 0x00, 0x29, 0xff },
	51	&rdesc[94], 4)) {
	52	rdesc[94] = 0x35;
	53	rdesc[96] = 0x45;
	54	}
73e4008d	55	return rdesc;
78a849a6 JS	56	}
	57
	58	#define ms_map_key_clear(c) hid_map_usage_clear(hi, usage, bit, max, \
	59	EV_KEY, (c))
	60	static int ms_ergonomy_kb_quirk(struct hid_input hi, struct hid_usage usage,
	61	unsigned long *bit, int max)
	62	{
	63	struct input_dev *input = hi->input;
	64
	65	switch (usage->hid & HID_USAGE) {
	66	case 0xfd06: ms_map_key_clear(KEY_CHAT); break;
	67	case 0xfd07: ms_map_key_clear(KEY_PHONE); break;
	68	case 0xff05:
	69	set_bit(EV_REP, input->evbit);
	70	ms_map_key_clear(KEY_F13);
	71	set_bit(KEY_F14, input->keybit);
	72	set_bit(KEY_F15, input->keybit);
	73	set_bit(KEY_F16, input->keybit);
	74	set_bit(KEY_F17, input->keybit);
	75	set_bit(KEY_F18, input->keybit);
	76	default:
	77	return 0;
	78	}
	79	return 1;
	80	}
	81
	82	static int ms_presenter_8k_quirk(struct hid_input hi, struct hid_usage usage,
	83	unsigned long *bit, int max)
	84	{
	85	set_bit(EV_REP, hi->input->evbit);
	86	switch (usage->hid & HID_USAGE) {
	87	case 0xfd08: ms_map_key_clear(KEY_FORWARD); break;
	88	case 0xfd09: ms_map_key_clear(KEY_BACK); break;
	89	case 0xfd0b: ms_map_key_clear(KEY_PLAYPAUSE); break;
	90	case 0xfd0e: ms_map_key_clear(KEY_CLOSE); break;
	91	case 0xfd0f: ms_map_key_clear(KEY_PLAY); break;
	92	default:
	93	return 0;
	94	}
	95	return 1;
	96	}
	97
	98	static int ms_input_mapping(struct hid_device hdev, struct hid_input hi,
	99	struct hid_field field, struct hid_usage usage,
	100	unsigned long *bit, int max)
	101	{
	102	unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);
	103
	104	if ((usage->hid & HID_USAGE_PAGE) != HID_UP_MSVENDOR)
	105	return 0;
	106
	107	if (quirks & MS_ERGONOMY) {
	108	int ret = ms_ergonomy_kb_quirk(hi, usage, bit, max);
	109	if (ret)
	110	return ret;
	111	}
	112
	113	if ((quirks & MS_PRESENTER) &&
	114	ms_presenter_8k_quirk(hi, usage, bit, max))
	115	return 1;
	116
	117	return 0;
	118	}
	119
23c10bec AS	120	static int ms_input_mapped(struct hid_device hdev, struct hid_input hi,
	121	struct hid_field field, struct hid_usage usage,
	122	unsigned long *bit, int max)
	123	{
	124	unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);
	125
	126	if (quirks & MS_DUPLICATE_USAGES)
	127	clear_bit(usage->code, *bit);
	128
	129	return 0;
	130	}
	131
78a849a6 JS	132	static int ms_event(struct hid_device hdev, struct hid_field field,
	133	struct hid_usage *usage, __s32 value)
	134	{
	135	unsigned long quirks = (unsigned long)hid_get_drvdata(hdev);
	136
	137	if (!(hdev->claimed & HID_CLAIMED_INPUT) \|\| !field->hidinput \|\|
	138	!usage->type)
	139	return 0;
	140
	141	/* Handling MS keyboards special buttons */
	142	if (quirks & MS_ERGONOMY && usage->hid == (HID_UP_MSVENDOR \| 0xff05)) {
	143	struct input_dev *input = field->hidinput->input;
	144	static unsigned int last_key = 0;
	145	unsigned int key = 0;
	146	switch (value) {
	147	case 0x01: key = KEY_F14; break;
	148	case 0x02: key = KEY_F15; break;
	149	case 0x04: key = KEY_F16; break;
	150	case 0x08: key = KEY_F17; break;
	151	case 0x10: key = KEY_F18; break;
	152	}
	153	if (key) {
	154	input_event(input, usage->type, key, 1);
	155	last_key = key;
	156	} else
	157	input_event(input, usage->type, last_key, 0);
	158
	159	return 1;
	160	}
	161
	162	return 0;
	163	}
	164
	165	static int ms_probe(struct hid_device hdev, const struct hid_device_id id)
	166	{
	167	unsigned long quirks = id->driver_data;
	168	int ret;
	169
	170	hid_set_drvdata(hdev, (void *)quirks);
	171
78a849a6 JS	172	if (quirks & MS_NOGET)
	173	hdev->quirks \|= HID_QUIRK_NOGET;
	174
	175	ret = hid_parse(hdev);
	176	if (ret) {
4291ee30	177	hid_err(hdev, "parse failed\n");
78a849a6 JS	178	goto err_free;
	179	}
	180
93c10132 JS	181	ret = hid_hw_start(hdev, HID_CONNECT_DEFAULT \| ((quirks & MS_HIDINPUT) ?
93c10132 JS	182	HID_CONNECT_HIDINPUT_FORCE : 0));
78a849a6	183	if (ret) {
4291ee30	184	hid_err(hdev, "hw start failed\n");
78a849a6 JS	185	goto err_free;
	186	}
	187
	188	return 0;
	189	err_free:
	190	return ret;
	191	}
	192
	193	static const struct hid_device_id ms_devices[] = {
	194	{ HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_SIDEWINDER_GV),
	195	.driver_data = MS_HIDINPUT },
	196	{ HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_NE4K),
	197	.driver_data = MS_ERGONOMY },
	198	{ HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_LK6K),
	199	.driver_data = MS_ERGONOMY \| MS_RDESC },
	200	{ HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_PRESENTER_8K_USB),
	201	.driver_data = MS_PRESENTER },
f3b83d71	202	{ HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_DIGITAL_MEDIA_3K),
3ccc60f9	203	.driver_data = MS_ERGONOMY \| MS_RDESC_3K },
78a849a6 JS	204	{ HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_WIRELESS_OPTICAL_DESKTOP_3_0),
78a849a6 JS	205	.driver_data = MS_NOGET },
23c10bec AS	206	{ HID_USB_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_COMFORT_MOUSE_4500),
23c10bec AS	207	.driver_data = MS_DUPLICATE_USAGES },
78a849a6 JS	208
	209	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_MICROSOFT, USB_DEVICE_ID_MS_PRESENTER_8K_BT),
	210	.driver_data = MS_PRESENTER },
	211	{ }
	212	};
	213	MODULE_DEVICE_TABLE(hid, ms_devices);
	214
	215	static struct hid_driver ms_driver = {
	216	.name = "microsoft",
	217	.id_table = ms_devices,
	218	.report_fixup = ms_report_fixup,
	219	.input_mapping = ms_input_mapping,
23c10bec	220	.input_mapped = ms_input_mapped,
78a849a6 JS	221	.event = ms_event,
	222	.probe = ms_probe,
	223	};
	224
a24f423b	225	static int __init ms_init(void)
78a849a6 JS	226	{
	227	return hid_register_driver(&ms_driver);
	228	}
	229
a24f423b	230	static void __exit ms_exit(void)
78a849a6 JS	231	{
	232	hid_unregister_driver(&ms_driver);
	233	}
	234
	235	module_init(ms_init);
	236	module_exit(ms_exit);
	237	MODULE_LICENSE("GPL");