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