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