1 // SPDX-License-Identifier: GPL-2.0-or-later 2 /* 3 * Copyright (c) 2000-2001 Vojtech Pavlik 4 * Copyright (c) 2006-2010 Jiri Kosina 5 * 6 * HID to Linux Input mapping 7 */ 8 9 /* 10 * 11 * Should you need to contact me, the author, you can do so either by 12 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail: 13 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic 14 */ 15 16 #include <linux/module.h> 17 #include <linux/slab.h> 18 #include <linux/kernel.h> 19 20 #include <linux/hid.h> 21 #include <linux/hid-debug.h> 22 23 #include "hid-ids.h" 24 25 #define unk KEY_UNKNOWN 26 27 static const unsigned char hid_keyboard[256] = { 28 0, 0, 0, 0, 30, 48, 46, 32, 18, 33, 34, 35, 23, 36, 37, 38, 29 50, 49, 24, 25, 16, 19, 31, 20, 22, 47, 17, 45, 21, 44, 2, 3, 30 4, 5, 6, 7, 8, 9, 10, 11, 28, 1, 14, 15, 57, 12, 13, 26, 31 27, 43, 43, 39, 40, 41, 51, 52, 53, 58, 59, 60, 61, 62, 63, 64, 32 65, 66, 67, 68, 87, 88, 99, 70,119,110,102,104,111,107,109,106, 33 105,108,103, 69, 98, 55, 74, 78, 96, 79, 80, 81, 75, 76, 77, 71, 34 72, 73, 82, 83, 86,127,116,117,183,184,185,186,187,188,189,190, 35 191,192,193,194,134,138,130,132,128,129,131,137,133,135,136,113, 36 115,114,unk,unk,unk,121,unk, 89, 93,124, 92, 94, 95,unk,unk,unk, 37 122,123, 90, 91, 85,unk,unk,unk,unk,unk,unk,unk,111,unk,unk,unk, 38 unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk, 39 unk,unk,unk,unk,unk,unk,179,180,unk,unk,unk,unk,unk,unk,unk,unk, 40 unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk, 41 unk,unk,unk,unk,unk,unk,unk,unk,111,unk,unk,unk,unk,unk,unk,unk, 42 29, 42, 56,125, 97, 54,100,126,164,166,165,163,161,115,114,113, 43 150,158,159,128,136,177,178,176,142,152,173,140,unk,unk,unk,unk 44 }; 45 46 static const struct { 47 __s32 x; 48 __s32 y; 49 } hid_hat_to_axis[] = {{ 0, 0}, { 0,-1}, { 1,-1}, { 1, 0}, { 1, 1}, { 0, 1}, {-1, 1}, {-1, 0}, {-1,-1}}; 50 51 struct usage_priority { 52 __u32 usage; /* the HID usage associated */ 53 bool global; /* we assume all usages to be slotted, 54 * unless global 55 */ 56 unsigned int slot_overwrite; /* for globals: allows to set the usage 57 * before or after the slots 58 */ 59 }; 60 61 /* 62 * hid-input will convert this list into priorities: 63 * the first element will have the highest priority 64 * (the length of the following array) and the last 65 * element the lowest (1). 66 * 67 * hid-input will then shift the priority by 8 bits to leave some space 68 * in case drivers want to interleave other fields. 69 * 70 * To accommodate slotted devices, the slot priority is 71 * defined in the next 8 bits (defined by 0xff - slot). 72 * 73 * If drivers want to add fields before those, hid-input will 74 * leave out the first 8 bits of the priority value. 75 * 76 * This still leaves us 65535 individual priority values. 77 */ 78 static const struct usage_priority hidinput_usages_priorities[] = { 79 { /* Eraser (eraser touching) must always come before tipswitch */ 80 .usage = HID_DG_ERASER, 81 }, 82 { /* Invert must always come before In Range */ 83 .usage = HID_DG_INVERT, 84 }, 85 { /* Is the tip of the tool touching? */ 86 .usage = HID_DG_TIPSWITCH, 87 }, 88 { /* Tip Pressure might emulate tip switch */ 89 .usage = HID_DG_TIPPRESSURE, 90 }, 91 { /* In Range needs to come after the other tool states */ 92 .usage = HID_DG_INRANGE, 93 }, 94 }; 95 96 #define map_abs(c) hid_map_usage(hidinput, usage, &bit, &max, EV_ABS, (c)) 97 #define map_rel(c) hid_map_usage(hidinput, usage, &bit, &max, EV_REL, (c)) 98 #define map_key(c) hid_map_usage(hidinput, usage, &bit, &max, EV_KEY, (c)) 99 #define map_led(c) hid_map_usage(hidinput, usage, &bit, &max, EV_LED, (c)) 100 #define map_msc(c) hid_map_usage(hidinput, usage, &bit, &max, EV_MSC, (c)) 101 102 #define map_abs_clear(c) hid_map_usage_clear(hidinput, usage, &bit, \ 103 &max, EV_ABS, (c)) 104 #define map_key_clear(c) hid_map_usage_clear(hidinput, usage, &bit, \ 105 &max, EV_KEY, (c)) 106 107 static bool match_scancode(struct hid_usage *usage, 108 unsigned int cur_idx, unsigned int scancode) 109 { 110 return (usage->hid & (HID_USAGE_PAGE | HID_USAGE)) == scancode; 111 } 112 113 static bool match_keycode(struct hid_usage *usage, 114 unsigned int cur_idx, unsigned int keycode) 115 { 116 /* 117 * We should exclude unmapped usages when doing lookup by keycode. 118 */ 119 return (usage->type == EV_KEY && usage->code == keycode); 120 } 121 122 static bool match_index(struct hid_usage *usage, 123 unsigned int cur_idx, unsigned int idx) 124 { 125 return cur_idx == idx; 126 } 127 128 typedef bool (*hid_usage_cmp_t)(struct hid_usage *usage, 129 unsigned int cur_idx, unsigned int val); 130 131 static struct hid_usage *hidinput_find_key(struct hid_device *hid, 132 hid_usage_cmp_t match, 133 unsigned int value, 134 unsigned int *usage_idx) 135 { 136 unsigned int i, j, k, cur_idx = 0; 137 struct hid_report *report; 138 struct hid_usage *usage; 139 140 for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) { 141 list_for_each_entry(report, &hid->report_enum[k].report_list, list) { 142 for (i = 0; i < report->maxfield; i++) { 143 for (j = 0; j < report->field[i]->maxusage; j++) { 144 usage = report->field[i]->usage + j; 145 if (usage->type == EV_KEY || usage->type == 0) { 146 if (match(usage, cur_idx, value)) { 147 if (usage_idx) 148 *usage_idx = cur_idx; 149 return usage; 150 } 151 cur_idx++; 152 } 153 } 154 } 155 } 156 } 157 return NULL; 158 } 159 160 static struct hid_usage *hidinput_locate_usage(struct hid_device *hid, 161 const struct input_keymap_entry *ke, 162 unsigned int *index) 163 { 164 struct hid_usage *usage; 165 unsigned int scancode; 166 167 if (ke->flags & INPUT_KEYMAP_BY_INDEX) 168 usage = hidinput_find_key(hid, match_index, ke->index, index); 169 else if (input_scancode_to_scalar(ke, &scancode) == 0) 170 usage = hidinput_find_key(hid, match_scancode, scancode, index); 171 else 172 usage = NULL; 173 174 return usage; 175 } 176 177 static int hidinput_getkeycode(struct input_dev *dev, 178 struct input_keymap_entry *ke) 179 { 180 struct hid_device *hid = input_get_drvdata(dev); 181 struct hid_usage *usage; 182 unsigned int scancode, index; 183 184 usage = hidinput_locate_usage(hid, ke, &index); 185 if (usage) { 186 ke->keycode = usage->type == EV_KEY ? 187 usage->code : KEY_RESERVED; 188 ke->index = index; 189 scancode = usage->hid & (HID_USAGE_PAGE | HID_USAGE); 190 ke->len = sizeof(scancode); 191 memcpy(ke->scancode, &scancode, sizeof(scancode)); 192 return 0; 193 } 194 195 return -EINVAL; 196 } 197 198 static int hidinput_setkeycode(struct input_dev *dev, 199 const struct input_keymap_entry *ke, 200 unsigned int *old_keycode) 201 { 202 struct hid_device *hid = input_get_drvdata(dev); 203 struct hid_usage *usage; 204 205 usage = hidinput_locate_usage(hid, ke, NULL); 206 if (usage) { 207 *old_keycode = usage->type == EV_KEY ? 208 usage->code : KEY_RESERVED; 209 usage->type = EV_KEY; 210 usage->code = ke->keycode; 211 212 clear_bit(*old_keycode, dev->keybit); 213 set_bit(usage->code, dev->keybit); 214 dbg_hid("Assigned keycode %d to HID usage code %x\n", 215 usage->code, usage->hid); 216 217 /* 218 * Set the keybit for the old keycode if the old keycode is used 219 * by another key 220 */ 221 if (hidinput_find_key(hid, match_keycode, *old_keycode, NULL)) 222 set_bit(*old_keycode, dev->keybit); 223 224 return 0; 225 } 226 227 return -EINVAL; 228 } 229 230 231 /** 232 * hidinput_calc_abs_res - calculate an absolute axis resolution 233 * @field: the HID report field to calculate resolution for 234 * @code: axis code 235 * 236 * The formula is: 237 * (logical_maximum - logical_minimum) 238 * resolution = ---------------------------------------------------------- 239 * (physical_maximum - physical_minimum) * 10 ^ unit_exponent 240 * 241 * as seen in the HID specification v1.11 6.2.2.7 Global Items. 242 * 243 * Only exponent 1 length units are processed. Centimeters and inches are 244 * converted to millimeters. Degrees are converted to radians. 245 */ 246 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code) 247 { 248 __s32 unit_exponent = field->unit_exponent; 249 __s32 logical_extents = field->logical_maximum - 250 field->logical_minimum; 251 __s32 physical_extents = field->physical_maximum - 252 field->physical_minimum; 253 __s32 prev; 254 255 /* Check if the extents are sane */ 256 if (logical_extents <= 0 || physical_extents <= 0) 257 return 0; 258 259 /* 260 * Verify and convert units. 261 * See HID specification v1.11 6.2.2.7 Global Items for unit decoding 262 */ 263 switch (code) { 264 case ABS_X: 265 case ABS_Y: 266 case ABS_Z: 267 case ABS_MT_POSITION_X: 268 case ABS_MT_POSITION_Y: 269 case ABS_MT_TOOL_X: 270 case ABS_MT_TOOL_Y: 271 case ABS_MT_TOUCH_MAJOR: 272 case ABS_MT_TOUCH_MINOR: 273 if (field->unit == 0x11) { /* If centimeters */ 274 /* Convert to millimeters */ 275 unit_exponent += 1; 276 } else if (field->unit == 0x13) { /* If inches */ 277 /* Convert to millimeters */ 278 prev = physical_extents; 279 physical_extents *= 254; 280 if (physical_extents < prev) 281 return 0; 282 unit_exponent -= 1; 283 } else { 284 return 0; 285 } 286 break; 287 288 case ABS_RX: 289 case ABS_RY: 290 case ABS_RZ: 291 case ABS_WHEEL: 292 case ABS_TILT_X: 293 case ABS_TILT_Y: 294 if (field->unit == 0x14) { /* If degrees */ 295 /* Convert to radians */ 296 prev = logical_extents; 297 logical_extents *= 573; 298 if (logical_extents < prev) 299 return 0; 300 unit_exponent += 1; 301 } else if (field->unit != 0x12) { /* If not radians */ 302 return 0; 303 } 304 break; 305 306 case ABS_PRESSURE: 307 case ABS_MT_PRESSURE: 308 if (field->unit == HID_UNIT_NEWTON) { 309 /* Convert to grams, 1 newton is 101.97 grams */ 310 prev = physical_extents; 311 physical_extents *= 10197; 312 if (physical_extents < prev) 313 return 0; 314 unit_exponent -= 2; 315 } else if (field->unit != HID_UNIT_GRAM) { 316 return 0; 317 } 318 break; 319 default: 320 return 0; 321 } 322 323 /* Apply negative unit exponent */ 324 for (; unit_exponent < 0; unit_exponent++) { 325 prev = logical_extents; 326 logical_extents *= 10; 327 if (logical_extents < prev) 328 return 0; 329 } 330 /* Apply positive unit exponent */ 331 for (; unit_exponent > 0; unit_exponent--) { 332 prev = physical_extents; 333 physical_extents *= 10; 334 if (physical_extents < prev) 335 return 0; 336 } 337 338 /* Calculate resolution */ 339 return DIV_ROUND_CLOSEST(logical_extents, physical_extents); 340 } 341 EXPORT_SYMBOL_GPL(hidinput_calc_abs_res); 342 343 #ifdef CONFIG_HID_BATTERY_STRENGTH 344 static enum power_supply_property hidinput_battery_props[] = { 345 POWER_SUPPLY_PROP_PRESENT, 346 POWER_SUPPLY_PROP_ONLINE, 347 POWER_SUPPLY_PROP_CAPACITY, 348 POWER_SUPPLY_PROP_MODEL_NAME, 349 POWER_SUPPLY_PROP_STATUS, 350 POWER_SUPPLY_PROP_SCOPE, 351 }; 352 353 #define HID_BATTERY_QUIRK_PERCENT (1 << 0) /* always reports percent */ 354 #define HID_BATTERY_QUIRK_FEATURE (1 << 1) /* ask for feature report */ 355 #define HID_BATTERY_QUIRK_IGNORE (1 << 2) /* completely ignore the battery */ 356 #define HID_BATTERY_QUIRK_AVOID_QUERY (1 << 3) /* do not query the battery */ 357 #define HID_BATTERY_QUIRK_DYNAMIC (1 << 4) /* report present only after life signs */ 358 359 static const struct hid_device_id hid_battery_quirks[] = { 360 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, 361 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO), 362 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE }, 363 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, 364 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI), 365 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE }, 366 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, 367 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ANSI), 368 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE }, 369 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, 370 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ISO), 371 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE }, 372 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, 373 USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI), 374 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE }, 375 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE, 376 USB_DEVICE_ID_APPLE_MAGICTRACKPAD), 377 HID_BATTERY_QUIRK_IGNORE }, 378 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_ELECOM, 379 USB_DEVICE_ID_ELECOM_BM084), 380 HID_BATTERY_QUIRK_IGNORE }, 381 { HID_USB_DEVICE(USB_VENDOR_ID_SYMBOL, 382 USB_DEVICE_ID_SYMBOL_SCANNER_3), 383 HID_BATTERY_QUIRK_IGNORE }, 384 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_ASUSTEK, 385 USB_DEVICE_ID_ASUSTEK_T100CHI_KEYBOARD), 386 HID_BATTERY_QUIRK_IGNORE }, 387 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH, 388 USB_DEVICE_ID_LOGITECH_DINOVO_EDGE_KBD), 389 HID_BATTERY_QUIRK_IGNORE }, 390 { HID_USB_DEVICE(USB_VENDOR_ID_UGEE, USB_DEVICE_ID_UGEE_XPPEN_TABLET_DECO_L), 391 HID_BATTERY_QUIRK_AVOID_QUERY }, 392 { HID_USB_DEVICE(USB_VENDOR_ID_UGEE, USB_DEVICE_ID_UGEE_XPPEN_TABLET_DECO_PRO_MW), 393 HID_BATTERY_QUIRK_AVOID_QUERY }, 394 { HID_USB_DEVICE(USB_VENDOR_ID_UGEE, USB_DEVICE_ID_UGEE_XPPEN_TABLET_DECO_PRO_SW), 395 HID_BATTERY_QUIRK_AVOID_QUERY }, 396 { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, I2C_DEVICE_ID_CHROMEBOOK_TROGDOR_POMPOM), 397 HID_BATTERY_QUIRK_AVOID_QUERY }, 398 /* 399 * Elan HID touchscreens seem to all report a non present battery, 400 * set HID_BATTERY_QUIRK_IGNORE for all Elan I2C and USB HID devices. 401 */ 402 { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, HID_ANY_ID), HID_BATTERY_QUIRK_DYNAMIC }, 403 { HID_USB_DEVICE(USB_VENDOR_ID_ELAN, HID_ANY_ID), HID_BATTERY_QUIRK_DYNAMIC }, 404 {} 405 }; 406 407 static unsigned find_battery_quirk(struct hid_device *hdev) 408 { 409 unsigned quirks = 0; 410 const struct hid_device_id *match; 411 412 match = hid_match_id(hdev, hid_battery_quirks); 413 if (match != NULL) 414 quirks = match->driver_data; 415 416 return quirks; 417 } 418 419 static int hidinput_scale_battery_capacity(struct hid_device *dev, 420 int value) 421 { 422 if (dev->battery_min < dev->battery_max && 423 value >= dev->battery_min && value <= dev->battery_max) 424 value = ((value - dev->battery_min) * 100) / 425 (dev->battery_max - dev->battery_min); 426 427 return value; 428 } 429 430 static int hidinput_query_battery_capacity(struct hid_device *dev) 431 { 432 u8 *buf; 433 int ret; 434 435 buf = kmalloc(4, GFP_KERNEL); 436 if (!buf) 437 return -ENOMEM; 438 439 ret = hid_hw_raw_request(dev, dev->battery_report_id, buf, 4, 440 dev->battery_report_type, HID_REQ_GET_REPORT); 441 if (ret < 2) { 442 kfree(buf); 443 return -ENODATA; 444 } 445 446 ret = hidinput_scale_battery_capacity(dev, buf[1]); 447 kfree(buf); 448 return ret; 449 } 450 451 static int hidinput_get_battery_property(struct power_supply *psy, 452 enum power_supply_property prop, 453 union power_supply_propval *val) 454 { 455 struct hid_device *dev = power_supply_get_drvdata(psy); 456 int value; 457 int ret = 0; 458 459 switch (prop) { 460 case POWER_SUPPLY_PROP_ONLINE: 461 val->intval = 1; 462 break; 463 464 case POWER_SUPPLY_PROP_PRESENT: 465 val->intval = dev->battery_present; 466 break; 467 468 case POWER_SUPPLY_PROP_CAPACITY: 469 if (dev->battery_status != HID_BATTERY_REPORTED && 470 !dev->battery_avoid_query) { 471 value = hidinput_query_battery_capacity(dev); 472 if (value < 0) 473 return value; 474 } else { 475 value = dev->battery_capacity; 476 } 477 478 val->intval = value; 479 break; 480 481 case POWER_SUPPLY_PROP_MODEL_NAME: 482 val->strval = dev->name; 483 break; 484 485 case POWER_SUPPLY_PROP_STATUS: 486 if (dev->battery_status != HID_BATTERY_REPORTED && 487 !dev->battery_avoid_query) { 488 value = hidinput_query_battery_capacity(dev); 489 if (value < 0) 490 return value; 491 492 dev->battery_capacity = value; 493 dev->battery_status = HID_BATTERY_QUERIED; 494 } 495 496 if (dev->battery_status == HID_BATTERY_UNKNOWN) 497 val->intval = POWER_SUPPLY_STATUS_UNKNOWN; 498 else 499 val->intval = dev->battery_charge_status; 500 break; 501 502 case POWER_SUPPLY_PROP_SCOPE: 503 val->intval = POWER_SUPPLY_SCOPE_DEVICE; 504 break; 505 506 default: 507 ret = -EINVAL; 508 break; 509 } 510 511 return ret; 512 } 513 514 static int hidinput_setup_battery(struct hid_device *dev, unsigned report_type, 515 struct hid_field *field, bool is_percentage) 516 { 517 struct power_supply_desc *psy_desc; 518 struct power_supply_config psy_cfg = { .drv_data = dev, }; 519 unsigned quirks; 520 s32 min, max; 521 int error; 522 523 if (dev->battery) 524 return 0; /* already initialized? */ 525 526 quirks = find_battery_quirk(dev); 527 528 hid_dbg(dev, "device %x:%x:%x %d quirks %d\n", 529 dev->bus, dev->vendor, dev->product, dev->version, quirks); 530 531 if (quirks & HID_BATTERY_QUIRK_IGNORE) 532 return 0; 533 534 psy_desc = kzalloc_obj(*psy_desc); 535 if (!psy_desc) 536 return -ENOMEM; 537 538 psy_desc->name = kasprintf(GFP_KERNEL, "hid-%s-battery", 539 strlen(dev->uniq) ? 540 dev->uniq : dev_name(&dev->dev)); 541 if (!psy_desc->name) { 542 error = -ENOMEM; 543 goto err_free_mem; 544 } 545 546 psy_desc->type = POWER_SUPPLY_TYPE_BATTERY; 547 psy_desc->properties = hidinput_battery_props; 548 psy_desc->num_properties = ARRAY_SIZE(hidinput_battery_props); 549 psy_desc->use_for_apm = 0; 550 psy_desc->get_property = hidinput_get_battery_property; 551 552 min = field->logical_minimum; 553 max = field->logical_maximum; 554 555 if (is_percentage || (quirks & HID_BATTERY_QUIRK_PERCENT)) { 556 min = 0; 557 max = 100; 558 } 559 560 if (quirks & HID_BATTERY_QUIRK_FEATURE) 561 report_type = HID_FEATURE_REPORT; 562 563 dev->battery_min = min; 564 dev->battery_max = max; 565 dev->battery_report_type = report_type; 566 dev->battery_report_id = field->report->id; 567 dev->battery_charge_status = POWER_SUPPLY_STATUS_DISCHARGING; 568 569 /* 570 * Stylus is normally not connected to the device and thus we 571 * can't query the device and get meaningful battery strength. 572 * We have to wait for the device to report it on its own. 573 */ 574 dev->battery_avoid_query = report_type == HID_INPUT_REPORT && 575 field->physical == HID_DG_STYLUS; 576 577 if (quirks & HID_BATTERY_QUIRK_AVOID_QUERY) 578 dev->battery_avoid_query = true; 579 580 dev->battery_present = (quirks & HID_BATTERY_QUIRK_DYNAMIC) ? false : true; 581 582 dev->battery = power_supply_register(&dev->dev, psy_desc, &psy_cfg); 583 if (IS_ERR(dev->battery)) { 584 error = PTR_ERR(dev->battery); 585 hid_warn(dev, "can't register power supply: %d\n", error); 586 goto err_free_name; 587 } 588 589 power_supply_powers(dev->battery, &dev->dev); 590 return 0; 591 592 err_free_name: 593 kfree(psy_desc->name); 594 err_free_mem: 595 kfree(psy_desc); 596 dev->battery = NULL; 597 return error; 598 } 599 600 static void hidinput_cleanup_battery(struct hid_device *dev) 601 { 602 const struct power_supply_desc *psy_desc; 603 604 if (!dev->battery) 605 return; 606 607 psy_desc = dev->battery->desc; 608 power_supply_unregister(dev->battery); 609 kfree(psy_desc->name); 610 kfree(psy_desc); 611 dev->battery = NULL; 612 } 613 614 static bool hidinput_update_battery_charge_status(struct hid_device *dev, 615 unsigned int usage, int value) 616 { 617 switch (usage) { 618 case HID_BAT_CHARGING: 619 dev->battery_charge_status = value ? 620 POWER_SUPPLY_STATUS_CHARGING : 621 POWER_SUPPLY_STATUS_DISCHARGING; 622 return true; 623 } 624 625 return false; 626 } 627 628 static void hidinput_update_battery(struct hid_device *dev, unsigned int usage, 629 int value) 630 { 631 int capacity; 632 633 if (!dev->battery) 634 return; 635 636 if (hidinput_update_battery_charge_status(dev, usage, value)) { 637 dev->battery_present = true; 638 power_supply_changed(dev->battery); 639 return; 640 } 641 642 if ((usage & HID_USAGE_PAGE) == HID_UP_DIGITIZER && value == 0) 643 return; 644 645 if (value < dev->battery_min || value > dev->battery_max) 646 return; 647 648 capacity = hidinput_scale_battery_capacity(dev, value); 649 650 if (dev->battery_status != HID_BATTERY_REPORTED || 651 capacity != dev->battery_capacity || 652 ktime_after(ktime_get_coarse(), dev->battery_ratelimit_time)) { 653 dev->battery_present = true; 654 dev->battery_capacity = capacity; 655 dev->battery_status = HID_BATTERY_REPORTED; 656 dev->battery_ratelimit_time = 657 ktime_add_ms(ktime_get_coarse(), 30 * 1000); 658 power_supply_changed(dev->battery); 659 } 660 } 661 #else /* !CONFIG_HID_BATTERY_STRENGTH */ 662 static int hidinput_setup_battery(struct hid_device *dev, unsigned report_type, 663 struct hid_field *field, bool is_percentage) 664 { 665 return 0; 666 } 667 668 static void hidinput_cleanup_battery(struct hid_device *dev) 669 { 670 } 671 672 static void hidinput_update_battery(struct hid_device *dev, unsigned int usage, 673 int value) 674 { 675 } 676 #endif /* CONFIG_HID_BATTERY_STRENGTH */ 677 678 static bool hidinput_field_in_collection(struct hid_device *device, struct hid_field *field, 679 unsigned int type, unsigned int usage) 680 { 681 struct hid_collection *collection; 682 683 collection = &device->collection[field->usage->collection_index]; 684 685 return collection->type == type && collection->usage == usage; 686 } 687 688 static void hidinput_configure_usage(struct hid_input *hidinput, struct hid_field *field, 689 struct hid_usage *usage, unsigned int usage_index) 690 { 691 struct input_dev *input = hidinput->input; 692 struct hid_device *device = input_get_drvdata(input); 693 const struct usage_priority *usage_priority = NULL; 694 int max = 0, code; 695 unsigned int i = 0; 696 unsigned long *bit = NULL; 697 698 field->hidinput = hidinput; 699 700 if (field->flags & HID_MAIN_ITEM_CONSTANT) 701 goto ignore; 702 703 /* Ignore if report count is out of bounds. */ 704 if (field->report_count < 1) 705 goto ignore; 706 707 /* only LED and HAPTIC usages are supported in output fields */ 708 if (field->report_type == HID_OUTPUT_REPORT && 709 (usage->hid & HID_USAGE_PAGE) != HID_UP_LED && 710 (usage->hid & HID_USAGE_PAGE) != HID_UP_HAPTIC) { 711 goto ignore; 712 } 713 714 /* assign a priority based on the static list declared here */ 715 for (i = 0; i < ARRAY_SIZE(hidinput_usages_priorities); i++) { 716 if (usage->hid == hidinput_usages_priorities[i].usage) { 717 usage_priority = &hidinput_usages_priorities[i]; 718 719 field->usages_priorities[usage_index] = 720 (ARRAY_SIZE(hidinput_usages_priorities) - i) << 8; 721 break; 722 } 723 } 724 725 /* 726 * For slotted devices, we need to also add the slot index 727 * in the priority. 728 */ 729 if (usage_priority && usage_priority->global) 730 field->usages_priorities[usage_index] |= 731 usage_priority->slot_overwrite; 732 else 733 field->usages_priorities[usage_index] |= 734 (0xff - field->slot_idx) << 16; 735 736 if (device->driver->input_mapping) { 737 int ret = device->driver->input_mapping(device, hidinput, field, 738 usage, &bit, &max); 739 if (ret > 0) 740 goto mapped; 741 if (ret < 0) 742 goto ignore; 743 } 744 745 switch (usage->hid & HID_USAGE_PAGE) { 746 case HID_UP_UNDEFINED: 747 goto ignore; 748 749 case HID_UP_KEYBOARD: 750 set_bit(EV_REP, input->evbit); 751 752 if ((usage->hid & HID_USAGE) < 256) { 753 if (!hid_keyboard[usage->hid & HID_USAGE]) goto ignore; 754 map_key_clear(hid_keyboard[usage->hid & HID_USAGE]); 755 } else 756 map_key(KEY_UNKNOWN); 757 758 break; 759 760 case HID_UP_BUTTON: 761 code = ((usage->hid - 1) & HID_USAGE); 762 763 switch (field->application) { 764 case HID_GD_MOUSE: 765 case HID_GD_POINTER: code += BTN_MOUSE; break; 766 case HID_GD_JOYSTICK: 767 if (code <= 0xf) 768 code += BTN_JOYSTICK; 769 else 770 code += BTN_TRIGGER_HAPPY - 0x10; 771 break; 772 case HID_GD_GAMEPAD: 773 if (code <= 0xf) 774 code += BTN_GAMEPAD; 775 else 776 code += BTN_TRIGGER_HAPPY - 0x10; 777 break; 778 case HID_CP_CONSUMER_CONTROL: 779 if (hidinput_field_in_collection(device, field, 780 HID_COLLECTION_NAMED_ARRAY, 781 HID_CP_PROGRAMMABLEBUTTONS)) { 782 if (code <= 0x1d) 783 code += KEY_MACRO1; 784 else 785 code += BTN_TRIGGER_HAPPY - 0x1e; 786 break; 787 } 788 fallthrough; 789 default: 790 switch (field->physical) { 791 case HID_GD_MOUSE: 792 case HID_GD_POINTER: code += BTN_MOUSE; break; 793 case HID_GD_JOYSTICK: code += BTN_JOYSTICK; break; 794 case HID_GD_GAMEPAD: code += BTN_GAMEPAD; break; 795 default: code += BTN_MISC; 796 } 797 } 798 799 map_key(code); 800 break; 801 802 case HID_UP_SIMULATION: 803 switch (usage->hid & 0xffff) { 804 case 0xba: map_abs(ABS_RUDDER); break; 805 case 0xbb: map_abs(ABS_THROTTLE); break; 806 case 0xc4: map_abs(ABS_GAS); break; 807 case 0xc5: map_abs(ABS_BRAKE); break; 808 case 0xc8: map_abs(ABS_WHEEL); break; 809 default: goto ignore; 810 } 811 break; 812 813 case HID_UP_GENDESK: 814 if ((usage->hid & 0xf0) == 0x80) { /* SystemControl */ 815 switch (usage->hid & 0xf) { 816 case 0x1: map_key_clear(KEY_POWER); break; 817 case 0x2: map_key_clear(KEY_SLEEP); break; 818 case 0x3: map_key_clear(KEY_WAKEUP); break; 819 case 0x4: map_key_clear(KEY_CONTEXT_MENU); break; 820 case 0x5: map_key_clear(KEY_MENU); break; 821 case 0x6: map_key_clear(KEY_PROG1); break; 822 case 0x7: map_key_clear(KEY_HELP); break; 823 case 0x8: map_key_clear(KEY_EXIT); break; 824 case 0x9: map_key_clear(KEY_SELECT); break; 825 case 0xa: map_key_clear(KEY_RIGHT); break; 826 case 0xb: map_key_clear(KEY_LEFT); break; 827 case 0xc: map_key_clear(KEY_UP); break; 828 case 0xd: map_key_clear(KEY_DOWN); break; 829 case 0xe: map_key_clear(KEY_POWER2); break; 830 case 0xf: map_key_clear(KEY_RESTART); break; 831 default: goto unknown; 832 } 833 break; 834 } 835 836 if ((usage->hid & 0xf0) == 0x90) { /* SystemControl & D-pad */ 837 switch (usage->hid) { 838 case HID_GD_UP: usage->hat_dir = 1; break; 839 case HID_GD_DOWN: usage->hat_dir = 5; break; 840 case HID_GD_RIGHT: usage->hat_dir = 3; break; 841 case HID_GD_LEFT: usage->hat_dir = 7; break; 842 case HID_GD_DO_NOT_DISTURB: 843 map_key_clear(KEY_DO_NOT_DISTURB); break; 844 default: goto unknown; 845 } 846 847 if (usage->hid <= HID_GD_LEFT) { 848 if (field->dpad) { 849 map_abs(field->dpad); 850 goto ignore; 851 } 852 map_abs(ABS_HAT0X); 853 } 854 break; 855 } 856 857 if ((usage->hid & 0xf0) == 0xa0) { /* SystemControl */ 858 switch (usage->hid & 0xf) { 859 case 0x9: map_key_clear(KEY_MICMUTE); break; 860 case 0xa: map_key_clear(KEY_ACCESSIBILITY); break; 861 default: goto ignore; 862 } 863 break; 864 } 865 866 if ((usage->hid & 0xf0) == 0xb0) { /* SC - Display */ 867 switch (usage->hid & 0xf) { 868 case 0x05: map_key_clear(KEY_SWITCHVIDEOMODE); break; 869 default: goto ignore; 870 } 871 break; 872 } 873 874 /* 875 * Some lazy vendors declare 255 usages for System Control, 876 * leading to the creation of ABS_X|Y axis and too many others. 877 * It wouldn't be a problem if joydev doesn't consider the 878 * device as a joystick then. 879 */ 880 if (field->application == HID_GD_SYSTEM_CONTROL) 881 goto ignore; 882 883 switch (usage->hid) { 884 /* These usage IDs map directly to the usage codes. */ 885 case HID_GD_X: case HID_GD_Y: 886 case HID_GD_RX: case HID_GD_RY: case HID_GD_RZ: 887 if (field->flags & HID_MAIN_ITEM_RELATIVE) 888 map_rel(usage->hid & 0xf); 889 else 890 map_abs_clear(usage->hid & 0xf); 891 break; 892 893 case HID_GD_Z: 894 /* HID_GD_Z is mapped to ABS_DISTANCE for stylus/pen */ 895 if (field->flags & HID_MAIN_ITEM_RELATIVE) { 896 map_rel(usage->hid & 0xf); 897 } else { 898 if (field->application == HID_DG_PEN || 899 field->physical == HID_DG_PEN || 900 field->logical == HID_DG_STYLUS || 901 field->physical == HID_DG_STYLUS || 902 field->application == HID_DG_DIGITIZER) 903 map_abs_clear(ABS_DISTANCE); 904 else 905 map_abs_clear(usage->hid & 0xf); 906 } 907 break; 908 909 case HID_GD_WHEEL: 910 if (field->flags & HID_MAIN_ITEM_RELATIVE) { 911 set_bit(REL_WHEEL, input->relbit); 912 map_rel(REL_WHEEL_HI_RES); 913 } else { 914 map_abs(usage->hid & 0xf); 915 } 916 break; 917 case HID_GD_SLIDER: case HID_GD_DIAL: 918 if (field->flags & HID_MAIN_ITEM_RELATIVE) 919 map_rel(usage->hid & 0xf); 920 else 921 map_abs(usage->hid & 0xf); 922 break; 923 924 case HID_GD_HATSWITCH: 925 usage->hat_min = field->logical_minimum; 926 usage->hat_max = field->logical_maximum; 927 map_abs(ABS_HAT0X); 928 break; 929 930 case HID_GD_START: map_key_clear(BTN_START); break; 931 case HID_GD_SELECT: map_key_clear(BTN_SELECT); break; 932 933 case HID_GD_RFKILL_BTN: 934 /* MS wireless radio ctl extension, also check CA */ 935 if (field->application == HID_GD_WIRELESS_RADIO_CTLS) { 936 map_key_clear(KEY_RFKILL); 937 /* We need to simulate the btn release */ 938 field->flags |= HID_MAIN_ITEM_RELATIVE; 939 break; 940 } 941 goto unknown; 942 943 default: goto unknown; 944 } 945 946 break; 947 948 case HID_UP_LED: 949 switch (usage->hid & 0xffff) { /* HID-Value: */ 950 case 0x01: map_led (LED_NUML); break; /* "Num Lock" */ 951 case 0x02: map_led (LED_CAPSL); break; /* "Caps Lock" */ 952 case 0x03: map_led (LED_SCROLLL); break; /* "Scroll Lock" */ 953 case 0x04: map_led (LED_COMPOSE); break; /* "Compose" */ 954 case 0x05: map_led (LED_KANA); break; /* "Kana" */ 955 case 0x27: map_led (LED_SLEEP); break; /* "Stand-By" */ 956 case 0x4c: map_led (LED_SUSPEND); break; /* "System Suspend" */ 957 case 0x09: map_led (LED_MUTE); break; /* "Mute" */ 958 case 0x4b: map_led (LED_MISC); break; /* "Generic Indicator" */ 959 case 0x19: map_led (LED_MAIL); break; /* "Message Waiting" */ 960 case 0x4d: map_led (LED_CHARGING); break; /* "External Power Connected" */ 961 962 default: goto ignore; 963 } 964 break; 965 966 case HID_UP_DIGITIZER: 967 if ((field->application & 0xff) == 0x01) /* Digitizer */ 968 __set_bit(INPUT_PROP_POINTER, input->propbit); 969 else if ((field->application & 0xff) == 0x02) /* Pen */ 970 __set_bit(INPUT_PROP_DIRECT, input->propbit); 971 972 switch (usage->hid & 0xff) { 973 case 0x00: /* Undefined */ 974 goto ignore; 975 976 case 0x30: /* TipPressure */ 977 if (!test_bit(BTN_TOUCH, input->keybit)) { 978 device->quirks |= HID_QUIRK_NOTOUCH; 979 set_bit(EV_KEY, input->evbit); 980 set_bit(BTN_TOUCH, input->keybit); 981 } 982 map_abs_clear(ABS_PRESSURE); 983 break; 984 985 case 0x32: /* InRange */ 986 switch (field->physical) { 987 case HID_DG_PUCK: 988 map_key(BTN_TOOL_MOUSE); 989 break; 990 case HID_DG_FINGER: 991 map_key(BTN_TOOL_FINGER); 992 break; 993 default: 994 /* 995 * If the physical is not given, 996 * rely on the application. 997 */ 998 if (!field->physical) { 999 switch (field->application) { 1000 case HID_DG_TOUCHSCREEN: 1001 case HID_DG_TOUCHPAD: 1002 map_key_clear(BTN_TOOL_FINGER); 1003 break; 1004 default: 1005 map_key_clear(BTN_TOOL_PEN); 1006 } 1007 } else { 1008 map_key(BTN_TOOL_PEN); 1009 } 1010 break; 1011 } 1012 break; 1013 1014 case 0x3b: /* Battery Strength */ 1015 hidinput_setup_battery(device, HID_INPUT_REPORT, field, false); 1016 usage->type = EV_PWR; 1017 return; 1018 1019 case 0x3c: /* Invert */ 1020 device->quirks &= ~HID_QUIRK_NOINVERT; 1021 map_key_clear(BTN_TOOL_RUBBER); 1022 break; 1023 1024 case 0x3d: /* X Tilt */ 1025 map_abs_clear(ABS_TILT_X); 1026 break; 1027 1028 case 0x3e: /* Y Tilt */ 1029 map_abs_clear(ABS_TILT_Y); 1030 break; 1031 1032 case 0x33: /* Touch */ 1033 case 0x42: /* TipSwitch */ 1034 case 0x43: /* TipSwitch2 */ 1035 device->quirks &= ~HID_QUIRK_NOTOUCH; 1036 map_key_clear(BTN_TOUCH); 1037 break; 1038 1039 case 0x44: /* BarrelSwitch */ 1040 map_key_clear(BTN_STYLUS); 1041 break; 1042 1043 case 0x45: /* ERASER */ 1044 /* 1045 * This event is reported when eraser tip touches the surface. 1046 * Actual eraser (BTN_TOOL_RUBBER) is set and released either 1047 * by Invert if tool reports proximity or by Eraser directly. 1048 */ 1049 if (!test_bit(BTN_TOOL_RUBBER, input->keybit)) { 1050 device->quirks |= HID_QUIRK_NOINVERT; 1051 set_bit(BTN_TOOL_RUBBER, input->keybit); 1052 } 1053 map_key_clear(BTN_TOUCH); 1054 break; 1055 1056 case 0x46: /* TabletPick */ 1057 case 0x5a: /* SecondaryBarrelSwitch */ 1058 map_key_clear(BTN_STYLUS2); 1059 break; 1060 1061 case 0x5b: /* TransducerSerialNumber */ 1062 case 0x6e: /* TransducerSerialNumber2 */ 1063 map_msc(MSC_SERIAL); 1064 break; 1065 1066 default: goto unknown; 1067 } 1068 break; 1069 1070 case HID_UP_TELEPHONY: 1071 switch (usage->hid & HID_USAGE) { 1072 case 0x2f: map_key_clear(KEY_MICMUTE); break; 1073 case 0xb0: map_key_clear(KEY_NUMERIC_0); break; 1074 case 0xb1: map_key_clear(KEY_NUMERIC_1); break; 1075 case 0xb2: map_key_clear(KEY_NUMERIC_2); break; 1076 case 0xb3: map_key_clear(KEY_NUMERIC_3); break; 1077 case 0xb4: map_key_clear(KEY_NUMERIC_4); break; 1078 case 0xb5: map_key_clear(KEY_NUMERIC_5); break; 1079 case 0xb6: map_key_clear(KEY_NUMERIC_6); break; 1080 case 0xb7: map_key_clear(KEY_NUMERIC_7); break; 1081 case 0xb8: map_key_clear(KEY_NUMERIC_8); break; 1082 case 0xb9: map_key_clear(KEY_NUMERIC_9); break; 1083 case 0xba: map_key_clear(KEY_NUMERIC_STAR); break; 1084 case 0xbb: map_key_clear(KEY_NUMERIC_POUND); break; 1085 case 0xbc: map_key_clear(KEY_NUMERIC_A); break; 1086 case 0xbd: map_key_clear(KEY_NUMERIC_B); break; 1087 case 0xbe: map_key_clear(KEY_NUMERIC_C); break; 1088 case 0xbf: map_key_clear(KEY_NUMERIC_D); break; 1089 default: goto ignore; 1090 } 1091 break; 1092 1093 case HID_UP_CONSUMER: /* USB HUT v1.12, pages 75-84 */ 1094 switch (usage->hid & HID_USAGE) { 1095 case 0x000: goto ignore; 1096 case 0x030: map_key_clear(KEY_POWER); break; 1097 case 0x031: map_key_clear(KEY_RESTART); break; 1098 case 0x032: map_key_clear(KEY_SLEEP); break; 1099 case 0x034: map_key_clear(KEY_SLEEP); break; 1100 case 0x035: map_key_clear(KEY_KBDILLUMTOGGLE); break; 1101 case 0x036: map_key_clear(BTN_MISC); break; 1102 1103 case 0x040: map_key_clear(KEY_MENU); break; /* Menu */ 1104 case 0x041: map_key_clear(KEY_SELECT); break; /* Menu Pick */ 1105 case 0x042: map_key_clear(KEY_UP); break; /* Menu Up */ 1106 case 0x043: map_key_clear(KEY_DOWN); break; /* Menu Down */ 1107 case 0x044: map_key_clear(KEY_LEFT); break; /* Menu Left */ 1108 case 0x045: map_key_clear(KEY_RIGHT); break; /* Menu Right */ 1109 case 0x046: map_key_clear(KEY_ESC); break; /* Menu Escape */ 1110 case 0x047: map_key_clear(KEY_KPPLUS); break; /* Menu Value Increase */ 1111 case 0x048: map_key_clear(KEY_KPMINUS); break; /* Menu Value Decrease */ 1112 1113 case 0x060: map_key_clear(KEY_INFO); break; /* Data On Screen */ 1114 case 0x061: map_key_clear(KEY_SUBTITLE); break; /* Closed Caption */ 1115 case 0x063: map_key_clear(KEY_VCR); break; /* VCR/TV */ 1116 case 0x065: map_key_clear(KEY_CAMERA); break; /* Snapshot */ 1117 case 0x069: map_key_clear(KEY_RED); break; 1118 case 0x06a: map_key_clear(KEY_GREEN); break; 1119 case 0x06b: map_key_clear(KEY_BLUE); break; 1120 case 0x06c: map_key_clear(KEY_YELLOW); break; 1121 case 0x06d: map_key_clear(KEY_ASPECT_RATIO); break; 1122 1123 case 0x06f: map_key_clear(KEY_BRIGHTNESSUP); break; 1124 case 0x070: map_key_clear(KEY_BRIGHTNESSDOWN); break; 1125 case 0x072: map_key_clear(KEY_BRIGHTNESS_TOGGLE); break; 1126 case 0x073: map_key_clear(KEY_BRIGHTNESS_MIN); break; 1127 case 0x074: map_key_clear(KEY_BRIGHTNESS_MAX); break; 1128 case 0x075: map_key_clear(KEY_BRIGHTNESS_AUTO); break; 1129 1130 case 0x076: map_key_clear(KEY_CAMERA_ACCESS_ENABLE); break; 1131 case 0x077: map_key_clear(KEY_CAMERA_ACCESS_DISABLE); break; 1132 case 0x078: map_key_clear(KEY_CAMERA_ACCESS_TOGGLE); break; 1133 1134 case 0x079: map_key_clear(KEY_KBDILLUMUP); break; 1135 case 0x07a: map_key_clear(KEY_KBDILLUMDOWN); break; 1136 case 0x07c: map_key_clear(KEY_KBDILLUMTOGGLE); break; 1137 1138 case 0x082: map_key_clear(KEY_VIDEO_NEXT); break; 1139 case 0x083: map_key_clear(KEY_LAST); break; 1140 case 0x084: map_key_clear(KEY_ENTER); break; 1141 case 0x088: map_key_clear(KEY_PC); break; 1142 case 0x089: map_key_clear(KEY_TV); break; 1143 case 0x08a: map_key_clear(KEY_WWW); break; 1144 case 0x08b: map_key_clear(KEY_DVD); break; 1145 case 0x08c: map_key_clear(KEY_PHONE); break; 1146 case 0x08d: map_key_clear(KEY_PROGRAM); break; 1147 case 0x08e: map_key_clear(KEY_VIDEOPHONE); break; 1148 case 0x08f: map_key_clear(KEY_GAMES); break; 1149 case 0x090: map_key_clear(KEY_MEMO); break; 1150 case 0x091: map_key_clear(KEY_CD); break; 1151 case 0x092: map_key_clear(KEY_VCR); break; 1152 case 0x093: map_key_clear(KEY_TUNER); break; 1153 case 0x094: map_key_clear(KEY_EXIT); break; 1154 case 0x095: map_key_clear(KEY_HELP); break; 1155 case 0x096: map_key_clear(KEY_TAPE); break; 1156 case 0x097: map_key_clear(KEY_TV2); break; 1157 case 0x098: map_key_clear(KEY_SAT); break; 1158 case 0x09a: map_key_clear(KEY_PVR); break; 1159 1160 case 0x09c: map_key_clear(KEY_CHANNELUP); break; 1161 case 0x09d: map_key_clear(KEY_CHANNELDOWN); break; 1162 case 0x0a0: map_key_clear(KEY_VCR2); break; 1163 1164 case 0x0b0: map_key_clear(KEY_PLAY); break; 1165 case 0x0b1: map_key_clear(KEY_PAUSE); break; 1166 case 0x0b2: map_key_clear(KEY_RECORD); break; 1167 case 0x0b3: map_key_clear(KEY_FASTFORWARD); break; 1168 case 0x0b4: map_key_clear(KEY_REWIND); break; 1169 case 0x0b5: map_key_clear(KEY_NEXTSONG); break; 1170 case 0x0b6: map_key_clear(KEY_PREVIOUSSONG); break; 1171 case 0x0b7: map_key_clear(KEY_STOPCD); break; 1172 case 0x0b8: map_key_clear(KEY_EJECTCD); break; 1173 case 0x0bc: map_key_clear(KEY_MEDIA_REPEAT); break; 1174 case 0x0b9: map_key_clear(KEY_SHUFFLE); break; 1175 case 0x0bf: map_key_clear(KEY_SLOW); break; 1176 1177 case 0x0cd: map_key_clear(KEY_PLAYPAUSE); break; 1178 case 0x0cf: map_key_clear(KEY_VOICECOMMAND); break; 1179 1180 case 0x0d8: map_key_clear(KEY_DICTATE); break; 1181 case 0x0d9: map_key_clear(KEY_EMOJI_PICKER); break; 1182 1183 case 0x0e0: map_abs_clear(ABS_VOLUME); break; 1184 case 0x0e2: map_key_clear(KEY_MUTE); break; 1185 case 0x0e5: map_key_clear(KEY_BASSBOOST); break; 1186 case 0x0e9: map_key_clear(KEY_VOLUMEUP); break; 1187 case 0x0ea: map_key_clear(KEY_VOLUMEDOWN); break; 1188 case 0x0f5: map_key_clear(KEY_SLOW); break; 1189 1190 case 0x181: map_key_clear(KEY_BUTTONCONFIG); break; 1191 case 0x182: map_key_clear(KEY_BOOKMARKS); break; 1192 case 0x183: map_key_clear(KEY_CONFIG); break; 1193 case 0x184: map_key_clear(KEY_WORDPROCESSOR); break; 1194 case 0x185: map_key_clear(KEY_EDITOR); break; 1195 case 0x186: map_key_clear(KEY_SPREADSHEET); break; 1196 case 0x187: map_key_clear(KEY_GRAPHICSEDITOR); break; 1197 case 0x188: map_key_clear(KEY_PRESENTATION); break; 1198 case 0x189: map_key_clear(KEY_DATABASE); break; 1199 case 0x18a: map_key_clear(KEY_MAIL); break; 1200 case 0x18b: map_key_clear(KEY_NEWS); break; 1201 case 0x18c: map_key_clear(KEY_VOICEMAIL); break; 1202 case 0x18d: map_key_clear(KEY_ADDRESSBOOK); break; 1203 case 0x18e: map_key_clear(KEY_CALENDAR); break; 1204 case 0x18f: map_key_clear(KEY_TASKMANAGER); break; 1205 case 0x190: map_key_clear(KEY_JOURNAL); break; 1206 case 0x191: map_key_clear(KEY_FINANCE); break; 1207 case 0x192: map_key_clear(KEY_CALC); break; 1208 case 0x193: map_key_clear(KEY_PLAYER); break; 1209 case 0x194: map_key_clear(KEY_FILE); break; 1210 case 0x196: map_key_clear(KEY_WWW); break; 1211 case 0x199: map_key_clear(KEY_CHAT); break; 1212 case 0x19c: map_key_clear(KEY_LOGOFF); break; 1213 case 0x19e: map_key_clear(KEY_COFFEE); break; 1214 case 0x19f: map_key_clear(KEY_CONTROLPANEL); break; 1215 case 0x1a2: map_key_clear(KEY_APPSELECT); break; 1216 case 0x1a3: map_key_clear(KEY_NEXT); break; 1217 case 0x1a4: map_key_clear(KEY_PREVIOUS); break; 1218 case 0x1a6: map_key_clear(KEY_HELP); break; 1219 case 0x1a7: map_key_clear(KEY_DOCUMENTS); break; 1220 case 0x1ab: map_key_clear(KEY_SPELLCHECK); break; 1221 case 0x1ae: map_key_clear(KEY_KEYBOARD); break; 1222 case 0x1b1: map_key_clear(KEY_SCREENSAVER); break; 1223 case 0x1b4: map_key_clear(KEY_FILE); break; 1224 case 0x1b6: map_key_clear(KEY_IMAGES); break; 1225 case 0x1b7: map_key_clear(KEY_AUDIO); break; 1226 case 0x1b8: map_key_clear(KEY_VIDEO); break; 1227 case 0x1bc: map_key_clear(KEY_MESSENGER); break; 1228 case 0x1bd: map_key_clear(KEY_INFO); break; 1229 case 0x1cb: map_key_clear(KEY_ASSISTANT); break; 1230 case 0x1cc: map_key_clear(KEY_ACTION_ON_SELECTION); break; 1231 case 0x1cd: map_key_clear(KEY_CONTEXTUAL_INSERT); break; 1232 case 0x1ce: map_key_clear(KEY_CONTEXTUAL_QUERY); break; 1233 case 0x201: map_key_clear(KEY_NEW); break; 1234 case 0x202: map_key_clear(KEY_OPEN); break; 1235 case 0x203: map_key_clear(KEY_CLOSE); break; 1236 case 0x204: map_key_clear(KEY_EXIT); break; 1237 case 0x207: map_key_clear(KEY_SAVE); break; 1238 case 0x208: map_key_clear(KEY_PRINT); break; 1239 case 0x209: map_key_clear(KEY_PROPS); break; 1240 case 0x21a: map_key_clear(KEY_UNDO); break; 1241 case 0x21b: map_key_clear(KEY_COPY); break; 1242 case 0x21c: map_key_clear(KEY_CUT); break; 1243 case 0x21d: map_key_clear(KEY_PASTE); break; 1244 case 0x21f: map_key_clear(KEY_FIND); break; 1245 case 0x221: map_key_clear(KEY_SEARCH); break; 1246 case 0x222: map_key_clear(KEY_GOTO); break; 1247 case 0x223: map_key_clear(KEY_HOMEPAGE); break; 1248 case 0x224: map_key_clear(KEY_BACK); break; 1249 case 0x225: map_key_clear(KEY_FORWARD); break; 1250 case 0x226: map_key_clear(KEY_STOP); break; 1251 case 0x227: map_key_clear(KEY_REFRESH); break; 1252 case 0x22a: map_key_clear(KEY_BOOKMARKS); break; 1253 case 0x22d: map_key_clear(KEY_ZOOMIN); break; 1254 case 0x22e: map_key_clear(KEY_ZOOMOUT); break; 1255 case 0x22f: map_key_clear(KEY_ZOOMRESET); break; 1256 case 0x232: map_key_clear(KEY_FULL_SCREEN); break; 1257 case 0x233: map_key_clear(KEY_SCROLLUP); break; 1258 case 0x234: map_key_clear(KEY_SCROLLDOWN); break; 1259 case 0x238: /* AC Pan */ 1260 set_bit(REL_HWHEEL, input->relbit); 1261 map_rel(REL_HWHEEL_HI_RES); 1262 break; 1263 case 0x23d: map_key_clear(KEY_EDIT); break; 1264 case 0x25f: map_key_clear(KEY_CANCEL); break; 1265 case 0x269: map_key_clear(KEY_INSERT); break; 1266 case 0x26a: map_key_clear(KEY_DELETE); break; 1267 case 0x279: map_key_clear(KEY_REDO); break; 1268 1269 case 0x289: map_key_clear(KEY_REPLY); break; 1270 case 0x28b: map_key_clear(KEY_FORWARDMAIL); break; 1271 case 0x28c: map_key_clear(KEY_SEND); break; 1272 1273 case 0x29d: map_key_clear(KEY_KBD_LAYOUT_NEXT); break; 1274 1275 case 0x2a2: map_key_clear(KEY_ALL_APPLICATIONS); break; 1276 1277 case 0x2c7: map_key_clear(KEY_KBDINPUTASSIST_PREV); break; 1278 case 0x2c8: map_key_clear(KEY_KBDINPUTASSIST_NEXT); break; 1279 case 0x2c9: map_key_clear(KEY_KBDINPUTASSIST_PREVGROUP); break; 1280 case 0x2ca: map_key_clear(KEY_KBDINPUTASSIST_NEXTGROUP); break; 1281 case 0x2cb: map_key_clear(KEY_KBDINPUTASSIST_ACCEPT); break; 1282 case 0x2cc: map_key_clear(KEY_KBDINPUTASSIST_CANCEL); break; 1283 1284 case 0x29f: map_key_clear(KEY_SCALE); break; 1285 1286 default: map_key_clear(KEY_UNKNOWN); 1287 } 1288 break; 1289 1290 case HID_UP_GENDEVCTRLS: 1291 switch (usage->hid) { 1292 case HID_DC_BATTERYSTRENGTH: 1293 hidinput_setup_battery(device, HID_INPUT_REPORT, field, false); 1294 usage->type = EV_PWR; 1295 return; 1296 } 1297 goto unknown; 1298 1299 case HID_UP_BATTERY: 1300 switch (usage->hid) { 1301 case HID_BAT_ABSOLUTESTATEOFCHARGE: 1302 hidinput_setup_battery(device, HID_INPUT_REPORT, field, true); 1303 usage->type = EV_PWR; 1304 return; 1305 case HID_BAT_CHARGING: 1306 usage->type = EV_PWR; 1307 return; 1308 } 1309 goto unknown; 1310 case HID_UP_CAMERA: 1311 switch (usage->hid & HID_USAGE) { 1312 case 0x020: 1313 map_key_clear(KEY_CAMERA_FOCUS); break; 1314 case 0x021: 1315 map_key_clear(KEY_CAMERA); break; 1316 default: 1317 goto ignore; 1318 } 1319 break; 1320 1321 case HID_UP_HPVENDOR: /* Reported on a Dutch layout HP5308 */ 1322 set_bit(EV_REP, input->evbit); 1323 switch (usage->hid & HID_USAGE) { 1324 case 0x021: map_key_clear(KEY_PRINT); break; 1325 case 0x070: map_key_clear(KEY_HP); break; 1326 case 0x071: map_key_clear(KEY_CAMERA); break; 1327 case 0x072: map_key_clear(KEY_SOUND); break; 1328 case 0x073: map_key_clear(KEY_QUESTION); break; 1329 case 0x080: map_key_clear(KEY_EMAIL); break; 1330 case 0x081: map_key_clear(KEY_CHAT); break; 1331 case 0x082: map_key_clear(KEY_SEARCH); break; 1332 case 0x083: map_key_clear(KEY_CONNECT); break; 1333 case 0x084: map_key_clear(KEY_FINANCE); break; 1334 case 0x085: map_key_clear(KEY_SPORT); break; 1335 case 0x086: map_key_clear(KEY_SHOP); break; 1336 default: goto ignore; 1337 } 1338 break; 1339 1340 case HID_UP_HPVENDOR2: 1341 set_bit(EV_REP, input->evbit); 1342 switch (usage->hid & HID_USAGE) { 1343 case 0x001: map_key_clear(KEY_MICMUTE); break; 1344 case 0x003: map_key_clear(KEY_BRIGHTNESSDOWN); break; 1345 case 0x004: map_key_clear(KEY_BRIGHTNESSUP); break; 1346 default: goto ignore; 1347 } 1348 break; 1349 1350 case HID_UP_MSVENDOR: 1351 goto ignore; 1352 1353 case HID_UP_CUSTOM: /* Reported on Logitech and Apple USB keyboards */ 1354 set_bit(EV_REP, input->evbit); 1355 goto ignore; 1356 1357 case HID_UP_LOGIVENDOR: 1358 /* intentional fallback */ 1359 case HID_UP_LOGIVENDOR2: 1360 /* intentional fallback */ 1361 case HID_UP_LOGIVENDOR3: 1362 goto ignore; 1363 1364 case HID_UP_PID: 1365 switch (usage->hid & HID_USAGE) { 1366 case 0xa4: map_key_clear(BTN_DEAD); break; 1367 default: goto ignore; 1368 } 1369 break; 1370 1371 default: 1372 unknown: 1373 if (field->report_size == 1) { 1374 if (field->report->type == HID_OUTPUT_REPORT) { 1375 map_led(LED_MISC); 1376 break; 1377 } 1378 map_key(BTN_MISC); 1379 break; 1380 } 1381 if (field->flags & HID_MAIN_ITEM_RELATIVE) { 1382 map_rel(REL_MISC); 1383 break; 1384 } 1385 map_abs(ABS_MISC); 1386 break; 1387 } 1388 1389 mapped: 1390 /* Mapping failed, bail out */ 1391 if (!bit) 1392 return; 1393 1394 if (device->driver->input_mapped && 1395 device->driver->input_mapped(device, hidinput, field, usage, 1396 &bit, &max) < 0) { 1397 /* 1398 * The driver indicated that no further generic handling 1399 * of the usage is desired. 1400 */ 1401 return; 1402 } 1403 1404 set_bit(usage->type, input->evbit); 1405 1406 /* 1407 * This part is *really* controversial: 1408 * - HID aims at being generic so we should do our best to export 1409 * all incoming events 1410 * - HID describes what events are, so there is no reason for ABS_X 1411 * to be mapped to ABS_Y 1412 * - HID is using *_MISC+N as a default value, but nothing prevents 1413 * *_MISC+N to overwrite a legitimate even, which confuses userspace 1414 * (for instance ABS_MISC + 7 is ABS_MT_SLOT, which has a different 1415 * processing) 1416 * 1417 * If devices still want to use this (at their own risk), they will 1418 * have to use the quirk HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE, but 1419 * the default should be a reliable mapping. 1420 */ 1421 while (usage->code <= max && test_and_set_bit(usage->code, bit)) { 1422 if (device->quirks & HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE) { 1423 usage->code = find_next_zero_bit(bit, 1424 max + 1, 1425 usage->code); 1426 } else { 1427 device->status |= HID_STAT_DUP_DETECTED; 1428 goto ignore; 1429 } 1430 } 1431 1432 if (usage->code > max) 1433 goto ignore; 1434 1435 if (usage->type == EV_ABS) { 1436 1437 int a = field->logical_minimum; 1438 int b = field->logical_maximum; 1439 1440 if ((device->quirks & HID_QUIRK_BADPAD) && (usage->code == ABS_X || usage->code == ABS_Y)) { 1441 a = field->logical_minimum = 0; 1442 b = field->logical_maximum = 255; 1443 } 1444 1445 if (field->application == HID_GD_GAMEPAD || field->application == HID_GD_JOYSTICK) 1446 input_set_abs_params(input, usage->code, a, b, (b - a) >> 8, (b - a) >> 4); 1447 else input_set_abs_params(input, usage->code, a, b, 0, 0); 1448 1449 input_abs_set_res(input, usage->code, 1450 hidinput_calc_abs_res(field, usage->code)); 1451 1452 /* use a larger default input buffer for MT devices */ 1453 if (usage->code == ABS_MT_POSITION_X && input->hint_events_per_packet == 0) 1454 input_set_events_per_packet(input, 60); 1455 } 1456 1457 if (usage->type == EV_ABS && 1458 (usage->hat_min < usage->hat_max || usage->hat_dir)) { 1459 int i; 1460 for (i = usage->code; i < usage->code + 2 && i <= max; i++) { 1461 input_set_abs_params(input, i, -1, 1, 0, 0); 1462 set_bit(i, input->absbit); 1463 } 1464 if (usage->hat_dir && !field->dpad) 1465 field->dpad = usage->code; 1466 } 1467 1468 /* for those devices which produce Consumer volume usage as relative, 1469 * we emulate pressing volumeup/volumedown appropriate number of times 1470 * in hidinput_hid_event() 1471 */ 1472 if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) && 1473 (usage->code == ABS_VOLUME)) { 1474 set_bit(KEY_VOLUMEUP, input->keybit); 1475 set_bit(KEY_VOLUMEDOWN, input->keybit); 1476 } 1477 1478 if (usage->type == EV_KEY) { 1479 set_bit(EV_MSC, input->evbit); 1480 set_bit(MSC_SCAN, input->mscbit); 1481 } 1482 1483 return; 1484 1485 ignore: 1486 usage->type = 0; 1487 usage->code = 0; 1488 } 1489 1490 static void hidinput_handle_scroll(struct hid_usage *usage, 1491 struct input_dev *input, 1492 __s32 value) 1493 { 1494 int code; 1495 int hi_res, lo_res; 1496 1497 if (value == 0) 1498 return; 1499 1500 if (usage->code == REL_WHEEL_HI_RES) 1501 code = REL_WHEEL; 1502 else 1503 code = REL_HWHEEL; 1504 1505 /* 1506 * Windows reports one wheel click as value 120. Where a high-res 1507 * scroll wheel is present, a fraction of 120 is reported instead. 1508 * Our REL_WHEEL_HI_RES axis does the same because all HW must 1509 * adhere to the 120 expectation. 1510 */ 1511 hi_res = value * 120/usage->resolution_multiplier; 1512 1513 usage->wheel_accumulated += hi_res; 1514 lo_res = usage->wheel_accumulated/120; 1515 if (lo_res) 1516 usage->wheel_accumulated -= lo_res * 120; 1517 1518 input_event(input, EV_REL, code, lo_res); 1519 input_event(input, EV_REL, usage->code, hi_res); 1520 } 1521 1522 static void hid_report_release_tool(struct hid_report *report, struct input_dev *input, 1523 unsigned int tool) 1524 { 1525 /* if the given tool is not currently reported, ignore */ 1526 if (!test_bit(tool, input->key)) 1527 return; 1528 1529 /* 1530 * if the given tool was previously set, release it, 1531 * release any TOUCH and send an EV_SYN 1532 */ 1533 input_event(input, EV_KEY, BTN_TOUCH, 0); 1534 input_event(input, EV_KEY, tool, 0); 1535 input_event(input, EV_SYN, SYN_REPORT, 0); 1536 1537 report->tool = 0; 1538 } 1539 1540 static void hid_report_set_tool(struct hid_report *report, struct input_dev *input, 1541 unsigned int new_tool) 1542 { 1543 if (report->tool != new_tool) 1544 hid_report_release_tool(report, input, report->tool); 1545 1546 input_event(input, EV_KEY, new_tool, 1); 1547 report->tool = new_tool; 1548 } 1549 1550 void hidinput_hid_event(struct hid_device *hid, struct hid_field *field, struct hid_usage *usage, __s32 value) 1551 { 1552 struct input_dev *input; 1553 struct hid_report *report = field->report; 1554 unsigned *quirks = &hid->quirks; 1555 1556 if (!usage->type) 1557 return; 1558 1559 if (usage->type == EV_PWR) { 1560 hidinput_update_battery(hid, usage->hid, value); 1561 return; 1562 } 1563 1564 if (!field->hidinput) 1565 return; 1566 1567 input = field->hidinput->input; 1568 1569 if (usage->hat_min < usage->hat_max || usage->hat_dir) { 1570 int hat_dir = usage->hat_dir; 1571 if (!hat_dir) 1572 hat_dir = (value - usage->hat_min) * 8 / (usage->hat_max - usage->hat_min + 1) + 1; 1573 if (hat_dir < 0 || hat_dir > 8) hat_dir = 0; 1574 input_event(input, usage->type, usage->code , hid_hat_to_axis[hat_dir].x); 1575 input_event(input, usage->type, usage->code + 1, hid_hat_to_axis[hat_dir].y); 1576 return; 1577 } 1578 1579 /* 1580 * Ignore out-of-range values as per HID specification, 1581 * section 5.10 and 6.2.25, when NULL state bit is present. 1582 * When it's not, clamp the value to match Microsoft's input 1583 * driver as mentioned in "Required HID usages for digitizers": 1584 * https://msdn.microsoft.com/en-us/library/windows/hardware/dn672278(v=vs.85).asp 1585 * 1586 * The logical_minimum < logical_maximum check is done so that we 1587 * don't unintentionally discard values sent by devices which 1588 * don't specify logical min and max. 1589 */ 1590 if ((field->flags & HID_MAIN_ITEM_VARIABLE) && 1591 field->logical_minimum < field->logical_maximum) { 1592 if (field->flags & HID_MAIN_ITEM_NULL_STATE && 1593 (value < field->logical_minimum || 1594 value > field->logical_maximum)) { 1595 dbg_hid("Ignoring out-of-range value %x\n", value); 1596 return; 1597 } 1598 value = clamp(value, 1599 field->logical_minimum, 1600 field->logical_maximum); 1601 } 1602 1603 switch (usage->hid) { 1604 case HID_DG_ERASER: 1605 report->tool_active |= !!value; 1606 1607 /* 1608 * if eraser is set, we must enforce BTN_TOOL_RUBBER 1609 * to accommodate for devices not following the spec. 1610 */ 1611 if (value) 1612 hid_report_set_tool(report, input, BTN_TOOL_RUBBER); 1613 else if (report->tool != BTN_TOOL_RUBBER) 1614 /* value is off, tool is not rubber, ignore */ 1615 return; 1616 else if (*quirks & HID_QUIRK_NOINVERT && 1617 !test_bit(BTN_TOUCH, input->key)) { 1618 /* 1619 * There is no invert to release the tool, let hid_input 1620 * send BTN_TOUCH with scancode and release the tool after. 1621 */ 1622 hid_report_release_tool(report, input, BTN_TOOL_RUBBER); 1623 return; 1624 } 1625 1626 /* let hid-input set BTN_TOUCH */ 1627 break; 1628 1629 case HID_DG_INVERT: 1630 report->tool_active |= !!value; 1631 1632 /* 1633 * If invert is set, we store BTN_TOOL_RUBBER. 1634 */ 1635 if (value) 1636 hid_report_set_tool(report, input, BTN_TOOL_RUBBER); 1637 else if (!report->tool_active) 1638 /* tool_active not set means Invert and Eraser are not set */ 1639 hid_report_release_tool(report, input, BTN_TOOL_RUBBER); 1640 1641 /* no further processing */ 1642 return; 1643 1644 case HID_DG_INRANGE: 1645 report->tool_active |= !!value; 1646 1647 if (report->tool_active) { 1648 /* 1649 * if tool is not set but is marked as active, 1650 * assume ours 1651 */ 1652 if (!report->tool) 1653 report->tool = usage->code; 1654 1655 /* drivers may have changed the value behind our back, resend it */ 1656 hid_report_set_tool(report, input, report->tool); 1657 } else { 1658 hid_report_release_tool(report, input, usage->code); 1659 } 1660 1661 /* reset tool_active for the next event */ 1662 report->tool_active = false; 1663 1664 /* no further processing */ 1665 return; 1666 1667 case HID_DG_TIPSWITCH: 1668 report->tool_active |= !!value; 1669 1670 /* if tool is set to RUBBER we should ignore the current value */ 1671 if (report->tool == BTN_TOOL_RUBBER) 1672 return; 1673 1674 break; 1675 1676 case HID_DG_TIPPRESSURE: 1677 if (*quirks & HID_QUIRK_NOTOUCH) { 1678 int a = field->logical_minimum; 1679 int b = field->logical_maximum; 1680 1681 if (value > a + ((b - a) >> 3)) { 1682 input_event(input, EV_KEY, BTN_TOUCH, 1); 1683 report->tool_active = true; 1684 } 1685 } 1686 break; 1687 1688 case HID_UP_PID | 0x83UL: /* Simultaneous Effects Max */ 1689 dbg_hid("Maximum Effects - %d\n",value); 1690 return; 1691 1692 case HID_UP_PID | 0x7fUL: 1693 dbg_hid("PID Pool Report\n"); 1694 return; 1695 } 1696 1697 switch (usage->type) { 1698 case EV_KEY: 1699 if (usage->code == 0) /* Key 0 is "unassigned", not KEY_UNKNOWN */ 1700 return; 1701 break; 1702 1703 case EV_REL: 1704 if (usage->code == REL_WHEEL_HI_RES || 1705 usage->code == REL_HWHEEL_HI_RES) { 1706 hidinput_handle_scroll(usage, input, value); 1707 return; 1708 } 1709 break; 1710 1711 case EV_ABS: 1712 if ((field->flags & HID_MAIN_ITEM_RELATIVE) && 1713 usage->code == ABS_VOLUME) { 1714 int count = abs(value); 1715 int direction = value > 0 ? KEY_VOLUMEUP : KEY_VOLUMEDOWN; 1716 int i; 1717 1718 for (i = 0; i < count; i++) { 1719 input_event(input, EV_KEY, direction, 1); 1720 input_sync(input); 1721 input_event(input, EV_KEY, direction, 0); 1722 input_sync(input); 1723 } 1724 return; 1725 1726 } else if (((*quirks & HID_QUIRK_X_INVERT) && usage->code == ABS_X) || 1727 ((*quirks & HID_QUIRK_Y_INVERT) && usage->code == ABS_Y)) 1728 value = field->logical_maximum - value; 1729 break; 1730 } 1731 1732 /* 1733 * Ignore reports for absolute data if the data didn't change. This is 1734 * not only an optimization but also fixes 'dead' key reports. Some 1735 * RollOver implementations for localized keys (like BACKSLASH/PIPE; HID 1736 * 0x31 and 0x32) report multiple keys, even though a localized keyboard 1737 * can only have one of them physically available. The 'dead' keys 1738 * report constant 0. As all map to the same keycode, they'd confuse 1739 * the input layer. If we filter the 'dead' keys on the HID level, we 1740 * skip the keycode translation and only forward real events. 1741 */ 1742 if (!(field->flags & (HID_MAIN_ITEM_RELATIVE | 1743 HID_MAIN_ITEM_BUFFERED_BYTE)) && 1744 (field->flags & HID_MAIN_ITEM_VARIABLE) && 1745 usage->usage_index < field->maxusage && 1746 value == field->value[usage->usage_index]) 1747 return; 1748 1749 /* report the usage code as scancode if the key status has changed */ 1750 if (usage->type == EV_KEY && 1751 (!test_bit(usage->code, input->key)) == value) 1752 input_event(input, EV_MSC, MSC_SCAN, usage->hid); 1753 1754 input_event(input, usage->type, usage->code, value); 1755 1756 if ((field->flags & HID_MAIN_ITEM_RELATIVE) && 1757 usage->type == EV_KEY && value) { 1758 input_sync(input); 1759 input_event(input, usage->type, usage->code, 0); 1760 } 1761 } 1762 1763 void hidinput_report_event(struct hid_device *hid, struct hid_report *report) 1764 { 1765 struct hid_input *hidinput; 1766 1767 if (hid->quirks & HID_QUIRK_NO_INPUT_SYNC) 1768 return; 1769 1770 list_for_each_entry(hidinput, &hid->inputs, list) 1771 input_sync(hidinput->input); 1772 } 1773 EXPORT_SYMBOL_GPL(hidinput_report_event); 1774 1775 static int hidinput_find_field(struct hid_device *hid, unsigned int type, 1776 unsigned int code, struct hid_field **field) 1777 { 1778 struct hid_report *report; 1779 int i, j; 1780 1781 list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) { 1782 for (i = 0; i < report->maxfield; i++) { 1783 *field = report->field[i]; 1784 for (j = 0; j < (*field)->maxusage; j++) 1785 if ((*field)->usage[j].type == type && (*field)->usage[j].code == code) 1786 return j; 1787 } 1788 } 1789 return -1; 1790 } 1791 1792 struct hid_field *hidinput_get_led_field(struct hid_device *hid) 1793 { 1794 struct hid_report *report; 1795 struct hid_field *field; 1796 int i, j; 1797 1798 list_for_each_entry(report, 1799 &hid->report_enum[HID_OUTPUT_REPORT].report_list, 1800 list) { 1801 for (i = 0; i < report->maxfield; i++) { 1802 field = report->field[i]; 1803 for (j = 0; j < field->maxusage; j++) 1804 if (field->usage[j].type == EV_LED) 1805 return field; 1806 } 1807 } 1808 return NULL; 1809 } 1810 EXPORT_SYMBOL_GPL(hidinput_get_led_field); 1811 1812 unsigned int hidinput_count_leds(struct hid_device *hid) 1813 { 1814 struct hid_report *report; 1815 struct hid_field *field; 1816 int i, j; 1817 unsigned int count = 0; 1818 1819 list_for_each_entry(report, 1820 &hid->report_enum[HID_OUTPUT_REPORT].report_list, 1821 list) { 1822 for (i = 0; i < report->maxfield; i++) { 1823 field = report->field[i]; 1824 for (j = 0; j < field->maxusage; j++) 1825 if (field->usage[j].type == EV_LED && 1826 field->value[j]) 1827 count += 1; 1828 } 1829 } 1830 return count; 1831 } 1832 EXPORT_SYMBOL_GPL(hidinput_count_leds); 1833 1834 static void hidinput_led_worker(struct work_struct *work) 1835 { 1836 struct hid_device *hid = container_of(work, struct hid_device, 1837 led_work); 1838 struct hid_field *field; 1839 struct hid_report *report; 1840 int ret; 1841 u32 len; 1842 __u8 *buf; 1843 1844 field = hidinput_get_led_field(hid); 1845 if (!field) 1846 return; 1847 1848 /* 1849 * field->report is accessed unlocked regarding HID core. So there might 1850 * be another incoming SET-LED request from user-space, which changes 1851 * the LED state while we assemble our outgoing buffer. However, this 1852 * doesn't matter as hid_output_report() correctly converts it into a 1853 * boolean value no matter what information is currently set on the LED 1854 * field (even garbage). So the remote device will always get a valid 1855 * request. 1856 * And in case we send a wrong value, a next led worker is spawned 1857 * for every SET-LED request so the following worker will send the 1858 * correct value, guaranteed! 1859 */ 1860 1861 report = field->report; 1862 1863 /* use custom SET_REPORT request if possible (asynchronous) */ 1864 if (hid->ll_driver->request) 1865 return hid->ll_driver->request(hid, report, HID_REQ_SET_REPORT); 1866 1867 /* fall back to generic raw-output-report */ 1868 len = hid_report_len(report); 1869 buf = hid_alloc_report_buf(report, GFP_KERNEL); 1870 if (!buf) 1871 return; 1872 1873 hid_output_report(report, buf); 1874 /* synchronous output report */ 1875 ret = hid_hw_output_report(hid, buf, len); 1876 if (ret == -ENOSYS) 1877 hid_hw_raw_request(hid, report->id, buf, len, HID_OUTPUT_REPORT, 1878 HID_REQ_SET_REPORT); 1879 kfree(buf); 1880 } 1881 1882 static int hidinput_input_event(struct input_dev *dev, unsigned int type, 1883 unsigned int code, int value) 1884 { 1885 struct hid_device *hid = input_get_drvdata(dev); 1886 struct hid_field *field; 1887 int offset; 1888 1889 if (type == EV_FF) 1890 return input_ff_event(dev, type, code, value); 1891 1892 if (type != EV_LED) 1893 return -1; 1894 1895 if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) { 1896 hid_warn(dev, "event field not found\n"); 1897 return -1; 1898 } 1899 1900 hid_set_field(field, offset, value); 1901 1902 schedule_work(&hid->led_work); 1903 return 0; 1904 } 1905 1906 static int hidinput_open(struct input_dev *dev) 1907 { 1908 struct hid_device *hid = input_get_drvdata(dev); 1909 1910 return hid_hw_open(hid); 1911 } 1912 1913 static void hidinput_close(struct input_dev *dev) 1914 { 1915 struct hid_device *hid = input_get_drvdata(dev); 1916 1917 hid_hw_close(hid); 1918 } 1919 1920 static bool __hidinput_change_resolution_multipliers(struct hid_device *hid, 1921 struct hid_report *report, bool use_logical_max) 1922 { 1923 struct hid_usage *usage; 1924 bool update_needed = false; 1925 bool get_report_completed = false; 1926 int i, j; 1927 1928 if (report->maxfield == 0) 1929 return false; 1930 1931 for (i = 0; i < report->maxfield; i++) { 1932 __s32 value = use_logical_max ? 1933 report->field[i]->logical_maximum : 1934 report->field[i]->logical_minimum; 1935 1936 /* There is no good reason for a Resolution 1937 * Multiplier to have a count other than 1. 1938 * Ignore that case. 1939 */ 1940 if (report->field[i]->report_count != 1) 1941 continue; 1942 1943 for (j = 0; j < report->field[i]->maxusage; j++) { 1944 usage = &report->field[i]->usage[j]; 1945 1946 if (usage->hid != HID_GD_RESOLUTION_MULTIPLIER) 1947 continue; 1948 1949 /* 1950 * If we have more than one feature within this 1951 * report we need to fill in the bits from the 1952 * others before we can overwrite the ones for the 1953 * Resolution Multiplier. 1954 * 1955 * But if we're not allowed to read from the device, 1956 * we just bail. Such a device should not exist 1957 * anyway. 1958 */ 1959 if (!get_report_completed && report->maxfield > 1) { 1960 if (hid->quirks & HID_QUIRK_NO_INIT_REPORTS) 1961 return update_needed; 1962 1963 hid_hw_request(hid, report, HID_REQ_GET_REPORT); 1964 hid_hw_wait(hid); 1965 get_report_completed = true; 1966 } 1967 1968 report->field[i]->value[j] = value; 1969 update_needed = true; 1970 } 1971 } 1972 1973 return update_needed; 1974 } 1975 1976 static void hidinput_change_resolution_multipliers(struct hid_device *hid) 1977 { 1978 struct hid_report_enum *rep_enum; 1979 struct hid_report *rep; 1980 int ret; 1981 1982 rep_enum = &hid->report_enum[HID_FEATURE_REPORT]; 1983 list_for_each_entry(rep, &rep_enum->report_list, list) { 1984 bool update_needed = __hidinput_change_resolution_multipliers(hid, 1985 rep, true); 1986 1987 if (update_needed) { 1988 ret = __hid_request(hid, rep, HID_REQ_SET_REPORT); 1989 if (ret) { 1990 __hidinput_change_resolution_multipliers(hid, 1991 rep, false); 1992 return; 1993 } 1994 } 1995 } 1996 1997 /* refresh our structs */ 1998 hid_setup_resolution_multiplier(hid); 1999 } 2000 2001 static void report_features(struct hid_device *hid) 2002 { 2003 struct hid_driver *drv = hid->driver; 2004 struct hid_report_enum *rep_enum; 2005 struct hid_report *rep; 2006 struct hid_usage *usage; 2007 int i, j; 2008 2009 rep_enum = &hid->report_enum[HID_FEATURE_REPORT]; 2010 list_for_each_entry(rep, &rep_enum->report_list, list) 2011 for (i = 0; i < rep->maxfield; i++) { 2012 /* Ignore if report count is out of bounds. */ 2013 if (rep->field[i]->report_count < 1) 2014 continue; 2015 2016 for (j = 0; j < rep->field[i]->maxusage; j++) { 2017 usage = &rep->field[i]->usage[j]; 2018 2019 /* Verify if Battery Strength feature is available */ 2020 if (usage->hid == HID_DC_BATTERYSTRENGTH) 2021 hidinput_setup_battery(hid, HID_FEATURE_REPORT, 2022 rep->field[i], false); 2023 2024 if (drv->feature_mapping) 2025 drv->feature_mapping(hid, rep->field[i], usage); 2026 } 2027 } 2028 } 2029 2030 static struct hid_input *hidinput_allocate(struct hid_device *hid, 2031 unsigned int application) 2032 { 2033 struct hid_input *hidinput = kzalloc_obj(*hidinput); 2034 struct input_dev *input_dev = input_allocate_device(); 2035 const char *suffix = NULL; 2036 size_t suffix_len, name_len; 2037 2038 if (!hidinput || !input_dev) 2039 goto fail; 2040 2041 if ((hid->quirks & HID_QUIRK_INPUT_PER_APP) && 2042 hid->maxapplication > 1) { 2043 switch (application) { 2044 case HID_GD_KEYBOARD: 2045 suffix = "Keyboard"; 2046 break; 2047 case HID_GD_KEYPAD: 2048 suffix = "Keypad"; 2049 break; 2050 case HID_GD_MOUSE: 2051 suffix = "Mouse"; 2052 break; 2053 case HID_DG_PEN: 2054 /* 2055 * yes, there is an issue here: 2056 * DG_PEN -> "Stylus" 2057 * DG_STYLUS -> "Pen" 2058 * But changing this now means users with config snippets 2059 * will have to change it and the test suite will not be happy. 2060 */ 2061 suffix = "Stylus"; 2062 break; 2063 case HID_DG_STYLUS: 2064 suffix = "Pen"; 2065 break; 2066 case HID_DG_TOUCHSCREEN: 2067 suffix = "Touchscreen"; 2068 break; 2069 case HID_DG_TOUCHPAD: 2070 suffix = "Touchpad"; 2071 break; 2072 case HID_GD_SYSTEM_CONTROL: 2073 suffix = "System Control"; 2074 break; 2075 case HID_CP_CONSUMER_CONTROL: 2076 suffix = "Consumer Control"; 2077 break; 2078 case HID_GD_WIRELESS_RADIO_CTLS: 2079 suffix = "Wireless Radio Control"; 2080 break; 2081 case HID_GD_SYSTEM_MULTIAXIS: 2082 suffix = "System Multi Axis"; 2083 break; 2084 default: 2085 break; 2086 } 2087 } 2088 2089 if (suffix) { 2090 name_len = strlen(hid->name); 2091 suffix_len = strlen(suffix); 2092 if ((name_len < suffix_len) || 2093 strcmp(hid->name + name_len - suffix_len, suffix)) { 2094 hidinput->name = kasprintf(GFP_KERNEL, "%s %s", 2095 hid->name, suffix); 2096 if (!hidinput->name) 2097 goto fail; 2098 } 2099 } 2100 2101 input_set_drvdata(input_dev, hid); 2102 input_dev->event = hidinput_input_event; 2103 input_dev->open = hidinput_open; 2104 input_dev->close = hidinput_close; 2105 input_dev->setkeycode = hidinput_setkeycode; 2106 input_dev->getkeycode = hidinput_getkeycode; 2107 2108 input_dev->name = hidinput->name ? hidinput->name : hid->name; 2109 input_dev->phys = hid->phys; 2110 input_dev->uniq = hid->uniq; 2111 input_dev->id.bustype = hid->bus; 2112 input_dev->id.vendor = hid->vendor; 2113 input_dev->id.product = hid->product; 2114 input_dev->id.version = hid->version; 2115 input_dev->dev.parent = &hid->dev; 2116 2117 hidinput->input = input_dev; 2118 hidinput->application = application; 2119 list_add_tail(&hidinput->list, &hid->inputs); 2120 2121 INIT_LIST_HEAD(&hidinput->reports); 2122 2123 return hidinput; 2124 2125 fail: 2126 kfree(hidinput); 2127 input_free_device(input_dev); 2128 hid_err(hid, "Out of memory during hid input probe\n"); 2129 return NULL; 2130 } 2131 2132 static bool hidinput_has_been_populated(struct hid_input *hidinput) 2133 { 2134 int i; 2135 unsigned long r = 0; 2136 2137 for (i = 0; i < BITS_TO_LONGS(EV_CNT); i++) 2138 r |= hidinput->input->evbit[i]; 2139 2140 for (i = 0; i < BITS_TO_LONGS(KEY_CNT); i++) 2141 r |= hidinput->input->keybit[i]; 2142 2143 for (i = 0; i < BITS_TO_LONGS(REL_CNT); i++) 2144 r |= hidinput->input->relbit[i]; 2145 2146 for (i = 0; i < BITS_TO_LONGS(ABS_CNT); i++) 2147 r |= hidinput->input->absbit[i]; 2148 2149 for (i = 0; i < BITS_TO_LONGS(MSC_CNT); i++) 2150 r |= hidinput->input->mscbit[i]; 2151 2152 for (i = 0; i < BITS_TO_LONGS(LED_CNT); i++) 2153 r |= hidinput->input->ledbit[i]; 2154 2155 for (i = 0; i < BITS_TO_LONGS(SND_CNT); i++) 2156 r |= hidinput->input->sndbit[i]; 2157 2158 for (i = 0; i < BITS_TO_LONGS(FF_CNT); i++) 2159 r |= hidinput->input->ffbit[i]; 2160 2161 for (i = 0; i < BITS_TO_LONGS(SW_CNT); i++) 2162 r |= hidinput->input->swbit[i]; 2163 2164 return !!r; 2165 } 2166 2167 static void hidinput_cleanup_hidinput(struct hid_device *hid, 2168 struct hid_input *hidinput) 2169 { 2170 struct hid_report *report; 2171 int i, k; 2172 2173 list_del(&hidinput->list); 2174 input_free_device(hidinput->input); 2175 kfree(hidinput->name); 2176 2177 for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) { 2178 if (k == HID_OUTPUT_REPORT && 2179 hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS) 2180 continue; 2181 2182 list_for_each_entry(report, &hid->report_enum[k].report_list, 2183 list) { 2184 2185 for (i = 0; i < report->maxfield; i++) 2186 if (report->field[i]->hidinput == hidinput) 2187 report->field[i]->hidinput = NULL; 2188 } 2189 } 2190 2191 kfree(hidinput); 2192 } 2193 2194 static struct hid_input *hidinput_match(struct hid_report *report) 2195 { 2196 struct hid_device *hid = report->device; 2197 struct hid_input *hidinput; 2198 2199 list_for_each_entry(hidinput, &hid->inputs, list) { 2200 if (hidinput->report && 2201 hidinput->report->id == report->id) 2202 return hidinput; 2203 } 2204 2205 return NULL; 2206 } 2207 2208 static struct hid_input *hidinput_match_application(struct hid_report *report) 2209 { 2210 struct hid_device *hid = report->device; 2211 struct hid_input *hidinput; 2212 2213 list_for_each_entry(hidinput, &hid->inputs, list) { 2214 if (hidinput->application == report->application) 2215 return hidinput; 2216 2217 /* 2218 * Keep SystemControl and ConsumerControl applications together 2219 * with the main keyboard, if present. 2220 */ 2221 if ((report->application == HID_GD_SYSTEM_CONTROL || 2222 report->application == HID_CP_CONSUMER_CONTROL) && 2223 hidinput->application == HID_GD_KEYBOARD) { 2224 return hidinput; 2225 } 2226 } 2227 2228 return NULL; 2229 } 2230 2231 static inline void hidinput_configure_usages(struct hid_input *hidinput, 2232 struct hid_report *report) 2233 { 2234 int i, j, k; 2235 int first_field_index = 0; 2236 int slot_collection_index = -1; 2237 int prev_collection_index = -1; 2238 unsigned int slot_idx = 0; 2239 struct hid_field *field; 2240 2241 /* 2242 * First tag all the fields that are part of a slot, 2243 * a slot needs to have one Contact ID in the collection 2244 */ 2245 for (i = 0; i < report->maxfield; i++) { 2246 field = report->field[i]; 2247 2248 /* ignore fields without usage */ 2249 if (field->maxusage < 1) 2250 continue; 2251 2252 /* 2253 * janitoring when collection_index changes 2254 */ 2255 if (prev_collection_index != field->usage->collection_index) { 2256 prev_collection_index = field->usage->collection_index; 2257 first_field_index = i; 2258 } 2259 2260 /* 2261 * if we already found a Contact ID in the collection, 2262 * tag and continue to the next. 2263 */ 2264 if (slot_collection_index == field->usage->collection_index) { 2265 field->slot_idx = slot_idx; 2266 continue; 2267 } 2268 2269 /* check if the current field has Contact ID */ 2270 for (j = 0; j < field->maxusage; j++) { 2271 if (field->usage[j].hid == HID_DG_CONTACTID) { 2272 slot_collection_index = field->usage->collection_index; 2273 slot_idx++; 2274 2275 /* 2276 * mark all previous fields and this one in the 2277 * current collection to be slotted. 2278 */ 2279 for (k = first_field_index; k <= i; k++) 2280 report->field[k]->slot_idx = slot_idx; 2281 break; 2282 } 2283 } 2284 } 2285 2286 for (i = 0; i < report->maxfield; i++) 2287 for (j = 0; j < report->field[i]->maxusage; j++) 2288 hidinput_configure_usage(hidinput, report->field[i], 2289 report->field[i]->usage + j, 2290 j); 2291 } 2292 2293 /* 2294 * Register the input device; print a message. 2295 * Configure the input layer interface 2296 * Read all reports and initialize the absolute field values. 2297 */ 2298 2299 int hidinput_connect(struct hid_device *hid, unsigned int force) 2300 { 2301 struct hid_driver *drv = hid->driver; 2302 struct hid_report *report; 2303 struct hid_input *next, *hidinput = NULL; 2304 unsigned int application; 2305 int i, k; 2306 2307 INIT_LIST_HEAD(&hid->inputs); 2308 INIT_WORK(&hid->led_work, hidinput_led_worker); 2309 2310 hid->status &= ~HID_STAT_DUP_DETECTED; 2311 2312 if (!force) { 2313 for (i = 0; i < hid->maxcollection; i++) { 2314 struct hid_collection *col = &hid->collection[i]; 2315 if (col->type == HID_COLLECTION_APPLICATION || 2316 col->type == HID_COLLECTION_PHYSICAL) 2317 if (IS_INPUT_APPLICATION(col->usage)) 2318 break; 2319 } 2320 2321 if (i == hid->maxcollection) 2322 return -1; 2323 } 2324 2325 report_features(hid); 2326 2327 for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) { 2328 if (k == HID_OUTPUT_REPORT && 2329 hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS) 2330 continue; 2331 2332 list_for_each_entry(report, &hid->report_enum[k].report_list, list) { 2333 2334 if (!report->maxfield) 2335 continue; 2336 2337 application = report->application; 2338 2339 /* 2340 * Find the previous hidinput report attached 2341 * to this report id. 2342 */ 2343 if (hid->quirks & HID_QUIRK_MULTI_INPUT) 2344 hidinput = hidinput_match(report); 2345 else if (hid->maxapplication > 1 && 2346 (hid->quirks & HID_QUIRK_INPUT_PER_APP)) 2347 hidinput = hidinput_match_application(report); 2348 2349 if (!hidinput) { 2350 hidinput = hidinput_allocate(hid, application); 2351 if (!hidinput) 2352 goto out_unwind; 2353 } 2354 2355 hidinput_configure_usages(hidinput, report); 2356 2357 if (hid->quirks & HID_QUIRK_MULTI_INPUT) 2358 hidinput->report = report; 2359 2360 list_add_tail(&report->hidinput_list, 2361 &hidinput->reports); 2362 } 2363 } 2364 2365 hidinput_change_resolution_multipliers(hid); 2366 2367 list_for_each_entry_safe(hidinput, next, &hid->inputs, list) { 2368 if (drv->input_configured && 2369 drv->input_configured(hid, hidinput)) 2370 goto out_unwind; 2371 2372 if (!hidinput_has_been_populated(hidinput)) { 2373 /* no need to register an input device not populated */ 2374 hidinput_cleanup_hidinput(hid, hidinput); 2375 continue; 2376 } 2377 2378 if (input_register_device(hidinput->input)) 2379 goto out_unwind; 2380 hidinput->registered = true; 2381 } 2382 2383 if (list_empty(&hid->inputs)) { 2384 hid_dbg(hid, "No inputs registered, leaving\n"); 2385 goto out_unwind; 2386 } 2387 2388 if (hid->status & HID_STAT_DUP_DETECTED) 2389 hid_dbg(hid, 2390 "Some usages could not be mapped, please use HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE if this is legitimate.\n"); 2391 2392 return 0; 2393 2394 out_unwind: 2395 /* unwind the ones we already registered */ 2396 hidinput_disconnect(hid); 2397 2398 return -1; 2399 } 2400 EXPORT_SYMBOL_GPL(hidinput_connect); 2401 2402 void hidinput_disconnect(struct hid_device *hid) 2403 { 2404 struct hid_input *hidinput, *next; 2405 2406 hidinput_cleanup_battery(hid); 2407 2408 list_for_each_entry_safe(hidinput, next, &hid->inputs, list) { 2409 list_del(&hidinput->list); 2410 if (hidinput->registered) 2411 input_unregister_device(hidinput->input); 2412 else 2413 input_free_device(hidinput->input); 2414 kfree(hidinput->name); 2415 kfree(hidinput); 2416 } 2417 2418 /* led_work is spawned by input_dev callbacks, but doesn't access the 2419 * parent input_dev at all. Once all input devices are removed, we 2420 * know that led_work will never get restarted, so we can cancel it 2421 * synchronously and are safe. */ 2422 cancel_work_sync(&hid->led_work); 2423 } 2424 EXPORT_SYMBOL_GPL(hidinput_disconnect); 2425 2426 void hidinput_reset_resume(struct hid_device *hid) 2427 { 2428 /* renegotiate host-device shared state after reset */ 2429 hidinput_change_resolution_multipliers(hid); 2430 } 2431 EXPORT_SYMBOL_GPL(hidinput_reset_resume); 2432 2433 #ifdef CONFIG_HID_KUNIT_TEST 2434 #include "hid-input-test.c" 2435 #endif 2436