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