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