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