xref: /openbmc/linux/drivers/hid/hid-input.c (revision 5bd8e16d)
1 /*
2  *  Copyright (c) 2000-2001 Vojtech Pavlik
3  *  Copyright (c) 2006-2010 Jiri Kosina
4  *
5  *  HID to Linux Input mapping
6  */
7 
8 /*
9  * This program is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 2 of the License, or
12  * (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software
21  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22  *
23  * Should you need to contact me, the author, you can do so either by
24  * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
25  * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
26  */
27 
28 #include <linux/module.h>
29 #include <linux/slab.h>
30 #include <linux/kernel.h>
31 
32 #include <linux/hid.h>
33 #include <linux/hid-debug.h>
34 
35 #include "hid-ids.h"
36 
37 #define unk	KEY_UNKNOWN
38 
39 static const unsigned char hid_keyboard[256] = {
40 	  0,  0,  0,  0, 30, 48, 46, 32, 18, 33, 34, 35, 23, 36, 37, 38,
41 	 50, 49, 24, 25, 16, 19, 31, 20, 22, 47, 17, 45, 21, 44,  2,  3,
42 	  4,  5,  6,  7,  8,  9, 10, 11, 28,  1, 14, 15, 57, 12, 13, 26,
43 	 27, 43, 43, 39, 40, 41, 51, 52, 53, 58, 59, 60, 61, 62, 63, 64,
44 	 65, 66, 67, 68, 87, 88, 99, 70,119,110,102,104,111,107,109,106,
45 	105,108,103, 69, 98, 55, 74, 78, 96, 79, 80, 81, 75, 76, 77, 71,
46 	 72, 73, 82, 83, 86,127,116,117,183,184,185,186,187,188,189,190,
47 	191,192,193,194,134,138,130,132,128,129,131,137,133,135,136,113,
48 	115,114,unk,unk,unk,121,unk, 89, 93,124, 92, 94, 95,unk,unk,unk,
49 	122,123, 90, 91, 85,unk,unk,unk,unk,unk,unk,unk,111,unk,unk,unk,
50 	unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,
51 	unk,unk,unk,unk,unk,unk,179,180,unk,unk,unk,unk,unk,unk,unk,unk,
52 	unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,unk,
53 	unk,unk,unk,unk,unk,unk,unk,unk,111,unk,unk,unk,unk,unk,unk,unk,
54 	 29, 42, 56,125, 97, 54,100,126,164,166,165,163,161,115,114,113,
55 	150,158,159,128,136,177,178,176,142,152,173,140,unk,unk,unk,unk
56 };
57 
58 static const struct {
59 	__s32 x;
60 	__s32 y;
61 }  hid_hat_to_axis[] = {{ 0, 0}, { 0,-1}, { 1,-1}, { 1, 0}, { 1, 1}, { 0, 1}, {-1, 1}, {-1, 0}, {-1,-1}};
62 
63 #define map_abs(c)	hid_map_usage(hidinput, usage, &bit, &max, EV_ABS, (c))
64 #define map_rel(c)	hid_map_usage(hidinput, usage, &bit, &max, EV_REL, (c))
65 #define map_key(c)	hid_map_usage(hidinput, usage, &bit, &max, EV_KEY, (c))
66 #define map_led(c)	hid_map_usage(hidinput, usage, &bit, &max, EV_LED, (c))
67 
68 #define map_abs_clear(c)	hid_map_usage_clear(hidinput, usage, &bit, \
69 		&max, EV_ABS, (c))
70 #define map_key_clear(c)	hid_map_usage_clear(hidinput, usage, &bit, \
71 		&max, EV_KEY, (c))
72 
73 static bool match_scancode(struct hid_usage *usage,
74 			   unsigned int cur_idx, unsigned int scancode)
75 {
76 	return (usage->hid & (HID_USAGE_PAGE | HID_USAGE)) == scancode;
77 }
78 
79 static bool match_keycode(struct hid_usage *usage,
80 			  unsigned int cur_idx, unsigned int keycode)
81 {
82 	/*
83 	 * We should exclude unmapped usages when doing lookup by keycode.
84 	 */
85 	return (usage->type == EV_KEY && usage->code == keycode);
86 }
87 
88 static bool match_index(struct hid_usage *usage,
89 			unsigned int cur_idx, unsigned int idx)
90 {
91 	return cur_idx == idx;
92 }
93 
94 typedef bool (*hid_usage_cmp_t)(struct hid_usage *usage,
95 				unsigned int cur_idx, unsigned int val);
96 
97 static struct hid_usage *hidinput_find_key(struct hid_device *hid,
98 					   hid_usage_cmp_t match,
99 					   unsigned int value,
100 					   unsigned int *usage_idx)
101 {
102 	unsigned int i, j, k, cur_idx = 0;
103 	struct hid_report *report;
104 	struct hid_usage *usage;
105 
106 	for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
107 		list_for_each_entry(report, &hid->report_enum[k].report_list, list) {
108 			for (i = 0; i < report->maxfield; i++) {
109 				for (j = 0; j < report->field[i]->maxusage; j++) {
110 					usage = report->field[i]->usage + j;
111 					if (usage->type == EV_KEY || usage->type == 0) {
112 						if (match(usage, cur_idx, value)) {
113 							if (usage_idx)
114 								*usage_idx = cur_idx;
115 							return usage;
116 						}
117 						cur_idx++;
118 					}
119 				}
120 			}
121 		}
122 	}
123 	return NULL;
124 }
125 
126 static struct hid_usage *hidinput_locate_usage(struct hid_device *hid,
127 					const struct input_keymap_entry *ke,
128 					unsigned int *index)
129 {
130 	struct hid_usage *usage;
131 	unsigned int scancode;
132 
133 	if (ke->flags & INPUT_KEYMAP_BY_INDEX)
134 		usage = hidinput_find_key(hid, match_index, ke->index, index);
135 	else if (input_scancode_to_scalar(ke, &scancode) == 0)
136 		usage = hidinput_find_key(hid, match_scancode, scancode, index);
137 	else
138 		usage = NULL;
139 
140 	return usage;
141 }
142 
143 static int hidinput_getkeycode(struct input_dev *dev,
144 			       struct input_keymap_entry *ke)
145 {
146 	struct hid_device *hid = input_get_drvdata(dev);
147 	struct hid_usage *usage;
148 	unsigned int scancode, index;
149 
150 	usage = hidinput_locate_usage(hid, ke, &index);
151 	if (usage) {
152 		ke->keycode = usage->type == EV_KEY ?
153 				usage->code : KEY_RESERVED;
154 		ke->index = index;
155 		scancode = usage->hid & (HID_USAGE_PAGE | HID_USAGE);
156 		ke->len = sizeof(scancode);
157 		memcpy(ke->scancode, &scancode, sizeof(scancode));
158 		return 0;
159 	}
160 
161 	return -EINVAL;
162 }
163 
164 static int hidinput_setkeycode(struct input_dev *dev,
165 			       const struct input_keymap_entry *ke,
166 			       unsigned int *old_keycode)
167 {
168 	struct hid_device *hid = input_get_drvdata(dev);
169 	struct hid_usage *usage;
170 
171 	usage = hidinput_locate_usage(hid, ke, NULL);
172 	if (usage) {
173 		*old_keycode = usage->type == EV_KEY ?
174 				usage->code : KEY_RESERVED;
175 		usage->code = ke->keycode;
176 
177 		clear_bit(*old_keycode, dev->keybit);
178 		set_bit(usage->code, dev->keybit);
179 		dbg_hid("Assigned keycode %d to HID usage code %x\n",
180 			usage->code, usage->hid);
181 
182 		/*
183 		 * Set the keybit for the old keycode if the old keycode is used
184 		 * by another key
185 		 */
186 		if (hidinput_find_key(hid, match_keycode, *old_keycode, NULL))
187 			set_bit(*old_keycode, dev->keybit);
188 
189 		return 0;
190 	}
191 
192 	return -EINVAL;
193 }
194 
195 /**
196  * hidinput_calc_abs_res - calculate an absolute axis resolution
197  * @field: the HID report field to calculate resolution for
198  * @code: axis code
199  *
200  * The formula is:
201  *                         (logical_maximum - logical_minimum)
202  * resolution = ----------------------------------------------------------
203  *              (physical_maximum - physical_minimum) * 10 ^ unit_exponent
204  *
205  * as seen in the HID specification v1.11 6.2.2.7 Global Items.
206  *
207  * Only exponent 1 length units are processed. Centimeters and inches are
208  * converted to millimeters. Degrees are converted to radians.
209  */
210 __s32 hidinput_calc_abs_res(const struct hid_field *field, __u16 code)
211 {
212 	__s32 unit_exponent = field->unit_exponent;
213 	__s32 logical_extents = field->logical_maximum -
214 					field->logical_minimum;
215 	__s32 physical_extents = field->physical_maximum -
216 					field->physical_minimum;
217 	__s32 prev;
218 
219 	/* Check if the extents are sane */
220 	if (logical_extents <= 0 || physical_extents <= 0)
221 		return 0;
222 
223 	/*
224 	 * Verify and convert units.
225 	 * See HID specification v1.11 6.2.2.7 Global Items for unit decoding
226 	 */
227 	switch (code) {
228 	case ABS_X:
229 	case ABS_Y:
230 	case ABS_Z:
231 	case ABS_MT_POSITION_X:
232 	case ABS_MT_POSITION_Y:
233 	case ABS_MT_TOOL_X:
234 	case ABS_MT_TOOL_Y:
235 	case ABS_MT_TOUCH_MAJOR:
236 	case ABS_MT_TOUCH_MINOR:
237 		if (field->unit & 0xffffff00)		/* Not a length */
238 			return 0;
239 		unit_exponent += hid_snto32(field->unit >> 4, 4) - 1;
240 		switch (field->unit & 0xf) {
241 		case 0x1:				/* If centimeters */
242 			/* Convert to millimeters */
243 			unit_exponent += 1;
244 			break;
245 		case 0x3:				/* If inches */
246 			/* Convert to millimeters */
247 			prev = physical_extents;
248 			physical_extents *= 254;
249 			if (physical_extents < prev)
250 				return 0;
251 			unit_exponent -= 1;
252 			break;
253 		default:
254 			return 0;
255 		}
256 		break;
257 
258 	case ABS_RX:
259 	case ABS_RY:
260 	case ABS_RZ:
261 	case ABS_TILT_X:
262 	case ABS_TILT_Y:
263 		if (field->unit == 0x14) {		/* If degrees */
264 			/* Convert to radians */
265 			prev = logical_extents;
266 			logical_extents *= 573;
267 			if (logical_extents < prev)
268 				return 0;
269 			unit_exponent += 1;
270 		} else if (field->unit != 0x12) {	/* If not radians */
271 			return 0;
272 		}
273 		break;
274 
275 	default:
276 		return 0;
277 	}
278 
279 	/* Apply negative unit exponent */
280 	for (; unit_exponent < 0; unit_exponent++) {
281 		prev = logical_extents;
282 		logical_extents *= 10;
283 		if (logical_extents < prev)
284 			return 0;
285 	}
286 	/* Apply positive unit exponent */
287 	for (; unit_exponent > 0; unit_exponent--) {
288 		prev = physical_extents;
289 		physical_extents *= 10;
290 		if (physical_extents < prev)
291 			return 0;
292 	}
293 
294 	/* Calculate resolution */
295 	return DIV_ROUND_CLOSEST(logical_extents, physical_extents);
296 }
297 EXPORT_SYMBOL_GPL(hidinput_calc_abs_res);
298 
299 #ifdef CONFIG_HID_BATTERY_STRENGTH
300 static enum power_supply_property hidinput_battery_props[] = {
301 	POWER_SUPPLY_PROP_PRESENT,
302 	POWER_SUPPLY_PROP_ONLINE,
303 	POWER_SUPPLY_PROP_CAPACITY,
304 	POWER_SUPPLY_PROP_MODEL_NAME,
305 	POWER_SUPPLY_PROP_STATUS,
306 	POWER_SUPPLY_PROP_SCOPE,
307 };
308 
309 #define HID_BATTERY_QUIRK_PERCENT	(1 << 0) /* always reports percent */
310 #define HID_BATTERY_QUIRK_FEATURE	(1 << 1) /* ask for feature report */
311 
312 static const struct hid_device_id hid_battery_quirks[] = {
313 	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
314 			USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO),
315 	HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
316 	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
317 			       USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ANSI),
318 	  HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
319 	{ HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE,
320 		USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI),
321 	  HID_BATTERY_QUIRK_PERCENT | HID_BATTERY_QUIRK_FEATURE },
322 	{}
323 };
324 
325 static unsigned find_battery_quirk(struct hid_device *hdev)
326 {
327 	unsigned quirks = 0;
328 	const struct hid_device_id *match;
329 
330 	match = hid_match_id(hdev, hid_battery_quirks);
331 	if (match != NULL)
332 		quirks = match->driver_data;
333 
334 	return quirks;
335 }
336 
337 static int hidinput_get_battery_property(struct power_supply *psy,
338 					 enum power_supply_property prop,
339 					 union power_supply_propval *val)
340 {
341 	struct hid_device *dev = container_of(psy, struct hid_device, battery);
342 	int ret = 0;
343 	__u8 *buf;
344 
345 	switch (prop) {
346 	case POWER_SUPPLY_PROP_PRESENT:
347 	case POWER_SUPPLY_PROP_ONLINE:
348 		val->intval = 1;
349 		break;
350 
351 	case POWER_SUPPLY_PROP_CAPACITY:
352 
353 		buf = kmalloc(2 * sizeof(__u8), GFP_KERNEL);
354 		if (!buf) {
355 			ret = -ENOMEM;
356 			break;
357 		}
358 		ret = dev->hid_get_raw_report(dev, dev->battery_report_id,
359 					      buf, 2,
360 					      dev->battery_report_type);
361 
362 		if (ret != 2) {
363 			ret = -ENODATA;
364 			kfree(buf);
365 			break;
366 		}
367 		ret = 0;
368 
369 		if (dev->battery_min < dev->battery_max &&
370 		    buf[1] >= dev->battery_min &&
371 		    buf[1] <= dev->battery_max)
372 			val->intval = (100 * (buf[1] - dev->battery_min)) /
373 				(dev->battery_max - dev->battery_min);
374 		kfree(buf);
375 		break;
376 
377 	case POWER_SUPPLY_PROP_MODEL_NAME:
378 		val->strval = dev->name;
379 		break;
380 
381 	case POWER_SUPPLY_PROP_STATUS:
382 		val->intval = POWER_SUPPLY_STATUS_DISCHARGING;
383 		break;
384 
385 	case POWER_SUPPLY_PROP_SCOPE:
386 		val->intval = POWER_SUPPLY_SCOPE_DEVICE;
387 		break;
388 
389 	default:
390 		ret = -EINVAL;
391 		break;
392 	}
393 
394 	return ret;
395 }
396 
397 static bool hidinput_setup_battery(struct hid_device *dev, unsigned report_type, struct hid_field *field)
398 {
399 	struct power_supply *battery = &dev->battery;
400 	int ret;
401 	unsigned quirks;
402 	s32 min, max;
403 
404 	if (field->usage->hid != HID_DC_BATTERYSTRENGTH)
405 		return false;	/* no match */
406 
407 	if (battery->name != NULL)
408 		goto out;	/* already initialized? */
409 
410 	battery->name = kasprintf(GFP_KERNEL, "hid-%s-battery", dev->uniq);
411 	if (battery->name == NULL)
412 		goto out;
413 
414 	battery->type = POWER_SUPPLY_TYPE_BATTERY;
415 	battery->properties = hidinput_battery_props;
416 	battery->num_properties = ARRAY_SIZE(hidinput_battery_props);
417 	battery->use_for_apm = 0;
418 	battery->get_property = hidinput_get_battery_property;
419 
420 	quirks = find_battery_quirk(dev);
421 
422 	hid_dbg(dev, "device %x:%x:%x %d quirks %d\n",
423 		dev->bus, dev->vendor, dev->product, dev->version, quirks);
424 
425 	min = field->logical_minimum;
426 	max = field->logical_maximum;
427 
428 	if (quirks & HID_BATTERY_QUIRK_PERCENT) {
429 		min = 0;
430 		max = 100;
431 	}
432 
433 	if (quirks & HID_BATTERY_QUIRK_FEATURE)
434 		report_type = HID_FEATURE_REPORT;
435 
436 	dev->battery_min = min;
437 	dev->battery_max = max;
438 	dev->battery_report_type = report_type;
439 	dev->battery_report_id = field->report->id;
440 
441 	ret = power_supply_register(&dev->dev, battery);
442 	if (ret != 0) {
443 		hid_warn(dev, "can't register power supply: %d\n", ret);
444 		kfree(battery->name);
445 		battery->name = NULL;
446 	}
447 
448 	power_supply_powers(battery, &dev->dev);
449 
450 out:
451 	return true;
452 }
453 
454 static void hidinput_cleanup_battery(struct hid_device *dev)
455 {
456 	if (!dev->battery.name)
457 		return;
458 
459 	power_supply_unregister(&dev->battery);
460 	kfree(dev->battery.name);
461 	dev->battery.name = NULL;
462 }
463 #else  /* !CONFIG_HID_BATTERY_STRENGTH */
464 static bool hidinput_setup_battery(struct hid_device *dev, unsigned report_type,
465 				   struct hid_field *field)
466 {
467 	return false;
468 }
469 
470 static void hidinput_cleanup_battery(struct hid_device *dev)
471 {
472 }
473 #endif	/* CONFIG_HID_BATTERY_STRENGTH */
474 
475 static void hidinput_configure_usage(struct hid_input *hidinput, struct hid_field *field,
476 				     struct hid_usage *usage)
477 {
478 	struct input_dev *input = hidinput->input;
479 	struct hid_device *device = input_get_drvdata(input);
480 	int max = 0, code;
481 	unsigned long *bit = NULL;
482 
483 	field->hidinput = hidinput;
484 
485 	if (field->flags & HID_MAIN_ITEM_CONSTANT)
486 		goto ignore;
487 
488 	/* Ignore if report count is out of bounds. */
489 	if (field->report_count < 1)
490 		goto ignore;
491 
492 	/* only LED usages are supported in output fields */
493 	if (field->report_type == HID_OUTPUT_REPORT &&
494 			(usage->hid & HID_USAGE_PAGE) != HID_UP_LED) {
495 		goto ignore;
496 	}
497 
498 	if (device->driver->input_mapping) {
499 		int ret = device->driver->input_mapping(device, hidinput, field,
500 				usage, &bit, &max);
501 		if (ret > 0)
502 			goto mapped;
503 		if (ret < 0)
504 			goto ignore;
505 	}
506 
507 	switch (usage->hid & HID_USAGE_PAGE) {
508 	case HID_UP_UNDEFINED:
509 		goto ignore;
510 
511 	case HID_UP_KEYBOARD:
512 		set_bit(EV_REP, input->evbit);
513 
514 		if ((usage->hid & HID_USAGE) < 256) {
515 			if (!hid_keyboard[usage->hid & HID_USAGE]) goto ignore;
516 			map_key_clear(hid_keyboard[usage->hid & HID_USAGE]);
517 		} else
518 			map_key(KEY_UNKNOWN);
519 
520 		break;
521 
522 	case HID_UP_BUTTON:
523 		code = ((usage->hid - 1) & HID_USAGE);
524 
525 		switch (field->application) {
526 		case HID_GD_MOUSE:
527 		case HID_GD_POINTER:  code += BTN_MOUSE; break;
528 		case HID_GD_JOYSTICK:
529 				if (code <= 0xf)
530 					code += BTN_JOYSTICK;
531 				else
532 					code += BTN_TRIGGER_HAPPY - 0x10;
533 				break;
534 		case HID_GD_GAMEPAD:
535 				if (code <= 0xf)
536 					code += BTN_GAMEPAD;
537 				else
538 					code += BTN_TRIGGER_HAPPY - 0x10;
539 				break;
540 		default:
541 			switch (field->physical) {
542 			case HID_GD_MOUSE:
543 			case HID_GD_POINTER:  code += BTN_MOUSE; break;
544 			case HID_GD_JOYSTICK: code += BTN_JOYSTICK; break;
545 			case HID_GD_GAMEPAD:  code += BTN_GAMEPAD; break;
546 			default:              code += BTN_MISC;
547 			}
548 		}
549 
550 		map_key(code);
551 		break;
552 
553 	case HID_UP_SIMULATION:
554 		switch (usage->hid & 0xffff) {
555 		case 0xba: map_abs(ABS_RUDDER);   break;
556 		case 0xbb: map_abs(ABS_THROTTLE); break;
557 		case 0xc4: map_abs(ABS_GAS);      break;
558 		case 0xc5: map_abs(ABS_BRAKE);    break;
559 		case 0xc8: map_abs(ABS_WHEEL);    break;
560 		default:   goto ignore;
561 		}
562 		break;
563 
564 	case HID_UP_GENDESK:
565 		if ((usage->hid & 0xf0) == 0x80) {	/* SystemControl */
566 			switch (usage->hid & 0xf) {
567 			case 0x1: map_key_clear(KEY_POWER);  break;
568 			case 0x2: map_key_clear(KEY_SLEEP);  break;
569 			case 0x3: map_key_clear(KEY_WAKEUP); break;
570 			case 0x4: map_key_clear(KEY_CONTEXT_MENU); break;
571 			case 0x5: map_key_clear(KEY_MENU); break;
572 			case 0x6: map_key_clear(KEY_PROG1); break;
573 			case 0x7: map_key_clear(KEY_HELP); break;
574 			case 0x8: map_key_clear(KEY_EXIT); break;
575 			case 0x9: map_key_clear(KEY_SELECT); break;
576 			case 0xa: map_key_clear(KEY_RIGHT); break;
577 			case 0xb: map_key_clear(KEY_LEFT); break;
578 			case 0xc: map_key_clear(KEY_UP); break;
579 			case 0xd: map_key_clear(KEY_DOWN); break;
580 			case 0xe: map_key_clear(KEY_POWER2); break;
581 			case 0xf: map_key_clear(KEY_RESTART); break;
582 			default: goto unknown;
583 			}
584 			break;
585 		}
586 
587 		if ((usage->hid & 0xf0) == 0x90) {	/* D-pad */
588 			switch (usage->hid) {
589 			case HID_GD_UP:	   usage->hat_dir = 1; break;
590 			case HID_GD_DOWN:  usage->hat_dir = 5; break;
591 			case HID_GD_RIGHT: usage->hat_dir = 3; break;
592 			case HID_GD_LEFT:  usage->hat_dir = 7; break;
593 			default: goto unknown;
594 			}
595 			if (field->dpad) {
596 				map_abs(field->dpad);
597 				goto ignore;
598 			}
599 			map_abs(ABS_HAT0X);
600 			break;
601 		}
602 
603 		switch (usage->hid) {
604 		/* These usage IDs map directly to the usage codes. */
605 		case HID_GD_X: case HID_GD_Y: case HID_GD_Z:
606 		case HID_GD_RX: case HID_GD_RY: case HID_GD_RZ:
607 		case HID_GD_SLIDER: case HID_GD_DIAL: case HID_GD_WHEEL:
608 			if (field->flags & HID_MAIN_ITEM_RELATIVE)
609 				map_rel(usage->hid & 0xf);
610 			else
611 				map_abs(usage->hid & 0xf);
612 			break;
613 
614 		case HID_GD_HATSWITCH:
615 			usage->hat_min = field->logical_minimum;
616 			usage->hat_max = field->logical_maximum;
617 			map_abs(ABS_HAT0X);
618 			break;
619 
620 		case HID_GD_START:	map_key_clear(BTN_START);	break;
621 		case HID_GD_SELECT:	map_key_clear(BTN_SELECT);	break;
622 
623 		default: goto unknown;
624 		}
625 
626 		break;
627 
628 	case HID_UP_LED:
629 		switch (usage->hid & 0xffff) {		      /* HID-Value:                   */
630 		case 0x01:  map_led (LED_NUML);     break;    /*   "Num Lock"                 */
631 		case 0x02:  map_led (LED_CAPSL);    break;    /*   "Caps Lock"                */
632 		case 0x03:  map_led (LED_SCROLLL);  break;    /*   "Scroll Lock"              */
633 		case 0x04:  map_led (LED_COMPOSE);  break;    /*   "Compose"                  */
634 		case 0x05:  map_led (LED_KANA);     break;    /*   "Kana"                     */
635 		case 0x27:  map_led (LED_SLEEP);    break;    /*   "Stand-By"                 */
636 		case 0x4c:  map_led (LED_SUSPEND);  break;    /*   "System Suspend"           */
637 		case 0x09:  map_led (LED_MUTE);     break;    /*   "Mute"                     */
638 		case 0x4b:  map_led (LED_MISC);     break;    /*   "Generic Indicator"        */
639 		case 0x19:  map_led (LED_MAIL);     break;    /*   "Message Waiting"          */
640 		case 0x4d:  map_led (LED_CHARGING); break;    /*   "External Power Connected" */
641 
642 		default: goto ignore;
643 		}
644 		break;
645 
646 	case HID_UP_DIGITIZER:
647 		switch (usage->hid & 0xff) {
648 		case 0x00: /* Undefined */
649 			goto ignore;
650 
651 		case 0x30: /* TipPressure */
652 			if (!test_bit(BTN_TOUCH, input->keybit)) {
653 				device->quirks |= HID_QUIRK_NOTOUCH;
654 				set_bit(EV_KEY, input->evbit);
655 				set_bit(BTN_TOUCH, input->keybit);
656 			}
657 			map_abs_clear(ABS_PRESSURE);
658 			break;
659 
660 		case 0x32: /* InRange */
661 			switch (field->physical & 0xff) {
662 			case 0x21: map_key(BTN_TOOL_MOUSE); break;
663 			case 0x22: map_key(BTN_TOOL_FINGER); break;
664 			default: map_key(BTN_TOOL_PEN); break;
665 			}
666 			break;
667 
668 		case 0x3c: /* Invert */
669 			map_key_clear(BTN_TOOL_RUBBER);
670 			break;
671 
672 		case 0x3d: /* X Tilt */
673 			map_abs_clear(ABS_TILT_X);
674 			break;
675 
676 		case 0x3e: /* Y Tilt */
677 			map_abs_clear(ABS_TILT_Y);
678 			break;
679 
680 		case 0x33: /* Touch */
681 		case 0x42: /* TipSwitch */
682 		case 0x43: /* TipSwitch2 */
683 			device->quirks &= ~HID_QUIRK_NOTOUCH;
684 			map_key_clear(BTN_TOUCH);
685 			break;
686 
687 		case 0x44: /* BarrelSwitch */
688 			map_key_clear(BTN_STYLUS);
689 			break;
690 
691 		case 0x46: /* TabletPick */
692 			map_key_clear(BTN_STYLUS2);
693 			break;
694 
695 		default:  goto unknown;
696 		}
697 		break;
698 
699 	case HID_UP_CONSUMER:	/* USB HUT v1.12, pages 75-84 */
700 		switch (usage->hid & HID_USAGE) {
701 		case 0x000: goto ignore;
702 		case 0x030: map_key_clear(KEY_POWER);		break;
703 		case 0x031: map_key_clear(KEY_RESTART);		break;
704 		case 0x032: map_key_clear(KEY_SLEEP);		break;
705 		case 0x034: map_key_clear(KEY_SLEEP);		break;
706 		case 0x035: map_key_clear(KEY_KBDILLUMTOGGLE);	break;
707 		case 0x036: map_key_clear(BTN_MISC);		break;
708 
709 		case 0x040: map_key_clear(KEY_MENU);		break; /* Menu */
710 		case 0x041: map_key_clear(KEY_SELECT);		break; /* Menu Pick */
711 		case 0x042: map_key_clear(KEY_UP);		break; /* Menu Up */
712 		case 0x043: map_key_clear(KEY_DOWN);		break; /* Menu Down */
713 		case 0x044: map_key_clear(KEY_LEFT);		break; /* Menu Left */
714 		case 0x045: map_key_clear(KEY_RIGHT);		break; /* Menu Right */
715 		case 0x046: map_key_clear(KEY_ESC);		break; /* Menu Escape */
716 		case 0x047: map_key_clear(KEY_KPPLUS);		break; /* Menu Value Increase */
717 		case 0x048: map_key_clear(KEY_KPMINUS);		break; /* Menu Value Decrease */
718 
719 		case 0x060: map_key_clear(KEY_INFO);		break; /* Data On Screen */
720 		case 0x061: map_key_clear(KEY_SUBTITLE);	break; /* Closed Caption */
721 		case 0x063: map_key_clear(KEY_VCR);		break; /* VCR/TV */
722 		case 0x065: map_key_clear(KEY_CAMERA);		break; /* Snapshot */
723 		case 0x069: map_key_clear(KEY_RED);		break;
724 		case 0x06a: map_key_clear(KEY_GREEN);		break;
725 		case 0x06b: map_key_clear(KEY_BLUE);		break;
726 		case 0x06c: map_key_clear(KEY_YELLOW);		break;
727 		case 0x06d: map_key_clear(KEY_ZOOM);		break;
728 
729 		case 0x082: map_key_clear(KEY_VIDEO_NEXT);	break;
730 		case 0x083: map_key_clear(KEY_LAST);		break;
731 		case 0x084: map_key_clear(KEY_ENTER);		break;
732 		case 0x088: map_key_clear(KEY_PC);		break;
733 		case 0x089: map_key_clear(KEY_TV);		break;
734 		case 0x08a: map_key_clear(KEY_WWW);		break;
735 		case 0x08b: map_key_clear(KEY_DVD);		break;
736 		case 0x08c: map_key_clear(KEY_PHONE);		break;
737 		case 0x08d: map_key_clear(KEY_PROGRAM);		break;
738 		case 0x08e: map_key_clear(KEY_VIDEOPHONE);	break;
739 		case 0x08f: map_key_clear(KEY_GAMES);		break;
740 		case 0x090: map_key_clear(KEY_MEMO);		break;
741 		case 0x091: map_key_clear(KEY_CD);		break;
742 		case 0x092: map_key_clear(KEY_VCR);		break;
743 		case 0x093: map_key_clear(KEY_TUNER);		break;
744 		case 0x094: map_key_clear(KEY_EXIT);		break;
745 		case 0x095: map_key_clear(KEY_HELP);		break;
746 		case 0x096: map_key_clear(KEY_TAPE);		break;
747 		case 0x097: map_key_clear(KEY_TV2);		break;
748 		case 0x098: map_key_clear(KEY_SAT);		break;
749 		case 0x09a: map_key_clear(KEY_PVR);		break;
750 
751 		case 0x09c: map_key_clear(KEY_CHANNELUP);	break;
752 		case 0x09d: map_key_clear(KEY_CHANNELDOWN);	break;
753 		case 0x0a0: map_key_clear(KEY_VCR2);		break;
754 
755 		case 0x0b0: map_key_clear(KEY_PLAY);		break;
756 		case 0x0b1: map_key_clear(KEY_PAUSE);		break;
757 		case 0x0b2: map_key_clear(KEY_RECORD);		break;
758 		case 0x0b3: map_key_clear(KEY_FASTFORWARD);	break;
759 		case 0x0b4: map_key_clear(KEY_REWIND);		break;
760 		case 0x0b5: map_key_clear(KEY_NEXTSONG);	break;
761 		case 0x0b6: map_key_clear(KEY_PREVIOUSSONG);	break;
762 		case 0x0b7: map_key_clear(KEY_STOPCD);		break;
763 		case 0x0b8: map_key_clear(KEY_EJECTCD);		break;
764 		case 0x0bc: map_key_clear(KEY_MEDIA_REPEAT);	break;
765 		case 0x0b9: map_key_clear(KEY_SHUFFLE);		break;
766 		case 0x0bf: map_key_clear(KEY_SLOW);		break;
767 
768 		case 0x0cd: map_key_clear(KEY_PLAYPAUSE);	break;
769 		case 0x0e0: map_abs_clear(ABS_VOLUME);		break;
770 		case 0x0e2: map_key_clear(KEY_MUTE);		break;
771 		case 0x0e5: map_key_clear(KEY_BASSBOOST);	break;
772 		case 0x0e9: map_key_clear(KEY_VOLUMEUP);	break;
773 		case 0x0ea: map_key_clear(KEY_VOLUMEDOWN);	break;
774 		case 0x0f5: map_key_clear(KEY_SLOW);		break;
775 
776 		case 0x182: map_key_clear(KEY_BOOKMARKS);	break;
777 		case 0x183: map_key_clear(KEY_CONFIG);		break;
778 		case 0x184: map_key_clear(KEY_WORDPROCESSOR);	break;
779 		case 0x185: map_key_clear(KEY_EDITOR);		break;
780 		case 0x186: map_key_clear(KEY_SPREADSHEET);	break;
781 		case 0x187: map_key_clear(KEY_GRAPHICSEDITOR);	break;
782 		case 0x188: map_key_clear(KEY_PRESENTATION);	break;
783 		case 0x189: map_key_clear(KEY_DATABASE);	break;
784 		case 0x18a: map_key_clear(KEY_MAIL);		break;
785 		case 0x18b: map_key_clear(KEY_NEWS);		break;
786 		case 0x18c: map_key_clear(KEY_VOICEMAIL);	break;
787 		case 0x18d: map_key_clear(KEY_ADDRESSBOOK);	break;
788 		case 0x18e: map_key_clear(KEY_CALENDAR);	break;
789 		case 0x191: map_key_clear(KEY_FINANCE);		break;
790 		case 0x192: map_key_clear(KEY_CALC);		break;
791 		case 0x193: map_key_clear(KEY_PLAYER);		break;
792 		case 0x194: map_key_clear(KEY_FILE);		break;
793 		case 0x196: map_key_clear(KEY_WWW);		break;
794 		case 0x199: map_key_clear(KEY_CHAT);		break;
795 		case 0x19c: map_key_clear(KEY_LOGOFF);		break;
796 		case 0x19e: map_key_clear(KEY_COFFEE);		break;
797 		case 0x1a6: map_key_clear(KEY_HELP);		break;
798 		case 0x1a7: map_key_clear(KEY_DOCUMENTS);	break;
799 		case 0x1ab: map_key_clear(KEY_SPELLCHECK);	break;
800 		case 0x1ae: map_key_clear(KEY_KEYBOARD);	break;
801 		case 0x1b6: map_key_clear(KEY_IMAGES);		break;
802 		case 0x1b7: map_key_clear(KEY_AUDIO);		break;
803 		case 0x1b8: map_key_clear(KEY_VIDEO);		break;
804 		case 0x1bc: map_key_clear(KEY_MESSENGER);	break;
805 		case 0x1bd: map_key_clear(KEY_INFO);		break;
806 		case 0x201: map_key_clear(KEY_NEW);		break;
807 		case 0x202: map_key_clear(KEY_OPEN);		break;
808 		case 0x203: map_key_clear(KEY_CLOSE);		break;
809 		case 0x204: map_key_clear(KEY_EXIT);		break;
810 		case 0x207: map_key_clear(KEY_SAVE);		break;
811 		case 0x208: map_key_clear(KEY_PRINT);		break;
812 		case 0x209: map_key_clear(KEY_PROPS);		break;
813 		case 0x21a: map_key_clear(KEY_UNDO);		break;
814 		case 0x21b: map_key_clear(KEY_COPY);		break;
815 		case 0x21c: map_key_clear(KEY_CUT);		break;
816 		case 0x21d: map_key_clear(KEY_PASTE);		break;
817 		case 0x21f: map_key_clear(KEY_FIND);		break;
818 		case 0x221: map_key_clear(KEY_SEARCH);		break;
819 		case 0x222: map_key_clear(KEY_GOTO);		break;
820 		case 0x223: map_key_clear(KEY_HOMEPAGE);	break;
821 		case 0x224: map_key_clear(KEY_BACK);		break;
822 		case 0x225: map_key_clear(KEY_FORWARD);		break;
823 		case 0x226: map_key_clear(KEY_STOP);		break;
824 		case 0x227: map_key_clear(KEY_REFRESH);		break;
825 		case 0x22a: map_key_clear(KEY_BOOKMARKS);	break;
826 		case 0x22d: map_key_clear(KEY_ZOOMIN);		break;
827 		case 0x22e: map_key_clear(KEY_ZOOMOUT);		break;
828 		case 0x22f: map_key_clear(KEY_ZOOMRESET);	break;
829 		case 0x233: map_key_clear(KEY_SCROLLUP);	break;
830 		case 0x234: map_key_clear(KEY_SCROLLDOWN);	break;
831 		case 0x238: map_rel(REL_HWHEEL);		break;
832 		case 0x23d: map_key_clear(KEY_EDIT);		break;
833 		case 0x25f: map_key_clear(KEY_CANCEL);		break;
834 		case 0x269: map_key_clear(KEY_INSERT);		break;
835 		case 0x26a: map_key_clear(KEY_DELETE);		break;
836 		case 0x279: map_key_clear(KEY_REDO);		break;
837 
838 		case 0x289: map_key_clear(KEY_REPLY);		break;
839 		case 0x28b: map_key_clear(KEY_FORWARDMAIL);	break;
840 		case 0x28c: map_key_clear(KEY_SEND);		break;
841 
842 		default:    goto ignore;
843 		}
844 		break;
845 
846 	case HID_UP_GENDEVCTRLS:
847 		if (hidinput_setup_battery(device, HID_INPUT_REPORT, field))
848 			goto ignore;
849 		else
850 			goto unknown;
851 		break;
852 
853 	case HID_UP_HPVENDOR:	/* Reported on a Dutch layout HP5308 */
854 		set_bit(EV_REP, input->evbit);
855 		switch (usage->hid & HID_USAGE) {
856 		case 0x021: map_key_clear(KEY_PRINT);           break;
857 		case 0x070: map_key_clear(KEY_HP);		break;
858 		case 0x071: map_key_clear(KEY_CAMERA);		break;
859 		case 0x072: map_key_clear(KEY_SOUND);		break;
860 		case 0x073: map_key_clear(KEY_QUESTION);	break;
861 		case 0x080: map_key_clear(KEY_EMAIL);		break;
862 		case 0x081: map_key_clear(KEY_CHAT);		break;
863 		case 0x082: map_key_clear(KEY_SEARCH);		break;
864 		case 0x083: map_key_clear(KEY_CONNECT);	        break;
865 		case 0x084: map_key_clear(KEY_FINANCE);		break;
866 		case 0x085: map_key_clear(KEY_SPORT);		break;
867 		case 0x086: map_key_clear(KEY_SHOP);	        break;
868 		default:    goto ignore;
869 		}
870 		break;
871 
872 	case HID_UP_HPVENDOR2:
873 		set_bit(EV_REP, input->evbit);
874 		switch (usage->hid & HID_USAGE) {
875 		case 0x003: map_key_clear(KEY_BRIGHTNESSDOWN);	break;
876 		case 0x004: map_key_clear(KEY_BRIGHTNESSUP);	break;
877 		default:    goto ignore;
878 		}
879 		break;
880 
881 	case HID_UP_MSVENDOR:
882 		goto ignore;
883 
884 	case HID_UP_CUSTOM: /* Reported on Logitech and Apple USB keyboards */
885 		set_bit(EV_REP, input->evbit);
886 		goto ignore;
887 
888 	case HID_UP_LOGIVENDOR:
889 		goto ignore;
890 
891 	case HID_UP_PID:
892 		switch (usage->hid & HID_USAGE) {
893 		case 0xa4: map_key_clear(BTN_DEAD);	break;
894 		default: goto ignore;
895 		}
896 		break;
897 
898 	default:
899 	unknown:
900 		if (field->report_size == 1) {
901 			if (field->report->type == HID_OUTPUT_REPORT) {
902 				map_led(LED_MISC);
903 				break;
904 			}
905 			map_key(BTN_MISC);
906 			break;
907 		}
908 		if (field->flags & HID_MAIN_ITEM_RELATIVE) {
909 			map_rel(REL_MISC);
910 			break;
911 		}
912 		map_abs(ABS_MISC);
913 		break;
914 	}
915 
916 mapped:
917 	if (device->driver->input_mapped && device->driver->input_mapped(device,
918 				hidinput, field, usage, &bit, &max) < 0)
919 		goto ignore;
920 
921 	set_bit(usage->type, input->evbit);
922 
923 	while (usage->code <= max && test_and_set_bit(usage->code, bit))
924 		usage->code = find_next_zero_bit(bit, max + 1, usage->code);
925 
926 	if (usage->code > max)
927 		goto ignore;
928 
929 
930 	if (usage->type == EV_ABS) {
931 
932 		int a = field->logical_minimum;
933 		int b = field->logical_maximum;
934 
935 		if ((device->quirks & HID_QUIRK_BADPAD) && (usage->code == ABS_X || usage->code == ABS_Y)) {
936 			a = field->logical_minimum = 0;
937 			b = field->logical_maximum = 255;
938 		}
939 
940 		if (field->application == HID_GD_GAMEPAD || field->application == HID_GD_JOYSTICK)
941 			input_set_abs_params(input, usage->code, a, b, (b - a) >> 8, (b - a) >> 4);
942 		else	input_set_abs_params(input, usage->code, a, b, 0, 0);
943 
944 		input_abs_set_res(input, usage->code,
945 				  hidinput_calc_abs_res(field, usage->code));
946 
947 		/* use a larger default input buffer for MT devices */
948 		if (usage->code == ABS_MT_POSITION_X && input->hint_events_per_packet == 0)
949 			input_set_events_per_packet(input, 60);
950 	}
951 
952 	if (usage->type == EV_ABS &&
953 	    (usage->hat_min < usage->hat_max || usage->hat_dir)) {
954 		int i;
955 		for (i = usage->code; i < usage->code + 2 && i <= max; i++) {
956 			input_set_abs_params(input, i, -1, 1, 0, 0);
957 			set_bit(i, input->absbit);
958 		}
959 		if (usage->hat_dir && !field->dpad)
960 			field->dpad = usage->code;
961 	}
962 
963 	/* for those devices which produce Consumer volume usage as relative,
964 	 * we emulate pressing volumeup/volumedown appropriate number of times
965 	 * in hidinput_hid_event()
966 	 */
967 	if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
968 			(usage->code == ABS_VOLUME)) {
969 		set_bit(KEY_VOLUMEUP, input->keybit);
970 		set_bit(KEY_VOLUMEDOWN, input->keybit);
971 	}
972 
973 	if (usage->type == EV_KEY) {
974 		set_bit(EV_MSC, input->evbit);
975 		set_bit(MSC_SCAN, input->mscbit);
976 	}
977 
978 ignore:
979 	return;
980 
981 }
982 
983 void hidinput_hid_event(struct hid_device *hid, struct hid_field *field, struct hid_usage *usage, __s32 value)
984 {
985 	struct input_dev *input;
986 	unsigned *quirks = &hid->quirks;
987 
988 	if (!field->hidinput)
989 		return;
990 
991 	input = field->hidinput->input;
992 
993 	if (!usage->type)
994 		return;
995 
996 	if (usage->hat_min < usage->hat_max || usage->hat_dir) {
997 		int hat_dir = usage->hat_dir;
998 		if (!hat_dir)
999 			hat_dir = (value - usage->hat_min) * 8 / (usage->hat_max - usage->hat_min + 1) + 1;
1000 		if (hat_dir < 0 || hat_dir > 8) hat_dir = 0;
1001 		input_event(input, usage->type, usage->code    , hid_hat_to_axis[hat_dir].x);
1002 		input_event(input, usage->type, usage->code + 1, hid_hat_to_axis[hat_dir].y);
1003 		return;
1004 	}
1005 
1006 	if (usage->hid == (HID_UP_DIGITIZER | 0x003c)) { /* Invert */
1007 		*quirks = value ? (*quirks | HID_QUIRK_INVERT) : (*quirks & ~HID_QUIRK_INVERT);
1008 		return;
1009 	}
1010 
1011 	if (usage->hid == (HID_UP_DIGITIZER | 0x0032)) { /* InRange */
1012 		if (value) {
1013 			input_event(input, usage->type, (*quirks & HID_QUIRK_INVERT) ? BTN_TOOL_RUBBER : usage->code, 1);
1014 			return;
1015 		}
1016 		input_event(input, usage->type, usage->code, 0);
1017 		input_event(input, usage->type, BTN_TOOL_RUBBER, 0);
1018 		return;
1019 	}
1020 
1021 	if (usage->hid == (HID_UP_DIGITIZER | 0x0030) && (*quirks & HID_QUIRK_NOTOUCH)) { /* Pressure */
1022 		int a = field->logical_minimum;
1023 		int b = field->logical_maximum;
1024 		input_event(input, EV_KEY, BTN_TOUCH, value > a + ((b - a) >> 3));
1025 	}
1026 
1027 	if (usage->hid == (HID_UP_PID | 0x83UL)) { /* Simultaneous Effects Max */
1028 		dbg_hid("Maximum Effects - %d\n",value);
1029 		return;
1030 	}
1031 
1032 	if (usage->hid == (HID_UP_PID | 0x7fUL)) {
1033 		dbg_hid("PID Pool Report\n");
1034 		return;
1035 	}
1036 
1037 	if ((usage->type == EV_KEY) && (usage->code == 0)) /* Key 0 is "unassigned", not KEY_UNKNOWN */
1038 		return;
1039 
1040 	if ((usage->type == EV_ABS) && (field->flags & HID_MAIN_ITEM_RELATIVE) &&
1041 			(usage->code == ABS_VOLUME)) {
1042 		int count = abs(value);
1043 		int direction = value > 0 ? KEY_VOLUMEUP : KEY_VOLUMEDOWN;
1044 		int i;
1045 
1046 		for (i = 0; i < count; i++) {
1047 			input_event(input, EV_KEY, direction, 1);
1048 			input_sync(input);
1049 			input_event(input, EV_KEY, direction, 0);
1050 			input_sync(input);
1051 		}
1052 		return;
1053 	}
1054 
1055 	/*
1056 	 * Ignore out-of-range values as per HID specification,
1057 	 * section 5.10 and 6.2.25.
1058 	 *
1059 	 * The logical_minimum < logical_maximum check is done so that we
1060 	 * don't unintentionally discard values sent by devices which
1061 	 * don't specify logical min and max.
1062 	 */
1063 	if ((field->flags & HID_MAIN_ITEM_VARIABLE) &&
1064 	    (field->logical_minimum < field->logical_maximum) &&
1065 	    (value < field->logical_minimum ||
1066 	     value > field->logical_maximum)) {
1067 		dbg_hid("Ignoring out-of-range value %x\n", value);
1068 		return;
1069 	}
1070 
1071 	/* report the usage code as scancode if the key status has changed */
1072 	if (usage->type == EV_KEY && !!test_bit(usage->code, input->key) != value)
1073 		input_event(input, EV_MSC, MSC_SCAN, usage->hid);
1074 
1075 	input_event(input, usage->type, usage->code, value);
1076 
1077 	if ((field->flags & HID_MAIN_ITEM_RELATIVE) && (usage->type == EV_KEY))
1078 		input_event(input, usage->type, usage->code, 0);
1079 }
1080 
1081 void hidinput_report_event(struct hid_device *hid, struct hid_report *report)
1082 {
1083 	struct hid_input *hidinput;
1084 
1085 	if (hid->quirks & HID_QUIRK_NO_INPUT_SYNC)
1086 		return;
1087 
1088 	list_for_each_entry(hidinput, &hid->inputs, list)
1089 		input_sync(hidinput->input);
1090 }
1091 EXPORT_SYMBOL_GPL(hidinput_report_event);
1092 
1093 int hidinput_find_field(struct hid_device *hid, unsigned int type, unsigned int code, struct hid_field **field)
1094 {
1095 	struct hid_report *report;
1096 	int i, j;
1097 
1098 	list_for_each_entry(report, &hid->report_enum[HID_OUTPUT_REPORT].report_list, list) {
1099 		for (i = 0; i < report->maxfield; i++) {
1100 			*field = report->field[i];
1101 			for (j = 0; j < (*field)->maxusage; j++)
1102 				if ((*field)->usage[j].type == type && (*field)->usage[j].code == code)
1103 					return j;
1104 		}
1105 	}
1106 	return -1;
1107 }
1108 EXPORT_SYMBOL_GPL(hidinput_find_field);
1109 
1110 struct hid_field *hidinput_get_led_field(struct hid_device *hid)
1111 {
1112 	struct hid_report *report;
1113 	struct hid_field *field;
1114 	int i, j;
1115 
1116 	list_for_each_entry(report,
1117 			    &hid->report_enum[HID_OUTPUT_REPORT].report_list,
1118 			    list) {
1119 		for (i = 0; i < report->maxfield; i++) {
1120 			field = report->field[i];
1121 			for (j = 0; j < field->maxusage; j++)
1122 				if (field->usage[j].type == EV_LED)
1123 					return field;
1124 		}
1125 	}
1126 	return NULL;
1127 }
1128 EXPORT_SYMBOL_GPL(hidinput_get_led_field);
1129 
1130 unsigned int hidinput_count_leds(struct hid_device *hid)
1131 {
1132 	struct hid_report *report;
1133 	struct hid_field *field;
1134 	int i, j;
1135 	unsigned int count = 0;
1136 
1137 	list_for_each_entry(report,
1138 			    &hid->report_enum[HID_OUTPUT_REPORT].report_list,
1139 			    list) {
1140 		for (i = 0; i < report->maxfield; i++) {
1141 			field = report->field[i];
1142 			for (j = 0; j < field->maxusage; j++)
1143 				if (field->usage[j].type == EV_LED &&
1144 				    field->value[j])
1145 					count += 1;
1146 		}
1147 	}
1148 	return count;
1149 }
1150 EXPORT_SYMBOL_GPL(hidinput_count_leds);
1151 
1152 static void hidinput_led_worker(struct work_struct *work)
1153 {
1154 	struct hid_device *hid = container_of(work, struct hid_device,
1155 					      led_work);
1156 	struct hid_field *field;
1157 	struct hid_report *report;
1158 	int len;
1159 	__u8 *buf;
1160 
1161 	field = hidinput_get_led_field(hid);
1162 	if (!field)
1163 		return;
1164 
1165 	/*
1166 	 * field->report is accessed unlocked regarding HID core. So there might
1167 	 * be another incoming SET-LED request from user-space, which changes
1168 	 * the LED state while we assemble our outgoing buffer. However, this
1169 	 * doesn't matter as hid_output_report() correctly converts it into a
1170 	 * boolean value no matter what information is currently set on the LED
1171 	 * field (even garbage). So the remote device will always get a valid
1172 	 * request.
1173 	 * And in case we send a wrong value, a next led worker is spawned
1174 	 * for every SET-LED request so the following worker will send the
1175 	 * correct value, guaranteed!
1176 	 */
1177 
1178 	report = field->report;
1179 
1180 	/* use custom SET_REPORT request if possible (asynchronous) */
1181 	if (hid->ll_driver->request)
1182 		return hid->ll_driver->request(hid, report, HID_REQ_SET_REPORT);
1183 
1184 	/* fall back to generic raw-output-report */
1185 	len = ((report->size - 1) >> 3) + 1 + (report->id > 0);
1186 	buf = kmalloc(len, GFP_KERNEL);
1187 	if (!buf)
1188 		return;
1189 
1190 	hid_output_report(report, buf);
1191 	/* synchronous output report */
1192 	hid->hid_output_raw_report(hid, buf, len, HID_OUTPUT_REPORT);
1193 	kfree(buf);
1194 }
1195 
1196 static int hidinput_input_event(struct input_dev *dev, unsigned int type,
1197 				unsigned int code, int value)
1198 {
1199 	struct hid_device *hid = input_get_drvdata(dev);
1200 	struct hid_field *field;
1201 	int offset;
1202 
1203 	if (type == EV_FF)
1204 		return input_ff_event(dev, type, code, value);
1205 
1206 	if (type != EV_LED)
1207 		return -1;
1208 
1209 	if ((offset = hidinput_find_field(hid, type, code, &field)) == -1) {
1210 		hid_warn(dev, "event field not found\n");
1211 		return -1;
1212 	}
1213 
1214 	hid_set_field(field, offset, value);
1215 
1216 	schedule_work(&hid->led_work);
1217 	return 0;
1218 }
1219 
1220 static int hidinput_open(struct input_dev *dev)
1221 {
1222 	struct hid_device *hid = input_get_drvdata(dev);
1223 
1224 	return hid_hw_open(hid);
1225 }
1226 
1227 static void hidinput_close(struct input_dev *dev)
1228 {
1229 	struct hid_device *hid = input_get_drvdata(dev);
1230 
1231 	hid_hw_close(hid);
1232 }
1233 
1234 static void report_features(struct hid_device *hid)
1235 {
1236 	struct hid_driver *drv = hid->driver;
1237 	struct hid_report_enum *rep_enum;
1238 	struct hid_report *rep;
1239 	int i, j;
1240 
1241 	rep_enum = &hid->report_enum[HID_FEATURE_REPORT];
1242 	list_for_each_entry(rep, &rep_enum->report_list, list)
1243 		for (i = 0; i < rep->maxfield; i++) {
1244 			/* Ignore if report count is out of bounds. */
1245 			if (rep->field[i]->report_count < 1)
1246 				continue;
1247 
1248 			for (j = 0; j < rep->field[i]->maxusage; j++) {
1249 				/* Verify if Battery Strength feature is available */
1250 				hidinput_setup_battery(hid, HID_FEATURE_REPORT, rep->field[i]);
1251 
1252 				if (drv->feature_mapping)
1253 					drv->feature_mapping(hid, rep->field[i],
1254 							     rep->field[i]->usage + j);
1255 			}
1256 		}
1257 }
1258 
1259 static struct hid_input *hidinput_allocate(struct hid_device *hid)
1260 {
1261 	struct hid_input *hidinput = kzalloc(sizeof(*hidinput), GFP_KERNEL);
1262 	struct input_dev *input_dev = input_allocate_device();
1263 	if (!hidinput || !input_dev) {
1264 		kfree(hidinput);
1265 		input_free_device(input_dev);
1266 		hid_err(hid, "Out of memory during hid input probe\n");
1267 		return NULL;
1268 	}
1269 
1270 	input_set_drvdata(input_dev, hid);
1271 	if (hid->ll_driver->hidinput_input_event)
1272 		input_dev->event = hid->ll_driver->hidinput_input_event;
1273 	else if (hid->ll_driver->request || hid->hid_output_raw_report)
1274 		input_dev->event = hidinput_input_event;
1275 	input_dev->open = hidinput_open;
1276 	input_dev->close = hidinput_close;
1277 	input_dev->setkeycode = hidinput_setkeycode;
1278 	input_dev->getkeycode = hidinput_getkeycode;
1279 
1280 	input_dev->name = hid->name;
1281 	input_dev->phys = hid->phys;
1282 	input_dev->uniq = hid->uniq;
1283 	input_dev->id.bustype = hid->bus;
1284 	input_dev->id.vendor  = hid->vendor;
1285 	input_dev->id.product = hid->product;
1286 	input_dev->id.version = hid->version;
1287 	input_dev->dev.parent = hid->dev.parent;
1288 	hidinput->input = input_dev;
1289 	list_add_tail(&hidinput->list, &hid->inputs);
1290 
1291 	return hidinput;
1292 }
1293 
1294 static bool hidinput_has_been_populated(struct hid_input *hidinput)
1295 {
1296 	int i;
1297 	unsigned long r = 0;
1298 
1299 	for (i = 0; i < BITS_TO_LONGS(EV_CNT); i++)
1300 		r |= hidinput->input->evbit[i];
1301 
1302 	for (i = 0; i < BITS_TO_LONGS(KEY_CNT); i++)
1303 		r |= hidinput->input->keybit[i];
1304 
1305 	for (i = 0; i < BITS_TO_LONGS(REL_CNT); i++)
1306 		r |= hidinput->input->relbit[i];
1307 
1308 	for (i = 0; i < BITS_TO_LONGS(ABS_CNT); i++)
1309 		r |= hidinput->input->absbit[i];
1310 
1311 	for (i = 0; i < BITS_TO_LONGS(MSC_CNT); i++)
1312 		r |= hidinput->input->mscbit[i];
1313 
1314 	for (i = 0; i < BITS_TO_LONGS(LED_CNT); i++)
1315 		r |= hidinput->input->ledbit[i];
1316 
1317 	for (i = 0; i < BITS_TO_LONGS(SND_CNT); i++)
1318 		r |= hidinput->input->sndbit[i];
1319 
1320 	for (i = 0; i < BITS_TO_LONGS(FF_CNT); i++)
1321 		r |= hidinput->input->ffbit[i];
1322 
1323 	for (i = 0; i < BITS_TO_LONGS(SW_CNT); i++)
1324 		r |= hidinput->input->swbit[i];
1325 
1326 	return !!r;
1327 }
1328 
1329 static void hidinput_cleanup_hidinput(struct hid_device *hid,
1330 		struct hid_input *hidinput)
1331 {
1332 	struct hid_report *report;
1333 	int i, k;
1334 
1335 	list_del(&hidinput->list);
1336 	input_free_device(hidinput->input);
1337 
1338 	for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
1339 		if (k == HID_OUTPUT_REPORT &&
1340 			hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
1341 			continue;
1342 
1343 		list_for_each_entry(report, &hid->report_enum[k].report_list,
1344 				    list) {
1345 
1346 			for (i = 0; i < report->maxfield; i++)
1347 				if (report->field[i]->hidinput == hidinput)
1348 					report->field[i]->hidinput = NULL;
1349 		}
1350 	}
1351 
1352 	kfree(hidinput);
1353 }
1354 
1355 /*
1356  * Register the input device; print a message.
1357  * Configure the input layer interface
1358  * Read all reports and initialize the absolute field values.
1359  */
1360 
1361 int hidinput_connect(struct hid_device *hid, unsigned int force)
1362 {
1363 	struct hid_driver *drv = hid->driver;
1364 	struct hid_report *report;
1365 	struct hid_input *hidinput = NULL;
1366 	int i, j, k;
1367 
1368 	INIT_LIST_HEAD(&hid->inputs);
1369 	INIT_WORK(&hid->led_work, hidinput_led_worker);
1370 
1371 	if (!force) {
1372 		for (i = 0; i < hid->maxcollection; i++) {
1373 			struct hid_collection *col = &hid->collection[i];
1374 			if (col->type == HID_COLLECTION_APPLICATION ||
1375 					col->type == HID_COLLECTION_PHYSICAL)
1376 				if (IS_INPUT_APPLICATION(col->usage))
1377 					break;
1378 		}
1379 
1380 		if (i == hid->maxcollection)
1381 			return -1;
1382 	}
1383 
1384 	report_features(hid);
1385 
1386 	for (k = HID_INPUT_REPORT; k <= HID_OUTPUT_REPORT; k++) {
1387 		if (k == HID_OUTPUT_REPORT &&
1388 			hid->quirks & HID_QUIRK_SKIP_OUTPUT_REPORTS)
1389 			continue;
1390 
1391 		list_for_each_entry(report, &hid->report_enum[k].report_list, list) {
1392 
1393 			if (!report->maxfield)
1394 				continue;
1395 
1396 			if (!hidinput) {
1397 				hidinput = hidinput_allocate(hid);
1398 				if (!hidinput)
1399 					goto out_unwind;
1400 			}
1401 
1402 			for (i = 0; i < report->maxfield; i++)
1403 				for (j = 0; j < report->field[i]->maxusage; j++)
1404 					hidinput_configure_usage(hidinput, report->field[i],
1405 								 report->field[i]->usage + j);
1406 
1407 			if ((hid->quirks & HID_QUIRK_NO_EMPTY_INPUT) &&
1408 			    !hidinput_has_been_populated(hidinput))
1409 				continue;
1410 
1411 			if (hid->quirks & HID_QUIRK_MULTI_INPUT) {
1412 				/* This will leave hidinput NULL, so that it
1413 				 * allocates another one if we have more inputs on
1414 				 * the same interface. Some devices (e.g. Happ's
1415 				 * UGCI) cram a lot of unrelated inputs into the
1416 				 * same interface. */
1417 				hidinput->report = report;
1418 				if (drv->input_configured)
1419 					drv->input_configured(hid, hidinput);
1420 				if (input_register_device(hidinput->input))
1421 					goto out_cleanup;
1422 				hidinput = NULL;
1423 			}
1424 		}
1425 	}
1426 
1427 	if (hidinput && (hid->quirks & HID_QUIRK_NO_EMPTY_INPUT) &&
1428 	    !hidinput_has_been_populated(hidinput)) {
1429 		/* no need to register an input device not populated */
1430 		hidinput_cleanup_hidinput(hid, hidinput);
1431 		hidinput = NULL;
1432 	}
1433 
1434 	if (list_empty(&hid->inputs)) {
1435 		hid_err(hid, "No inputs registered, leaving\n");
1436 		goto out_unwind;
1437 	}
1438 
1439 	if (hidinput) {
1440 		if (drv->input_configured)
1441 			drv->input_configured(hid, hidinput);
1442 		if (input_register_device(hidinput->input))
1443 			goto out_cleanup;
1444 	}
1445 
1446 	return 0;
1447 
1448 out_cleanup:
1449 	list_del(&hidinput->list);
1450 	input_free_device(hidinput->input);
1451 	kfree(hidinput);
1452 out_unwind:
1453 	/* unwind the ones we already registered */
1454 	hidinput_disconnect(hid);
1455 
1456 	return -1;
1457 }
1458 EXPORT_SYMBOL_GPL(hidinput_connect);
1459 
1460 void hidinput_disconnect(struct hid_device *hid)
1461 {
1462 	struct hid_input *hidinput, *next;
1463 
1464 	hidinput_cleanup_battery(hid);
1465 
1466 	list_for_each_entry_safe(hidinput, next, &hid->inputs, list) {
1467 		list_del(&hidinput->list);
1468 		input_unregister_device(hidinput->input);
1469 		kfree(hidinput);
1470 	}
1471 
1472 	/* led_work is spawned by input_dev callbacks, but doesn't access the
1473 	 * parent input_dev at all. Once all input devices are removed, we
1474 	 * know that led_work will never get restarted, so we can cancel it
1475 	 * synchronously and are safe. */
1476 	cancel_work_sync(&hid->led_work);
1477 }
1478 EXPORT_SYMBOL_GPL(hidinput_disconnect);
1479 
1480