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