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