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