1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Asus Notebooks WMI hotkey driver
8 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
10 #include <linux/kernel.h>
11 #include <linux/module.h>
12 #include <linux/init.h>
13 #include <linux/input.h>
14 #include <linux/input/sparse-keymap.h>
16 #include <linux/dmi.h>
17 #include <linux/i8042.h>
21 #define ASUS_NB_WMI_FILE "asus-nb-wmi"
24 MODULE_DESCRIPTION("Asus Notebooks WMI Hotkey Driver");
25 MODULE_LICENSE("GPL");
27 #define ASUS_NB_WMI_EVENT_GUID "0B3CBB35-E3C2-45ED-91C2-4C5A6D195D1C"
29 MODULE_ALIAS("wmi:"ASUS_NB_WMI_EVENT_GUID);
32 * WAPF defines the behavior of the Fn+Fx wlan key
33 * The significance of values is yet to be found, but
35 * Bit | Bluetooth | WLAN
36 * 0 | Hardware | Hardware
37 * 1 | Hardware | Software
38 * 4 | Software | Software
41 module_param(wapf, uint, 0444);
42 MODULE_PARM_DESC(wapf, "WAPF value");
44 static struct quirk_entry *quirks;
46 static bool asus_q500a_i8042_filter(unsigned char data, unsigned char str,
52 if (str & I8042_STR_AUXDATA)
55 if (unlikely(data == 0xe1)) {
58 } else if (unlikely(extended)) {
66 static struct quirk_entry quirk_asus_unknown = {
68 .wmi_backlight_set_devstate = true,
71 static struct quirk_entry quirk_asus_q500a = {
72 .i8042_filter = asus_q500a_i8042_filter,
73 .wmi_backlight_set_devstate = true,
77 * For those machines that need software to control bt/wifi status
78 * and can't adjust brightness through ACPI interface
79 * and have duplicate events(ACPI and WMI) for display toggle
81 static struct quirk_entry quirk_asus_x55u = {
83 .wmi_backlight_power = true,
84 .wmi_backlight_set_devstate = true,
85 .no_display_toggle = true,
88 static struct quirk_entry quirk_asus_wapf4 = {
90 .wmi_backlight_set_devstate = true,
93 static struct quirk_entry quirk_asus_x200ca = {
95 .wmi_backlight_set_devstate = true,
98 static struct quirk_entry quirk_asus_ux303ub = {
99 .wmi_backlight_native = true,
100 .wmi_backlight_set_devstate = true,
103 static struct quirk_entry quirk_asus_x550lb = {
104 .wmi_backlight_set_devstate = true,
108 static struct quirk_entry quirk_asus_forceals = {
109 .wmi_backlight_set_devstate = true,
110 .wmi_force_als_set = true,
113 static struct quirk_entry quirk_asus_use_kbd_dock_devid = {
114 .use_kbd_dock_devid = true,
117 static struct quirk_entry quirk_asus_use_lid_flip_devid = {
118 .wmi_backlight_set_devstate = true,
119 .use_lid_flip_devid = true,
122 static int dmi_matched(const struct dmi_system_id *dmi)
124 pr_info("Identified laptop model '%s'\n", dmi->ident);
125 quirks = dmi->driver_data;
129 static const struct dmi_system_id asus_quirks[] = {
131 .callback = dmi_matched,
132 .ident = "ASUSTeK COMPUTER INC. Q500A",
134 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
135 DMI_MATCH(DMI_PRODUCT_NAME, "Q500A"),
137 .driver_data = &quirk_asus_q500a,
140 .callback = dmi_matched,
141 .ident = "ASUSTeK COMPUTER INC. U32U",
143 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK Computer Inc."),
144 DMI_MATCH(DMI_PRODUCT_NAME, "U32U"),
147 * Note this machine has a Brazos APU, and most Brazos Asus
148 * machines need quirk_asus_x55u / wmi_backlight_power but
149 * here acpi-video seems to work fine for backlight control.
151 .driver_data = &quirk_asus_wapf4,
154 .callback = dmi_matched,
155 .ident = "ASUSTeK COMPUTER INC. X302UA",
157 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
158 DMI_MATCH(DMI_PRODUCT_NAME, "X302UA"),
160 .driver_data = &quirk_asus_wapf4,
163 .callback = dmi_matched,
164 .ident = "ASUSTeK COMPUTER INC. X401U",
166 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
167 DMI_MATCH(DMI_PRODUCT_NAME, "X401U"),
169 .driver_data = &quirk_asus_x55u,
172 .callback = dmi_matched,
173 .ident = "ASUSTeK COMPUTER INC. X401A",
175 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
176 DMI_MATCH(DMI_PRODUCT_NAME, "X401A"),
178 .driver_data = &quirk_asus_wapf4,
181 .callback = dmi_matched,
182 .ident = "ASUSTeK COMPUTER INC. X401A1",
184 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
185 DMI_MATCH(DMI_PRODUCT_NAME, "X401A1"),
187 .driver_data = &quirk_asus_wapf4,
190 .callback = dmi_matched,
191 .ident = "ASUSTeK COMPUTER INC. X45U",
193 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
194 DMI_MATCH(DMI_PRODUCT_NAME, "X45U"),
196 .driver_data = &quirk_asus_wapf4,
199 .callback = dmi_matched,
200 .ident = "ASUSTeK COMPUTER INC. X456UA",
202 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
203 DMI_MATCH(DMI_PRODUCT_NAME, "X456UA"),
205 .driver_data = &quirk_asus_wapf4,
208 .callback = dmi_matched,
209 .ident = "ASUSTeK COMPUTER INC. X456UF",
211 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
212 DMI_MATCH(DMI_PRODUCT_NAME, "X456UF"),
214 .driver_data = &quirk_asus_wapf4,
217 .callback = dmi_matched,
218 .ident = "ASUSTeK COMPUTER INC. X501U",
220 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
221 DMI_MATCH(DMI_PRODUCT_NAME, "X501U"),
223 .driver_data = &quirk_asus_x55u,
226 .callback = dmi_matched,
227 .ident = "ASUSTeK COMPUTER INC. X501A",
229 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
230 DMI_MATCH(DMI_PRODUCT_NAME, "X501A"),
232 .driver_data = &quirk_asus_wapf4,
235 .callback = dmi_matched,
236 .ident = "ASUSTeK COMPUTER INC. X501A1",
238 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
239 DMI_MATCH(DMI_PRODUCT_NAME, "X501A1"),
241 .driver_data = &quirk_asus_wapf4,
244 .callback = dmi_matched,
245 .ident = "ASUSTeK COMPUTER INC. X550CA",
247 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
248 DMI_MATCH(DMI_PRODUCT_NAME, "X550CA"),
250 .driver_data = &quirk_asus_wapf4,
253 .callback = dmi_matched,
254 .ident = "ASUSTeK COMPUTER INC. X550CC",
256 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
257 DMI_MATCH(DMI_PRODUCT_NAME, "X550CC"),
259 .driver_data = &quirk_asus_wapf4,
262 .callback = dmi_matched,
263 .ident = "ASUSTeK COMPUTER INC. X550CL",
265 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
266 DMI_MATCH(DMI_PRODUCT_NAME, "X550CL"),
268 .driver_data = &quirk_asus_wapf4,
271 .callback = dmi_matched,
272 .ident = "ASUSTeK COMPUTER INC. X550VB",
274 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
275 DMI_MATCH(DMI_PRODUCT_NAME, "X550VB"),
277 .driver_data = &quirk_asus_wapf4,
280 .callback = dmi_matched,
281 .ident = "ASUSTeK COMPUTER INC. X551CA",
283 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
284 DMI_MATCH(DMI_PRODUCT_NAME, "X551CA"),
286 .driver_data = &quirk_asus_wapf4,
289 .callback = dmi_matched,
290 .ident = "ASUSTeK COMPUTER INC. X55A",
292 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
293 DMI_MATCH(DMI_PRODUCT_NAME, "X55A"),
295 .driver_data = &quirk_asus_wapf4,
298 .callback = dmi_matched,
299 .ident = "ASUSTeK COMPUTER INC. X55C",
301 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
302 DMI_MATCH(DMI_PRODUCT_NAME, "X55C"),
304 .driver_data = &quirk_asus_wapf4,
307 .callback = dmi_matched,
308 .ident = "ASUSTeK COMPUTER INC. X55U",
310 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
311 DMI_MATCH(DMI_PRODUCT_NAME, "X55U"),
313 .driver_data = &quirk_asus_x55u,
316 .callback = dmi_matched,
317 .ident = "ASUSTeK COMPUTER INC. X55VD",
319 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
320 DMI_MATCH(DMI_PRODUCT_NAME, "X55VD"),
322 .driver_data = &quirk_asus_wapf4,
325 .callback = dmi_matched,
326 .ident = "ASUSTeK COMPUTER INC. X75A",
328 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
329 DMI_MATCH(DMI_PRODUCT_NAME, "X75A"),
331 .driver_data = &quirk_asus_wapf4,
334 .callback = dmi_matched,
335 .ident = "ASUSTeK COMPUTER INC. X75VBP",
337 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
338 DMI_MATCH(DMI_PRODUCT_NAME, "X75VBP"),
340 .driver_data = &quirk_asus_wapf4,
343 .callback = dmi_matched,
344 .ident = "ASUSTeK COMPUTER INC. X75VD",
346 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
347 DMI_MATCH(DMI_PRODUCT_NAME, "X75VD"),
349 .driver_data = &quirk_asus_wapf4,
352 .callback = dmi_matched,
353 .ident = "ASUSTeK COMPUTER INC. 1015E",
355 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
356 DMI_MATCH(DMI_PRODUCT_NAME, "1015E"),
358 .driver_data = &quirk_asus_wapf4,
361 .callback = dmi_matched,
362 .ident = "ASUSTeK COMPUTER INC. 1015U",
364 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
365 DMI_MATCH(DMI_PRODUCT_NAME, "1015U"),
367 .driver_data = &quirk_asus_wapf4,
370 .callback = dmi_matched,
371 .ident = "ASUSTeK COMPUTER INC. X200CA",
373 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
374 DMI_MATCH(DMI_PRODUCT_NAME, "X200CA"),
376 .driver_data = &quirk_asus_x200ca,
379 .callback = dmi_matched,
380 .ident = "ASUSTeK COMPUTER INC. UX303UB",
382 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
383 DMI_MATCH(DMI_PRODUCT_NAME, "UX303UB"),
385 .driver_data = &quirk_asus_ux303ub,
388 .callback = dmi_matched,
389 .ident = "ASUSTeK COMPUTER INC. UX330UAK",
391 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
392 DMI_MATCH(DMI_PRODUCT_NAME, "UX330UAK"),
394 .driver_data = &quirk_asus_forceals,
397 .callback = dmi_matched,
398 .ident = "ASUSTeK COMPUTER INC. X550LB",
400 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
401 DMI_MATCH(DMI_PRODUCT_NAME, "X550LB"),
403 .driver_data = &quirk_asus_x550lb,
406 .callback = dmi_matched,
407 .ident = "ASUSTeK COMPUTER INC. UX430UQ",
409 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
410 DMI_MATCH(DMI_PRODUCT_NAME, "UX430UQ"),
412 .driver_data = &quirk_asus_forceals,
415 .callback = dmi_matched,
416 .ident = "ASUSTeK COMPUTER INC. UX430UNR",
418 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
419 DMI_MATCH(DMI_PRODUCT_NAME, "UX430UNR"),
421 .driver_data = &quirk_asus_forceals,
424 .callback = dmi_matched,
425 .ident = "Asus Transformer T100TA / T100HA / T100CHI",
427 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
429 DMI_MATCH(DMI_PRODUCT_NAME, "T100"),
431 .driver_data = &quirk_asus_use_kbd_dock_devid,
434 .callback = dmi_matched,
435 .ident = "Asus Transformer T101HA",
437 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
438 DMI_MATCH(DMI_PRODUCT_NAME, "T101HA"),
440 .driver_data = &quirk_asus_use_kbd_dock_devid,
443 .callback = dmi_matched,
444 .ident = "Asus Transformer T200TA",
446 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
447 DMI_MATCH(DMI_PRODUCT_NAME, "T200TA"),
449 .driver_data = &quirk_asus_use_kbd_dock_devid,
452 .callback = dmi_matched,
453 .ident = "ASUS ZenBook Flip UX360",
455 DMI_MATCH(DMI_SYS_VENDOR, "ASUSTeK COMPUTER INC."),
457 DMI_MATCH(DMI_PRODUCT_NAME, "UX360"),
459 .driver_data = &quirk_asus_use_lid_flip_devid,
464 static void asus_nb_wmi_quirks(struct asus_wmi_driver *driver)
468 quirks = &quirk_asus_unknown;
469 dmi_check_system(asus_quirks);
471 driver->quirks = quirks;
472 driver->panel_power = FB_BLANK_UNBLANK;
474 /* overwrite the wapf setting if the wapf paramater is specified */
480 if (quirks->i8042_filter) {
481 ret = i8042_install_filter(quirks->i8042_filter);
483 pr_warn("Unable to install key filter\n");
486 pr_info("Using i8042 filter function for receiving events\n");
490 static const struct key_entry asus_nb_wmi_keymap[] = {
491 { KE_KEY, ASUS_WMI_BRN_DOWN, { KEY_BRIGHTNESSDOWN } },
492 { KE_KEY, ASUS_WMI_BRN_UP, { KEY_BRIGHTNESSUP } },
493 { KE_KEY, 0x30, { KEY_VOLUMEUP } },
494 { KE_KEY, 0x31, { KEY_VOLUMEDOWN } },
495 { KE_KEY, 0x32, { KEY_MUTE } },
496 { KE_KEY, 0x35, { KEY_SCREENLOCK } },
497 { KE_KEY, 0x40, { KEY_PREVIOUSSONG } },
498 { KE_KEY, 0x41, { KEY_NEXTSONG } },
499 { KE_KEY, 0x43, { KEY_STOPCD } }, /* Stop/Eject */
500 { KE_KEY, 0x45, { KEY_PLAYPAUSE } },
501 { KE_KEY, 0x4c, { KEY_MEDIA } }, /* WMP Key */
502 { KE_KEY, 0x50, { KEY_EMAIL } },
503 { KE_KEY, 0x51, { KEY_WWW } },
504 { KE_KEY, 0x55, { KEY_CALC } },
505 { KE_IGNORE, 0x57, }, /* Battery mode */
506 { KE_IGNORE, 0x58, }, /* AC mode */
507 { KE_KEY, 0x5C, { KEY_F15 } }, /* Power Gear key */
508 { KE_KEY, 0x5D, { KEY_WLAN } }, /* Wireless console Toggle */
509 { KE_KEY, 0x5E, { KEY_WLAN } }, /* Wireless console Enable */
510 { KE_KEY, 0x5F, { KEY_WLAN } }, /* Wireless console Disable */
511 { KE_KEY, 0x60, { KEY_TOUCHPAD_ON } },
512 { KE_KEY, 0x61, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD only */
513 { KE_KEY, 0x62, { KEY_SWITCHVIDEOMODE } }, /* SDSP CRT only */
514 { KE_KEY, 0x63, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD + CRT */
515 { KE_KEY, 0x64, { KEY_SWITCHVIDEOMODE } }, /* SDSP TV */
516 { KE_KEY, 0x65, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD + TV */
517 { KE_KEY, 0x66, { KEY_SWITCHVIDEOMODE } }, /* SDSP CRT + TV */
518 { KE_KEY, 0x67, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD + CRT + TV */
519 { KE_KEY, 0x6B, { KEY_TOUCHPAD_TOGGLE } },
520 { KE_IGNORE, 0x6E, }, /* Low Battery notification */
521 { KE_KEY, 0x71, { KEY_F13 } }, /* General-purpose button */
522 { KE_IGNORE, 0x79, }, /* Charger type dectection notification */
523 { KE_KEY, 0x7a, { KEY_ALS_TOGGLE } }, /* Ambient Light Sensor Toggle */
524 { KE_KEY, 0x7c, { KEY_MICMUTE } },
525 { KE_KEY, 0x7D, { KEY_BLUETOOTH } }, /* Bluetooth Enable */
526 { KE_KEY, 0x7E, { KEY_BLUETOOTH } }, /* Bluetooth Disable */
527 { KE_KEY, 0x82, { KEY_CAMERA } },
528 { KE_KEY, 0x88, { KEY_RFKILL } }, /* Radio Toggle Key */
529 { KE_KEY, 0x8A, { KEY_PROG1 } }, /* Color enhancement mode */
530 { KE_KEY, 0x8C, { KEY_SWITCHVIDEOMODE } }, /* SDSP DVI only */
531 { KE_KEY, 0x8D, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD + DVI */
532 { KE_KEY, 0x8E, { KEY_SWITCHVIDEOMODE } }, /* SDSP CRT + DVI */
533 { KE_KEY, 0x8F, { KEY_SWITCHVIDEOMODE } }, /* SDSP TV + DVI */
534 { KE_KEY, 0x90, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD + CRT + DVI */
535 { KE_KEY, 0x91, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD + TV + DVI */
536 { KE_KEY, 0x92, { KEY_SWITCHVIDEOMODE } }, /* SDSP CRT + TV + DVI */
537 { KE_KEY, 0x93, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD + CRT + TV + DVI */
538 { KE_KEY, 0x95, { KEY_MEDIA } },
539 { KE_KEY, 0x99, { KEY_PHONE } }, /* Conflicts with fan mode switch */
540 { KE_KEY, 0xA0, { KEY_SWITCHVIDEOMODE } }, /* SDSP HDMI only */
541 { KE_KEY, 0xA1, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD + HDMI */
542 { KE_KEY, 0xA2, { KEY_SWITCHVIDEOMODE } }, /* SDSP CRT + HDMI */
543 { KE_KEY, 0xA3, { KEY_SWITCHVIDEOMODE } }, /* SDSP TV + HDMI */
544 { KE_KEY, 0xA4, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD + CRT + HDMI */
545 { KE_KEY, 0xA5, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD + TV + HDMI */
546 { KE_KEY, 0xA6, { KEY_SWITCHVIDEOMODE } }, /* SDSP CRT + TV + HDMI */
547 { KE_KEY, 0xA7, { KEY_SWITCHVIDEOMODE } }, /* SDSP LCD + CRT + TV + HDMI */
548 { KE_KEY, 0xB5, { KEY_CALC } },
549 { KE_KEY, 0xC4, { KEY_KBDILLUMUP } },
550 { KE_KEY, 0xC5, { KEY_KBDILLUMDOWN } },
551 { KE_IGNORE, 0xC6, }, /* Ambient Light Sensor notification */
552 { KE_KEY, 0xFA, { KEY_PROG2 } }, /* Lid flip action */
556 static struct asus_wmi_driver asus_nb_wmi_driver = {
557 .name = ASUS_NB_WMI_FILE,
558 .owner = THIS_MODULE,
559 .event_guid = ASUS_NB_WMI_EVENT_GUID,
560 .keymap = asus_nb_wmi_keymap,
561 .input_name = "Asus WMI hotkeys",
562 .input_phys = ASUS_NB_WMI_FILE "/input0",
563 .detect_quirks = asus_nb_wmi_quirks,
567 static int __init asus_nb_wmi_init(void)
569 return asus_wmi_register_driver(&asus_nb_wmi_driver);
572 static void __exit asus_nb_wmi_exit(void)
574 asus_wmi_unregister_driver(&asus_nb_wmi_driver);
577 module_init(asus_nb_wmi_init);
578 module_exit(asus_nb_wmi_exit);