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