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