1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Copyright (c) 2000-2001 Vojtech Pavlik
4 * Copyright (c) 2006-2010 Jiri Kosina
6 * HID to Linux Input mapping
11 * Should you need to contact me, the author, you can do so either by
12 * e-mail - mail your message to <vojtech@ucw.cz>, or by paper mail:
13 * Vojtech Pavlik, Simunkova 1594, Prague 8, 182 00 Czech Republic
16 #include <linux/module.h>
17 #include <linux/slab.h>
18 #include <linux/kernel.h>
20 #include <linux/hid.h>
21 #include <linux/hid-debug.h>
25 #define unk KEY_UNKNOWN
27 static const unsigned char hid_keyboard
[256] = {
28 0, 0, 0, 0, 30, 48, 46, 32, 18, 33, 34, 35, 23, 36, 37, 38,
29 50, 49, 24, 25, 16, 19, 31, 20, 22, 47, 17, 45, 21, 44, 2, 3,
30 4, 5, 6, 7, 8, 9, 10, 11, 28, 1, 14, 15, 57, 12, 13, 26,
31 27, 43, 43, 39, 40, 41, 51, 52, 53, 58, 59, 60, 61, 62, 63, 64,
32 65, 66, 67, 68, 87, 88, 99, 70,119,110,102,104,111,107,109,106,
33 105,108,103, 69, 98, 55, 74, 78, 96, 79, 80, 81, 75, 76, 77, 71,
34 72, 73, 82, 83, 86,127,116,117,183,184,185,186,187,188,189,190,
35 191,192,193,194,134,138,130,132,128,129,131,137,133,135,136,113,
36 115,114,unk
,unk
,unk
,121,unk
, 89, 93,124, 92, 94, 95,unk
,unk
,unk
,
37 122,123, 90, 91, 85,unk
,unk
,unk
,unk
,unk
,unk
,unk
,111,unk
,unk
,unk
,
38 unk
,unk
,unk
,unk
,unk
,unk
,unk
,unk
,unk
,unk
,unk
,unk
,unk
,unk
,unk
,unk
,
39 unk
,unk
,unk
,unk
,unk
,unk
,179,180,unk
,unk
,unk
,unk
,unk
,unk
,unk
,unk
,
40 unk
,unk
,unk
,unk
,unk
,unk
,unk
,unk
,unk
,unk
,unk
,unk
,unk
,unk
,unk
,unk
,
41 unk
,unk
,unk
,unk
,unk
,unk
,unk
,unk
,111,unk
,unk
,unk
,unk
,unk
,unk
,unk
,
42 29, 42, 56,125, 97, 54,100,126,164,166,165,163,161,115,114,113,
43 150,158,159,128,136,177,178,176,142,152,173,140,unk
,unk
,unk
,unk
49 } hid_hat_to_axis
[] = {{ 0, 0}, { 0,-1}, { 1,-1}, { 1, 0}, { 1, 1}, { 0, 1}, {-1, 1}, {-1, 0}, {-1,-1}};
51 #define map_abs(c) hid_map_usage(hidinput, usage, &bit, &max, EV_ABS, (c))
52 #define map_rel(c) hid_map_usage(hidinput, usage, &bit, &max, EV_REL, (c))
53 #define map_key(c) hid_map_usage(hidinput, usage, &bit, &max, EV_KEY, (c))
54 #define map_led(c) hid_map_usage(hidinput, usage, &bit, &max, EV_LED, (c))
56 #define map_abs_clear(c) hid_map_usage_clear(hidinput, usage, &bit, \
58 #define map_key_clear(c) hid_map_usage_clear(hidinput, usage, &bit, \
61 static bool match_scancode(struct hid_usage
*usage
,
62 unsigned int cur_idx
, unsigned int scancode
)
64 return (usage
->hid
& (HID_USAGE_PAGE
| HID_USAGE
)) == scancode
;
67 static bool match_keycode(struct hid_usage
*usage
,
68 unsigned int cur_idx
, unsigned int keycode
)
71 * We should exclude unmapped usages when doing lookup by keycode.
73 return (usage
->type
== EV_KEY
&& usage
->code
== keycode
);
76 static bool match_index(struct hid_usage
*usage
,
77 unsigned int cur_idx
, unsigned int idx
)
79 return cur_idx
== idx
;
82 typedef bool (*hid_usage_cmp_t
)(struct hid_usage
*usage
,
83 unsigned int cur_idx
, unsigned int val
);
85 static struct hid_usage
*hidinput_find_key(struct hid_device
*hid
,
86 hid_usage_cmp_t match
,
88 unsigned int *usage_idx
)
90 unsigned int i
, j
, k
, cur_idx
= 0;
91 struct hid_report
*report
;
92 struct hid_usage
*usage
;
94 for (k
= HID_INPUT_REPORT
; k
<= HID_OUTPUT_REPORT
; k
++) {
95 list_for_each_entry(report
, &hid
->report_enum
[k
].report_list
, list
) {
96 for (i
= 0; i
< report
->maxfield
; i
++) {
97 for (j
= 0; j
< report
->field
[i
]->maxusage
; j
++) {
98 usage
= report
->field
[i
]->usage
+ j
;
99 if (usage
->type
== EV_KEY
|| usage
->type
== 0) {
100 if (match(usage
, cur_idx
, value
)) {
102 *usage_idx
= cur_idx
;
114 static struct hid_usage
*hidinput_locate_usage(struct hid_device
*hid
,
115 const struct input_keymap_entry
*ke
,
118 struct hid_usage
*usage
;
119 unsigned int scancode
;
121 if (ke
->flags
& INPUT_KEYMAP_BY_INDEX
)
122 usage
= hidinput_find_key(hid
, match_index
, ke
->index
, index
);
123 else if (input_scancode_to_scalar(ke
, &scancode
) == 0)
124 usage
= hidinput_find_key(hid
, match_scancode
, scancode
, index
);
131 static int hidinput_getkeycode(struct input_dev
*dev
,
132 struct input_keymap_entry
*ke
)
134 struct hid_device
*hid
= input_get_drvdata(dev
);
135 struct hid_usage
*usage
;
136 unsigned int scancode
, index
;
138 usage
= hidinput_locate_usage(hid
, ke
, &index
);
140 ke
->keycode
= usage
->type
== EV_KEY
?
141 usage
->code
: KEY_RESERVED
;
143 scancode
= usage
->hid
& (HID_USAGE_PAGE
| HID_USAGE
);
144 ke
->len
= sizeof(scancode
);
145 memcpy(ke
->scancode
, &scancode
, sizeof(scancode
));
152 static int hidinput_setkeycode(struct input_dev
*dev
,
153 const struct input_keymap_entry
*ke
,
154 unsigned int *old_keycode
)
156 struct hid_device
*hid
= input_get_drvdata(dev
);
157 struct hid_usage
*usage
;
159 usage
= hidinput_locate_usage(hid
, ke
, NULL
);
161 *old_keycode
= usage
->type
== EV_KEY
?
162 usage
->code
: KEY_RESERVED
;
163 usage
->code
= ke
->keycode
;
165 clear_bit(*old_keycode
, dev
->keybit
);
166 set_bit(usage
->code
, dev
->keybit
);
167 dbg_hid("Assigned keycode %d to HID usage code %x\n",
168 usage
->code
, usage
->hid
);
171 * Set the keybit for the old keycode if the old keycode is used
174 if (hidinput_find_key(hid
, match_keycode
, *old_keycode
, NULL
))
175 set_bit(*old_keycode
, dev
->keybit
);
185 * hidinput_calc_abs_res - calculate an absolute axis resolution
186 * @field: the HID report field to calculate resolution for
190 * (logical_maximum - logical_minimum)
191 * resolution = ----------------------------------------------------------
192 * (physical_maximum - physical_minimum) * 10 ^ unit_exponent
194 * as seen in the HID specification v1.11 6.2.2.7 Global Items.
196 * Only exponent 1 length units are processed. Centimeters and inches are
197 * converted to millimeters. Degrees are converted to radians.
199 __s32
hidinput_calc_abs_res(const struct hid_field
*field
, __u16 code
)
201 __s32 unit_exponent
= field
->unit_exponent
;
202 __s32 logical_extents
= field
->logical_maximum
-
203 field
->logical_minimum
;
204 __s32 physical_extents
= field
->physical_maximum
-
205 field
->physical_minimum
;
208 /* Check if the extents are sane */
209 if (logical_extents
<= 0 || physical_extents
<= 0)
213 * Verify and convert units.
214 * See HID specification v1.11 6.2.2.7 Global Items for unit decoding
220 case ABS_MT_POSITION_X
:
221 case ABS_MT_POSITION_Y
:
224 case ABS_MT_TOUCH_MAJOR
:
225 case ABS_MT_TOUCH_MINOR
:
226 if (field
->unit
== 0x11) { /* If centimeters */
227 /* Convert to millimeters */
229 } else if (field
->unit
== 0x13) { /* If inches */
230 /* Convert to millimeters */
231 prev
= physical_extents
;
232 physical_extents
*= 254;
233 if (physical_extents
< prev
)
247 if (field
->unit
== 0x14) { /* If degrees */
248 /* Convert to radians */
249 prev
= logical_extents
;
250 logical_extents
*= 573;
251 if (logical_extents
< prev
)
254 } else if (field
->unit
!= 0x12) { /* If not radians */
263 /* Apply negative unit exponent */
264 for (; unit_exponent
< 0; unit_exponent
++) {
265 prev
= logical_extents
;
266 logical_extents
*= 10;
267 if (logical_extents
< prev
)
270 /* Apply positive unit exponent */
271 for (; unit_exponent
> 0; unit_exponent
--) {
272 prev
= physical_extents
;
273 physical_extents
*= 10;
274 if (physical_extents
< prev
)
278 /* Calculate resolution */
279 return DIV_ROUND_CLOSEST(logical_extents
, physical_extents
);
281 EXPORT_SYMBOL_GPL(hidinput_calc_abs_res
);
283 #ifdef CONFIG_HID_BATTERY_STRENGTH
284 static enum power_supply_property hidinput_battery_props
[] = {
285 POWER_SUPPLY_PROP_PRESENT
,
286 POWER_SUPPLY_PROP_ONLINE
,
287 POWER_SUPPLY_PROP_CAPACITY
,
288 POWER_SUPPLY_PROP_MODEL_NAME
,
289 POWER_SUPPLY_PROP_STATUS
,
290 POWER_SUPPLY_PROP_SCOPE
,
293 #define HID_BATTERY_QUIRK_PERCENT (1 << 0) /* always reports percent */
294 #define HID_BATTERY_QUIRK_FEATURE (1 << 1) /* ask for feature report */
295 #define HID_BATTERY_QUIRK_IGNORE (1 << 2) /* completely ignore the battery */
297 static const struct hid_device_id hid_battery_quirks
[] = {
298 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE
,
299 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ISO
),
300 HID_BATTERY_QUIRK_PERCENT
| HID_BATTERY_QUIRK_FEATURE
},
301 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE
,
302 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2009_ANSI
),
303 HID_BATTERY_QUIRK_PERCENT
| HID_BATTERY_QUIRK_FEATURE
},
304 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE
,
305 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ANSI
),
306 HID_BATTERY_QUIRK_PERCENT
| HID_BATTERY_QUIRK_FEATURE
},
307 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE
,
308 USB_DEVICE_ID_APPLE_ALU_WIRELESS_2011_ISO
),
309 HID_BATTERY_QUIRK_PERCENT
| HID_BATTERY_QUIRK_FEATURE
},
310 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_APPLE
,
311 USB_DEVICE_ID_APPLE_ALU_WIRELESS_ANSI
),
312 HID_BATTERY_QUIRK_PERCENT
| HID_BATTERY_QUIRK_FEATURE
},
313 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_ELECOM
,
314 USB_DEVICE_ID_ELECOM_BM084
),
315 HID_BATTERY_QUIRK_IGNORE
},
316 { HID_USB_DEVICE(USB_VENDOR_ID_SYMBOL
,
317 USB_DEVICE_ID_SYMBOL_SCANNER_3
),
318 HID_BATTERY_QUIRK_IGNORE
},
319 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_ASUSTEK
,
320 USB_DEVICE_ID_ASUSTEK_T100CHI_KEYBOARD
),
321 HID_BATTERY_QUIRK_IGNORE
},
325 static unsigned find_battery_quirk(struct hid_device
*hdev
)
328 const struct hid_device_id
*match
;
330 match
= hid_match_id(hdev
, hid_battery_quirks
);
332 quirks
= match
->driver_data
;
337 static int hidinput_scale_battery_capacity(struct hid_device
*dev
,
340 if (dev
->battery_min
< dev
->battery_max
&&
341 value
>= dev
->battery_min
&& value
<= dev
->battery_max
)
342 value
= ((value
- dev
->battery_min
) * 100) /
343 (dev
->battery_max
- dev
->battery_min
);
348 static int hidinput_query_battery_capacity(struct hid_device
*dev
)
353 buf
= kmalloc(4, GFP_KERNEL
);
357 ret
= hid_hw_raw_request(dev
, dev
->battery_report_id
, buf
, 4,
358 dev
->battery_report_type
, HID_REQ_GET_REPORT
);
364 ret
= hidinput_scale_battery_capacity(dev
, buf
[1]);
369 static int hidinput_get_battery_property(struct power_supply
*psy
,
370 enum power_supply_property prop
,
371 union power_supply_propval
*val
)
373 struct hid_device
*dev
= power_supply_get_drvdata(psy
);
378 case POWER_SUPPLY_PROP_PRESENT
:
379 case POWER_SUPPLY_PROP_ONLINE
:
383 case POWER_SUPPLY_PROP_CAPACITY
:
384 if (dev
->battery_status
!= HID_BATTERY_REPORTED
&&
385 !dev
->battery_avoid_query
) {
386 value
= hidinput_query_battery_capacity(dev
);
390 value
= dev
->battery_capacity
;
396 case POWER_SUPPLY_PROP_MODEL_NAME
:
397 val
->strval
= dev
->name
;
400 case POWER_SUPPLY_PROP_STATUS
:
401 if (dev
->battery_status
!= HID_BATTERY_REPORTED
&&
402 !dev
->battery_avoid_query
) {
403 value
= hidinput_query_battery_capacity(dev
);
407 dev
->battery_capacity
= value
;
408 dev
->battery_status
= HID_BATTERY_QUERIED
;
411 if (dev
->battery_status
== HID_BATTERY_UNKNOWN
)
412 val
->intval
= POWER_SUPPLY_STATUS_UNKNOWN
;
413 else if (dev
->battery_capacity
== 100)
414 val
->intval
= POWER_SUPPLY_STATUS_FULL
;
416 val
->intval
= POWER_SUPPLY_STATUS_DISCHARGING
;
419 case POWER_SUPPLY_PROP_SCOPE
:
420 val
->intval
= POWER_SUPPLY_SCOPE_DEVICE
;
431 static int hidinput_setup_battery(struct hid_device
*dev
, unsigned report_type
, struct hid_field
*field
)
433 struct power_supply_desc
*psy_desc
;
434 struct power_supply_config psy_cfg
= { .drv_data
= dev
, };
440 return 0; /* already initialized? */
442 quirks
= find_battery_quirk(dev
);
444 hid_dbg(dev
, "device %x:%x:%x %d quirks %d\n",
445 dev
->bus
, dev
->vendor
, dev
->product
, dev
->version
, quirks
);
447 if (quirks
& HID_BATTERY_QUIRK_IGNORE
)
450 psy_desc
= kzalloc(sizeof(*psy_desc
), GFP_KERNEL
);
454 psy_desc
->name
= kasprintf(GFP_KERNEL
, "hid-%s-battery",
456 dev
->uniq
: dev_name(&dev
->dev
));
457 if (!psy_desc
->name
) {
462 psy_desc
->type
= POWER_SUPPLY_TYPE_BATTERY
;
463 psy_desc
->properties
= hidinput_battery_props
;
464 psy_desc
->num_properties
= ARRAY_SIZE(hidinput_battery_props
);
465 psy_desc
->use_for_apm
= 0;
466 psy_desc
->get_property
= hidinput_get_battery_property
;
468 min
= field
->logical_minimum
;
469 max
= field
->logical_maximum
;
471 if (quirks
& HID_BATTERY_QUIRK_PERCENT
) {
476 if (quirks
& HID_BATTERY_QUIRK_FEATURE
)
477 report_type
= HID_FEATURE_REPORT
;
479 dev
->battery_min
= min
;
480 dev
->battery_max
= max
;
481 dev
->battery_report_type
= report_type
;
482 dev
->battery_report_id
= field
->report
->id
;
485 * Stylus is normally not connected to the device and thus we
486 * can't query the device and get meaningful battery strength.
487 * We have to wait for the device to report it on its own.
489 dev
->battery_avoid_query
= report_type
== HID_INPUT_REPORT
&&
490 field
->physical
== HID_DG_STYLUS
;
492 dev
->battery
= power_supply_register(&dev
->dev
, psy_desc
, &psy_cfg
);
493 if (IS_ERR(dev
->battery
)) {
494 error
= PTR_ERR(dev
->battery
);
495 hid_warn(dev
, "can't register power supply: %d\n", error
);
499 power_supply_powers(dev
->battery
, &dev
->dev
);
503 kfree(psy_desc
->name
);
510 static void hidinput_cleanup_battery(struct hid_device
*dev
)
512 const struct power_supply_desc
*psy_desc
;
517 psy_desc
= dev
->battery
->desc
;
518 power_supply_unregister(dev
->battery
);
519 kfree(psy_desc
->name
);
524 static void hidinput_update_battery(struct hid_device
*dev
, int value
)
531 if (value
== 0 || value
< dev
->battery_min
|| value
> dev
->battery_max
)
534 capacity
= hidinput_scale_battery_capacity(dev
, value
);
536 if (dev
->battery_status
!= HID_BATTERY_REPORTED
||
537 capacity
!= dev
->battery_capacity
) {
538 dev
->battery_capacity
= capacity
;
539 dev
->battery_status
= HID_BATTERY_REPORTED
;
540 power_supply_changed(dev
->battery
);
543 #else /* !CONFIG_HID_BATTERY_STRENGTH */
544 static int hidinput_setup_battery(struct hid_device
*dev
, unsigned report_type
,
545 struct hid_field
*field
)
550 static void hidinput_cleanup_battery(struct hid_device
*dev
)
554 static void hidinput_update_battery(struct hid_device
*dev
, int value
)
557 #endif /* CONFIG_HID_BATTERY_STRENGTH */
559 static void hidinput_configure_usage(struct hid_input
*hidinput
, struct hid_field
*field
,
560 struct hid_usage
*usage
)
562 struct input_dev
*input
= hidinput
->input
;
563 struct hid_device
*device
= input_get_drvdata(input
);
565 unsigned long *bit
= NULL
;
567 field
->hidinput
= hidinput
;
569 if (field
->flags
& HID_MAIN_ITEM_CONSTANT
)
572 /* Ignore if report count is out of bounds. */
573 if (field
->report_count
< 1)
576 /* only LED usages are supported in output fields */
577 if (field
->report_type
== HID_OUTPUT_REPORT
&&
578 (usage
->hid
& HID_USAGE_PAGE
) != HID_UP_LED
) {
582 if (device
->driver
->input_mapping
) {
583 int ret
= device
->driver
->input_mapping(device
, hidinput
, field
,
591 switch (usage
->hid
& HID_USAGE_PAGE
) {
592 case HID_UP_UNDEFINED
:
595 case HID_UP_KEYBOARD
:
596 set_bit(EV_REP
, input
->evbit
);
598 if ((usage
->hid
& HID_USAGE
) < 256) {
599 if (!hid_keyboard
[usage
->hid
& HID_USAGE
]) goto ignore
;
600 map_key_clear(hid_keyboard
[usage
->hid
& HID_USAGE
]);
602 map_key(KEY_UNKNOWN
);
607 code
= ((usage
->hid
- 1) & HID_USAGE
);
609 switch (field
->application
) {
611 case HID_GD_POINTER
: code
+= BTN_MOUSE
; break;
612 case HID_GD_JOYSTICK
:
614 code
+= BTN_JOYSTICK
;
616 code
+= BTN_TRIGGER_HAPPY
- 0x10;
622 code
+= BTN_TRIGGER_HAPPY
- 0x10;
625 switch (field
->physical
) {
627 case HID_GD_POINTER
: code
+= BTN_MOUSE
; break;
628 case HID_GD_JOYSTICK
: code
+= BTN_JOYSTICK
; break;
629 case HID_GD_GAMEPAD
: code
+= BTN_GAMEPAD
; break;
630 default: code
+= BTN_MISC
;
637 case HID_UP_SIMULATION
:
638 switch (usage
->hid
& 0xffff) {
639 case 0xba: map_abs(ABS_RUDDER
); break;
640 case 0xbb: map_abs(ABS_THROTTLE
); break;
641 case 0xc4: map_abs(ABS_GAS
); break;
642 case 0xc5: map_abs(ABS_BRAKE
); break;
643 case 0xc8: map_abs(ABS_WHEEL
); break;
644 default: goto ignore
;
649 if ((usage
->hid
& 0xf0) == 0x80) { /* SystemControl */
650 switch (usage
->hid
& 0xf) {
651 case 0x1: map_key_clear(KEY_POWER
); break;
652 case 0x2: map_key_clear(KEY_SLEEP
); break;
653 case 0x3: map_key_clear(KEY_WAKEUP
); break;
654 case 0x4: map_key_clear(KEY_CONTEXT_MENU
); break;
655 case 0x5: map_key_clear(KEY_MENU
); break;
656 case 0x6: map_key_clear(KEY_PROG1
); break;
657 case 0x7: map_key_clear(KEY_HELP
); break;
658 case 0x8: map_key_clear(KEY_EXIT
); break;
659 case 0x9: map_key_clear(KEY_SELECT
); break;
660 case 0xa: map_key_clear(KEY_RIGHT
); break;
661 case 0xb: map_key_clear(KEY_LEFT
); break;
662 case 0xc: map_key_clear(KEY_UP
); break;
663 case 0xd: map_key_clear(KEY_DOWN
); break;
664 case 0xe: map_key_clear(KEY_POWER2
); break;
665 case 0xf: map_key_clear(KEY_RESTART
); break;
666 default: goto unknown
;
671 if ((usage
->hid
& 0xf0) == 0xb0) { /* SC - Display */
672 switch (usage
->hid
& 0xf) {
673 case 0x05: map_key_clear(KEY_SWITCHVIDEOMODE
); break;
674 default: goto ignore
;
680 * Some lazy vendors declare 255 usages for System Control,
681 * leading to the creation of ABS_X|Y axis and too many others.
682 * It wouldn't be a problem if joydev doesn't consider the
683 * device as a joystick then.
685 if (field
->application
== HID_GD_SYSTEM_CONTROL
)
688 if ((usage
->hid
& 0xf0) == 0x90) { /* D-pad */
689 switch (usage
->hid
) {
690 case HID_GD_UP
: usage
->hat_dir
= 1; break;
691 case HID_GD_DOWN
: usage
->hat_dir
= 5; break;
692 case HID_GD_RIGHT
: usage
->hat_dir
= 3; break;
693 case HID_GD_LEFT
: usage
->hat_dir
= 7; break;
694 default: goto unknown
;
697 map_abs(field
->dpad
);
704 switch (usage
->hid
) {
705 /* These usage IDs map directly to the usage codes. */
706 case HID_GD_X
: case HID_GD_Y
: case HID_GD_Z
:
707 case HID_GD_RX
: case HID_GD_RY
: case HID_GD_RZ
:
708 if (field
->flags
& HID_MAIN_ITEM_RELATIVE
)
709 map_rel(usage
->hid
& 0xf);
711 map_abs_clear(usage
->hid
& 0xf);
715 if (field
->flags
& HID_MAIN_ITEM_RELATIVE
) {
716 set_bit(REL_WHEEL
, input
->relbit
);
717 map_rel(REL_WHEEL_HI_RES
);
719 map_abs(usage
->hid
& 0xf);
722 case HID_GD_SLIDER
: case HID_GD_DIAL
:
723 if (field
->flags
& HID_MAIN_ITEM_RELATIVE
)
724 map_rel(usage
->hid
& 0xf);
726 map_abs(usage
->hid
& 0xf);
729 case HID_GD_HATSWITCH
:
730 usage
->hat_min
= field
->logical_minimum
;
731 usage
->hat_max
= field
->logical_maximum
;
735 case HID_GD_START
: map_key_clear(BTN_START
); break;
736 case HID_GD_SELECT
: map_key_clear(BTN_SELECT
); break;
738 case HID_GD_RFKILL_BTN
:
739 /* MS wireless radio ctl extension, also check CA */
740 if (field
->application
== HID_GD_WIRELESS_RADIO_CTLS
) {
741 map_key_clear(KEY_RFKILL
);
742 /* We need to simulate the btn release */
743 field
->flags
|= HID_MAIN_ITEM_RELATIVE
;
747 default: goto unknown
;
753 switch (usage
->hid
& 0xffff) { /* HID-Value: */
754 case 0x01: map_led (LED_NUML
); break; /* "Num Lock" */
755 case 0x02: map_led (LED_CAPSL
); break; /* "Caps Lock" */
756 case 0x03: map_led (LED_SCROLLL
); break; /* "Scroll Lock" */
757 case 0x04: map_led (LED_COMPOSE
); break; /* "Compose" */
758 case 0x05: map_led (LED_KANA
); break; /* "Kana" */
759 case 0x27: map_led (LED_SLEEP
); break; /* "Stand-By" */
760 case 0x4c: map_led (LED_SUSPEND
); break; /* "System Suspend" */
761 case 0x09: map_led (LED_MUTE
); break; /* "Mute" */
762 case 0x4b: map_led (LED_MISC
); break; /* "Generic Indicator" */
763 case 0x19: map_led (LED_MAIL
); break; /* "Message Waiting" */
764 case 0x4d: map_led (LED_CHARGING
); break; /* "External Power Connected" */
766 default: goto ignore
;
770 case HID_UP_DIGITIZER
:
771 if ((field
->application
& 0xff) == 0x01) /* Digitizer */
772 __set_bit(INPUT_PROP_POINTER
, input
->propbit
);
773 else if ((field
->application
& 0xff) == 0x02) /* Pen */
774 __set_bit(INPUT_PROP_DIRECT
, input
->propbit
);
776 switch (usage
->hid
& 0xff) {
777 case 0x00: /* Undefined */
780 case 0x30: /* TipPressure */
781 if (!test_bit(BTN_TOUCH
, input
->keybit
)) {
782 device
->quirks
|= HID_QUIRK_NOTOUCH
;
783 set_bit(EV_KEY
, input
->evbit
);
784 set_bit(BTN_TOUCH
, input
->keybit
);
786 map_abs_clear(ABS_PRESSURE
);
789 case 0x32: /* InRange */
790 switch (field
->physical
& 0xff) {
791 case 0x21: map_key(BTN_TOOL_MOUSE
); break;
792 case 0x22: map_key(BTN_TOOL_FINGER
); break;
793 default: map_key(BTN_TOOL_PEN
); break;
797 case 0x3b: /* Battery Strength */
798 hidinput_setup_battery(device
, HID_INPUT_REPORT
, field
);
799 usage
->type
= EV_PWR
;
802 case 0x3c: /* Invert */
803 map_key_clear(BTN_TOOL_RUBBER
);
806 case 0x3d: /* X Tilt */
807 map_abs_clear(ABS_TILT_X
);
810 case 0x3e: /* Y Tilt */
811 map_abs_clear(ABS_TILT_Y
);
814 case 0x33: /* Touch */
815 case 0x42: /* TipSwitch */
816 case 0x43: /* TipSwitch2 */
817 device
->quirks
&= ~HID_QUIRK_NOTOUCH
;
818 map_key_clear(BTN_TOUCH
);
821 case 0x44: /* BarrelSwitch */
822 map_key_clear(BTN_STYLUS
);
825 case 0x45: /* ERASER */
827 * This event is reported when eraser tip touches the surface.
828 * Actual eraser (BTN_TOOL_RUBBER) is set by Invert usage when
829 * tool gets in proximity.
831 map_key_clear(BTN_TOUCH
);
834 case 0x46: /* TabletPick */
835 case 0x5a: /* SecondaryBarrelSwitch */
836 map_key_clear(BTN_STYLUS2
);
839 case 0x5b: /* TransducerSerialNumber */
840 usage
->type
= EV_MSC
;
841 usage
->code
= MSC_SERIAL
;
846 default: goto unknown
;
850 case HID_UP_TELEPHONY
:
851 switch (usage
->hid
& HID_USAGE
) {
852 case 0x2f: map_key_clear(KEY_MICMUTE
); break;
853 case 0xb0: map_key_clear(KEY_NUMERIC_0
); break;
854 case 0xb1: map_key_clear(KEY_NUMERIC_1
); break;
855 case 0xb2: map_key_clear(KEY_NUMERIC_2
); break;
856 case 0xb3: map_key_clear(KEY_NUMERIC_3
); break;
857 case 0xb4: map_key_clear(KEY_NUMERIC_4
); break;
858 case 0xb5: map_key_clear(KEY_NUMERIC_5
); break;
859 case 0xb6: map_key_clear(KEY_NUMERIC_6
); break;
860 case 0xb7: map_key_clear(KEY_NUMERIC_7
); break;
861 case 0xb8: map_key_clear(KEY_NUMERIC_8
); break;
862 case 0xb9: map_key_clear(KEY_NUMERIC_9
); break;
863 case 0xba: map_key_clear(KEY_NUMERIC_STAR
); break;
864 case 0xbb: map_key_clear(KEY_NUMERIC_POUND
); break;
865 case 0xbc: map_key_clear(KEY_NUMERIC_A
); break;
866 case 0xbd: map_key_clear(KEY_NUMERIC_B
); break;
867 case 0xbe: map_key_clear(KEY_NUMERIC_C
); break;
868 case 0xbf: map_key_clear(KEY_NUMERIC_D
); break;
869 default: goto ignore
;
873 case HID_UP_CONSUMER
: /* USB HUT v1.12, pages 75-84 */
874 switch (usage
->hid
& HID_USAGE
) {
875 case 0x000: goto ignore
;
876 case 0x030: map_key_clear(KEY_POWER
); break;
877 case 0x031: map_key_clear(KEY_RESTART
); break;
878 case 0x032: map_key_clear(KEY_SLEEP
); break;
879 case 0x034: map_key_clear(KEY_SLEEP
); break;
880 case 0x035: map_key_clear(KEY_KBDILLUMTOGGLE
); break;
881 case 0x036: map_key_clear(BTN_MISC
); break;
883 case 0x040: map_key_clear(KEY_MENU
); break; /* Menu */
884 case 0x041: map_key_clear(KEY_SELECT
); break; /* Menu Pick */
885 case 0x042: map_key_clear(KEY_UP
); break; /* Menu Up */
886 case 0x043: map_key_clear(KEY_DOWN
); break; /* Menu Down */
887 case 0x044: map_key_clear(KEY_LEFT
); break; /* Menu Left */
888 case 0x045: map_key_clear(KEY_RIGHT
); break; /* Menu Right */
889 case 0x046: map_key_clear(KEY_ESC
); break; /* Menu Escape */
890 case 0x047: map_key_clear(KEY_KPPLUS
); break; /* Menu Value Increase */
891 case 0x048: map_key_clear(KEY_KPMINUS
); break; /* Menu Value Decrease */
893 case 0x060: map_key_clear(KEY_INFO
); break; /* Data On Screen */
894 case 0x061: map_key_clear(KEY_SUBTITLE
); break; /* Closed Caption */
895 case 0x063: map_key_clear(KEY_VCR
); break; /* VCR/TV */
896 case 0x065: map_key_clear(KEY_CAMERA
); break; /* Snapshot */
897 case 0x069: map_key_clear(KEY_RED
); break;
898 case 0x06a: map_key_clear(KEY_GREEN
); break;
899 case 0x06b: map_key_clear(KEY_BLUE
); break;
900 case 0x06c: map_key_clear(KEY_YELLOW
); break;
901 case 0x06d: map_key_clear(KEY_ASPECT_RATIO
); break;
903 case 0x06f: map_key_clear(KEY_BRIGHTNESSUP
); break;
904 case 0x070: map_key_clear(KEY_BRIGHTNESSDOWN
); break;
905 case 0x072: map_key_clear(KEY_BRIGHTNESS_TOGGLE
); break;
906 case 0x073: map_key_clear(KEY_BRIGHTNESS_MIN
); break;
907 case 0x074: map_key_clear(KEY_BRIGHTNESS_MAX
); break;
908 case 0x075: map_key_clear(KEY_BRIGHTNESS_AUTO
); break;
910 case 0x079: map_key_clear(KEY_KBDILLUMUP
); break;
911 case 0x07a: map_key_clear(KEY_KBDILLUMDOWN
); break;
912 case 0x07c: map_key_clear(KEY_KBDILLUMTOGGLE
); break;
914 case 0x082: map_key_clear(KEY_VIDEO_NEXT
); break;
915 case 0x083: map_key_clear(KEY_LAST
); break;
916 case 0x084: map_key_clear(KEY_ENTER
); break;
917 case 0x088: map_key_clear(KEY_PC
); break;
918 case 0x089: map_key_clear(KEY_TV
); break;
919 case 0x08a: map_key_clear(KEY_WWW
); break;
920 case 0x08b: map_key_clear(KEY_DVD
); break;
921 case 0x08c: map_key_clear(KEY_PHONE
); break;
922 case 0x08d: map_key_clear(KEY_PROGRAM
); break;
923 case 0x08e: map_key_clear(KEY_VIDEOPHONE
); break;
924 case 0x08f: map_key_clear(KEY_GAMES
); break;
925 case 0x090: map_key_clear(KEY_MEMO
); break;
926 case 0x091: map_key_clear(KEY_CD
); break;
927 case 0x092: map_key_clear(KEY_VCR
); break;
928 case 0x093: map_key_clear(KEY_TUNER
); break;
929 case 0x094: map_key_clear(KEY_EXIT
); break;
930 case 0x095: map_key_clear(KEY_HELP
); break;
931 case 0x096: map_key_clear(KEY_TAPE
); break;
932 case 0x097: map_key_clear(KEY_TV2
); break;
933 case 0x098: map_key_clear(KEY_SAT
); break;
934 case 0x09a: map_key_clear(KEY_PVR
); break;
936 case 0x09c: map_key_clear(KEY_CHANNELUP
); break;
937 case 0x09d: map_key_clear(KEY_CHANNELDOWN
); break;
938 case 0x0a0: map_key_clear(KEY_VCR2
); break;
940 case 0x0b0: map_key_clear(KEY_PLAY
); break;
941 case 0x0b1: map_key_clear(KEY_PAUSE
); break;
942 case 0x0b2: map_key_clear(KEY_RECORD
); break;
943 case 0x0b3: map_key_clear(KEY_FASTFORWARD
); break;
944 case 0x0b4: map_key_clear(KEY_REWIND
); break;
945 case 0x0b5: map_key_clear(KEY_NEXTSONG
); break;
946 case 0x0b6: map_key_clear(KEY_PREVIOUSSONG
); break;
947 case 0x0b7: map_key_clear(KEY_STOPCD
); break;
948 case 0x0b8: map_key_clear(KEY_EJECTCD
); break;
949 case 0x0bc: map_key_clear(KEY_MEDIA_REPEAT
); break;
950 case 0x0b9: map_key_clear(KEY_SHUFFLE
); break;
951 case 0x0bf: map_key_clear(KEY_SLOW
); break;
953 case 0x0cd: map_key_clear(KEY_PLAYPAUSE
); break;
954 case 0x0cf: map_key_clear(KEY_VOICECOMMAND
); break;
955 case 0x0e0: map_abs_clear(ABS_VOLUME
); break;
956 case 0x0e2: map_key_clear(KEY_MUTE
); break;
957 case 0x0e5: map_key_clear(KEY_BASSBOOST
); break;
958 case 0x0e9: map_key_clear(KEY_VOLUMEUP
); break;
959 case 0x0ea: map_key_clear(KEY_VOLUMEDOWN
); break;
960 case 0x0f5: map_key_clear(KEY_SLOW
); break;
962 case 0x181: map_key_clear(KEY_BUTTONCONFIG
); break;
963 case 0x182: map_key_clear(KEY_BOOKMARKS
); break;
964 case 0x183: map_key_clear(KEY_CONFIG
); break;
965 case 0x184: map_key_clear(KEY_WORDPROCESSOR
); break;
966 case 0x185: map_key_clear(KEY_EDITOR
); break;
967 case 0x186: map_key_clear(KEY_SPREADSHEET
); break;
968 case 0x187: map_key_clear(KEY_GRAPHICSEDITOR
); break;
969 case 0x188: map_key_clear(KEY_PRESENTATION
); break;
970 case 0x189: map_key_clear(KEY_DATABASE
); break;
971 case 0x18a: map_key_clear(KEY_MAIL
); break;
972 case 0x18b: map_key_clear(KEY_NEWS
); break;
973 case 0x18c: map_key_clear(KEY_VOICEMAIL
); break;
974 case 0x18d: map_key_clear(KEY_ADDRESSBOOK
); break;
975 case 0x18e: map_key_clear(KEY_CALENDAR
); break;
976 case 0x18f: map_key_clear(KEY_TASKMANAGER
); break;
977 case 0x190: map_key_clear(KEY_JOURNAL
); break;
978 case 0x191: map_key_clear(KEY_FINANCE
); break;
979 case 0x192: map_key_clear(KEY_CALC
); break;
980 case 0x193: map_key_clear(KEY_PLAYER
); break;
981 case 0x194: map_key_clear(KEY_FILE
); break;
982 case 0x196: map_key_clear(KEY_WWW
); break;
983 case 0x199: map_key_clear(KEY_CHAT
); break;
984 case 0x19c: map_key_clear(KEY_LOGOFF
); break;
985 case 0x19e: map_key_clear(KEY_COFFEE
); break;
986 case 0x19f: map_key_clear(KEY_CONTROLPANEL
); break;
987 case 0x1a2: map_key_clear(KEY_APPSELECT
); break;
988 case 0x1a3: map_key_clear(KEY_NEXT
); break;
989 case 0x1a4: map_key_clear(KEY_PREVIOUS
); break;
990 case 0x1a6: map_key_clear(KEY_HELP
); break;
991 case 0x1a7: map_key_clear(KEY_DOCUMENTS
); break;
992 case 0x1ab: map_key_clear(KEY_SPELLCHECK
); break;
993 case 0x1ae: map_key_clear(KEY_KEYBOARD
); break;
994 case 0x1b1: map_key_clear(KEY_SCREENSAVER
); break;
995 case 0x1b4: map_key_clear(KEY_FILE
); break;
996 case 0x1b6: map_key_clear(KEY_IMAGES
); break;
997 case 0x1b7: map_key_clear(KEY_AUDIO
); break;
998 case 0x1b8: map_key_clear(KEY_VIDEO
); break;
999 case 0x1bc: map_key_clear(KEY_MESSENGER
); break;
1000 case 0x1bd: map_key_clear(KEY_INFO
); break;
1001 case 0x1cb: map_key_clear(KEY_ASSISTANT
); break;
1002 case 0x201: map_key_clear(KEY_NEW
); break;
1003 case 0x202: map_key_clear(KEY_OPEN
); break;
1004 case 0x203: map_key_clear(KEY_CLOSE
); break;
1005 case 0x204: map_key_clear(KEY_EXIT
); break;
1006 case 0x207: map_key_clear(KEY_SAVE
); break;
1007 case 0x208: map_key_clear(KEY_PRINT
); break;
1008 case 0x209: map_key_clear(KEY_PROPS
); break;
1009 case 0x21a: map_key_clear(KEY_UNDO
); break;
1010 case 0x21b: map_key_clear(KEY_COPY
); break;
1011 case 0x21c: map_key_clear(KEY_CUT
); break;
1012 case 0x21d: map_key_clear(KEY_PASTE
); break;
1013 case 0x21f: map_key_clear(KEY_FIND
); break;
1014 case 0x221: map_key_clear(KEY_SEARCH
); break;
1015 case 0x222: map_key_clear(KEY_GOTO
); break;
1016 case 0x223: map_key_clear(KEY_HOMEPAGE
); break;
1017 case 0x224: map_key_clear(KEY_BACK
); break;
1018 case 0x225: map_key_clear(KEY_FORWARD
); break;
1019 case 0x226: map_key_clear(KEY_STOP
); break;
1020 case 0x227: map_key_clear(KEY_REFRESH
); break;
1021 case 0x22a: map_key_clear(KEY_BOOKMARKS
); break;
1022 case 0x22d: map_key_clear(KEY_ZOOMIN
); break;
1023 case 0x22e: map_key_clear(KEY_ZOOMOUT
); break;
1024 case 0x22f: map_key_clear(KEY_ZOOMRESET
); break;
1025 case 0x232: map_key_clear(KEY_FULL_SCREEN
); break;
1026 case 0x233: map_key_clear(KEY_SCROLLUP
); break;
1027 case 0x234: map_key_clear(KEY_SCROLLDOWN
); break;
1028 case 0x238: /* AC Pan */
1029 set_bit(REL_HWHEEL
, input
->relbit
);
1030 map_rel(REL_HWHEEL_HI_RES
);
1032 case 0x23d: map_key_clear(KEY_EDIT
); break;
1033 case 0x25f: map_key_clear(KEY_CANCEL
); break;
1034 case 0x269: map_key_clear(KEY_INSERT
); break;
1035 case 0x26a: map_key_clear(KEY_DELETE
); break;
1036 case 0x279: map_key_clear(KEY_REDO
); break;
1038 case 0x289: map_key_clear(KEY_REPLY
); break;
1039 case 0x28b: map_key_clear(KEY_FORWARDMAIL
); break;
1040 case 0x28c: map_key_clear(KEY_SEND
); break;
1042 case 0x29d: map_key_clear(KEY_KBD_LAYOUT_NEXT
); break;
1044 case 0x2c7: map_key_clear(KEY_KBDINPUTASSIST_PREV
); break;
1045 case 0x2c8: map_key_clear(KEY_KBDINPUTASSIST_NEXT
); break;
1046 case 0x2c9: map_key_clear(KEY_KBDINPUTASSIST_PREVGROUP
); break;
1047 case 0x2ca: map_key_clear(KEY_KBDINPUTASSIST_NEXTGROUP
); break;
1048 case 0x2cb: map_key_clear(KEY_KBDINPUTASSIST_ACCEPT
); break;
1049 case 0x2cc: map_key_clear(KEY_KBDINPUTASSIST_CANCEL
); break;
1051 case 0x29f: map_key_clear(KEY_SCALE
); break;
1053 default: map_key_clear(KEY_UNKNOWN
);
1057 case HID_UP_GENDEVCTRLS
:
1058 switch (usage
->hid
) {
1059 case HID_DC_BATTERYSTRENGTH
:
1060 hidinput_setup_battery(device
, HID_INPUT_REPORT
, field
);
1061 usage
->type
= EV_PWR
;
1066 case HID_UP_HPVENDOR
: /* Reported on a Dutch layout HP5308 */
1067 set_bit(EV_REP
, input
->evbit
);
1068 switch (usage
->hid
& HID_USAGE
) {
1069 case 0x021: map_key_clear(KEY_PRINT
); break;
1070 case 0x070: map_key_clear(KEY_HP
); break;
1071 case 0x071: map_key_clear(KEY_CAMERA
); break;
1072 case 0x072: map_key_clear(KEY_SOUND
); break;
1073 case 0x073: map_key_clear(KEY_QUESTION
); break;
1074 case 0x080: map_key_clear(KEY_EMAIL
); break;
1075 case 0x081: map_key_clear(KEY_CHAT
); break;
1076 case 0x082: map_key_clear(KEY_SEARCH
); break;
1077 case 0x083: map_key_clear(KEY_CONNECT
); break;
1078 case 0x084: map_key_clear(KEY_FINANCE
); break;
1079 case 0x085: map_key_clear(KEY_SPORT
); break;
1080 case 0x086: map_key_clear(KEY_SHOP
); break;
1081 default: goto ignore
;
1085 case HID_UP_HPVENDOR2
:
1086 set_bit(EV_REP
, input
->evbit
);
1087 switch (usage
->hid
& HID_USAGE
) {
1088 case 0x001: map_key_clear(KEY_MICMUTE
); break;
1089 case 0x003: map_key_clear(KEY_BRIGHTNESSDOWN
); break;
1090 case 0x004: map_key_clear(KEY_BRIGHTNESSUP
); break;
1091 default: goto ignore
;
1095 case HID_UP_MSVENDOR
:
1098 case HID_UP_CUSTOM
: /* Reported on Logitech and Apple USB keyboards */
1099 set_bit(EV_REP
, input
->evbit
);
1102 case HID_UP_LOGIVENDOR
:
1103 /* intentional fallback */
1104 case HID_UP_LOGIVENDOR2
:
1105 /* intentional fallback */
1106 case HID_UP_LOGIVENDOR3
:
1110 switch (usage
->hid
& HID_USAGE
) {
1111 case 0xa4: map_key_clear(BTN_DEAD
); break;
1112 default: goto ignore
;
1118 if (field
->report_size
== 1) {
1119 if (field
->report
->type
== HID_OUTPUT_REPORT
) {
1126 if (field
->flags
& HID_MAIN_ITEM_RELATIVE
) {
1135 /* Mapping failed, bail out */
1139 if (device
->driver
->input_mapped
&&
1140 device
->driver
->input_mapped(device
, hidinput
, field
, usage
,
1143 * The driver indicated that no further generic handling
1144 * of the usage is desired.
1149 set_bit(usage
->type
, input
->evbit
);
1152 * This part is *really* controversial:
1153 * - HID aims at being generic so we should do our best to export
1154 * all incoming events
1155 * - HID describes what events are, so there is no reason for ABS_X
1156 * to be mapped to ABS_Y
1157 * - HID is using *_MISC+N as a default value, but nothing prevents
1158 * *_MISC+N to overwrite a legitimate even, which confuses userspace
1159 * (for instance ABS_MISC + 7 is ABS_MT_SLOT, which has a different
1162 * If devices still want to use this (at their own risk), they will
1163 * have to use the quirk HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE, but
1164 * the default should be a reliable mapping.
1166 while (usage
->code
<= max
&& test_and_set_bit(usage
->code
, bit
)) {
1167 if (device
->quirks
& HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE
) {
1168 usage
->code
= find_next_zero_bit(bit
,
1172 device
->status
|= HID_STAT_DUP_DETECTED
;
1177 if (usage
->code
> max
)
1180 if (usage
->type
== EV_ABS
) {
1182 int a
= field
->logical_minimum
;
1183 int b
= field
->logical_maximum
;
1185 if ((device
->quirks
& HID_QUIRK_BADPAD
) && (usage
->code
== ABS_X
|| usage
->code
== ABS_Y
)) {
1186 a
= field
->logical_minimum
= 0;
1187 b
= field
->logical_maximum
= 255;
1190 if (field
->application
== HID_GD_GAMEPAD
|| field
->application
== HID_GD_JOYSTICK
)
1191 input_set_abs_params(input
, usage
->code
, a
, b
, (b
- a
) >> 8, (b
- a
) >> 4);
1192 else input_set_abs_params(input
, usage
->code
, a
, b
, 0, 0);
1194 input_abs_set_res(input
, usage
->code
,
1195 hidinput_calc_abs_res(field
, usage
->code
));
1197 /* use a larger default input buffer for MT devices */
1198 if (usage
->code
== ABS_MT_POSITION_X
&& input
->hint_events_per_packet
== 0)
1199 input_set_events_per_packet(input
, 60);
1202 if (usage
->type
== EV_ABS
&&
1203 (usage
->hat_min
< usage
->hat_max
|| usage
->hat_dir
)) {
1205 for (i
= usage
->code
; i
< usage
->code
+ 2 && i
<= max
; i
++) {
1206 input_set_abs_params(input
, i
, -1, 1, 0, 0);
1207 set_bit(i
, input
->absbit
);
1209 if (usage
->hat_dir
&& !field
->dpad
)
1210 field
->dpad
= usage
->code
;
1213 /* for those devices which produce Consumer volume usage as relative,
1214 * we emulate pressing volumeup/volumedown appropriate number of times
1215 * in hidinput_hid_event()
1217 if ((usage
->type
== EV_ABS
) && (field
->flags
& HID_MAIN_ITEM_RELATIVE
) &&
1218 (usage
->code
== ABS_VOLUME
)) {
1219 set_bit(KEY_VOLUMEUP
, input
->keybit
);
1220 set_bit(KEY_VOLUMEDOWN
, input
->keybit
);
1223 if (usage
->type
== EV_KEY
) {
1224 set_bit(EV_MSC
, input
->evbit
);
1225 set_bit(MSC_SCAN
, input
->mscbit
);
1235 static void hidinput_handle_scroll(struct hid_usage
*usage
,
1236 struct input_dev
*input
,
1245 if (usage
->code
== REL_WHEEL_HI_RES
)
1251 * Windows reports one wheel click as value 120. Where a high-res
1252 * scroll wheel is present, a fraction of 120 is reported instead.
1253 * Our REL_WHEEL_HI_RES axis does the same because all HW must
1254 * adhere to the 120 expectation.
1256 hi_res
= value
* 120/usage
->resolution_multiplier
;
1258 usage
->wheel_accumulated
+= hi_res
;
1259 lo_res
= usage
->wheel_accumulated
/120;
1261 usage
->wheel_accumulated
-= lo_res
* 120;
1263 input_event(input
, EV_REL
, code
, lo_res
);
1264 input_event(input
, EV_REL
, usage
->code
, hi_res
);
1267 void hidinput_hid_event(struct hid_device
*hid
, struct hid_field
*field
, struct hid_usage
*usage
, __s32 value
)
1269 struct input_dev
*input
;
1270 unsigned *quirks
= &hid
->quirks
;
1275 if (usage
->type
== EV_PWR
) {
1276 hidinput_update_battery(hid
, value
);
1280 if (!field
->hidinput
)
1283 input
= field
->hidinput
->input
;
1285 if (usage
->hat_min
< usage
->hat_max
|| usage
->hat_dir
) {
1286 int hat_dir
= usage
->hat_dir
;
1288 hat_dir
= (value
- usage
->hat_min
) * 8 / (usage
->hat_max
- usage
->hat_min
+ 1) + 1;
1289 if (hat_dir
< 0 || hat_dir
> 8) hat_dir
= 0;
1290 input_event(input
, usage
->type
, usage
->code
, hid_hat_to_axis
[hat_dir
].x
);
1291 input_event(input
, usage
->type
, usage
->code
+ 1, hid_hat_to_axis
[hat_dir
].y
);
1295 if (usage
->hid
== (HID_UP_DIGITIZER
| 0x003c)) { /* Invert */
1296 *quirks
= value
? (*quirks
| HID_QUIRK_INVERT
) : (*quirks
& ~HID_QUIRK_INVERT
);
1300 if (usage
->hid
== (HID_UP_DIGITIZER
| 0x0032)) { /* InRange */
1302 input_event(input
, usage
->type
, (*quirks
& HID_QUIRK_INVERT
) ? BTN_TOOL_RUBBER
: usage
->code
, 1);
1305 input_event(input
, usage
->type
, usage
->code
, 0);
1306 input_event(input
, usage
->type
, BTN_TOOL_RUBBER
, 0);
1310 if (usage
->hid
== (HID_UP_DIGITIZER
| 0x0030) && (*quirks
& HID_QUIRK_NOTOUCH
)) { /* Pressure */
1311 int a
= field
->logical_minimum
;
1312 int b
= field
->logical_maximum
;
1313 input_event(input
, EV_KEY
, BTN_TOUCH
, value
> a
+ ((b
- a
) >> 3));
1316 if (usage
->hid
== (HID_UP_PID
| 0x83UL
)) { /* Simultaneous Effects Max */
1317 dbg_hid("Maximum Effects - %d\n",value
);
1321 if (usage
->hid
== (HID_UP_PID
| 0x7fUL
)) {
1322 dbg_hid("PID Pool Report\n");
1326 if ((usage
->type
== EV_KEY
) && (usage
->code
== 0)) /* Key 0 is "unassigned", not KEY_UNKNOWN */
1329 if ((usage
->type
== EV_REL
) && (usage
->code
== REL_WHEEL_HI_RES
||
1330 usage
->code
== REL_HWHEEL_HI_RES
)) {
1331 hidinput_handle_scroll(usage
, input
, value
);
1335 if ((usage
->type
== EV_ABS
) && (field
->flags
& HID_MAIN_ITEM_RELATIVE
) &&
1336 (usage
->code
== ABS_VOLUME
)) {
1337 int count
= abs(value
);
1338 int direction
= value
> 0 ? KEY_VOLUMEUP
: KEY_VOLUMEDOWN
;
1341 for (i
= 0; i
< count
; i
++) {
1342 input_event(input
, EV_KEY
, direction
, 1);
1344 input_event(input
, EV_KEY
, direction
, 0);
1351 * Ignore out-of-range values as per HID specification,
1352 * section 5.10 and 6.2.25, when NULL state bit is present.
1353 * When it's not, clamp the value to match Microsoft's input
1354 * driver as mentioned in "Required HID usages for digitizers":
1355 * https://msdn.microsoft.com/en-us/library/windows/hardware/dn672278(v=vs.85).asp
1357 * The logical_minimum < logical_maximum check is done so that we
1358 * don't unintentionally discard values sent by devices which
1359 * don't specify logical min and max.
1361 if ((field
->flags
& HID_MAIN_ITEM_VARIABLE
) &&
1362 (field
->logical_minimum
< field
->logical_maximum
)) {
1363 if (field
->flags
& HID_MAIN_ITEM_NULL_STATE
&&
1364 (value
< field
->logical_minimum
||
1365 value
> field
->logical_maximum
)) {
1366 dbg_hid("Ignoring out-of-range value %x\n", value
);
1369 value
= clamp(value
,
1370 field
->logical_minimum
,
1371 field
->logical_maximum
);
1375 * Ignore reports for absolute data if the data didn't change. This is
1376 * not only an optimization but also fixes 'dead' key reports. Some
1377 * RollOver implementations for localized keys (like BACKSLASH/PIPE; HID
1378 * 0x31 and 0x32) report multiple keys, even though a localized keyboard
1379 * can only have one of them physically available. The 'dead' keys
1380 * report constant 0. As all map to the same keycode, they'd confuse
1381 * the input layer. If we filter the 'dead' keys on the HID level, we
1382 * skip the keycode translation and only forward real events.
1384 if (!(field
->flags
& (HID_MAIN_ITEM_RELATIVE
|
1385 HID_MAIN_ITEM_BUFFERED_BYTE
)) &&
1386 (field
->flags
& HID_MAIN_ITEM_VARIABLE
) &&
1387 usage
->usage_index
< field
->maxusage
&&
1388 value
== field
->value
[usage
->usage_index
])
1391 /* report the usage code as scancode if the key status has changed */
1392 if (usage
->type
== EV_KEY
&&
1393 (!test_bit(usage
->code
, input
->key
)) == value
)
1394 input_event(input
, EV_MSC
, MSC_SCAN
, usage
->hid
);
1396 input_event(input
, usage
->type
, usage
->code
, value
);
1398 if ((field
->flags
& HID_MAIN_ITEM_RELATIVE
) &&
1399 usage
->type
== EV_KEY
&& value
) {
1401 input_event(input
, usage
->type
, usage
->code
, 0);
1405 void hidinput_report_event(struct hid_device
*hid
, struct hid_report
*report
)
1407 struct hid_input
*hidinput
;
1409 if (hid
->quirks
& HID_QUIRK_NO_INPUT_SYNC
)
1412 list_for_each_entry(hidinput
, &hid
->inputs
, list
)
1413 input_sync(hidinput
->input
);
1415 EXPORT_SYMBOL_GPL(hidinput_report_event
);
1417 int hidinput_find_field(struct hid_device
*hid
, unsigned int type
, unsigned int code
, struct hid_field
**field
)
1419 struct hid_report
*report
;
1422 list_for_each_entry(report
, &hid
->report_enum
[HID_OUTPUT_REPORT
].report_list
, list
) {
1423 for (i
= 0; i
< report
->maxfield
; i
++) {
1424 *field
= report
->field
[i
];
1425 for (j
= 0; j
< (*field
)->maxusage
; j
++)
1426 if ((*field
)->usage
[j
].type
== type
&& (*field
)->usage
[j
].code
== code
)
1432 EXPORT_SYMBOL_GPL(hidinput_find_field
);
1434 struct hid_field
*hidinput_get_led_field(struct hid_device
*hid
)
1436 struct hid_report
*report
;
1437 struct hid_field
*field
;
1440 list_for_each_entry(report
,
1441 &hid
->report_enum
[HID_OUTPUT_REPORT
].report_list
,
1443 for (i
= 0; i
< report
->maxfield
; i
++) {
1444 field
= report
->field
[i
];
1445 for (j
= 0; j
< field
->maxusage
; j
++)
1446 if (field
->usage
[j
].type
== EV_LED
)
1452 EXPORT_SYMBOL_GPL(hidinput_get_led_field
);
1454 unsigned int hidinput_count_leds(struct hid_device
*hid
)
1456 struct hid_report
*report
;
1457 struct hid_field
*field
;
1459 unsigned int count
= 0;
1461 list_for_each_entry(report
,
1462 &hid
->report_enum
[HID_OUTPUT_REPORT
].report_list
,
1464 for (i
= 0; i
< report
->maxfield
; i
++) {
1465 field
= report
->field
[i
];
1466 for (j
= 0; j
< field
->maxusage
; j
++)
1467 if (field
->usage
[j
].type
== EV_LED
&&
1474 EXPORT_SYMBOL_GPL(hidinput_count_leds
);
1476 static void hidinput_led_worker(struct work_struct
*work
)
1478 struct hid_device
*hid
= container_of(work
, struct hid_device
,
1480 struct hid_field
*field
;
1481 struct hid_report
*report
;
1486 field
= hidinput_get_led_field(hid
);
1491 * field->report is accessed unlocked regarding HID core. So there might
1492 * be another incoming SET-LED request from user-space, which changes
1493 * the LED state while we assemble our outgoing buffer. However, this
1494 * doesn't matter as hid_output_report() correctly converts it into a
1495 * boolean value no matter what information is currently set on the LED
1496 * field (even garbage). So the remote device will always get a valid
1498 * And in case we send a wrong value, a next led worker is spawned
1499 * for every SET-LED request so the following worker will send the
1500 * correct value, guaranteed!
1503 report
= field
->report
;
1505 /* use custom SET_REPORT request if possible (asynchronous) */
1506 if (hid
->ll_driver
->request
)
1507 return hid
->ll_driver
->request(hid
, report
, HID_REQ_SET_REPORT
);
1509 /* fall back to generic raw-output-report */
1510 len
= hid_report_len(report
);
1511 buf
= hid_alloc_report_buf(report
, GFP_KERNEL
);
1515 hid_output_report(report
, buf
);
1516 /* synchronous output report */
1517 ret
= hid_hw_output_report(hid
, buf
, len
);
1519 hid_hw_raw_request(hid
, report
->id
, buf
, len
, HID_OUTPUT_REPORT
,
1520 HID_REQ_SET_REPORT
);
1524 static int hidinput_input_event(struct input_dev
*dev
, unsigned int type
,
1525 unsigned int code
, int value
)
1527 struct hid_device
*hid
= input_get_drvdata(dev
);
1528 struct hid_field
*field
;
1532 return input_ff_event(dev
, type
, code
, value
);
1537 if ((offset
= hidinput_find_field(hid
, type
, code
, &field
)) == -1) {
1538 hid_warn(dev
, "event field not found\n");
1542 hid_set_field(field
, offset
, value
);
1544 schedule_work(&hid
->led_work
);
1548 static int hidinput_open(struct input_dev
*dev
)
1550 struct hid_device
*hid
= input_get_drvdata(dev
);
1552 return hid_hw_open(hid
);
1555 static void hidinput_close(struct input_dev
*dev
)
1557 struct hid_device
*hid
= input_get_drvdata(dev
);
1562 static bool __hidinput_change_resolution_multipliers(struct hid_device
*hid
,
1563 struct hid_report
*report
, bool use_logical_max
)
1565 struct hid_usage
*usage
;
1566 bool update_needed
= false;
1569 if (report
->maxfield
== 0)
1573 * If we have more than one feature within this report we
1574 * need to fill in the bits from the others before we can
1575 * overwrite the ones for the Resolution Multiplier.
1577 if (report
->maxfield
> 1) {
1578 hid_hw_request(hid
, report
, HID_REQ_GET_REPORT
);
1582 for (i
= 0; i
< report
->maxfield
; i
++) {
1583 __s32 value
= use_logical_max
?
1584 report
->field
[i
]->logical_maximum
:
1585 report
->field
[i
]->logical_minimum
;
1587 /* There is no good reason for a Resolution
1588 * Multiplier to have a count other than 1.
1591 if (report
->field
[i
]->report_count
!= 1)
1594 for (j
= 0; j
< report
->field
[i
]->maxusage
; j
++) {
1595 usage
= &report
->field
[i
]->usage
[j
];
1597 if (usage
->hid
!= HID_GD_RESOLUTION_MULTIPLIER
)
1600 report
->field
[i
]->value
[j
] = value
;
1601 update_needed
= true;
1605 return update_needed
;
1608 static void hidinput_change_resolution_multipliers(struct hid_device
*hid
)
1610 struct hid_report_enum
*rep_enum
;
1611 struct hid_report
*rep
;
1614 rep_enum
= &hid
->report_enum
[HID_FEATURE_REPORT
];
1615 list_for_each_entry(rep
, &rep_enum
->report_list
, list
) {
1616 bool update_needed
= __hidinput_change_resolution_multipliers(hid
,
1619 if (update_needed
) {
1620 ret
= __hid_request(hid
, rep
, HID_REQ_SET_REPORT
);
1622 __hidinput_change_resolution_multipliers(hid
,
1629 /* refresh our structs */
1630 hid_setup_resolution_multiplier(hid
);
1633 static void report_features(struct hid_device
*hid
)
1635 struct hid_driver
*drv
= hid
->driver
;
1636 struct hid_report_enum
*rep_enum
;
1637 struct hid_report
*rep
;
1638 struct hid_usage
*usage
;
1641 rep_enum
= &hid
->report_enum
[HID_FEATURE_REPORT
];
1642 list_for_each_entry(rep
, &rep_enum
->report_list
, list
)
1643 for (i
= 0; i
< rep
->maxfield
; i
++) {
1644 /* Ignore if report count is out of bounds. */
1645 if (rep
->field
[i
]->report_count
< 1)
1648 for (j
= 0; j
< rep
->field
[i
]->maxusage
; j
++) {
1649 usage
= &rep
->field
[i
]->usage
[j
];
1651 /* Verify if Battery Strength feature is available */
1652 if (usage
->hid
== HID_DC_BATTERYSTRENGTH
)
1653 hidinput_setup_battery(hid
, HID_FEATURE_REPORT
,
1656 if (drv
->feature_mapping
)
1657 drv
->feature_mapping(hid
, rep
->field
[i
], usage
);
1662 static struct hid_input
*hidinput_allocate(struct hid_device
*hid
,
1663 unsigned int application
)
1665 struct hid_input
*hidinput
= kzalloc(sizeof(*hidinput
), GFP_KERNEL
);
1666 struct input_dev
*input_dev
= input_allocate_device();
1667 const char *suffix
= NULL
;
1668 size_t suffix_len
, name_len
;
1670 if (!hidinput
|| !input_dev
)
1673 if ((hid
->quirks
& HID_QUIRK_INPUT_PER_APP
) &&
1674 hid
->maxapplication
> 1) {
1675 switch (application
) {
1676 case HID_GD_KEYBOARD
:
1677 suffix
= "Keyboard";
1688 case HID_DG_TOUCHSCREEN
:
1689 suffix
= "Touchscreen";
1691 case HID_DG_TOUCHPAD
:
1692 suffix
= "Touchpad";
1694 case HID_GD_SYSTEM_CONTROL
:
1695 suffix
= "System Control";
1697 case HID_CP_CONSUMER_CONTROL
:
1698 suffix
= "Consumer Control";
1700 case HID_GD_WIRELESS_RADIO_CTLS
:
1701 suffix
= "Wireless Radio Control";
1703 case HID_GD_SYSTEM_MULTIAXIS
:
1704 suffix
= "System Multi Axis";
1712 name_len
= strlen(hid
->name
);
1713 suffix_len
= strlen(suffix
);
1714 if ((name_len
< suffix_len
) ||
1715 strcmp(hid
->name
+ name_len
- suffix_len
, suffix
)) {
1716 hidinput
->name
= kasprintf(GFP_KERNEL
, "%s %s",
1718 if (!hidinput
->name
)
1723 input_set_drvdata(input_dev
, hid
);
1724 input_dev
->event
= hidinput_input_event
;
1725 input_dev
->open
= hidinput_open
;
1726 input_dev
->close
= hidinput_close
;
1727 input_dev
->setkeycode
= hidinput_setkeycode
;
1728 input_dev
->getkeycode
= hidinput_getkeycode
;
1730 input_dev
->name
= hidinput
->name
? hidinput
->name
: hid
->name
;
1731 input_dev
->phys
= hid
->phys
;
1732 input_dev
->uniq
= hid
->uniq
;
1733 input_dev
->id
.bustype
= hid
->bus
;
1734 input_dev
->id
.vendor
= hid
->vendor
;
1735 input_dev
->id
.product
= hid
->product
;
1736 input_dev
->id
.version
= hid
->version
;
1737 input_dev
->dev
.parent
= &hid
->dev
;
1739 hidinput
->input
= input_dev
;
1740 hidinput
->application
= application
;
1741 list_add_tail(&hidinput
->list
, &hid
->inputs
);
1743 INIT_LIST_HEAD(&hidinput
->reports
);
1749 input_free_device(input_dev
);
1750 hid_err(hid
, "Out of memory during hid input probe\n");
1754 static bool hidinput_has_been_populated(struct hid_input
*hidinput
)
1757 unsigned long r
= 0;
1759 for (i
= 0; i
< BITS_TO_LONGS(EV_CNT
); i
++)
1760 r
|= hidinput
->input
->evbit
[i
];
1762 for (i
= 0; i
< BITS_TO_LONGS(KEY_CNT
); i
++)
1763 r
|= hidinput
->input
->keybit
[i
];
1765 for (i
= 0; i
< BITS_TO_LONGS(REL_CNT
); i
++)
1766 r
|= hidinput
->input
->relbit
[i
];
1768 for (i
= 0; i
< BITS_TO_LONGS(ABS_CNT
); i
++)
1769 r
|= hidinput
->input
->absbit
[i
];
1771 for (i
= 0; i
< BITS_TO_LONGS(MSC_CNT
); i
++)
1772 r
|= hidinput
->input
->mscbit
[i
];
1774 for (i
= 0; i
< BITS_TO_LONGS(LED_CNT
); i
++)
1775 r
|= hidinput
->input
->ledbit
[i
];
1777 for (i
= 0; i
< BITS_TO_LONGS(SND_CNT
); i
++)
1778 r
|= hidinput
->input
->sndbit
[i
];
1780 for (i
= 0; i
< BITS_TO_LONGS(FF_CNT
); i
++)
1781 r
|= hidinput
->input
->ffbit
[i
];
1783 for (i
= 0; i
< BITS_TO_LONGS(SW_CNT
); i
++)
1784 r
|= hidinput
->input
->swbit
[i
];
1789 static void hidinput_cleanup_hidinput(struct hid_device
*hid
,
1790 struct hid_input
*hidinput
)
1792 struct hid_report
*report
;
1795 list_del(&hidinput
->list
);
1796 input_free_device(hidinput
->input
);
1797 kfree(hidinput
->name
);
1799 for (k
= HID_INPUT_REPORT
; k
<= HID_OUTPUT_REPORT
; k
++) {
1800 if (k
== HID_OUTPUT_REPORT
&&
1801 hid
->quirks
& HID_QUIRK_SKIP_OUTPUT_REPORTS
)
1804 list_for_each_entry(report
, &hid
->report_enum
[k
].report_list
,
1807 for (i
= 0; i
< report
->maxfield
; i
++)
1808 if (report
->field
[i
]->hidinput
== hidinput
)
1809 report
->field
[i
]->hidinput
= NULL
;
1816 static struct hid_input
*hidinput_match(struct hid_report
*report
)
1818 struct hid_device
*hid
= report
->device
;
1819 struct hid_input
*hidinput
;
1821 list_for_each_entry(hidinput
, &hid
->inputs
, list
) {
1822 if (hidinput
->report
&&
1823 hidinput
->report
->id
== report
->id
)
1830 static struct hid_input
*hidinput_match_application(struct hid_report
*report
)
1832 struct hid_device
*hid
= report
->device
;
1833 struct hid_input
*hidinput
;
1835 list_for_each_entry(hidinput
, &hid
->inputs
, list
) {
1836 if (hidinput
->application
== report
->application
)
1843 static inline void hidinput_configure_usages(struct hid_input
*hidinput
,
1844 struct hid_report
*report
)
1848 for (i
= 0; i
< report
->maxfield
; i
++)
1849 for (j
= 0; j
< report
->field
[i
]->maxusage
; j
++)
1850 hidinput_configure_usage(hidinput
, report
->field
[i
],
1851 report
->field
[i
]->usage
+ j
);
1855 * Register the input device; print a message.
1856 * Configure the input layer interface
1857 * Read all reports and initialize the absolute field values.
1860 int hidinput_connect(struct hid_device
*hid
, unsigned int force
)
1862 struct hid_driver
*drv
= hid
->driver
;
1863 struct hid_report
*report
;
1864 struct hid_input
*next
, *hidinput
= NULL
;
1865 unsigned int application
;
1868 INIT_LIST_HEAD(&hid
->inputs
);
1869 INIT_WORK(&hid
->led_work
, hidinput_led_worker
);
1871 hid
->status
&= ~HID_STAT_DUP_DETECTED
;
1874 for (i
= 0; i
< hid
->maxcollection
; i
++) {
1875 struct hid_collection
*col
= &hid
->collection
[i
];
1876 if (col
->type
== HID_COLLECTION_APPLICATION
||
1877 col
->type
== HID_COLLECTION_PHYSICAL
)
1878 if (IS_INPUT_APPLICATION(col
->usage
))
1882 if (i
== hid
->maxcollection
)
1886 report_features(hid
);
1888 for (k
= HID_INPUT_REPORT
; k
<= HID_OUTPUT_REPORT
; k
++) {
1889 if (k
== HID_OUTPUT_REPORT
&&
1890 hid
->quirks
& HID_QUIRK_SKIP_OUTPUT_REPORTS
)
1893 list_for_each_entry(report
, &hid
->report_enum
[k
].report_list
, list
) {
1895 if (!report
->maxfield
)
1898 application
= report
->application
;
1901 * Find the previous hidinput report attached
1902 * to this report id.
1904 if (hid
->quirks
& HID_QUIRK_MULTI_INPUT
)
1905 hidinput
= hidinput_match(report
);
1906 else if (hid
->maxapplication
> 1 &&
1907 (hid
->quirks
& HID_QUIRK_INPUT_PER_APP
))
1908 hidinput
= hidinput_match_application(report
);
1911 hidinput
= hidinput_allocate(hid
, application
);
1916 hidinput_configure_usages(hidinput
, report
);
1918 if (hid
->quirks
& HID_QUIRK_MULTI_INPUT
)
1919 hidinput
->report
= report
;
1921 list_add_tail(&report
->hidinput_list
,
1922 &hidinput
->reports
);
1926 hidinput_change_resolution_multipliers(hid
);
1928 list_for_each_entry_safe(hidinput
, next
, &hid
->inputs
, list
) {
1929 if (drv
->input_configured
&&
1930 drv
->input_configured(hid
, hidinput
))
1933 if (!hidinput_has_been_populated(hidinput
)) {
1934 /* no need to register an input device not populated */
1935 hidinput_cleanup_hidinput(hid
, hidinput
);
1939 if (input_register_device(hidinput
->input
))
1941 hidinput
->registered
= true;
1944 if (list_empty(&hid
->inputs
)) {
1945 hid_err(hid
, "No inputs registered, leaving\n");
1949 if (hid
->status
& HID_STAT_DUP_DETECTED
)
1951 "Some usages could not be mapped, please use HID_QUIRK_INCREMENT_USAGE_ON_DUPLICATE if this is legitimate.\n");
1956 /* unwind the ones we already registered */
1957 hidinput_disconnect(hid
);
1961 EXPORT_SYMBOL_GPL(hidinput_connect
);
1963 void hidinput_disconnect(struct hid_device
*hid
)
1965 struct hid_input
*hidinput
, *next
;
1967 hidinput_cleanup_battery(hid
);
1969 list_for_each_entry_safe(hidinput
, next
, &hid
->inputs
, list
) {
1970 list_del(&hidinput
->list
);
1971 if (hidinput
->registered
)
1972 input_unregister_device(hidinput
->input
);
1974 input_free_device(hidinput
->input
);
1975 kfree(hidinput
->name
);
1979 /* led_work is spawned by input_dev callbacks, but doesn't access the
1980 * parent input_dev at all. Once all input devices are removed, we
1981 * know that led_work will never get restarted, so we can cancel it
1982 * synchronously and are safe. */
1983 cancel_work_sync(&hid
->led_work
);
1985 EXPORT_SYMBOL_GPL(hidinput_disconnect
);