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