summaryrefstree
path: root/kernel/drivers/hid/hid-zagg.c
blob: d43098d52cb647313f04948829c5c24d76c97c3b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
/*
 *  HID driver for some zagg "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) 2007 Paul Walmsley
 *  Copyright (c) 2008 Jiri Slaby
 *  Copyright (c) 2010 Don Prince <dhprince.devel@yahoo.co.uk>
 *  Copyright (c) 2013 ZAGG Inc. <software.engineering@zagg.com>
 *
 *
 *  This driver supports several HID devices:
 *
 *  [0419:0001] Samsung IrDA remote controller (reports as Cypress USB Mouse).
 *	various hid report fixups for different variants.
 *
 *  [0419:0600] Creative Desktop Wireless 6000 keyboard/mouse combo
 *	several key mappings used from the consumer usage page
 *	deviate from the USB HUT 1.12 standard.
 *
 */

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

#include "hid-ids.h"

/*
 * There are several variants for 0419:0001:
 *
 * 1. 184 byte report descriptor
 * Vendor specific report #4 has a size of 48 bit,
 * and therefore is not accepted when inspecting the descriptors.
 * As a workaround we reinterpret the report as:
 *   Variable type, count 6, size 8 bit, log. maximum 255
 * The burden to reconstruct the data is moved into user space.
 *
 * 2. 203 byte report descriptor
 * Report #4 has an array field with logical range 0..18 instead of 1..15.
 *
 * 3. 135 byte report descriptor
 * Report #4 has an array field with logical range 0..17 instead of 1..14.
 *
 * 4. 171 byte report descriptor
 * Report #3 has an array field with logical range 0..1 instead of 1..3.
 */
static inline void zagg_irda_dev_trace(struct hid_device *hdev,
		unsigned int rsize)
{
	hid_info(hdev, "fixing up ZAGG IrDA %d byte report descriptor\n",
		 rsize);
}

static __u8 *zagg_irda_report_fixup(struct hid_device *hdev, __u8 *rdesc,
		unsigned int *rsize)
{
	if (*rsize == 184 && rdesc[175] == 0x25 && rdesc[176] == 0x40 &&
			rdesc[177] == 0x75 && rdesc[178] == 0x30 &&
			rdesc[179] == 0x95 && rdesc[180] == 0x01 &&
			rdesc[182] == 0x40) {
		zagg_irda_dev_trace(hdev, 184);
		rdesc[176] = 0xff;
		rdesc[178] = 0x08;
		rdesc[180] = 0x06;
		rdesc[182] = 0x42;
	} else
	if (*rsize == 203 && rdesc[192] == 0x15 && rdesc[193] == 0x0 &&
			rdesc[194] == 0x25 && rdesc[195] == 0x12) {
		zagg_irda_dev_trace(hdev, 203);
		rdesc[193] = 0x1;
		rdesc[195] = 0xf;
	} else
	if (*rsize == 135 && rdesc[124] == 0x15 && rdesc[125] == 0x0 &&
			rdesc[126] == 0x25 && rdesc[127] == 0x11) {
		zagg_irda_dev_trace(hdev, 135);
		rdesc[125] = 0x1;
		rdesc[127] = 0xe;
	} else
	if (*rsize == 171 && rdesc[160] == 0x15 && rdesc[161] == 0x0 &&
			rdesc[162] == 0x25 && rdesc[163] == 0x01) {
		zagg_irda_dev_trace(hdev, 171);
		rdesc[161] = 0x1;
		rdesc[163] = 0x3;
	}
	return rdesc;
}

#define zagg_kbd_mouse_map_key_clear(c) \
	hid_map_usage_clear(hi, usage, bit, max, EV_KEY, (c))

