GNU Linux-libre 4.4.289-gnu1
[releases.git] / drivers / hid / hid-input.c
1 /*
2  *  Copyright (c) 2000-2001 Vojtech Pavlik
3  *  Copyright (c) 2006-2010 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 #include "hid-ids.h"
36
37 #define unk     KEY_UNKNOWN
38
39 static const unsigned char hid_keyboard[256] = {
40           0,  0,  0,  0, 30, 48, 46, 32, 18, 33, 34, 35, 23, 36, 37, 38,
41          50, 49, 24, 25, 16, 19, 31, 20, 22, 47, 17, 45, 21, 44,  2,  3,
42           4,  5,  6,  7,  8,  9, 10, 11, 28,  1, 14, 15, 57, 12, 13, 26,
43          27, 43, 43, 39, 40, 41, 51, 52, 53, 58, 59, 60, 61, 62, 63, 64,
44          65, 66, 67, 68, 87, 88, 99, 70,119,110,102,104,111,107,109,106,
45         105,108,103, 69, 98, 55, 74, 78, 96, 79, 80, 81, 75, 76, 77, 71,
46          72, 73, 82, 83, 86,127,116,117,183,184,185,186,187,188,189,190,
47         191,192,193,194,134,138,130,132,128,129,131,137,133,135,136,113,
48         115,114,unk,unk,unk,121,unk, 89, 93,124, 92, 94, 95,unk,unk,unk,
49         122,123, 90, 91, 85,unk,unk,unk,unk,unk,unk,unk,111,unk,unk,unk,
50         unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,
51         unk,unk,unk,unk,unk,unk,179,180,unk,unk,unk,unk,unk,unk,unk,unk,
52         unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,
53         unk,unk,unk,unk,unk,unk,unk,unk,111,unk,unk,unk,unk,unk,unk,unk,
54          29, 42, 56,125, 97, 54,100,126,164,166,165,163,161,115,114,113,
55         150,158,159,128,136,177,178,176,142,152,173,140,unk,unk,unk,unk
56 };
57
58 static const struct {
59         __s32 x;
60         __s32 y;
61 }  hid_hat_to_axis[] = {{ 0, 0}, { 0,-1}, { 1,-1}, { 1, 0}, { 1, 1}, { 0, 1}, {-1, 1}, {-1, 0}, {-1,-1}};
62
63 #define map_abs(c)      hid_map_usage(hidinput, usage, &bit, &max, EV_ABS, (c))
64 #define map_rel(c)      hid_map_usage(hidinput, usage, &bit, &max, EV_REL, (c))
65 #define map_key(c)      hid_map_usage(hidinput, usage, &bit, &max, EV_KEY, (c))
66 #define map_led(c)      hid_map_usage(hidinput, usage, &bit, &max, EV_LED, (c))
67
68 #define map_abs_clear(c)        hid_map_usage_clear(hidinput, usage, &bit, \
69                 &max, EV_ABS, (c))
70 #define map_key_clear(c)        hid_map_usage_clear(hidinput, usage, &bit, \
71                 &max, EV_KEY, (c))
72
73 static bool match_scancode(struct hid_usage *usage,
74                            unsigned int cur_idx, unsigned int scancode)
75 {
76         return (usage->hid & (HID_USAGE_PAGE | HID_USAGE)) == scancode;
77 }
78
79 static bool match_keycode(struct hid_usage *usage,
80                           unsigned int cur_idx, unsigned int keycode)
81 {
82         /*
83          * We should exclude unmapped usages when doing lookup by keycode.
84          */
85         return (usage->type == EV_KEY && usage->code == keycode);
86 }
87
88 static bool match_index(struct hid_usage *usage,
89                         unsigned int cur_idx, unsigned int idx)
90 {
91         return cur_idx == idx;
92 }
93
94 typedef bool (*hid_usage_cmp_t)(struct hid_usage *usage,
95                                 unsigned int cur_idx, unsigned int val);
96
97 static struct hid_usage *hidinput_find_key(struct hid_device *hid,
98                                            hid_usage_cmp_t match,
99                                            unsigned int value,
100                                            unsigned int *usage_idx)
101 {
102         unsigned int i, j, k, cur_idx = 0;
103         struct hid_report *report;
104         struct hid_usage *usage;
105
106         for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
107                 list_for_each_entry(report, &hid->report_enum[k].report_list, list) {
108                         for (i = 0; i < report->maxfield; i++) {
109                                 for (j = 0; j < report->field[i]->maxusage; j++) {
110                                         usage = report->field[i]->usage + j;
111                                         if (usage->type == EV_KEY || usage->type == 0) {
112                                                 if (match(usage, cur_idx, value)) {
113                                                         if (usage_idx)
114                                                                 *usage_idx = cur_idx;
115                                                         return usage;
116                                                 }
117                                                 cur_idx++;
118                                         }
119                                 }
120                         }
121                 }
122         }
123         return NULL;
124 }
125
126 static struct hid_usage *hidinput_locate_usage(struct hid_device *hid,
127                                         const struct input_keymap_entry *ke,
128                                         unsigned int *index)
129 {
130         struct hid_usage *usage;
131         unsigned int scancode;
132
133         if (ke->flags & INPUT_KEYMAP_BY_INDEX)
134                 usage = hidinput_find_key(hid, match_index, ke->index, index);
135         else if (input_scancode_to_scalar(ke, &scancode) == 0)
136                 usage = hidinput_find_key(hid, match_scancode, scancode, index);
137         else
138                 usage = NULL;
139
140         return usage;
141 }
142
143 static int hidinput_getkeycode(struct input_dev *dev,
144                                struct input_keymap_entry *ke)
145 {
146         struct hid_device *hid = input_get_drvdata(dev);
147         struct hid_usage *usage;
148         unsigned int scancode, index;
149
150         usage = hidinput_locate_usage(hid, ke, &index);
151         if (usage) {
152                 ke->keycode = usage->type == EV_KEY ?
153                                 usage->code : KEY_RESERVED;
154                 ke->index = index;
155                 scancode = usage->hid & (HID_USAGE_PAGE | HID_USAGE);
156                 ke->len = sizeof(scancode);
157                 memcpy(ke->scancode, &scancode, sizeof(scancode));
158                 return 0;
159         }
160
161         return -EINVAL;
162 }
163
164 static int hidinput_setkeycode(struct input_dev *dev,
165                                const struct input_keymap_entry *ke,
166                                unsigned int *old_keycode)
167 {
168         struct hid_device *hid = input_get_drvdata(dev);
169         struct hid_usage *usage;
170
171         usage = hidinput_locate_usage(hid, ke, NULL);
172         if (usage) {
173                 *old_keycode = usage->type == EV_KEY ?
174                                 usage->code : KEY_RESERVED;
175                 usage->code = ke->keycode;
176
177                 clear_bit(*old_keycode, dev->keybit);
178                 set_bit(usage->code, dev->keybit);
179                 dbg_hid("Assigned keycode %d to HID usage code %x\n",
180                         usage->code, usage->hid);
181
182                 /*
183                  * Set the keybit for the old keycode if the old keycode is used
184                  * by another key
185                  */
186                 if (hidinput_find_key(hid, match_keycode, *old_keycode, NULL))
187                         set_bit(*old_keycode, dev->keybit);
188
189                 return 0;
190         }
191
192         return -EINVAL;
193 }
194
195
196 /**
197  * hidinput_calc_abs_res - calculate an absolute axis resolution
198  * @field: the HID report field to calculate resolution for
199  * @code: axis code
200  *
201  * The formula is:
202  *                         (logical_maximum - logical_minimum)
203  * resolution = ----------------------------------------------------------
204  *              (physical_maximum - physical_minimum) * 10 ^ unit_exponent
205  *
206  * as seen in the HID specification v1.11 6.2.2.7 Global Items.
207  *
208  * Only exponent 1 length units are processed. Centimeters and inches are
209  * converted to millimeters. Degrees are converted to radians.
210  */
211 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code)
212 {
213         __s32 unit_exponent = field->unit_exponent;
214         __s32 logical_extents = field->logical_maximum -
215                                         field->logical_minimum;
216         __s32 physical_extents = field->physical_maximum -
217                                         field->physical_minimum;
218         __s32 prev;
219
220         /* Check if the extents are sane */
221         if (logical_extents <= 0 || physical_extents <= 0)
222                 return 0;
223
224         /*
225          * Verify and convert units.
226          * See HID specification v1.11 6.2.2.7 Global Items for unit decoding
227          */
228         switch (code) {
229         case ABS_X:
230         case ABS_Y:
231         case ABS_Z:
232         case ABS_MT_POSITION_X:
233         case ABS_MT_POSITION_Y:
234         case ABS_MT_TOOL_X:
235         case ABS_MT_TOOL_Y:
236         case ABS_MT_TOUCH_MAJOR:
237         case ABS_MT_TOUCH_MINOR:
238                 if (field->unit == 0x11) {              /* If centimeters */
239                         /* Convert to millimeters */
240                         unit_exponent += 1;
241                 } else if (field->unit == 0x13) {       /* If inches */
242                         /* Convert to millimeters */
243                         prev = physical_extents;
244                         physical_extents *= 254;
245                         if (physical_extents < prev)
246                                 return 0;
247                         unit_exponent -= 1;
248                 } else {
249                         return 0;
250                 }
251                 break;
252
253         case ABS_RX:
254         case ABS_RY:
255         case ABS_RZ:
256         case ABS_TILT_X:
257         case ABS_TILT_Y:
258                 if (field->unit == 0x14) {              /* If degrees */
259                         /* Convert to radians */
260                         prev = logical_extents;
261                         logical_extents *= 573;
262                         if (logical_extents < prev)
263                                 return 0;
264                         unit_exponent += 1;
265                 } else if (field->unit != 0x12) {       /* If not radians */
266                         return 0;
267                 }
268                 break;
269
270         default:
271                 return 0;
272         }
273
274         /* Apply negative unit exponent */
275         for (; unit_exponent < 0; unit_exponent++) {
276                 prev = logical_extents;
277                 logical_extents *= 10;
278                 if (logical_extents < prev)
279                         return 0;
280         }
281         /* Apply positive unit exponent */
282         for (; unit_exponent > 0; unit_exponent--) {
283                 prev = physical_extents;
284                 physical_extents *= 10;
285                 if (physical_extents < prev)
286                         return 0;
287         }
288
289         /* Calculate resolution */
290         return DIV_ROUND_CLOSEST(logical_extents, physical_extents);
291 }
292 EXPORT_SYMBOL_GPL(hidinput_calc_abs_res);
293
294 #ifdef CONFIG_HID_BATTERY_STRENGTH
295 static enum power_supply_property hidinput_battery_props[] = {
296         POWER_SUPPLY_PROP_PRESENT,
297         POWER_SUPPLY_PROP_ONLINE,
298         POWER_SUPPLY_PROP_CAPACITY,
299         POWER_SUPPLY_PROP_MODEL_NAME,
300         POWER_SUPPLY_PROP_STATUS,
301         POWER_SUPPLY_PROP_SCOPE,
302 };
303
304 #define HID_BATTERY_QUIRK_PERCENT       (1 << 0) /* always reports percent */
305 #define HID_BATTERY_QUIRK_FEATURE       (1 << 1) /* ask for feature report */
306
307 static const struct hid_device_id hid_battery_quirks[] = {
308         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
309                 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO),
310           HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
311         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
312                 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI),
313           HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
314         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
315                 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ANSI),
316           HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
317         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
318                                USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ISO),
319           HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
320         { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
321                 USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI),
322           HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
323         {}
324 };
325
326 static unsigned find_battery_quirk(struct hid_device *hdev)
327 {
328         unsigned quirks = 0;
329         const struct hid_device_id *match;
330
331         match = hid_match_id(hdev, hid_battery_quirks);
332         if (match != NULL)
333                 quirks = match->driver_data;
334
335         return quirks;
336 }
337
338 static int hidinput_get_battery_property(struct power_supply *psy,
339                                          enum power_supply_property prop,
340                                          union power_supply_propval *val)
341 {
342         struct hid_device *dev = power_supply_get_drvdata(psy);
343         int ret = 0;
344         __u8 *buf;
345
346         switch (prop) {
347         case POWER_SUPPLY_PROP_PRESENT:
348         case POWER_SUPPLY_PROP_ONLINE:
349                 val->intval = 1;
350                 break;
351
352         case POWER_SUPPLY_PROP_CAPACITY:
353
354                 buf = kmalloc(2 * sizeof(__u8), GFP_KERNEL);
355                 if (!buf) {
356                         ret = -ENOMEM;
357                         break;
358                 }
359                 ret = hid_hw_raw_request(dev, dev->battery_report_id, buf, 2,
360                                          dev->battery_report_type,
361                                          HID_REQ_GET_REPORT);
362
363                 if (ret != 2) {
364                         ret = -ENODATA;
365                         kfree(buf);
366                         break;
367                 }
368                 ret = 0;
369
370                 if (dev->battery_min < dev->battery_max &&
371                     buf[1] >= dev->battery_min &&
372                     buf[1] <= dev->battery_max)
373                         val->intval = (100 * (buf[1] - dev->battery_min)) /
374                                 (dev->battery_max - dev->battery_min);
375                 kfree(buf);
376                 break;
377
378         case POWER_SUPPLY_PROP_MODEL_NAME:
379                 val->strval = dev->name;
380                 break;
381
382         case POWER_SUPPLY_PROP_STATUS:
383                 val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
384                 break;
385
386         case POWER_SUPPLY_PROP_SCOPE:
387                 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
388                 break;
389
390         default:
391                 ret = -EINVAL;
392                 break;
393         }
394
395         return ret;
396 }
397
398 static bool hidinput_setup_battery(struct hid_device *dev, unsigned report_type, struct hid_field *field)
399 {
400         struct power_supply_desc *psy_desc = NULL;
401         struct power_supply_config psy_cfg = { .drv_data = dev, };
402         unsigned quirks;
403         s32 min, max;
404
405         if (field->usage->hid != HID_DC_BATTERYSTRENGTH)
406                 return false;   /* no match */
407
408         if (dev->battery != NULL)
409                 goto out;       /* already initialized? */
410
411         psy_desc = kzalloc(sizeof(*psy_desc), GFP_KERNEL);
412         if (psy_desc == NULL)
413                 goto out;
414
415         psy_desc->name = kasprintf(GFP_KERNEL, "hid-%s-battery", dev->uniq);
416         if (psy_desc->name == NULL) {
417                 kfree(psy_desc);
418                 goto out;
419         }
420
421         psy_desc->type = POWER_SUPPLY_TYPE_BATTERY;
422         psy_desc->properties = hidinput_battery_props;
423         psy_desc->num_properties = ARRAY_SIZE(hidinput_battery_props);
424         psy_desc->use_for_apm = 0;
425         psy_desc->get_property = hidinput_get_battery_property;
426
427         quirks = find_battery_quirk(dev);
428
429         hid_dbg(dev, "device %x:%x:%x %d quirks %d\n",
430                 dev->bus, dev->vendor, dev->product, dev->version, quirks);
431
432         min = field->logical_minimum;
433         max = field->logical_maximum;
434
435         if (quirks & HID_BATTERY_QUIRK_PERCENT) {
436                 min = 0;
437                 max = 100;
438         }
439
440         if (quirks & HID_BATTERY_QUIRK_FEATURE)
441                 report_type = HID_FEATURE_REPORT;
442
443         dev->battery_min = min;
444         dev->battery_max = max;
445         dev->battery_report_type = report_type;
446         dev->battery_report_id = field->report->id;
447
448         dev->battery = power_supply_register(&dev->dev, psy_desc, &psy_cfg);
449         if (IS_ERR(dev->battery)) {
450                 hid_warn(dev, "can't register power supply: %ld\n",
451                                 PTR_ERR(dev->battery));
452                 kfree(psy_desc->name);
453                 kfree(psy_desc);
454                 dev->battery = NULL;
455         } else {
456                 power_supply_powers(dev->battery, &dev->dev);
457         }
458
459 out:
460         return true;
461 }
462
463 static void hidinput_cleanup_battery(struct hid_device *dev)
464 {
465         const struct power_supply_desc *psy_desc;
466
467         if (!dev->battery)
468                 return;
469
470         psy_desc = dev->battery->desc;
471         power_supply_unregister(dev->battery);
472         kfree(psy_desc->name);
473         kfree(psy_desc);
474         dev->battery = NULL;
475 }
476 #else  /* !CONFIG_HID_BATTERY_STRENGTH */
477 static bool hidinput_setup_battery(struct hid_device *dev, unsigned report_type,
478                                    struct hid_field *field)
479 {
480         return false;
481 }
482
483 static void hidinput_cleanup_battery(struct hid_device *dev)
484 {
485 }
486 #endif  /* CONFIG_HID_BATTERY_STRENGTH */
487
488 static void hidinput_configure_usage(struct hid_input *hidinput, struct hid_field *field,
489                                      struct hid_usage *usage)
490 {
491         struct input_dev *input = hidinput->input;
492         struct hid_device *device = input_get_drvdata(input);
493         int max = 0, code;
494         unsigned long *bit = NULL;
495
496         field->hidinput = hidinput;
497
498         if (field->flags & HID_MAIN_ITEM_CONSTANT)
499                 goto ignore;
500
501         /* Ignore if report count is out of bounds. */
502         if (field->report_count < 1)
503                 goto ignore;
504
505         /* only LED usages are supported in output fields */
506         if (field->report_type == HID_OUTPUT_REPORT &&
507                         (usage->hid & HID_USAGE_PAGE) != HID_UP_LED) {
508                 goto ignore;
509         }
510
511         if (device->driver->input_mapping) {
512                 int ret = device->driver->input_mapping(device, hidinput, field,
513                                 usage, &bit, &max);
514                 if (ret > 0)
515                         goto mapped;
516                 if (ret < 0)
517                         goto ignore;
518         }
519
520         switch (usage->hid & HID_USAGE_PAGE) {
521         case HID_UP_UNDEFINED:
522                 goto ignore;
523
524         case HID_UP_KEYBOARD:
525                 set_bit(EV_REP, input->evbit);
526
527                 if ((usage->hid & HID_USAGE) < 256) {
528                         if (!hid_keyboard[usage->hid & HID_USAGE]) goto ignore;
529                         map_key_clear(hid_keyboard[usage->hid & HID_USAGE]);
530                 } else
531                         map_key(KEY_UNKNOWN);
532
533                 break;
534
535         case HID_UP_BUTTON:
536                 code = ((usage->hid - 1) & HID_USAGE);
537
538                 switch (field->application) {
539                 case HID_GD_MOUSE:
540                 case HID_GD_POINTER:  code += BTN_MOUSE; break;
541                 case HID_GD_JOYSTICK:
542                                 if (code <= 0xf)
543                                         code += BTN_JOYSTICK;
544                                 else
545                                         code += BTN_TRIGGER_HAPPY - 0x10;
546                                 break;
547                 case HID_GD_GAMEPAD:
548                                 if (code <= 0xf)
549                                         code += BTN_GAMEPAD;
550                                 else
551                                         code += BTN_TRIGGER_HAPPY - 0x10;
552                                 break;
553                 default:
554                         switch (field->physical) {
555                         case HID_GD_MOUSE:
556                         case HID_GD_POINTER:  code += BTN_MOUSE; break;
557                         case HID_GD_JOYSTICK: code += BTN_JOYSTICK; break;
558                         case HID_GD_GAMEPAD:  code += BTN_GAMEPAD; break;
559                         default:              code += BTN_MISC;
560                         }
561                 }
562
563                 map_key(code);
564                 break;
565
566         case HID_UP_SIMULATION:
567                 switch (usage->hid & 0xffff) {
568                 case 0xba: map_abs(ABS_RUDDER);   break;
569                 case 0xbb: map_abs(ABS_THROTTLE); break;
570                 case 0xc4: map_abs(ABS_GAS);      break;
571                 case 0xc5: map_abs(ABS_BRAKE);    break;
572                 case 0xc8: map_abs(ABS_WHEEL);    break;
573                 default:   goto ignore;
574                 }
575                 break;
576
577         case HID_UP_GENDESK:
578                 if ((usage->hid & 0xf0) == 0x80) {      /* SystemControl */
579                         switch (usage->hid & 0xf) {
580                         case 0x1: map_key_clear(KEY_POWER);  break;
581                         case 0x2: map_key_clear(KEY_SLEEP);  break;
582                         case 0x3: map_key_clear(KEY_WAKEUP); break;
583                         case 0x4: map_key_clear(KEY_CONTEXT_MENU); break;
584                         case 0x5: map_key_clear(KEY_MENU); break;
585                         case 0x6: map_key_clear(KEY_PROG1); break;
586                         case 0x7: map_key_clear(KEY_HELP); break;
587                         case 0x8: map_key_clear(KEY_EXIT); break;
588                         case 0x9: map_key_clear(KEY_SELECT); break;
589                         case 0xa: map_key_clear(KEY_RIGHT); break;
590                         case 0xb: map_key_clear(KEY_LEFT); break;
591                         case 0xc: map_key_clear(KEY_UP); break;
592                         case 0xd: map_key_clear(KEY_DOWN); break;
593                         case 0xe: map_key_clear(KEY_POWER2); break;
594                         case 0xf: map_key_clear(KEY_RESTART); break;
595                         default: goto unknown;
596                         }
597                         break;
598                 }
599
600                 if ((usage->hid & 0xf0) == 0x90) {      /* D-pad */
601                         switch (usage->hid) {
602                         case HID_GD_UP:    usage->hat_dir = 1; break;
603                         case HID_GD_DOWN:  usage->hat_dir = 5; break;
604                         case HID_GD_RIGHT: usage->hat_dir = 3; break;
605                         case HID_GD_LEFT:  usage->hat_dir = 7; break;
606                         default: goto unknown;
607                         }
608                         if (field->dpad) {
609                                 map_abs(field->dpad);
610                                 goto ignore;
611                         }
612                         map_abs(ABS_HAT0X);
613                         break;
614                 }
615
616                 switch (usage->hid) {
617                 /* These usage IDs map directly to the usage codes. */
618                 case HID_GD_X: case HID_GD_Y: case HID_GD_Z:
619                 case HID_GD_RX: case HID_GD_RY: case HID_GD_RZ:
620                         if (field->flags & HID_MAIN_ITEM_RELATIVE)
621                                 map_rel(usage->hid & 0xf);
622                         else
623                                 map_abs_clear(usage->hid & 0xf);
624                         break;
625
626                 case HID_GD_SLIDER: case HID_GD_DIAL: case HID_GD_WHEEL:
627                         if (field->flags & HID_MAIN_ITEM_RELATIVE)
628                                 map_rel(usage->hid & 0xf);
629                         else
630                                 map_abs(usage->hid & 0xf);
631                         break;
632
633                 case HID_GD_HATSWITCH:
634                         usage->hat_min = field->logical_minimum;
635                         usage->hat_max = field->logical_maximum;
636                         map_abs(ABS_HAT0X);
637                         break;
638
639                 case HID_GD_START:      map_key_clear(BTN_START);       break;
640                 case HID_GD_SELECT:     map_key_clear(BTN_SELECT);      break;
641
642                 default: goto unknown;
643                 }
644
645                 break;
646
647         case HID_UP_LED:
648                 switch (usage->hid & 0xffff) {                /* HID-Value:                   */
649                 case 0x01:  map_led (LED_NUML);     break;    /*   "Num Lock"                 */
650                 case 0x02:  map_led (LED_CAPSL);    break;    /*   "Caps Lock"                */
651                 case 0x03:  map_led (LED_SCROLLL);  break;    /*   "Scroll Lock"              */
652                 case 0x04:  map_led (LED_COMPOSE);  break;    /*   "Compose"                  */
653                 case 0x05:  map_led (LED_KANA);     break;    /*   "Kana"                     */
654                 case 0x27:  map_led (LED_SLEEP);    break;    /*   "Stand-By"                 */
655                 case 0x4c:  map_led (LED_SUSPEND);  break;    /*   "System Suspend"           */
656                 case 0x09:  map_led (LED_MUTE);     break;    /*   "Mute"                     */
657                 case 0x4b:  map_led (LED_MISC);     break;    /*   "Generic Indicator"        */
658                 case 0x19:  map_led (LED_MAIL);     break;    /*   "Message Waiting"          */
659                 case 0x4d:  map_led (LED_CHARGING); break;    /*   "External Power Connected" */
660
661                 default: goto ignore;
662                 }
663                 break;
664
665         case HID_UP_DIGITIZER:
666                 switch (usage->hid & 0xff) {
667                 case 0x00: /* Undefined */
668                         goto ignore;
669
670                 case 0x30: /* TipPressure */
671                         if (!test_bit(BTN_TOUCH, input->keybit)) {
672                                 device->quirks |= HID_QUIRK_NOTOUCH;
673                                 set_bit(EV_KEY, input->evbit);
674                                 set_bit(BTN_TOUCH, input->keybit);
675                         }
676                         map_abs_clear(ABS_PRESSURE);
677                         break;
678
679                 case 0x32: /* InRange */
680                         switch (field->physical & 0xff) {
681                         case 0x21: map_key(BTN_TOOL_MOUSE); break;
682                         case 0x22: map_key(BTN_TOOL_FINGER); break;
683                         default: map_key(BTN_TOOL_PEN); break;
684                         }
685                         break;
686
687                 case 0x3c: /* Invert */
688                         map_key_clear(BTN_TOOL_RUBBER);
689                         break;
690
691                 case 0x3d: /* X Tilt */
692                         map_abs_clear(ABS_TILT_X);
693                         break;
694
695                 case 0x3e: /* Y Tilt */
696                         map_abs_clear(ABS_TILT_Y);
697                         break;
698
699                 case 0x33: /* Touch */
700                 case 0x42: /* TipSwitch */
701                 case 0x43: /* TipSwitch2 */
702                         device->quirks &= ~HID_QUIRK_NOTOUCH;
703                         map_key_clear(BTN_TOUCH);
704                         break;
705
706                 case 0x44: /* BarrelSwitch */
707                         map_key_clear(BTN_STYLUS);
708                         break;
709
710                 case 0x46: /* TabletPick */
711                 case 0x5a: /* SecondaryBarrelSwitch */
712                         map_key_clear(BTN_STYLUS2);
713                         break;
714
715                 case 0x5b: /* TransducerSerialNumber */
716                         usage->type = EV_MSC;
717                         usage->code = MSC_SERIAL;
718                         bit = input->mscbit;
719                         max = MSC_MAX;
720                         break;
721
722                 default:  goto unknown;
723                 }
724                 break;
725
726         case HID_UP_TELEPHONY:
727                 switch (usage->hid & HID_USAGE) {
728                 case 0x2f: map_key_clear(KEY_MICMUTE);          break;
729                 case 0xb0: map_key_clear(KEY_NUMERIC_0);        break;
730                 case 0xb1: map_key_clear(KEY_NUMERIC_1);        break;
731                 case 0xb2: map_key_clear(KEY_NUMERIC_2);        break;
732                 case 0xb3: map_key_clear(KEY_NUMERIC_3);        break;
733                 case 0xb4: map_key_clear(KEY_NUMERIC_4);        break;
734                 case 0xb5: map_key_clear(KEY_NUMERIC_5);        break;
735                 case 0xb6: map_key_clear(KEY_NUMERIC_6);        break;
736                 case 0xb7: map_key_clear(KEY_NUMERIC_7);        break;
737                 case 0xb8: map_key_clear(KEY_NUMERIC_8);        break;
738                 case 0xb9: map_key_clear(KEY_NUMERIC_9);        break;
739                 case 0xba: map_key_clear(KEY_NUMERIC_STAR);     break;
740                 case 0xbb: map_key_clear(KEY_NUMERIC_POUND);    break;
741                 case 0xbc: map_key_clear(KEY_NUMERIC_A);        break;
742                 case 0xbd: map_key_clear(KEY_NUMERIC_B);        break;
743                 case 0xbe: map_key_clear(KEY_NUMERIC_C);        break;
744                 case 0xbf: map_key_clear(KEY_NUMERIC_D);        break;
745                 default: goto ignore;
746                 }
747                 break;
748
749         case HID_UP_CONSUMER:   /* USB HUT v1.12, pages 75-84 */
750                 switch (usage->hid & HID_USAGE) {
751                 case 0x000: goto ignore;
752                 case 0x030: map_key_clear(KEY_POWER);           break;
753                 case 0x031: map_key_clear(KEY_RESTART);         break;
754                 case 0x032: map_key_clear(KEY_SLEEP);           break;
755                 case 0x034: map_key_clear(KEY_SLEEP);           break;
756                 case 0x035: map_key_clear(KEY_KBDILLUMTOGGLE);  break;
757                 case 0x036: map_key_clear(BTN_MISC);            break;
758
759                 case 0x040: map_key_clear(KEY_MENU);            break; /* Menu */
760                 case 0x041: map_key_clear(KEY_SELECT);          break; /* Menu Pick */
761                 case 0x042: map_key_clear(KEY_UP);              break; /* Menu Up */
762                 case 0x043: map_key_clear(KEY_DOWN);            break; /* Menu Down */
763                 case 0x044: map_key_clear(KEY_LEFT);            break; /* Menu Left */
764                 case 0x045: map_key_clear(KEY_RIGHT);           break; /* Menu Right */
765                 case 0x046: map_key_clear(KEY_ESC);             break; /* Menu Escape */
766                 case 0x047: map_key_clear(KEY_KPPLUS);          break; /* Menu Value Increase */
767                 case 0x048: map_key_clear(KEY_KPMINUS);         break; /* Menu Value Decrease */
768
769                 case 0x060: map_key_clear(KEY_INFO);            break; /* Data On Screen */
770                 case 0x061: map_key_clear(KEY_SUBTITLE);        break; /* Closed Caption */
771                 case 0x063: map_key_clear(KEY_VCR);             break; /* VCR/TV */
772                 case 0x065: map_key_clear(KEY_CAMERA);          break; /* Snapshot */
773                 case 0x069: map_key_clear(KEY_RED);             break;
774                 case 0x06a: map_key_clear(KEY_GREEN);           break;
775                 case 0x06b: map_key_clear(KEY_BLUE);            break;
776                 case 0x06c: map_key_clear(KEY_YELLOW);          break;
777                 case 0x06d: map_key_clear(KEY_ZOOM);            break;
778
779                 case 0x06f: map_key_clear(KEY_BRIGHTNESSUP);            break;
780                 case 0x070: map_key_clear(KEY_BRIGHTNESSDOWN);          break;
781                 case 0x072: map_key_clear(KEY_BRIGHTNESS_TOGGLE);       break;
782                 case 0x073: map_key_clear(KEY_BRIGHTNESS_MIN);          break;
783                 case 0x074: map_key_clear(KEY_BRIGHTNESS_MAX);          break;
784                 case 0x075: map_key_clear(KEY_BRIGHTNESS_AUTO);         break;
785
786                 case 0x079: map_key_clear(KEY_KBDILLUMUP);      break;
787                 case 0x07a: map_key_clear(KEY_KBDILLUMDOWN);    break;
788                 case 0x07c: map_key_clear(KEY_KBDILLUMTOGGLE);  break;
789
790                 case 0x082: map_key_clear(KEY_VIDEO_NEXT);      break;
791                 case 0x083: map_key_clear(KEY_LAST);            break;
792                 case 0x084: map_key_clear(KEY_ENTER);           break;
793                 case 0x088: map_key_clear(KEY_PC);              break;
794                 case 0x089: map_key_clear(KEY_TV);              break;
795                 case 0x08a: map_key_clear(KEY_WWW);             break;
796                 case 0x08b: map_key_clear(KEY_DVD);             break;
797                 case 0x08c: map_key_clear(KEY_PHONE);           break;
798                 case 0x08d: map_key_clear(KEY_PROGRAM);         break;
799                 case 0x08e: map_key_clear(KEY_VIDEOPHONE);      break;
800                 case 0x08f: map_key_clear(KEY_GAMES);           break;
801                 case 0x090: map_key_clear(KEY_MEMO);            break;
802                 case 0x091: map_key_clear(KEY_CD);              break;
803                 case 0x092: map_key_clear(KEY_VCR);             break;
804                 case 0x093: map_key_clear(KEY_TUNER);           break;
805                 case 0x094: map_key_clear(KEY_EXIT);            break;
806                 case 0x095: map_key_clear(KEY_HELP);            break;
807                 case 0x096: map_key_clear(KEY_TAPE);            break;
808                 case 0x097: map_key_clear(KEY_TV2);             break;
809                 case 0x098: map_key_clear(KEY_SAT);             break;
810                 case 0x09a: map_key_clear(KEY_PVR);             break;
811
812                 case 0x09c: map_key_clear(KEY_CHANNELUP);       break;
813                 case 0x09d: map_key_clear(KEY_CHANNELDOWN);     break;
814                 case 0x0a0: map_key_clear(KEY_VCR2);            break;
815
816                 case 0x0b0: map_key_clear(KEY_PLAY);            break;
817                 case 0x0b1: map_key_clear(KEY_PAUSE);           break;
818                 case 0x0b2: map_key_clear(KEY_RECORD);          break;
819                 case 0x0b3: map_key_clear(KEY_FASTFORWARD);     break;
820                 case 0x0b4: map_key_clear(KEY_REWIND);          break;
821                 case 0x0b5: map_key_clear(KEY_NEXTSONG);        break;
822                 case 0x0b6: map_key_clear(KEY_PREVIOUSSONG);    break;
823                 case 0x0b7: map_key_clear(KEY_STOPCD);          break;
824                 case 0x0b8: map_key_clear(KEY_EJECTCD);         break;
825                 case 0x0bc: map_key_clear(KEY_MEDIA_REPEAT);    break;
826                 case 0x0b9: map_key_clear(KEY_SHUFFLE);         break;
827                 case 0x0bf: map_key_clear(KEY_SLOW);            break;
828
829                 case 0x0cd: map_key_clear(KEY_PLAYPAUSE);       break;
830                 case 0x0cf: map_key_clear(KEY_VOICECOMMAND);    break;
831                 case 0x0e0: map_abs_clear(ABS_VOLUME);          break;
832                 case 0x0e2: map_key_clear(KEY_MUTE);            break;
833                 case 0x0e5: map_key_clear(KEY_BASSBOOST);       break;
834                 case 0x0e9: map_key_clear(KEY_VOLUMEUP);        break;
835                 case 0x0ea: map_key_clear(KEY_VOLUMEDOWN);      break;
836                 case 0x0f5: map_key_clear(KEY_SLOW);            break;
837
838                 case 0x181: map_key_clear(KEY_BUTTONCONFIG);    break;
839                 case 0x182: map_key_clear(KEY_BOOKMARKS);       break;
840                 case 0x183: map_key_clear(KEY_CONFIG);          break;
841                 case 0x184: map_key_clear(KEY_WORDPROCESSOR);   break;
842                 case 0x185: map_key_clear(KEY_EDITOR);          break;
843                 case 0x186: map_key_clear(KEY_SPREADSHEET);     break;
844                 case 0x187: map_key_clear(KEY_GRAPHICSEDITOR);  break;
845                 case 0x188: map_key_clear(KEY_PRESENTATION);    break;
846                 case 0x189: map_key_clear(KEY_DATABASE);        break;
847                 case 0x18a: map_key_clear(KEY_MAIL);            break;
848                 case 0x18b: map_key_clear(KEY_NEWS);            break;
849                 case 0x18c: map_key_clear(KEY_VOICEMAIL);       break;
850                 case 0x18d: map_key_clear(KEY_ADDRESSBOOK);     break;
851                 case 0x18e: map_key_clear(KEY_CALENDAR);        break;
852                 case 0x18f: map_key_clear(KEY_TASKMANAGER);     break;
853                 case 0x190: map_key_clear(KEY_JOURNAL);         break;
854                 case 0x191: map_key_clear(KEY_FINANCE);         break;
855                 case 0x192: map_key_clear(KEY_CALC);            break;
856                 case 0x193: map_key_clear(KEY_PLAYER);          break;
857                 case 0x194: map_key_clear(KEY_FILE);            break;
858                 case 0x196: map_key_clear(KEY_WWW);             break;
859                 case 0x199: map_key_clear(KEY_CHAT);            break;
860                 case 0x19c: map_key_clear(KEY_LOGOFF);          break;
861                 case 0x19e: map_key_clear(KEY_COFFEE);          break;
862                 case 0x19f: map_key_clear(KEY_CONTROLPANEL);            break;
863                 case 0x1a2: map_key_clear(KEY_APPSELECT);               break;
864                 case 0x1a3: map_key_clear(KEY_NEXT);            break;
865                 case 0x1a4: map_key_clear(KEY_PREVIOUS);        break;
866                 case 0x1a6: map_key_clear(KEY_HELP);            break;
867                 case 0x1a7: map_key_clear(KEY_DOCUMENTS);       break;
868                 case 0x1ab: map_key_clear(KEY_SPELLCHECK);      break;
869                 case 0x1ae: map_key_clear(KEY_KEYBOARD);        break;
870                 case 0x1b1: map_key_clear(KEY_SCREENSAVER);             break;
871                 case 0x1b4: map_key_clear(KEY_FILE);            break;
872                 case 0x1b6: map_key_clear(KEY_IMAGES);          break;
873                 case 0x1b7: map_key_clear(KEY_AUDIO);           break;
874                 case 0x1b8: map_key_clear(KEY_VIDEO);           break;
875                 case 0x1bc: map_key_clear(KEY_MESSENGER);       break;
876                 case 0x1bd: map_key_clear(KEY_INFO);            break;
877                 case 0x201: map_key_clear(KEY_NEW);             break;
878                 case 0x202: map_key_clear(KEY_OPEN);            break;
879                 case 0x203: map_key_clear(KEY_CLOSE);           break;
880                 case 0x204: map_key_clear(KEY_EXIT);            break;
881                 case 0x207: map_key_clear(KEY_SAVE);            break;
882                 case 0x208: map_key_clear(KEY_PRINT);           break;
883                 case 0x209: map_key_clear(KEY_PROPS);           break;
884                 case 0x21a: map_key_clear(KEY_UNDO);            break;
885                 case 0x21b: map_key_clear(KEY_COPY);            break;
886                 case 0x21c: map_key_clear(KEY_CUT);             break;
887                 case 0x21d: map_key_clear(KEY_PASTE);           break;
888                 case 0x21f: map_key_clear(KEY_FIND);            break;
889                 case 0x221: map_key_clear(KEY_SEARCH);          break;
890                 case 0x222: map_key_clear(KEY_GOTO);            break;
891                 case 0x223: map_key_clear(KEY_HOMEPAGE);        break;
892                 case 0x224: map_key_clear(KEY_BACK);            break;
893                 case 0x225: map_key_clear(KEY_FORWARD);         break;
894                 case 0x226: map_key_clear(KEY_STOP);            break;
895                 case 0x227: map_key_clear(KEY_REFRESH);         break;
896                 case 0x22a: map_key_clear(KEY_BOOKMARKS);       break;
897                 case 0x22d: map_key_clear(KEY_ZOOMIN);          break;
898                 case 0x22e: map_key_clear(KEY_ZOOMOUT);         break;
899                 case 0x22f: map_key_clear(KEY_ZOOMRESET);       break;
900                 case 0x233: map_key_clear(KEY_SCROLLUP);        break;
901                 case 0x234: map_key_clear(KEY_SCROLLDOWN);      break;
902                 case 0x238: map_rel(REL_HWHEEL);                break;
903                 case 0x23d: map_key_clear(KEY_EDIT);            break;
904                 case 0x25f: map_key_clear(KEY_CANCEL);          break;
905                 case 0x269: map_key_clear(KEY_INSERT);          break;
906                 case 0x26a: map_key_clear(KEY_DELETE);          break;
907                 case 0x279: map_key_clear(KEY_REDO);            break;
908
909                 case 0x289: map_key_clear(KEY_REPLY);           break;
910                 case 0x28b: map_key_clear(KEY_FORWARDMAIL);     break;
911                 case 0x28c: map_key_clear(KEY_SEND);            break;
912
913                 case 0x2c7: map_key_clear(KEY_KBDINPUTASSIST_PREV);             break;
914                 case 0x2c8: map_key_clear(KEY_KBDINPUTASSIST_NEXT);             break;
915                 case 0x2c9: map_key_clear(KEY_KBDINPUTASSIST_PREVGROUP);                break;
916                 case 0x2ca: map_key_clear(KEY_KBDINPUTASSIST_NEXTGROUP);                break;
917                 case 0x2cb: map_key_clear(KEY_KBDINPUTASSIST_ACCEPT);   break;
918                 case 0x2cc: map_key_clear(KEY_KBDINPUTASSIST_CANCEL);   break;
919
920                 case 0x29f: map_key_clear(KEY_SCALE);           break;
921
922                 default: map_key_clear(KEY_UNKNOWN);
923                 }
924                 break;
925
926         case HID_UP_GENDEVCTRLS:
927                 if (hidinput_setup_battery(device, HID_INPUT_REPORT, field))
928                         goto ignore;
929                 else
930                         goto unknown;
931                 break;
932
933         case HID_UP_HPVENDOR:   /* Reported on a Dutch layout HP5308 */
934                 set_bit(EV_REP, input->evbit);
935                 switch (usage->hid & HID_USAGE) {
936                 case 0x021: map_key_clear(KEY_PRINT);           break;
937                 case 0x070: map_key_clear(KEY_HP);              break;
938                 case 0x071: map_key_clear(KEY_CAMERA);          break;
939                 case 0x072: map_key_clear(KEY_SOUND);           break;
940                 case 0x073: map_key_clear(KEY_QUESTION);        break;
941                 case 0x080: map_key_clear(KEY_EMAIL);           break;
942                 case 0x081: map_key_clear(KEY_CHAT);            break;
943                 case 0x082: map_key_clear(KEY_SEARCH);          break;
944                 case 0x083: map_key_clear(KEY_CONNECT);         break;
945                 case 0x084: map_key_clear(KEY_FINANCE);         break;
946                 case 0x085: map_key_clear(KEY_SPORT);           break;
947                 case 0x086: map_key_clear(KEY_SHOP);            break;
948                 default:    goto ignore;
949                 }
950                 break;
951
952         case HID_UP_HPVENDOR2:
953                 set_bit(EV_REP, input->evbit);
954                 switch (usage->hid & HID_USAGE) {
955                 case 0x003: map_key_clear(KEY_BRIGHTNESSDOWN);  break;
956                 case 0x004: map_key_clear(KEY_BRIGHTNESSUP);    break;
957                 default:    goto ignore;
958                 }
959                 break;
960
961         case HID_UP_MSVENDOR:
962                 goto ignore;
963
964         case HID_UP_CUSTOM: /* Reported on Logitech and Apple USB keyboards */
965                 set_bit(EV_REP, input->evbit);
966                 goto ignore;
967
968         case HID_UP_LOGIVENDOR:
969                 goto ignore;
970
971         case HID_UP_PID:
972                 switch (usage->hid & HID_USAGE) {
973                 case 0xa4: map_key_clear(BTN_DEAD);     break;
974                 default: goto ignore;
975                 }
976                 break;
977
978         default:
979         unknown:
980                 if (field->report_size == 1) {
981                         if (field->report->type == HID_OUTPUT_REPORT) {
982                                 map_led(LED_MISC);
983                                 break;
984                         }
985                         map_key(BTN_MISC);
986                         break;
987                 }
988                 if (field->flags & HID_MAIN_ITEM_RELATIVE) {
989                         map_rel(REL_MISC);
990                         break;
991                 }
992                 map_abs(ABS_MISC);
993                 break;
994         }
995
996 mapped:
997         /* Mapping failed, bail out */
998         if (!bit)
999                 return;
1000
1001         if (device->driver->input_mapped &&
1002             device->driver->input_mapped(device, hidinput, field, usage,
1003                                          &bit, &max) < 0) {
1004                 /*
1005                  * The driver indicated that no further generic handling
1006                  * of the usage is desired.
1007                  */
1008                 return;
1009         }
1010
1011         set_bit(usage->type, input->evbit);
1012
1013         while (usage->code <= max && test_and_set_bit(usage->code, bit))
1014                 usage->code = find_next_zero_bit(bit, max + 1, usage->code);
1015
1016         if (usage->code > max)
1017                 goto ignore;
1018
1019
1020         if (usage->type == EV_ABS) {
1021
1022                 int a = field->logical_minimum;
1023                 int b = field->logical_maximum;
1024
1025                 if ((device->quirks & HID_QUIRK_BADPAD) && (usage->code == ABS_X || usage->code == ABS_Y)) {
1026                         a = field->logical_minimum = 0;
1027                         b = field->logical_maximum = 255;
1028                 }
1029
1030                 if (field->application == HID_GD_GAMEPAD || field->application == HID_GD_JOYSTICK)
1031                         input_set_abs_params(input, usage->code, a, b, (b - a) >> 8, (b - a) >> 4);
1032                 else    input_set_abs_params(input, usage->code, a, b, 0, 0);
1033
1034                 input_abs_set_res(input, usage->code,
1035                                   hidinput_calc_abs_res(field, usage->code));
1036
1037                 /* use a larger default input buffer for MT devices */
1038                 if (usage->code == ABS_MT_POSITION_X && input->hint_events_per_packet == 0)
1039                         input_set_events_per_packet(input, 60);
1040         }
1041
1042         if (usage->type == EV_ABS &&
1043             (usage->hat_min < usage->hat_max || usage->hat_dir)) {
1044                 int i;
1045                 for (i = usage->code; i < usage->code + 2 && i <= max; i++) {
1046                         input_set_abs_params(input, i, -1, 1, 0, 0);
1047                         set_bit(i, input->absbit);
1048                 }
1049                 if (usage->hat_dir && !field->dpad)
1050                         field->dpad = usage->code;
1051         }
1052
1053         /* for those devices which produce Consumer volume usage as relative,
1054          * we emulate pressing volumeup/volumedown appropriate number of times
1055          * in hidinput_hid_event()
1056          */
1057         if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
1058                         (usage->code == ABS_VOLUME)) {
1059                 set_bit(KEY_VOLUMEUP, input->keybit);
1060                 set_bit(KEY_VOLUMEDOWN, input->keybit);
1061         }
1062
1063         if (usage->type == EV_KEY) {
1064                 set_bit(EV_MSC, input->evbit);
1065                 set_bit(MSC_SCAN, input->mscbit);
1066         }
1067
1068         return;
1069
1070 ignore:
1071         usage->type = 0;
1072         usage->code = 0;
1073 }
1074
1075 void hidinput_hid_event(struct hid_device *hid, struct hid_field *field, struct hid_usage *usage, __s32 value)
1076 {
1077         struct input_dev *input;
1078         unsigned *quirks = &hid->quirks;
1079
1080         if (!field->hidinput)
1081                 return;
1082
1083         input = field->hidinput->input;
1084
1085         if (!usage->type)
1086                 return;
1087
1088         if (usage->hat_min < usage->hat_max || usage->hat_dir) {
1089                 int hat_dir = usage->hat_dir;
1090                 if (!hat_dir)
1091                         hat_dir = (value - usage->hat_min) * 8 / (usage->hat_max - usage->hat_min + 1) + 1;
1092                 if (hat_dir < 0 || hat_dir > 8) hat_dir = 0;
1093                 input_event(input, usage->type, usage->code    , hid_hat_to_axis[hat_dir].x);
1094                 input_event(input, usage->type, usage->code + 1, hid_hat_to_axis[hat_dir].y);
1095                 return;
1096         }
1097
1098         if (usage->hid == (HID_UP_DIGITIZER | 0x003c)) { /* Invert */
1099                 *quirks = value ? (*quirks | HID_QUIRK_INVERT) : (*quirks & ~HID_QUIRK_INVERT);
1100                 return;
1101         }
1102
1103         if (usage->hid == (HID_UP_DIGITIZER | 0x0032)) { /* InRange */
1104                 if (value) {
1105                         input_event(input, usage->type, (*quirks & HID_QUIRK_INVERT) ? BTN_TOOL_RUBBER : usage->code, 1);
1106                         return;
1107                 }
1108                 input_event(input, usage->type, usage->code, 0);
1109                 input_event(input, usage->type, BTN_TOOL_RUBBER, 0);
1110                 return;
1111         }
1112
1113         if (usage->hid == (HID_UP_DIGITIZER | 0x0030) && (*quirks & HID_QUIRK_NOTOUCH)) { /* Pressure */
1114                 int a = field->logical_minimum;
1115                 int b = field->logical_maximum;
1116                 input_event(input, EV_KEY, BTN_TOUCH, value > a + ((b - a) >> 3));
1117         }
1118
1119         if (usage->hid == (HID_UP_PID | 0x83UL)) { /* Simultaneous Effects Max */
1120                 dbg_hid("Maximum Effects - %d\n",value);
1121                 return;
1122         }
1123
1124         if (usage->hid == (HID_UP_PID | 0x7fUL)) {
1125                 dbg_hid("PID Pool Report\n");
1126                 return;
1127         }
1128
1129         if ((usage->type == EV_KEY) && (usage->code == 0)) /* Key 0 is "unassigned", not KEY_UNKNOWN */
1130                 return;
1131
1132         if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
1133                         (usage->code == ABS_VOLUME)) {
1134                 int count = abs(value);
1135                 int direction = value > 0 ? KEY_VOLUMEUP : KEY_VOLUMEDOWN;
1136                 int i;
1137
1138                 for (i = 0; i < count; i++) {
1139                         input_event(input, EV_KEY, direction, 1);
1140                         input_sync(input);
1141                         input_event(input, EV_KEY, direction, 0);
1142                         input_sync(input);
1143                 }
1144                 return;
1145         }
1146
1147         /*
1148          * Ignore out-of-range values as per HID specification,
1149          * section 5.10 and 6.2.25, when NULL state bit is present.
1150          * When it's not, clamp the value to match Microsoft's input
1151          * driver as mentioned in "Required HID usages for digitizers":
1152          * https://msdn.microsoft.com/en-us/library/windows/hardware/dn672278(v=vs.85).asp
1153          *
1154          * The logical_minimum < logical_maximum check is done so that we
1155          * don't unintentionally discard values sent by devices which
1156          * don't specify logical min and max.
1157          */
1158         if ((field->flags & HID_MAIN_ITEM_VARIABLE) &&
1159             (field->logical_minimum < field->logical_maximum)) {
1160                 if (field->flags & HID_MAIN_ITEM_NULL_STATE &&
1161                     (value < field->logical_minimum ||
1162                      value > field->logical_maximum)) {
1163                         dbg_hid("Ignoring out-of-range value %x\n", value);
1164                         return;
1165                 }
1166                 value = clamp(value,
1167                               field->logical_minimum,
1168                               field->logical_maximum);
1169         }
1170
1171         /*
1172          * Ignore reports for absolute data if the data didn't change. This is
1173          * not only an optimization but also fixes 'dead' key reports. Some
1174          * RollOver implementations for localized keys (like BACKSLASH/PIPE; HID
1175          * 0x31 and 0x32) report multiple keys, even though a localized keyboard
1176          * can only have one of them physically available. The 'dead' keys
1177          * report constant 0. As all map to the same keycode, they'd confuse
1178          * the input layer. If we filter the 'dead' keys on the HID level, we
1179          * skip the keycode translation and only forward real events.
1180          */
1181         if (!(field->flags & (HID_MAIN_ITEM_RELATIVE |
1182                               HID_MAIN_ITEM_BUFFERED_BYTE)) &&
1183                               (field->flags & HID_MAIN_ITEM_VARIABLE) &&
1184             usage->usage_index < field->maxusage &&
1185             value == field->value[usage->usage_index])
1186                 return;
1187
1188         /* report the usage code as scancode if the key status has changed */
1189         if (usage->type == EV_KEY &&
1190             (!test_bit(usage->code, input->key)) == value)
1191                 input_event(input, EV_MSC, MSC_SCAN, usage->hid);
1192
1193         input_event(input, usage->type, usage->code, value);
1194
1195         if ((field->flags & HID_MAIN_ITEM_RELATIVE) &&
1196             usage->type == EV_KEY && value) {
1197                 input_sync(input);
1198                 input_event(input, usage->type, usage->code, 0);
1199         }
1200 }
1201
1202 void hidinput_report_event(struct hid_device *hid, struct hid_report *report)
1203 {
1204         struct hid_input *hidinput;
1205
1206         if (hid->quirks & HID_QUIRK_NO_INPUT_SYNC)
1207                 return;
1208
1209         list_for_each_entry(hidinput, &hid->inputs, list)
1210                 input_sync(hidinput->input);
1211 }
1212 EXPORT_SYMBOL_GPL(hidinput_report_event);
1213
1214 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field)
1215 {
1216         struct hid_report *report;
1217         int i, j;
1218
1219         list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
1220                 for (i = 0; i < report->maxfield; i++) {
1221                         *field = report->field[i];
1222                         for (j = 0; j < (*field)->maxusage; j++)
1223                                 if ((*field)->usage[j].type == type && (*field)->usage[j].code == code)
1224                                         return j;
1225                 }
1226         }
1227         return -1;
1228 }
1229 EXPORT_SYMBOL_GPL(hidinput_find_field);
1230
1231 struct hid_field *hidinput_get_led_field(struct hid_device *hid)
1232 {
1233         struct hid_report *report;
1234         struct hid_field *field;
1235         int i, j;
1236
1237         list_for_each_entry(report,
1238                             &hid->report_enum[HID_OUTPUT_REPORT].report_list,
1239                             list) {
1240                 for (i = 0; i < report->maxfield; i++) {
1241                         field = report->field[i];
1242                         for (j = 0; j < field->maxusage; j++)
1243                                 if (field->usage[j].type == EV_LED)
1244                                         return field;
1245                 }
1246         }
1247         return NULL;
1248 }
1249 EXPORT_SYMBOL_GPL(hidinput_get_led_field);
1250
1251 unsigned int hidinput_count_leds(struct hid_device *hid)
1252 {
1253         struct hid_report *report;
1254         struct hid_field *field;
1255         int i, j;
1256         unsigned int count = 0;
1257
1258         list_for_each_entry(report,
1259                             &hid->report_enum[HID_OUTPUT_REPORT].report_list,
1260                             list) {
1261                 for (i = 0; i < report->maxfield; i++) {
1262                         field = report->field[i];
1263                         for (j = 0; j < field->maxusage; j++)
1264                                 if (field->usage[j].type == EV_LED &&
1265                                     field->value[j])
1266                                         count += 1;
1267                 }
1268         }
1269         return count;
1270 }
1271 EXPORT_SYMBOL_GPL(hidinput_count_leds);
1272
1273 static void hidinput_led_worker(struct work_struct *work)
1274 {
1275         struct hid_device *hid = container_of(work, struct hid_device,
1276                                               led_work);
1277         struct hid_field *field;
1278         struct hid_report *report;
1279         int ret;
1280         u32 len;
1281         __u8 *buf;
1282
1283         field = hidinput_get_led_field(hid);
1284         if (!field)
1285                 return;
1286
1287         /*
1288          * field->report is accessed unlocked regarding HID core. So there might
1289          * be another incoming SET-LED request from user-space, which changes
1290          * the LED state while we assemble our outgoing buffer. However, this
1291          * doesn't matter as hid_output_report() correctly converts it into a
1292          * boolean value no matter what information is currently set on the LED
1293          * field (even garbage). So the remote device will always get a valid
1294          * request.
1295          * And in case we send a wrong value, a next led worker is spawned
1296          * for every SET-LED request so the following worker will send the
1297          * correct value, guaranteed!
1298          */
1299
1300         report = field->report;
1301
1302         /* use custom SET_REPORT request if possible (asynchronous) */
1303         if (hid->ll_driver->request)
1304                 return hid->ll_driver->request(hid, report, HID_REQ_SET_REPORT);
1305
1306         /* fall back to generic raw-output-report */
1307         len = hid_report_len(report);
1308         buf = hid_alloc_report_buf(report, GFP_KERNEL);
1309         if (!buf)
1310                 return;
1311
1312         hid_output_report(report, buf);
1313         /* synchronous output report */
1314         ret = hid_hw_output_report(hid, buf, len);
1315         if (ret == -ENOSYS)
1316                 hid_hw_raw_request(hid, report->id, buf, len, HID_OUTPUT_REPORT,
1317                                 HID_REQ_SET_REPORT);
1318         kfree(buf);
1319 }
1320
1321 static int hidinput_input_event(struct input_dev *dev, unsigned int type,
1322                                 unsigned int code, int value)
1323 {
1324         struct hid_device *hid = input_get_drvdata(dev);
1325         struct hid_field *field;
1326         int offset;
1327
1328         if (type == EV_FF)
1329                 return input_ff_event(dev, type, code, value);
1330
1331         if (type != EV_LED)
1332                 return -1;
1333
1334         if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
1335                 hid_warn(dev, "event field not found\n");
1336                 return -1;
1337         }
1338
1339         hid_set_field(field, offset, value);
1340
1341         schedule_work(&hid->led_work);
1342         return 0;
1343 }
1344
1345 static int hidinput_open(struct input_dev *dev)
1346 {
1347         struct hid_device *hid = input_get_drvdata(dev);
1348
1349         return hid_hw_open(hid);
1350 }
1351
1352 static void hidinput_close(struct input_dev *dev)
1353 {
1354         struct hid_device *hid = input_get_drvdata(dev);
1355
1356         hid_hw_close(hid);
1357 }
1358
1359 static void report_features(struct hid_device *hid)
1360 {
1361         struct hid_driver *drv = hid->driver;
1362         struct hid_report_enum *rep_enum;
1363         struct hid_report *rep;
1364         int i, j;
1365
1366         rep_enum = &hid->report_enum[HID_FEATURE_REPORT];
1367         list_for_each_entry(rep, &rep_enum->report_list, list)
1368                 for (i = 0; i < rep->maxfield; i++) {
1369                         /* Ignore if report count is out of bounds. */
1370                         if (rep->field[i]->report_count < 1)
1371                                 continue;
1372
1373                         for (j = 0; j < rep->field[i]->maxusage; j++) {
1374                                 /* Verify if Battery Strength feature is available */
1375                                 hidinput_setup_battery(hid, HID_FEATURE_REPORT, rep->field[i]);
1376
1377                                 if (drv->feature_mapping)
1378                                         drv->feature_mapping(hid, rep->field[i],
1379                                                              rep->field[i]->usage + j);
1380                         }
1381                 }
1382 }
1383
1384 static struct hid_input *hidinput_allocate(struct hid_device *hid)
1385 {
1386         struct hid_input *hidinput = kzalloc(sizeof(*hidinput), GFP_KERNEL);
1387         struct input_dev *input_dev = input_allocate_device();
1388         if (!hidinput || !input_dev) {
1389                 kfree(hidinput);
1390                 input_free_device(input_dev);
1391                 hid_err(hid, "Out of memory during hid input probe\n");
1392                 return NULL;
1393         }
1394
1395         input_set_drvdata(input_dev, hid);
1396         input_dev->event = hidinput_input_event;
1397         input_dev->open = hidinput_open;
1398         input_dev->close = hidinput_close;
1399         input_dev->setkeycode = hidinput_setkeycode;
1400         input_dev->getkeycode = hidinput_getkeycode;
1401
1402         input_dev->name = hid->name;
1403         input_dev->phys = hid->phys;
1404         input_dev->uniq = hid->uniq;
1405         input_dev->id.bustype = hid->bus;
1406         input_dev->id.vendor  = hid->vendor;
1407         input_dev->id.product = hid->product;
1408         input_dev->id.version = hid->version;
1409         input_dev->dev.parent = &hid->dev;
1410         hidinput->input = input_dev;
1411         list_add_tail(&hidinput->list, &hid->inputs);
1412
1413         return hidinput;
1414 }
1415
1416 static bool hidinput_has_been_populated(struct hid_input *hidinput)
1417 {
1418         int i;
1419         unsigned long r = 0;
1420
1421         for (i = 0; i < BITS_TO_LONGS(EV_CNT); i++)
1422                 r |= hidinput->input->evbit[i];
1423
1424         for (i = 0; i < BITS_TO_LONGS(KEY_CNT); i++)
1425                 r |= hidinput->input->keybit[i];
1426
1427         for (i = 0; i < BITS_TO_LONGS(REL_CNT); i++)
1428                 r |= hidinput->input->relbit[i];
1429
1430         for (i = 0; i < BITS_TO_LONGS(ABS_CNT); i++)
1431                 r |= hidinput->input->absbit[i];
1432
1433         for (i = 0; i < BITS_TO_LONGS(MSC_CNT); i++)
1434                 r |= hidinput->input->mscbit[i];
1435
1436         for (i = 0; i < BITS_TO_LONGS(LED_CNT); i++)
1437                 r |= hidinput->input->ledbit[i];
1438
1439         for (i = 0; i < BITS_TO_LONGS(SND_CNT); i++)
1440                 r |= hidinput->input->sndbit[i];
1441
1442         for (i = 0; i < BITS_TO_LONGS(FF_CNT); i++)
1443                 r |= hidinput->input->ffbit[i];
1444
1445         for (i = 0; i < BITS_TO_LONGS(SW_CNT); i++)
1446                 r |= hidinput->input->swbit[i];
1447
1448         return !!r;
1449 }
1450
1451 static void hidinput_cleanup_hidinput(struct hid_device *hid,
1452                 struct hid_input *hidinput)
1453 {
1454         struct hid_report *report;
1455         int i, k;
1456
1457         list_del(&hidinput->list);
1458         input_free_device(hidinput->input);
1459
1460         for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
1461                 if (k == HID_OUTPUT_REPORT &&
1462                         hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
1463                         continue;
1464
1465                 list_for_each_entry(report, &hid->report_enum[k].report_list,
1466                                     list) {
1467
1468                         for (i = 0; i < report->maxfield; i++)
1469                                 if (report->field[i]->hidinput == hidinput)
1470                                         report->field[i]->hidinput = NULL;
1471                 }
1472         }
1473
1474         kfree(hidinput);
1475 }
1476
1477 /*
1478  * Register the input device; print a message.
1479  * Configure the input layer interface
1480  * Read all reports and initialize the absolute field values.
1481  */
1482
1483 int hidinput_connect(struct hid_device *hid, unsigned int force)
1484 {
1485         struct hid_driver *drv = hid->driver;
1486         struct hid_report *report;
1487         struct hid_input *hidinput = NULL;
1488         int i, j, k;
1489
1490         INIT_LIST_HEAD(&hid->inputs);
1491         INIT_WORK(&hid->led_work, hidinput_led_worker);
1492
1493         if (!force) {
1494                 for (i = 0; i < hid->maxcollection; i++) {
1495                         struct hid_collection *col = &hid->collection[i];
1496                         if (col->type == HID_COLLECTION_APPLICATION ||
1497                                         col->type == HID_COLLECTION_PHYSICAL)
1498                                 if (IS_INPUT_APPLICATION(col->usage))
1499                                         break;
1500                 }
1501
1502                 if (i == hid->maxcollection)
1503                         return -1;
1504         }
1505
1506         report_features(hid);
1507
1508         for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
1509                 if (k == HID_OUTPUT_REPORT &&
1510                         hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
1511                         continue;
1512
1513                 list_for_each_entry(report, &hid->report_enum[k].report_list, list) {
1514
1515                         if (!report->maxfield)
1516                                 continue;
1517
1518                         if (!hidinput) {
1519                                 hidinput = hidinput_allocate(hid);
1520                                 if (!hidinput)
1521                                         goto out_unwind;
1522                         }
1523
1524                         for (i = 0; i < report->maxfield; i++)
1525                                 for (j = 0; j < report->field[i]->maxusage; j++)
1526                                         hidinput_configure_usage(hidinput, report->field[i],
1527                                                                  report->field[i]->usage + j);
1528
1529                         if ((hid->quirks & HID_QUIRK_NO_EMPTY_INPUT) &&
1530                             !hidinput_has_been_populated(hidinput))
1531                                 continue;
1532
1533                         if (hid->quirks & HID_QUIRK_MULTI_INPUT) {
1534                                 /* This will leave hidinput NULL, so that it
1535                                  * allocates another one if we have more inputs on
1536                                  * the same interface. Some devices (e.g. Happ's
1537                                  * UGCI) cram a lot of unrelated inputs into the
1538                                  * same interface. */
1539                                 hidinput->report = report;
1540                                 if (drv->input_configured &&
1541                                     drv->input_configured(hid, hidinput))
1542                                         goto out_cleanup;
1543                                 if (input_register_device(hidinput->input))
1544                                         goto out_cleanup;
1545                                 hidinput = NULL;
1546                         }
1547                 }
1548         }
1549
1550         if (hidinput && (hid->quirks & HID_QUIRK_NO_EMPTY_INPUT) &&
1551             !hidinput_has_been_populated(hidinput)) {
1552                 /* no need to register an input device not populated */
1553                 hidinput_cleanup_hidinput(hid, hidinput);
1554                 hidinput = NULL;
1555         }
1556
1557         if (list_empty(&hid->inputs)) {
1558                 hid_err(hid, "No inputs registered, leaving\n");
1559                 goto out_unwind;
1560         }
1561
1562         if (hidinput) {
1563                 if (drv->input_configured &&
1564                     drv->input_configured(hid, hidinput))
1565                         goto out_cleanup;
1566                 if (input_register_device(hidinput->input))
1567                         goto out_cleanup;
1568         }
1569
1570         return 0;
1571
1572 out_cleanup:
1573         list_del(&hidinput->list);
1574         input_free_device(hidinput->input);
1575         kfree(hidinput);
1576 out_unwind:
1577         /* unwind the ones we already registered */
1578         hidinput_disconnect(hid);
1579
1580         return -1;
1581 }
1582 EXPORT_SYMBOL_GPL(hidinput_connect);
1583
1584 void hidinput_disconnect(struct hid_device *hid)
1585 {
1586         struct hid_input *hidinput, *next;
1587
1588         hidinput_cleanup_battery(hid);
1589
1590         list_for_each_entry_safe(hidinput, next, &hid->inputs, list) {
1591                 list_del(&hidinput->list);
1592                 input_unregister_device(hidinput->input);
1593                 kfree(hidinput);
1594         }
1595
1596         /* led_work is spawned by input_dev callbacks, but doesn't access the
1597          * parent input_dev at all. Once all input devices are removed, we
1598          * know that led_work will never get restarted, so we can cancel it
1599          * synchronously and are safe. */
1600         cancel_work_sync(&hid->led_work);
1601 }
1602 EXPORT_SYMBOL_GPL(hidinput_disconnect);
1603