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