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