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