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}, { .x: 0,.y: -1}, { .x: 1,.y: -1}, { .x: 1, .y: 0}, { .x: 1, .y: 1}, { .x: 0, .y: 1}, {.x: -1, .y: 1}, {.x: -1, .y: 0}, {.x: -1,.y: -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: match_index, value: ke->index, usage_idx: index);
169 else if (input_scancode_to_scalar(ke, scancode: &scancode) == 0)
170 usage = hidinput_find_key(hid, match: match_scancode, value: scancode, usage_idx: 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: &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(to: ke->scancode, from: &scancode, len: 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(nr: *old_keycode, addr: dev->keybit);
213 set_bit(nr: usage->code, addr: 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: match_keycode, value: *old_keycode, NULL))
222 set_bit(nr: *old_keycode, addr: dev->keybit);
223
224 return 0;
225 }
226
227 return -EINVAL;
228}
229
230
231/**
232 * hidinput_calc_abs_res - calculate an absolute axis resolution
233 * @field: the HID report field to calculate resolution for
234 * @code: axis code
235 *
236 * The formula is:
237 * (logical_maximum - logical_minimum)
238 * resolution = ----------------------------------------------------------
239 * (physical_maximum - physical_minimum) * 10 ^ unit_exponent
240 *
241 * as seen in the HID specification v1.11 6.2.2.7 Global Items.
242 *
243 * Only exponent 1 length units are processed. Centimeters and inches are
244 * converted to millimeters. Degrees are converted to radians.
245 */
246__s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code)
247{
248 __s32 unit_exponent = field->unit_exponent;
249 __s32 logical_extents = field->logical_maximum -
250 field->logical_minimum;
251 __s32 physical_extents = field->physical_maximum -
252 field->physical_minimum;
253 __s32 prev;
254
255 /* Check if the extents are sane */
256 if (logical_extents <= 0 || physical_extents <= 0)
257 return 0;
258
259 /*
260 * Verify and convert units.
261 * See HID specification v1.11 6.2.2.7 Global Items for unit decoding
262 */
263 switch (code) {
264 case ABS_X:
265 case ABS_Y:
266 case ABS_Z:
267 case ABS_MT_POSITION_X:
268 case ABS_MT_POSITION_Y:
269 case ABS_MT_TOOL_X:
270 case ABS_MT_TOOL_Y:
271 case ABS_MT_TOUCH_MAJOR:
272 case ABS_MT_TOUCH_MINOR:
273 if (field->unit == 0x11) { /* If centimeters */
274 /* Convert to millimeters */
275 unit_exponent += 1;
276 } else if (field->unit == 0x13) { /* If inches */
277 /* Convert to millimeters */
278 prev = physical_extents;
279 physical_extents *= 254;
280 if (physical_extents < prev)
281 return 0;
282 unit_exponent -= 1;
283 } else {
284 return 0;
285 }
286 break;
287
288 case ABS_RX:
289 case ABS_RY:
290 case ABS_RZ:
291 case ABS_WHEEL:
292 case ABS_TILT_X:
293 case ABS_TILT_Y:
294 if (field->unit == 0x14) { /* If degrees */
295 /* Convert to radians */
296 prev = logical_extents;
297 logical_extents *= 573;
298 if (logical_extents < prev)
299 return 0;
300 unit_exponent += 1;
301 } else if (field->unit != 0x12) { /* If not radians */
302 return 0;
303 }
304 break;
305
306 case ABS_PRESSURE:
307 case ABS_MT_PRESSURE:
308 if (field->unit == HID_UNIT_NEWTON) {
309 /* Convert to grams, 1 newton is 101.97 grams */
310 prev = physical_extents;
311 physical_extents *= 10197;
312 if (physical_extents < prev)
313 return 0;
314 unit_exponent -= 2;
315 } else if (field->unit != HID_UNIT_GRAM) {
316 return 0;
317 }
318 break;
319 default:
320 return 0;
321 }
322
323 /* Apply negative unit exponent */
324 for (; unit_exponent < 0; unit_exponent++) {
325 prev = logical_extents;
326 logical_extents *= 10;
327 if (logical_extents < prev)
328 return 0;
329 }
330 /* Apply positive unit exponent */
331 for (; unit_exponent > 0; unit_exponent--) {
332 prev = physical_extents;
333 physical_extents *= 10;
334 if (physical_extents < prev)
335 return 0;
336 }
337
338 /* Calculate resolution */
339 return DIV_ROUND_CLOSEST(logical_extents, physical_extents);
340}
341EXPORT_SYMBOL_GPL(hidinput_calc_abs_res);
342
343#ifdef CONFIG_HID_BATTERY_STRENGTH
344static enum power_supply_property hidinput_battery_props[] = {
345 POWER_SUPPLY_PROP_PRESENT,
346 POWER_SUPPLY_PROP_ONLINE,
347 POWER_SUPPLY_PROP_CAPACITY,
348 POWER_SUPPLY_PROP_MODEL_NAME,
349 POWER_SUPPLY_PROP_STATUS,
350 POWER_SUPPLY_PROP_SCOPE,
351};
352
353#define HID_BATTERY_QUIRK_PERCENT (1 << 0) /* always reports percent */
354#define HID_BATTERY_QUIRK_FEATURE (1 << 1) /* ask for feature report */
355#define HID_BATTERY_QUIRK_IGNORE (1 << 2) /* completely ignore the battery */
356#define HID_BATTERY_QUIRK_AVOID_QUERY (1 << 3) /* do not query the battery */
357
358static const struct hid_device_id hid_battery_quirks[] = {
359 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
360 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO),
361 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
362 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
363 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI),
364 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
365 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
366 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ANSI),
367 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
368 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
369 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ISO),
370 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
371 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
372 USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI),
373 HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
374 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
375 USB_DEVICE_ID_APPLE_MAGICTRACKPAD),
376 HID_BATTERY_QUIRK_IGNORE },
377 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_ELECOM,
378 USB_DEVICE_ID_ELECOM_BM084),
379 HID_BATTERY_QUIRK_IGNORE },
380 { HID_USB_DEVICE(USB_VENDOR_ID_SYMBOL,
381 USB_DEVICE_ID_SYMBOL_SCANNER_3),
382 HID_BATTERY_QUIRK_IGNORE },
383 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_ASUSTEK,
384 USB_DEVICE_ID_ASUSTEK_T100CHI_KEYBOARD),
385 HID_BATTERY_QUIRK_IGNORE },
386 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_LOGITECH,
387 USB_DEVICE_ID_LOGITECH_DINOVO_EDGE_KBD),
388 HID_BATTERY_QUIRK_IGNORE },
389 { HID_USB_DEVICE(USB_VENDOR_ID_ELAN, USB_DEVICE_ID_ASUS_UX550_TOUCHSCREEN),
390 HID_BATTERY_QUIRK_IGNORE },
391 { HID_USB_DEVICE(USB_VENDOR_ID_ELAN, USB_DEVICE_ID_ASUS_UX550VE_TOUCHSCREEN),
392 HID_BATTERY_QUIRK_IGNORE },
393 { HID_USB_DEVICE(USB_VENDOR_ID_UGEE, USB_DEVICE_ID_UGEE_XPPEN_TABLET_DECO_L),
394 HID_BATTERY_QUIRK_AVOID_QUERY },
395 { HID_USB_DEVICE(USB_VENDOR_ID_UGEE, USB_DEVICE_ID_UGEE_XPPEN_TABLET_DECO_PRO_MW),
396 HID_BATTERY_QUIRK_AVOID_QUERY },
397 { HID_USB_DEVICE(USB_VENDOR_ID_UGEE, USB_DEVICE_ID_UGEE_XPPEN_TABLET_DECO_PRO_SW),
398 HID_BATTERY_QUIRK_AVOID_QUERY },
399 { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, I2C_DEVICE_ID_CHROMEBOOK_TROGDOR_POMPOM),
400 HID_BATTERY_QUIRK_AVOID_QUERY },
401 /*
402 * Elan I2C-HID touchscreens seem to all report a non present battery,
403 * set HID_BATTERY_QUIRK_IGNORE for all Elan I2C-HID devices.
404 */
405 { HID_I2C_DEVICE(USB_VENDOR_ID_ELAN, HID_ANY_ID), HID_BATTERY_QUIRK_IGNORE },
406 {}
407};
408
409static unsigned find_battery_quirk(struct hid_device *hdev)
410{
411 unsigned quirks = 0;
412 const struct hid_device_id *match;
413
414 match = hid_match_id(hdev, hid_battery_quirks);
415 if (match != NULL)
416 quirks = match->driver_data;
417
418 return quirks;
419}
420
421static int hidinput_scale_battery_capacity(struct hid_device *dev,
422 int value)
423{
424 if (dev->battery_min < dev->battery_max &&
425 value >= dev->battery_min && value <= dev->battery_max)
426 value = ((value - dev->battery_min) * 100) /
427 (dev->battery_max - dev->battery_min);
428
429 return value;
430}
431
432static int hidinput_query_battery_capacity(struct hid_device *dev)
433{
434 u8 *buf;
435 int ret;
436
437 buf = kmalloc(4, GFP_KERNEL);
438 if (!buf)
439 return -ENOMEM;
440
441 ret = hid_hw_raw_request(dev, dev->battery_report_id, buf, 4,
442 dev->battery_report_type, HID_REQ_GET_REPORT);
443 if (ret < 2) {
444 kfree(buf);
445 return -ENODATA;
446 }
447
448 ret = hidinput_scale_battery_capacity(dev, buf[1]);
449 kfree(buf);
450 return ret;
451}
452
453static int hidinput_get_battery_property(struct power_supply *psy,
454 enum power_supply_property prop,
455 union power_supply_propval *val)
456{
457 struct hid_device *dev = power_supply_get_drvdata(psy);
458 int value;
459 int ret = 0;
460
461 switch (prop) {
462 case POWER_SUPPLY_PROP_PRESENT:
463 case POWER_SUPPLY_PROP_ONLINE:
464 val->intval = 1;
465 break;
466
467 case POWER_SUPPLY_PROP_CAPACITY:
468 if (dev->battery_status != HID_BATTERY_REPORTED &&
469 !dev->battery_avoid_query) {
470 value = hidinput_query_battery_capacity(dev);
471 if (value < 0)
472 return value;
473 } else {
474 value = dev->battery_capacity;
475 }
476
477 val->intval = value;
478 break;
479
480 case POWER_SUPPLY_PROP_MODEL_NAME:
481 val->strval = dev->name;
482 break;
483
484 case POWER_SUPPLY_PROP_STATUS:
485 if (dev->battery_status != HID_BATTERY_REPORTED &&
486 !dev->battery_avoid_query) {
487 value = hidinput_query_battery_capacity(dev);
488 if (value < 0)
489 return value;
490
491 dev->battery_capacity = value;
492 dev->battery_status = HID_BATTERY_QUERIED;
493 }
494
495 if (dev->battery_status == HID_BATTERY_UNKNOWN)
496 val->intval = POWER_SUPPLY_STATUS_UNKNOWN;
497 else
498 val->intval = dev->battery_charge_status;
499 break;
500
501 case POWER_SUPPLY_PROP_SCOPE:
502 val->intval = POWER_SUPPLY_SCOPE_DEVICE;
503 break;
504
505 default:
506 ret = -EINVAL;
507 break;
508 }
509
510 return ret;
511}
512
513static int hidinput_setup_battery(struct hid_device *dev, unsigned report_type,
514 struct hid_field *field, bool is_percentage)
515{
516 struct power_supply_desc *psy_desc;
517 struct power_supply_config psy_cfg = { .drv_data = dev, };
518 unsigned quirks;
519 s32 min, max;
520 int error;
521
522 if (dev->battery)
523 return 0; /* already initialized? */
524
525 quirks = find_battery_quirk(dev);
526
527 hid_dbg(dev, "device %x:%x:%x %d quirks %d\n",
528 dev->bus, dev->vendor, dev->product, dev->version, quirks);
529
530 if (quirks & HID_BATTERY_QUIRK_IGNORE)
531 return 0;
532
533 psy_desc = kzalloc(sizeof(*psy_desc), GFP_KERNEL);
534 if (!psy_desc)
535 return -ENOMEM;
536
537 psy_desc->name = kasprintf(GFP_KERNEL, "hid-%s-battery",
538 strlen(dev->uniq) ?
539 dev->uniq : dev_name(&dev->dev));
540 if (!psy_desc->name) {
541 error = -ENOMEM;
542 goto err_free_mem;
543 }
544
545 psy_desc->type = POWER_SUPPLY_TYPE_BATTERY;
546 psy_desc->properties = hidinput_battery_props;
547 psy_desc->num_properties = ARRAY_SIZE(hidinput_battery_props);
548 psy_desc->use_for_apm = 0;
549 psy_desc->get_property = hidinput_get_battery_property;
550
551 min = field->logical_minimum;
552 max = field->logical_maximum;
553
554 if (is_percentage || (quirks & HID_BATTERY_QUIRK_PERCENT)) {
555 min = 0;
556 max = 100;
557 }
558
559 if (quirks & HID_BATTERY_QUIRK_FEATURE)
560 report_type = HID_FEATURE_REPORT;
561
562 dev->battery_min = min;
563 dev->battery_max = max;
564 dev->battery_report_type = report_type;
565 dev->battery_report_id = field->report->id;
566 dev->battery_charge_status = POWER_SUPPLY_STATUS_DISCHARGING;
567
568 /*
569 * Stylus is normally not connected to the device and thus we
570 * can't query the device and get meaningful battery strength.
571 * We have to wait for the device to report it on its own.
572 */
573 dev->battery_avoid_query = report_type == HID_INPUT_REPORT &&
574 field->physical == HID_DG_STYLUS;
575
576 if (quirks & HID_BATTERY_QUIRK_AVOID_QUERY)
577 dev->battery_avoid_query = true;
578
579 dev->battery = power_supply_register(&dev->dev, psy_desc, &psy_cfg);
580 if (IS_ERR(dev->battery)) {
581 error = PTR_ERR(dev->battery);
582 hid_warn(dev, "can't register power supply: %d\n", error);
583 goto err_free_name;
584 }
585
586 power_supply_powers(dev->battery, &dev->dev);
587 return 0;
588
589err_free_name:
590 kfree(psy_desc->name);
591err_free_mem:
592 kfree(psy_desc);
593 dev->battery = NULL;
594 return error;
595}
596
597static void hidinput_cleanup_battery(struct hid_device *dev)
598{
599 const struct power_supply_desc *psy_desc;
600
601 if (!dev->battery)
602 return;
603
604 psy_desc = dev->battery->desc;
605 power_supply_unregister(dev->battery);
606 kfree(psy_desc->name);
607 kfree(psy_desc);
608 dev->battery = NULL;
609}
610
611static bool hidinput_update_battery_charge_status(struct hid_device *dev,
612 unsigned int usage, int value)
613{
614 switch (usage) {
615 case HID_BAT_CHARGING:
616 dev->battery_charge_status = value ?
617 POWER_SUPPLY_STATUS_CHARGING :
618 POWER_SUPPLY_STATUS_DISCHARGING;
619 return true;
620 }
621
622 return false;
623}
624
625static void hidinput_update_battery(struct hid_device *dev, unsigned int usage,
626 int value)
627{
628 int capacity;
629
630 if (!dev->battery)
631 return;
632
633 if (hidinput_update_battery_charge_status(dev, usage, value)) {
634 power_supply_changed(dev->battery);
635 return;
636 }
637
638 if (value == 0 || value < dev->battery_min || value > dev->battery_max)
639 return;
640
641 capacity = hidinput_scale_battery_capacity(dev, value);
642
643 if (dev->battery_status != HID_BATTERY_REPORTED ||
644 capacity != dev->battery_capacity ||
645 ktime_after(ktime_get_coarse(), dev->battery_ratelimit_time)) {
646 dev->battery_capacity = capacity;
647 dev->battery_status = HID_BATTERY_REPORTED;
648 dev->battery_ratelimit_time =
649 ktime_add_ms(ktime_get_coarse(), 30 * 1000);
650 power_supply_changed(dev->battery);
651 }
652}
653#else /* !CONFIG_HID_BATTERY_STRENGTH */
654static int hidinput_setup_battery(struct hid_device *dev, unsigned report_type,
655 struct hid_field *field, bool is_percentage)
656{
657 return 0;
658}
659
660static void hidinput_cleanup_battery(struct hid_device *dev)
661{
662}
663
664static void hidinput_update_battery(struct hid_device *dev, unsigned int usage,
665 int value)
666{
667}
668#endif /* CONFIG_HID_BATTERY_STRENGTH */
669
670static bool hidinput_field_in_collection(struct hid_device *device, struct hid_field *field,
671 unsigned int type, unsigned int usage)
672{
673 struct hid_collection *collection;
674
675 collection = &device->collection[field->usage->collection_index];
676
677 return collection->type == type && collection->usage == usage;
678}
679
680static void hidinput_configure_usage(struct hid_input *hidinput, struct hid_field *field,
681 struct hid_usage *usage, unsigned int usage_index)
682{
683 struct input_dev *input = hidinput->input;
684 struct hid_device *device = input_get_drvdata(dev: input);
685 const struct usage_priority *usage_priority = NULL;
686 int max = 0, code;
687 unsigned int i = 0;
688 unsigned long *bit = NULL;
689
690 field->hidinput = hidinput;
691
692 if (field->flags & HID_MAIN_ITEM_CONSTANT)
693 goto ignore;
694
695 /* Ignore if report count is out of bounds. */
696 if (field->report_count < 1)
697 goto ignore;
698
699 /* only LED and HAPTIC usages are supported in output fields */
700 if (field->report_type == HID_OUTPUT_REPORT &&
701 (usage->hid & HID_USAGE_PAGE) != HID_UP_LED &&
702 (usage->hid & HID_USAGE_PAGE) != HID_UP_HAPTIC) {
703 goto ignore;
704 }
705
706 /* assign a priority based on the static list declared here */
707 for (i = 0; i < ARRAY_SIZE(hidinput_usages_priorities); i++) {
708 if (usage->hid == hidinput_usages_priorities[i].usage) {
709 usage_priority = &hidinput_usages_priorities[i];
710
711 field->usages_priorities[usage_index] =
712 (ARRAY_SIZE(hidinput_usages_priorities) - i) << 8;
713 break;
714 }
715 }
716
717 /*
718 * For slotted devices, we need to also add the slot index
719 * in the priority.
720 */
721 if (usage_priority && usage_priority->global)
722 field->usages_priorities[usage_index] |=
723 usage_priority->slot_overwrite;
724 else
725 field->usages_priorities[usage_index] |=
726 (0xff - field->slot_idx) << 16;
727
728 if (device->driver->input_mapping) {
729 int ret = device->driver->input_mapping(device, hidinput, field,
730 usage, &bit, &max);
731 if (ret > 0)
732 goto mapped;
733 if (ret < 0)
734 goto ignore;
735 }
736
737 switch (usage->hid & HID_USAGE_PAGE) {
738 case HID_UP_UNDEFINED:
739 goto ignore;
740
741 case HID_UP_KEYBOARD:
742 set_bit(EV_REP, addr: input->evbit);
743
744 if ((usage->hid & HID_USAGE) < 256) {
745 if (!hid_keyboard[usage->hid & HID_USAGE]) goto ignore;
746 map_key_clear(hid_keyboard[usage->hid & HID_USAGE]);
747 } else
748 map_key(KEY_UNKNOWN);
749
750 break;
751
752 case HID_UP_BUTTON:
753 code = ((usage->hid - 1) & HID_USAGE);
754
755 switch (field->application) {
756 case HID_GD_MOUSE:
757 case HID_GD_POINTER: code += BTN_MOUSE; break;
758 case HID_GD_JOYSTICK:
759 if (code <= 0xf)
760 code += BTN_JOYSTICK;
761 else
762 code += BTN_TRIGGER_HAPPY - 0x10;
763 break;
764 case HID_GD_GAMEPAD:
765 if (code <= 0xf)
766 code += BTN_GAMEPAD;
767 else
768 code += BTN_TRIGGER_HAPPY - 0x10;
769 break;
770 case HID_CP_CONSUMER_CONTROL:
771 if (hidinput_field_in_collection(device, field,
772 HID_COLLECTION_NAMED_ARRAY,
773 HID_CP_PROGRAMMABLEBUTTONS)) {
774 if (code <= 0x1d)
775 code += KEY_MACRO1;
776 else
777 code += BTN_TRIGGER_HAPPY - 0x1e;
778 break;
779 }
780 fallthrough;
781 default:
782 switch (field->physical) {
783 case HID_GD_MOUSE:
784 case HID_GD_POINTER: code += BTN_MOUSE; break;
785 case HID_GD_JOYSTICK: code += BTN_JOYSTICK; break;
786 case HID_GD_GAMEPAD: code += BTN_GAMEPAD; break;
787 default: code += BTN_MISC;
788 }
789 }
790
791 map_key(code);
792 break;
793
794 case HID_UP_SIMULATION:
795 switch (usage->hid & 0xffff) {
796 case 0xba: map_abs(ABS_RUDDER); break;
797 case 0xbb: map_abs(ABS_THROTTLE); break;
798 case 0xc4: map_abs(ABS_GAS); break;
799 case 0xc5: map_abs(ABS_BRAKE); break;
800 case 0xc8: map_abs(ABS_WHEEL); break;
801 default: goto ignore;
802 }
803 break;
804
805 case HID_UP_GENDESK:
806 if ((usage->hid & 0xf0) == 0x80) { /* SystemControl */
807 switch (usage->hid & 0xf) {
808 case 0x1: map_key_clear(KEY_POWER); break;
809 case 0x2: map_key_clear(KEY_SLEEP); break;
810 case 0x3: map_key_clear(KEY_WAKEUP); break;
811 case 0x4: map_key_clear(KEY_CONTEXT_MENU); break;
812 case 0x5: map_key_clear(KEY_MENU); break;
813 case 0x6: map_key_clear(KEY_PROG1); break;
814 case 0x7: map_key_clear(KEY_HELP); break;
815 case 0x8: map_key_clear(KEY_EXIT); break;
816 case 0x9: map_key_clear(KEY_SELECT); break;
817 case 0xa: map_key_clear(KEY_RIGHT); break;
818 case 0xb: map_key_clear(KEY_LEFT); break;
819 case 0xc: map_key_clear(KEY_UP); break;
820 case 0xd: map_key_clear(KEY_DOWN); break;
821 case 0xe: map_key_clear(KEY_POWER2); break;
822 case 0xf: map_key_clear(KEY_RESTART); break;
823 default: goto unknown;
824 }
825 break;
826 }
827
828 if ((usage->hid & 0xf0) == 0x90) { /* SystemControl & D-pad */
829 switch (usage->hid) {
830 case HID_GD_UP: usage->hat_dir = 1; break;
831 case HID_GD_DOWN: usage->hat_dir = 5; break;
832 case HID_GD_RIGHT: usage->hat_dir = 3; break;
833 case HID_GD_LEFT: usage->hat_dir = 7; break;
834 case HID_GD_DO_NOT_DISTURB:
835 map_key_clear(KEY_DO_NOT_DISTURB); break;
836 default: goto unknown;
837 }
838
839 if (usage->hid <= HID_GD_LEFT) {
840 if (field->dpad) {
841 map_abs(field->dpad);
842 goto ignore;
843 }
844 map_abs(ABS_HAT0X);
845 }
846 break;
847 }
848
849 if ((usage->hid & 0xf0) == 0xa0) { /* SystemControl */
850 switch (usage->hid & 0xf) {
851 case 0x9: map_key_clear(KEY_MICMUTE); break;
852 case 0xa: map_key_clear(KEY_ACCESSIBILITY); break;
853 default: goto ignore;
854 }
855 break;
856 }
857
858 if ((usage->hid & 0xf0) == 0xb0) { /* SC - Display */
859 switch (usage->hid & 0xf) {
860 case 0x05: map_key_clear(KEY_SWITCHVIDEOMODE); break;
861 default: goto ignore;
862 }
863 break;
864 }
865
866 /*
867 * Some lazy vendors declare 255 usages for System Control,
868 * leading to the creation of ABS_X|Y axis and too many others.
869 * It wouldn't be a problem if joydev doesn't consider the
870 * device as a joystick then.
871 */
872 if (field->application == HID_GD_SYSTEM_CONTROL)
873 goto ignore;
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, addr: 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, addr: input->evbit);
956 set_bit(BTN_TOUCH, addr: 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(dev: device, report_type: HID_INPUT_REPORT, field, is_percentage: 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, addr: 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, addr: 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(dev: device, report_type: HID_INPUT_REPORT, field, is_percentage: 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(dev: device, report_type: HID_INPUT_REPORT, field, is_percentage: 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, addr: 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, addr: 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, addr: 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(nr: usage->type, addr: 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(nr: usage->code, addr: bit)) {
1395 if (device->quirks & HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE) {
1396 usage->code = find_next_zero_bit(addr: bit,
1397 size: max + 1,
1398 offset: 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(dev: input, axis: usage->code, min: a, max: b, fuzz: (b - a) >> 8, flat: (b - a) >> 4);
1420 else input_set_abs_params(dev: input, axis: usage->code, min: a, max: b, fuzz: 0, flat: 0);
1421
1422 input_abs_set_res(dev: input, axis: usage->code,
1423 val: 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(dev: input, n_events: 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(dev: input, axis: i, min: -1, max: 1, fuzz: 0, flat: 0);
1435 set_bit(nr: i, addr: 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, addr: input->keybit);
1448 set_bit(KEY_VOLUMEDOWN, addr: input->keybit);
1449 }
1450
1451 if (usage->type == EV_KEY) {
1452 set_bit(EV_MSC, addr: input->evbit);
1453 set_bit(MSC_SCAN, addr: 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(dev: input, EV_REL, code, value: lo_res);
1492 input_event(dev: input, EV_REL, code: usage->code, value: 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(dev: input, EV_KEY, BTN_TOUCH, value: 0);
1507 input_event(dev: input, EV_KEY, code: tool, value: 0);
1508 input_event(dev: input, EV_SYN, SYN_REPORT, value: 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, tool: report->tool);
1518
1519 input_event(dev: input, EV_KEY, code: new_tool, value: 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 hidinput_update_battery(dev: hid, usage: usage->hid, value);
1534 return;
1535 }
1536
1537 if (!field->hidinput)
1538 return;
1539
1540 input = field->hidinput->input;
1541
1542 if (usage->hat_min < usage->hat_max || usage->hat_dir) {
1543 int hat_dir = usage->hat_dir;
1544 if (!hat_dir)
1545 hat_dir = (value - usage->hat_min) * 8 / (usage->hat_max - usage->hat_min + 1) + 1;
1546 if (hat_dir < 0 || hat_dir > 8) hat_dir = 0;
1547 input_event(dev: input, type: usage->type, code: usage->code , value: hid_hat_to_axis[hat_dir].x);
1548 input_event(dev: input, type: usage->type, code: usage->code + 1, value: hid_hat_to_axis[hat_dir].y);
1549 return;
1550 }
1551
1552 /*
1553 * Ignore out-of-range values as per HID specification,
1554 * section 5.10 and 6.2.25, when NULL state bit is present.
1555 * When it's not, clamp the value to match Microsoft's input
1556 * driver as mentioned in "Required HID usages for digitizers":
1557 * https://msdn.microsoft.com/en-us/library/windows/hardware/dn672278(v=vs.85).asp
1558 *
1559 * The logical_minimum < logical_maximum check is done so that we
1560 * don't unintentionally discard values sent by devices which
1561 * don't specify logical min and max.
1562 */
1563 if ((field->flags & HID_MAIN_ITEM_VARIABLE) &&
1564 field->logical_minimum < field->logical_maximum) {
1565 if (field->flags & HID_MAIN_ITEM_NULL_STATE &&
1566 (value < field->logical_minimum ||
1567 value > field->logical_maximum)) {
1568 dbg_hid("Ignoring out-of-range value %x\n", value);
1569 return;
1570 }
1571 value = clamp(value,
1572 field->logical_minimum,
1573 field->logical_maximum);
1574 }
1575
1576 switch (usage->hid) {
1577 case HID_DG_ERASER:
1578 report->tool_active |= !!value;
1579
1580 /*
1581 * if eraser is set, we must enforce BTN_TOOL_RUBBER
1582 * to accommodate for devices not following the spec.
1583 */
1584 if (value)
1585 hid_report_set_tool(report, input, BTN_TOOL_RUBBER);
1586 else if (report->tool != BTN_TOOL_RUBBER)
1587 /* value is off, tool is not rubber, ignore */
1588 return;
1589 else if (*quirks & HID_QUIRK_NOINVERT &&
1590 !test_bit(BTN_TOUCH, input->key)) {
1591 /*
1592 * There is no invert to release the tool, let hid_input
1593 * send BTN_TOUCH with scancode and release the tool after.
1594 */
1595 hid_report_release_tool(report, input, BTN_TOOL_RUBBER);
1596 return;
1597 }
1598
1599 /* let hid-input set BTN_TOUCH */
1600 break;
1601
1602 case HID_DG_INVERT:
1603 report->tool_active |= !!value;
1604
1605 /*
1606 * If invert is set, we store BTN_TOOL_RUBBER.
1607 */
1608 if (value)
1609 hid_report_set_tool(report, input, BTN_TOOL_RUBBER);
1610 else if (!report->tool_active)
1611 /* tool_active not set means Invert and Eraser are not set */
1612 hid_report_release_tool(report, input, BTN_TOOL_RUBBER);
1613
1614 /* no further processing */
1615 return;
1616
1617 case HID_DG_INRANGE:
1618 report->tool_active |= !!value;
1619
1620 if (report->tool_active) {
1621 /*
1622 * if tool is not set but is marked as active,
1623 * assume ours
1624 */
1625 if (!report->tool)
1626 report->tool = usage->code;
1627
1628 /* drivers may have changed the value behind our back, resend it */
1629 hid_report_set_tool(report, input, new_tool: report->tool);
1630 } else {
1631 hid_report_release_tool(report, input, tool: usage->code);
1632 }
1633
1634 /* reset tool_active for the next event */
1635 report->tool_active = false;
1636
1637 /* no further processing */
1638 return;
1639
1640 case HID_DG_TIPSWITCH:
1641 report->tool_active |= !!value;
1642
1643 /* if tool is set to RUBBER we should ignore the current value */
1644 if (report->tool == BTN_TOOL_RUBBER)
1645 return;
1646
1647 break;
1648
1649 case HID_DG_TIPPRESSURE:
1650 if (*quirks & HID_QUIRK_NOTOUCH) {
1651 int a = field->logical_minimum;
1652 int b = field->logical_maximum;
1653
1654 if (value > a + ((b - a) >> 3)) {
1655 input_event(dev: input, EV_KEY, BTN_TOUCH, value: 1);
1656 report->tool_active = true;
1657 }
1658 }
1659 break;
1660
1661 case HID_UP_PID | 0x83UL: /* Simultaneous Effects Max */
1662 dbg_hid("Maximum Effects - %d\n",value);
1663 return;
1664
1665 case HID_UP_PID | 0x7fUL:
1666 dbg_hid("PID Pool Report\n");
1667 return;
1668 }
1669
1670 switch (usage->type) {
1671 case EV_KEY:
1672 if (usage->code == 0) /* Key 0 is "unassigned", not KEY_UNKNOWN */
1673 return;
1674 break;
1675
1676 case EV_REL:
1677 if (usage->code == REL_WHEEL_HI_RES ||
1678 usage->code == REL_HWHEEL_HI_RES) {
1679 hidinput_handle_scroll(usage, input, value);
1680 return;
1681 }
1682 break;
1683
1684 case EV_ABS:
1685 if ((field->flags & HID_MAIN_ITEM_RELATIVE) &&
1686 usage->code == ABS_VOLUME) {
1687 int count = abs(value);
1688 int direction = value > 0 ? KEY_VOLUMEUP : KEY_VOLUMEDOWN;
1689 int i;
1690
1691 for (i = 0; i < count; i++) {
1692 input_event(dev: input, EV_KEY, code: direction, value: 1);
1693 input_sync(dev: input);
1694 input_event(dev: input, EV_KEY, code: direction, value: 0);
1695 input_sync(dev: input);
1696 }
1697 return;
1698
1699 } else if (((*quirks & HID_QUIRK_X_INVERT) && usage->code == ABS_X) ||
1700 ((*quirks & HID_QUIRK_Y_INVERT) && usage->code == ABS_Y))
1701 value = field->logical_maximum - value;
1702 break;
1703 }
1704
1705 /*
1706 * Ignore reports for absolute data if the data didn't change. This is
1707 * not only an optimization but also fixes 'dead' key reports. Some
1708 * RollOver implementations for localized keys (like BACKSLASH/PIPE; HID
1709 * 0x31 and 0x32) report multiple keys, even though a localized keyboard
1710 * can only have one of them physically available. The 'dead' keys
1711 * report constant 0. As all map to the same keycode, they'd confuse
1712 * the input layer. If we filter the 'dead' keys on the HID level, we
1713 * skip the keycode translation and only forward real events.
1714 */
1715 if (!(field->flags & (HID_MAIN_ITEM_RELATIVE |
1716 HID_MAIN_ITEM_BUFFERED_BYTE)) &&
1717 (field->flags & HID_MAIN_ITEM_VARIABLE) &&
1718 usage->usage_index < field->maxusage &&
1719 value == field->value[usage->usage_index])
1720 return;
1721
1722 /* report the usage code as scancode if the key status has changed */
1723 if (usage->type == EV_KEY &&
1724 (!test_bit(usage->code, input->key)) == value)
1725 input_event(dev: input, EV_MSC, MSC_SCAN, value: usage->hid);
1726
1727 input_event(dev: input, type: usage->type, code: usage->code, value);
1728
1729 if ((field->flags & HID_MAIN_ITEM_RELATIVE) &&
1730 usage->type == EV_KEY && value) {
1731 input_sync(dev: input);
1732 input_event(dev: input, type: usage->type, code: usage->code, value: 0);
1733 }
1734}
1735
1736void hidinput_report_event(struct hid_device *hid, struct hid_report *report)
1737{
1738 struct hid_input *hidinput;
1739
1740 if (hid->quirks & HID_QUIRK_NO_INPUT_SYNC)
1741 return;
1742
1743 list_for_each_entry(hidinput, &hid->inputs, list)
1744 input_sync(dev: hidinput->input);
1745}
1746EXPORT_SYMBOL_GPL(hidinput_report_event);
1747
1748static int hidinput_find_field(struct hid_device *hid, unsigned int type,
1749 unsigned int code, struct hid_field **field)
1750{
1751 struct hid_report *report;
1752 int i, j;
1753
1754 list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
1755 for (i = 0; i < report->maxfield; i++) {
1756 *field = report->field[i];
1757 for (j = 0; j < (*field)->maxusage; j++)
1758 if ((*field)->usage[j].type == type && (*field)->usage[j].code == code)
1759 return j;
1760 }
1761 }
1762 return -1;
1763}
1764
1765struct hid_field *hidinput_get_led_field(struct hid_device *hid)
1766{
1767 struct hid_report *report;
1768 struct hid_field *field;
1769 int i, j;
1770
1771 list_for_each_entry(report,
1772 &hid->report_enum[HID_OUTPUT_REPORT].report_list,
1773 list) {
1774 for (i = 0; i < report->maxfield; i++) {
1775 field = report->field[i];
1776 for (j = 0; j < field->maxusage; j++)
1777 if (field->usage[j].type == EV_LED)
1778 return field;
1779 }
1780 }
1781 return NULL;
1782}
1783EXPORT_SYMBOL_GPL(hidinput_get_led_field);
1784
1785unsigned int hidinput_count_leds(struct hid_device *hid)
1786{
1787 struct hid_report *report;
1788 struct hid_field *field;
1789 int i, j;
1790 unsigned int count = 0;
1791
1792 list_for_each_entry(report,
1793 &hid->report_enum[HID_OUTPUT_REPORT].report_list,
1794 list) {
1795 for (i = 0; i < report->maxfield; i++) {
1796 field = report->field[i];
1797 for (j = 0; j < field->maxusage; j++)
1798 if (field->usage[j].type == EV_LED &&
1799 field->value[j])
1800 count += 1;
1801 }
1802 }
1803 return count;
1804}
1805EXPORT_SYMBOL_GPL(hidinput_count_leds);
1806
1807static void hidinput_led_worker(struct work_struct *work)
1808{
1809 struct hid_device *hid = container_of(work, struct hid_device,
1810 led_work);
1811 struct hid_field *field;
1812 struct hid_report *report;
1813 int ret;
1814 u32 len;
1815 __u8 *buf;
1816
1817 field = hidinput_get_led_field(hid);
1818 if (!field)
1819 return;
1820
1821 /*
1822 * field->report is accessed unlocked regarding HID core. So there might
1823 * be another incoming SET-LED request from user-space, which changes
1824 * the LED state while we assemble our outgoing buffer. However, this
1825 * doesn't matter as hid_output_report() correctly converts it into a
1826 * boolean value no matter what information is currently set on the LED
1827 * field (even garbage). So the remote device will always get a valid
1828 * request.
1829 * And in case we send a wrong value, a next led worker is spawned
1830 * for every SET-LED request so the following worker will send the
1831 * correct value, guaranteed!
1832 */
1833
1834 report = field->report;
1835
1836 /* use custom SET_REPORT request if possible (asynchronous) */
1837 if (hid->ll_driver->request)
1838 return hid->ll_driver->request(hid, report, HID_REQ_SET_REPORT);
1839
1840 /* fall back to generic raw-output-report */
1841 len = hid_report_len(report);
1842 buf = hid_alloc_report_buf(report, GFP_KERNEL);
1843 if (!buf)
1844 return;
1845
1846 hid_output_report(report, data: buf);
1847 /* synchronous output report */
1848 ret = hid_hw_output_report(hdev: hid, buf, len);
1849 if (ret == -ENOSYS)
1850 hid_hw_raw_request(hdev: hid, reportnum: report->id, buf, len, rtype: HID_OUTPUT_REPORT,
1851 reqtype: HID_REQ_SET_REPORT);
1852 kfree(objp: buf);
1853}
1854
1855static int hidinput_input_event(struct input_dev *dev, unsigned int type,
1856 unsigned int code, int value)
1857{
1858 struct hid_device *hid = input_get_drvdata(dev);
1859 struct hid_field *field;
1860 int offset;
1861
1862 if (type == EV_FF)
1863 return input_ff_event(dev, type, code, value);
1864
1865 if (type != EV_LED)
1866 return -1;
1867
1868 if ((offset = hidinput_find_field(hid, type, code, field: &field)) == -1) {
1869 hid_warn(dev, "event field not found\n");
1870 return -1;
1871 }
1872
1873 hid_set_field(field, offset, value);
1874
1875 schedule_work(work: &hid->led_work);
1876 return 0;
1877}
1878
1879static int hidinput_open(struct input_dev *dev)
1880{
1881 struct hid_device *hid = input_get_drvdata(dev);
1882
1883 return hid_hw_open(hdev: hid);
1884}
1885
1886static void hidinput_close(struct input_dev *dev)
1887{
1888 struct hid_device *hid = input_get_drvdata(dev);
1889
1890 hid_hw_close(hdev: hid);
1891}
1892
1893static bool __hidinput_change_resolution_multipliers(struct hid_device *hid,
1894 struct hid_report *report, bool use_logical_max)
1895{
1896 struct hid_usage *usage;
1897 bool update_needed = false;
1898 bool get_report_completed = false;
1899 int i, j;
1900
1901 if (report->maxfield == 0)
1902 return false;
1903
1904 for (i = 0; i < report->maxfield; i++) {
1905 __s32 value = use_logical_max ?
1906 report->field[i]->logical_maximum :
1907 report->field[i]->logical_minimum;
1908
1909 /* There is no good reason for a Resolution
1910 * Multiplier to have a count other than 1.
1911 * Ignore that case.
1912 */
1913 if (report->field[i]->report_count != 1)
1914 continue;
1915
1916 for (j = 0; j < report->field[i]->maxusage; j++) {
1917 usage = &report->field[i]->usage[j];
1918
1919 if (usage->hid != HID_GD_RESOLUTION_MULTIPLIER)
1920 continue;
1921
1922 /*
1923 * If we have more than one feature within this
1924 * report we need to fill in the bits from the
1925 * others before we can overwrite the ones for the
1926 * Resolution Multiplier.
1927 *
1928 * But if we're not allowed to read from the device,
1929 * we just bail. Such a device should not exist
1930 * anyway.
1931 */
1932 if (!get_report_completed && report->maxfield > 1) {
1933 if (hid->quirks & HID_QUIRK_NO_INIT_REPORTS)
1934 return update_needed;
1935
1936 hid_hw_request(hdev: hid, report, reqtype: HID_REQ_GET_REPORT);
1937 hid_hw_wait(hdev: hid);
1938 get_report_completed = true;
1939 }
1940
1941 report->field[i]->value[j] = value;
1942 update_needed = true;
1943 }
1944 }
1945
1946 return update_needed;
1947}
1948
1949static void hidinput_change_resolution_multipliers(struct hid_device *hid)
1950{
1951 struct hid_report_enum *rep_enum;
1952 struct hid_report *rep;
1953 int ret;
1954
1955 rep_enum = &hid->report_enum[HID_FEATURE_REPORT];
1956 list_for_each_entry(rep, &rep_enum->report_list, list) {
1957 bool update_needed = __hidinput_change_resolution_multipliers(hid,
1958 report: rep, use_logical_max: true);
1959
1960 if (update_needed) {
1961 ret = __hid_request(hid, rep, reqtype: HID_REQ_SET_REPORT);
1962 if (ret) {
1963 __hidinput_change_resolution_multipliers(hid,
1964 report: rep, use_logical_max: false);
1965 return;
1966 }
1967 }
1968 }
1969
1970 /* refresh our structs */
1971 hid_setup_resolution_multiplier(hid);
1972}
1973
1974static void report_features(struct hid_device *hid)
1975{
1976 struct hid_driver *drv = hid->driver;
1977 struct hid_report_enum *rep_enum;
1978 struct hid_report *rep;
1979 struct hid_usage *usage;
1980 int i, j;
1981
1982 rep_enum = &hid->report_enum[HID_FEATURE_REPORT];
1983 list_for_each_entry(rep, &rep_enum->report_list, list)
1984 for (i = 0; i < rep->maxfield; i++) {
1985 /* Ignore if report count is out of bounds. */
1986 if (rep->field[i]->report_count < 1)
1987 continue;
1988
1989 for (j = 0; j < rep->field[i]->maxusage; j++) {
1990 usage = &rep->field[i]->usage[j];
1991
1992 /* Verify if Battery Strength feature is available */
1993 if (usage->hid == HID_DC_BATTERYSTRENGTH)
1994 hidinput_setup_battery(dev: hid, report_type: HID_FEATURE_REPORT,
1995 field: rep->field[i], is_percentage: false);
1996
1997 if (drv->feature_mapping)
1998 drv->feature_mapping(hid, rep->field[i], usage);
1999 }
2000 }
2001}
2002
2003static struct hid_input *hidinput_allocate(struct hid_device *hid,
2004 unsigned int application)
2005{
2006 struct hid_input *hidinput = kzalloc(sizeof(*hidinput), GFP_KERNEL);
2007 struct input_dev *input_dev = input_allocate_device();
2008 const char *suffix = NULL;
2009 size_t suffix_len, name_len;
2010
2011 if (!hidinput || !input_dev)
2012 goto fail;
2013
2014 if ((hid->quirks & HID_QUIRK_INPUT_PER_APP) &&
2015 hid->maxapplication > 1) {
2016 switch (application) {
2017 case HID_GD_KEYBOARD:
2018 suffix = "Keyboard";
2019 break;
2020 case HID_GD_KEYPAD:
2021 suffix = "Keypad";
2022 break;
2023 case HID_GD_MOUSE:
2024 suffix = "Mouse";
2025 break;
2026 case HID_DG_PEN:
2027 /*
2028 * yes, there is an issue here:
2029 * DG_PEN -> "Stylus"
2030 * DG_STYLUS -> "Pen"
2031 * But changing this now means users with config snippets
2032 * will have to change it and the test suite will not be happy.
2033 */
2034 suffix = "Stylus";
2035 break;
2036 case HID_DG_STYLUS:
2037 suffix = "Pen";
2038 break;
2039 case HID_DG_TOUCHSCREEN:
2040 suffix = "Touchscreen";
2041 break;
2042 case HID_DG_TOUCHPAD:
2043 suffix = "Touchpad";
2044 break;
2045 case HID_GD_SYSTEM_CONTROL:
2046 suffix = "System Control";
2047 break;
2048 case HID_CP_CONSUMER_CONTROL:
2049 suffix = "Consumer Control";
2050 break;
2051 case HID_GD_WIRELESS_RADIO_CTLS:
2052 suffix = "Wireless Radio Control";
2053 break;
2054 case HID_GD_SYSTEM_MULTIAXIS:
2055 suffix = "System Multi Axis";
2056 break;
2057 default:
2058 break;
2059 }
2060 }
2061
2062 if (suffix) {
2063 name_len = strlen(hid->name);
2064 suffix_len = strlen(suffix);
2065 if ((name_len < suffix_len) ||
2066 strcmp(hid->name + name_len - suffix_len, suffix)) {
2067 hidinput->name = kasprintf(GFP_KERNEL, fmt: "%s %s",
2068 hid->name, suffix);
2069 if (!hidinput->name)
2070 goto fail;
2071 }
2072 }
2073
2074 input_set_drvdata(dev: input_dev, data: hid);
2075 input_dev->event = hidinput_input_event;
2076 input_dev->open = hidinput_open;
2077 input_dev->close = hidinput_close;
2078 input_dev->setkeycode = hidinput_setkeycode;
2079 input_dev->getkeycode = hidinput_getkeycode;
2080
2081 input_dev->name = hidinput->name ? hidinput->name : hid->name;
2082 input_dev->phys = hid->phys;
2083 input_dev->uniq = hid->uniq;
2084 input_dev->id.bustype = hid->bus;
2085 input_dev->id.vendor = hid->vendor;
2086 input_dev->id.product = hid->product;
2087 input_dev->id.version = hid->version;
2088 input_dev->dev.parent = &hid->dev;
2089
2090 hidinput->input = input_dev;
2091 hidinput->application = application;
2092 list_add_tail(new: &hidinput->list, head: &hid->inputs);
2093
2094 INIT_LIST_HEAD(list: &hidinput->reports);
2095
2096 return hidinput;
2097
2098fail:
2099 kfree(objp: hidinput);
2100 input_free_device(dev: input_dev);
2101 hid_err(hid, "Out of memory during hid input probe\n");
2102 return NULL;
2103}
2104
2105static bool hidinput_has_been_populated(struct hid_input *hidinput)
2106{
2107 int i;
2108 unsigned long r = 0;
2109
2110 for (i = 0; i < BITS_TO_LONGS(EV_CNT); i++)
2111 r |= hidinput->input->evbit[i];
2112
2113 for (i = 0; i < BITS_TO_LONGS(KEY_CNT); i++)
2114 r |= hidinput->input->keybit[i];
2115
2116 for (i = 0; i < BITS_TO_LONGS(REL_CNT); i++)
2117 r |= hidinput->input->relbit[i];
2118
2119 for (i = 0; i < BITS_TO_LONGS(ABS_CNT); i++)
2120 r |= hidinput->input->absbit[i];
2121
2122 for (i = 0; i < BITS_TO_LONGS(MSC_CNT); i++)
2123 r |= hidinput->input->mscbit[i];
2124
2125 for (i = 0; i < BITS_TO_LONGS(LED_CNT); i++)
2126 r |= hidinput->input->ledbit[i];
2127
2128 for (i = 0; i < BITS_TO_LONGS(SND_CNT); i++)
2129 r |= hidinput->input->sndbit[i];
2130
2131 for (i = 0; i < BITS_TO_LONGS(FF_CNT); i++)
2132 r |= hidinput->input->ffbit[i];
2133
2134 for (i = 0; i < BITS_TO_LONGS(SW_CNT); i++)
2135 r |= hidinput->input->swbit[i];
2136
2137 return !!r;
2138}
2139
2140static void hidinput_cleanup_hidinput(struct hid_device *hid,
2141 struct hid_input *hidinput)
2142{
2143 struct hid_report *report;
2144 int i, k;
2145
2146 list_del(entry: &hidinput->list);
2147 input_free_device(dev: hidinput->input);
2148 kfree(objp: hidinput->name);
2149
2150 for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
2151 if (k == HID_OUTPUT_REPORT &&
2152 hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
2153 continue;
2154
2155 list_for_each_entry(report, &hid->report_enum[k].report_list,
2156 list) {
2157
2158 for (i = 0; i < report->maxfield; i++)
2159 if (report->field[i]->hidinput == hidinput)
2160 report->field[i]->hidinput = NULL;
2161 }
2162 }
2163
2164 kfree(objp: hidinput);
2165}
2166
2167static struct hid_input *hidinput_match(struct hid_report *report)
2168{
2169 struct hid_device *hid = report->device;
2170 struct hid_input *hidinput;
2171
2172 list_for_each_entry(hidinput, &hid->inputs, list) {
2173 if (hidinput->report &&
2174 hidinput->report->id == report->id)
2175 return hidinput;
2176 }
2177
2178 return NULL;
2179}
2180
2181static struct hid_input *hidinput_match_application(struct hid_report *report)
2182{
2183 struct hid_device *hid = report->device;
2184 struct hid_input *hidinput;
2185
2186 list_for_each_entry(hidinput, &hid->inputs, list) {
2187 if (hidinput->application == report->application)
2188 return hidinput;
2189
2190 /*
2191 * Keep SystemControl and ConsumerControl applications together
2192 * with the main keyboard, if present.
2193 */
2194 if ((report->application == HID_GD_SYSTEM_CONTROL ||
2195 report->application == HID_CP_CONSUMER_CONTROL) &&
2196 hidinput->application == HID_GD_KEYBOARD) {
2197 return hidinput;
2198 }
2199 }
2200
2201 return NULL;
2202}
2203
2204static inline void hidinput_configure_usages(struct hid_input *hidinput,
2205 struct hid_report *report)
2206{
2207 int i, j, k;
2208 int first_field_index = 0;
2209 int slot_collection_index = -1;
2210 int prev_collection_index = -1;
2211 unsigned int slot_idx = 0;
2212 struct hid_field *field;
2213
2214 /*
2215 * First tag all the fields that are part of a slot,
2216 * a slot needs to have one Contact ID in the collection
2217 */
2218 for (i = 0; i < report->maxfield; i++) {
2219 field = report->field[i];
2220
2221 /* ignore fields without usage */
2222 if (field->maxusage < 1)
2223 continue;
2224
2225 /*
2226 * janitoring when collection_index changes
2227 */
2228 if (prev_collection_index != field->usage->collection_index) {
2229 prev_collection_index = field->usage->collection_index;
2230 first_field_index = i;
2231 }
2232
2233 /*
2234 * if we already found a Contact ID in the collection,
2235 * tag and continue to the next.
2236 */
2237 if (slot_collection_index == field->usage->collection_index) {
2238 field->slot_idx = slot_idx;
2239 continue;
2240 }
2241
2242 /* check if the current field has Contact ID */
2243 for (j = 0; j < field->maxusage; j++) {
2244 if (field->usage[j].hid == HID_DG_CONTACTID) {
2245 slot_collection_index = field->usage->collection_index;
2246 slot_idx++;
2247
2248 /*
2249 * mark all previous fields and this one in the
2250 * current collection to be slotted.
2251 */
2252 for (k = first_field_index; k <= i; k++)
2253 report->field[k]->slot_idx = slot_idx;
2254 break;
2255 }
2256 }
2257 }
2258
2259 for (i = 0; i < report->maxfield; i++)
2260 for (j = 0; j < report->field[i]->maxusage; j++)
2261 hidinput_configure_usage(hidinput, field: report->field[i],
2262 usage: report->field[i]->usage + j,
2263 usage_index: j);
2264}
2265
2266/*
2267 * Register the input device; print a message.
2268 * Configure the input layer interface
2269 * Read all reports and initialize the absolute field values.
2270 */
2271
2272int hidinput_connect(struct hid_device *hid, unsigned int force)
2273{
2274 struct hid_driver *drv = hid->driver;
2275 struct hid_report *report;
2276 struct hid_input *next, *hidinput = NULL;
2277 unsigned int application;
2278 int i, k;
2279
2280 INIT_LIST_HEAD(list: &hid->inputs);
2281 INIT_WORK(&hid->led_work, hidinput_led_worker);
2282
2283 hid->status &= ~HID_STAT_DUP_DETECTED;
2284
2285 if (!force) {
2286 for (i = 0; i < hid->maxcollection; i++) {
2287 struct hid_collection *col = &hid->collection[i];
2288 if (col->type == HID_COLLECTION_APPLICATION ||
2289 col->type == HID_COLLECTION_PHYSICAL)
2290 if (IS_INPUT_APPLICATION(col->usage))
2291 break;
2292 }
2293
2294 if (i == hid->maxcollection)
2295 return -1;
2296 }
2297
2298 report_features(hid);
2299
2300 for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
2301 if (k == HID_OUTPUT_REPORT &&
2302 hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
2303 continue;
2304
2305 list_for_each_entry(report, &hid->report_enum[k].report_list, list) {
2306
2307 if (!report->maxfield)
2308 continue;
2309
2310 application = report->application;
2311
2312 /*
2313 * Find the previous hidinput report attached
2314 * to this report id.
2315 */
2316 if (hid->quirks & HID_QUIRK_MULTI_INPUT)
2317 hidinput = hidinput_match(report);
2318 else if (hid->maxapplication > 1 &&
2319 (hid->quirks & HID_QUIRK_INPUT_PER_APP))
2320 hidinput = hidinput_match_application(report);
2321
2322 if (!hidinput) {
2323 hidinput = hidinput_allocate(hid, application);
2324 if (!hidinput)
2325 goto out_unwind;
2326 }
2327
2328 hidinput_configure_usages(hidinput, report);
2329
2330 if (hid->quirks & HID_QUIRK_MULTI_INPUT)
2331 hidinput->report = report;
2332
2333 list_add_tail(new: &report->hidinput_list,
2334 head: &hidinput->reports);
2335 }
2336 }
2337
2338 hidinput_change_resolution_multipliers(hid);
2339
2340 list_for_each_entry_safe(hidinput, next, &hid->inputs, list) {
2341 if (drv->input_configured &&
2342 drv->input_configured(hid, hidinput))
2343 goto out_unwind;
2344
2345 if (!hidinput_has_been_populated(hidinput)) {
2346 /* no need to register an input device not populated */
2347 hidinput_cleanup_hidinput(hid, hidinput);
2348 continue;
2349 }
2350
2351 if (input_register_device(hidinput->input))
2352 goto out_unwind;
2353 hidinput->registered = true;
2354 }
2355
2356 if (list_empty(head: &hid->inputs)) {
2357 hid_dbg(hid, "No inputs registered, leaving\n");
2358 goto out_unwind;
2359 }
2360
2361 if (hid->status & HID_STAT_DUP_DETECTED)
2362 hid_dbg(hid,
2363 "Some usages could not be mapped, please use HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE if this is legitimate.\n");
2364
2365 return 0;
2366
2367out_unwind:
2368 /* unwind the ones we already registered */
2369 hidinput_disconnect(hid);
2370
2371 return -1;
2372}
2373EXPORT_SYMBOL_GPL(hidinput_connect);
2374
2375void hidinput_disconnect(struct hid_device *hid)
2376{
2377 struct hid_input *hidinput, *next;
2378
2379 hidinput_cleanup_battery(dev: hid);
2380
2381 list_for_each_entry_safe(hidinput, next, &hid->inputs, list) {
2382 list_del(entry: &hidinput->list);
2383 if (hidinput->registered)
2384 input_unregister_device(hidinput->input);
2385 else
2386 input_free_device(dev: hidinput->input);
2387 kfree(objp: hidinput->name);
2388 kfree(objp: hidinput);
2389 }
2390
2391 /* led_work is spawned by input_dev callbacks, but doesn't access the
2392 * parent input_dev at all. Once all input devices are removed, we
2393 * know that led_work will never get restarted, so we can cancel it
2394 * synchronously and are safe. */
2395 cancel_work_sync(work: &hid->led_work);
2396}
2397EXPORT_SYMBOL_GPL(hidinput_disconnect);
2398
2399#ifdef CONFIG_HID_KUNIT_TEST
2400#include "hid-input-test.c"
2401#endif
2402