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