static int zagg_kbd_mouse_input_mapping(struct hid_device *hdev,
	struct hid_input *hi, struct hid_field *field, struct hid_usage *usage,
	unsigned long **bit, int *max)
{
	struct usb_interface *intf = to_usb_interface(hdev->dev.parent);
	unsigned short ifnum = intf->cur_altsetting->desc.bInterfaceNumber;

	if (1 != ifnum || HID_UP_CONSUMER != (usage->hid & HID_USAGE_PAGE))
		return 0;

	dbg_hid("zagg wireless keyboard/mouse input mapping event [0x%x]\n",
		usage->hid & HID_USAGE);

	switch (usage->hid & HID_USAGE) {
	/* report 2 */
	case 0x183: zagg_kbd_mouse_map_key_clear(KEY_MEDIA); break;
	case 0x195: zagg_kbd_mouse_map_key_clear(KEY_EMAIL);	break;
	case 0x196: zagg_kbd_mouse_map_key_clear(KEY_CALC); break;
	case 0x197: zagg_kbd_mouse_map_key_clear(KEY_COMPUTER); break;
	case 0x22b: zagg_kbd_mouse_map_key_clear(KEY_SEARCH); break;
	case 0x22c: zagg_kbd_mouse_map_key_clear(KEY_WWW); break;
	case 0x22d: zagg_kbd_mouse_map_key_clear(KEY_BACK); break;
	case 0x22e: zagg_kbd_mouse_map_key_clear(KEY_FORWARD); break;
	case 0x22f: zagg_kbd_mouse_map_key_clear(KEY_FAVORITES); break;
	case 0x230: zagg_kbd_mouse_map_key_clear(KEY_REFRESH); break;
	case 0x231: zagg_kbd_mouse_map_key_clear(KEY_STOP); break;
	default:
		return 0;
	}

	return 1;
}

static int zagg_kbd_input_mapping(struct hid_device *hdev,
	struct hid_input *hi, struct hid_field *field, struct hid_usage *usage,
	unsigned long **bit, int *max)
{
	if (!(HID_UP_CONSUMER == (usage->hid & HID_USAGE_PAGE) ||
			HID_UP_KEYBOARD == (usage->hid & HID_USAGE_PAGE)))
		return 0;

	dbg_hid("zagg wireless keyboard input mapping event [0x%x]\n",
		usage->hid & HID_USAGE);

	if (HID_UP_KEYBOARD == (usage->hid & HID_USAGE_PAGE)) { // 0x00070000 == (0x???????? & 0XFFFF0000)
		switch (usage->hid & HID_USAGE) { // 0X0000FFFF --> PS/2 Set 1 Make
		set_bit(EV_REP, hi->input->evbit);
		/* Only for UK keyboard */
		case 0x32: zagg_kbd_mouse_map_key_clear(KEY_BACKSLASH); break; // BACKSLASH
		case 0x64: zagg_kbd_mouse_map_key_clear(KEY_102ND); break; // PLUS
		default:
			return 0;
		}
	}

	if (HID_UP_CONSUMER == (usage->hid & HID_USAGE_PAGE)) { // 0x000C0000 == (0x???????? & 0XFFFF0000)
		switch (usage->hid & HID_USAGE) { // 0X0000FFFF --> PS/2 Set 1 Make
		/* report 2 */
		case 0x040: zagg_kbd_mouse_map_key_clear(KEY_MENU); break; // MENU
		case 0x18a: zagg_kbd_mouse_map_key_clear(KEY_MAIL); break; // EMAIL
		case 0x196: zagg_kbd_mouse_map_key_clear(KEY_WWW); break; // EXPLORER
		case 0x19e: zagg_kbd_mouse_map_key_clear(KEY_SCREENLOCK); break; // POWER
		case 0x221: zagg_kbd_mouse_map_key_clear(KEY_SEARCH); break; // SEARCH
		case 0x223: zagg_kbd_mouse_map_key_clear(KEY_HOMEPAGE); break; // HOME

		case 0x301: zagg_kbd_mouse_map_key_clear(BTN_TRIGGER_HAPPY1); break; // RECENTAPPS
		case 0x302: zagg_kbd_mouse_map_key_clear(BTN_TRIGGER_HAPPY2); break; // APPLICATION
		case 0x307: zagg_kbd_mouse_map_key_clear(BTN_TRIGGER_HAPPY3); break; // SIP_ON_OFF
		case 0x305: zagg_kbd_mouse_map_key_clear(BTN_TRIGGER_HAPPY4); break; // VOICESEARCH
		case 0x306: zagg_kbd_mouse_map_key_clear(BTN_TRIGGER_HAPPY5); break; // QPANEL_ON_OFF
		case 0x30c: zagg_kbd_mouse_map_key_clear(BTN_TRIGGER_HAPPY7); break; // SFINDER
		case 0x30d: zagg_kbd_mouse_map_key_clear(BTN_TRIGGER_HAPPY9); break; // MULTI_WINDOW

		case 0x308: zagg_kbd_mouse_map_key_clear(KEY_LANGUAGE); break; // LANGUAGE_SWITCH

		case 0x30a: zagg_kbd_mouse_map_key_clear(KEY_BRIGHTNESSDOWN); break; // BRIGHTNESS_DOWN
		case 0x30b: zagg_kbd_mouse_map_key_clear(KEY_BRIGHTNESSUP); break; // BRIGHTNESS_UP
		default:
			return 0;
		}
	}

	return 1;
}

