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