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 wmi_lock;
73 static struct huawei_wmi *huawei_wmi;
75 static const struct key_entry huawei_wmi_keymap[] = {
76 { KE_KEY, 0x281, { KEY_BRIGHTNESSDOWN } },
77 { KE_KEY, 0x282, { KEY_BRIGHTNESSUP } },
78 { KE_KEY, 0x284, { KEY_MUTE } },
79 { KE_KEY, 0x285, { KEY_VOLUMEDOWN } },
80 { KE_KEY, 0x286, { KEY_VOLUMEUP } },
81 { KE_KEY, 0x287, { KEY_MICMUTE } },
82 { KE_KEY, 0x289, { KEY_WLAN } },
84 { KE_KEY, 0x28a, { KEY_CONFIG } },
86 { KE_IGNORE, 0x293, { KEY_KBDILLUMTOGGLE } },
87 { KE_IGNORE, 0x294, { KEY_KBDILLUMUP } },
88 { KE_IGNORE, 0x295, { KEY_KBDILLUMUP } },
89 // Ignore Ambient Light Sensoring
90 { KE_KEY, 0x2c1, { KEY_RESERVED } },
94 static int battery_reset = -1;
95 static int report_brightness = -1;
97 module_param(battery_reset, bint, 0444);
98 MODULE_PARM_DESC(battery_reset,
99 "Reset battery charge values to (0-0) before disabling it using (0-100)");
100 module_param(report_brightness, bint, 0444);
101 MODULE_PARM_DESC(report_brightness,
102 "Report brightness keys.");
106 static int __init dmi_matched(const struct dmi_system_id *dmi)
108 quirks = dmi->driver_data;
112 static struct quirk_entry quirk_unknown = {
115 static struct quirk_entry quirk_battery_reset = {
116 .battery_reset = true,
119 static struct quirk_entry quirk_matebook_x = {
121 .report_brightness = true,
124 static const struct dmi_system_id huawei_quirks[] = {
126 .callback = dmi_matched,
127 .ident = "Huawei MACH-WX9",
129 DMI_MATCH(DMI_SYS_VENDOR, "HUAWEI"),
130 DMI_MATCH(DMI_PRODUCT_NAME, "MACH-WX9"),
132 .driver_data = &quirk_battery_reset
135 .callback = dmi_matched,
136 .ident = "Huawei MateBook X",
138 DMI_MATCH(DMI_SYS_VENDOR, "HUAWEI"),
139 DMI_MATCH(DMI_PRODUCT_NAME, "HUAWEI MateBook X")
141 .driver_data = &quirk_matebook_x
148 static int huawei_wmi_call(struct huawei_wmi *huawei,
149 struct acpi_buffer *in, struct acpi_buffer *out)
153 mutex_lock(&huawei->wmi_lock);
154 status = wmi_evaluate_method(HWMI_METHOD_GUID, 0, 1, in, out);
155 mutex_unlock(&huawei->wmi_lock);
156 if (ACPI_FAILURE(status)) {
157 dev_err(huawei->dev, "Failed to evaluate wmi method\n");
164 /* HWMI takes a 64 bit input and returns either a package with 2 buffers, one of
165 * 4 bytes and the other of 256 bytes, or one buffer of size 0x104 (260) bytes.
166 * The first 4 bytes are ignored, we ignore the first 4 bytes buffer if we got a
167 * package, or skip the first 4 if a buffer of 0x104 is used. The first byte of
168 * the remaining 0x100 sized buffer has the return status of every call. In case
169 * the return status is non-zero, we return -ENODEV but still copy the returned
170 * buffer to the given buffer parameter (buf).
172 static int huawei_wmi_cmd(u64 arg, u8 *buf, size_t buflen)
174 struct huawei_wmi *huawei = huawei_wmi;
175 struct acpi_buffer out = { ACPI_ALLOCATE_BUFFER, NULL };
176 struct acpi_buffer in;
177 union acpi_object *obj;
181 in.length = sizeof(arg);
184 /* Some models require calling HWMI twice to execute a command. We evaluate
185 * HWMI and if we get a non-zero return status we evaluate it again.
187 for (i = 0; i < 2; i++) {
188 err = huawei_wmi_call(huawei, &in, &out);
199 /* Models that implement both "legacy" and HWMI tend to return a 0x104
200 * sized buffer instead of a package of 0x4 and 0x100 buffers.
202 case ACPI_TYPE_BUFFER:
203 if (obj->buffer.length == 0x104) {
204 // Skip the first 4 bytes.
205 obj->buffer.pointer += 4;
208 dev_err(huawei->dev, "Bad buffer length, got %d\n", obj->buffer.length);
214 /* HWMI returns a package with 2 buffer elements, one of 4 bytes and the
215 * other is 256 bytes.
217 case ACPI_TYPE_PACKAGE:
218 if (obj->package.count != 2) {
219 dev_err(huawei->dev, "Bad package count, got %d\n", obj->package.count);
224 obj = &obj->package.elements[1];
225 if (obj->type != ACPI_TYPE_BUFFER) {
226 dev_err(huawei->dev, "Bad package element type, got %d\n", obj->type);
230 len = obj->buffer.length;
233 /* Shouldn't get here! */
235 dev_err(huawei->dev, "Unexpected obj type, got: %d\n", obj->type);
240 if (!*obj->buffer.pointer)
244 err = (*obj->buffer.pointer) ? -ENODEV : 0;
247 len = min(buflen, len);
248 memcpy(buf, obj->buffer.pointer, len);
258 static int huawei_wmi_micmute_led_set(struct led_classdev *led_cdev,
259 enum led_brightness brightness)
261 /* This is a workaround until the "legacy" interface is implemented. */
262 if (quirks && quirks->ec_micmute) {
266 union acpi_object args[3];
267 struct acpi_object_list arg_list = {
269 .count = ARRAY_SIZE(args),
272 handle = ec_get_handle();
276 args[0].type = args[1].type = args[2].type = ACPI_TYPE_INTEGER;
277 args[1].integer.value = 0x04;
279 if (acpi_has_method(handle, "SPIN")) {
280 acpi_method = "SPIN";
281 args[0].integer.value = 0;
282 args[2].integer.value = brightness ? 1 : 0;
283 } else if (acpi_has_method(handle, "WPIN")) {
284 acpi_method = "WPIN";
285 args[0].integer.value = 1;
286 args[2].integer.value = brightness ? 0 : 1;
291 status = acpi_evaluate_object(handle, acpi_method, &arg_list, NULL);
292 if (ACPI_FAILURE(status))
299 arg.cmd = MICMUTE_LED_SET;
300 arg.args[2] = brightness;
302 return huawei_wmi_cmd(arg.cmd, NULL, 0);
306 static void huawei_wmi_leds_setup(struct device *dev)
308 struct huawei_wmi *huawei = dev_get_drvdata(dev);
310 huawei->cdev.name = "platform::micmute";
311 huawei->cdev.max_brightness = 1;
312 huawei->cdev.brightness_set_blocking = &huawei_wmi_micmute_led_set;
313 huawei->cdev.default_trigger = "audio-micmute";
314 huawei->cdev.brightness = ledtrig_audio_get(LED_AUDIO_MICMUTE);
315 huawei->cdev.dev = dev;
316 huawei->cdev.flags = LED_CORE_SUSPENDRESUME;
318 devm_led_classdev_register(dev, &huawei->cdev);
321 /* Battery protection */
323 static int huawei_wmi_battery_get(int *start, int *end)
328 err = huawei_wmi_cmd(BATTERY_THRESH_GET, ret, 0x100);
332 /* Find the last two non-zero values. Return status is ignored. */
339 } while (i > 2 && !ret[i--]);
344 static int huawei_wmi_battery_set(int start, int end)
349 if (start < 0 || end < 0 || start > 100 || end > 100)
352 arg.cmd = BATTERY_THRESH_SET;
356 /* This is an edge case were some models turn battery protection
357 * off without changing their thresholds values. We clear the
358 * values before turning off protection. Sometimes we need a sleep delay to
359 * make sure these values make their way to EC memory.
361 if (quirks && quirks->battery_reset && start == 0 && end == 100) {
362 err = huawei_wmi_battery_set(0, 0);
369 err = huawei_wmi_cmd(arg.cmd, NULL, 0);
374 static ssize_t charge_control_start_threshold_show(struct device *dev,
375 struct device_attribute *attr,
380 err = huawei_wmi_battery_get(&start, NULL);
384 return sprintf(buf, "%d\n", start);
387 static ssize_t charge_control_end_threshold_show(struct device *dev,
388 struct device_attribute *attr,
393 err = huawei_wmi_battery_get(NULL, &end);
397 return sprintf(buf, "%d\n", end);
400 static ssize_t charge_control_thresholds_show(struct device *dev,
401 struct device_attribute *attr,
406 err = huawei_wmi_battery_get(&start, &end);
410 return sprintf(buf, "%d %d\n", start, end);
413 static ssize_t charge_control_start_threshold_store(struct device *dev,
414 struct device_attribute *attr,
415 const char *buf, size_t size)
419 err = huawei_wmi_battery_get(NULL, &end);
423 if (sscanf(buf, "%d", &start) != 1)
426 err = huawei_wmi_battery_set(start, end);
433 static ssize_t charge_control_end_threshold_store(struct device *dev,
434 struct device_attribute *attr,
435 const char *buf, size_t size)
439 err = huawei_wmi_battery_get(&start, NULL);
443 if (sscanf(buf, "%d", &end) != 1)
446 err = huawei_wmi_battery_set(start, end);
453 static ssize_t charge_control_thresholds_store(struct device *dev,
454 struct device_attribute *attr,
455 const char *buf, size_t size)
459 if (sscanf(buf, "%d %d", &start, &end) != 2)
462 err = huawei_wmi_battery_set(start, end);
469 static DEVICE_ATTR_RW(charge_control_start_threshold);
470 static DEVICE_ATTR_RW(charge_control_end_threshold);
471 static DEVICE_ATTR_RW(charge_control_thresholds);
473 static int huawei_wmi_battery_add(struct power_supply *battery)
477 err = device_create_file(&battery->dev, &dev_attr_charge_control_start_threshold);
481 err = device_create_file(&battery->dev, &dev_attr_charge_control_end_threshold);
483 device_remove_file(&battery->dev, &dev_attr_charge_control_start_threshold);
488 static int huawei_wmi_battery_remove(struct power_supply *battery)
490 device_remove_file(&battery->dev, &dev_attr_charge_control_start_threshold);
491 device_remove_file(&battery->dev, &dev_attr_charge_control_end_threshold);
496 static struct acpi_battery_hook huawei_wmi_battery_hook = {
497 .add_battery = huawei_wmi_battery_add,
498 .remove_battery = huawei_wmi_battery_remove,
499 .name = "Huawei Battery Extension"
502 static void huawei_wmi_battery_setup(struct device *dev)
504 struct huawei_wmi *huawei = dev_get_drvdata(dev);
506 huawei->battery_available = true;
507 if (huawei_wmi_battery_get(NULL, NULL)) {
508 huawei->battery_available = false;
512 battery_hook_register(&huawei_wmi_battery_hook);
513 device_create_file(dev, &dev_attr_charge_control_thresholds);
516 static void huawei_wmi_battery_exit(struct device *dev)
518 struct huawei_wmi *huawei = dev_get_drvdata(dev);
520 if (huawei->battery_available) {
521 battery_hook_unregister(&huawei_wmi_battery_hook);
522 device_remove_file(dev, &dev_attr_charge_control_thresholds);
528 static int huawei_wmi_fn_lock_get(int *on)
530 u8 ret[0x100] = { 0 };
533 err = huawei_wmi_cmd(FN_LOCK_GET, ret, 0x100);
537 /* Find the first non-zero value. Return status is ignored. */
541 *on = ret[i] - 1; // -1 undefined, 0 off, 1 on.
542 } while (i < 0xff && !ret[i++]);
547 static int huawei_wmi_fn_lock_set(int on)
551 arg.cmd = FN_LOCK_SET;
552 arg.args[2] = on + 1; // 0 undefined, 1 off, 2 on.
554 return huawei_wmi_cmd(arg.cmd, NULL, 0);
557 static ssize_t fn_lock_state_show(struct device *dev,
558 struct device_attribute *attr,
563 err = huawei_wmi_fn_lock_get(&on);
567 return sprintf(buf, "%d\n", on);
570 static ssize_t fn_lock_state_store(struct device *dev,
571 struct device_attribute *attr,
572 const char *buf, size_t size)
576 if (kstrtoint(buf, 10, &on) ||
580 err = huawei_wmi_fn_lock_set(on);
587 static DEVICE_ATTR_RW(fn_lock_state);
589 static void huawei_wmi_fn_lock_setup(struct device *dev)
591 struct huawei_wmi *huawei = dev_get_drvdata(dev);
593 huawei->fn_lock_available = true;
594 if (huawei_wmi_fn_lock_get(NULL)) {
595 huawei->fn_lock_available = false;
599 device_create_file(dev, &dev_attr_fn_lock_state);
602 static void huawei_wmi_fn_lock_exit(struct device *dev)
604 struct huawei_wmi *huawei = dev_get_drvdata(dev);
606 if (huawei->fn_lock_available)
607 device_remove_file(dev, &dev_attr_fn_lock_state);
612 static void huawei_wmi_debugfs_call_dump(struct seq_file *m, void *data,
613 union acpi_object *obj)
615 struct huawei_wmi *huawei = m->private;
619 case ACPI_TYPE_INTEGER:
620 seq_printf(m, "0x%llx", obj->integer.value);
622 case ACPI_TYPE_STRING:
623 seq_printf(m, "\"%.*s\"", obj->string.length, obj->string.pointer);
625 case ACPI_TYPE_BUFFER:
627 for (i = 0; i < obj->buffer.length; i++) {
628 seq_printf(m, "0x%02x", obj->buffer.pointer[i]);
629 if (i < obj->buffer.length - 1)
634 case ACPI_TYPE_PACKAGE:
636 for (i = 0; i < obj->package.count; i++) {
637 huawei_wmi_debugfs_call_dump(m, huawei, &obj->package.elements[i]);
638 if (i < obj->package.count - 1)
644 dev_err(huawei->dev, "Unexpected obj type, got %d\n", obj->type);
649 static int huawei_wmi_debugfs_call_show(struct seq_file *m, void *data)
651 struct huawei_wmi *huawei = m->private;
652 struct acpi_buffer out = { ACPI_ALLOCATE_BUFFER, NULL };
653 struct acpi_buffer in;
654 union acpi_object *obj;
657 in.length = sizeof(u64);
658 in.pointer = &huawei->debug.arg;
660 err = huawei_wmi_call(huawei, &in, &out);
667 goto fail_debugfs_call;
670 huawei_wmi_debugfs_call_dump(m, huawei, obj);
677 DEFINE_SHOW_ATTRIBUTE(huawei_wmi_debugfs_call);
679 static void huawei_wmi_debugfs_setup(struct device *dev)
681 struct huawei_wmi *huawei = dev_get_drvdata(dev);
683 huawei->debug.root = debugfs_create_dir("huawei-wmi", NULL);
685 debugfs_create_x64("arg", 0644, huawei->debug.root,
687 debugfs_create_file("call", 0400,
688 huawei->debug.root, huawei, &huawei_wmi_debugfs_call_fops);
691 static void huawei_wmi_debugfs_exit(struct device *dev)
693 struct huawei_wmi *huawei = dev_get_drvdata(dev);
695 debugfs_remove_recursive(huawei->debug.root);
700 static void huawei_wmi_process_key(struct input_dev *idev, int code)
702 const struct key_entry *key;
705 * WMI0 uses code 0x80 to indicate a hotkey event.
706 * The actual key is fetched from the method WQ00
707 * using WMI0_EXPENSIVE_GUID.
710 struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
711 union acpi_object *obj;
714 status = wmi_query_block(WMI0_EXPENSIVE_GUID, 0, &response);
715 if (ACPI_FAILURE(status))
718 obj = (union acpi_object *)response.pointer;
719 if (obj && obj->type == ACPI_TYPE_INTEGER)
720 code = obj->integer.value;
722 kfree(response.pointer);
725 key = sparse_keymap_entry_from_scancode(idev, code);
727 dev_info(&idev->dev, "Unknown key pressed, code: 0x%04x\n", code);
731 if (quirks && !quirks->report_brightness &&
732 (key->sw.code == KEY_BRIGHTNESSDOWN ||
733 key->sw.code == KEY_BRIGHTNESSUP))
736 sparse_keymap_report_entry(idev, key, 1, true);
739 static void huawei_wmi_input_notify(u32 value, void *context)
741 struct input_dev *idev = (struct input_dev *)context;
742 struct acpi_buffer response = { ACPI_ALLOCATE_BUFFER, NULL };
743 union acpi_object *obj;
746 status = wmi_get_event_data(value, &response);
747 if (ACPI_FAILURE(status)) {
748 dev_err(&idev->dev, "Unable to get event data\n");
752 obj = (union acpi_object *)response.pointer;
753 if (obj && obj->type == ACPI_TYPE_INTEGER)
754 huawei_wmi_process_key(idev, obj->integer.value);
756 dev_err(&idev->dev, "Bad response type\n");
758 kfree(response.pointer);
761 static int huawei_wmi_input_setup(struct device *dev,
763 struct input_dev **idev)
768 *idev = devm_input_allocate_device(dev);
772 (*idev)->name = "Huawei WMI hotkeys";
773 (*idev)->phys = "wmi/input0";
774 (*idev)->id.bustype = BUS_HOST;
775 (*idev)->dev.parent = dev;
777 err = sparse_keymap_setup(*idev, huawei_wmi_keymap, NULL);
781 err = input_register_device(*idev);
785 status = wmi_install_notify_handler(guid, huawei_wmi_input_notify, *idev);
786 if (ACPI_FAILURE(status))
792 static void huawei_wmi_input_exit(struct device *dev, const char *guid)
794 wmi_remove_notify_handler(guid);
799 static const struct wmi_device_id huawei_wmi_events_id_table[] = {
800 { .guid_string = WMI0_EVENT_GUID },
801 { .guid_string = HWMI_EVENT_GUID },
805 static int huawei_wmi_probe(struct platform_device *pdev)
807 const struct wmi_device_id *guid = huawei_wmi_events_id_table;
810 platform_set_drvdata(pdev, huawei_wmi);
811 huawei_wmi->dev = &pdev->dev;
813 while (*guid->guid_string) {
814 struct input_dev *idev = *huawei_wmi->idev;
816 if (wmi_has_guid(guid->guid_string)) {
817 err = huawei_wmi_input_setup(&pdev->dev, guid->guid_string, &idev);
819 dev_err(&pdev->dev, "Failed to setup input on %s\n", guid->guid_string);
828 if (wmi_has_guid(HWMI_METHOD_GUID)) {
829 mutex_init(&huawei_wmi->wmi_lock);
831 huawei_wmi_leds_setup(&pdev->dev);
832 huawei_wmi_fn_lock_setup(&pdev->dev);
833 huawei_wmi_battery_setup(&pdev->dev);
834 huawei_wmi_debugfs_setup(&pdev->dev);
840 static int huawei_wmi_remove(struct platform_device *pdev)
842 const struct wmi_device_id *guid = huawei_wmi_events_id_table;
844 while (*guid->guid_string) {
845 if (wmi_has_guid(guid->guid_string))
846 huawei_wmi_input_exit(&pdev->dev, guid->guid_string);
851 if (wmi_has_guid(HWMI_METHOD_GUID)) {
852 huawei_wmi_debugfs_exit(&pdev->dev);
853 huawei_wmi_battery_exit(&pdev->dev);
854 huawei_wmi_fn_lock_exit(&pdev->dev);
860 static struct platform_driver huawei_wmi_driver = {
862 .name = "huawei-wmi",
864 .probe = huawei_wmi_probe,
865 .remove = huawei_wmi_remove,
868 static __init int huawei_wmi_init(void)
870 struct platform_device *pdev;
873 huawei_wmi = kzalloc(sizeof(struct huawei_wmi), GFP_KERNEL);
877 quirks = &quirk_unknown;
878 dmi_check_system(huawei_quirks);
879 if (battery_reset != -1)
880 quirks->battery_reset = battery_reset;
881 if (report_brightness != -1)
882 quirks->report_brightness = report_brightness;
884 err = platform_driver_register(&huawei_wmi_driver);
888 pdev = platform_device_register_simple("huawei-wmi", -1, NULL, 0);
897 platform_driver_unregister(&huawei_wmi_driver);
903 static __exit void huawei_wmi_exit(void)
905 struct platform_device *pdev = to_platform_device(huawei_wmi->dev);
907 platform_device_unregister(pdev);
908 platform_driver_unregister(&huawei_wmi_driver);
913 module_init(huawei_wmi_init);
914 module_exit(huawei_wmi_exit);
916 MODULE_ALIAS("wmi:"HWMI_METHOD_GUID);
917 MODULE_DEVICE_TABLE(wmi, huawei_wmi_events_id_table);
918 MODULE_AUTHOR("Ayman Bagabas <ayman.bagabas@gmail.com>");
919 MODULE_DESCRIPTION("Huawei WMI laptop extras driver");
920 MODULE_LICENSE("GPL v2");