1 // SPDX-License-Identifier: GPL-2.0
3 * Huawei WMI laptop extras driver
5 * Copyright (C) 2018 Ayman Bagabas <ayman.bagabas@gmail.com>
8 #include <linux/acpi.h>
9 #include <linux/debugfs.h>
10 #include <linux/delay.h>
11 #include <linux/dmi.h>
12 #include <linux/input.h>
13 #include <linux/input/sparse-keymap.h>
14 #include <linux/leds.h>
15 #include <linux/module.h>
16 #include <linux/mutex.h>
17 #include <linux/platform_device.h>
18 #include <linux/power_supply.h>
19 #include <linux/sysfs.h>
20 #include <linux/wmi.h>
21 #include <acpi/battery.h>
26 #define HWMI_METHOD_GUID "ABBC0F5B-8EA1-11D1-A000-C90629100000"
27 #define HWMI_EVENT_GUID "ABBC0F5C-8EA1-11D1-A000-C90629100000"
30 #define WMI0_EXPENSIVE_GUID "39142400-C6A3-40fa-BADB-8A2652834100"
31 #define WMI0_EVENT_GUID "59142400-C6A3-40fa-BADB-8A2652834100"
36 BATTERY_THRESH_GET = 0x00001103, /* \GBTT */
37 BATTERY_THRESH_SET = 0x00001003, /* \SBTT */
38 FN_LOCK_GET = 0x00000604, /* \GFRS */
39 FN_LOCK_SET = 0x00000704, /* \SFRS */
40 MICMUTE_LED_SET = 0x00000b04, /* \SMLS */
51 bool report_brightness;
54 static struct quirk_entry *quirks;
56 struct huawei_wmi_debug {
62 bool battery_available;
63 bool fn_lock_available;
65 struct huawei_wmi_debug debug;
66 struct input_dev *idev[2];
67 struct led_classdev cdev;
70 struct mutex battery_lock;
71 struct mutex wmi_lock;
74 static struct huawei_wmi *huawei_wmi;
76 static const struct key_entry huawei_wmi_keymap[] = {
77 { KE_KEY, 0x281, { KEY_BRIGHTNESSDOWN } },
78 { KE_KEY, 0x282, { KEY_BRIGHTNESSUP } },
79 { KE_KEY, 0x284, { KEY_MUTE } },
80 { KE_KEY, 0x285, { KEY_VOLUMEDOWN } },
81 { KE_KEY, 0x286, { KEY_VOLUMEUP } },
82 { KE_KEY, 0x287, { KEY_MICMUTE } },
83 { KE_KEY, 0x289, { KEY_WLAN } },
85 { KE_KEY, 0x28a, { KEY_CONFIG } },
87 { KE_IGNORE, 0x293, { KEY_KBDILLUMTOGGLE } },
88 { KE_IGNORE, 0x294, { KEY_KBDILLUMUP } },
89 { KE_IGNORE, 0x295, { KEY_KBDILLUMUP } },
93 static int battery_reset = -1;
94 static int report_brightness = -1;
96 module_param(battery_reset, bint, 0444);
97 MODULE_PARM_DESC(battery_reset,
98 "Reset battery charge values to (0-0) before disabling it using (0-100)");
99 module_param(report_brightness, bint, 0444);
100 MODULE_PARM_DESC(report_brightness,
101 "Report brightness keys.");
105 static int __init dmi_matched(const struct dmi_system_id *dmi)
107 quirks = dmi->driver_data;
111 static struct quirk_entry quirk_unknown = {
114 static struct quirk_entry quirk_battery_reset = {
115 .battery_reset = true,
118 static struct quirk_entry quirk_matebook_x = {
120 .report_brightness = true,
123 static const struct dmi_system_id huawei_quirks[] = {
125 .callback = dmi_matched,
126 .ident = "Huawei MACH-WX9",
128 DMI_MATCH(DMI_SYS_VENDOR, "HUAWEI"),
129 DMI_MATCH(DMI_PRODUCT_NAME, "MACH-WX9"),
131 .driver_data = &quirk_battery_reset
134 .callback = dmi_matched,
135 .ident = "Huawei MateBook X",
137 DMI_MATCH(DMI_SYS_VENDOR, "HUAWEI"),
138 DMI_MATCH(DMI_PRODUCT_NAME, "HUAWEI MateBook X")
140 .driver_data = &quirk_matebook_x
147 static int huawei_wmi_call(struct huawei_wmi *huawei,
148 struct acpi_buffer *in, struct acpi_buffer *out)
152 mutex_lock(&huawei->wmi_lock);
153 status = wmi_evaluate_method(HWMI_METHOD_GUID, 0, 1, in, out);
154 mutex_unlock(&huawei->wmi_lock);
155 if (ACPI_FAILURE(status)) {
156 dev_err(huawei->dev, "Failed to evaluate wmi method\n");
163 /* HWMI takes a 64 bit input and returns either a package with 2 buffers, one of
164 * 4 bytes and the other of 256 bytes, or one buffer of size 0x104 (260) bytes.
165 * The first 4 bytes are ignored, we ignore the first 4 bytes buffer if we got a
166 * package, or skip the first 4 if a buffer of 0x104 is used. The first byte of
167 * the remaining 0x100 sized buffer has the return status of every call. In case
168 * the return status is non-zero, we return -ENODEV but still copy the returned
169 * buffer to the given buffer parameter (buf).
171 static int huawei_wmi_cmd(u64 arg, u8 *buf, size_t buflen)
173 struct huawei_wmi *huawei = huawei_wmi;
174 struct acpi_buffer out = { ACPI_ALLOCATE_BUFFER, NULL };
175 struct acpi_buffer in;
176 union acpi_object *obj;
180 in.length = sizeof(arg);
183 /* Some models require calling HWMI twice to execute a command. We evaluate
184 * HWMI and if we get a non-zero return status we evaluate it again.
186 for (i = 0; i < 2; i++) {
187 err = huawei_wmi_call(huawei, &in, &out);
198 /* Models that implement both "legacy" and HWMI tend to return a 0x104
199 * sized buffer instead of a package of 0x4 and 0x100 buffers.
201 case ACPI_TYPE_BUFFER:
202 if (obj->buffer.length == 0x104) {
203 // Skip the first 4 bytes.
204 obj->buffer.pointer += 4;
207 dev_err(huawei->dev, "Bad buffer length, got %d\n", obj->buffer.length);
213 /* HWMI returns a package with 2 buffer elements, one of 4 bytes and the
214 * other is 256 bytes.
216 case ACPI_TYPE_PACKAGE:
217 if (obj->package.count != 2) {
218 dev_err(huawei->dev, "Bad package count, got %d\n", obj->package.count);
223 obj = &obj->package.elements[1];
224 if (obj->type != ACPI_TYPE_BUFFER) {
225 dev_err(huawei->dev, "Bad package element type, got %d\n", obj->type);
229 len = obj->buffer.length;
232 /* Shouldn't get here! */
234 dev_err(huawei->dev, "Unexpected obj type, got: %d\n", obj->type);
239 if (!*obj->buffer.pointer)
243 err = (*obj->buffer.pointer) ? -ENODEV : 0;
246 len = min(buflen, len);
247 memcpy(buf, obj->buffer.pointer, len);
257 static int huawei_wmi_micmute_led_set(struct led_classdev *led_cdev,
258 enum led_brightness brightness)
260 /* This is a workaround until the "legacy" interface is implemented. */
261 if (quirks && quirks->ec_micmute) {
265 union acpi_object args[3];
266 struct acpi_object_list arg_list = {
268 .count = ARRAY_SIZE(args),
271 handle = ec_get_handle();
275 args[0].type = args[1].type = args[2].type = ACPI_TYPE_INTEGER;
276 args[1].integer.value = 0x04;
278 if (acpi_has_method(handle, "SPIN")) {
279 acpi_method = "SPIN";
280 args[0].integer.value = 0;
281 args[2].integer.value = brightness ? 1 : 0;
282 } else if (acpi_has_method(handle, "WPIN")) {
283 acpi_method = "WPIN";
284 args[0].integer.value = 1;
285 args[2].integer.value = brightness ? 0 : 1;
290 status = acpi_evaluate_object(handle, acpi_method, &arg_list, NULL);
291 if (ACPI_FAILURE(status))
298 arg.cmd = MICMUTE_LED_SET;
299 arg.args[2] = brightness;
301 return huawei_wmi_cmd(arg.cmd, NULL, 0);
305 static void huawei_wmi_leds_setup(struct device *dev)
307 struct huawei_wmi *huawei = dev_get_drvdata(dev);
309 huawei->cdev.name = "platform::micmute";
310 huawei->cdev.max_brightness = 1;
311 huawei->cdev.brightness_set_blocking = &huawei_wmi_micmute_led_set;
312 huawei->cdev.default_trigger = "audio-micmute";
313 huawei->cdev.brightness = ledtrig_audio_get(LED_AUDIO_MICMUTE);
314 huawei->cdev.dev = dev;
315 huawei->cdev.flags = LED_CORE_SUSPENDRESUME;
317 devm_led_classdev_register(dev, &huawei->cdev);
320 /* Battery protection */
322 static int huawei_wmi_battery_get(int *start, int *end)
327 err = huawei_wmi_cmd(BATTERY_THRESH_GET, ret, 0x100);
331 /* Find the last two non-zero values. Return status is ignored. */
338 } while (i > 2 && !ret[i--]);
343 static int huawei_wmi_battery_set(int start, int end)
348 if (start < 0 || end < 0 || start > 100 || end > 100)
351 arg.cmd = BATTERY_THRESH_SET;
355 /* This is an edge case were some models turn battery protection
356 * off without changing their thresholds values. We clear the
357 * values before turning off protection. Sometimes we need a sleep delay to
358 * make sure these values make their way to EC memory.
360 if (quirks && quirks->battery_reset && start == 0 && end == 100) {
361 err = huawei_wmi_battery_set(0, 0);
368 err = huawei_wmi_cmd(arg.cmd, NULL, 0);
373 static ssize_t charge_control_start_threshold_show(struct device *dev,
374 struct device_attribute *attr,
379 err = huawei_wmi_battery_get(&start, NULL);
383 return sprintf(buf, "%d\n", start);
386 static ssize_t charge_control_end_threshold_show(struct device *dev,
387 struct device_attribute *attr,
392 err = huawei_wmi_battery_get(NULL, &end);
396 return sprintf(buf, "%d\n", end);
399 static ssize_t charge_control_thresholds_show(struct device *dev,
400 struct device_attribute *attr,
405 err = huawei_wmi_battery_get(&start, &end);
409 return sprintf(buf, "%d %d\n", start, end);
412 static ssize_t charge_control_start_threshold_store(struct device *dev,
413 struct device_attribute *attr,
414 const char *buf, size_t size)
418 err = huawei_wmi_battery_get(NULL, &end);
422 if (sscanf(buf, "%d", &start) != 1)
425 err = huawei_wmi_battery_set(start, end);
432 static ssize_t charge_control_end_threshold_store(struct device *dev,
433 struct device_attribute *attr,
434 const char *buf, size_t size)
438 err = huawei_wmi_battery_get(&start, NULL);
442 if (sscanf(buf, "%d", &end) != 1)
445 err = huawei_wmi_battery_set(start, end);
452 static ssize_t charge_control_thresholds_store(struct device *dev,
453 struct device_attribute *attr,
454 const char *buf, size_t size)
458 if (sscanf(buf, "%d %d", &start, &end) != 2)
461 err = huawei_wmi_battery_set(start, end);
468 static DEVICE_ATTR_RW(charge_control_start_threshold);
469 static DEVICE_ATTR_RW(charge_control_end_threshold);
470 static DEVICE_ATTR_RW(charge_control_thresholds);
472 static int huawei_wmi_battery_add(struct power_supply *battery)
474 device_create_file(&battery->dev, &dev_attr_charge_control_start_threshold);
475 device_create_file(&battery->dev, &dev_attr_charge_control_end_threshold);
480 static int huawei_wmi_battery_remove(struct power_supply *battery)
482 device_remove_file(&battery->dev, &dev_attr_charge_control_start_threshold);
483 device_remove_file(&battery->dev, &dev_attr_charge_control_end_threshold);
488 static struct acpi_battery_hook huawei_wmi_battery_hook = {
489 .add_battery = huawei_wmi_battery_add,
490 .remove_battery = huawei_wmi_battery_remove,
491 .name = "Huawei Battery Extension"
494 static void huawei_wmi_battery_setup(struct device *dev)
496 struct huawei_wmi *huawei = dev_get_drvdata(dev);
498 huawei->battery_available = true;
499 if (huawei_wmi_battery_get(NULL, NULL)) {
500 huawei->battery_available = false;
504 battery_hook_register(&huawei_wmi_battery_hook);
505 device_create_file(dev, &dev_attr_charge_control_thresholds);
508 static void huawei_wmi_battery_exit(struct device *dev)
510 struct huawei_wmi *huawei = dev_get_drvdata(dev);
512 if (huawei->battery_available) {
513 battery_hook_unregister(&huawei_wmi_battery_hook);
514 device_remove_file(dev, &dev_attr_charge_control_thresholds);
520 static int huawei_wmi_fn_lock_get(int *on)
522 u8 ret[0x100] = { 0 };
525 err = huawei_wmi_cmd(FN_LOCK_GET, ret, 0x100);
529 /* Find the first non-zero value. Return status is ignored. */
533 *on = ret[i] - 1; // -1 undefined, 0 off, 1 on.
534 } while (i < 0xff && !ret[i++]);
539 static int huawei_wmi_fn_lock_set(int on)
543 arg.cmd = FN_LOCK_SET;
544 arg.args[2] = on + 1; // 0 undefined, 1 off, 2 on.
546 return huawei_wmi_cmd(arg.cmd, NULL, 0);
549 static ssize_t fn_lock_state_show(struct device *dev,
550 struct device_attribute *attr,
555 err = huawei_wmi_fn_lock_get(&on);
559 return sprintf(buf, "%d\n", on);
562 static ssize_t fn_lock_state_store(struct device *dev,
563 struct device_attribute *attr,
564 const char *buf, size_t size)
568 if (kstrtoint(buf, 10, &on) ||
572 err = huawei_wmi_fn_lock_set(on);
579 static DEVICE_ATTR_RW(fn_lock_state);
581 static void huawei_wmi_fn_lock_setup(struct device *dev)
583 struct huawei_wmi *huawei = dev_get_drvdata(dev);
585 huawei->fn_lock_available = true;
586 if (huawei_wmi_fn_lock_get(NULL)) {
587 huawei->fn_lock_available = false;
591 device_create_file(dev, &dev_attr_fn_lock_state);
594 static void huawei_wmi_fn_lock_exit(struct device *dev)
596 struct huawei_wmi *huawei = dev_get_drvdata(dev);
598 if (huawei->fn_lock_available)
599 device_remove_file(dev, &dev_attr_fn_lock_state);
604 static void huawei_wmi_debugfs_call_dump(struct seq_file *m, void *data,
605 union acpi_object *obj)
607 struct huawei_wmi *huawei = m->private;
611 case ACPI_TYPE_INTEGER:
612 seq_printf(m, "0x%llx", obj->integer.value);
614 case ACPI_TYPE_STRING:
615 seq_printf(m, "\"%.*s\"", obj->string.length, obj->string.pointer);
617 case ACPI_TYPE_BUFFER:
619 for (i = 0; i < obj->buffer.length; i++) {
620 seq_printf(m, "0x%02x", obj->buffer.pointer[i]);
621 if (i < obj->buffer.length - 1)
626 case ACPI_TYPE_PACKAGE:
628 for (i = 0; i < obj->package.count; i++) {
629 huawei_wmi_debugfs_call_dump(m, huawei, &obj->package.elements[i]);
630 if (i < obj->package.count - 1)
636 dev_err(huawei->dev, "Unexpected obj type, got %d\n", obj->type);
641 static int huawei_wmi_debugfs_call_show(struct seq_file *m, void *data)
643 struct huawei_wmi *huawei = m->private;
644 struct acpi_buffer out = { ACPI_ALLOCATE_BUFFER, NULL };
645 struct acpi_buffer in;
646 union acpi_object *obj;
649 in.length = sizeof(u64);
650 in.pointer = &huawei->debug.arg;
652 err = huawei_wmi_call(huawei, &in, &out);
659 goto fail_debugfs_call;
662 huawei_wmi_debugfs_call_dump(m, huawei, obj);
669 DEFINE_SHOW_ATTRIBUTE(huawei_wmi_debugfs_call);
671 static void huawei_wmi_debugfs_setup(struct device *dev)
673 struct huawei_wmi *huawei = dev_get_drvdata(dev);
675 huawei->debug.root = debugfs_create_dir("huawei-wmi", NULL);
677 debugfs_create_x64("arg", 0644, huawei->debug.root,
679 debugfs_create_file("call", 0400,
680 huawei->debug.root, huawei, &huawei_wmi_debugfs_call_fops);
683 static void huawei_wmi_debugfs_exit(struct device *dev)
685 struct huawei_wmi *huawei = dev_get_drvdata(dev);
687 debugfs_remove_recursive(huawei->debug.root);
692 static void huawei_wmi_process_key(struct input_dev *idev, int code)
694 const struct key_entry *key;
697 * WMI0 uses code 0x80 to indicate a hotkey event.
698 * The actual key is fetched from the method WQ00
699 * using WMI0_EXPENSIVE_GUID.
702 struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
703 union acpi_object *obj;
706 status = wmi_query_block(WMI0_EXPENSIVE_GUID, 0, &response);
707 if (ACPI_FAILURE(status))
710 obj = (union acpi_object *)response.pointer;
711 if (obj && obj->type == ACPI_TYPE_INTEGER)
712 code = obj->integer.value;
714 kfree(response.pointer);
717 key = sparse_keymap_entry_from_scancode(idev, code);
719 dev_info(&idev->dev, "Unknown key pressed, code: 0x%04x\n", code);
723 if (quirks && !quirks->report_brightness &&
724 (key->sw.code == KEY_BRIGHTNESSDOWN ||
725 key->sw.code == KEY_BRIGHTNESSUP))
728 sparse_keymap_report_entry(idev, key, 1, true);
731 static void huawei_wmi_input_notify(u32 value, void *context)
733 struct input_dev *idev = (struct input_dev *)context;
734 struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
735 union acpi_object *obj;
738 status = wmi_get_event_data(value, &response);
739 if (ACPI_FAILURE(status)) {
740 dev_err(&idev->dev, "Unable to get event data\n");
744 obj = (union acpi_object *)response.pointer;
745 if (obj && obj->type == ACPI_TYPE_INTEGER)
746 huawei_wmi_process_key(idev, obj->integer.value);
748 dev_err(&idev->dev, "Bad response type\n");
750 kfree(response.pointer);
753 static int huawei_wmi_input_setup(struct device *dev,
755 struct input_dev **idev)
757 *idev = devm_input_allocate_device(dev);
761 (*idev)->name = "Huawei WMI hotkeys";
762 (*idev)->phys = "wmi/input0";
763 (*idev)->id.bustype = BUS_HOST;
764 (*idev)->dev.parent = dev;
766 return sparse_keymap_setup(*idev, huawei_wmi_keymap, NULL) ||
767 input_register_device(*idev) ||
768 wmi_install_notify_handler(guid, huawei_wmi_input_notify,
772 static void huawei_wmi_input_exit(struct device *dev, const char *guid)
774 wmi_remove_notify_handler(guid);
779 static const struct wmi_device_id huawei_wmi_events_id_table[] = {
780 { .guid_string = WMI0_EVENT_GUID },
781 { .guid_string = HWMI_EVENT_GUID },
785 static int huawei_wmi_probe(struct platform_device *pdev)
787 const struct wmi_device_id *guid = huawei_wmi_events_id_table;
790 platform_set_drvdata(pdev, huawei_wmi);
791 huawei_wmi->dev = &pdev->dev;
793 while (*guid->guid_string) {
794 struct input_dev *idev = *huawei_wmi->idev;
796 if (wmi_has_guid(guid->guid_string)) {
797 err = huawei_wmi_input_setup(&pdev->dev, guid->guid_string, &idev);
799 dev_err(&pdev->dev, "Failed to setup input on %s\n", guid->guid_string);
808 if (wmi_has_guid(HWMI_METHOD_GUID)) {
809 mutex_init(&huawei_wmi->wmi_lock);
810 mutex_init(&huawei_wmi->battery_lock);
812 huawei_wmi_leds_setup(&pdev->dev);
813 huawei_wmi_fn_lock_setup(&pdev->dev);
814 huawei_wmi_battery_setup(&pdev->dev);
815 huawei_wmi_debugfs_setup(&pdev->dev);
821 static int huawei_wmi_remove(struct platform_device *pdev)
823 const struct wmi_device_id *guid = huawei_wmi_events_id_table;
825 while (*guid->guid_string) {
826 if (wmi_has_guid(guid->guid_string))
827 huawei_wmi_input_exit(&pdev->dev, guid->guid_string);
832 if (wmi_has_guid(HWMI_METHOD_GUID)) {
833 huawei_wmi_debugfs_exit(&pdev->dev);
834 huawei_wmi_battery_exit(&pdev->dev);
835 huawei_wmi_fn_lock_exit(&pdev->dev);
841 static struct platform_driver huawei_wmi_driver = {
843 .name = "huawei-wmi",
845 .probe = huawei_wmi_probe,
846 .remove = huawei_wmi_remove,
849 static __init int huawei_wmi_init(void)
851 struct platform_device *pdev;
854 huawei_wmi = kzalloc(sizeof(struct huawei_wmi), GFP_KERNEL);
858 quirks = &quirk_unknown;
859 dmi_check_system(huawei_quirks);
860 if (battery_reset != -1)
861 quirks->battery_reset = battery_reset;
862 if (report_brightness != -1)
863 quirks->report_brightness = report_brightness;
865 err = platform_driver_register(&huawei_wmi_driver);
869 pdev = platform_device_register_simple("huawei-wmi", -1, NULL, 0);
878 platform_driver_unregister(&huawei_wmi_driver);
884 static __exit void huawei_wmi_exit(void)
886 struct platform_device *pdev = to_platform_device(huawei_wmi->dev);
888 platform_device_unregister(pdev);
889 platform_driver_unregister(&huawei_wmi_driver);
894 module_init(huawei_wmi_init);
895 module_exit(huawei_wmi_exit);
897 MODULE_ALIAS("wmi:"HWMI_METHOD_GUID);
898 MODULE_DEVICE_TABLE(wmi, huawei_wmi_events_id_table);
899 MODULE_AUTHOR("Ayman Bagabas <ayman.bagabas@gmail.com>");
900 MODULE_DESCRIPTION("Huawei WMI laptop extras driver");
901 MODULE_LICENSE("GPL v2");