ip6_tunnel: better validate user provided tunnel names
[linux/fpc-iii.git] / drivers / hid / hid-input.c
blob40233315d5f57758a465d1b8adbe50fc19d94fa9
1 /*
2 * Copyright (c) 2000-2001 Vojtech Pavlik
3 * Copyright (c) 2006-2010 Jiri Kosina
5 * HID to Linux Input mapping
6 */
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.
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.
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
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
28 #include <linux/module.h>
29 #include <linux/slab.h>
30 #include <linux/kernel.h>
32 #include <linux/hid.h>
33 #include <linux/hid-debug.h>
35 #include "hid-ids.h"
37 #define unk KEY_UNKNOWN
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
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}};
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))
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))
73 static bool match_scancode(struct hid_usage *usage,
74 unsigned int cur_idx, unsigned int scancode)
76 return (usage->hid & (HID_USAGE_PAGE | HID_USAGE)) == scancode;
79 static bool match_keycode(struct hid_usage *usage,
80 unsigned int cur_idx, unsigned int keycode)
83 * We should exclude unmapped usages when doing lookup by keycode.
85 return (usage->type == EV_KEY && usage->code == keycode);
88 static bool match_index(struct hid_usage *usage,
89 unsigned int cur_idx, unsigned int idx)
91 return cur_idx == idx;
94 typedef bool (*hid_usage_cmp_t)(struct hid_usage *usage,
95 unsigned int cur_idx, unsigned int val);
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)
102 unsigned int i, j, k, cur_idx = 0;
103 struct hid_report *report;
104 struct hid_usage *usage;
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;
117 cur_idx++;
123 return NULL;
126 static struct hid_usage *hidinput_locate_usage(struct hid_device *hid,
127 const struct input_keymap_entry *ke,
128 unsigned int *index)
130 struct hid_usage *usage;
131 unsigned int scancode;
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;
140 return usage;
143 static int hidinput_getkeycode(struct input_dev *dev,
144 struct input_keymap_entry *ke)
146 struct hid_device *hid = input_get_drvdata(dev);
147 struct hid_usage *usage;
148 unsigned int scancode, index;
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;
161 return -EINVAL;
164 static int hidinput_setkeycode(struct input_dev *dev,
165 const struct input_keymap_entry *ke,
166 unsigned int *old_keycode)
168 struct hid_device *hid = input_get_drvdata(dev);
169 struct hid_usage *usage;
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;
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);
183 * Set the keybit for the old keycode if the old keycode is used
184 * by another key
186 if (hidinput_find_key(hid, match_keycode, *old_keycode, NULL))
187 set_bit(*old_keycode, dev->keybit);
189 return 0;
192 return -EINVAL;
197 * hidinput_calc_abs_res - calculate an absolute axis resolution
198 * @field: the HID report field to calculate resolution for
199 * @code: axis code
201 * The formula is:
202 * (logical_maximum - logical_minimum)
203 * resolution = ----------------------------------------------------------
204 * (physical_maximum - physical_minimum) * 10 ^ unit_exponent
206 * as seen in the HID specification v1.11 6.2.2.7 Global Items.
208 * Only exponent 1 length units are processed. Centimeters and inches are
209 * converted to millimeters. Degrees are converted to radians.
211 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code)
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;
220 /* Check if the extents are sane */
221 if (logical_extents <= 0 || physical_extents <= 0)
222 return 0;
225 * Verify and convert units.
226 * See HID specification v1.11 6.2.2.7 Global Items for unit decoding
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;
251 break;
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;
268 break;
270 default:
271 return 0;
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;
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;
289 /* Calculate resolution */
290 return DIV_ROUND_CLOSEST(logical_extents, physical_extents);
292 EXPORT_SYMBOL_GPL(hidinput_calc_abs_res);
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,
304 #define HID_BATTERY_QUIRK_PERCENT (1 << 0) /* always reports percent */
305 #define HID_BATTERY_QUIRK_FEATURE (1 << 1) /* ask for feature report */
306 #define HID_BATTERY_QUIRK_IGNORE (1 << 2) /* completely ignore the battery */
308 static const struct hid_device_id hid_battery_quirks[] = {
309 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
310 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO),
311 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
312 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
313 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI),
314 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
315 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
316 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ANSI),
317 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
318 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
319 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ISO),
320 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
321 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
322 USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI),
323 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
324 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_ELECOM,
325 USB_DEVICE_ID_ELECOM_BM084),
326 HID_BATTERY_QUIRK_IGNORE },
330 static unsigned find_battery_quirk(struct hid_device *hdev)
332 unsigned quirks = 0;
333 const struct hid_device_id *match;
335 match = hid_match_id(hdev, hid_battery_quirks);
336 if (match != NULL)
337 quirks = match->driver_data;
339 return quirks;
342 static int hidinput_get_battery_property(struct power_supply *psy,
343 enum power_supply_property prop,
344 union power_supply_propval *val)
346 struct hid_device *dev = power_supply_get_drvdata(psy);
347 int ret = 0;
348 __u8 *buf;
350 switch (prop) {
351 case POWER_SUPPLY_PROP_PRESENT:
352 case POWER_SUPPLY_PROP_ONLINE:
353 val->intval = 1;
354 break;
356 case POWER_SUPPLY_PROP_CAPACITY:
358 buf = kmalloc(2 * sizeof(__u8), GFP_KERNEL);
359 if (!buf) {
360 ret = -ENOMEM;
361 break;
363 ret = hid_hw_raw_request(dev, dev->battery_report_id, buf, 2,
364 dev->battery_report_type,
365 HID_REQ_GET_REPORT);
367 if (ret != 2) {
368 ret = -ENODATA;
369 kfree(buf);
370 break;
372 ret = 0;
374 if (dev->battery_min < dev->battery_max &&
375 buf[1] >= dev->battery_min &&
376 buf[1] <= dev->battery_max)
377 val->intval = (100 * (buf[1] - dev->battery_min)) /
378 (dev->battery_max - dev->battery_min);
379 kfree(buf);
380 break;
382 case POWER_SUPPLY_PROP_MODEL_NAME:
383 val->strval = dev->name;
384 break;
386 case POWER_SUPPLY_PROP_STATUS:
387 val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
388 break;
390 case POWER_SUPPLY_PROP_SCOPE:
391 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
392 break;
394 default:
395 ret = -EINVAL;
396 break;
399 return ret;
402 static bool hidinput_setup_battery(struct hid_device *dev, unsigned report_type, struct hid_field *field)
404 struct power_supply_desc *psy_desc = NULL;
405 struct power_supply_config psy_cfg = { .drv_data = dev, };
406 unsigned quirks;
407 s32 min, max;
409 if (field->usage->hid != HID_DC_BATTERYSTRENGTH)
410 return false; /* no match */
412 if (dev->battery != NULL)
413 goto out; /* already initialized? */
415 quirks = find_battery_quirk(dev);
417 hid_dbg(dev, "device %x:%x:%x %d quirks %d\n",
418 dev->bus, dev->vendor, dev->product, dev->version, quirks);
420 if (quirks & HID_BATTERY_QUIRK_IGNORE)
421 goto out;
423 psy_desc = kzalloc(sizeof(*psy_desc), GFP_KERNEL);
424 if (psy_desc == NULL)
425 goto out;
427 psy_desc->name = kasprintf(GFP_KERNEL, "hid-%s-battery", dev->uniq);
428 if (psy_desc->name == NULL) {
429 kfree(psy_desc);
430 goto out;
433 psy_desc->type = POWER_SUPPLY_TYPE_BATTERY;
434 psy_desc->properties = hidinput_battery_props;
435 psy_desc->num_properties = ARRAY_SIZE(hidinput_battery_props);
436 psy_desc->use_for_apm = 0;
437 psy_desc->get_property = hidinput_get_battery_property;
439 min = field->logical_minimum;
440 max = field->logical_maximum;
442 if (quirks & HID_BATTERY_QUIRK_PERCENT) {
443 min = 0;
444 max = 100;
447 if (quirks & HID_BATTERY_QUIRK_FEATURE)
448 report_type = HID_FEATURE_REPORT;
450 dev->battery_min = min;
451 dev->battery_max = max;
452 dev->battery_report_type = report_type;
453 dev->battery_report_id = field->report->id;
455 dev->battery = power_supply_register(&dev->dev, psy_desc, &psy_cfg);
456 if (IS_ERR(dev->battery)) {
457 hid_warn(dev, "can't register power supply: %ld\n",
458 PTR_ERR(dev->battery));
459 kfree(psy_desc->name);
460 kfree(psy_desc);
461 dev->battery = NULL;
462 } else {
463 power_supply_powers(dev->battery, &dev->dev);
466 out:
467 return true;
470 static void hidinput_cleanup_battery(struct hid_device *dev)
472 const struct power_supply_desc *psy_desc;
474 if (!dev->battery)
475 return;
477 psy_desc = dev->battery->desc;
478 power_supply_unregister(dev->battery);
479 kfree(psy_desc->name);
480 kfree(psy_desc);
481 dev->battery = NULL;
483 #else /* !CONFIG_HID_BATTERY_STRENGTH */
484 static bool hidinput_setup_battery(struct hid_device *dev, unsigned report_type,
485 struct hid_field *field)
487 return false;
490 static void hidinput_cleanup_battery(struct hid_device *dev)
493 #endif /* CONFIG_HID_BATTERY_STRENGTH */
495 static void hidinput_configure_usage(struct hid_input *hidinput, struct hid_field *field,
496 struct hid_usage *usage)
498 struct input_dev *input = hidinput->input;
499 struct hid_device *device = input_get_drvdata(input);
500 int max = 0, code;
501 unsigned long *bit = NULL;
503 field->hidinput = hidinput;
505 if (field->flags & HID_MAIN_ITEM_CONSTANT)
506 goto ignore;
508 /* Ignore if report count is out of bounds. */
509 if (field->report_count < 1)
510 goto ignore;
512 /* only LED usages are supported in output fields */
513 if (field->report_type == HID_OUTPUT_REPORT &&
514 (usage->hid & HID_USAGE_PAGE) != HID_UP_LED) {
515 goto ignore;
518 if (device->driver->input_mapping) {
519 int ret = device->driver->input_mapping(device, hidinput, field,
520 usage, &bit, &max);
521 if (ret > 0)
522 goto mapped;
523 if (ret < 0)
524 goto ignore;
527 switch (usage->hid & HID_USAGE_PAGE) {
528 case HID_UP_UNDEFINED:
529 goto ignore;
531 case HID_UP_KEYBOARD:
532 set_bit(EV_REP, input->evbit);
534 if ((usage->hid & HID_USAGE) < 256) {
535 if (!hid_keyboard[usage->hid & HID_USAGE]) goto ignore;
536 map_key_clear(hid_keyboard[usage->hid & HID_USAGE]);
537 } else
538 map_key(KEY_UNKNOWN);
540 break;
542 case HID_UP_BUTTON:
543 code = ((usage->hid - 1) & HID_USAGE);
545 switch (field->application) {
546 case HID_GD_MOUSE:
547 case HID_GD_POINTER: code += BTN_MOUSE; break;
548 case HID_GD_JOYSTICK:
549 if (code <= 0xf)
550 code += BTN_JOYSTICK;
551 else
552 code += BTN_TRIGGER_HAPPY - 0x10;
553 break;
554 case HID_GD_GAMEPAD:
555 if (code <= 0xf)
556 code += BTN_GAMEPAD;
557 else
558 code += BTN_TRIGGER_HAPPY - 0x10;
559 break;
560 default:
561 switch (field->physical) {
562 case HID_GD_MOUSE:
563 case HID_GD_POINTER: code += BTN_MOUSE; break;
564 case HID_GD_JOYSTICK: code += BTN_JOYSTICK; break;
565 case HID_GD_GAMEPAD: code += BTN_GAMEPAD; break;
566 default: code += BTN_MISC;
570 map_key(code);
571 break;
573 case HID_UP_SIMULATION:
574 switch (usage->hid & 0xffff) {
575 case 0xba: map_abs(ABS_RUDDER); break;
576 case 0xbb: map_abs(ABS_THROTTLE); break;
577 case 0xc4: map_abs(ABS_GAS); break;
578 case 0xc5: map_abs(ABS_BRAKE); break;
579 case 0xc8: map_abs(ABS_WHEEL); break;
580 default: goto ignore;
582 break;
584 case HID_UP_GENDESK:
585 if ((usage->hid & 0xf0) == 0x80) { /* SystemControl */
586 switch (usage->hid & 0xf) {
587 case 0x1: map_key_clear(KEY_POWER); break;
588 case 0x2: map_key_clear(KEY_SLEEP); break;
589 case 0x3: map_key_clear(KEY_WAKEUP); break;
590 case 0x4: map_key_clear(KEY_CONTEXT_MENU); break;
591 case 0x5: map_key_clear(KEY_MENU); break;
592 case 0x6: map_key_clear(KEY_PROG1); break;
593 case 0x7: map_key_clear(KEY_HELP); break;
594 case 0x8: map_key_clear(KEY_EXIT); break;
595 case 0x9: map_key_clear(KEY_SELECT); break;
596 case 0xa: map_key_clear(KEY_RIGHT); break;
597 case 0xb: map_key_clear(KEY_LEFT); break;
598 case 0xc: map_key_clear(KEY_UP); break;
599 case 0xd: map_key_clear(KEY_DOWN); break;
600 case 0xe: map_key_clear(KEY_POWER2); break;
601 case 0xf: map_key_clear(KEY_RESTART); break;
602 default: goto unknown;
604 break;
608 * Some lazy vendors declare 255 usages for System Control,
609 * leading to the creation of ABS_X|Y axis and too many others.
610 * It wouldn't be a problem if joydev doesn't consider the
611 * device as a joystick then.
613 if (field->application == HID_GD_SYSTEM_CONTROL)
614 goto ignore;
616 if ((usage->hid & 0xf0) == 0x90) { /* D-pad */
617 switch (usage->hid) {
618 case HID_GD_UP: usage->hat_dir = 1; break;
619 case HID_GD_DOWN: usage->hat_dir = 5; break;
620 case HID_GD_RIGHT: usage->hat_dir = 3; break;
621 case HID_GD_LEFT: usage->hat_dir = 7; break;
622 default: goto unknown;
624 if (field->dpad) {
625 map_abs(field->dpad);
626 goto ignore;
628 map_abs(ABS_HAT0X);
629 break;
632 switch (usage->hid) {
633 /* These usage IDs map directly to the usage codes. */
634 case HID_GD_X: case HID_GD_Y: case HID_GD_Z:
635 case HID_GD_RX: case HID_GD_RY: case HID_GD_RZ:
636 if (field->flags & HID_MAIN_ITEM_RELATIVE)
637 map_rel(usage->hid & 0xf);
638 else
639 map_abs_clear(usage->hid & 0xf);
640 break;
642 case HID_GD_SLIDER: case HID_GD_DIAL: case HID_GD_WHEEL:
643 if (field->flags & HID_MAIN_ITEM_RELATIVE)
644 map_rel(usage->hid & 0xf);
645 else
646 map_abs(usage->hid & 0xf);
647 break;
649 case HID_GD_HATSWITCH:
650 usage->hat_min = field->logical_minimum;
651 usage->hat_max = field->logical_maximum;
652 map_abs(ABS_HAT0X);
653 break;
655 case HID_GD_START: map_key_clear(BTN_START); break;
656 case HID_GD_SELECT: map_key_clear(BTN_SELECT); break;
658 default: goto unknown;
661 break;
663 case HID_UP_LED:
664 switch (usage->hid & 0xffff) { /* HID-Value: */
665 case 0x01: map_led (LED_NUML); break; /* "Num Lock" */
666 case 0x02: map_led (LED_CAPSL); break; /* "Caps Lock" */
667 case 0x03: map_led (LED_SCROLLL); break; /* "Scroll Lock" */
668 case 0x04: map_led (LED_COMPOSE); break; /* "Compose" */
669 case 0x05: map_led (LED_KANA); break; /* "Kana" */
670 case 0x27: map_led (LED_SLEEP); break; /* "Stand-By" */
671 case 0x4c: map_led (LED_SUSPEND); break; /* "System Suspend" */
672 case 0x09: map_led (LED_MUTE); break; /* "Mute" */
673 case 0x4b: map_led (LED_MISC); break; /* "Generic Indicator" */
674 case 0x19: map_led (LED_MAIL); break; /* "Message Waiting" */
675 case 0x4d: map_led (LED_CHARGING); break; /* "External Power Connected" */
677 default: goto ignore;
679 break;
681 case HID_UP_DIGITIZER:
682 switch (usage->hid & 0xff) {
683 case 0x00: /* Undefined */
684 goto ignore;
686 case 0x30: /* TipPressure */
687 if (!test_bit(BTN_TOUCH, input->keybit)) {
688 device->quirks |= HID_QUIRK_NOTOUCH;
689 set_bit(EV_KEY, input->evbit);
690 set_bit(BTN_TOUCH, input->keybit);
692 map_abs_clear(ABS_PRESSURE);
693 break;
695 case 0x32: /* InRange */
696 switch (field->physical & 0xff) {
697 case 0x21: map_key(BTN_TOOL_MOUSE); break;
698 case 0x22: map_key(BTN_TOOL_FINGER); break;
699 default: map_key(BTN_TOOL_PEN); break;
701 break;
703 case 0x3c: /* Invert */
704 map_key_clear(BTN_TOOL_RUBBER);
705 break;
707 case 0x3d: /* X Tilt */
708 map_abs_clear(ABS_TILT_X);
709 break;
711 case 0x3e: /* Y Tilt */
712 map_abs_clear(ABS_TILT_Y);
713 break;
715 case 0x33: /* Touch */
716 case 0x42: /* TipSwitch */
717 case 0x43: /* TipSwitch2 */
718 device->quirks &= ~HID_QUIRK_NOTOUCH;
719 map_key_clear(BTN_TOUCH);
720 break;
722 case 0x44: /* BarrelSwitch */
723 map_key_clear(BTN_STYLUS);
724 break;
726 case 0x46: /* TabletPick */
727 case 0x5a: /* SecondaryBarrelSwitch */
728 map_key_clear(BTN_STYLUS2);
729 break;
731 case 0x5b: /* TransducerSerialNumber */
732 usage->type = EV_MSC;
733 usage->code = MSC_SERIAL;
734 bit = input->mscbit;
735 max = MSC_MAX;
736 break;
738 default: goto unknown;
740 break;
742 case HID_UP_TELEPHONY:
743 switch (usage->hid & HID_USAGE) {
744 case 0x2f: map_key_clear(KEY_MICMUTE); break;
745 case 0xb0: map_key_clear(KEY_NUMERIC_0); break;
746 case 0xb1: map_key_clear(KEY_NUMERIC_1); break;
747 case 0xb2: map_key_clear(KEY_NUMERIC_2); break;
748 case 0xb3: map_key_clear(KEY_NUMERIC_3); break;
749 case 0xb4: map_key_clear(KEY_NUMERIC_4); break;
750 case 0xb5: map_key_clear(KEY_NUMERIC_5); break;
751 case 0xb6: map_key_clear(KEY_NUMERIC_6); break;
752 case 0xb7: map_key_clear(KEY_NUMERIC_7); break;
753 case 0xb8: map_key_clear(KEY_NUMERIC_8); break;
754 case 0xb9: map_key_clear(KEY_NUMERIC_9); break;
755 case 0xba: map_key_clear(KEY_NUMERIC_STAR); break;
756 case 0xbb: map_key_clear(KEY_NUMERIC_POUND); break;
757 case 0xbc: map_key_clear(KEY_NUMERIC_A); break;
758 case 0xbd: map_key_clear(KEY_NUMERIC_B); break;
759 case 0xbe: map_key_clear(KEY_NUMERIC_C); break;
760 case 0xbf: map_key_clear(KEY_NUMERIC_D); break;
761 default: goto ignore;
763 break;
765 case HID_UP_CONSUMER: /* USB HUT v1.12, pages 75-84 */
766 switch (usage->hid & HID_USAGE) {
767 case 0x000: goto ignore;
768 case 0x030: map_key_clear(KEY_POWER); break;
769 case 0x031: map_key_clear(KEY_RESTART); break;
770 case 0x032: map_key_clear(KEY_SLEEP); break;
771 case 0x034: map_key_clear(KEY_SLEEP); break;
772 case 0x035: map_key_clear(KEY_KBDILLUMTOGGLE); break;
773 case 0x036: map_key_clear(BTN_MISC); break;
775 case 0x040: map_key_clear(KEY_MENU); break; /* Menu */
776 case 0x041: map_key_clear(KEY_SELECT); break; /* Menu Pick */
777 case 0x042: map_key_clear(KEY_UP); break; /* Menu Up */
778 case 0x043: map_key_clear(KEY_DOWN); break; /* Menu Down */
779 case 0x044: map_key_clear(KEY_LEFT); break; /* Menu Left */
780 case 0x045: map_key_clear(KEY_RIGHT); break; /* Menu Right */
781 case 0x046: map_key_clear(KEY_ESC); break; /* Menu Escape */
782 case 0x047: map_key_clear(KEY_KPPLUS); break; /* Menu Value Increase */
783 case 0x048: map_key_clear(KEY_KPMINUS); break; /* Menu Value Decrease */
785 case 0x060: map_key_clear(KEY_INFO); break; /* Data On Screen */
786 case 0x061: map_key_clear(KEY_SUBTITLE); break; /* Closed Caption */
787 case 0x063: map_key_clear(KEY_VCR); break; /* VCR/TV */
788 case 0x065: map_key_clear(KEY_CAMERA); break; /* Snapshot */
789 case 0x069: map_key_clear(KEY_RED); break;
790 case 0x06a: map_key_clear(KEY_GREEN); break;
791 case 0x06b: map_key_clear(KEY_BLUE); break;
792 case 0x06c: map_key_clear(KEY_YELLOW); break;
793 case 0x06d: map_key_clear(KEY_ZOOM); break;
795 case 0x06f: map_key_clear(KEY_BRIGHTNESSUP); break;
796 case 0x070: map_key_clear(KEY_BRIGHTNESSDOWN); break;
797 case 0x072: map_key_clear(KEY_BRIGHTNESS_TOGGLE); break;
798 case 0x073: map_key_clear(KEY_BRIGHTNESS_MIN); break;
799 case 0x074: map_key_clear(KEY_BRIGHTNESS_MAX); break;
800 case 0x075: map_key_clear(KEY_BRIGHTNESS_AUTO); break;
802 case 0x082: map_key_clear(KEY_VIDEO_NEXT); break;
803 case 0x083: map_key_clear(KEY_LAST); break;
804 case 0x084: map_key_clear(KEY_ENTER); break;
805 case 0x088: map_key_clear(KEY_PC); break;
806 case 0x089: map_key_clear(KEY_TV); break;
807 case 0x08a: map_key_clear(KEY_WWW); break;
808 case 0x08b: map_key_clear(KEY_DVD); break;
809 case 0x08c: map_key_clear(KEY_PHONE); break;
810 case 0x08d: map_key_clear(KEY_PROGRAM); break;
811 case 0x08e: map_key_clear(KEY_VIDEOPHONE); break;
812 case 0x08f: map_key_clear(KEY_GAMES); break;
813 case 0x090: map_key_clear(KEY_MEMO); break;
814 case 0x091: map_key_clear(KEY_CD); break;
815 case 0x092: map_key_clear(KEY_VCR); break;
816 case 0x093: map_key_clear(KEY_TUNER); break;
817 case 0x094: map_key_clear(KEY_EXIT); break;
818 case 0x095: map_key_clear(KEY_HELP); break;
819 case 0x096: map_key_clear(KEY_TAPE); break;
820 case 0x097: map_key_clear(KEY_TV2); break;
821 case 0x098: map_key_clear(KEY_SAT); break;
822 case 0x09a: map_key_clear(KEY_PVR); break;
824 case 0x09c: map_key_clear(KEY_CHANNELUP); break;
825 case 0x09d: map_key_clear(KEY_CHANNELDOWN); break;
826 case 0x0a0: map_key_clear(KEY_VCR2); break;
828 case 0x0b0: map_key_clear(KEY_PLAY); break;
829 case 0x0b1: map_key_clear(KEY_PAUSE); break;
830 case 0x0b2: map_key_clear(KEY_RECORD); break;
831 case 0x0b3: map_key_clear(KEY_FASTFORWARD); break;
832 case 0x0b4: map_key_clear(KEY_REWIND); break;
833 case 0x0b5: map_key_clear(KEY_NEXTSONG); break;
834 case 0x0b6: map_key_clear(KEY_PREVIOUSSONG); break;
835 case 0x0b7: map_key_clear(KEY_STOPCD); break;
836 case 0x0b8: map_key_clear(KEY_EJECTCD); break;
837 case 0x0bc: map_key_clear(KEY_MEDIA_REPEAT); break;
838 case 0x0b9: map_key_clear(KEY_SHUFFLE); break;
839 case 0x0bf: map_key_clear(KEY_SLOW); break;
841 case 0x0cd: map_key_clear(KEY_PLAYPAUSE); break;
842 case 0x0cf: map_key_clear(KEY_VOICECOMMAND); break;
843 case 0x0e0: map_abs_clear(ABS_VOLUME); break;
844 case 0x0e2: map_key_clear(KEY_MUTE); break;
845 case 0x0e5: map_key_clear(KEY_BASSBOOST); break;
846 case 0x0e9: map_key_clear(KEY_VOLUMEUP); break;
847 case 0x0ea: map_key_clear(KEY_VOLUMEDOWN); break;
848 case 0x0f5: map_key_clear(KEY_SLOW); break;
850 case 0x181: map_key_clear(KEY_BUTTONCONFIG); break;
851 case 0x182: map_key_clear(KEY_BOOKMARKS); break;
852 case 0x183: map_key_clear(KEY_CONFIG); break;
853 case 0x184: map_key_clear(KEY_WORDPROCESSOR); break;
854 case 0x185: map_key_clear(KEY_EDITOR); break;
855 case 0x186: map_key_clear(KEY_SPREADSHEET); break;
856 case 0x187: map_key_clear(KEY_GRAPHICSEDITOR); break;
857 case 0x188: map_key_clear(KEY_PRESENTATION); break;
858 case 0x189: map_key_clear(KEY_DATABASE); break;
859 case 0x18a: map_key_clear(KEY_MAIL); break;
860 case 0x18b: map_key_clear(KEY_NEWS); break;
861 case 0x18c: map_key_clear(KEY_VOICEMAIL); break;
862 case 0x18d: map_key_clear(KEY_ADDRESSBOOK); break;
863 case 0x18e: map_key_clear(KEY_CALENDAR); break;
864 case 0x18f: map_key_clear(KEY_TASKMANAGER); break;
865 case 0x190: map_key_clear(KEY_JOURNAL); break;
866 case 0x191: map_key_clear(KEY_FINANCE); break;
867 case 0x192: map_key_clear(KEY_CALC); break;
868 case 0x193: map_key_clear(KEY_PLAYER); break;
869 case 0x194: map_key_clear(KEY_FILE); break;
870 case 0x196: map_key_clear(KEY_WWW); break;
871 case 0x199: map_key_clear(KEY_CHAT); break;
872 case 0x19c: map_key_clear(KEY_LOGOFF); break;
873 case 0x19e: map_key_clear(KEY_COFFEE); break;
874 case 0x19f: map_key_clear(KEY_CONTROLPANEL); break;
875 case 0x1a2: map_key_clear(KEY_APPSELECT); break;
876 case 0x1a3: map_key_clear(KEY_NEXT); break;
877 case 0x1a4: map_key_clear(KEY_PREVIOUS); break;
878 case 0x1a6: map_key_clear(KEY_HELP); break;
879 case 0x1a7: map_key_clear(KEY_DOCUMENTS); break;
880 case 0x1ab: map_key_clear(KEY_SPELLCHECK); break;
881 case 0x1ae: map_key_clear(KEY_KEYBOARD); break;
882 case 0x1b1: map_key_clear(KEY_SCREENSAVER); break;
883 case 0x1b4: map_key_clear(KEY_FILE); break;
884 case 0x1b6: map_key_clear(KEY_IMAGES); break;
885 case 0x1b7: map_key_clear(KEY_AUDIO); break;
886 case 0x1b8: map_key_clear(KEY_VIDEO); break;
887 case 0x1bc: map_key_clear(KEY_MESSENGER); break;
888 case 0x1bd: map_key_clear(KEY_INFO); break;
889 case 0x201: map_key_clear(KEY_NEW); break;
890 case 0x202: map_key_clear(KEY_OPEN); break;
891 case 0x203: map_key_clear(KEY_CLOSE); break;
892 case 0x204: map_key_clear(KEY_EXIT); break;
893 case 0x207: map_key_clear(KEY_SAVE); break;
894 case 0x208: map_key_clear(KEY_PRINT); break;
895 case 0x209: map_key_clear(KEY_PROPS); break;
896 case 0x21a: map_key_clear(KEY_UNDO); break;
897 case 0x21b: map_key_clear(KEY_COPY); break;
898 case 0x21c: map_key_clear(KEY_CUT); break;
899 case 0x21d: map_key_clear(KEY_PASTE); break;
900 case 0x21f: map_key_clear(KEY_FIND); break;
901 case 0x221: map_key_clear(KEY_SEARCH); break;
902 case 0x222: map_key_clear(KEY_GOTO); break;
903 case 0x223: map_key_clear(KEY_HOMEPAGE); break;
904 case 0x224: map_key_clear(KEY_BACK); break;
905 case 0x225: map_key_clear(KEY_FORWARD); break;
906 case 0x226: map_key_clear(KEY_STOP); break;
907 case 0x227: map_key_clear(KEY_REFRESH); break;
908 case 0x22a: map_key_clear(KEY_BOOKMARKS); break;
909 case 0x22d: map_key_clear(KEY_ZOOMIN); break;
910 case 0x22e: map_key_clear(KEY_ZOOMOUT); break;
911 case 0x22f: map_key_clear(KEY_ZOOMRESET); break;
912 case 0x233: map_key_clear(KEY_SCROLLUP); break;
913 case 0x234: map_key_clear(KEY_SCROLLDOWN); break;
914 case 0x238: map_rel(REL_HWHEEL); break;
915 case 0x23d: map_key_clear(KEY_EDIT); break;
916 case 0x25f: map_key_clear(KEY_CANCEL); break;
917 case 0x269: map_key_clear(KEY_INSERT); break;
918 case 0x26a: map_key_clear(KEY_DELETE); break;
919 case 0x279: map_key_clear(KEY_REDO); break;
921 case 0x289: map_key_clear(KEY_REPLY); break;
922 case 0x28b: map_key_clear(KEY_FORWARDMAIL); break;
923 case 0x28c: map_key_clear(KEY_SEND); break;
925 case 0x2c7: map_key_clear(KEY_KBDINPUTASSIST_PREV); break;
926 case 0x2c8: map_key_clear(KEY_KBDINPUTASSIST_NEXT); break;
927 case 0x2c9: map_key_clear(KEY_KBDINPUTASSIST_PREVGROUP); break;
928 case 0x2ca: map_key_clear(KEY_KBDINPUTASSIST_NEXTGROUP); break;
929 case 0x2cb: map_key_clear(KEY_KBDINPUTASSIST_ACCEPT); break;
930 case 0x2cc: map_key_clear(KEY_KBDINPUTASSIST_CANCEL); break;
932 default: map_key_clear(KEY_UNKNOWN);
934 break;
936 case HID_UP_GENDEVCTRLS:
937 if (hidinput_setup_battery(device, HID_INPUT_REPORT, field))
938 goto ignore;
939 else
940 goto unknown;
941 break;
943 case HID_UP_HPVENDOR: /* Reported on a Dutch layout HP5308 */
944 set_bit(EV_REP, input->evbit);
945 switch (usage->hid & HID_USAGE) {
946 case 0x021: map_key_clear(KEY_PRINT); break;
947 case 0x070: map_key_clear(KEY_HP); break;
948 case 0x071: map_key_clear(KEY_CAMERA); break;
949 case 0x072: map_key_clear(KEY_SOUND); break;
950 case 0x073: map_key_clear(KEY_QUESTION); break;
951 case 0x080: map_key_clear(KEY_EMAIL); break;
952 case 0x081: map_key_clear(KEY_CHAT); break;
953 case 0x082: map_key_clear(KEY_SEARCH); break;
954 case 0x083: map_key_clear(KEY_CONNECT); break;
955 case 0x084: map_key_clear(KEY_FINANCE); break;
956 case 0x085: map_key_clear(KEY_SPORT); break;
957 case 0x086: map_key_clear(KEY_SHOP); break;
958 default: goto ignore;
960 break;
962 case HID_UP_HPVENDOR2:
963 set_bit(EV_REP, input->evbit);
964 switch (usage->hid & HID_USAGE) {
965 case 0x001: map_key_clear(KEY_MICMUTE); break;
966 case 0x003: map_key_clear(KEY_BRIGHTNESSDOWN); break;
967 case 0x004: map_key_clear(KEY_BRIGHTNESSUP); break;
968 default: goto ignore;
970 break;
972 case HID_UP_MSVENDOR:
973 goto ignore;
975 case HID_UP_CUSTOM: /* Reported on Logitech and Apple USB keyboards */
976 set_bit(EV_REP, input->evbit);
977 goto ignore;
979 case HID_UP_LOGIVENDOR:
980 /* intentional fallback */
981 case HID_UP_LOGIVENDOR2:
982 /* intentional fallback */
983 case HID_UP_LOGIVENDOR3:
984 goto ignore;
986 case HID_UP_PID:
987 switch (usage->hid & HID_USAGE) {
988 case 0xa4: map_key_clear(BTN_DEAD); break;
989 default: goto ignore;
991 break;
993 default:
994 unknown:
995 if (field->report_size == 1) {
996 if (field->report->type == HID_OUTPUT_REPORT) {
997 map_led(LED_MISC);
998 break;
1000 map_key(BTN_MISC);
1001 break;
1003 if (field->flags & HID_MAIN_ITEM_RELATIVE) {
1004 map_rel(REL_MISC);
1005 break;
1007 map_abs(ABS_MISC);
1008 break;
1011 mapped:
1012 if (device->driver->input_mapped && device->driver->input_mapped(device,
1013 hidinput, field, usage, &bit, &max) < 0)
1014 goto ignore;
1016 set_bit(usage->type, input->evbit);
1018 while (usage->code <= max && test_and_set_bit(usage->code, bit))
1019 usage->code = find_next_zero_bit(bit, max + 1, usage->code);
1021 if (usage->code > max)
1022 goto ignore;
1025 if (usage->type == EV_ABS) {
1027 int a = field->logical_minimum;
1028 int b = field->logical_maximum;
1030 if ((device->quirks & HID_QUIRK_BADPAD) && (usage->code == ABS_X || usage->code == ABS_Y)) {
1031 a = field->logical_minimum = 0;
1032 b = field->logical_maximum = 255;
1035 if (field->application == HID_GD_GAMEPAD || field->application == HID_GD_JOYSTICK)
1036 input_set_abs_params(input, usage->code, a, b, (b - a) >> 8, (b - a) >> 4);
1037 else input_set_abs_params(input, usage->code, a, b, 0, 0);
1039 input_abs_set_res(input, usage->code,
1040 hidinput_calc_abs_res(field, usage->code));
1042 /* use a larger default input buffer for MT devices */
1043 if (usage->code == ABS_MT_POSITION_X && input->hint_events_per_packet == 0)
1044 input_set_events_per_packet(input, 60);
1047 if (usage->type == EV_ABS &&
1048 (usage->hat_min < usage->hat_max || usage->hat_dir)) {
1049 int i;
1050 for (i = usage->code; i < usage->code + 2 && i <= max; i++) {
1051 input_set_abs_params(input, i, -1, 1, 0, 0);
1052 set_bit(i, input->absbit);
1054 if (usage->hat_dir && !field->dpad)
1055 field->dpad = usage->code;
1058 /* for those devices which produce Consumer volume usage as relative,
1059 * we emulate pressing volumeup/volumedown appropriate number of times
1060 * in hidinput_hid_event()
1062 if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
1063 (usage->code == ABS_VOLUME)) {
1064 set_bit(KEY_VOLUMEUP, input->keybit);
1065 set_bit(KEY_VOLUMEDOWN, input->keybit);
1068 if (usage->type == EV_KEY) {
1069 set_bit(EV_MSC, input->evbit);
1070 set_bit(MSC_SCAN, input->mscbit);
1073 ignore:
1074 return;
1078 void hidinput_hid_event(struct hid_device *hid, struct hid_field *field, struct hid_usage *usage, __s32 value)
1080 struct input_dev *input;
1081 unsigned *quirks = &hid->quirks;
1083 if (!field->hidinput)
1084 return;
1086 input = field->hidinput->input;
1088 if (!usage->type)
1089 return;
1091 if (usage->hat_min < usage->hat_max || usage->hat_dir) {
1092 int hat_dir = usage->hat_dir;
1093 if (!hat_dir)
1094 hat_dir = (value - usage->hat_min) * 8 / (usage->hat_max - usage->hat_min + 1) + 1;
1095 if (hat_dir < 0 || hat_dir > 8) hat_dir = 0;
1096 input_event(input, usage->type, usage->code , hid_hat_to_axis[hat_dir].x);
1097 input_event(input, usage->type, usage->code + 1, hid_hat_to_axis[hat_dir].y);
1098 return;
1101 if (usage->hid == (HID_UP_DIGITIZER | 0x003c)) { /* Invert */
1102 *quirks = value ? (*quirks | HID_QUIRK_INVERT) : (*quirks & ~HID_QUIRK_INVERT);
1103 return;
1106 if (usage->hid == (HID_UP_DIGITIZER | 0x0032)) { /* InRange */
1107 if (value) {
1108 input_event(input, usage->type, (*quirks & HID_QUIRK_INVERT) ? BTN_TOOL_RUBBER : usage->code, 1);
1109 return;
1111 input_event(input, usage->type, usage->code, 0);
1112 input_event(input, usage->type, BTN_TOOL_RUBBER, 0);
1113 return;
1116 if (usage->hid == (HID_UP_DIGITIZER | 0x0030) && (*quirks & HID_QUIRK_NOTOUCH)) { /* Pressure */
1117 int a = field->logical_minimum;
1118 int b = field->logical_maximum;
1119 input_event(input, EV_KEY, BTN_TOUCH, value > a + ((b - a) >> 3));
1122 if (usage->hid == (HID_UP_PID | 0x83UL)) { /* Simultaneous Effects Max */
1123 dbg_hid("Maximum Effects - %d\n",value);
1124 return;
1127 if (usage->hid == (HID_UP_PID | 0x7fUL)) {
1128 dbg_hid("PID Pool Report\n");
1129 return;
1132 if ((usage->type == EV_KEY) && (usage->code == 0)) /* Key 0 is "unassigned", not KEY_UNKNOWN */
1133 return;
1135 if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
1136 (usage->code == ABS_VOLUME)) {
1137 int count = abs(value);
1138 int direction = value > 0 ? KEY_VOLUMEUP : KEY_VOLUMEDOWN;
1139 int i;
1141 for (i = 0; i < count; i++) {
1142 input_event(input, EV_KEY, direction, 1);
1143 input_sync(input);
1144 input_event(input, EV_KEY, direction, 0);
1145 input_sync(input);
1147 return;
1151 * Ignore out-of-range values as per HID specification,
1152 * section 5.10 and 6.2.25, when NULL state bit is present.
1153 * When it's not, clamp the value to match Microsoft's input
1154 * driver as mentioned in "Required HID usages for digitizers":
1155 * https://msdn.microsoft.com/en-us/library/windows/hardware/dn672278(v=vs.85).asp
1157 * The logical_minimum < logical_maximum check is done so that we
1158 * don't unintentionally discard values sent by devices which
1159 * don't specify logical min and max.
1161 if ((field->flags & HID_MAIN_ITEM_VARIABLE) &&
1162 (field->logical_minimum < field->logical_maximum)) {
1163 if (field->flags & HID_MAIN_ITEM_NULL_STATE &&
1164 (value < field->logical_minimum ||
1165 value > field->logical_maximum)) {
1166 dbg_hid("Ignoring out-of-range value %x\n", value);
1167 return;
1169 value = clamp(value,
1170 field->logical_minimum,
1171 field->logical_maximum);
1175 * Ignore reports for absolute data if the data didn't change. This is
1176 * not only an optimization but also fixes 'dead' key reports. Some
1177 * RollOver implementations for localized keys (like BACKSLASH/PIPE; HID
1178 * 0x31 and 0x32) report multiple keys, even though a localized keyboard
1179 * can only have one of them physically available. The 'dead' keys
1180 * report constant 0. As all map to the same keycode, they'd confuse
1181 * the input layer. If we filter the 'dead' keys on the HID level, we
1182 * skip the keycode translation and only forward real events.
1184 if (!(field->flags & (HID_MAIN_ITEM_RELATIVE |
1185 HID_MAIN_ITEM_BUFFERED_BYTE)) &&
1186 (field->flags & HID_MAIN_ITEM_VARIABLE) &&
1187 usage->usage_index < field->maxusage &&
1188 value == field->value[usage->usage_index])
1189 return;
1191 /* report the usage code as scancode if the key status has changed */
1192 if (usage->type == EV_KEY &&
1193 (!test_bit(usage->code, input->key)) == value)
1194 input_event(input, EV_MSC, MSC_SCAN, usage->hid);
1196 input_event(input, usage->type, usage->code, value);
1198 if ((field->flags & HID_MAIN_ITEM_RELATIVE) &&
1199 usage->type == EV_KEY && value) {
1200 input_sync(input);
1201 input_event(input, usage->type, usage->code, 0);
1205 void hidinput_report_event(struct hid_device *hid, struct hid_report *report)
1207 struct hid_input *hidinput;
1209 if (hid->quirks & HID_QUIRK_NO_INPUT_SYNC)
1210 return;
1212 list_for_each_entry(hidinput, &hid->inputs, list)
1213 input_sync(hidinput->input);
1215 EXPORT_SYMBOL_GPL(hidinput_report_event);
1217 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field)
1219 struct hid_report *report;
1220 int i, j;
1222 list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
1223 for (i = 0; i < report->maxfield; i++) {
1224 *field = report->field[i];
1225 for (j = 0; j < (*field)->maxusage; j++)
1226 if ((*field)->usage[j].type == type && (*field)->usage[j].code == code)
1227 return j;
1230 return -1;
1232 EXPORT_SYMBOL_GPL(hidinput_find_field);
1234 struct hid_field *hidinput_get_led_field(struct hid_device *hid)
1236 struct hid_report *report;
1237 struct hid_field *field;
1238 int i, j;
1240 list_for_each_entry(report,
1241 &hid->report_enum[HID_OUTPUT_REPORT].report_list,
1242 list) {
1243 for (i = 0; i < report->maxfield; i++) {
1244 field = report->field[i];
1245 for (j = 0; j < field->maxusage; j++)
1246 if (field->usage[j].type == EV_LED)
1247 return field;
1250 return NULL;
1252 EXPORT_SYMBOL_GPL(hidinput_get_led_field);
1254 unsigned int hidinput_count_leds(struct hid_device *hid)
1256 struct hid_report *report;
1257 struct hid_field *field;
1258 int i, j;
1259 unsigned int count = 0;
1261 list_for_each_entry(report,
1262 &hid->report_enum[HID_OUTPUT_REPORT].report_list,
1263 list) {
1264 for (i = 0; i < report->maxfield; i++) {
1265 field = report->field[i];
1266 for (j = 0; j < field->maxusage; j++)
1267 if (field->usage[j].type == EV_LED &&
1268 field->value[j])
1269 count += 1;
1272 return count;
1274 EXPORT_SYMBOL_GPL(hidinput_count_leds);
1276 static void hidinput_led_worker(struct work_struct *work)
1278 struct hid_device *hid = container_of(work, struct hid_device,
1279 led_work);
1280 struct hid_field *field;
1281 struct hid_report *report;
1282 int len, ret;
1283 __u8 *buf;
1285 field = hidinput_get_led_field(hid);
1286 if (!field)
1287 return;
1290 * field->report is accessed unlocked regarding HID core. So there might
1291 * be another incoming SET-LED request from user-space, which changes
1292 * the LED state while we assemble our outgoing buffer. However, this
1293 * doesn't matter as hid_output_report() correctly converts it into a
1294 * boolean value no matter what information is currently set on the LED
1295 * field (even garbage). So the remote device will always get a valid
1296 * request.
1297 * And in case we send a wrong value, a next led worker is spawned
1298 * for every SET-LED request so the following worker will send the
1299 * correct value, guaranteed!
1302 report = field->report;
1304 /* use custom SET_REPORT request if possible (asynchronous) */
1305 if (hid->ll_driver->request)
1306 return hid->ll_driver->request(hid, report, HID_REQ_SET_REPORT);
1308 /* fall back to generic raw-output-report */
1309 len = hid_report_len(report);
1310 buf = hid_alloc_report_buf(report, GFP_KERNEL);
1311 if (!buf)
1312 return;
1314 hid_output_report(report, buf);
1315 /* synchronous output report */
1316 ret = hid_hw_output_report(hid, buf, len);
1317 if (ret == -ENOSYS)
1318 hid_hw_raw_request(hid, report->id, buf, len, HID_OUTPUT_REPORT,
1319 HID_REQ_SET_REPORT);
1320 kfree(buf);
1323 static int hidinput_input_event(struct input_dev *dev, unsigned int type,
1324 unsigned int code, int value)
1326 struct hid_device *hid = input_get_drvdata(dev);
1327 struct hid_field *field;
1328 int offset;
1330 if (type == EV_FF)
1331 return input_ff_event(dev, type, code, value);
1333 if (type != EV_LED)
1334 return -1;
1336 if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
1337 hid_warn(dev, "event field not found\n");
1338 return -1;
1341 hid_set_field(field, offset, value);
1343 schedule_work(&hid->led_work);
1344 return 0;
1347 static int hidinput_open(struct input_dev *dev)
1349 struct hid_device *hid = input_get_drvdata(dev);
1351 return hid_hw_open(hid);
1354 static void hidinput_close(struct input_dev *dev)
1356 struct hid_device *hid = input_get_drvdata(dev);
1358 hid_hw_close(hid);
1361 static void report_features(struct hid_device *hid)
1363 struct hid_driver *drv = hid->driver;
1364 struct hid_report_enum *rep_enum;
1365 struct hid_report *rep;
1366 int i, j;
1368 rep_enum = &hid->report_enum[HID_FEATURE_REPORT];
1369 list_for_each_entry(rep, &rep_enum->report_list, list)
1370 for (i = 0; i < rep->maxfield; i++) {
1371 /* Ignore if report count is out of bounds. */
1372 if (rep->field[i]->report_count < 1)
1373 continue;
1375 for (j = 0; j < rep->field[i]->maxusage; j++) {
1376 /* Verify if Battery Strength feature is available */
1377 hidinput_setup_battery(hid, HID_FEATURE_REPORT, rep->field[i]);
1379 if (drv->feature_mapping)
1380 drv->feature_mapping(hid, rep->field[i],
1381 rep->field[i]->usage + j);
1386 static struct hid_input *hidinput_allocate(struct hid_device *hid)
1388 struct hid_input *hidinput = kzalloc(sizeof(*hidinput), GFP_KERNEL);
1389 struct input_dev *input_dev = input_allocate_device();
1390 if (!hidinput || !input_dev) {
1391 kfree(hidinput);
1392 input_free_device(input_dev);
1393 hid_err(hid, "Out of memory during hid input probe\n");
1394 return NULL;
1397 input_set_drvdata(input_dev, hid);
1398 input_dev->event = hidinput_input_event;
1399 input_dev->open = hidinput_open;
1400 input_dev->close = hidinput_close;
1401 input_dev->setkeycode = hidinput_setkeycode;
1402 input_dev->getkeycode = hidinput_getkeycode;
1404 input_dev->name = hid->name;
1405 input_dev->phys = hid->phys;
1406 input_dev->uniq = hid->uniq;
1407 input_dev->id.bustype = hid->bus;
1408 input_dev->id.vendor = hid->vendor;
1409 input_dev->id.product = hid->product;
1410 input_dev->id.version = hid->version;
1411 input_dev->dev.parent = &hid->dev;
1412 hidinput->input = input_dev;
1413 list_add_tail(&hidinput->list, &hid->inputs);
1415 return hidinput;
1418 static bool hidinput_has_been_populated(struct hid_input *hidinput)
1420 int i;
1421 unsigned long r = 0;
1423 for (i = 0; i < BITS_TO_LONGS(EV_CNT); i++)
1424 r |= hidinput->input->evbit[i];
1426 for (i = 0; i < BITS_TO_LONGS(KEY_CNT); i++)
1427 r |= hidinput->input->keybit[i];
1429 for (i = 0; i < BITS_TO_LONGS(REL_CNT); i++)
1430 r |= hidinput->input->relbit[i];
1432 for (i = 0; i < BITS_TO_LONGS(ABS_CNT); i++)
1433 r |= hidinput->input->absbit[i];
1435 for (i = 0; i < BITS_TO_LONGS(MSC_CNT); i++)
1436 r |= hidinput->input->mscbit[i];
1438 for (i = 0; i < BITS_TO_LONGS(LED_CNT); i++)
1439 r |= hidinput->input->ledbit[i];
1441 for (i = 0; i < BITS_TO_LONGS(SND_CNT); i++)
1442 r |= hidinput->input->sndbit[i];
1444 for (i = 0; i < BITS_TO_LONGS(FF_CNT); i++)
1445 r |= hidinput->input->ffbit[i];
1447 for (i = 0; i < BITS_TO_LONGS(SW_CNT); i++)
1448 r |= hidinput->input->swbit[i];
1450 return !!r;
1453 static void hidinput_cleanup_hidinput(struct hid_device *hid,
1454 struct hid_input *hidinput)
1456 struct hid_report *report;
1457 int i, k;
1459 list_del(&hidinput->list);
1460 input_free_device(hidinput->input);
1462 for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
1463 if (k == HID_OUTPUT_REPORT &&
1464 hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
1465 continue;
1467 list_for_each_entry(report, &hid->report_enum[k].report_list,
1468 list) {
1470 for (i = 0; i < report->maxfield; i++)
1471 if (report->field[i]->hidinput == hidinput)
1472 report->field[i]->hidinput = NULL;
1476 kfree(hidinput);
1480 * Register the input device; print a message.
1481 * Configure the input layer interface
1482 * Read all reports and initialize the absolute field values.
1485 int hidinput_connect(struct hid_device *hid, unsigned int force)
1487 struct hid_driver *drv = hid->driver;
1488 struct hid_report *report;
1489 struct hid_input *hidinput = NULL;
1490 int i, j, k;
1492 INIT_LIST_HEAD(&hid->inputs);
1493 INIT_WORK(&hid->led_work, hidinput_led_worker);
1495 if (!force) {
1496 for (i = 0; i < hid->maxcollection; i++) {
1497 struct hid_collection *col = &hid->collection[i];
1498 if (col->type == HID_COLLECTION_APPLICATION ||
1499 col->type == HID_COLLECTION_PHYSICAL)
1500 if (IS_INPUT_APPLICATION(col->usage))
1501 break;
1504 if (i == hid->maxcollection)
1505 return -1;
1508 report_features(hid);
1510 for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
1511 if (k == HID_OUTPUT_REPORT &&
1512 hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
1513 continue;
1515 list_for_each_entry(report, &hid->report_enum[k].report_list, list) {
1517 if (!report->maxfield)
1518 continue;
1520 if (!hidinput) {
1521 hidinput = hidinput_allocate(hid);
1522 if (!hidinput)
1523 goto out_unwind;
1526 for (i = 0; i < report->maxfield; i++)
1527 for (j = 0; j < report->field[i]->maxusage; j++)
1528 hidinput_configure_usage(hidinput, report->field[i],
1529 report->field[i]->usage + j);
1531 if ((hid->quirks & HID_QUIRK_NO_EMPTY_INPUT) &&
1532 !hidinput_has_been_populated(hidinput))
1533 continue;
1535 if (hid->quirks & HID_QUIRK_MULTI_INPUT) {
1536 /* This will leave hidinput NULL, so that it
1537 * allocates another one if we have more inputs on
1538 * the same interface. Some devices (e.g. Happ's
1539 * UGCI) cram a lot of unrelated inputs into the
1540 * same interface. */
1541 hidinput->report = report;
1542 if (drv->input_configured &&
1543 drv->input_configured(hid, hidinput))
1544 goto out_cleanup;
1545 if (input_register_device(hidinput->input))
1546 goto out_cleanup;
1547 hidinput = NULL;
1552 if (hidinput && (hid->quirks & HID_QUIRK_NO_EMPTY_INPUT) &&
1553 !hidinput_has_been_populated(hidinput)) {
1554 /* no need to register an input device not populated */
1555 hidinput_cleanup_hidinput(hid, hidinput);
1556 hidinput = NULL;
1559 if (list_empty(&hid->inputs)) {
1560 hid_err(hid, "No inputs registered, leaving\n");
1561 goto out_unwind;
1564 if (hidinput) {
1565 if (drv->input_configured &&
1566 drv->input_configured(hid, hidinput))
1567 goto out_cleanup;
1568 if (input_register_device(hidinput->input))
1569 goto out_cleanup;
1572 return 0;
1574 out_cleanup:
1575 list_del(&hidinput->list);
1576 input_free_device(hidinput->input);
1577 kfree(hidinput);
1578 out_unwind:
1579 /* unwind the ones we already registered */
1580 hidinput_disconnect(hid);
1582 return -1;
1584 EXPORT_SYMBOL_GPL(hidinput_connect);
1586 void hidinput_disconnect(struct hid_device *hid)
1588 struct hid_input *hidinput, *next;
1590 hidinput_cleanup_battery(hid);
1592 list_for_each_entry_safe(hidinput, next, &hid->inputs, list) {
1593 list_del(&hidinput->list);
1594 input_unregister_device(hidinput->input);
1595 kfree(hidinput);
1598 /* led_work is spawned by input_dev callbacks, but doesn't access the
1599 * parent input_dev at all. Once all input devices are removed, we
1600 * know that led_work will never get restarted, so we can cancel it
1601 * synchronously and are safe. */
1602 cancel_work_sync(&hid->led_work);
1604 EXPORT_SYMBOL_GPL(hidinput_disconnect);