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