1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * HID driver for Asus notebook built-in keyboard.
4 * Fixes small logical maximum to match usage maximum.
6 * Currently supported devices are:
10 * Copyright (c) 2016 Yusuke Fujimaki <usk.fujimaki@gmail.com>
12 * This module based on hid-ortek by
13 * Copyright (c) 2010 Johnathon Harris <jmharris@gmail.com>
14 * Copyright (c) 2011 Jiri Kosina
16 * This module has been updated to add support for Asus i2c touchpad.
18 * Copyright (c) 2016 Brendan McGrath <redmcg@redmandi.dyndns.org>
19 * Copyright (c) 2016 Victor Vlasenko <victor.vlasenko@sysgears.com>
20 * Copyright (c) 2016 Frederik Wenigwieser <frederik.wenigwieser@gmail.com>
26 #include <linux/dmi.h>
27 #include <linux/hid.h>
28 #include <linux/module.h>
29 #include <linux/platform_data/x86/asus-wmi.h>
30 #include <linux/input/mt.h>
31 #include <linux/usb.h> /* For to_usb_interface for T100 touchpad intf check */
32 #include <linux/power_supply.h>
36 MODULE_AUTHOR("Yusuke Fujimaki <usk.fujimaki@gmail.com>");
37 MODULE_AUTHOR("Brendan McGrath <redmcg@redmandi.dyndns.org>");
38 MODULE_AUTHOR("Victor Vlasenko <victor.vlasenko@sysgears.com>");
39 MODULE_AUTHOR("Frederik Wenigwieser <frederik.wenigwieser@gmail.com>");
40 MODULE_DESCRIPTION("Asus HID Keyboard and TouchPad");
42 #define T100_TPAD_INTF 2
43 #define MEDION_E1239T_TPAD_INTF 1
45 #define E1239T_TP_TOGGLE_REPORT_ID 0x05
46 #define T100CHI_MOUSE_REPORT_ID 0x06
47 #define FEATURE_REPORT_ID 0x0d
48 #define INPUT_REPORT_ID 0x5d
49 #define FEATURE_KBD_REPORT_ID 0x5a
50 #define FEATURE_KBD_REPORT_SIZE 16
51 #define FEATURE_KBD_LED_REPORT_ID1 0x5d
52 #define FEATURE_KBD_LED_REPORT_ID2 0x5e
54 #define SUPPORT_KBD_BACKLIGHT BIT(0)
56 #define MAX_TOUCH_MAJOR 8
57 #define MAX_PRESSURE 128
59 #define BTN_LEFT_MASK 0x01
60 #define CONTACT_TOOL_TYPE_MASK 0x80
61 #define CONTACT_X_MSB_MASK 0xf0
62 #define CONTACT_Y_MSB_MASK 0x0f
63 #define CONTACT_TOUCH_MAJOR_MASK 0x07
64 #define CONTACT_PRESSURE_MASK 0x7f
66 #define BATTERY_REPORT_ID (0x03)
67 #define BATTERY_REPORT_SIZE (1 + 8)
68 #define BATTERY_LEVEL_MAX ((u8)255)
69 #define BATTERY_STAT_DISCONNECT (0)
70 #define BATTERY_STAT_CHARGING (1)
71 #define BATTERY_STAT_FULL (2)
73 #define QUIRK_FIX_NOTEBOOK_REPORT BIT(0)
74 #define QUIRK_NO_INIT_REPORTS BIT(1)
75 #define QUIRK_SKIP_INPUT_MAPPING BIT(2)
76 #define QUIRK_IS_MULTITOUCH BIT(3)
77 #define QUIRK_NO_CONSUMER_USAGES BIT(4)
78 #define QUIRK_USE_KBD_BACKLIGHT BIT(5)
79 #define QUIRK_T100_KEYBOARD BIT(6)
80 #define QUIRK_T100CHI BIT(7)
81 #define QUIRK_G752_KEYBOARD BIT(8)
82 #define QUIRK_T101HA_DOCK BIT(9)
83 #define QUIRK_T90CHI BIT(10)
84 #define QUIRK_MEDION_E1239T BIT(11)
85 #define QUIRK_ROG_NKEY_KEYBOARD BIT(12)
87 #define I2C_KEYBOARD_QUIRKS (QUIRK_FIX_NOTEBOOK_REPORT | \
88 QUIRK_NO_INIT_REPORTS | \
89 QUIRK_NO_CONSUMER_USAGES)
90 #define I2C_TOUCHPAD_QUIRKS (QUIRK_NO_INIT_REPORTS | \
91 QUIRK_SKIP_INPUT_MAPPING | \
94 #define TRKID_SGN ((TRKID_MAX + 1) >> 1)
96 struct asus_kbd_leds
{
97 struct led_classdev cdev
;
98 struct hid_device
*hdev
;
99 struct work_struct work
;
100 unsigned int brightness
;
104 struct asus_touchpad_info
{
114 struct asus_drvdata
{
115 unsigned long quirks
;
116 struct hid_device
*hdev
;
117 struct input_dev
*input
;
118 struct input_dev
*tp_kbd_input
;
119 struct asus_kbd_leds
*kbd_backlight
;
120 const struct asus_touchpad_info
*tp
;
121 bool enable_backlight
;
122 struct power_supply
*battery
;
123 struct power_supply_desc battery_desc
;
124 int battery_capacity
;
126 bool battery_in_query
;
127 unsigned long battery_next_query
;
130 static int asus_report_battery(struct asus_drvdata
*, u8
*, int);
132 static const struct asus_touchpad_info asus_i2c_tp
= {
137 .report_size
= 28 /* 2 byte header + 5 * 5 + 1 byte footer */,
140 static const struct asus_touchpad_info asus_t100ta_tp
= {
143 .res_x
= 30, /* units/mm */
144 .res_y
= 27, /* units/mm */
147 .report_size
= 28 /* 2 byte header + 5 * 5 + 1 byte footer */,
150 static const struct asus_touchpad_info asus_t100ha_tp
= {
153 .res_x
= 30, /* units/mm */
154 .res_y
= 29, /* units/mm */
157 .report_size
= 28 /* 2 byte header + 5 * 5 + 1 byte footer */,
160 static const struct asus_touchpad_info asus_t200ta_tp
= {
163 .res_x
= 30, /* units/mm */
164 .res_y
= 28, /* units/mm */
167 .report_size
= 28 /* 2 byte header + 5 * 5 + 1 byte footer */,
170 static const struct asus_touchpad_info asus_t100chi_tp
= {
173 .res_x
= 31, /* units/mm */
174 .res_y
= 29, /* units/mm */
177 .report_size
= 15 /* 2 byte header + 3 * 4 + 1 byte footer */,
180 static const struct asus_touchpad_info medion_e1239t_tp
= {
183 .res_x
= 29, /* units/mm */
184 .res_y
= 28, /* units/mm */
187 .report_size
= 32 /* 2 byte header + 5 * 5 + 5 byte footer */,
190 static void asus_report_contact_down(struct asus_drvdata
*drvdat
,
191 int toolType
, u8
*data
)
193 struct input_dev
*input
= drvdat
->input
;
194 int touch_major
, pressure
, x
, y
;
196 x
= (data
[0] & CONTACT_X_MSB_MASK
) << 4 | data
[1];
197 y
= drvdat
->tp
->max_y
- ((data
[0] & CONTACT_Y_MSB_MASK
) << 8 | data
[2]);
199 input_report_abs(input
, ABS_MT_POSITION_X
, x
);
200 input_report_abs(input
, ABS_MT_POSITION_Y
, y
);
202 if (drvdat
->tp
->contact_size
< 5)
205 if (toolType
== MT_TOOL_PALM
) {
206 touch_major
= MAX_TOUCH_MAJOR
;
207 pressure
= MAX_PRESSURE
;
209 touch_major
= (data
[3] >> 4) & CONTACT_TOUCH_MAJOR_MASK
;
210 pressure
= data
[4] & CONTACT_PRESSURE_MASK
;
213 input_report_abs(input
, ABS_MT_TOUCH_MAJOR
, touch_major
);
214 input_report_abs(input
, ABS_MT_PRESSURE
, pressure
);
217 /* Required for Synaptics Palm Detection */
218 static void asus_report_tool_width(struct asus_drvdata
*drvdat
)
220 struct input_mt
*mt
= drvdat
->input
->mt
;
221 struct input_mt_slot
*oldest
;
224 if (drvdat
->tp
->contact_size
< 5)
231 for (i
= 0; i
< mt
->num_slots
; ++i
) {
232 struct input_mt_slot
*ps
= &mt
->slots
[i
];
233 int id
= input_mt_get_value(ps
, ABS_MT_TRACKING_ID
);
237 if ((id
- oldid
) & TRKID_SGN
) {
245 input_report_abs(drvdat
->input
, ABS_TOOL_WIDTH
,
246 input_mt_get_value(oldest
, ABS_MT_TOUCH_MAJOR
));
250 static int asus_report_input(struct asus_drvdata
*drvdat
, u8
*data
, int size
)
252 int i
, toolType
= MT_TOOL_FINGER
;
253 u8
*contactData
= data
+ 2;
255 if (size
!= drvdat
->tp
->report_size
)
258 for (i
= 0; i
< drvdat
->tp
->max_contacts
; i
++) {
259 bool down
= !!(data
[1] & BIT(i
+3));
261 if (drvdat
->tp
->contact_size
>= 5)
262 toolType
= contactData
[3] & CONTACT_TOOL_TYPE_MASK
?
263 MT_TOOL_PALM
: MT_TOOL_FINGER
;
265 input_mt_slot(drvdat
->input
, i
);
266 input_mt_report_slot_state(drvdat
->input
, toolType
, down
);
269 asus_report_contact_down(drvdat
, toolType
, contactData
);
270 contactData
+= drvdat
->tp
->contact_size
;
274 input_report_key(drvdat
->input
, BTN_LEFT
, data
[1] & BTN_LEFT_MASK
);
275 asus_report_tool_width(drvdat
);
277 input_mt_sync_frame(drvdat
->input
);
278 input_sync(drvdat
->input
);
283 static int asus_e1239t_event(struct asus_drvdata
*drvdat
, u8
*data
, int size
)
288 /* Handle broken mute key which only sends press events */
290 data
[0] == 0x02 && data
[1] == 0xe2 && data
[2] == 0x00) {
291 input_report_key(drvdat
->input
, KEY_MUTE
, 1);
292 input_sync(drvdat
->input
);
293 input_report_key(drvdat
->input
, KEY_MUTE
, 0);
294 input_sync(drvdat
->input
);
298 /* Handle custom touchpad toggle key which only sends press events */
299 if (drvdat
->tp_kbd_input
&&
300 data
[0] == 0x05 && data
[1] == 0x02 && data
[2] == 0x28) {
301 input_report_key(drvdat
->tp_kbd_input
, KEY_F21
, 1);
302 input_sync(drvdat
->tp_kbd_input
);
303 input_report_key(drvdat
->tp_kbd_input
, KEY_F21
, 0);
304 input_sync(drvdat
->tp_kbd_input
);
311 static int asus_event(struct hid_device
*hdev
, struct hid_field
*field
,
312 struct hid_usage
*usage
, __s32 value
)
314 if ((usage
->hid
& HID_USAGE_PAGE
) == 0xff310000 &&
315 (usage
->hid
& HID_USAGE
) != 0x00 &&
316 (usage
->hid
& HID_USAGE
) != 0xff && !usage
->type
) {
317 hid_warn(hdev
, "Unmapped Asus vendor usagepage code 0x%02x\n",
318 usage
->hid
& HID_USAGE
);
324 static int asus_raw_event(struct hid_device
*hdev
,
325 struct hid_report
*report
, u8
*data
, int size
)
327 struct asus_drvdata
*drvdata
= hid_get_drvdata(hdev
);
329 if (drvdata
->battery
&& data
[0] == BATTERY_REPORT_ID
)
330 return asus_report_battery(drvdata
, data
, size
);
332 if (drvdata
->tp
&& data
[0] == INPUT_REPORT_ID
)
333 return asus_report_input(drvdata
, data
, size
);
335 if (drvdata
->quirks
& QUIRK_MEDION_E1239T
)
336 return asus_e1239t_event(drvdata
, data
, size
);
338 if (drvdata
->quirks
& QUIRK_ROG_NKEY_KEYBOARD
) {
340 * Skip these report ID, the device emits a continuous stream associated
341 * with the AURA mode it is in which looks like an 'echo'.
343 if (report
->id
== FEATURE_KBD_LED_REPORT_ID1
||
344 report
->id
== FEATURE_KBD_LED_REPORT_ID2
) {
346 /* Additional report filtering */
347 } else if (report
->id
== FEATURE_KBD_REPORT_ID
) {
349 * G14 and G15 send these codes on some keypresses with no
350 * discernable reason for doing so. We'll filter them out to avoid
351 * unmapped warning messages later.
353 if (data
[1] == 0xea || data
[1] == 0xec || data
[1] == 0x02 ||
354 data
[1] == 0x8a || data
[1] == 0x9e) {
363 static int asus_kbd_set_report(struct hid_device
*hdev
, u8
*buf
, size_t buf_size
)
365 unsigned char *dmabuf
;
368 dmabuf
= kmemdup(buf
, buf_size
, GFP_KERNEL
);
373 * The report ID should be set from the incoming buffer due to LED and key
374 * interfaces having different pages
376 ret
= hid_hw_raw_request(hdev
, buf
[0], dmabuf
,
377 buf_size
, HID_FEATURE_REPORT
,
384 static int asus_kbd_init(struct hid_device
*hdev
)
386 u8 buf
[] = { FEATURE_KBD_REPORT_ID
, 0x41, 0x53, 0x55, 0x53, 0x20, 0x54,
387 0x65, 0x63, 0x68, 0x2e, 0x49, 0x6e, 0x63, 0x2e, 0x00 };
390 ret
= asus_kbd_set_report(hdev
, buf
, sizeof(buf
));
392 hid_err(hdev
, "Asus failed to send init command: %d\n", ret
);
397 static int asus_kbd_get_functions(struct hid_device
*hdev
,
398 unsigned char *kbd_func
)
400 u8 buf
[] = { FEATURE_KBD_REPORT_ID
, 0x05, 0x20, 0x31, 0x00, 0x08 };
404 ret
= asus_kbd_set_report(hdev
, buf
, sizeof(buf
));
406 hid_err(hdev
, "Asus failed to send configuration command: %d\n", ret
);
410 readbuf
= kzalloc(FEATURE_KBD_REPORT_SIZE
, GFP_KERNEL
);
414 ret
= hid_hw_raw_request(hdev
, FEATURE_KBD_REPORT_ID
, readbuf
,
415 FEATURE_KBD_REPORT_SIZE
, HID_FEATURE_REPORT
,
418 hid_err(hdev
, "Asus failed to request functions: %d\n", ret
);
423 *kbd_func
= readbuf
[6];
429 static int rog_nkey_led_init(struct hid_device
*hdev
)
431 u8 buf_init_start
[] = { FEATURE_KBD_LED_REPORT_ID1
, 0xB9 };
432 u8 buf_init2
[] = { FEATURE_KBD_LED_REPORT_ID1
, 0x41, 0x53, 0x55, 0x53, 0x20,
433 0x54, 0x65, 0x63, 0x68, 0x2e, 0x49, 0x6e, 0x63, 0x2e, 0x00 };
434 u8 buf_init3
[] = { FEATURE_KBD_LED_REPORT_ID1
,
435 0x05, 0x20, 0x31, 0x00, 0x08 };
438 hid_info(hdev
, "Asus initialise N-KEY Device");
439 /* The first message is an init start */
440 ret
= asus_kbd_set_report(hdev
, buf_init_start
, sizeof(buf_init_start
));
442 hid_warn(hdev
, "Asus failed to send init start command: %d\n", ret
);
445 /* Followed by a string */
446 ret
= asus_kbd_set_report(hdev
, buf_init2
, sizeof(buf_init2
));
448 hid_warn(hdev
, "Asus failed to send init command 1.0: %d\n", ret
);
451 /* Followed by a string */
452 ret
= asus_kbd_set_report(hdev
, buf_init3
, sizeof(buf_init3
));
454 hid_warn(hdev
, "Asus failed to send init command 1.1: %d\n", ret
);
458 /* begin second report ID with same data */
459 buf_init2
[0] = FEATURE_KBD_LED_REPORT_ID2
;
460 buf_init3
[0] = FEATURE_KBD_LED_REPORT_ID2
;
462 ret
= asus_kbd_set_report(hdev
, buf_init2
, sizeof(buf_init2
));
464 hid_warn(hdev
, "Asus failed to send init command 2.0: %d\n", ret
);
467 ret
= asus_kbd_set_report(hdev
, buf_init3
, sizeof(buf_init3
));
469 hid_warn(hdev
, "Asus failed to send init command 2.1: %d\n", ret
);
474 static void asus_kbd_backlight_set(struct led_classdev
*led_cdev
,
475 enum led_brightness brightness
)
477 struct asus_kbd_leds
*led
= container_of(led_cdev
, struct asus_kbd_leds
,
479 if (led
->brightness
== brightness
)
482 led
->brightness
= brightness
;
483 schedule_work(&led
->work
);
486 static enum led_brightness
asus_kbd_backlight_get(struct led_classdev
*led_cdev
)
488 struct asus_kbd_leds
*led
= container_of(led_cdev
, struct asus_kbd_leds
,
491 return led
->brightness
;
494 static void asus_kbd_backlight_work(struct work_struct
*work
)
496 struct asus_kbd_leds
*led
= container_of(work
, struct asus_kbd_leds
, work
);
497 u8 buf
[] = { FEATURE_KBD_REPORT_ID
, 0xba, 0xc5, 0xc4, 0x00 };
503 buf
[4] = led
->brightness
;
505 ret
= asus_kbd_set_report(led
->hdev
, buf
, sizeof(buf
));
507 hid_err(led
->hdev
, "Asus failed to set keyboard backlight: %d\n", ret
);
510 /* WMI-based keyboard backlight LED control (via asus-wmi driver) takes
511 * precedence. We only activate HID-based backlight control when the
512 * WMI control is not available.
514 static bool asus_kbd_wmi_led_control_present(struct hid_device
*hdev
)
519 if (!IS_ENABLED(CONFIG_ASUS_WMI
))
522 ret
= asus_wmi_evaluate_method(ASUS_WMI_METHODID_DSTS
,
523 ASUS_WMI_DEVID_KBD_BACKLIGHT
, 0, &value
);
524 hid_dbg(hdev
, "WMI backlight check: rc %d value %x", ret
, value
);
528 return !!(value
& ASUS_WMI_DSTS_PRESENCE_BIT
);
531 static int asus_kbd_register_leds(struct hid_device
*hdev
)
533 struct asus_drvdata
*drvdata
= hid_get_drvdata(hdev
);
534 unsigned char kbd_func
;
537 if (drvdata
->quirks
& QUIRK_ROG_NKEY_KEYBOARD
) {
538 ret
= rog_nkey_led_init(hdev
);
542 /* Initialize keyboard */
543 ret
= asus_kbd_init(hdev
);
547 /* Get keyboard functions */
548 ret
= asus_kbd_get_functions(hdev
, &kbd_func
);
552 /* Check for backlight support */
553 if (!(kbd_func
& SUPPORT_KBD_BACKLIGHT
))
557 drvdata
->kbd_backlight
= devm_kzalloc(&hdev
->dev
,
558 sizeof(struct asus_kbd_leds
),
560 if (!drvdata
->kbd_backlight
)
563 drvdata
->kbd_backlight
->removed
= false;
564 drvdata
->kbd_backlight
->brightness
= 0;
565 drvdata
->kbd_backlight
->hdev
= hdev
;
566 drvdata
->kbd_backlight
->cdev
.name
= "asus::kbd_backlight";
567 drvdata
->kbd_backlight
->cdev
.max_brightness
= 3;
568 drvdata
->kbd_backlight
->cdev
.brightness_set
= asus_kbd_backlight_set
;
569 drvdata
->kbd_backlight
->cdev
.brightness_get
= asus_kbd_backlight_get
;
570 INIT_WORK(&drvdata
->kbd_backlight
->work
, asus_kbd_backlight_work
);
572 ret
= devm_led_classdev_register(&hdev
->dev
, &drvdata
->kbd_backlight
->cdev
);
574 /* No need to have this still around */
575 devm_kfree(&hdev
->dev
, drvdata
->kbd_backlight
);
582 * [0] REPORT_ID (same value defined in report descriptor)
583 * [1] rest battery level. range [0..255]
584 * [2]..[7] Bluetooth hardware address (MAC address)
585 * [8] charging status
586 * = 0 : AC offline / discharging
587 * = 1 : AC online / charging
588 * = 2 : AC online / fully charged
590 static int asus_parse_battery(struct asus_drvdata
*drvdata
, u8
*data
, int size
)
599 drvdata
->battery_capacity
= ((int)lvl
* 100) / (int)BATTERY_LEVEL_MAX
;
602 case BATTERY_STAT_CHARGING
:
603 val
= POWER_SUPPLY_STATUS_CHARGING
;
605 case BATTERY_STAT_FULL
:
606 val
= POWER_SUPPLY_STATUS_FULL
;
608 case BATTERY_STAT_DISCONNECT
:
610 val
= POWER_SUPPLY_STATUS_DISCHARGING
;
613 drvdata
->battery_stat
= val
;
618 static int asus_report_battery(struct asus_drvdata
*drvdata
, u8
*data
, int size
)
620 /* notify only the autonomous event by device */
621 if ((drvdata
->battery_in_query
== false) &&
622 (size
== BATTERY_REPORT_SIZE
))
623 power_supply_changed(drvdata
->battery
);
628 static int asus_battery_query(struct asus_drvdata
*drvdata
)
633 buf
= kmalloc(BATTERY_REPORT_SIZE
, GFP_KERNEL
);
637 drvdata
->battery_in_query
= true;
638 ret
= hid_hw_raw_request(drvdata
->hdev
, BATTERY_REPORT_ID
,
639 buf
, BATTERY_REPORT_SIZE
,
640 HID_INPUT_REPORT
, HID_REQ_GET_REPORT
);
641 drvdata
->battery_in_query
= false;
642 if (ret
== BATTERY_REPORT_SIZE
)
643 ret
= asus_parse_battery(drvdata
, buf
, BATTERY_REPORT_SIZE
);
652 static enum power_supply_property asus_battery_props
[] = {
653 POWER_SUPPLY_PROP_STATUS
,
654 POWER_SUPPLY_PROP_PRESENT
,
655 POWER_SUPPLY_PROP_CAPACITY
,
656 POWER_SUPPLY_PROP_SCOPE
,
657 POWER_SUPPLY_PROP_MODEL_NAME
,
660 #define QUERY_MIN_INTERVAL (60 * HZ) /* 60[sec] */
662 static int asus_battery_get_property(struct power_supply
*psy
,
663 enum power_supply_property psp
,
664 union power_supply_propval
*val
)
666 struct asus_drvdata
*drvdata
= power_supply_get_drvdata(psy
);
670 case POWER_SUPPLY_PROP_STATUS
:
671 case POWER_SUPPLY_PROP_CAPACITY
:
672 if (time_before(drvdata
->battery_next_query
, jiffies
)) {
673 drvdata
->battery_next_query
=
674 jiffies
+ QUERY_MIN_INTERVAL
;
675 ret
= asus_battery_query(drvdata
);
679 if (psp
== POWER_SUPPLY_PROP_STATUS
)
680 val
->intval
= drvdata
->battery_stat
;
682 val
->intval
= drvdata
->battery_capacity
;
684 case POWER_SUPPLY_PROP_PRESENT
:
687 case POWER_SUPPLY_PROP_SCOPE
:
688 val
->intval
= POWER_SUPPLY_SCOPE_DEVICE
;
690 case POWER_SUPPLY_PROP_MODEL_NAME
:
691 val
->strval
= drvdata
->hdev
->name
;
701 static int asus_battery_probe(struct hid_device
*hdev
)
703 struct asus_drvdata
*drvdata
= hid_get_drvdata(hdev
);
704 struct power_supply_config pscfg
= { .drv_data
= drvdata
};
707 drvdata
->battery_capacity
= 0;
708 drvdata
->battery_stat
= POWER_SUPPLY_STATUS_UNKNOWN
;
709 drvdata
->battery_in_query
= false;
711 drvdata
->battery_desc
.properties
= asus_battery_props
;
712 drvdata
->battery_desc
.num_properties
= ARRAY_SIZE(asus_battery_props
);
713 drvdata
->battery_desc
.get_property
= asus_battery_get_property
;
714 drvdata
->battery_desc
.type
= POWER_SUPPLY_TYPE_BATTERY
;
715 drvdata
->battery_desc
.use_for_apm
= 0;
716 drvdata
->battery_desc
.name
= devm_kasprintf(&hdev
->dev
, GFP_KERNEL
,
717 "asus-keyboard-%s-battery",
719 hdev
->uniq
: dev_name(&hdev
->dev
));
720 if (!drvdata
->battery_desc
.name
)
723 drvdata
->battery_next_query
= jiffies
;
725 drvdata
->battery
= devm_power_supply_register(&hdev
->dev
,
726 &(drvdata
->battery_desc
), &pscfg
);
727 if (IS_ERR(drvdata
->battery
)) {
728 ret
= PTR_ERR(drvdata
->battery
);
729 drvdata
->battery
= NULL
;
730 hid_err(hdev
, "Unable to register battery device\n");
734 power_supply_powers(drvdata
->battery
, &hdev
->dev
);
739 static int asus_input_configured(struct hid_device
*hdev
, struct hid_input
*hi
)
741 struct input_dev
*input
= hi
->input
;
742 struct asus_drvdata
*drvdata
= hid_get_drvdata(hdev
);
744 /* T100CHI uses MULTI_INPUT, bind the touchpad to the mouse hid_input */
745 if (drvdata
->quirks
& QUIRK_T100CHI
&&
746 hi
->report
->id
!= T100CHI_MOUSE_REPORT_ID
)
749 /* Handle MULTI_INPUT on E1239T mouse/touchpad USB interface */
750 if (drvdata
->tp
&& (drvdata
->quirks
& QUIRK_MEDION_E1239T
)) {
751 switch (hi
->report
->id
) {
752 case E1239T_TP_TOGGLE_REPORT_ID
:
753 input_set_capability(input
, EV_KEY
, KEY_F21
);
754 input
->name
= "Asus Touchpad Keys";
755 drvdata
->tp_kbd_input
= input
;
757 case INPUT_REPORT_ID
:
758 break; /* Touchpad report, handled below */
760 return 0; /* Ignore other reports */
767 input_set_abs_params(input
, ABS_MT_POSITION_X
, 0,
768 drvdata
->tp
->max_x
, 0, 0);
769 input_set_abs_params(input
, ABS_MT_POSITION_Y
, 0,
770 drvdata
->tp
->max_y
, 0, 0);
771 input_abs_set_res(input
, ABS_MT_POSITION_X
, drvdata
->tp
->res_x
);
772 input_abs_set_res(input
, ABS_MT_POSITION_Y
, drvdata
->tp
->res_y
);
774 if (drvdata
->tp
->contact_size
>= 5) {
775 input_set_abs_params(input
, ABS_TOOL_WIDTH
, 0,
776 MAX_TOUCH_MAJOR
, 0, 0);
777 input_set_abs_params(input
, ABS_MT_TOUCH_MAJOR
, 0,
778 MAX_TOUCH_MAJOR
, 0, 0);
779 input_set_abs_params(input
, ABS_MT_PRESSURE
, 0,
783 __set_bit(BTN_LEFT
, input
->keybit
);
784 __set_bit(INPUT_PROP_BUTTONPAD
, input
->propbit
);
786 ret
= input_mt_init_slots(input
, drvdata
->tp
->max_contacts
,
790 hid_err(hdev
, "Asus input mt init slots failed: %d\n", ret
);
795 drvdata
->input
= input
;
797 if (drvdata
->enable_backlight
&&
798 !asus_kbd_wmi_led_control_present(hdev
) &&
799 asus_kbd_register_leds(hdev
))
800 hid_warn(hdev
, "Failed to initialize backlight.\n");
805 #define asus_map_key_clear(c) hid_map_usage_clear(hi, usage, bit, \
807 static int asus_input_mapping(struct hid_device
*hdev
,
808 struct hid_input
*hi
, struct hid_field
*field
,
809 struct hid_usage
*usage
, unsigned long **bit
,
812 struct asus_drvdata
*drvdata
= hid_get_drvdata(hdev
);
814 if (drvdata
->quirks
& QUIRK_SKIP_INPUT_MAPPING
) {
815 /* Don't map anything from the HID report.
816 * We do it all manually in asus_input_configured
822 * Ignore a bunch of bogus collections in the T100CHI descriptor.
823 * This avoids a bunch of non-functional hid_input devices getting
824 * created because of the T100CHI using HID_QUIRK_MULTI_INPUT.
826 if ((drvdata
->quirks
& (QUIRK_T100CHI
| QUIRK_T90CHI
)) &&
827 (field
->application
== (HID_UP_GENDESK
| 0x0080) ||
828 field
->application
== HID_GD_MOUSE
||
829 usage
->hid
== (HID_UP_GENDEVCTRLS
| 0x0024) ||
830 usage
->hid
== (HID_UP_GENDEVCTRLS
| 0x0025) ||
831 usage
->hid
== (HID_UP_GENDEVCTRLS
| 0x0026)))
834 /* ASUS-specific keyboard hotkeys and led backlight */
835 if ((usage
->hid
& HID_USAGE_PAGE
) == HID_UP_ASUSVENDOR
) {
836 switch (usage
->hid
& HID_USAGE
) {
837 case 0x10: asus_map_key_clear(KEY_BRIGHTNESSDOWN
); break;
838 case 0x20: asus_map_key_clear(KEY_BRIGHTNESSUP
); break;
839 case 0x35: asus_map_key_clear(KEY_DISPLAY_OFF
); break;
840 case 0x6c: asus_map_key_clear(KEY_SLEEP
); break;
841 case 0x7c: asus_map_key_clear(KEY_MICMUTE
); break;
842 case 0x82: asus_map_key_clear(KEY_CAMERA
); break;
843 case 0x88: asus_map_key_clear(KEY_RFKILL
); break;
844 case 0xb5: asus_map_key_clear(KEY_CALC
); break;
845 case 0xc4: asus_map_key_clear(KEY_KBDILLUMUP
); break;
846 case 0xc5: asus_map_key_clear(KEY_KBDILLUMDOWN
); break;
848 /* ASUS touchpad toggle */
849 case 0x6b: asus_map_key_clear(KEY_F21
); break;
852 case 0x38: asus_map_key_clear(KEY_PROG1
); break;
854 /* Fn+C ASUS Splendid */
855 case 0xba: asus_map_key_clear(KEY_PROG2
); break;
857 /* Fn+Space Power4Gear Hybrid */
858 case 0x5c: asus_map_key_clear(KEY_PROG3
); break;
860 /* Fn+F5 "fan" symbol on FX503VD */
861 case 0x99: asus_map_key_clear(KEY_PROG4
); break;
863 /* Fn+F5 "fan" symbol on N-Key keyboard */
864 case 0xae: asus_map_key_clear(KEY_PROG4
); break;
866 /* Fn+Ret "Calc" symbol on N-Key keyboard */
867 case 0x92: asus_map_key_clear(KEY_CALC
); break;
869 /* Fn+Left Aura mode previous on N-Key keyboard */
870 case 0xb2: asus_map_key_clear(KEY_PROG2
); break;
872 /* Fn+Right Aura mode next on N-Key keyboard */
873 case 0xb3: asus_map_key_clear(KEY_PROG3
); break;
876 /* ASUS lazily declares 256 usages, ignore the rest,
877 * as some make the keyboard appear as a pointer device. */
882 * Check and enable backlight only on devices with UsagePage ==
883 * 0xff31 to avoid initializing the keyboard firmware multiple
884 * times on devices with multiple HID descriptors but same
887 if (drvdata
->quirks
& QUIRK_USE_KBD_BACKLIGHT
)
888 drvdata
->enable_backlight
= true;
890 set_bit(EV_REP
, hi
->input
->evbit
);
894 if ((usage
->hid
& HID_USAGE_PAGE
) == HID_UP_MSVENDOR
) {
895 switch (usage
->hid
& HID_USAGE
) {
896 case 0xff01: asus_map_key_clear(BTN_1
); break;
897 case 0xff02: asus_map_key_clear(BTN_2
); break;
898 case 0xff03: asus_map_key_clear(BTN_3
); break;
899 case 0xff04: asus_map_key_clear(BTN_4
); break;
900 case 0xff05: asus_map_key_clear(BTN_5
); break;
901 case 0xff06: asus_map_key_clear(BTN_6
); break;
902 case 0xff07: asus_map_key_clear(BTN_7
); break;
903 case 0xff08: asus_map_key_clear(BTN_8
); break;
904 case 0xff09: asus_map_key_clear(BTN_9
); break;
905 case 0xff0a: asus_map_key_clear(BTN_A
); break;
906 case 0xff0b: asus_map_key_clear(BTN_B
); break;
907 case 0x00f1: asus_map_key_clear(KEY_WLAN
); break;
908 case 0x00f2: asus_map_key_clear(KEY_BRIGHTNESSDOWN
); break;
909 case 0x00f3: asus_map_key_clear(KEY_BRIGHTNESSUP
); break;
910 case 0x00f4: asus_map_key_clear(KEY_DISPLAY_OFF
); break;
911 case 0x00f7: asus_map_key_clear(KEY_CAMERA
); break;
912 case 0x00f8: asus_map_key_clear(KEY_PROG1
); break;
917 set_bit(EV_REP
, hi
->input
->evbit
);
921 if (drvdata
->quirks
& QUIRK_NO_CONSUMER_USAGES
&&
922 (usage
->hid
& HID_USAGE_PAGE
) == HID_UP_CONSUMER
) {
923 switch (usage
->hid
& HID_USAGE
) {
924 case 0xe2: /* Mute */
925 case 0xe9: /* Volume up */
926 case 0xea: /* Volume down */
929 /* Ignore dummy Consumer usages which make the
930 * keyboard incorrectly appear as a pointer device.
937 * The mute button is broken and only sends press events, we
938 * deal with this in our raw_event handler, so do not map it.
940 if ((drvdata
->quirks
& QUIRK_MEDION_E1239T
) &&
941 usage
->hid
== (HID_UP_CONSUMER
| 0xe2)) {
942 input_set_capability(hi
->input
, EV_KEY
, KEY_MUTE
);
949 static int asus_start_multitouch(struct hid_device
*hdev
)
952 static const unsigned char buf
[] = {
953 FEATURE_REPORT_ID
, 0x00, 0x03, 0x01, 0x00
955 unsigned char *dmabuf
= kmemdup(buf
, sizeof(buf
), GFP_KERNEL
);
959 hid_err(hdev
, "Asus failed to alloc dma buf: %d\n", ret
);
963 ret
= hid_hw_raw_request(hdev
, dmabuf
[0], dmabuf
, sizeof(buf
),
964 HID_FEATURE_REPORT
, HID_REQ_SET_REPORT
);
968 if (ret
!= sizeof(buf
)) {
969 hid_err(hdev
, "Asus failed to start multitouch: %d\n", ret
);
976 static int __maybe_unused
asus_reset_resume(struct hid_device
*hdev
)
978 struct asus_drvdata
*drvdata
= hid_get_drvdata(hdev
);
981 return asus_start_multitouch(hdev
);
986 static int asus_probe(struct hid_device
*hdev
, const struct hid_device_id
*id
)
989 struct asus_drvdata
*drvdata
;
991 drvdata
= devm_kzalloc(&hdev
->dev
, sizeof(*drvdata
), GFP_KERNEL
);
992 if (drvdata
== NULL
) {
993 hid_err(hdev
, "Can't alloc Asus descriptor\n");
997 hid_set_drvdata(hdev
, drvdata
);
999 drvdata
->quirks
= id
->driver_data
;
1002 * T90CHI's keyboard dock returns same ID values as T100CHI's dock.
1003 * Thus, identify T90CHI dock with product name string.
1005 if (strstr(hdev
->name
, "T90CHI")) {
1006 drvdata
->quirks
&= ~QUIRK_T100CHI
;
1007 drvdata
->quirks
|= QUIRK_T90CHI
;
1010 if (drvdata
->quirks
& QUIRK_IS_MULTITOUCH
)
1011 drvdata
->tp
= &asus_i2c_tp
;
1013 if ((drvdata
->quirks
& QUIRK_T100_KEYBOARD
) &&
1014 hid_is_using_ll_driver(hdev
, &usb_hid_driver
)) {
1015 struct usb_interface
*intf
= to_usb_interface(hdev
->dev
.parent
);
1017 if (intf
->altsetting
->desc
.bInterfaceNumber
== T100_TPAD_INTF
) {
1018 drvdata
->quirks
= QUIRK_SKIP_INPUT_MAPPING
;
1020 * The T100HA uses the same USB-ids as the T100TAF and
1021 * the T200TA uses the same USB-ids as the T100TA, while
1022 * both have different max x/y values as the T100TA[F].
1024 if (dmi_match(DMI_PRODUCT_NAME
, "T100HAN"))
1025 drvdata
->tp
= &asus_t100ha_tp
;
1026 else if (dmi_match(DMI_PRODUCT_NAME
, "T200TA"))
1027 drvdata
->tp
= &asus_t200ta_tp
;
1029 drvdata
->tp
= &asus_t100ta_tp
;
1033 if (drvdata
->quirks
& QUIRK_T100CHI
) {
1035 * All functionality is on a single HID interface and for
1036 * userspace the touchpad must be a separate input_dev.
1038 hdev
->quirks
|= HID_QUIRK_MULTI_INPUT
;
1039 drvdata
->tp
= &asus_t100chi_tp
;
1042 if ((drvdata
->quirks
& QUIRK_MEDION_E1239T
) &&
1043 hid_is_using_ll_driver(hdev
, &usb_hid_driver
)) {
1044 struct usb_host_interface
*alt
=
1045 to_usb_interface(hdev
->dev
.parent
)->altsetting
;
1047 if (alt
->desc
.bInterfaceNumber
== MEDION_E1239T_TPAD_INTF
) {
1048 /* For separate input-devs for tp and tp toggle key */
1049 hdev
->quirks
|= HID_QUIRK_MULTI_INPUT
;
1050 drvdata
->quirks
|= QUIRK_SKIP_INPUT_MAPPING
;
1051 drvdata
->tp
= &medion_e1239t_tp
;
1055 if (drvdata
->quirks
& QUIRK_NO_INIT_REPORTS
)
1056 hdev
->quirks
|= HID_QUIRK_NO_INIT_REPORTS
;
1058 drvdata
->hdev
= hdev
;
1060 if (drvdata
->quirks
& (QUIRK_T100CHI
| QUIRK_T90CHI
)) {
1061 ret
= asus_battery_probe(hdev
);
1064 "Asus hid battery_probe failed: %d\n", ret
);
1069 ret
= hid_parse(hdev
);
1071 hid_err(hdev
, "Asus hid parse failed: %d\n", ret
);
1075 /* use hid-multitouch for T101HA touchpad */
1076 if (id
->driver_data
& QUIRK_T101HA_DOCK
&&
1077 hdev
->collection
->usage
== HID_GD_MOUSE
)
1080 ret
= hid_hw_start(hdev
, HID_CONNECT_DEFAULT
);
1082 hid_err(hdev
, "Asus hw start failed: %d\n", ret
);
1086 if (!drvdata
->input
) {
1087 hid_err(hdev
, "Asus input not registered\n");
1093 drvdata
->input
->name
= "Asus TouchPad";
1095 drvdata
->input
->name
= "Asus Keyboard";
1099 ret
= asus_start_multitouch(hdev
);
1110 static void asus_remove(struct hid_device
*hdev
)
1112 struct asus_drvdata
*drvdata
= hid_get_drvdata(hdev
);
1114 if (drvdata
->kbd_backlight
) {
1115 drvdata
->kbd_backlight
->removed
= true;
1116 cancel_work_sync(&drvdata
->kbd_backlight
->work
);
1122 static const __u8 asus_g752_fixed_rdesc
[] = {
1123 0x19, 0x00, /* Usage Minimum (0x00) */
1124 0x2A, 0xFF, 0x00, /* Usage Maximum (0xFF) */
1127 static __u8
*asus_report_fixup(struct hid_device
*hdev
, __u8
*rdesc
,
1128 unsigned int *rsize
)
1130 struct asus_drvdata
*drvdata
= hid_get_drvdata(hdev
);
1132 if (drvdata
->quirks
& QUIRK_FIX_NOTEBOOK_REPORT
&&
1133 *rsize
>= 56 && rdesc
[54] == 0x25 && rdesc
[55] == 0x65) {
1134 hid_info(hdev
, "Fixing up Asus notebook report descriptor\n");
1137 /* For the T100TA/T200TA keyboard dock */
1138 if (drvdata
->quirks
& QUIRK_T100_KEYBOARD
&&
1139 (*rsize
== 76 || *rsize
== 101) &&
1140 rdesc
[73] == 0x81 && rdesc
[74] == 0x01) {
1141 hid_info(hdev
, "Fixing up Asus T100 keyb report descriptor\n");
1142 rdesc
[74] &= ~HID_MAIN_ITEM_CONSTANT
;
1144 /* For the T100CHI/T90CHI keyboard dock */
1145 if (drvdata
->quirks
& (QUIRK_T100CHI
| QUIRK_T90CHI
)) {
1149 if (drvdata
->quirks
& QUIRK_T100CHI
) {
1158 * Change Usage (76h) to Usage Minimum (00h), Usage Maximum
1159 * (FFh) and clear the flags in the Input() byte.
1160 * Note the descriptor has a bogus 0 byte at the end so we
1161 * only need 1 extra byte.
1163 if (*rsize
== rsize_orig
&&
1164 rdesc
[offs
] == 0x09 && rdesc
[offs
+ 1] == 0x76) {
1165 *rsize
= rsize_orig
+ 1;
1166 rdesc
= kmemdup(rdesc
, *rsize
, GFP_KERNEL
);
1170 hid_info(hdev
, "Fixing up %s keyb report descriptor\n",
1171 drvdata
->quirks
& QUIRK_T100CHI
?
1172 "T100CHI" : "T90CHI");
1173 memmove(rdesc
+ offs
+ 4, rdesc
+ offs
+ 2, 12);
1175 rdesc
[offs
+ 1] = 0x00;
1176 rdesc
[offs
+ 2] = 0x29;
1177 rdesc
[offs
+ 3] = 0xff;
1178 rdesc
[offs
+ 14] = 0x00;
1182 if (drvdata
->quirks
& QUIRK_G752_KEYBOARD
&&
1183 *rsize
== 75 && rdesc
[61] == 0x15 && rdesc
[62] == 0x00) {
1184 /* report is missing usage mninum and maximum */
1186 size_t new_size
= *rsize
+ sizeof(asus_g752_fixed_rdesc
);
1188 new_rdesc
= devm_kzalloc(&hdev
->dev
, new_size
, GFP_KERNEL
);
1189 if (new_rdesc
== NULL
)
1192 hid_info(hdev
, "Fixing up Asus G752 keyb report descriptor\n");
1193 /* copy the valid part */
1194 memcpy(new_rdesc
, rdesc
, 61);
1195 /* insert missing part */
1196 memcpy(new_rdesc
+ 61, asus_g752_fixed_rdesc
, sizeof(asus_g752_fixed_rdesc
));
1197 /* copy remaining data */
1198 memcpy(new_rdesc
+ 61 + sizeof(asus_g752_fixed_rdesc
), rdesc
+ 61, *rsize
- 61);
1207 static const struct hid_device_id asus_devices
[] = {
1208 { HID_I2C_DEVICE(USB_VENDOR_ID_ASUSTEK
,
1209 USB_DEVICE_ID_ASUSTEK_I2C_KEYBOARD
), I2C_KEYBOARD_QUIRKS
},
1210 { HID_I2C_DEVICE(USB_VENDOR_ID_ASUSTEK
,
1211 USB_DEVICE_ID_ASUSTEK_I2C_TOUCHPAD
), I2C_TOUCHPAD_QUIRKS
},
1212 { HID_USB_DEVICE(USB_VENDOR_ID_ASUSTEK
,
1213 USB_DEVICE_ID_ASUSTEK_ROG_KEYBOARD1
), QUIRK_USE_KBD_BACKLIGHT
},
1214 { HID_USB_DEVICE(USB_VENDOR_ID_ASUSTEK
,
1215 USB_DEVICE_ID_ASUSTEK_ROG_KEYBOARD2
), QUIRK_USE_KBD_BACKLIGHT
},
1216 { HID_USB_DEVICE(USB_VENDOR_ID_ASUSTEK
,
1217 USB_DEVICE_ID_ASUSTEK_ROG_KEYBOARD3
), QUIRK_G752_KEYBOARD
},
1218 { HID_USB_DEVICE(USB_VENDOR_ID_ASUSTEK
,
1219 USB_DEVICE_ID_ASUSTEK_FX503VD_KEYBOARD
),
1220 QUIRK_USE_KBD_BACKLIGHT
},
1221 { HID_USB_DEVICE(USB_VENDOR_ID_ASUSTEK
,
1222 USB_DEVICE_ID_ASUSTEK_ROG_NKEY_KEYBOARD
),
1223 QUIRK_USE_KBD_BACKLIGHT
| QUIRK_ROG_NKEY_KEYBOARD
},
1224 { HID_USB_DEVICE(USB_VENDOR_ID_ASUSTEK
,
1225 USB_DEVICE_ID_ASUSTEK_T100TA_KEYBOARD
),
1226 QUIRK_T100_KEYBOARD
| QUIRK_NO_CONSUMER_USAGES
},
1227 { HID_USB_DEVICE(USB_VENDOR_ID_ASUSTEK
,
1228 USB_DEVICE_ID_ASUSTEK_T100TAF_KEYBOARD
),
1229 QUIRK_T100_KEYBOARD
| QUIRK_NO_CONSUMER_USAGES
},
1230 { HID_USB_DEVICE(USB_VENDOR_ID_ASUSTEK
,
1231 USB_DEVICE_ID_ASUSTEK_T101HA_KEYBOARD
), QUIRK_T101HA_DOCK
},
1232 { HID_USB_DEVICE(USB_VENDOR_ID_CHICONY
, USB_DEVICE_ID_ASUS_AK1D
) },
1233 { HID_USB_DEVICE(USB_VENDOR_ID_TURBOX
, USB_DEVICE_ID_ASUS_MD_5110
) },
1234 { HID_USB_DEVICE(USB_VENDOR_ID_JESS
, USB_DEVICE_ID_ASUS_MD_5112
) },
1235 { HID_BLUETOOTH_DEVICE(USB_VENDOR_ID_ASUSTEK
,
1236 USB_DEVICE_ID_ASUSTEK_T100CHI_KEYBOARD
), QUIRK_T100CHI
},
1237 { HID_USB_DEVICE(USB_VENDOR_ID_ITE
, USB_DEVICE_ID_ITE_MEDION_E1239T
),
1238 QUIRK_MEDION_E1239T
},
1241 MODULE_DEVICE_TABLE(hid
, asus_devices
);
1243 static struct hid_driver asus_driver
= {
1245 .id_table
= asus_devices
,
1246 .report_fixup
= asus_report_fixup
,
1247 .probe
= asus_probe
,
1248 .remove
= asus_remove
,
1249 .input_mapping
= asus_input_mapping
,
1250 .input_configured
= asus_input_configured
,
1252 .reset_resume
= asus_reset_resume
,
1254 .event
= asus_event
,
1255 .raw_event
= asus_raw_event
1257 module_hid_driver(asus_driver
);
1259 MODULE_LICENSE("GPL");