2 * Copyright (c) 2000-2001 Vojtech Pavlik
3 * Copyright (c) 2006-2010 Jiri Kosina
5 * HID to Linux Input mapping
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>
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
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, \
70 #define map_key_clear(c) hid_map_usage_clear(hidinput, usage, &bit, \
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,
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)) {
114 *usage_idx = cur_idx;
126 static struct hid_usage *hidinput_locate_usage(struct hid_device *hid,
127 const struct input_keymap_entry *ke,
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);
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);
152 ke->keycode = usage->type == EV_KEY ?
153 usage->code : KEY_RESERVED;
155 scancode = usage->hid & (HID_USAGE_PAGE | HID_USAGE);
156 ke->len = sizeof(scancode);
157 memcpy(ke->scancode, &scancode, sizeof(scancode));
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);
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
186 if (hidinput_find_key(hid, match_keycode, *old_keycode, NULL))
187 set_bit(*old_keycode, dev->keybit);
197 * hidinput_calc_abs_res - calculate an absolute axis resolution
198 * @field: the HID report field to calculate resolution for
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;
220 /* Check if the extents are sane */
221 if (logical_extents <= 0 || physical_extents <= 0)
225 * Verify and convert units.
226 * See HID specification v1.11 6.2.2.7 Global Items for unit decoding
232 case ABS_MT_POSITION_X:
233 case ABS_MT_POSITION_Y:
236 case ABS_MT_TOUCH_MAJOR:
237 case ABS_MT_TOUCH_MINOR:
238 if (field->unit == 0x11) { /* If centimeters */
239 /* Convert to millimeters */
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)
259 if (field->unit == 0x14) { /* If degrees */
260 /* Convert to radians */
261 prev = logical_extents;
262 logical_extents *= 573;
263 if (logical_extents < prev)
266 } else if (field->unit != 0x12) { /* If not radians */
275 /* Apply negative unit exponent */
276 for (; unit_exponent < 0; unit_exponent++) {
277 prev = logical_extents;
278 logical_extents *= 10;
279 if (logical_extents < prev)
282 /* Apply positive unit exponent */
283 for (; unit_exponent > 0; unit_exponent--) {
284 prev = physical_extents;
285 physical_extents *= 10;
286 if (physical_extents < prev)
290 /* Calculate resolution */
291 return DIV_ROUND_CLOSEST(logical_extents, physical_extents);
293 EXPORT_SYMBOL_GPL(hidinput_calc_abs_res);
295 #ifdef CONFIG_HID_BATTERY_STRENGTH
296 static enum power_supply_property hidinput_battery_props[] = {
297 POWER_SUPPLY_PROP_PRESENT,
298 POWER_SUPPLY_PROP_ONLINE,
299 POWER_SUPPLY_PROP_CAPACITY,
300 POWER_SUPPLY_PROP_MODEL_NAME,
301 POWER_SUPPLY_PROP_STATUS,
302 POWER_SUPPLY_PROP_SCOPE,
305 #define HID_BATTERY_QUIRK_PERCENT (1 << 0) /* always reports percent */
306 #define HID_BATTERY_QUIRK_FEATURE (1 << 1) /* ask for feature report */
307 #define HID_BATTERY_QUIRK_IGNORE (1 << 2) /* completely ignore the battery */
309 static const struct hid_device_id hid_battery_quirks[] = {
310 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
311 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO),
312 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
313 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
314 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI),
315 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
316 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
317 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ANSI),
318 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
319 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
320 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ISO),
321 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
322 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
323 USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI),
324 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
325 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_ELECOM,
326 USB_DEVICE_ID_ELECOM_BM084),
327 HID_BATTERY_QUIRK_IGNORE },
328 { HID_USB_DEVICE(USB_VENDOR_ID_SYMBOL,
329 USB_DEVICE_ID_SYMBOL_SCANNER_3),
330 HID_BATTERY_QUIRK_IGNORE },
334 static unsigned find_battery_quirk(struct hid_device *hdev)
337 const struct hid_device_id *match;
339 match = hid_match_id(hdev, hid_battery_quirks);
341 quirks = match->driver_data;
346 static int hidinput_scale_battery_capacity(struct hid_device *dev,
349 if (dev->battery_min < dev->battery_max &&
350 value >= dev->battery_min && value <= dev->battery_max)
351 value = ((value - dev->battery_min) * 100) /
352 (dev->battery_max - dev->battery_min);
357 static int hidinput_query_battery_capacity(struct hid_device *dev)
362 buf = kmalloc(2, GFP_KERNEL);
366 ret = hid_hw_raw_request(dev, dev->battery_report_id, buf, 2,
367 dev->battery_report_type, HID_REQ_GET_REPORT);
373 ret = hidinput_scale_battery_capacity(dev, buf[1]);
378 static int hidinput_get_battery_property(struct power_supply *psy,
379 enum power_supply_property prop,
380 union power_supply_propval *val)
382 struct hid_device *dev = power_supply_get_drvdata(psy);
387 case POWER_SUPPLY_PROP_PRESENT:
388 case POWER_SUPPLY_PROP_ONLINE:
392 case POWER_SUPPLY_PROP_CAPACITY:
393 if (dev->battery_status != HID_BATTERY_REPORTED &&
394 !dev->battery_avoid_query) {
395 value = hidinput_query_battery_capacity(dev);
399 value = dev->battery_capacity;
405 case POWER_SUPPLY_PROP_MODEL_NAME:
406 val->strval = dev->name;
409 case POWER_SUPPLY_PROP_STATUS:
410 if (dev->battery_status != HID_BATTERY_REPORTED &&
411 !dev->battery_avoid_query) {
412 value = hidinput_query_battery_capacity(dev);
416 dev->battery_capacity = value;
417 dev->battery_status = HID_BATTERY_QUERIED;
420 if (dev->battery_status == HID_BATTERY_UNKNOWN)
421 val->intval = POWER_SUPPLY_STATUS_UNKNOWN;
422 else if (dev->battery_capacity == 100)
423 val->intval = POWER_SUPPLY_STATUS_FULL;
425 val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
428 case POWER_SUPPLY_PROP_SCOPE:
429 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
440 static int hidinput_setup_battery(struct hid_device *dev, unsigned report_type, struct hid_field *field)
442 struct power_supply_desc *psy_desc;
443 struct power_supply_config psy_cfg = { .drv_data = dev, };
449 return 0; /* already initialized? */
451 quirks = find_battery_quirk(dev);
453 hid_dbg(dev, "device %x:%x:%x %d quirks %d\n",
454 dev->bus, dev->vendor, dev->product, dev->version, quirks);
456 if (quirks & HID_BATTERY_QUIRK_IGNORE)
459 psy_desc = kzalloc(sizeof(*psy_desc), GFP_KERNEL);
463 psy_desc->name = kasprintf(GFP_KERNEL, "hid-%s-battery",
465 dev->uniq : dev_name(&dev->dev));
466 if (!psy_desc->name) {
471 psy_desc->type = POWER_SUPPLY_TYPE_BATTERY;
472 psy_desc->properties = hidinput_battery_props;
473 psy_desc->num_properties = ARRAY_SIZE(hidinput_battery_props);
474 psy_desc->use_for_apm = 0;
475 psy_desc->get_property = hidinput_get_battery_property;
477 min = field->logical_minimum;
478 max = field->logical_maximum;
480 if (quirks & HID_BATTERY_QUIRK_PERCENT) {
485 if (quirks & HID_BATTERY_QUIRK_FEATURE)
486 report_type = HID_FEATURE_REPORT;
488 dev->battery_min = min;
489 dev->battery_max = max;
490 dev->battery_report_type = report_type;
491 dev->battery_report_id = field->report->id;
494 * Stylus is normally not connected to the device and thus we
495 * can't query the device and get meaningful battery strength.
496 * We have to wait for the device to report it on its own.
498 dev->battery_avoid_query = report_type == HID_INPUT_REPORT &&
499 field->physical == HID_DG_STYLUS;
501 dev->battery = power_supply_register(&dev->dev, psy_desc, &psy_cfg);
502 if (IS_ERR(dev->battery)) {
503 error = PTR_ERR(dev->battery);
504 hid_warn(dev, "can't register power supply: %d\n", error);
508 power_supply_powers(dev->battery, &dev->dev);
512 kfree(psy_desc->name);
519 static void hidinput_cleanup_battery(struct hid_device *dev)
521 const struct power_supply_desc *psy_desc;
526 psy_desc = dev->battery->desc;
527 power_supply_unregister(dev->battery);
528 kfree(psy_desc->name);
533 static void hidinput_update_battery(struct hid_device *dev, int value)
540 if (value == 0 || value < dev->battery_min || value > dev->battery_max)
543 capacity = hidinput_scale_battery_capacity(dev, value);
545 if (dev->battery_status != HID_BATTERY_REPORTED ||
546 capacity != dev->battery_capacity) {
547 dev->battery_capacity = capacity;
548 dev->battery_status = HID_BATTERY_REPORTED;
549 power_supply_changed(dev->battery);
552 #else /* !CONFIG_HID_BATTERY_STRENGTH */
553 static int hidinput_setup_battery(struct hid_device *dev, unsigned report_type,
554 struct hid_field *field)
559 static void hidinput_cleanup_battery(struct hid_device *dev)
563 static void hidinput_update_battery(struct hid_device *dev, int value)
566 #endif /* CONFIG_HID_BATTERY_STRENGTH */
568 static void hidinput_configure_usage(struct hid_input *hidinput, struct hid_field *field,
569 struct hid_usage *usage)
571 struct input_dev *input = hidinput->input;
572 struct hid_device *device = input_get_drvdata(input);
574 unsigned long *bit = NULL;
576 field->hidinput = hidinput;
578 if (field->flags & HID_MAIN_ITEM_CONSTANT)
581 /* Ignore if report count is out of bounds. */
582 if (field->report_count < 1)
585 /* only LED usages are supported in output fields */
586 if (field->report_type == HID_OUTPUT_REPORT &&
587 (usage->hid & HID_USAGE_PAGE) != HID_UP_LED) {
591 if (device->driver->input_mapping) {
592 int ret = device->driver->input_mapping(device, hidinput, field,
600 switch (usage->hid & HID_USAGE_PAGE) {
601 case HID_UP_UNDEFINED:
604 case HID_UP_KEYBOARD:
605 set_bit(EV_REP, input->evbit);
607 if ((usage->hid & HID_USAGE) < 256) {
608 if (!hid_keyboard[usage->hid & HID_USAGE]) goto ignore;
609 map_key_clear(hid_keyboard[usage->hid & HID_USAGE]);
611 map_key(KEY_UNKNOWN);
616 code = ((usage->hid - 1) & HID_USAGE);
618 switch (field->application) {
620 case HID_GD_POINTER: code += BTN_MOUSE; break;
621 case HID_GD_JOYSTICK:
623 code += BTN_JOYSTICK;
625 code += BTN_TRIGGER_HAPPY - 0x10;
631 code += BTN_TRIGGER_HAPPY - 0x10;
634 switch (field->physical) {
636 case HID_GD_POINTER: code += BTN_MOUSE; break;
637 case HID_GD_JOYSTICK: code += BTN_JOYSTICK; break;
638 case HID_GD_GAMEPAD: code += BTN_GAMEPAD; break;
639 default: code += BTN_MISC;
646 case HID_UP_SIMULATION:
647 switch (usage->hid & 0xffff) {
648 case 0xba: map_abs(ABS_RUDDER); break;
649 case 0xbb: map_abs(ABS_THROTTLE); break;
650 case 0xc4: map_abs(ABS_GAS); break;
651 case 0xc5: map_abs(ABS_BRAKE); break;
652 case 0xc8: map_abs(ABS_WHEEL); break;
653 default: goto ignore;
658 if ((usage->hid & 0xf0) == 0x80) { /* SystemControl */
659 switch (usage->hid & 0xf) {
660 case 0x1: map_key_clear(KEY_POWER); break;
661 case 0x2: map_key_clear(KEY_SLEEP); break;
662 case 0x3: map_key_clear(KEY_WAKEUP); break;
663 case 0x4: map_key_clear(KEY_CONTEXT_MENU); break;
664 case 0x5: map_key_clear(KEY_MENU); break;
665 case 0x6: map_key_clear(KEY_PROG1); break;
666 case 0x7: map_key_clear(KEY_HELP); break;
667 case 0x8: map_key_clear(KEY_EXIT); break;
668 case 0x9: map_key_clear(KEY_SELECT); break;
669 case 0xa: map_key_clear(KEY_RIGHT); break;
670 case 0xb: map_key_clear(KEY_LEFT); break;
671 case 0xc: map_key_clear(KEY_UP); break;
672 case 0xd: map_key_clear(KEY_DOWN); break;
673 case 0xe: map_key_clear(KEY_POWER2); break;
674 case 0xf: map_key_clear(KEY_RESTART); break;
675 default: goto unknown;
681 * Some lazy vendors declare 255 usages for System Control,
682 * leading to the creation of ABS_X|Y axis and too many others.
683 * It wouldn't be a problem if joydev doesn't consider the
684 * device as a joystick then.
686 if (field->application == HID_GD_SYSTEM_CONTROL)
689 if ((usage->hid & 0xf0) == 0x90) { /* D-pad */
690 switch (usage->hid) {
691 case HID_GD_UP: usage->hat_dir = 1; break;
692 case HID_GD_DOWN: usage->hat_dir = 5; break;
693 case HID_GD_RIGHT: usage->hat_dir = 3; break;
694 case HID_GD_LEFT: usage->hat_dir = 7; break;
695 default: goto unknown;
698 map_abs(field->dpad);
705 switch (usage->hid) {
706 /* These usage IDs map directly to the usage codes. */
707 case HID_GD_X: case HID_GD_Y: case HID_GD_Z:
708 case HID_GD_RX: case HID_GD_RY: case HID_GD_RZ:
709 if (field->flags & HID_MAIN_ITEM_RELATIVE)
710 map_rel(usage->hid & 0xf);
712 map_abs_clear(usage->hid & 0xf);
716 if (field->flags & HID_MAIN_ITEM_RELATIVE) {
717 set_bit(REL_WHEEL, input->relbit);
718 map_rel(REL_WHEEL_HI_RES);
720 map_abs(usage->hid & 0xf);
723 case HID_GD_SLIDER: case HID_GD_DIAL:
724 if (field->flags & HID_MAIN_ITEM_RELATIVE)
725 map_rel(usage->hid & 0xf);
727 map_abs(usage->hid & 0xf);
730 case HID_GD_HATSWITCH:
731 usage->hat_min = field->logical_minimum;
732 usage->hat_max = field->logical_maximum;
736 case HID_GD_START: map_key_clear(BTN_START); break;
737 case HID_GD_SELECT: map_key_clear(BTN_SELECT); break;
739 case HID_GD_RFKILL_BTN:
740 /* MS wireless radio ctl extension, also check CA */
741 if (field->application == HID_GD_WIRELESS_RADIO_CTLS) {
742 map_key_clear(KEY_RFKILL);
743 /* We need to simulate the btn release */
744 field->flags |= HID_MAIN_ITEM_RELATIVE;
748 default: goto unknown;
754 switch (usage->hid & 0xffff) { /* HID-Value: */
755 case 0x01: map_led (LED_NUML); break; /* "Num Lock" */
756 case 0x02: map_led (LED_CAPSL); break; /* "Caps Lock" */
757 case 0x03: map_led (LED_SCROLLL); break; /* "Scroll Lock" */
758 case 0x04: map_led (LED_COMPOSE); break; /* "Compose" */
759 case 0x05: map_led (LED_KANA); break; /* "Kana" */
760 case 0x27: map_led (LED_SLEEP); break; /* "Stand-By" */
761 case 0x4c: map_led (LED_SUSPEND); break; /* "System Suspend" */
762 case 0x09: map_led (LED_MUTE); break; /* "Mute" */
763 case 0x4b: map_led (LED_MISC); break; /* "Generic Indicator" */
764 case 0x19: map_led (LED_MAIL); break; /* "Message Waiting" */
765 case 0x4d: map_led (LED_CHARGING); break; /* "External Power Connected" */
767 default: goto ignore;
771 case HID_UP_DIGITIZER:
772 if ((field->application & 0xff) == 0x01) /* Digitizer */
773 __set_bit(INPUT_PROP_POINTER, input->propbit);
774 else if ((field->application & 0xff) == 0x02) /* Pen */
775 __set_bit(INPUT_PROP_DIRECT, input->propbit);
777 switch (usage->hid & 0xff) {
778 case 0x00: /* Undefined */
781 case 0x30: /* TipPressure */
782 if (!test_bit(BTN_TOUCH, input->keybit)) {
783 device->quirks |= HID_QUIRK_NOTOUCH;
784 set_bit(EV_KEY, input->evbit);
785 set_bit(BTN_TOUCH, input->keybit);
787 map_abs_clear(ABS_PRESSURE);
790 case 0x32: /* InRange */
791 switch (field->physical & 0xff) {
792 case 0x21: map_key(BTN_TOOL_MOUSE); break;
793 case 0x22: map_key(BTN_TOOL_FINGER); break;
794 default: map_key(BTN_TOOL_PEN); break;
798 case 0x3b: /* Battery Strength */
799 hidinput_setup_battery(device, HID_INPUT_REPORT, field);
800 usage->type = EV_PWR;
803 case 0x3c: /* Invert */
804 map_key_clear(BTN_TOOL_RUBBER);
807 case 0x3d: /* X Tilt */
808 map_abs_clear(ABS_TILT_X);
811 case 0x3e: /* Y Tilt */
812 map_abs_clear(ABS_TILT_Y);
815 case 0x33: /* Touch */
816 case 0x42: /* TipSwitch */
817 case 0x43: /* TipSwitch2 */
818 device->quirks &= ~HID_QUIRK_NOTOUCH;
819 map_key_clear(BTN_TOUCH);
822 case 0x44: /* BarrelSwitch */
823 map_key_clear(BTN_STYLUS);
826 case 0x45: /* ERASER */
828 * This event is reported when eraser tip touches the surface.
829 * Actual eraser (BTN_TOOL_RUBBER) is set by Invert usage when
830 * tool gets in proximity.
832 map_key_clear(BTN_TOUCH);
835 case 0x46: /* TabletPick */
836 case 0x5a: /* SecondaryBarrelSwitch */
837 map_key_clear(BTN_STYLUS2);
840 case 0x5b: /* TransducerSerialNumber */
841 usage->type = EV_MSC;
842 usage->code = MSC_SERIAL;
847 default: goto unknown;
851 case HID_UP_TELEPHONY:
852 switch (usage->hid & HID_USAGE) {
853 case 0x2f: map_key_clear(KEY_MICMUTE); break;
854 case 0xb0: map_key_clear(KEY_NUMERIC_0); break;
855 case 0xb1: map_key_clear(KEY_NUMERIC_1); break;
856 case 0xb2: map_key_clear(KEY_NUMERIC_2); break;
857 case 0xb3: map_key_clear(KEY_NUMERIC_3); break;
858 case 0xb4: map_key_clear(KEY_NUMERIC_4); break;
859 case 0xb5: map_key_clear(KEY_NUMERIC_5); break;
860 case 0xb6: map_key_clear(KEY_NUMERIC_6); break;
861 case 0xb7: map_key_clear(KEY_NUMERIC_7); break;
862 case 0xb8: map_key_clear(KEY_NUMERIC_8); break;
863 case 0xb9: map_key_clear(KEY_NUMERIC_9); break;
864 case 0xba: map_key_clear(KEY_NUMERIC_STAR); break;
865 case 0xbb: map_key_clear(KEY_NUMERIC_POUND); break;
866 case 0xbc: map_key_clear(KEY_NUMERIC_A); break;
867 case 0xbd: map_key_clear(KEY_NUMERIC_B); break;
868 case 0xbe: map_key_clear(KEY_NUMERIC_C); break;
869 case 0xbf: map_key_clear(KEY_NUMERIC_D); break;
870 default: goto ignore;
874 case HID_UP_CONSUMER: /* USB HUT v1.12, pages 75-84 */
875 switch (usage->hid & HID_USAGE) {
876 case 0x000: goto ignore;
877 case 0x030: map_key_clear(KEY_POWER); break;
878 case 0x031: map_key_clear(KEY_RESTART); break;
879 case 0x032: map_key_clear(KEY_SLEEP); break;
880 case 0x034: map_key_clear(KEY_SLEEP); break;
881 case 0x035: map_key_clear(KEY_KBDILLUMTOGGLE); break;
882 case 0x036: map_key_clear(BTN_MISC); break;
884 case 0x040: map_key_clear(KEY_MENU); break; /* Menu */
885 case 0x041: map_key_clear(KEY_SELECT); break; /* Menu Pick */
886 case 0x042: map_key_clear(KEY_UP); break; /* Menu Up */
887 case 0x043: map_key_clear(KEY_DOWN); break; /* Menu Down */
888 case 0x044: map_key_clear(KEY_LEFT); break; /* Menu Left */
889 case 0x045: map_key_clear(KEY_RIGHT); break; /* Menu Right */
890 case 0x046: map_key_clear(KEY_ESC); break; /* Menu Escape */
891 case 0x047: map_key_clear(KEY_KPPLUS); break; /* Menu Value Increase */
892 case 0x048: map_key_clear(KEY_KPMINUS); break; /* Menu Value Decrease */
894 case 0x060: map_key_clear(KEY_INFO); break; /* Data On Screen */
895 case 0x061: map_key_clear(KEY_SUBTITLE); break; /* Closed Caption */
896 case 0x063: map_key_clear(KEY_VCR); break; /* VCR/TV */
897 case 0x065: map_key_clear(KEY_CAMERA); break; /* Snapshot */
898 case 0x069: map_key_clear(KEY_RED); break;
899 case 0x06a: map_key_clear(KEY_GREEN); break;
900 case 0x06b: map_key_clear(KEY_BLUE); break;
901 case 0x06c: map_key_clear(KEY_YELLOW); break;
902 case 0x06d: map_key_clear(KEY_ZOOM); break;
904 case 0x06f: map_key_clear(KEY_BRIGHTNESSUP); break;
905 case 0x070: map_key_clear(KEY_BRIGHTNESSDOWN); break;
906 case 0x072: map_key_clear(KEY_BRIGHTNESS_TOGGLE); break;
907 case 0x073: map_key_clear(KEY_BRIGHTNESS_MIN); break;
908 case 0x074: map_key_clear(KEY_BRIGHTNESS_MAX); break;
909 case 0x075: map_key_clear(KEY_BRIGHTNESS_AUTO); break;
911 case 0x082: map_key_clear(KEY_VIDEO_NEXT); break;
912 case 0x083: map_key_clear(KEY_LAST); break;
913 case 0x084: map_key_clear(KEY_ENTER); break;
914 case 0x088: map_key_clear(KEY_PC); break;
915 case 0x089: map_key_clear(KEY_TV); break;
916 case 0x08a: map_key_clear(KEY_WWW); break;
917 case 0x08b: map_key_clear(KEY_DVD); break;
918 case 0x08c: map_key_clear(KEY_PHONE); break;
919 case 0x08d: map_key_clear(KEY_PROGRAM); break;
920 case 0x08e: map_key_clear(KEY_VIDEOPHONE); break;
921 case 0x08f: map_key_clear(KEY_GAMES); break;
922 case 0x090: map_key_clear(KEY_MEMO); break;
923 case 0x091: map_key_clear(KEY_CD); break;
924 case 0x092: map_key_clear(KEY_VCR); break;
925 case 0x093: map_key_clear(KEY_TUNER); break;
926 case 0x094: map_key_clear(KEY_EXIT); break;
927 case 0x095: map_key_clear(KEY_HELP); break;
928 case 0x096: map_key_clear(KEY_TAPE); break;
929 case 0x097: map_key_clear(KEY_TV2); break;
930 case 0x098: map_key_clear(KEY_SAT); break;
931 case 0x09a: map_key_clear(KEY_PVR); break;
933 case 0x09c: map_key_clear(KEY_CHANNELUP); break;
934 case 0x09d: map_key_clear(KEY_CHANNELDOWN); break;
935 case 0x0a0: map_key_clear(KEY_VCR2); break;
937 case 0x0b0: map_key_clear(KEY_PLAY); break;
938 case 0x0b1: map_key_clear(KEY_PAUSE); break;
939 case 0x0b2: map_key_clear(KEY_RECORD); break;
940 case 0x0b3: map_key_clear(KEY_FASTFORWARD); break;
941 case 0x0b4: map_key_clear(KEY_REWIND); break;
942 case 0x0b5: map_key_clear(KEY_NEXTSONG); break;
943 case 0x0b6: map_key_clear(KEY_PREVIOUSSONG); break;
944 case 0x0b7: map_key_clear(KEY_STOPCD); break;
945 case 0x0b8: map_key_clear(KEY_EJECTCD); break;
946 case 0x0bc: map_key_clear(KEY_MEDIA_REPEAT); break;
947 case 0x0b9: map_key_clear(KEY_SHUFFLE); break;
948 case 0x0bf: map_key_clear(KEY_SLOW); break;
950 case 0x0cd: map_key_clear(KEY_PLAYPAUSE); break;
951 case 0x0cf: map_key_clear(KEY_VOICECOMMAND); break;
952 case 0x0e0: map_abs_clear(ABS_VOLUME); break;
953 case 0x0e2: map_key_clear(KEY_MUTE); break;
954 case 0x0e5: map_key_clear(KEY_BASSBOOST); break;
955 case 0x0e9: map_key_clear(KEY_VOLUMEUP); break;
956 case 0x0ea: map_key_clear(KEY_VOLUMEDOWN); break;
957 case 0x0f5: map_key_clear(KEY_SLOW); break;
959 case 0x181: map_key_clear(KEY_BUTTONCONFIG); break;
960 case 0x182: map_key_clear(KEY_BOOKMARKS); break;
961 case 0x183: map_key_clear(KEY_CONFIG); break;
962 case 0x184: map_key_clear(KEY_WORDPROCESSOR); break;
963 case 0x185: map_key_clear(KEY_EDITOR); break;
964 case 0x186: map_key_clear(KEY_SPREADSHEET); break;
965 case 0x187: map_key_clear(KEY_GRAPHICSEDITOR); break;
966 case 0x188: map_key_clear(KEY_PRESENTATION); break;
967 case 0x189: map_key_clear(KEY_DATABASE); break;
968 case 0x18a: map_key_clear(KEY_MAIL); break;
969 case 0x18b: map_key_clear(KEY_NEWS); break;
970 case 0x18c: map_key_clear(KEY_VOICEMAIL); break;
971 case 0x18d: map_key_clear(KEY_ADDRESSBOOK); break;
972 case 0x18e: map_key_clear(KEY_CALENDAR); break;
973 case 0x18f: map_key_clear(KEY_TASKMANAGER); break;
974 case 0x190: map_key_clear(KEY_JOURNAL); break;
975 case 0x191: map_key_clear(KEY_FINANCE); break;
976 case 0x192: map_key_clear(KEY_CALC); break;
977 case 0x193: map_key_clear(KEY_PLAYER); break;
978 case 0x194: map_key_clear(KEY_FILE); break;
979 case 0x196: map_key_clear(KEY_WWW); break;
980 case 0x199: map_key_clear(KEY_CHAT); break;
981 case 0x19c: map_key_clear(KEY_LOGOFF); break;
982 case 0x19e: map_key_clear(KEY_COFFEE); break;
983 case 0x19f: map_key_clear(KEY_CONTROLPANEL); break;
984 case 0x1a2: map_key_clear(KEY_APPSELECT); break;
985 case 0x1a3: map_key_clear(KEY_NEXT); break;
986 case 0x1a4: map_key_clear(KEY_PREVIOUS); break;
987 case 0x1a6: map_key_clear(KEY_HELP); break;
988 case 0x1a7: map_key_clear(KEY_DOCUMENTS); break;
989 case 0x1ab: map_key_clear(KEY_SPELLCHECK); break;
990 case 0x1ae: map_key_clear(KEY_KEYBOARD); break;
991 case 0x1b1: map_key_clear(KEY_SCREENSAVER); break;
992 case 0x1b4: map_key_clear(KEY_FILE); break;
993 case 0x1b6: map_key_clear(KEY_IMAGES); break;
994 case 0x1b7: map_key_clear(KEY_AUDIO); break;
995 case 0x1b8: map_key_clear(KEY_VIDEO); break;
996 case 0x1bc: map_key_clear(KEY_MESSENGER); break;
997 case 0x1bd: map_key_clear(KEY_INFO); break;
998 case 0x201: map_key_clear(KEY_NEW); break;
999 case 0x202: map_key_clear(KEY_OPEN); break;
1000 case 0x203: map_key_clear(KEY_CLOSE); break;
1001 case 0x204: map_key_clear(KEY_EXIT); break;
1002 case 0x207: map_key_clear(KEY_SAVE); break;
1003 case 0x208: map_key_clear(KEY_PRINT); break;
1004 case 0x209: map_key_clear(KEY_PROPS); break;
1005 case 0x21a: map_key_clear(KEY_UNDO); break;
1006 case 0x21b: map_key_clear(KEY_COPY); break;
1007 case 0x21c: map_key_clear(KEY_CUT); break;
1008 case 0x21d: map_key_clear(KEY_PASTE); break;
1009 case 0x21f: map_key_clear(KEY_FIND); break;
1010 case 0x221: map_key_clear(KEY_SEARCH); break;
1011 case 0x222: map_key_clear(KEY_GOTO); break;
1012 case 0x223: map_key_clear(KEY_HOMEPAGE); break;
1013 case 0x224: map_key_clear(KEY_BACK); break;
1014 case 0x225: map_key_clear(KEY_FORWARD); break;
1015 case 0x226: map_key_clear(KEY_STOP); break;
1016 case 0x227: map_key_clear(KEY_REFRESH); break;
1017 case 0x22a: map_key_clear(KEY_BOOKMARKS); break;
1018 case 0x22d: map_key_clear(KEY_ZOOMIN); break;
1019 case 0x22e: map_key_clear(KEY_ZOOMOUT); break;
1020 case 0x22f: map_key_clear(KEY_ZOOMRESET); break;
1021 case 0x233: map_key_clear(KEY_SCROLLUP); break;
1022 case 0x234: map_key_clear(KEY_SCROLLDOWN); break;
1023 case 0x238: /* AC Pan */
1024 set_bit(REL_HWHEEL, input->relbit);
1025 map_rel(REL_HWHEEL_HI_RES);
1027 case 0x23d: map_key_clear(KEY_EDIT); break;
1028 case 0x25f: map_key_clear(KEY_CANCEL); break;
1029 case 0x269: map_key_clear(KEY_INSERT); break;
1030 case 0x26a: map_key_clear(KEY_DELETE); break;
1031 case 0x279: map_key_clear(KEY_REDO); break;
1033 case 0x289: map_key_clear(KEY_REPLY); break;
1034 case 0x28b: map_key_clear(KEY_FORWARDMAIL); break;
1035 case 0x28c: map_key_clear(KEY_SEND); break;
1037 case 0x2c7: map_key_clear(KEY_KBDINPUTASSIST_PREV); break;
1038 case 0x2c8: map_key_clear(KEY_KBDINPUTASSIST_NEXT); break;
1039 case 0x2c9: map_key_clear(KEY_KBDINPUTASSIST_PREVGROUP); break;
1040 case 0x2ca: map_key_clear(KEY_KBDINPUTASSIST_NEXTGROUP); break;
1041 case 0x2cb: map_key_clear(KEY_KBDINPUTASSIST_ACCEPT); break;
1042 case 0x2cc: map_key_clear(KEY_KBDINPUTASSIST_CANCEL); break;
1044 default: map_key_clear(KEY_UNKNOWN);
1048 case HID_UP_GENDEVCTRLS:
1049 switch (usage->hid) {
1050 case HID_DC_BATTERYSTRENGTH:
1051 hidinput_setup_battery(device, HID_INPUT_REPORT, field);
1052 usage->type = EV_PWR;
1057 case HID_UP_HPVENDOR: /* Reported on a Dutch layout HP5308 */
1058 set_bit(EV_REP, input->evbit);
1059 switch (usage->hid & HID_USAGE) {
1060 case 0x021: map_key_clear(KEY_PRINT); break;
1061 case 0x070: map_key_clear(KEY_HP); break;
1062 case 0x071: map_key_clear(KEY_CAMERA); break;
1063 case 0x072: map_key_clear(KEY_SOUND); break;
1064 case 0x073: map_key_clear(KEY_QUESTION); break;
1065 case 0x080: map_key_clear(KEY_EMAIL); break;
1066 case 0x081: map_key_clear(KEY_CHAT); break;
1067 case 0x082: map_key_clear(KEY_SEARCH); break;
1068 case 0x083: map_key_clear(KEY_CONNECT); break;
1069 case 0x084: map_key_clear(KEY_FINANCE); break;
1070 case 0x085: map_key_clear(KEY_SPORT); break;
1071 case 0x086: map_key_clear(KEY_SHOP); break;
1072 default: goto ignore;
1076 case HID_UP_HPVENDOR2:
1077 set_bit(EV_REP, input->evbit);
1078 switch (usage->hid & HID_USAGE) {
1079 case 0x001: map_key_clear(KEY_MICMUTE); break;
1080 case 0x003: map_key_clear(KEY_BRIGHTNESSDOWN); break;
1081 case 0x004: map_key_clear(KEY_BRIGHTNESSUP); break;
1082 default: goto ignore;
1086 case HID_UP_MSVENDOR:
1089 case HID_UP_CUSTOM: /* Reported on Logitech and Apple USB keyboards */
1090 set_bit(EV_REP, input->evbit);
1093 case HID_UP_LOGIVENDOR:
1094 /* intentional fallback */
1095 case HID_UP_LOGIVENDOR2:
1096 /* intentional fallback */
1097 case HID_UP_LOGIVENDOR3:
1101 switch (usage->hid & HID_USAGE) {
1102 case 0xa4: map_key_clear(BTN_DEAD); break;
1103 default: goto ignore;
1109 if (field->report_size == 1) {
1110 if (field->report->type == HID_OUTPUT_REPORT) {
1117 if (field->flags & HID_MAIN_ITEM_RELATIVE) {
1126 if (device->driver->input_mapped && device->driver->input_mapped(device,
1127 hidinput, field, usage, &bit, &max) < 0)
1130 set_bit(usage->type, input->evbit);
1133 * This part is *really* controversial:
1134 * - HID aims at being generic so we should do our best to export
1135 * all incoming events
1136 * - HID describes what events are, so there is no reason for ABS_X
1137 * to be mapped to ABS_Y
1138 * - HID is using *_MISC+N as a default value, but nothing prevents
1139 * *_MISC+N to overwrite a legitimate even, which confuses userspace
1140 * (for instance ABS_MISC + 7 is ABS_MT_SLOT, which has a different
1143 * If devices still want to use this (at their own risk), they will
1144 * have to use the quirk HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE, but
1145 * the default should be a reliable mapping.
1147 while (usage->code <= max && test_and_set_bit(usage->code, bit)) {
1148 if (device->quirks & HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE) {
1149 usage->code = find_next_zero_bit(bit,
1153 device->status |= HID_STAT_DUP_DETECTED;
1158 if (usage->code > max)
1161 if (usage->type == EV_ABS) {
1163 int a = field->logical_minimum;
1164 int b = field->logical_maximum;
1166 if ((device->quirks & HID_QUIRK_BADPAD) && (usage->code == ABS_X || usage->code == ABS_Y)) {
1167 a = field->logical_minimum = 0;
1168 b = field->logical_maximum = 255;
1171 if (field->application == HID_GD_GAMEPAD || field->application == HID_GD_JOYSTICK)
1172 input_set_abs_params(input, usage->code, a, b, (b - a) >> 8, (b - a) >> 4);
1173 else input_set_abs_params(input, usage->code, a, b, 0, 0);
1175 input_abs_set_res(input, usage->code,
1176 hidinput_calc_abs_res(field, usage->code));
1178 /* use a larger default input buffer for MT devices */
1179 if (usage->code == ABS_MT_POSITION_X && input->hint_events_per_packet == 0)
1180 input_set_events_per_packet(input, 60);
1183 if (usage->type == EV_ABS &&
1184 (usage->hat_min < usage->hat_max || usage->hat_dir)) {
1186 for (i = usage->code; i < usage->code + 2 && i <= max; i++) {
1187 input_set_abs_params(input, i, -1, 1, 0, 0);
1188 set_bit(i, input->absbit);
1190 if (usage->hat_dir && !field->dpad)
1191 field->dpad = usage->code;
1194 /* for those devices which produce Consumer volume usage as relative,
1195 * we emulate pressing volumeup/volumedown appropriate number of times
1196 * in hidinput_hid_event()
1198 if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
1199 (usage->code == ABS_VOLUME)) {
1200 set_bit(KEY_VOLUMEUP, input->keybit);
1201 set_bit(KEY_VOLUMEDOWN, input->keybit);
1204 if (usage->type == EV_KEY) {
1205 set_bit(EV_MSC, input->evbit);
1206 set_bit(MSC_SCAN, input->mscbit);
1214 static void hidinput_handle_scroll(struct hid_usage *usage,
1215 struct input_dev *input,
1224 if (usage->code == REL_WHEEL_HI_RES)
1230 * Windows reports one wheel click as value 120. Where a high-res
1231 * scroll wheel is present, a fraction of 120 is reported instead.
1232 * Our REL_WHEEL_HI_RES axis does the same because all HW must
1233 * adhere to the 120 expectation.
1235 hi_res = value * 120/usage->resolution_multiplier;
1237 usage->wheel_accumulated += hi_res;
1238 lo_res = usage->wheel_accumulated/120;
1240 usage->wheel_accumulated -= lo_res * 120;
1242 input_event(input, EV_REL, code, lo_res);
1243 input_event(input, EV_REL, usage->code, hi_res);
1246 void hidinput_hid_event(struct hid_device *hid, struct hid_field *field, struct hid_usage *usage, __s32 value)
1248 struct input_dev *input;
1249 unsigned *quirks = &hid->quirks;
1254 if (usage->type == EV_PWR) {
1255 hidinput_update_battery(hid, value);
1259 if (!field->hidinput)
1262 input = field->hidinput->input;
1264 if (usage->hat_min < usage->hat_max || usage->hat_dir) {
1265 int hat_dir = usage->hat_dir;
1267 hat_dir = (value - usage->hat_min) * 8 / (usage->hat_max - usage->hat_min + 1) + 1;
1268 if (hat_dir < 0 || hat_dir > 8) hat_dir = 0;
1269 input_event(input, usage->type, usage->code , hid_hat_to_axis[hat_dir].x);
1270 input_event(input, usage->type, usage->code + 1, hid_hat_to_axis[hat_dir].y);
1274 if (usage->hid == (HID_UP_DIGITIZER | 0x003c)) { /* Invert */
1275 *quirks = value ? (*quirks | HID_QUIRK_INVERT) : (*quirks & ~HID_QUIRK_INVERT);
1279 if (usage->hid == (HID_UP_DIGITIZER | 0x0032)) { /* InRange */
1281 input_event(input, usage->type, (*quirks & HID_QUIRK_INVERT) ? BTN_TOOL_RUBBER : usage->code, 1);
1284 input_event(input, usage->type, usage->code, 0);
1285 input_event(input, usage->type, BTN_TOOL_RUBBER, 0);
1289 if (usage->hid == (HID_UP_DIGITIZER | 0x0030) && (*quirks & HID_QUIRK_NOTOUCH)) { /* Pressure */
1290 int a = field->logical_minimum;
1291 int b = field->logical_maximum;
1292 input_event(input, EV_KEY, BTN_TOUCH, value > a + ((b - a) >> 3));
1295 if (usage->hid == (HID_UP_PID | 0x83UL)) { /* Simultaneous Effects Max */
1296 dbg_hid("Maximum Effects - %d\n",value);
1300 if (usage->hid == (HID_UP_PID | 0x7fUL)) {
1301 dbg_hid("PID Pool Report\n");
1305 if ((usage->type == EV_KEY) && (usage->code == 0)) /* Key 0 is "unassigned", not KEY_UNKNOWN */
1308 if ((usage->type == EV_REL) && (usage->code == REL_WHEEL_HI_RES ||
1309 usage->code == REL_HWHEEL_HI_RES)) {
1310 hidinput_handle_scroll(usage, input, value);
1314 if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
1315 (usage->code == ABS_VOLUME)) {
1316 int count = abs(value);
1317 int direction = value > 0 ? KEY_VOLUMEUP : KEY_VOLUMEDOWN;
1320 for (i = 0; i < count; i++) {
1321 input_event(input, EV_KEY, direction, 1);
1323 input_event(input, EV_KEY, direction, 0);
1330 * Ignore out-of-range values as per HID specification,
1331 * section 5.10 and 6.2.25, when NULL state bit is present.
1332 * When it's not, clamp the value to match Microsoft's input
1333 * driver as mentioned in "Required HID usages for digitizers":
1334 * https://msdn.microsoft.com/en-us/library/windows/hardware/dn672278(v=vs.85).asp
1336 * The logical_minimum < logical_maximum check is done so that we
1337 * don't unintentionally discard values sent by devices which
1338 * don't specify logical min and max.
1340 if ((field->flags & HID_MAIN_ITEM_VARIABLE) &&
1341 (field->logical_minimum < field->logical_maximum)) {
1342 if (field->flags & HID_MAIN_ITEM_NULL_STATE &&
1343 (value < field->logical_minimum ||
1344 value > field->logical_maximum)) {
1345 dbg_hid("Ignoring out-of-range value %x\n", value);
1348 value = clamp(value,
1349 field->logical_minimum,
1350 field->logical_maximum);
1354 * Ignore reports for absolute data if the data didn't change. This is
1355 * not only an optimization but also fixes 'dead' key reports. Some
1356 * RollOver implementations for localized keys (like BACKSLASH/PIPE; HID
1357 * 0x31 and 0x32) report multiple keys, even though a localized keyboard
1358 * can only have one of them physically available. The 'dead' keys
1359 * report constant 0. As all map to the same keycode, they'd confuse
1360 * the input layer. If we filter the 'dead' keys on the HID level, we
1361 * skip the keycode translation and only forward real events.
1363 if (!(field->flags & (HID_MAIN_ITEM_RELATIVE |
1364 HID_MAIN_ITEM_BUFFERED_BYTE)) &&
1365 (field->flags & HID_MAIN_ITEM_VARIABLE) &&
1366 usage->usage_index < field->maxusage &&
1367 value == field->value[usage->usage_index])
1370 /* report the usage code as scancode if the key status has changed */
1371 if (usage->type == EV_KEY &&
1372 (!test_bit(usage->code, input->key)) == value)
1373 input_event(input, EV_MSC, MSC_SCAN, usage->hid);
1375 input_event(input, usage->type, usage->code, value);
1377 if ((field->flags & HID_MAIN_ITEM_RELATIVE) &&
1378 usage->type == EV_KEY && value) {
1380 input_event(input, usage->type, usage->code, 0);
1384 void hidinput_report_event(struct hid_device *hid, struct hid_report *report)
1386 struct hid_input *hidinput;
1388 if (hid->quirks & HID_QUIRK_NO_INPUT_SYNC)
1391 list_for_each_entry(hidinput, &hid->inputs, list)
1392 input_sync(hidinput->input);
1394 EXPORT_SYMBOL_GPL(hidinput_report_event);
1396 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field)
1398 struct hid_report *report;
1401 list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
1402 for (i = 0; i < report->maxfield; i++) {
1403 *field = report->field[i];
1404 for (j = 0; j < (*field)->maxusage; j++)
1405 if ((*field)->usage[j].type == type && (*field)->usage[j].code == code)
1411 EXPORT_SYMBOL_GPL(hidinput_find_field);
1413 struct hid_field *hidinput_get_led_field(struct hid_device *hid)
1415 struct hid_report *report;
1416 struct hid_field *field;
1419 list_for_each_entry(report,
1420 &hid->report_enum[HID_OUTPUT_REPORT].report_list,
1422 for (i = 0; i < report->maxfield; i++) {
1423 field = report->field[i];
1424 for (j = 0; j < field->maxusage; j++)
1425 if (field->usage[j].type == EV_LED)
1431 EXPORT_SYMBOL_GPL(hidinput_get_led_field);
1433 unsigned int hidinput_count_leds(struct hid_device *hid)
1435 struct hid_report *report;
1436 struct hid_field *field;
1438 unsigned int count = 0;
1440 list_for_each_entry(report,
1441 &hid->report_enum[HID_OUTPUT_REPORT].report_list,
1443 for (i = 0; i < report->maxfield; i++) {
1444 field = report->field[i];
1445 for (j = 0; j < field->maxusage; j++)
1446 if (field->usage[j].type == EV_LED &&
1453 EXPORT_SYMBOL_GPL(hidinput_count_leds);
1455 static void hidinput_led_worker(struct work_struct *work)
1457 struct hid_device *hid = container_of(work, struct hid_device,
1459 struct hid_field *field;
1460 struct hid_report *report;
1465 field = hidinput_get_led_field(hid);
1470 * field->report is accessed unlocked regarding HID core. So there might
1471 * be another incoming SET-LED request from user-space, which changes
1472 * the LED state while we assemble our outgoing buffer. However, this
1473 * doesn't matter as hid_output_report() correctly converts it into a
1474 * boolean value no matter what information is currently set on the LED
1475 * field (even garbage). So the remote device will always get a valid
1477 * And in case we send a wrong value, a next led worker is spawned
1478 * for every SET-LED request so the following worker will send the
1479 * correct value, guaranteed!
1482 report = field->report;
1484 /* use custom SET_REPORT request if possible (asynchronous) */
1485 if (hid->ll_driver->request)
1486 return hid->ll_driver->request(hid, report, HID_REQ_SET_REPORT);
1488 /* fall back to generic raw-output-report */
1489 len = hid_report_len(report);
1490 buf = hid_alloc_report_buf(report, GFP_KERNEL);
1494 hid_output_report(report, buf);
1495 /* synchronous output report */
1496 ret = hid_hw_output_report(hid, buf, len);
1498 hid_hw_raw_request(hid, report->id, buf, len, HID_OUTPUT_REPORT,
1499 HID_REQ_SET_REPORT);
1503 static int hidinput_input_event(struct input_dev *dev, unsigned int type,
1504 unsigned int code, int value)
1506 struct hid_device *hid = input_get_drvdata(dev);
1507 struct hid_field *field;
1511 return input_ff_event(dev, type, code, value);
1516 if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
1517 hid_warn(dev, "event field not found\n");
1521 hid_set_field(field, offset, value);
1523 schedule_work(&hid->led_work);
1527 static int hidinput_open(struct input_dev *dev)
1529 struct hid_device *hid = input_get_drvdata(dev);
1531 return hid_hw_open(hid);
1534 static void hidinput_close(struct input_dev *dev)
1536 struct hid_device *hid = input_get_drvdata(dev);
1541 static void hidinput_change_resolution_multipliers(struct hid_device *hid)
1543 struct hid_report_enum *rep_enum;
1544 struct hid_report *rep;
1545 struct hid_usage *usage;
1548 rep_enum = &hid->report_enum[HID_FEATURE_REPORT];
1549 list_for_each_entry(rep, &rep_enum->report_list, list) {
1550 bool update_needed = false;
1552 if (rep->maxfield == 0)
1556 * If we have more than one feature within this report we
1557 * need to fill in the bits from the others before we can
1558 * overwrite the ones for the Resolution Multiplier.
1560 if (rep->maxfield > 1) {
1561 hid_hw_request(hid, rep, HID_REQ_GET_REPORT);
1565 for (i = 0; i < rep->maxfield; i++) {
1566 __s32 logical_max = rep->field[i]->logical_maximum;
1568 /* There is no good reason for a Resolution
1569 * Multiplier to have a count other than 1.
1572 if (rep->field[i]->report_count != 1)
1575 for (j = 0; j < rep->field[i]->maxusage; j++) {
1576 usage = &rep->field[i]->usage[j];
1578 if (usage->hid != HID_GD_RESOLUTION_MULTIPLIER)
1581 *rep->field[i]->value = logical_max;
1582 update_needed = true;
1586 hid_hw_request(hid, rep, HID_REQ_SET_REPORT);
1589 /* refresh our structs */
1590 hid_setup_resolution_multiplier(hid);
1593 static void report_features(struct hid_device *hid)
1595 struct hid_driver *drv = hid->driver;
1596 struct hid_report_enum *rep_enum;
1597 struct hid_report *rep;
1598 struct hid_usage *usage;
1601 rep_enum = &hid->report_enum[HID_FEATURE_REPORT];
1602 list_for_each_entry(rep, &rep_enum->report_list, list)
1603 for (i = 0; i < rep->maxfield; i++) {
1604 /* Ignore if report count is out of bounds. */
1605 if (rep->field[i]->report_count < 1)
1608 for (j = 0; j < rep->field[i]->maxusage; j++) {
1609 usage = &rep->field[i]->usage[j];
1611 /* Verify if Battery Strength feature is available */
1612 if (usage->hid == HID_DC_BATTERYSTRENGTH)
1613 hidinput_setup_battery(hid, HID_FEATURE_REPORT,
1616 if (drv->feature_mapping)
1617 drv->feature_mapping(hid, rep->field[i], usage);
1622 static struct hid_input *hidinput_allocate(struct hid_device *hid,
1623 unsigned int application)
1625 struct hid_input *hidinput = kzalloc(sizeof(*hidinput), GFP_KERNEL);
1626 struct input_dev *input_dev = input_allocate_device();
1627 const char *suffix = NULL;
1628 size_t suffix_len, name_len;
1630 if (!hidinput || !input_dev)
1633 if ((hid->quirks & HID_QUIRK_INPUT_PER_APP) &&
1634 hid->maxapplication > 1) {
1635 switch (application) {
1636 case HID_GD_KEYBOARD:
1637 suffix = "Keyboard";
1648 case HID_DG_TOUCHSCREEN:
1649 suffix = "Touchscreen";
1651 case HID_DG_TOUCHPAD:
1652 suffix = "Touchpad";
1654 case HID_GD_SYSTEM_CONTROL:
1655 suffix = "System Control";
1657 case HID_CP_CONSUMER_CONTROL:
1658 suffix = "Consumer Control";
1660 case HID_GD_WIRELESS_RADIO_CTLS:
1661 suffix = "Wireless Radio Control";
1663 case HID_GD_SYSTEM_MULTIAXIS:
1664 suffix = "System Multi Axis";
1672 name_len = strlen(hid->name);
1673 suffix_len = strlen(suffix);
1674 if ((name_len < suffix_len) ||
1675 strcmp(hid->name + name_len - suffix_len, suffix)) {
1676 hidinput->name = kasprintf(GFP_KERNEL, "%s %s",
1678 if (!hidinput->name)
1683 input_set_drvdata(input_dev, hid);
1684 input_dev->event = hidinput_input_event;
1685 input_dev->open = hidinput_open;
1686 input_dev->close = hidinput_close;
1687 input_dev->setkeycode = hidinput_setkeycode;
1688 input_dev->getkeycode = hidinput_getkeycode;
1690 input_dev->name = hidinput->name ? hidinput->name : hid->name;
1691 input_dev->phys = hid->phys;
1692 input_dev->uniq = hid->uniq;
1693 input_dev->id.bustype = hid->bus;
1694 input_dev->id.vendor = hid->vendor;
1695 input_dev->id.product = hid->product;
1696 input_dev->id.version = hid->version;
1697 input_dev->dev.parent = &hid->dev;
1699 hidinput->input = input_dev;
1700 hidinput->application = application;
1701 list_add_tail(&hidinput->list, &hid->inputs);
1703 INIT_LIST_HEAD(&hidinput->reports);
1709 input_free_device(input_dev);
1710 hid_err(hid, "Out of memory during hid input probe\n");
1714 static bool hidinput_has_been_populated(struct hid_input *hidinput)
1717 unsigned long r = 0;
1719 for (i = 0; i < BITS_TO_LONGS(EV_CNT); i++)
1720 r |= hidinput->input->evbit[i];
1722 for (i = 0; i < BITS_TO_LONGS(KEY_CNT); i++)
1723 r |= hidinput->input->keybit[i];
1725 for (i = 0; i < BITS_TO_LONGS(REL_CNT); i++)
1726 r |= hidinput->input->relbit[i];
1728 for (i = 0; i < BITS_TO_LONGS(ABS_CNT); i++)
1729 r |= hidinput->input->absbit[i];
1731 for (i = 0; i < BITS_TO_LONGS(MSC_CNT); i++)
1732 r |= hidinput->input->mscbit[i];
1734 for (i = 0; i < BITS_TO_LONGS(LED_CNT); i++)
1735 r |= hidinput->input->ledbit[i];
1737 for (i = 0; i < BITS_TO_LONGS(SND_CNT); i++)
1738 r |= hidinput->input->sndbit[i];
1740 for (i = 0; i < BITS_TO_LONGS(FF_CNT); i++)
1741 r |= hidinput->input->ffbit[i];
1743 for (i = 0; i < BITS_TO_LONGS(SW_CNT); i++)
1744 r |= hidinput->input->swbit[i];
1749 static void hidinput_cleanup_hidinput(struct hid_device *hid,
1750 struct hid_input *hidinput)
1752 struct hid_report *report;
1755 list_del(&hidinput->list);
1756 input_free_device(hidinput->input);
1757 kfree(hidinput->name);
1759 for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
1760 if (k == HID_OUTPUT_REPORT &&
1761 hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
1764 list_for_each_entry(report, &hid->report_enum[k].report_list,
1767 for (i = 0; i < report->maxfield; i++)
1768 if (report->field[i]->hidinput == hidinput)
1769 report->field[i]->hidinput = NULL;
1776 static struct hid_input *hidinput_match(struct hid_report *report)
1778 struct hid_device *hid = report->device;
1779 struct hid_input *hidinput;
1781 list_for_each_entry(hidinput, &hid->inputs, list) {
1782 if (hidinput->report &&
1783 hidinput->report->id == report->id)
1790 static struct hid_input *hidinput_match_application(struct hid_report *report)
1792 struct hid_device *hid = report->device;
1793 struct hid_input *hidinput;
1795 list_for_each_entry(hidinput, &hid->inputs, list) {
1796 if (hidinput->application == report->application)
1803 static inline void hidinput_configure_usages(struct hid_input *hidinput,
1804 struct hid_report *report)
1808 for (i = 0; i < report->maxfield; i++)
1809 for (j = 0; j < report->field[i]->maxusage; j++)
1810 hidinput_configure_usage(hidinput, report->field[i],
1811 report->field[i]->usage + j);
1815 * Register the input device; print a message.
1816 * Configure the input layer interface
1817 * Read all reports and initialize the absolute field values.
1820 int hidinput_connect(struct hid_device *hid, unsigned int force)
1822 struct hid_driver *drv = hid->driver;
1823 struct hid_report *report;
1824 struct hid_input *next, *hidinput = NULL;
1825 unsigned int application;
1828 INIT_LIST_HEAD(&hid->inputs);
1829 INIT_WORK(&hid->led_work, hidinput_led_worker);
1831 hid->status &= ~HID_STAT_DUP_DETECTED;
1834 for (i = 0; i < hid->maxcollection; i++) {
1835 struct hid_collection *col = &hid->collection[i];
1836 if (col->type == HID_COLLECTION_APPLICATION ||
1837 col->type == HID_COLLECTION_PHYSICAL)
1838 if (IS_INPUT_APPLICATION(col->usage))
1842 if (i == hid->maxcollection)
1846 report_features(hid);
1848 for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
1849 if (k == HID_OUTPUT_REPORT &&
1850 hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
1853 list_for_each_entry(report, &hid->report_enum[k].report_list, list) {
1855 if (!report->maxfield)
1858 application = report->application;
1861 * Find the previous hidinput report attached
1862 * to this report id.
1864 if (hid->quirks & HID_QUIRK_MULTI_INPUT)
1865 hidinput = hidinput_match(report);
1866 else if (hid->maxapplication > 1 &&
1867 (hid->quirks & HID_QUIRK_INPUT_PER_APP))
1868 hidinput = hidinput_match_application(report);
1871 hidinput = hidinput_allocate(hid, application);
1876 hidinput_configure_usages(hidinput, report);
1878 if (hid->quirks & HID_QUIRK_MULTI_INPUT)
1879 hidinput->report = report;
1881 list_add_tail(&report->hidinput_list,
1882 &hidinput->reports);
1886 hidinput_change_resolution_multipliers(hid);
1888 list_for_each_entry_safe(hidinput, next, &hid->inputs, list) {
1889 if (drv->input_configured &&
1890 drv->input_configured(hid, hidinput))
1893 if (!hidinput_has_been_populated(hidinput)) {
1894 /* no need to register an input device not populated */
1895 hidinput_cleanup_hidinput(hid, hidinput);
1899 if (input_register_device(hidinput->input))
1901 hidinput->registered = true;
1904 if (list_empty(&hid->inputs)) {
1905 hid_err(hid, "No inputs registered, leaving\n");
1909 if (hid->status & HID_STAT_DUP_DETECTED)
1911 "Some usages could not be mapped, please use HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE if this is legitimate.\n");
1916 /* unwind the ones we already registered */
1917 hidinput_disconnect(hid);
1921 EXPORT_SYMBOL_GPL(hidinput_connect);
1923 void hidinput_disconnect(struct hid_device *hid)
1925 struct hid_input *hidinput, *next;
1927 hidinput_cleanup_battery(hid);
1929 list_for_each_entry_safe(hidinput, next, &hid->inputs, list) {
1930 list_del(&hidinput->list);
1931 if (hidinput->registered)
1932 input_unregister_device(hidinput->input);
1934 input_free_device(hidinput->input);
1935 kfree(hidinput->name);
1939 /* led_work is spawned by input_dev callbacks, but doesn't access the
1940 * parent input_dev at all. Once all input devices are removed, we
1941 * know that led_work will never get restarted, so we can cancel it
1942 * synchronously and are safe. */
1943 cancel_work_sync(&hid->led_work);
1945 EXPORT_SYMBOL_GPL(hidinput_disconnect);