static __u8 *zagg_report_fixup(struct hid_device *hdev, __u8 *rdesc,
	unsigned int *rsize)
{
	if (USB_DEVICE_ID_ZAGG_IR_REMOTE == hdev->product)
		rdesc = zagg_irda_report_fixup(hdev, rdesc, rsize);
	return rdesc;
}

static int zagg_input_mapping(struct hid_device *hdev, struct hid_input *hi,
	struct hid_field *field, struct hid_usage *usage,
	unsigned long **bit, int *max)
{
	int ret = 0;

	if (USB_DEVICE_ID_ZAGG_WIRELESS_KBD_MOUSE == hdev->product)
		ret = zagg_kbd_mouse_input_mapping(hdev,
			hi, field, usage, bit, max);
	else if (USB_DEVICE_ID_ZAGG_WIRELESS_KBD == hdev->product)
		ret = zagg_kbd_input_mapping(hdev,
			hi, field, usage, bit, max);

	return ret;
}

static int zagg_probe(struct hid_device *hdev,
		const struct hid_device_id *id)
{
	int ret;
	unsigned int cmask = HID_CONNECT_DEFAULT;

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

	if (USB_DEVICE_ID_ZAGG_IR_REMOTE == hdev->product) {
		if (hdev->rsize == 184) {
			/* disable hidinput, force hiddev */
			cmask = (cmask & ~HID_CONNECT_HIDINPUT) |
				HID_CONNECT_HIDDEV_FORCE;
		}
	}

	ret = hid_hw_start(hdev, cmask);
	if (ret) {
		hid_err(hdev, "hw start failed\n");
		goto err_free;
	}

	return 0;
err_free:
	return ret;
}

static const struct hid_device_id zagg_devices[] = {
	{ HID_USB_DEVICE(USB_VENDOR_ID_ZAGG, USB_DEVICE_ID_ZAGG_IR_REMOTE) },
	{ HID_USB_DEVICE(USB_VENDOR_ID_ZAGG, USB_DEVICE_ID_ZAGG_WIRELESS_KBD_MOUSE) },
	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_ZAGG, USB_DEVICE_ID_ZAGG_WIRELESS_KBD) },
	{ }
};
MODULE_DEVICE_TABLE(hid, zagg_devices);

static struct hid_driver zagg_driver = {
	.name = "zagg",
	.id_table = zagg_devices,
	.report_fixup = zagg_report_fixup,
	.input_mapping = zagg_input_mapping,
	.probe = zagg_probe,
};

static int __init zagg_init(void)
{
	return hid_register_driver(&zagg_driver);
}

static void __exit zagg_exit(void)
{
	hid_unregister_driver(&zagg_driver);
}

module_init(zagg_init);
module_exit(zagg_exit);
MODULE_LICENSE("GPL");