xref: /linux/drivers/hid/hid-input.c (revision 185000fc556372b7fb7f26516c325f212030dbd3)
1 /*
2  *  Copyright (c) 2000-2001 Vojtech Pavlik
3  *  Copyright (c) 2006-2007 Jiri Kosina
4  *
5  *  HID to Linux Input mapping
6  */
7 
8 /*
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22  *
23  * Should you need to contact me, the author, you can do so either by
24  * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
25  * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
26  */
27 
28 #include <linux/module.h>
29 #include <linux/slab.h>
30 #include <linux/kernel.h>
31 
32 #include <linux/hid.h>
33 #include <linux/hid-debug.h>
34 
35 static int hid_apple_fnmode = 1;
36 module_param_named(pb_fnmode, hid_apple_fnmode, int, 0644);
37 MODULE_PARM_DESC(pb_fnmode,
38 		"Mode of fn key on Apple keyboards (0 = disabled, 1 = fkeyslast, 2 = fkeysfirst)");
39 
40 #define unk	KEY_UNKNOWN
41 
42 static const unsigned char hid_keyboard[256] = {
43 	  0,  0,  0,  0, 30, 48, 46, 32, 18, 33, 34, 35, 23, 36, 37, 38,
44 	 50, 49, 24, 25, 16, 19, 31, 20, 22, 47, 17, 45, 21, 44,  2,  3,
45 	  4,  5,  6,  7,  8,  9, 10, 11, 28,  1, 14, 15, 57, 12, 13, 26,
46 	 27, 43, 43, 39, 40, 41, 51, 52, 53, 58, 59, 60, 61, 62, 63, 64,
47 	 65, 66, 67, 68, 87, 88, 99, 70,119,110,102,104,111,107,109,106,
48 	105,108,103, 69, 98, 55, 74, 78, 96, 79, 80, 81, 75, 76, 77, 71,
49 	 72, 73, 82, 83, 86,127,116,117,183,184,185,186,187,188,189,190,
50 	191,192,193,194,134,138,130,132,128,129,131,137,133,135,136,113,
51 	115,114,unk,unk,unk,121,unk, 89, 93,124, 92, 94, 95,unk,unk,unk,
52 	122,123, 90, 91, 85,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,
53 	unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,
54 	unk,unk,unk,unk,unk,unk,179,180,unk,unk,unk,unk,unk,unk,unk,unk,
55 	unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,
56 	unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,
57 	 29, 42, 56,125, 97, 54,100,126,164,166,165,163,161,115,114,113,
58 	150,158,159,128,136,177,178,176,142,152,173,140,unk,unk,unk,unk
59 };
60 
61 /* extended mapping for certain Logitech hardware (Logitech cordless desktop LX500) */
62 #define LOGITECH_EXPANDED_KEYMAP_SIZE 80
63 static int logitech_expanded_keymap[LOGITECH_EXPANDED_KEYMAP_SIZE] = {
64 	  0,216,  0,213,175,156,  0,  0,  0,  0,
65 	144,  0,  0,  0,  0,  0,  0,  0,  0,212,
66 	174,167,152,161,112,  0,  0,  0,154,  0,
67 	  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,
68 	  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,
69 	  0,  0,  0,  0,  0,  0,  0,  0,  0,  0,
70 	  0,  0,  0,  0,  0,183,184,185,186,187,
71 	188,189,190,191,192,193,194,  0,  0,  0
72 };
73 
74 static const struct {
75 	__s32 x;
76 	__s32 y;
77 }  hid_hat_to_axis[] = {{ 0, 0}, { 0,-1}, { 1,-1}, { 1, 0}, { 1, 1}, { 0, 1}, {-1, 1}, {-1, 0}, {-1,-1}};
78 
79 #define map_abs(c)	do { usage->code = c; usage->type = EV_ABS; bit = input->absbit; max = ABS_MAX; } while (0)
80 #define map_rel(c)	do { usage->code = c; usage->type = EV_REL; bit = input->relbit; max = REL_MAX; } while (0)
81 #define map_key(c)	do { usage->code = c; usage->type = EV_KEY; bit = input->keybit; max = KEY_MAX; } while (0)
82 #define map_led(c)	do { usage->code = c; usage->type = EV_LED; bit = input->ledbit; max = LED_MAX; } while (0)
83 
84 #define map_abs_clear(c)	do { map_abs(c); clear_bit(c, bit); } while (0)
85 #define map_key_clear(c)	do { map_key(c); clear_bit(c, bit); } while (0)
86 
87 #ifdef CONFIG_USB_HIDINPUT_POWERBOOK
88 
89 struct hidinput_key_translation {
90 	u16 from;
91 	u16 to;
92 	u8 flags;
93 };
94 
95 #define APPLE_FLAG_FKEY 0x01
96 
97 static struct hidinput_key_translation apple_fn_keys[] = {
98 	{ KEY_BACKSPACE, KEY_DELETE },
99 	{ KEY_F1,       KEY_BRIGHTNESSDOWN, APPLE_FLAG_FKEY },
100 	{ KEY_F2,       KEY_BRIGHTNESSUP,   APPLE_FLAG_FKEY },
101 	{ KEY_F3,       KEY_FN_F5,          APPLE_FLAG_FKEY }, /* Expos� */
102 	{ KEY_F4,       KEY_FN_F4,          APPLE_FLAG_FKEY }, /* Dashboard */
103 	{ KEY_F7,       KEY_PREVIOUSSONG,   APPLE_FLAG_FKEY },
104 	{ KEY_F8,       KEY_PLAYPAUSE,      APPLE_FLAG_FKEY },
105 	{ KEY_F9,       KEY_NEXTSONG,       APPLE_FLAG_FKEY },
106 	{ KEY_F10,      KEY_MUTE,           APPLE_FLAG_FKEY },
107 	{ KEY_F11,      KEY_VOLUMEDOWN,     APPLE_FLAG_FKEY },
108 	{ KEY_F12,      KEY_VOLUMEUP,       APPLE_FLAG_FKEY },
109 	{ KEY_UP,       KEY_PAGEUP },
110 	{ KEY_DOWN,     KEY_PAGEDOWN },
111 	{ KEY_LEFT,     KEY_HOME },
112 	{ KEY_RIGHT,    KEY_END },
113 	{ }
114 };
115 
116 static struct hidinput_key_translation powerbook_fn_keys[] = {
117 	{ KEY_BACKSPACE, KEY_DELETE },
118 	{ KEY_F1,       KEY_BRIGHTNESSDOWN,     APPLE_FLAG_FKEY },
119 	{ KEY_F2,       KEY_BRIGHTNESSUP,       APPLE_FLAG_FKEY },
120 	{ KEY_F3,       KEY_MUTE,               APPLE_FLAG_FKEY },
121 	{ KEY_F4,       KEY_VOLUMEDOWN,         APPLE_FLAG_FKEY },
122 	{ KEY_F5,       KEY_VOLUMEUP,           APPLE_FLAG_FKEY },
123 	{ KEY_F6,       KEY_NUMLOCK,            APPLE_FLAG_FKEY },
124 	{ KEY_F7,       KEY_SWITCHVIDEOMODE,    APPLE_FLAG_FKEY },
125 	{ KEY_F8,       KEY_KBDILLUMTOGGLE,     APPLE_FLAG_FKEY },
126 	{ KEY_F9,       KEY_KBDILLUMDOWN,       APPLE_FLAG_FKEY },
127 	{ KEY_F10,      KEY_KBDILLUMUP,         APPLE_FLAG_FKEY },
128 	{ KEY_UP,       KEY_PAGEUP },
129 	{ KEY_DOWN,     KEY_PAGEDOWN },
130 	{ KEY_LEFT,     KEY_HOME },
131 	{ KEY_RIGHT,    KEY_END },
132 	{ }
133 };
134 
135 static struct hidinput_key_translation powerbook_numlock_keys[] = {
136 	{ KEY_J,        KEY_KP1 },
137 	{ KEY_K,        KEY_KP2 },
138 	{ KEY_L,        KEY_KP3 },
139 	{ KEY_U,        KEY_KP4 },
140 	{ KEY_I,        KEY_KP5 },
141 	{ KEY_O,        KEY_KP6 },
142 	{ KEY_7,        KEY_KP7 },
143 	{ KEY_8,        KEY_KP8 },
144 	{ KEY_9,        KEY_KP9 },
145 	{ KEY_M,        KEY_KP0 },
146 	{ KEY_DOT,      KEY_KPDOT },
147 	{ KEY_SLASH,    KEY_KPPLUS },
148 	{ KEY_SEMICOLON, KEY_KPMINUS },
149 	{ KEY_P,        KEY_KPASTERISK },
150 	{ KEY_MINUS,    KEY_KPEQUAL },
151 	{ KEY_0,        KEY_KPSLASH },
152 	{ KEY_F6,       KEY_NUMLOCK },
153 	{ KEY_KPENTER,  KEY_KPENTER },
154 	{ KEY_BACKSPACE, KEY_BACKSPACE },
155 	{ }
156 };
157 
158 static struct hidinput_key_translation apple_iso_keyboard[] = {
159 	{ KEY_GRAVE,    KEY_102ND },
160 	{ KEY_102ND,    KEY_GRAVE },
161 	{ }
162 };
163 
164 static struct hidinput_key_translation *find_translation(struct hidinput_key_translation *table, u16 from)
165 {
166 	struct hidinput_key_translation *trans;
167 
168 	/* Look for the translation */
169 	for (trans = table; trans->from; trans++)
170 		if (trans->from == from)
171 			return trans;
172 
173 	return NULL;
174 }
175 
176 int hidinput_apple_event(struct hid_device *hid, struct input_dev *input,
177 		struct hid_usage *usage, __s32 value)
178 {
179 	struct hidinput_key_translation *trans;
180 
181 	if (usage->code == KEY_FN) {
182 		if (value) hid->quirks |=  HID_QUIRK_APPLE_FN_ON;
183 		else       hid->quirks &= ~HID_QUIRK_APPLE_FN_ON;
184 
185 		input_event(input, usage->type, usage->code, value);
186 
187 		return 1;
188 	}
189 
190 	if (hid_apple_fnmode) {
191 		int do_translate;
192 
193 		trans = find_translation((hid->product < 0x220 ||
194 					  hid->product >= 0x300) ?
195 					 powerbook_fn_keys : apple_fn_keys,
196 					 usage->code);
197 		if (trans) {
198 			if (test_bit(usage->code, hid->apple_pressed_fn))
199 				do_translate = 1;
200 			else if (trans->flags & APPLE_FLAG_FKEY)
201 				do_translate =
202 					(hid_apple_fnmode == 2 &&  (hid->quirks & HID_QUIRK_APPLE_FN_ON)) ||
203 					(hid_apple_fnmode == 1 && !(hid->quirks & HID_QUIRK_APPLE_FN_ON));
204 			else
205 				do_translate = (hid->quirks & HID_QUIRK_APPLE_FN_ON);
206 
207 			if (do_translate) {
208 				if (value)
209 					set_bit(usage->code, hid->apple_pressed_fn);
210 				else
211 					clear_bit(usage->code, hid->apple_pressed_fn);
212 
213 				input_event(input, usage->type, trans->to, value);
214 
215 				return 1;
216 			}
217 		}
218 
219 		if (hid->quirks & HID_QUIRK_APPLE_NUMLOCK_EMULATION && (
220 				test_bit(usage->code, hid->pb_pressed_numlock) ||
221 				test_bit(LED_NUML, input->led))) {
222 			trans = find_translation(powerbook_numlock_keys, usage->code);
223 
224 			if (trans) {
225 				if (value)
226 					set_bit(usage->code, hid->pb_pressed_numlock);
227 				else
228 					clear_bit(usage->code, hid->pb_pressed_numlock);
229 
230 				input_event(input, usage->type, trans->to, value);
231 			}
232 
233 			return 1;
234 		}
235 	}
236 
237 	if (hid->quirks & HID_QUIRK_APPLE_ISO_KEYBOARD) {
238 		trans = find_translation(apple_iso_keyboard, usage->code);
239 		if (trans) {
240 			input_event(input, usage->type, trans->to, value);
241 			return 1;
242 		}
243 	}
244 
245 	return 0;
246 }
247 
248 static void hidinput_apple_setup(struct input_dev *input)
249 {
250 	struct hidinput_key_translation *trans;
251 
252 	set_bit(KEY_NUMLOCK, input->keybit);
253 
254 	/* Enable all needed keys */
255 	for (trans = apple_fn_keys; trans->from; trans++)
256 		set_bit(trans->to, input->keybit);
257 
258 	for (trans = powerbook_fn_keys; trans->from; trans++)
259 		set_bit(trans->to, input->keybit);
260 
261 	for (trans = powerbook_numlock_keys; trans->from; trans++)
262 		set_bit(trans->to, input->keybit);
263 
264 	for (trans = apple_iso_keyboard; trans->from; trans++)
265 		set_bit(trans->to, input->keybit);
266 
267 }
268 #else
269 inline int hidinput_apple_event(struct hid_device *hid,
270 				       struct input_dev *input,
271 				       struct hid_usage *usage, __s32 value)
272 {
273 	return 0;
274 }
275 
276 static inline void hidinput_apple_setup(struct input_dev *input)
277 {
278 }
279 #endif
280 
281 static inline int match_scancode(int code, int scancode)
282 {
283 	if (scancode == 0)
284 		return 1;
285 	return ((code & (HID_USAGE_PAGE | HID_USAGE)) == scancode);
286 }
287 
288 static inline int match_keycode(int code, int keycode)
289 {
290 	if (keycode == 0)
291 		return 1;
292 	return (code == keycode);
293 }
294 
295 static struct hid_usage *hidinput_find_key(struct hid_device *hid,
296 		int scancode, int keycode)
297 {
298 	int i, j, k;
299 	struct hid_report *report;
300 	struct hid_usage *usage;
301 
302 	for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
303 		list_for_each_entry(report, &hid->report_enum[k].report_list, list) {
304 			for (i = 0; i < report->maxfield; i++) {
305 				for ( j = 0; j < report->field[i]->maxusage; j++) {
306 					usage = report->field[i]->usage + j;
307 					if (usage->type == EV_KEY &&
308 						match_scancode(usage->hid, scancode) &&
309 						match_keycode(usage->code, keycode))
310 						return usage;
311 				}
312 			}
313 		}
314 	}
315 	return NULL;
316 }
317 
318 static int hidinput_getkeycode(struct input_dev *dev, int scancode,
319 				int *keycode)
320 {
321 	struct hid_device *hid = input_get_drvdata(dev);
322 	struct hid_usage *usage;
323 
324 	usage = hidinput_find_key(hid, scancode, 0);
325 	if (usage) {
326 		*keycode = usage->code;
327 		return 0;
328 	}
329 	return -EINVAL;
330 }
331 
332 static int hidinput_setkeycode(struct input_dev *dev, int scancode,
333 				int keycode)
334 {
335 	struct hid_device *hid = input_get_drvdata(dev);
336 	struct hid_usage *usage;
337 	int old_keycode;
338 
339 	if (keycode < 0 || keycode > KEY_MAX)
340 		return -EINVAL;
341 
342 	usage = hidinput_find_key(hid, scancode, 0);
343 	if (usage) {
344 		old_keycode = usage->code;
345 		usage->code = keycode;
346 
347 		clear_bit(old_keycode, dev->keybit);
348 		set_bit(usage->code, dev->keybit);
349 		dbg_hid(KERN_DEBUG "Assigned keycode %d to HID usage code %x\n", keycode, scancode);
350 		/* Set the keybit for the old keycode if the old keycode is used
351 		 * by another key */
352 		if (hidinput_find_key (hid, 0, old_keycode))
353 			set_bit(old_keycode, dev->keybit);
354 
355 		return 0;
356 	}
357 
358 	return -EINVAL;
359 }
360 
361 
362 static void hidinput_configure_usage(struct hid_input *hidinput, struct hid_field *field,
363 				     struct hid_usage *usage)
364 {
365 	struct input_dev *input = hidinput->input;
366 	struct hid_device *device = input_get_drvdata(input);
367 	int max = 0, code, ret;
368 	unsigned long *bit = NULL;
369 
370 	field->hidinput = hidinput;
371 
372 	dbg_hid("Mapping: ");
373 	hid_resolv_usage(usage->hid);
374 	dbg_hid_line(" ---> ");
375 
376 	if (field->flags & HID_MAIN_ITEM_CONSTANT)
377 		goto ignore;
378 
379 	/* only LED usages are supported in output fields */
380 	if (field->report_type == HID_OUTPUT_REPORT &&
381 			(usage->hid & HID_USAGE_PAGE) != HID_UP_LED) {
382 		dbg_hid_line(" [non-LED output field] ");
383 		goto ignore;
384 	}
385 
386 	/* handle input mappings for quirky devices */
387 	ret = hidinput_mapping_quirks(usage, input, &bit, &max);
388 	if (ret)
389 		goto mapped;
390 
391 	switch (usage->hid & HID_USAGE_PAGE) {
392 
393 		case HID_UP_UNDEFINED:
394 			goto ignore;
395 
396 		case HID_UP_KEYBOARD:
397 
398 			set_bit(EV_REP, input->evbit);
399 
400 			if ((usage->hid & HID_USAGE) < 256) {
401 				if (!hid_keyboard[usage->hid & HID_USAGE]) goto ignore;
402 				map_key_clear(hid_keyboard[usage->hid & HID_USAGE]);
403 			} else
404 				map_key(KEY_UNKNOWN);
405 
406 			break;
407 
408 		case HID_UP_BUTTON:
409 
410 			code = ((usage->hid - 1) & 0xf);
411 
412 			switch (field->application) {
413 				case HID_GD_MOUSE:
414 				case HID_GD_POINTER:  code += 0x110; break;
415 				case HID_GD_JOYSTICK: code += 0x120; break;
416 				case HID_GD_GAMEPAD:  code += 0x130; break;
417 				default:
418 					switch (field->physical) {
419 						case HID_GD_MOUSE:
420 						case HID_GD_POINTER:  code += 0x110; break;
421 						case HID_GD_JOYSTICK: code += 0x120; break;
422 						case HID_GD_GAMEPAD:  code += 0x130; break;
423 						default:              code += 0x100;
424 					}
425 			}
426 
427 			/* Special handling for Logitech Cordless Desktop */
428 			if (field->application != HID_GD_MOUSE) {
429 				if (device->quirks & HID_QUIRK_LOGITECH_EXPANDED_KEYMAP) {
430 					int hid = usage->hid & HID_USAGE;
431 					if (hid < LOGITECH_EXPANDED_KEYMAP_SIZE && logitech_expanded_keymap[hid] != 0)
432 						code = logitech_expanded_keymap[hid];
433 				}
434 			} else {
435 				if (device->quirks & HID_QUIRK_LOGITECH_IGNORE_DOUBLED_WHEEL) {
436 					int hid = usage->hid & HID_USAGE;
437 					if (hid == 7 || hid == 8)
438 						goto ignore;
439 				}
440 			}
441 
442 			map_key(code);
443 			break;
444 
445 
446 		case HID_UP_SIMULATION:
447 
448 			switch (usage->hid & 0xffff) {
449 				case 0xba: map_abs(ABS_RUDDER);   break;
450 				case 0xbb: map_abs(ABS_THROTTLE); break;
451 				case 0xc4: map_abs(ABS_GAS);      break;
452 				case 0xc5: map_abs(ABS_BRAKE);    break;
453 				case 0xc8: map_abs(ABS_WHEEL);    break;
454 				default:   goto ignore;
455 			}
456 			break;
457 
458 		case HID_UP_GENDESK:
459 
460 			if ((usage->hid & 0xf0) == 0x80) {	/* SystemControl */
461 				switch (usage->hid & 0xf) {
462 					case 0x1: map_key_clear(KEY_POWER);  break;
463 					case 0x2: map_key_clear(KEY_SLEEP);  break;
464 					case 0x3: map_key_clear(KEY_WAKEUP); break;
465 					default: goto unknown;
466 				}
467 				break;
468 			}
469 
470 			if ((usage->hid & 0xf0) == 0x90) {	/* D-pad */
471 				switch (usage->hid) {
472 					case HID_GD_UP:	   usage->hat_dir = 1; break;
473 					case HID_GD_DOWN:  usage->hat_dir = 5; break;
474 					case HID_GD_RIGHT: usage->hat_dir = 3; break;
475 					case HID_GD_LEFT:  usage->hat_dir = 7; break;
476 					default: goto unknown;
477 				}
478 				if (field->dpad) {
479 					map_abs(field->dpad);
480 					goto ignore;
481 				}
482 				map_abs(ABS_HAT0X);
483 				break;
484 			}
485 
486 			switch (usage->hid) {
487 
488 				/* These usage IDs map directly to the usage codes. */
489 				case HID_GD_X: case HID_GD_Y: case HID_GD_Z:
490 				case HID_GD_RX: case HID_GD_RY: case HID_GD_RZ:
491 				case HID_GD_SLIDER: case HID_GD_DIAL: case HID_GD_WHEEL:
492 					if (field->flags & HID_MAIN_ITEM_RELATIVE)
493 						map_rel(usage->hid & 0xf);
494 					else
495 						map_abs(usage->hid & 0xf);
496 					break;
497 
498 				case HID_GD_HATSWITCH:
499 					usage->hat_min = field->logical_minimum;
500 					usage->hat_max = field->logical_maximum;
501 					map_abs(ABS_HAT0X);
502 					break;
503 
504 				case HID_GD_START:	map_key_clear(BTN_START);	break;
505 				case HID_GD_SELECT:	map_key_clear(BTN_SELECT);	break;
506 
507 				default: goto unknown;
508 			}
509 
510 			break;
511 
512 		case HID_UP_LED:
513 
514 			switch (usage->hid & 0xffff) {                        /* HID-Value:                   */
515 				case 0x01:  map_led (LED_NUML);     break;    /*   "Num Lock"                 */
516 				case 0x02:  map_led (LED_CAPSL);    break;    /*   "Caps Lock"                */
517 				case 0x03:  map_led (LED_SCROLLL);  break;    /*   "Scroll Lock"              */
518 				case 0x04:  map_led (LED_COMPOSE);  break;    /*   "Compose"                  */
519 				case 0x05:  map_led (LED_KANA);     break;    /*   "Kana"                     */
520 				case 0x27:  map_led (LED_SLEEP);    break;    /*   "Stand-By"                 */
521 				case 0x4c:  map_led (LED_SUSPEND);  break;    /*   "System Suspend"           */
522 				case 0x09:  map_led (LED_MUTE);     break;    /*   "Mute"                     */
523 				case 0x4b:  map_led (LED_MISC);     break;    /*   "Generic Indicator"        */
524 				case 0x19:  map_led (LED_MAIL);     break;    /*   "Message Waiting"          */
525 				case 0x4d:  map_led (LED_CHARGING); break;    /*   "External Power Connected" */
526 
527 				default: goto ignore;
528 			}
529 			break;
530 
531 		case HID_UP_DIGITIZER:
532 
533 			switch (usage->hid & 0xff) {
534 
535 				case 0x30: /* TipPressure */
536 					if (!test_bit(BTN_TOUCH, input->keybit)) {
537 						device->quirks |= HID_QUIRK_NOTOUCH;
538 						set_bit(EV_KEY, input->evbit);
539 						set_bit(BTN_TOUCH, input->keybit);
540 					}
541 
542 					map_abs_clear(ABS_PRESSURE);
543 					break;
544 
545 				case 0x32: /* InRange */
546 					switch (field->physical & 0xff) {
547 						case 0x21: map_key(BTN_TOOL_MOUSE); break;
548 						case 0x22: map_key(BTN_TOOL_FINGER); break;
549 						default: map_key(BTN_TOOL_PEN); break;
550 					}
551 					break;
552 
553 				case 0x3c: /* Invert */
554 					map_key_clear(BTN_TOOL_RUBBER);
555 					break;
556 
557 				case 0x33: /* Touch */
558 				case 0x42: /* TipSwitch */
559 				case 0x43: /* TipSwitch2 */
560 					device->quirks &= ~HID_QUIRK_NOTOUCH;
561 					map_key_clear(BTN_TOUCH);
562 					break;
563 
564 				case 0x44: /* BarrelSwitch */
565 					map_key_clear(BTN_STYLUS);
566 					break;
567 
568 				default:  goto unknown;
569 			}
570 			break;
571 
572 		case HID_UP_CONSUMER:	/* USB HUT v1.1, pages 56-62 */
573 
574 			switch (usage->hid & HID_USAGE) {
575 				case 0x000: goto ignore;
576 				case 0x034: map_key_clear(KEY_SLEEP);		break;
577 				case 0x036: map_key_clear(BTN_MISC);		break;
578 
579 				case 0x040: map_key_clear(KEY_MENU);		break;
580 				case 0x045: map_key_clear(KEY_RADIO);		break;
581 
582 				case 0x083: map_key_clear(KEY_LAST);		break;
583 				case 0x088: map_key_clear(KEY_PC);		break;
584 				case 0x089: map_key_clear(KEY_TV);		break;
585 				case 0x08a: map_key_clear(KEY_WWW);		break;
586 				case 0x08b: map_key_clear(KEY_DVD);		break;
587 				case 0x08c: map_key_clear(KEY_PHONE);		break;
588 				case 0x08d: map_key_clear(KEY_PROGRAM);		break;
589 				case 0x08e: map_key_clear(KEY_VIDEOPHONE);	break;
590 				case 0x08f: map_key_clear(KEY_GAMES);		break;
591 				case 0x090: map_key_clear(KEY_MEMO);		break;
592 				case 0x091: map_key_clear(KEY_CD);		break;
593 				case 0x092: map_key_clear(KEY_VCR);		break;
594 				case 0x093: map_key_clear(KEY_TUNER);		break;
595 				case 0x094: map_key_clear(KEY_EXIT);		break;
596 				case 0x095: map_key_clear(KEY_HELP);		break;
597 				case 0x096: map_key_clear(KEY_TAPE);		break;
598 				case 0x097: map_key_clear(KEY_TV2);		break;
599 				case 0x098: map_key_clear(KEY_SAT);		break;
600 				case 0x09a: map_key_clear(KEY_PVR);		break;
601 
602 				case 0x09c: map_key_clear(KEY_CHANNELUP);	break;
603 				case 0x09d: map_key_clear(KEY_CHANNELDOWN);	break;
604 				case 0x0a0: map_key_clear(KEY_VCR2);		break;
605 
606 				case 0x0b0: map_key_clear(KEY_PLAY);		break;
607 				case 0x0b1: map_key_clear(KEY_PAUSE);		break;
608 				case 0x0b2: map_key_clear(KEY_RECORD);		break;
609 				case 0x0b3: map_key_clear(KEY_FASTFORWARD);	break;
610 				case 0x0b4: map_key_clear(KEY_REWIND);		break;
611 				case 0x0b5: map_key_clear(KEY_NEXTSONG);	break;
612 				case 0x0b6: map_key_clear(KEY_PREVIOUSSONG);	break;
613 				case 0x0b7: map_key_clear(KEY_STOPCD);		break;
614 				case 0x0b8: map_key_clear(KEY_EJECTCD);		break;
615 
616 				case 0x0cd: map_key_clear(KEY_PLAYPAUSE);	break;
617 			        case 0x0e0: map_abs_clear(ABS_VOLUME);		break;
618 				case 0x0e2: map_key_clear(KEY_MUTE);		break;
619 				case 0x0e5: map_key_clear(KEY_BASSBOOST);	break;
620 				case 0x0e9: map_key_clear(KEY_VOLUMEUP);	break;
621 				case 0x0ea: map_key_clear(KEY_VOLUMEDOWN);	break;
622 
623 				case 0x182: map_key_clear(KEY_BOOKMARKS);	break;
624 				case 0x183: map_key_clear(KEY_CONFIG);		break;
625 				case 0x184: map_key_clear(KEY_WORDPROCESSOR);	break;
626 				case 0x185: map_key_clear(KEY_EDITOR);		break;
627 				case 0x186: map_key_clear(KEY_SPREADSHEET);	break;
628 				case 0x187: map_key_clear(KEY_GRAPHICSEDITOR);	break;
629 				case 0x188: map_key_clear(KEY_PRESENTATION);	break;
630 				case 0x189: map_key_clear(KEY_DATABASE);	break;
631 				case 0x18a: map_key_clear(KEY_MAIL);		break;
632 				case 0x18b: map_key_clear(KEY_NEWS);		break;
633 				case 0x18c: map_key_clear(KEY_VOICEMAIL);	break;
634 				case 0x18d: map_key_clear(KEY_ADDRESSBOOK);	break;
635 				case 0x18e: map_key_clear(KEY_CALENDAR);	break;
636 				case 0x191: map_key_clear(KEY_FINANCE);		break;
637 				case 0x192: map_key_clear(KEY_CALC);		break;
638 				case 0x194: map_key_clear(KEY_FILE);		break;
639 				case 0x196: map_key_clear(KEY_WWW);		break;
640 				case 0x19c: map_key_clear(KEY_LOGOFF);		break;
641 				case 0x19e: map_key_clear(KEY_COFFEE);		break;
642 				case 0x1a6: map_key_clear(KEY_HELP);		break;
643 				case 0x1a7: map_key_clear(KEY_DOCUMENTS);	break;
644 				case 0x1ab: map_key_clear(KEY_SPELLCHECK);	break;
645 				case 0x1b6: map_key_clear(KEY_MEDIA);		break;
646 				case 0x1b7: map_key_clear(KEY_SOUND);		break;
647 				case 0x1bc: map_key_clear(KEY_MESSENGER);	break;
648 				case 0x1bd: map_key_clear(KEY_INFO);		break;
649 				case 0x201: map_key_clear(KEY_NEW);		break;
650 				case 0x202: map_key_clear(KEY_OPEN);		break;
651 				case 0x203: map_key_clear(KEY_CLOSE);		break;
652 				case 0x204: map_key_clear(KEY_EXIT);		break;
653 				case 0x207: map_key_clear(KEY_SAVE);		break;
654 				case 0x208: map_key_clear(KEY_PRINT);		break;
655 				case 0x209: map_key_clear(KEY_PROPS);		break;
656 				case 0x21a: map_key_clear(KEY_UNDO);		break;
657 				case 0x21b: map_key_clear(KEY_COPY);		break;
658 				case 0x21c: map_key_clear(KEY_CUT);		break;
659 				case 0x21d: map_key_clear(KEY_PASTE);		break;
660 				case 0x21f: map_key_clear(KEY_FIND);		break;
661 				case 0x221: map_key_clear(KEY_SEARCH);		break;
662 				case 0x222: map_key_clear(KEY_GOTO);		break;
663 				case 0x223: map_key_clear(KEY_HOMEPAGE);	break;
664 				case 0x224: map_key_clear(KEY_BACK);		break;
665 				case 0x225: map_key_clear(KEY_FORWARD);		break;
666 				case 0x226: map_key_clear(KEY_STOP);		break;
667 				case 0x227: map_key_clear(KEY_REFRESH);		break;
668 				case 0x22a: map_key_clear(KEY_BOOKMARKS);	break;
669 				case 0x22d: map_key_clear(KEY_ZOOMIN);		break;
670 				case 0x22e: map_key_clear(KEY_ZOOMOUT);		break;
671 				case 0x22f: map_key_clear(KEY_ZOOMRESET);	break;
672 				case 0x233: map_key_clear(KEY_SCROLLUP);	break;
673 				case 0x234: map_key_clear(KEY_SCROLLDOWN);	break;
674 				case 0x238: map_rel(REL_HWHEEL);		break;
675 				case 0x25f: map_key_clear(KEY_CANCEL);		break;
676 				case 0x279: map_key_clear(KEY_REDO);		break;
677 
678 				case 0x289: map_key_clear(KEY_REPLY);		break;
679 				case 0x28b: map_key_clear(KEY_FORWARDMAIL);	break;
680 				case 0x28c: map_key_clear(KEY_SEND);		break;
681 
682 				default:    goto ignore;
683 			}
684 			break;
685 
686 		case HID_UP_HPVENDOR:	/* Reported on a Dutch layout HP5308 */
687 
688 			set_bit(EV_REP, input->evbit);
689 			switch (usage->hid & HID_USAGE) {
690 			        case 0x021: map_key_clear(KEY_PRINT);           break;
691 				case 0x070: map_key_clear(KEY_HP);		break;
692 				case 0x071: map_key_clear(KEY_CAMERA);		break;
693 				case 0x072: map_key_clear(KEY_SOUND);		break;
694 				case 0x073: map_key_clear(KEY_QUESTION);	break;
695 				case 0x080: map_key_clear(KEY_EMAIL);		break;
696 				case 0x081: map_key_clear(KEY_CHAT);		break;
697 				case 0x082: map_key_clear(KEY_SEARCH);		break;
698 				case 0x083: map_key_clear(KEY_CONNECT);	        break;
699 				case 0x084: map_key_clear(KEY_FINANCE);		break;
700 				case 0x085: map_key_clear(KEY_SPORT);		break;
701 				case 0x086: map_key_clear(KEY_SHOP);	        break;
702 				default:    goto ignore;
703 			}
704 			break;
705 
706 		case HID_UP_MSVENDOR:
707 
708 			goto ignore;
709 
710 		case HID_UP_CUSTOM: /* Reported on Logitech and Apple USB keyboards */
711 
712 			set_bit(EV_REP, input->evbit);
713 			switch(usage->hid & HID_USAGE) {
714 				case 0x003:
715 					/* The fn key on Apple USB keyboards */
716 					map_key_clear(KEY_FN);
717 					hidinput_apple_setup(input);
718 					break;
719 
720 				default:    goto ignore;
721 			}
722 			break;
723 
724 		case HID_UP_LOGIVENDOR:
725 
726 			goto ignore;
727 
728 		case HID_UP_PID:
729 
730 			switch(usage->hid & HID_USAGE) {
731 				case 0xa4: map_key_clear(BTN_DEAD);	break;
732 				default: goto ignore;
733 			}
734 			break;
735 
736 		default:
737 		unknown:
738 			if (field->report_size == 1) {
739 				if (field->report->type == HID_OUTPUT_REPORT) {
740 					map_led(LED_MISC);
741 					break;
742 				}
743 				map_key(BTN_MISC);
744 				break;
745 			}
746 			if (field->flags & HID_MAIN_ITEM_RELATIVE) {
747 				map_rel(REL_MISC);
748 				break;
749 			}
750 			map_abs(ABS_MISC);
751 			break;
752 	}
753 
754 mapped:
755 	if (device->quirks & HID_QUIRK_MIGHTYMOUSE) {
756 		if (usage->hid == HID_GD_Z)
757 			map_rel(REL_HWHEEL);
758 		else if (usage->code == BTN_1)
759 			map_key(BTN_2);
760 		else if (usage->code == BTN_2)
761 			map_key(BTN_1);
762 	}
763 
764 	if ((device->quirks & (HID_QUIRK_2WHEEL_MOUSE_HACK_7 | HID_QUIRK_2WHEEL_MOUSE_HACK_5 |
765 			HID_QUIRK_2WHEEL_MOUSE_HACK_B8)) && (usage->type == EV_REL) &&
766 			(usage->code == REL_WHEEL))
767 		set_bit(REL_HWHEEL, bit);
768 
769 	if (((device->quirks & HID_QUIRK_2WHEEL_MOUSE_HACK_5) && (usage->hid == 0x00090005))
770 		|| ((device->quirks & HID_QUIRK_2WHEEL_MOUSE_HACK_7) && (usage->hid == 0x00090007)))
771 		goto ignore;
772 
773 	if ((device->quirks & HID_QUIRK_BAD_RELATIVE_KEYS) &&
774 		usage->type == EV_KEY && (field->flags & HID_MAIN_ITEM_RELATIVE))
775 		field->flags &= ~HID_MAIN_ITEM_RELATIVE;
776 
777 	set_bit(usage->type, input->evbit);
778 
779 	if (device->quirks & HID_QUIRK_DUPLICATE_USAGES &&
780 			(usage->type == EV_KEY ||
781 			 usage->type == EV_REL ||
782 			 usage->type == EV_ABS))
783 		clear_bit(usage->code, bit);
784 
785 	while (usage->code <= max && test_and_set_bit(usage->code, bit))
786 		usage->code = find_next_zero_bit(bit, max + 1, usage->code);
787 
788 	if (usage->code > max)
789 		goto ignore;
790 
791 
792 	if (usage->type == EV_ABS) {
793 
794 		int a = field->logical_minimum;
795 		int b = field->logical_maximum;
796 
797 		if ((device->quirks & HID_QUIRK_BADPAD) && (usage->code == ABS_X || usage->code == ABS_Y)) {
798 			a = field->logical_minimum = 0;
799 			b = field->logical_maximum = 255;
800 		}
801 
802 		if (field->application == HID_GD_GAMEPAD || field->application == HID_GD_JOYSTICK)
803 			input_set_abs_params(input, usage->code, a, b, (b - a) >> 8, (b - a) >> 4);
804 		else	input_set_abs_params(input, usage->code, a, b, 0, 0);
805 
806 	}
807 
808 	if (usage->type == EV_ABS &&
809 	    (usage->hat_min < usage->hat_max || usage->hat_dir)) {
810 		int i;
811 		for (i = usage->code; i < usage->code + 2 && i <= max; i++) {
812 			input_set_abs_params(input, i, -1, 1, 0, 0);
813 			set_bit(i, input->absbit);
814 		}
815 		if (usage->hat_dir && !field->dpad)
816 			field->dpad = usage->code;
817 	}
818 
819 	/* for those devices which produce Consumer volume usage as relative,
820 	 * we emulate pressing volumeup/volumedown appropriate number of times
821 	 * in hidinput_hid_event()
822 	 */
823 	if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
824 			(usage->code == ABS_VOLUME)) {
825 		set_bit(KEY_VOLUMEUP, input->keybit);
826 		set_bit(KEY_VOLUMEDOWN, input->keybit);
827 	}
828 
829 	if (usage->type == EV_KEY) {
830 		set_bit(EV_MSC, input->evbit);
831 		set_bit(MSC_SCAN, input->mscbit);
832 	}
833 
834 	hid_resolv_event(usage->type, usage->code);
835 
836 	dbg_hid_line("\n");
837 
838 	return;
839 
840 ignore:
841 	dbg_hid_line("IGNORED\n");
842 	return;
843 }
844 
845 void hidinput_hid_event(struct hid_device *hid, struct hid_field *field, struct hid_usage *usage, __s32 value)
846 {
847 	struct input_dev *input;
848 	unsigned *quirks = &hid->quirks;
849 
850 	if (!field->hidinput)
851 		return;
852 
853 	input = field->hidinput->input;
854 
855 	if (!usage->type)
856 		return;
857 
858 	/* handle input events for quirky devices */
859 	if (hidinput_event_quirks(hid, field, usage, value))
860 		return;
861 
862 	if (usage->hat_min < usage->hat_max || usage->hat_dir) {
863 		int hat_dir = usage->hat_dir;
864 		if (!hat_dir)
865 			hat_dir = (value - usage->hat_min) * 8 / (usage->hat_max - usage->hat_min + 1) + 1;
866 		if (hat_dir < 0 || hat_dir > 8) hat_dir = 0;
867 		input_event(input, usage->type, usage->code    , hid_hat_to_axis[hat_dir].x);
868                 input_event(input, usage->type, usage->code + 1, hid_hat_to_axis[hat_dir].y);
869                 return;
870         }
871 
872 	if (usage->hid == (HID_UP_DIGITIZER | 0x003c)) { /* Invert */
873 		*quirks = value ? (*quirks | HID_QUIRK_INVERT) : (*quirks & ~HID_QUIRK_INVERT);
874 		return;
875 	}
876 
877 	if (usage->hid == (HID_UP_DIGITIZER | 0x0032)) { /* InRange */
878 		if (value) {
879 			input_event(input, usage->type, (*quirks & HID_QUIRK_INVERT) ? BTN_TOOL_RUBBER : usage->code, 1);
880 			return;
881 		}
882 		input_event(input, usage->type, usage->code, 0);
883 		input_event(input, usage->type, BTN_TOOL_RUBBER, 0);
884 		return;
885 	}
886 
887 	if (usage->hid == (HID_UP_DIGITIZER | 0x0030) && (*quirks & HID_QUIRK_NOTOUCH)) { /* Pressure */
888 		int a = field->logical_minimum;
889 		int b = field->logical_maximum;
890 		input_event(input, EV_KEY, BTN_TOUCH, value > a + ((b - a) >> 3));
891 	}
892 
893 	if (usage->hid == (HID_UP_PID | 0x83UL)) { /* Simultaneous Effects Max */
894 		dbg_hid("Maximum Effects - %d\n",value);
895 		return;
896 	}
897 
898 	if (usage->hid == (HID_UP_PID | 0x7fUL)) {
899 		dbg_hid("PID Pool Report\n");
900 		return;
901 	}
902 
903 	if ((usage->type == EV_KEY) && (usage->code == 0)) /* Key 0 is "unassigned", not KEY_UNKNOWN */
904 		return;
905 
906 	if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
907 			(usage->code == ABS_VOLUME)) {
908 		int count = abs(value);
909 		int direction = value > 0 ? KEY_VOLUMEUP : KEY_VOLUMEDOWN;
910 		int i;
911 
912 		for (i = 0; i < count; i++) {
913 			input_event(input, EV_KEY, direction, 1);
914 			input_sync(input);
915 			input_event(input, EV_KEY, direction, 0);
916 			input_sync(input);
917 		}
918 		return;
919 	}
920 
921 	/* report the usage code as scancode if the key status has changed */
922 	if (usage->type == EV_KEY && !!test_bit(usage->code, input->key) != value)
923 		input_event(input, EV_MSC, MSC_SCAN, usage->hid);
924 
925 	input_event(input, usage->type, usage->code, value);
926 
927 	if ((field->flags & HID_MAIN_ITEM_RELATIVE) && (usage->type == EV_KEY))
928 		input_event(input, usage->type, usage->code, 0);
929 }
930 
931 void hidinput_report_event(struct hid_device *hid, struct hid_report *report)
932 {
933 	struct hid_input *hidinput;
934 
935 	list_for_each_entry(hidinput, &hid->inputs, list)
936 		input_sync(hidinput->input);
937 }
938 EXPORT_SYMBOL_GPL(hidinput_report_event);
939 
940 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field)
941 {
942 	struct hid_report *report;
943 	int i, j;
944 
945 	list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
946 		for (i = 0; i < report->maxfield; i++) {
947 			*field = report->field[i];
948 			for (j = 0; j < (*field)->maxusage; j++)
949 				if ((*field)->usage[j].type == type && (*field)->usage[j].code == code)
950 					return j;
951 		}
952 	}
953 	return -1;
954 }
955 EXPORT_SYMBOL_GPL(hidinput_find_field);
956 
957 static int hidinput_open(struct input_dev *dev)
958 {
959 	struct hid_device *hid = input_get_drvdata(dev);
960 
961 	return hid->hid_open(hid);
962 }
963 
964 static void hidinput_close(struct input_dev *dev)
965 {
966 	struct hid_device *hid = input_get_drvdata(dev);
967 
968 	hid->hid_close(hid);
969 }
970 
971 /*
972  * Register the input device; print a message.
973  * Configure the input layer interface
974  * Read all reports and initialize the absolute field values.
975  */
976 
977 int hidinput_connect(struct hid_device *hid)
978 {
979 	struct hid_report *report;
980 	struct hid_input *hidinput = NULL;
981 	struct input_dev *input_dev;
982 	int i, j, k;
983 	int max_report_type = HID_OUTPUT_REPORT;
984 
985 	if (hid->quirks & HID_QUIRK_IGNORE_HIDINPUT)
986 		return -1;
987 
988 	INIT_LIST_HEAD(&hid->inputs);
989 
990 	for (i = 0; i < hid->maxcollection; i++)
991 		if (hid->collection[i].type == HID_COLLECTION_APPLICATION ||
992 		    hid->collection[i].type == HID_COLLECTION_PHYSICAL)
993 			if (IS_INPUT_APPLICATION(hid->collection[i].usage))
994 				break;
995 
996 	if (i == hid->maxcollection && (hid->quirks & HID_QUIRK_HIDINPUT) == 0)
997 		return -1;
998 
999 	if (hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
1000 		max_report_type = HID_INPUT_REPORT;
1001 
1002 	for (k = HID_INPUT_REPORT; k <= max_report_type; k++)
1003 		list_for_each_entry(report, &hid->report_enum[k].report_list, list) {
1004 
1005 			if (!report->maxfield)
1006 				continue;
1007 
1008 			if (!hidinput) {
1009 				hidinput = kzalloc(sizeof(*hidinput), GFP_KERNEL);
1010 				input_dev = input_allocate_device();
1011 				if (!hidinput || !input_dev) {
1012 					kfree(hidinput);
1013 					input_free_device(input_dev);
1014 					err_hid("Out of memory during hid input probe");
1015 					goto out_unwind;
1016 				}
1017 
1018 				input_set_drvdata(input_dev, hid);
1019 				input_dev->event = hid->hidinput_input_event;
1020 				input_dev->open = hidinput_open;
1021 				input_dev->close = hidinput_close;
1022 				input_dev->setkeycode = hidinput_setkeycode;
1023 				input_dev->getkeycode = hidinput_getkeycode;
1024 
1025 				input_dev->name = hid->name;
1026 				input_dev->phys = hid->phys;
1027 				input_dev->uniq = hid->uniq;
1028 				input_dev->id.bustype = hid->bus;
1029 				input_dev->id.vendor  = hid->vendor;
1030 				input_dev->id.product = hid->product;
1031 				input_dev->id.version = hid->version;
1032 				input_dev->dev.parent = hid->dev;
1033 				hidinput->input = input_dev;
1034 				list_add_tail(&hidinput->list, &hid->inputs);
1035 			}
1036 
1037 			for (i = 0; i < report->maxfield; i++)
1038 				for (j = 0; j < report->field[i]->maxusage; j++)
1039 					hidinput_configure_usage(hidinput, report->field[i],
1040 								 report->field[i]->usage + j);
1041 
1042 			if (hid->quirks & HID_QUIRK_MULTI_INPUT) {
1043 				/* This will leave hidinput NULL, so that it
1044 				 * allocates another one if we have more inputs on
1045 				 * the same interface. Some devices (e.g. Happ's
1046 				 * UGCI) cram a lot of unrelated inputs into the
1047 				 * same interface. */
1048 				hidinput->report = report;
1049 				if (input_register_device(hidinput->input))
1050 					goto out_cleanup;
1051 				hidinput = NULL;
1052 			}
1053 		}
1054 
1055 	if (hidinput && input_register_device(hidinput->input))
1056 		goto out_cleanup;
1057 
1058 	return 0;
1059 
1060 out_cleanup:
1061 	input_free_device(hidinput->input);
1062 	kfree(hidinput);
1063 out_unwind:
1064 	/* unwind the ones we already registered */
1065 	hidinput_disconnect(hid);
1066 
1067 	return -1;
1068 }
1069 EXPORT_SYMBOL_GPL(hidinput_connect);
1070 
1071 void hidinput_disconnect(struct hid_device *hid)
1072 {
1073 	struct hid_input *hidinput, *next;
1074 
1075 	list_for_each_entry_safe(hidinput, next, &hid->inputs, list) {
1076 		list_del(&hidinput->list);
1077 		input_unregister_device(hidinput->input);
1078 		kfree(hidinput);
1079 	}
1080 }
1081 EXPORT_SYMBOL_GPL(hidinput_disconnect);
1082 
1083