1 // SPDX-License-Identifier: GPL-2.0+
3 * lg-laptop.c - LG Gram ACPI features and hotkeys Driver
8 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
10 #include <linux/acpi.h>
11 #include <linux/bits.h>
12 #include <linux/device.h>
13 #include <linux/dev_printk.h>
14 #include <linux/dmi.h>
15 #include <linux/input.h>
16 #include <linux/input/sparse-keymap.h>
17 #include <linux/kernel.h>
18 #include <linux/leds.h>
19 #include <linux/module.h>
20 #include <linux/platform_device.h>
21 #include <linux/types.h>
23 #include <acpi/battery.h>
25 #define LED_DEVICE(_name, max, flag) struct led_classdev _name = { \
26 .name = __stringify(_name), \
27 .max_brightness = max, \
28 .brightness_set = _name##_set, \
29 .brightness_get = _name##_get, \
33 MODULE_AUTHOR("Matan Ziv-Av");
34 MODULE_DESCRIPTION("LG WMI Hotkey Driver");
35 MODULE_LICENSE("GPL");
38 module_param(fw_debug, bool, 0);
39 MODULE_PARM_DESC(fw_debug, "Enable printing of firmware debug messages");
41 #define LG_ADDRESS_SPACE_ID 0x8F
43 #define LG_ADDRESS_SPACE_DEBUG_FLAG_ADR 0x00
44 #define LG_ADDRESS_SPACE_FAN_MODE_ADR 0x03
46 #define LG_ADDRESS_SPACE_DTTM_FLAG_ADR 0x20
47 #define LG_ADDRESS_SPACE_CPU_TEMP_ADR 0x21
48 #define LG_ADDRESS_SPACE_CPU_TRIP_LOW_ADR 0x22
49 #define LG_ADDRESS_SPACE_CPU_TRIP_HIGH_ADR 0x23
50 #define LG_ADDRESS_SPACE_MB_TEMP_ADR 0x24
51 #define LG_ADDRESS_SPACE_MB_TRIP_LOW_ADR 0x25
52 #define LG_ADDRESS_SPACE_MB_TRIP_HIGH_ADR 0x26
54 #define LG_ADDRESS_SPACE_DEBUG_MSG_START_ADR 0x3E8
55 #define LG_ADDRESS_SPACE_DEBUG_MSG_END_ADR 0x5E8
57 #define WMI_EVENT_GUID0 "E4FB94F9-7F2B-4173-AD1A-CD1D95086248"
58 #define WMI_EVENT_GUID1 "023B133E-49D1-4E10-B313-698220140DC2"
59 #define WMI_EVENT_GUID2 "37BE1AC0-C3F2-4B1F-BFBE-8FDEAF2814D6"
60 #define WMI_EVENT_GUID3 "911BAD44-7DF8-4FBB-9319-BABA1C4B293B"
61 #define WMI_METHOD_WMAB "C3A72B38-D3EF-42D3-8CBB-D5A57049F66D"
62 #define WMI_METHOD_WMBB "2B4F501A-BD3C-4394-8DCF-00A7D2BC8210"
63 #define WMI_EVENT_GUID WMI_EVENT_GUID0
65 #define SB_GGOV_METHOD "\\_SB.GGOV"
66 #define GOV_TLED 0x2020008
69 #define WM_KEY_LIGHT 0x400
71 #define WM_FN_LOCK 0x407
72 #define WM_BATT_LIMIT 0x61
73 #define WM_READER_MODE 0xBF
74 #define WM_FAN_MODE 0x33
75 #define WMBB_USB_CHARGE 0x10B
76 #define WMBB_BATT_LIMIT 0x10C
78 #define PLATFORM_NAME "lg-laptop"
80 MODULE_ALIAS("wmi:" WMI_EVENT_GUID0);
81 MODULE_ALIAS("wmi:" WMI_EVENT_GUID1);
82 MODULE_ALIAS("wmi:" WMI_EVENT_GUID2);
83 MODULE_ALIAS("wmi:" WMI_EVENT_GUID3);
84 MODULE_ALIAS("wmi:" WMI_METHOD_WMAB);
85 MODULE_ALIAS("wmi:" WMI_METHOD_WMBB);
87 static struct platform_device *pf_device;
88 static struct input_dev *wmi_input_dev;
91 #define INIT_INPUT_WMI_0 0x01
92 #define INIT_INPUT_WMI_2 0x02
93 #define INIT_INPUT_ACPI 0x04
94 #define INIT_SPARSE_KEYMAP 0x80
96 static int battery_limit_use_wmbb;
97 static struct led_classdev kbd_backlight;
98 static enum led_brightness get_kbd_backlight_level(struct device *dev);
100 static const struct key_entry wmi_keymap[] = {
101 {KE_KEY, 0x70, {KEY_F15} }, /* LG control panel (F1) */
102 {KE_KEY, 0x74, {KEY_F21} }, /* Touchpad toggle (F5) */
103 {KE_KEY, 0xf020000, {KEY_F14} }, /* Read mode (F9) */
104 {KE_KEY, 0x10000000, {KEY_F16} },/* Keyboard backlight (F8) - pressing
105 * this key both sends an event and
106 * changes backlight level.
111 static int ggov(u32 arg0)
113 union acpi_object args[1];
114 union acpi_object *r;
117 struct acpi_object_list arg;
118 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
121 args[0].type = ACPI_TYPE_INTEGER;
122 args[0].integer.value = arg0;
124 status = acpi_get_handle(NULL, (acpi_string) SB_GGOV_METHOD, &handle);
125 if (ACPI_FAILURE(status)) {
126 pr_err("Cannot get handle");
133 status = acpi_evaluate_object(handle, NULL, &arg, &buffer);
134 if (ACPI_FAILURE(status)) {
135 acpi_handle_err(handle, "GGOV: call failed.\n");
140 if (r->type != ACPI_TYPE_INTEGER) {
145 res = r->integer.value;
151 static union acpi_object *lg_wmab(struct device *dev, u32 method, u32 arg1, u32 arg2)
153 union acpi_object args[3];
155 struct acpi_object_list arg;
156 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
158 args[0].type = ACPI_TYPE_INTEGER;
159 args[0].integer.value = method;
160 args[1].type = ACPI_TYPE_INTEGER;
161 args[1].integer.value = arg1;
162 args[2].type = ACPI_TYPE_INTEGER;
163 args[2].integer.value = arg2;
168 status = acpi_evaluate_object(ACPI_HANDLE(dev), "WMAB", &arg, &buffer);
169 if (ACPI_FAILURE(status)) {
170 dev_err(dev, "WMAB: call failed.\n");
174 return buffer.pointer;
177 static union acpi_object *lg_wmbb(struct device *dev, u32 method_id, u32 arg1, u32 arg2)
179 union acpi_object args[3];
181 struct acpi_object_list arg;
182 struct acpi_buffer buffer = { ACPI_ALLOCATE_BUFFER, NULL };
185 *(u32 *)buf = method_id;
186 *(u32 *)(buf + 4) = arg1;
187 *(u32 *)(buf + 16) = arg2;
188 args[0].type = ACPI_TYPE_INTEGER;
189 args[0].integer.value = 0; /* ignored */
190 args[1].type = ACPI_TYPE_INTEGER;
191 args[1].integer.value = 1; /* Must be 1 or 2. Does not matter which */
192 args[2].type = ACPI_TYPE_BUFFER;
193 args[2].buffer.length = 32;
194 args[2].buffer.pointer = buf;
199 status = acpi_evaluate_object(ACPI_HANDLE(dev), "WMBB", &arg, &buffer);
200 if (ACPI_FAILURE(status)) {
201 dev_err(dev, "WMBB: call failed.\n");
205 return (union acpi_object *)buffer.pointer;
208 static void wmi_notify(union acpi_object *obj, void *context)
210 long data = (long)context;
212 pr_debug("event guid %li\n", data);
216 if (obj->type == ACPI_TYPE_INTEGER) {
217 int eventcode = obj->integer.value;
218 struct key_entry *key;
220 if (eventcode == 0x10000000) {
221 led_classdev_notify_brightness_hw_changed(
222 &kbd_backlight, get_kbd_backlight_level(kbd_backlight.dev->parent));
224 key = sparse_keymap_entry_from_scancode(
225 wmi_input_dev, eventcode);
226 if (key && key->type == KE_KEY)
227 sparse_keymap_report_entry(wmi_input_dev,
232 pr_debug("Type: %i Eventcode: 0x%llx\n", obj->type,
236 static void wmi_input_setup(void)
240 wmi_input_dev = input_allocate_device();
242 wmi_input_dev->name = "LG WMI hotkeys";
243 wmi_input_dev->phys = "wmi/input0";
244 wmi_input_dev->id.bustype = BUS_HOST;
246 if (sparse_keymap_setup(wmi_input_dev, wmi_keymap, NULL) ||
247 input_register_device(wmi_input_dev)) {
248 pr_info("Cannot initialize input device");
249 input_free_device(wmi_input_dev);
253 inited |= INIT_SPARSE_KEYMAP;
254 status = wmi_install_notify_handler(WMI_EVENT_GUID0, wmi_notify,
256 if (ACPI_SUCCESS(status))
257 inited |= INIT_INPUT_WMI_0;
259 status = wmi_install_notify_handler(WMI_EVENT_GUID2, wmi_notify,
261 if (ACPI_SUCCESS(status))
262 inited |= INIT_INPUT_WMI_2;
264 pr_info("Cannot allocate input device");
268 static void acpi_notify(struct acpi_device *device, u32 event)
270 acpi_handle_debug(device->handle, "notify: %d\n", event);
273 static ssize_t fan_mode_store(struct device *dev,
274 struct device_attribute *attr,
275 const char *buffer, size_t count)
278 union acpi_object *r;
282 ret = kstrtobool(buffer, &value);
286 r = lg_wmab(dev, WM_FAN_MODE, WM_GET, 0);
290 if (r->type != ACPI_TYPE_INTEGER) {
295 m = r->integer.value;
297 r = lg_wmab(dev, WM_FAN_MODE, WM_SET, (m & 0xffffff0f) | (value << 4));
299 r = lg_wmab(dev, WM_FAN_MODE, WM_SET, (m & 0xfffffff0) | value);
305 static ssize_t fan_mode_show(struct device *dev,
306 struct device_attribute *attr, char *buffer)
309 union acpi_object *r;
311 r = lg_wmab(dev, WM_FAN_MODE, WM_GET, 0);
315 if (r->type != ACPI_TYPE_INTEGER) {
320 status = r->integer.value & 0x01;
323 return sysfs_emit(buffer, "%d\n", status);
326 static ssize_t usb_charge_store(struct device *dev,
327 struct device_attribute *attr,
328 const char *buffer, size_t count)
331 union acpi_object *r;
334 ret = kstrtobool(buffer, &value);
338 r = lg_wmbb(dev, WMBB_USB_CHARGE, WM_SET, value);
346 static ssize_t usb_charge_show(struct device *dev,
347 struct device_attribute *attr, char *buffer)
350 union acpi_object *r;
352 r = lg_wmbb(dev, WMBB_USB_CHARGE, WM_GET, 0);
356 if (r->type != ACPI_TYPE_BUFFER) {
361 status = !!r->buffer.pointer[0x10];
365 return sysfs_emit(buffer, "%d\n", status);
368 static ssize_t reader_mode_store(struct device *dev,
369 struct device_attribute *attr,
370 const char *buffer, size_t count)
373 union acpi_object *r;
376 ret = kstrtobool(buffer, &value);
380 r = lg_wmab(dev, WM_READER_MODE, WM_SET, value);
388 static ssize_t reader_mode_show(struct device *dev,
389 struct device_attribute *attr, char *buffer)
392 union acpi_object *r;
394 r = lg_wmab(dev, WM_READER_MODE, WM_GET, 0);
398 if (r->type != ACPI_TYPE_INTEGER) {
403 status = !!r->integer.value;
407 return sysfs_emit(buffer, "%d\n", status);
410 static ssize_t fn_lock_store(struct device *dev,
411 struct device_attribute *attr,
412 const char *buffer, size_t count)
415 union acpi_object *r;
418 ret = kstrtobool(buffer, &value);
422 r = lg_wmab(dev, WM_FN_LOCK, WM_SET, value);
430 static ssize_t fn_lock_show(struct device *dev,
431 struct device_attribute *attr, char *buffer)
434 union acpi_object *r;
436 r = lg_wmab(dev, WM_FN_LOCK, WM_GET, 0);
440 if (r->type != ACPI_TYPE_BUFFER) {
445 status = !!r->buffer.pointer[0];
448 return sysfs_emit(buffer, "%d\n", status);
451 static ssize_t charge_control_end_threshold_store(struct device *dev,
452 struct device_attribute *attr,
453 const char *buf, size_t count)
458 ret = kstrtoul(buf, 10, &value);
462 if (value == 100 || value == 80) {
463 union acpi_object *r;
465 if (battery_limit_use_wmbb)
466 r = lg_wmbb(&pf_device->dev, WMBB_BATT_LIMIT, WM_SET, value);
468 r = lg_wmab(&pf_device->dev, WM_BATT_LIMIT, WM_SET, value);
479 static ssize_t charge_control_end_threshold_show(struct device *device,
480 struct device_attribute *attr,
484 union acpi_object *r;
486 if (battery_limit_use_wmbb) {
487 r = lg_wmbb(&pf_device->dev, WMBB_BATT_LIMIT, WM_GET, 0);
491 if (r->type != ACPI_TYPE_BUFFER) {
496 status = r->buffer.pointer[0x10];
498 r = lg_wmab(&pf_device->dev, WM_BATT_LIMIT, WM_GET, 0);
502 if (r->type != ACPI_TYPE_INTEGER) {
507 status = r->integer.value;
510 if (status != 80 && status != 100)
513 return sysfs_emit(buf, "%d\n", status);
516 static ssize_t battery_care_limit_show(struct device *dev,
517 struct device_attribute *attr,
520 return charge_control_end_threshold_show(dev, attr, buffer);
523 static ssize_t battery_care_limit_store(struct device *dev,
524 struct device_attribute *attr,
525 const char *buffer, size_t count)
527 return charge_control_end_threshold_store(dev, attr, buffer, count);
530 static DEVICE_ATTR_RW(fan_mode);
531 static DEVICE_ATTR_RW(usb_charge);
532 static DEVICE_ATTR_RW(reader_mode);
533 static DEVICE_ATTR_RW(fn_lock);
534 static DEVICE_ATTR_RW(charge_control_end_threshold);
535 static DEVICE_ATTR_RW(battery_care_limit);
537 static int lg_battery_add(struct power_supply *battery, struct acpi_battery_hook *hook)
539 if (device_create_file(&battery->dev,
540 &dev_attr_charge_control_end_threshold))
546 static int lg_battery_remove(struct power_supply *battery, struct acpi_battery_hook *hook)
548 device_remove_file(&battery->dev,
549 &dev_attr_charge_control_end_threshold);
553 static struct acpi_battery_hook battery_hook = {
554 .add_battery = lg_battery_add,
555 .remove_battery = lg_battery_remove,
556 .name = "LG Battery Extension",
559 static struct attribute *dev_attributes[] = {
560 &dev_attr_fan_mode.attr,
561 &dev_attr_usb_charge.attr,
562 &dev_attr_reader_mode.attr,
563 &dev_attr_fn_lock.attr,
564 &dev_attr_battery_care_limit.attr,
568 static const struct attribute_group dev_attribute_group = {
569 .attrs = dev_attributes,
572 static void tpad_led_set(struct led_classdev *cdev,
573 enum led_brightness brightness)
575 union acpi_object *r;
577 r = lg_wmab(cdev->dev->parent, WM_TLED, WM_SET, brightness > LED_OFF);
581 static enum led_brightness tpad_led_get(struct led_classdev *cdev)
583 return ggov(GOV_TLED) > 0 ? LED_ON : LED_OFF;
586 static LED_DEVICE(tpad_led, 1, 0);
588 static void kbd_backlight_set(struct led_classdev *cdev,
589 enum led_brightness brightness)
592 union acpi_object *r;
595 if (brightness <= LED_OFF)
597 if (brightness >= LED_FULL)
599 r = lg_wmab(cdev->dev->parent, WM_KEY_LIGHT, WM_SET, val);
603 static enum led_brightness get_kbd_backlight_level(struct device *dev)
605 union acpi_object *r;
608 r = lg_wmab(dev, WM_KEY_LIGHT, WM_GET, 0);
613 if (r->type != ACPI_TYPE_BUFFER || r->buffer.pointer[1] != 0x05) {
618 switch (r->buffer.pointer[0] & 0x27) {
634 static enum led_brightness kbd_backlight_get(struct led_classdev *cdev)
636 return get_kbd_backlight_level(cdev->dev->parent);
639 static LED_DEVICE(kbd_backlight, 255, LED_BRIGHT_HW_CHANGED);
641 static void wmi_input_destroy(void)
643 if (inited & INIT_INPUT_WMI_2)
644 wmi_remove_notify_handler(WMI_EVENT_GUID2);
646 if (inited & INIT_INPUT_WMI_0)
647 wmi_remove_notify_handler(WMI_EVENT_GUID0);
649 if (inited & INIT_SPARSE_KEYMAP)
650 input_unregister_device(wmi_input_dev);
652 inited &= ~(INIT_INPUT_WMI_0 | INIT_INPUT_WMI_2 | INIT_SPARSE_KEYMAP);
655 static struct platform_driver pf_driver = {
657 .name = PLATFORM_NAME,
661 static acpi_status lg_laptop_address_space_write(struct device *dev, acpi_physical_address address,
662 size_t size, u64 value)
666 /* Ignore any debug messages */
667 if (address >= LG_ADDRESS_SPACE_DEBUG_MSG_START_ADR &&
668 address <= LG_ADDRESS_SPACE_DEBUG_MSG_END_ADR)
671 if (size != sizeof(byte))
672 return AE_BAD_PARAMETER;
677 case LG_ADDRESS_SPACE_FAN_MODE_ADR:
679 * The fan mode field is not affected by the DTTM flag, so we
680 * have to manually check fw_debug.
683 dev_dbg(dev, "Fan mode set to mode %u\n", byte);
686 case LG_ADDRESS_SPACE_CPU_TEMP_ADR:
687 dev_dbg(dev, "CPU temperature is %u °C\n", byte);
689 case LG_ADDRESS_SPACE_CPU_TRIP_LOW_ADR:
690 dev_dbg(dev, "CPU lower trip point set to %u °C\n", byte);
692 case LG_ADDRESS_SPACE_CPU_TRIP_HIGH_ADR:
693 dev_dbg(dev, "CPU higher trip point set to %u °C\n", byte);
695 case LG_ADDRESS_SPACE_MB_TEMP_ADR:
696 dev_dbg(dev, "Motherboard temperature is %u °C\n", byte);
698 case LG_ADDRESS_SPACE_MB_TRIP_LOW_ADR:
699 dev_dbg(dev, "Motherboard lower trip point set to %u °C\n", byte);
701 case LG_ADDRESS_SPACE_MB_TRIP_HIGH_ADR:
702 dev_dbg(dev, "Motherboard higher trip point set to %u °C\n", byte);
705 dev_notice_ratelimited(dev, "Ignoring write to unknown opregion address %llu\n",
711 static acpi_status lg_laptop_address_space_read(struct device *dev, acpi_physical_address address,
712 size_t size, u64 *value)
715 return AE_BAD_PARAMETER;
718 case LG_ADDRESS_SPACE_DEBUG_FLAG_ADR:
719 /* Debug messages are already printed using the standard ACPI Debug object */
722 case LG_ADDRESS_SPACE_DTTM_FLAG_ADR:
726 dev_notice_ratelimited(dev, "Attempt to read unknown opregion address %llu\n",
728 return AE_BAD_PARAMETER;
732 static acpi_status lg_laptop_address_space_handler(u32 function, acpi_physical_address address,
733 u32 bits, u64 *value, void *handler_context,
734 void *region_context)
736 struct device *dev = handler_context;
739 if (bits % BITS_PER_BYTE)
740 return AE_BAD_PARAMETER;
742 size = bits / BITS_PER_BYTE;
746 return lg_laptop_address_space_read(dev, address, size, value);
748 return lg_laptop_address_space_write(dev, address, size, *value);
750 return AE_BAD_PARAMETER;
754 static void lg_laptop_remove_address_space_handler(void *data)
756 struct acpi_device *device = data;
758 acpi_remove_address_space_handler(device->handle, LG_ADDRESS_SPACE_ID,
759 &lg_laptop_address_space_handler);
762 static int acpi_add(struct acpi_device *device)
764 struct platform_device_info pdev_info = {
765 .fwnode = acpi_fwnode_handle(device),
766 .name = PLATFORM_NAME,
767 .id = PLATFORM_DEVID_NONE,
777 status = acpi_install_address_space_handler(device->handle, LG_ADDRESS_SPACE_ID,
778 &lg_laptop_address_space_handler,
780 if (ACPI_FAILURE(status))
783 ret = devm_add_action_or_reset(&device->dev, lg_laptop_remove_address_space_handler,
788 ret = platform_driver_register(&pf_driver);
792 pf_device = platform_device_register_full(&pdev_info);
793 if (IS_ERR(pf_device)) {
794 ret = PTR_ERR(pf_device);
796 pr_err("unable to register platform device\n");
797 goto out_platform_registered;
799 product = dmi_get_system_info(DMI_PRODUCT_NAME);
800 if (product && strlen(product) > 4)
801 switch (product[4]) {
803 if (strlen(product) > 5)
804 switch (product[5]) {
828 if (strlen(product) > 5)
829 switch (product[5]) {
843 pr_info("product: %s year: %d\n", product ?: "unknown", year);
846 battery_limit_use_wmbb = 1;
848 ret = sysfs_create_group(&pf_device->dev.kobj, &dev_attribute_group);
850 goto out_platform_device;
852 /* LEDs are optional */
853 led_classdev_register(&pf_device->dev, &kbd_backlight);
854 led_classdev_register(&pf_device->dev, &tpad_led);
857 battery_hook_register(&battery_hook);
862 platform_device_unregister(pf_device);
863 out_platform_registered:
864 platform_driver_unregister(&pf_driver);
868 static void acpi_remove(struct acpi_device *device)
870 sysfs_remove_group(&pf_device->dev.kobj, &dev_attribute_group);
872 led_classdev_unregister(&tpad_led);
873 led_classdev_unregister(&kbd_backlight);
875 battery_hook_unregister(&battery_hook);
877 platform_device_unregister(pf_device);
879 platform_driver_unregister(&pf_driver);
882 static const struct acpi_device_id device_ids[] = {
886 MODULE_DEVICE_TABLE(acpi, device_ids);
888 static struct acpi_driver acpi_driver = {
889 .name = "LG Gram Laptop Support",
890 .class = "lg-laptop",
894 .remove = acpi_remove,
895 .notify = acpi_notify,
899 static int __init acpi_init(void)
903 result = acpi_bus_register_driver(&acpi_driver);
905 pr_debug("Error registering driver\n");
912 static void __exit acpi_exit(void)
914 acpi_bus_unregister_driver(&acpi_driver);
917 module_init(acpi_init);
918 module_exit(acpi_exit);