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