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