* [PATCH 0/3] platform/x86: Add support for Uniwill laptop features
@ 2025-07-12 11:23 Armin Wolf
2025-07-12 11:23 ` [PATCH 1/3] platform/x86: Add Uniwill WMI driver Armin Wolf
` (2 more replies)
0 siblings, 3 replies; 11+ messages in thread
From: Armin Wolf @ 2025-07-12 11:23 UTC (permalink / raw)
To: ilpo.jarvinen, hdegoede, chumuzero, corbet, cs, wse, ggo
Cc: linux-doc, linux-kernel, platform-driver-x86, rdunlap,
alok.a.tiwari, linux-leds, lee, pobrn
This patch series adds support for the various features found on
laptops manufactured by Uniwill. Those features are:
- battery charge limiting
- RGB lightbar control
- hwmon support
- improved hotkey support
- keyboard-related settings
This patch series is based on the following out-of-tree drivers:
- https://github.com/pobrn/qc71_laptop
- https://gitlab.com/tuxedocomputers/development/packages/tuxedo-drivers
Additionally the OEM software of the Intel Nuc x15 was
reverse-engineered to have a better understanding about the underlying
hardware interface.
The first patch introduces the uniwill-wmi driver used for handling
WMI events on Uniwill devices. Due to a grave design error inside the
underlying WMI firmware interface (the WMI GUID was copied from the
Windows driver samples and is thus not unique) the driver cannot be
autoloaded. Instead drivers using this module will load it as an
module dependency.
The second patch introduces the uniwill-laptop driver that does the
majority of the work. This driver talks to the embedded controller
using yet another WMI interface to control the various features
available on those devices. Sadly this WMI firmware interfaces suffers
from the exact same issue (the WMI GUID is not unique) and thus a DMI
whitelist has to be used for loading the driver.
The last patch finally adds some documentation for configuring and
using both drivers.
Special thanks go to:
- github user cyear for bring up this topic on the lm-sensors issue
tracker and being the tester for various prototype versions
- github user dumingqiao for testing the battery, lightbar and
keyboard-related features
- Tuxedo computers for giving advice on how to design the userspace
interface
Please note that the whole series is based onto the pdx86/fixes branch
as it uses the new power_supply_get_property_direct() function.
Changes since the RFC series:
- spelling fixes
- mention the INOU0000 ACPI device inside thew documentation
- use MILLIDEGREE_PER_DEGREE instead of 1000
- use power_supply_get_property_direct() to prevent deadlock
- add support for KEY_KBDILLUMDOWN and KEY_KBDILLUMUP
Since the changes to the driver source code are fairly small i decided
to keep the Tested-by tags from the RFC series.
Armin Wolf (3):
platform/x86: Add Uniwill WMI driver
platform/x86: Add Uniwill laptop driver
Documentation: laptops: Add documentation for uniwill laptops
.../ABI/testing/sysfs-driver-uniwill-laptop | 53 +
Documentation/admin-guide/laptops/index.rst | 1 +
.../admin-guide/laptops/uniwill-laptop.rst | 68 +
Documentation/wmi/devices/uniwill-laptop.rst | 118 ++
Documentation/wmi/devices/uniwill-wmi.rst | 52 +
MAINTAINERS | 17 +
drivers/platform/x86/Kconfig | 2 +
drivers/platform/x86/Makefile | 3 +
drivers/platform/x86/uniwill/Kconfig | 49 +
drivers/platform/x86/uniwill/Makefile | 8 +
drivers/platform/x86/uniwill/uniwill-laptop.c | 1481 +++++++++++++++++
drivers/platform/x86/uniwill/uniwill-wmi.c | 186 +++
drivers/platform/x86/uniwill/uniwill-wmi.h | 122 ++
13 files changed, 2160 insertions(+)
create mode 100644 Documentation/ABI/testing/sysfs-driver-uniwill-laptop
create mode 100644 Documentation/admin-guide/laptops/uniwill-laptop.rst
create mode 100644 Documentation/wmi/devices/uniwill-laptop.rst
create mode 100644 Documentation/wmi/devices/uniwill-wmi.rst
create mode 100644 drivers/platform/x86/uniwill/Kconfig
create mode 100644 drivers/platform/x86/uniwill/Makefile
create mode 100644 drivers/platform/x86/uniwill/uniwill-laptop.c
create mode 100644 drivers/platform/x86/uniwill/uniwill-wmi.c
create mode 100644 drivers/platform/x86/uniwill/uniwill-wmi.h
--
2.39.5
^ permalink raw reply [flat|nested] 11+ messages in thread* [PATCH 1/3] platform/x86: Add Uniwill WMI driver 2025-07-12 11:23 [PATCH 0/3] platform/x86: Add support for Uniwill laptop features Armin Wolf @ 2025-07-12 11:23 ` Armin Wolf 2025-07-12 11:46 ` [External] : " ALOK TIWARI 2025-07-12 11:23 ` [PATCH 2/3] platform/x86: Add Uniwill laptop driver Armin Wolf 2025-07-12 11:23 ` [PATCH 3/3] Documentation: laptops: Add documentation for uniwill laptops Armin Wolf 2 siblings, 1 reply; 11+ messages in thread From: Armin Wolf @ 2025-07-12 11:23 UTC (permalink / raw) To: ilpo.jarvinen, hdegoede, chumuzero, corbet, cs, wse, ggo Cc: linux-doc, linux-kernel, platform-driver-x86, rdunlap, alok.a.tiwari, linux-leds, lee, pobrn Add a new driver for handling WMI events on Uniwill laptops. The driver sadly cannot use the WMI GUID for autoloading since Uniwill just copied it from the Windows driver example. The driver is reverse-engineered based on the following information: - https://github.com/pobrn/qc71_laptop - https://gitlab.com/tuxedocomputers/development/packages/tuxedo-drivers - various OEM software Reported-by: cyear <chumuzero@gmail.com> Closes: https://github.com/lm-sensors/lm-sensors/issues/508 Closes: https://github.com/Wer-Wolf/uniwill-laptop/issues/3 Signed-off-by: Armin Wolf <W_Armin@gmx.de> --- Documentation/wmi/devices/uniwill-wmi.rst | 52 ++++++ MAINTAINERS | 8 + drivers/platform/x86/Kconfig | 2 + drivers/platform/x86/Makefile | 3 + drivers/platform/x86/uniwill/Kconfig | 32 ++++ drivers/platform/x86/uniwill/Makefile | 7 + drivers/platform/x86/uniwill/uniwill-wmi.c | 185 +++++++++++++++++++++ drivers/platform/x86/uniwill/uniwill-wmi.h | 122 ++++++++++++++ 8 files changed, 411 insertions(+) create mode 100644 Documentation/wmi/devices/uniwill-wmi.rst create mode 100644 drivers/platform/x86/uniwill/Kconfig create mode 100644 drivers/platform/x86/uniwill/Makefile create mode 100644 drivers/platform/x86/uniwill/uniwill-wmi.c create mode 100644 drivers/platform/x86/uniwill/uniwill-wmi.h diff --git a/Documentation/wmi/devices/uniwill-wmi.rst b/Documentation/wmi/devices/uniwill-wmi.rst new file mode 100644 index 000000000000..8de86c910bb9 --- /dev/null +++ b/Documentation/wmi/devices/uniwill-wmi.rst @@ -0,0 +1,52 @@ +.. SPDX-License-Identifier: GPL-2.0-or-later + +====================================== +Uniwill WMI event driver (uniwill-wmi) +====================================== + +Introduction +============ + +Many notebooks manufactured by Uniwill (either directly or as ODM) provide a WMI-based +event interface for various platform events like hotkeys. This interface is used by the +``uniwill-wmi`` driver to react to hotkey presses. + +WMI interface description +========================= + +The WMI interface description can be decoded from the embedded binary MOF (bmof) +data using the `bmfdec <https://github.com/pali/bmfdec>`_ utility: + +:: + + [WMI, Dynamic, Provider("WmiProv"), Locale("MS\\0x409"), + Description("Class containing event generated ULong data"), + guid("{ABBC0F72-8EA1-11d1-00A0-C90629100000}")] + class AcpiTest_EventULong : WmiEvent { + [key, read] string InstanceName; + [read] boolean Active; + + [WmiDataId(1), read, write, Description("ULong Data")] uint32 ULong; + }; + +Most of the WMI-related code was copied from the Windows driver samples, which unfortunately means +that the WMI-GUID is not unique. This makes the WMI-GUID unusable for autoloading. + +WMI event data +-------------- + +The WMI event data contains a single 32-bit value which is used to indicate various platform events. +Many non-hotkey events are not directly consumed by the driver itself, but are instead handled by +the ``uniwill-laptop`` driver. + +Reverse-Engineering the Uniwill WMI event interface +=================================================== + +The driver logs debug messages when receiving a WMI event. Thus enabling debug messages will be +useful for finding unknown event codes. + +Special thanks go to github user `pobrn` which developed the +`qc71_laptop <https://github.com/pobrn/qc71_laptop>`_ driver on which this driver is partly based. +The same is true for Tuxedo Computers, which developed the +`tuxedo-drivers <https://gitlab.com/tuxedocomputers/development/packages/tuxedo-drivers>`_ package +which also served as a foundation for this driver. diff --git a/MAINTAINERS b/MAINTAINERS index e8f3dc93a569..6c5879bd2ba2 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -25490,6 +25490,14 @@ L: linux-scsi@vger.kernel.org S: Maintained F: drivers/ufs/host/ufs-renesas.c +UNIWILL WMI DRIVER +M: Armin Wolf <W_Armin@gmx.de> +L: platform-driver-x86@vger.kernel.org +S: Maintained +F: Documentation/wmi/devices/uniwill-wmi.rst +F: drivers/platform/x86/uniwill/uniwill-wmi.c +F: drivers/platform/x86/uniwill/uniwill-wmi.h + UNSORTED BLOCK IMAGES (UBI) M: Richard Weinberger <richard@nod.at> R: Zhihao Cheng <chengzhihao1@huawei.com> diff --git a/drivers/platform/x86/Kconfig b/drivers/platform/x86/Kconfig index e5cbd58a99f3..59ce7247dae6 100644 --- a/drivers/platform/x86/Kconfig +++ b/drivers/platform/x86/Kconfig @@ -65,6 +65,8 @@ config HUAWEI_WMI To compile this driver as a module, choose M here: the module will be called huawei-wmi. +source "drivers/platform/x86/uniwill/Kconfig" + config UV_SYSFS tristate "Sysfs structure for UV systems" depends on X86_UV diff --git a/drivers/platform/x86/Makefile b/drivers/platform/x86/Makefile index abbc2644ff6d..d0aac46bebf9 100644 --- a/drivers/platform/x86/Makefile +++ b/drivers/platform/x86/Makefile @@ -112,6 +112,9 @@ obj-$(CONFIG_TOSHIBA_WMI) += toshiba-wmi.o # before toshiba_acpi initializes obj-$(CONFIG_ACPI_TOSHIBA) += toshiba_acpi.o +# Uniwill +obj-y += uniwill/ + # Inspur obj-$(CONFIG_INSPUR_PLATFORM_PROFILE) += inspur_platform_profile.o diff --git a/drivers/platform/x86/uniwill/Kconfig b/drivers/platform/x86/uniwill/Kconfig new file mode 100644 index 000000000000..7571b30edb11 --- /dev/null +++ b/drivers/platform/x86/uniwill/Kconfig @@ -0,0 +1,32 @@ +# SPDX-License-Identifier: GPL-2.0-or-later +# +# Uniwill X86 Platform Specific Drivers +# + +menuconfig X86_PLATFORM_DRIVERS_UNIWILL + bool "Uniwill X86 Platform Specific Device Drivers" + depends on X86_PLATFORM_DEVICES + help + Say Y here to see options for device drivers for various + Uniwill x86 platforms, including many OEM laptops originally + manufactured by Uniwill. + This option alone does not add any kernel code. + + If you say N, all options in this submenu will be skipped and disabled. + +if X86_PLATFORM_DRIVERS_UNIWILL + +config UNIWILL_WMI + tristate "Uniwill WMI Event Driver" + default m + depends on ACPI_WMI + depends on INPUT + select INPUT_SPARSEKMAP + help + This driver adds support for various hotkey events on Uniwill laptops, + like rfkill and other special buttons. It also supports many OEM laptops + originally manufactured by Uniwill. + + If you have such a laptop, say Y or M here. + +endif diff --git a/drivers/platform/x86/uniwill/Makefile b/drivers/platform/x86/uniwill/Makefile new file mode 100644 index 000000000000..a5a300be63f3 --- /dev/null +++ b/drivers/platform/x86/uniwill/Makefile @@ -0,0 +1,7 @@ +# SPDX-License-Identifier: GPL-2.0-or-later +# +# Makefile for linux/drivers/platform/x86/uniwill +# Uniwill X86 Platform Specific Drivers +# + +obj-$(CONFIG_UNIWILL_WMI) += uniwill-wmi.o diff --git a/drivers/platform/x86/uniwill/uniwill-wmi.c b/drivers/platform/x86/uniwill/uniwill-wmi.c new file mode 100644 index 000000000000..f38e4bbcd8b6 --- /dev/null +++ b/drivers/platform/x86/uniwill/uniwill-wmi.c @@ -0,0 +1,185 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/* + * Linux hotkey driver for Uniwill notebooks. + * + * Special thanks go to Pőcze Barnabás, Christoffer Sandberg and Werner Sembach + * for supporting the development of this driver either through prior work or + * by answering questions regarding the underlying WMI interface. + * + * Copyright (C) 2025 Armin Wolf <W_Armin@gmx.de> + */ + +#include <linux/acpi.h> +#include <linux/device.h> +#include <linux/errno.h> +#include <linux/export.h> +#include <linux/input.h> +#include <linux/input/sparse-keymap.h> +#include <linux/mod_devicetable.h> +#include <linux/module.h> +#include <linux/mutex.h> +#include <linux/notifier.h> +#include <linux/printk.h> +#include <linux/slab.h> +#include <linux/types.h> +#include <linux/wmi.h> + +#include "uniwill-wmi.h" + +#define DRIVER_NAME "uniwill-wmi" +#define UNIWILL_EVENT_GUID "ABBC0F72-8EA1-11D1-00A0-C90629100000" + +struct uniwill_wmi_data { + struct mutex input_lock; /* Protects input sequence during notify */ + struct input_dev *input_device; +}; + +static BLOCKING_NOTIFIER_HEAD(uniwill_wmi_chain_head); + +static const struct key_entry uniwill_wmi_keymap[] = { + /* Reported via keyboard controller */ + { KE_IGNORE, UNIWILL_OSD_CAPSLOCK, { KEY_CAPSLOCK }}, + { KE_IGNORE, UNIWILL_OSD_NUMLOCK, { KEY_NUMLOCK }}, + + /* Reported when the user locks/unlocks the super key */ + { KE_IGNORE, UNIWILL_OSD_SUPER_KEY_LOCK_ENABLE, { KEY_UNKNOWN }}, + { KE_IGNORE, UNIWILL_OSD_SUPER_KEY_LOCK_DISABLE, { KEY_UNKNOWN }}, + + /* Reported in manual mode when toggling the airplane mode status */ + { KE_KEY, UNIWILL_OSD_RFKILL, { KEY_RFKILL }}, + + /* Reported when user wants to cycle the platform profile */ + { KE_IGNORE, UNIWILL_OSD_PERFORMANCE_MODE_TOGGLE, { KEY_UNKNOWN }}, + + /* Reported when the user wants to adjust the brightness of the keyboard */ + { KE_KEY, UNIWILL_OSD_KBDILLUMDOWN, { KEY_KBDILLUMDOWN }}, + { KE_KEY, UNIWILL_OSD_KBDILLUMUP, { KEY_KBDILLUMUP }}, + + /* Reported when the user wants to toggle the microphone mute status */ + { KE_KEY, UNIWILL_OSD_MIC_MUTE, { KEY_MICMUTE }}, + + /* Reported when the user locks/unlocks the Fn key */ + { KE_IGNORE, UNIWILL_OSD_FN_LOCK, { KEY_FN_ESC }}, + + /* Reported when the user wants to toggle the brightness of the keyboard */ + { KE_KEY, UNIWILL_OSD_KBDILLUMTOGGLE, { KEY_KBDILLUMTOGGLE }}, + + /* FIXME: find out the exact meaning of those events */ + { KE_IGNORE, UNIWILL_OSD_BAT_CHARGE_FULL_24_H, { KEY_UNKNOWN }}, + { KE_IGNORE, UNIWILL_OSD_BAT_ERM_UPDATE, { KEY_UNKNOWN }}, + + /* Reported when the user wants to toggle the benchmark mode status */ + { KE_IGNORE, UNIWILL_OSD_BENCHMARK_MODE_TOGGLE, { KEY_UNKNOWN }}, + + { KE_END } +}; + +int uniwill_wmi_register_notifier(struct notifier_block *nb) +{ + return blocking_notifier_chain_register(&uniwill_wmi_chain_head, nb); +} +EXPORT_SYMBOL_NS_GPL(uniwill_wmi_register_notifier, "UNIWILL"); + +int uniwill_wmi_unregister_notifier(struct notifier_block *nb) +{ + return blocking_notifier_chain_unregister(&uniwill_wmi_chain_head, nb); +} +EXPORT_SYMBOL_NS_GPL(uniwill_wmi_unregister_notifier, "UNIWILL"); + +static void devm_uniwill_wmi_unregister_notifier(void *data) +{ + struct notifier_block *nb = data; + + uniwill_wmi_unregister_notifier(nb); +} + +int devm_uniwill_wmi_register_notifier(struct device *dev, struct notifier_block *nb) +{ + int ret; + + ret = uniwill_wmi_register_notifier(nb); + if (ret < 0) + return ret; + + return devm_add_action_or_reset(dev, devm_uniwill_wmi_unregister_notifier, nb); +} +EXPORT_SYMBOL_NS_GPL(devm_uniwill_wmi_register_notifier, "UNIWILL"); + +static void uniwill_wmi_notify(struct wmi_device *wdev, union acpi_object *obj) +{ + struct uniwill_wmi_data *data = dev_get_drvdata(&wdev->dev); + u32 value; + int ret; + + if (obj->type != ACPI_TYPE_INTEGER) + return; + + value = obj->integer.value; + + dev_dbg(&wdev->dev, "Received WMI event %u\n", value); + + ret = blocking_notifier_call_chain(&uniwill_wmi_chain_head, value, NULL); + if (ret == NOTIFY_BAD) + return; + + mutex_lock(&data->input_lock); + sparse_keymap_report_event(data->input_device, value, 1, true); + mutex_unlock(&data->input_lock); +} + +static int uniwill_wmi_probe(struct wmi_device *wdev, const void *context) +{ + struct uniwill_wmi_data *data; + int ret; + + data = devm_kzalloc(&wdev->dev, sizeof(*data), GFP_KERNEL); + if (!data) + return -ENOMEM; + + ret = devm_mutex_init(&wdev->dev, &data->input_lock); + if (ret < 0) + return ret; + + dev_set_drvdata(&wdev->dev, data); + + data->input_device = devm_input_allocate_device(&wdev->dev); + if (!data->input_device) + return -ENOMEM; + + ret = sparse_keymap_setup(data->input_device, uniwill_wmi_keymap, NULL); + if (ret < 0) + return ret; + + data->input_device->name = "Uniwill WMI hotkeys"; + data->input_device->phys = "wmi/input0"; + data->input_device->id.bustype = BUS_HOST; + + return input_register_device(data->input_device); +} + +/* + * We cannot fully trust this GUID since Uniwill just copied the WMI GUID + * from the Windows driver example, and others probably did the same. + * + * Because of this we cannot use this WMI GUID for autoloading. + */ +static const struct wmi_device_id uniwill_wmi_id_table[] = { + { UNIWILL_EVENT_GUID, NULL }, + { } +}; + +static struct wmi_driver uniwill_wmi_driver = { + .driver = { + .name = DRIVER_NAME, + .probe_type = PROBE_PREFER_ASYNCHRONOUS, + }, + .id_table = uniwill_wmi_id_table, + .probe = uniwill_wmi_probe, + .notify = uniwill_wmi_notify, + .no_singleton = true, +}; +module_wmi_driver(uniwill_wmi_driver); + +MODULE_AUTHOR("Armin Wolf <W_Armin@gmx.de>"); +MODULE_DESCRIPTION("Uniwill notebook hotkey driver"); +MODULE_LICENSE("GPL"); diff --git a/drivers/platform/x86/uniwill/uniwill-wmi.h b/drivers/platform/x86/uniwill/uniwill-wmi.h new file mode 100644 index 000000000000..f6dd610d49eb --- /dev/null +++ b/drivers/platform/x86/uniwill/uniwill-wmi.h @@ -0,0 +1,122 @@ +/* SPDX-License-Identifier: GPL-2.0-or-later */ +/* + * Linux hotkey driver for Uniwill notebooks. + * + * Copyright (C) 2025 Armin Wolf <W_Armin@gmx.de> + */ + +#ifndef UNIWILL_WMI_H +#define UNIWILL_WMI_H + +#define UNIWILL_OSD_CAPSLOCK 0x01 +#define UNIWILL_OSD_NUMLOCK 0x02 +#define UNIWILL_OSD_SCROLLLOCK 0x03 + +#define UNIWILL_OSD_TOUCHPAD_ON 0x04 +#define UNIWILL_OSD_TOUCHPAD_OFF 0x05 + +#define UNIWILL_OSD_SILENT_MODE_ON 0x06 +#define UNIWILL_OSD_SILENT_MODE_OFF 0x07 + +#define UNIWILL_OSD_WLAN_ON 0x08 +#define UNIWILL_OSD_WLAN_OFF 0x09 + +#define UNIWILL_OSD_WIMAX_ON 0x0A +#define UNIWILL_OSD_WIMAX_OFF 0x0B + +#define UNIWILL_OSD_BLUETOOTH_ON 0x0C +#define UNIWILL_OSD_BLUETOOTH_OFF 0x0D + +#define UNIWILL_OSD_RF_ON 0x0E +#define UNIWILL_OSD_RF_OFF 0x0F + +#define UNIWILL_OSD_3G_ON 0x10 +#define UNIWILL_OSD_3G_OFF 0x11 + +#define UNIWILL_OSD_WEBCAM_ON 0x12 +#define UNIWILL_OSD_WEBCAM_OFF 0x13 + +#define UNIWILL_OSD_BRIGHTNESSUP 0x14 +#define UNIWILL_OSD_BRIGHTNESSDOWN 0x15 + +#define UNIWILL_OSD_RADIOON 0x1A +#define UNIWILL_OSD_RADIOOFF 0x1B + +#define UNIWILL_OSD_POWERSAVE_ON 0x31 +#define UNIWILL_OSD_POWERSAVE_OFF 0x32 + +#define UNIWILL_OSD_MENU 0x34 + +#define UNIWILL_OSD_MUTE 0x35 +#define UNIWILL_OSD_VOLUMEDOWN 0x36 +#define UNIWILL_OSD_VOLUMEUP 0x37 + +#define UNIWILL_OSD_MENU_2 0x38 + +#define UNIWILL_OSD_LIGHTBAR_ON 0x39 +#define UNIWILL_OSD_LIGHTBAR_OFF 0x3A + +#define UNIWILL_OSD_KB_LED_LEVEL0 0x3B +#define UNIWILL_OSD_KB_LED_LEVEL1 0x3C +#define UNIWILL_OSD_KB_LED_LEVEL2 0x3D +#define UNIWILL_OSD_KB_LED_LEVEL3 0x3E +#define UNIWILL_OSD_KB_LED_LEVEL4 0x3F + +#define UNIWILL_OSD_SUPER_KEY_LOCK_ENABLE 0x40 +#define UNIWILL_OSD_SUPER_KEY_LOCK_DISABLE 0x41 + +#define UNIWILL_OSD_MENU_JP 0x42 + +#define UNIWILL_OSD_CAMERA_ON 0x90 +#define UNIWILL_OSD_CAMERA_OFF 0x91 + +#define UNIWILL_OSD_RFKILL 0xA4 + +#define UNIWILL_OSD_SUPER_KEY_LOCK_CHANGED 0xA5 + +#define UNIWILL_OSD_LIGHTBAR_STATE_CHANGED 0xA6 + +#define UNIWILL_OSD_FAN_BOOST_STATE_CHANGED 0xA7 + +#define UNIWILL_OSD_LCD_SW 0xA9 + +#define UNIWILL_OSD_FAN_OVERTEMP 0xAA + +#define UNIWILL_OSD_DC_ADAPTER_CHANGED 0xAB + +#define UNIWILL_OSD_BAT_HP_OFF 0xAC + +#define UNIWILL_OSD_FAN_DOWN_TEMP 0xAD + +#define UNIWILL_OSD_BATTERY_ALERT 0xAE + +#define UNIWILL_OSD_TIMAP_HAIERLB_SW 0xAF + +#define UNIWILL_OSD_PERFORMANCE_MODE_TOGGLE 0xB0 + +#define UNIWILL_OSD_KBDILLUMDOWN 0xB1 +#define UNIWILL_OSD_KBDILLUMUP 0xB2 + +#define UNIWILL_OSD_BACKLIGHT_LEVEL_CHANGE 0xB3 +#define UNIWILL_OSD_BACKLIGHT_POWER_CHANGE 0xB4 + +#define UNIWILL_OSD_MIC_MUTE 0xB7 + +#define UNIWILL_OSD_FN_LOCK 0xB8 +#define UNIWILL_OSD_KBDILLUMTOGGLE 0xB9 + +#define UNIWILL_OSD_BAT_CHARGE_FULL_24_H 0xBE + +#define UNIWILL_OSD_BAT_ERM_UPDATE 0xBF + +#define UNIWILL_OSD_BENCHMARK_MODE_TOGGLE 0xC0 + +#define UNIWILL_OSD_KBD_BACKLIGHT_CHANGED 0xF0 + +struct notifier_block; + +int uniwill_wmi_register_notifier(struct notifier_block *nb); +int uniwill_wmi_unregister_notifier(struct notifier_block *nb); +int devm_uniwill_wmi_register_notifier(struct device *dev, struct notifier_block *nb); + +#endif /* UNIWILL_WMI_H */ -- 2.39.5 ^ permalink raw reply related [flat|nested] 11+ messages in thread
* Re: [External] : [PATCH 1/3] platform/x86: Add Uniwill WMI driver 2025-07-12 11:23 ` [PATCH 1/3] platform/x86: Add Uniwill WMI driver Armin Wolf @ 2025-07-12 11:46 ` ALOK TIWARI 2025-07-16 16:37 ` Armin Wolf 0 siblings, 1 reply; 11+ messages in thread From: ALOK TIWARI @ 2025-07-12 11:46 UTC (permalink / raw) To: Armin Wolf, ilpo.jarvinen, hdegoede, chumuzero, corbet, cs, wse, ggo Cc: linux-doc, linux-kernel, platform-driver-x86, rdunlap, linux-leds, lee, pobrn > + /* Reported when the user locks/unlocks the super key */ > + { KE_IGNORE, UNIWILL_OSD_SUPER_KEY_LOCK_ENABLE, { KEY_UNKNOWN }}, > + { KE_IGNORE, UNIWILL_OSD_SUPER_KEY_LOCK_DISABLE, { KEY_UNKNOWN }}, > + > + /* Reported in manual mode when toggling the airplane mode status */ > + { KE_KEY, UNIWILL_OSD_RFKILL, { KEY_RFKILL }}, > + > + /* Reported when user wants to cycle the platform profile */ > + { KE_IGNORE, UNIWILL_OSD_PERFORMANCE_MODE_TOGGLE, { KEY_UNKNOWN }}, > + > + /* Reported when the user wants to adjust the brightness of the keyboard */ remove extra " " after keyboard > + { KE_KEY, UNIWILL_OSD_KBDILLUMDOWN, { KEY_KBDILLUMDOWN }}, > + { KE_KEY, UNIWILL_OSD_KBDILLUMUP, { KEY_KBDILLUMUP }}, > + > + /* Reported when the user wants to toggle the microphone mute status */ > + { KE_KEY, UNIWILL_OSD_MIC_MUTE, { KEY_MICMUTE }}, > + > + /* Reported when the user locks/unlocks the Fn key */ > + { KE_IGNORE, UNIWILL_OSD_FN_LOCK, { KEY_FN_ESC }}, > + > + /* Reported when the user wants to toggle the brightness of the keyboard */ Thanks, Alok ^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: [External] : [PATCH 1/3] platform/x86: Add Uniwill WMI driver 2025-07-12 11:46 ` [External] : " ALOK TIWARI @ 2025-07-16 16:37 ` Armin Wolf 0 siblings, 0 replies; 11+ messages in thread From: Armin Wolf @ 2025-07-16 16:37 UTC (permalink / raw) To: ALOK TIWARI, ilpo.jarvinen, hdegoede, chumuzero, corbet, cs, wse, ggo Cc: linux-doc, linux-kernel, platform-driver-x86, rdunlap, linux-leds, lee, pobrn Am 12.07.25 um 13:46 schrieb ALOK TIWARI: > >> + /* Reported when the user locks/unlocks the super key */ >> + { KE_IGNORE, UNIWILL_OSD_SUPER_KEY_LOCK_ENABLE, { >> KEY_UNKNOWN }}, >> + { KE_IGNORE, UNIWILL_OSD_SUPER_KEY_LOCK_DISABLE, { >> KEY_UNKNOWN }}, >> + >> + /* Reported in manual mode when toggling the airplane mode >> status */ >> + { KE_KEY, UNIWILL_OSD_RFKILL, { KEY_RFKILL }}, >> + >> + /* Reported when user wants to cycle the platform profile */ >> + { KE_IGNORE, UNIWILL_OSD_PERFORMANCE_MODE_TOGGLE, { >> KEY_UNKNOWN }}, >> + >> + /* Reported when the user wants to adjust the brightness of the >> keyboard */ > > remove extra " " after keyboard Will do. Thanks, Armin Wolf > >> + { KE_KEY, UNIWILL_OSD_KBDILLUMDOWN, { KEY_KBDILLUMDOWN }}, >> + { KE_KEY, UNIWILL_OSD_KBDILLUMUP, { KEY_KBDILLUMUP >> }}, >> + >> + /* Reported when the user wants to toggle the microphone mute >> status */ >> + { KE_KEY, UNIWILL_OSD_MIC_MUTE, { KEY_MICMUTE }}, >> + >> + /* Reported when the user locks/unlocks the Fn key */ >> + { KE_IGNORE, UNIWILL_OSD_FN_LOCK, { KEY_FN_ESC }}, >> + >> + /* Reported when the user wants to toggle the brightness of the >> keyboard */ > > > Thanks, > Alok > ^ permalink raw reply [flat|nested] 11+ messages in thread
* [PATCH 2/3] platform/x86: Add Uniwill laptop driver 2025-07-12 11:23 [PATCH 0/3] platform/x86: Add support for Uniwill laptop features Armin Wolf 2025-07-12 11:23 ` [PATCH 1/3] platform/x86: Add Uniwill WMI driver Armin Wolf @ 2025-07-12 11:23 ` Armin Wolf 2025-07-12 12:31 ` [External] : " ALOK TIWARI 2025-07-13 2:56 ` kernel test robot 2025-07-12 11:23 ` [PATCH 3/3] Documentation: laptops: Add documentation for uniwill laptops Armin Wolf 2 siblings, 2 replies; 11+ messages in thread From: Armin Wolf @ 2025-07-12 11:23 UTC (permalink / raw) To: ilpo.jarvinen, hdegoede, chumuzero, corbet, cs, wse, ggo Cc: linux-doc, linux-kernel, platform-driver-x86, rdunlap, alok.a.tiwari, linux-leds, lee, pobrn Add a new driver for Uniwill laptops. The driver uses a ACPI WMI interface to talk with the embedded controller, but relies on a DMI whitelist for autoloading since Uniwill just copied the WMI GUID from the Windows driver example. The driver is reverse-engineered based on the following information: - OEM software from intel - https://github.com/pobrn/qc71_laptop - https://gitlab.com/tuxedocomputers/development/packages/tuxedo-drivers - https://github.com/tuxedocomputers/tuxedo-control-center The underlying EC supports various features, including hwmon sensors, battery charge limiting, a RGB lightbar and keyboard-related controls. Reported-by: cyear <chumuzero@gmail.com> Closes: https://github.com/lm-sensors/lm-sensors/issues/508 Closes: https://github.com/Wer-Wolf/uniwill-laptop/issues/3 Signed-off-by: Armin Wolf <W_Armin@gmx.de> --- .../ABI/testing/sysfs-driver-uniwill-laptop | 53 + Documentation/wmi/devices/uniwill-laptop.rst | 118 ++ MAINTAINERS | 8 + drivers/platform/x86/uniwill/Kconfig | 17 + drivers/platform/x86/uniwill/Makefile | 1 + drivers/platform/x86/uniwill/uniwill-laptop.c | 1481 +++++++++++++++++ drivers/platform/x86/uniwill/uniwill-wmi.c | 3 +- 7 files changed, 1680 insertions(+), 1 deletion(-) create mode 100644 Documentation/ABI/testing/sysfs-driver-uniwill-laptop create mode 100644 Documentation/wmi/devices/uniwill-laptop.rst create mode 100644 drivers/platform/x86/uniwill/uniwill-laptop.c diff --git a/Documentation/ABI/testing/sysfs-driver-uniwill-laptop b/Documentation/ABI/testing/sysfs-driver-uniwill-laptop new file mode 100644 index 000000000000..7a540a7b9f24 --- /dev/null +++ b/Documentation/ABI/testing/sysfs-driver-uniwill-laptop @@ -0,0 +1,53 @@ +What: /sys/bus/wmi/devices/ABBC0F6F-8EA1-11D1-00A0-C90629100000[-X]/fn_lock +Date: June 2025 +KernelVersion: 6.17 +Contact: Armin Wolf <W_Armin@gmx.de> +Description: + Allows userspace applications to enable/disable the FN lock feature + of the integrated keyboard by writing "enable"/"disable" into this file. + + Reading this file returns the current enable status of the FN lock functionality. + +What: /sys/bus/wmi/devices/ABBC0F6F-8EA1-11D1-00A0-C90629100000[-X]/super_key_lock +Date: June 2025 +KernelVersion: 6.17 +Contact: Armin Wolf <W_Armin@gmx.de> +Description: + Allows userspace applications to enable/disable the super key functionality + of the integrated keyboard by writing "enable"/"disable" into this file. + + Reading this file returns the current enable status of the super key functionality. + +What: /sys/bus/wmi/devices/ABBC0F6F-8EA1-11D1-00A0-C90629100000[-X]/touchpad_toggle +Date: June 2025 +KernelVersion: 6.17 +Contact: Armin Wolf <W_Armin@gmx.de> +Description: + Allows userspace applications to enable/disable the touchpad toggle functionality + of the integrated touchpad by writing "enable"/"disable" into this file. + + Reading this file returns the current enable status of the touchpad toggle + functionality. + +What: /sys/bus/wmi/devices/ABBC0F6F-8EA1-11D1-00A0-C90629100000[-X]/rainbow_animation +Date: June 2025 +KernelVersion: 6.17 +Contact: Armin Wolf <W_Armin@gmx.de> +Description: + Forces the integrated lightbar to display a rainbow animation when the machine + is not suspended. Writing "enable"/"disable" into this file enables/disables + this functionality. + + Reading this file returns the current status of the rainbow animation functionality. + +What: /sys/bus/wmi/devices/ABBC0F6F-8EA1-11D1-00A0-C90629100000[-X]/breathing_in_suspend +Date: June 2025 +KernelVersion: 6.17 +Contact: Armin Wolf <W_Armin@gmx.de> +Description: + Causes the integrated lightbar to display a breathing animation when the machine + has been suspended and is running on AC power. Writing "enable"/"disable" into + this file enables/disables this functionality. + + Reading this file returns the current status of the breathing animation + functionality. diff --git a/Documentation/wmi/devices/uniwill-laptop.rst b/Documentation/wmi/devices/uniwill-laptop.rst new file mode 100644 index 000000000000..77a544b91f9e --- /dev/null +++ b/Documentation/wmi/devices/uniwill-laptop.rst @@ -0,0 +1,118 @@ +.. SPDX-License-Identifier: GPL-2.0-or-later + +============================================ +Uniwill WMI Notebook driver (uniwill-laptop) +============================================ + +Introduction +============ + +Many notebooks manufactured by Uniwill (either directly or as ODM) provide a WMI-based +EC interface for controlling various platform settings like sensors and fan control. +This interface is used by the ``uniwill-laptop`` driver to map those features onto standard +kernel interfaces. + +WMI interface description +========================= + +The WMI interface description can be decoded from the embedded binary MOF (bmof) +data using the `bmfdec <https://github.com/pali/bmfdec>`_ utility: + +:: + + [WMI, Dynamic, Provider("WmiProv"), Locale("MS\\0x409"), + Description("Class used to operate methods on a ULong"), + guid("{ABBC0F6F-8EA1-11d1-00A0-C90629100000}")] + class AcpiTest_MULong { + [key, read] string InstanceName; + [read] boolean Active; + + [WmiMethodId(1), Implemented, read, write, Description("Return the contents of a ULong")] + void GetULong([out, Description("Ulong Data")] uint32 Data); + + [WmiMethodId(2), Implemented, read, write, Description("Set the contents of a ULong")] + void SetULong([in, Description("Ulong Data")] uint32 Data); + + [WmiMethodId(3), Implemented, read, write, + Description("Generate an event containing ULong data")] + void FireULong([in, Description("WMI requires a parameter")] uint32 Hack); + + [WmiMethodId(4), Implemented, read, write, Description("Get and Set the contents of a ULong")] + void GetSetULong([in, Description("Ulong Data")] uint64 Data, + [out, Description("Ulong Data")] uint32 Return); + + [WmiMethodId(5), Implemented, read, write, + Description("Get and Set the contents of a ULong for Dollby button")] + void GetButton([in, Description("Ulong Data")] uint64 Data, + [out, Description("Ulong Data")] uint32 Return); + }; + +Most of the WMI-related code was copied from the Windows driver samples, which unfortunately means +that the WMI-GUID is not unique. This makes the WMI-GUID unusable for autoloading. + +WMI method GetULong() +--------------------- + +This WMI method was copied from the Windows driver samples and has no function. + +WMI method SetULong() +--------------------- + +This WMI method was copied from the Windows driver samples and has no function. + +WMI method FireULong() +---------------------- + +This WMI method allows to inject a WMI event with a 32-bit payload. Its primary purpose seems +to be debugging. + +WMI method GetSetULong() +------------------------ + +This WMI method is used to communicate with the EC. The ``Data`` argument hold the following +information (starting with the least significant byte): + +1. 16-bit address +2. 16-bit data (set to ``0x0000`` when reading) +3. 16-bit operation (``0x0100`` for reading and ``0x0000`` for writing) +4. 16-bit reserved (set to ``0x0000``) + +The first 8 bits of the ``Return`` value contain the data returned by the EC when reading. +The special value ``0xFEFEFEFE`` is used to indicate a communication failure with the EC. + +WMI method GetButton() +---------------------- + +This WMI method is not implemented on all machines and has an unknown purpose. + +Relation with the ``INOU0000`` ACPI device +========================================== + +It seems that many of the embedded controller registers can also be accessed by using the ``ECRR`` +and ``ECRW`` ACPI control methods under the ``INOU0000`` ACPI device. This sidesteps the overhead +of the WMI interface but does not work for the registers in the range between ``0x1800`` and +``0x18FF``. More research is needed to determine whether this interface imposes addtional +restrictions. + +Reverse-Engineering the Uniwill WMI interface +============================================= + +.. warning:: Randomly poking the EC can potentially cause damage to the machine and other unwanted + side effects, please be careful. + +The EC behind the ``GetSetULong`` method is used by the OEM software supplied by the manufacturer. +Reverse-engineering of this software is difficult since it uses an obfuscator, however some parts +are not obfuscated. In this case `dnSpy <https://github.com/dnSpy/dnSpy>`_ could also be helpful. + +The EC can be accessed under Windows using powershell (requires admin privileges): + +:: + + > $obj = Get-CimInstance -Namespace root/wmi -ClassName AcpiTest_MULong | Select-Object -First 1 + > Invoke-CimMethod -InputObject $obj -MethodName GetSetULong -Arguments @{Data = <input>} + +Special thanks go to github user `pobrn` which developed the +`qc71_laptop <https://github.com/pobrn/qc71_laptop>`_ driver on which this driver is partly based. +The same is true for Tuxedo Computers, which developed the +`tuxedo-drivers <https://gitlab.com/tuxedocomputers/development/packages/tuxedo-drivers>`_ package +which also served as a foundation for this driver. diff --git a/MAINTAINERS b/MAINTAINERS index 6c5879bd2ba2..3efec7a99262 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -25490,6 +25490,14 @@ L: linux-scsi@vger.kernel.org S: Maintained F: drivers/ufs/host/ufs-renesas.c +UNIWILL LAPTOP DRIVER +M: Armin Wolf <W_Armin@gmx.de> +L: platform-driver-x86@vger.kernel.org +S: Maintained +F: Documentation/ABI/testing/sysfs-driver-uniwill-laptop +F: Documentation/wmi/devices/uniwill-laptop.rst +F: drivers/platform/x86/uniwill/uniwill-laptop.c + UNIWILL WMI DRIVER M: Armin Wolf <W_Armin@gmx.de> L: platform-driver-x86@vger.kernel.org diff --git a/drivers/platform/x86/uniwill/Kconfig b/drivers/platform/x86/uniwill/Kconfig index 7571b30edb11..46d9af52b3f2 100644 --- a/drivers/platform/x86/uniwill/Kconfig +++ b/drivers/platform/x86/uniwill/Kconfig @@ -16,6 +16,23 @@ menuconfig X86_PLATFORM_DRIVERS_UNIWILL if X86_PLATFORM_DRIVERS_UNIWILL +config UNIWILL_LAPTOP + tristate "Uniwill Laptop Extras" + default m + depends on ACPI_WMI + depends on ACPI_BATTERY + depends on UNIWILL_WMI + depends on HWMON + depends on LEDS_CLASS_MULTICOLOR + depends on DMI + select REGMAP + help + This driver adds support for various extra features found on Uniwill laptops, + like the lightbar and hwmon sensors. It also supports many OEM laptops + originally manufactured by Uniwill. + + If you have such a laptop, say Y or M here. + config UNIWILL_WMI tristate "Uniwill WMI Event Driver" default m diff --git a/drivers/platform/x86/uniwill/Makefile b/drivers/platform/x86/uniwill/Makefile index a5a300be63f3..b55169a49e1e 100644 --- a/drivers/platform/x86/uniwill/Makefile +++ b/drivers/platform/x86/uniwill/Makefile @@ -4,4 +4,5 @@ # Uniwill X86 Platform Specific Drivers # +obj-$(CONFIG_UNIWILL_LAPTOP) += uniwill-laptop.o obj-$(CONFIG_UNIWILL_WMI) += uniwill-wmi.o diff --git a/drivers/platform/x86/uniwill/uniwill-laptop.c b/drivers/platform/x86/uniwill/uniwill-laptop.c new file mode 100644 index 000000000000..141c58673525 --- /dev/null +++ b/drivers/platform/x86/uniwill/uniwill-laptop.c @@ -0,0 +1,1481 @@ +// SPDX-License-Identifier: GPL-2.0-or-later +/* + * Linux driver for Uniwill notebooks. + * + * Special thanks go to Pőcze Barnabás, Christoffer Sandberg and Werner Sembach + * for supporting the development of this driver either through prior work or + * by answering questions regarding the underlying WMI interface. + * + * Copyright (C) 2025 Armin Wolf <W_Armin@gmx.de> + */ + +#define pr_format(fmt) KBUILD_MODNAME ": " fmt + +#include <linux/acpi.h> +#include <linux/bits.h> +#include <linux/bitfield.h> +#include <linux/cleanup.h> +#include <linux/debugfs.h> +#include <linux/device.h> +#include <linux/device/driver.h> +#include <linux/dmi.h> +#include <linux/errno.h> +#include <linux/fixp-arith.h> +#include <linux/hwmon.h> +#include <linux/hwmon-sysfs.h> +#include <linux/init.h> +#include <linux/kernel.h> +#include <linux/kstrtox.h> +#include <linux/leds.h> +#include <linux/led-class-multicolor.h> +#include <linux/limits.h> +#include <linux/list.h> +#include <linux/minmax.h> +#include <linux/module.h> +#include <linux/mutex.h> +#include <linux/notifier.h> +#include <linux/pm.h> +#include <linux/printk.h> +#include <linux/regmap.h> +#include <linux/string.h> +#include <linux/string_choices.h> +#include <linux/sysfs.h> +#include <linux/types.h> +#include <linux/unaligned.h> +#include <linux/units.h> +#include <linux/wmi.h> + +#include <acpi/battery.h> + +#include "uniwill-wmi.h" + +#define EC_ADDR_BAT_POWER_UNIT_1 0x0400 + +#define EC_ADDR_BAT_POWER_UNIT_2 0x0401 + +#define EC_ADDR_BAT_DESIGN_CAPACITY_1 0x0402 + +#define EC_ADDR_BAT_DESIGN_CAPACITY_2 0x0403 + +#define EC_ADDR_BAT_FULL_CAPACITY_1 0x0404 + +#define EC_ADDR_BAT_FULL_CAPACITY_2 0x0405 + +#define EC_ADDR_BAT_DESIGN_VOLTAGE_1 0x0408 + +#define EC_ADDR_BAT_DESIGN_VOLTAGE_2 0x0409 + +#define EC_ADDR_BAT_STATUS_1 0x0432 +#define BAT_DISCHARGING BIT(0) + +#define EC_ADDR_BAT_STATUS_2 0x0433 + +#define EC_ADDR_BAT_CURRENT_1 0x0434 + +#define EC_ADDR_BAT_CURRENT_2 0x0435 + +#define EC_ADDR_BAT_REMAIN_CAPACITY_1 0x0436 + +#define EC_ADDR_BAT_REMAIN_CAPACITY_2 0x0437 + +#define EC_ADDR_BAT_VOLTAGE_1 0x0438 + +#define EC_ADDR_BAT_VOLTAGE_2 0x0439 + +#define EC_ADDR_CPU_TEMP 0x043E + +#define EC_ADDR_GPU_TEMP 0x044F + +#define EC_ADDR_MAIN_FAN_RPM_1 0x0464 + +#define EC_ADDR_MAIN_FAN_RPM_2 0x0465 + +#define EC_ADDR_SECOND_FAN_RPM_1 0x046C + +#define EC_ADDR_SECOND_FAN_RPM_2 0x046D + +#define EC_ADDR_DEVICE_STATUS 0x047B +#define WIFI_STATUS_ON BIT(7) +/* BIT(5) is also unset depending on the rfkill state (bluetooth?) */ + +#define EC_ADDR_BAT_ALERT 0x0494 + +#define EC_ADDR_BAT_CYCLE_COUNT_1 0x04A6 + +#define EC_ADDR_BAT_CYCLE_COUNT_2 0x04A7 + +#define EC_ADDR_PROJECT_ID 0x0740 + +#define EC_ADDR_AP_OEM 0x0741 +#define ENABLE_MANUAL_CTRL BIT(0) +#define ITE_KBD_EFFECT_REACTIVE BIT(3) +#define FAN_ABNORMAL BIT(5) + +#define EC_ADDR_SUPPORT_5 0x0742 +#define FAN_TURBO_SUPPORTED BIT(4) +#define FAN_SUPPORT BIT(5) + +#define EC_ADDR_CTGP_DB_CTRL 0x0743 +#define CTGP_DB_GENERAL_ENABLE BIT(0) +#define CTGP_DB_DB_ENABLE BIT(1) +#define CTGP_DB_CTGP_ENABLE BIT(2) + +#define EC_ADDR_CTGP_OFFSET 0x0744 + +#define EC_ADDR_TPP_OFFSET 0x0745 + +#define EC_ADDR_MAX_TGP 0x0746 + +#define EC_ADDR_LIGHTBAR_AC_CTRL 0x0748 +#define LIGHTBAR_APP_EXISTS BIT(0) +#define LIGHTBAR_POWER_SAVE BIT(1) +#define LIGHTBAR_S0_OFF BIT(2) +#define LIGHTBAR_S3_OFF BIT(3) // Breathing animation when suspended +#define LIGHTBAR_WELCOME BIT(7) // Rainbow animation + +#define EC_ADDR_LIGHTBAR_AC_RED 0x0749 + +#define EC_ADDR_LIGHTBAR_AC_GREEN 0x074A + +#define EC_ADDR_LIGHTBAR_AC_BLUE 0x074B + +#define EC_ADDR_BIOS_OEM 0x074E +#define FN_LOCK_STATUS BIT(4) + +#define EC_ADDR_MANUAL_FAN_CTRL 0x0751 +#define FAN_LEVEL_MASK GENMASK(2, 0) +#define FAN_MODE_TURBO BIT(4) +#define FAN_MODE_HIGH BIT(5) +#define FAN_MODE_BOOST BIT(6) +#define FAN_MODE_USER BIT(7) + +#define EC_ADDR_PWM_1 0x075B + +#define EC_ADDR_PWM_2 0x075C + +/* Unreliable */ +#define EC_ADDR_SUPPORT_1 0x0765 +#define AIRPLANE_MODE BIT(0) +#define GPS_SWITCH BIT(1) +#define OVERCLOCK BIT(2) +#define MACRO_KEY BIT(3) +#define SHORTCUT_KEY BIT(4) +#define SUPER_KEY_LOCK BIT(5) +#define LIGHTBAR BIT(6) +#define FAN_BOOST BIT(7) + +#define EC_ADDR_SUPPORT_2 0x0766 +#define SILENT_MODE BIT(0) +#define USB_CHARGING BIT(1) +#define RGB_KEYBOARD BIT(2) +#define CHINA_MODE BIT(5) +#define MY_BATTERY BIT(6) + +#define EC_ADDR_TRIGGER 0x0767 +#define TRIGGER_SUPER_KEY_LOCK BIT(0) +#define TRIGGER_LIGHTBAR BIT(1) +#define TRIGGER_FAN_BOOST BIT(2) +#define TRIGGER_SILENT_MODE BIT(3) +#define TRIGGER_USB_CHARGING BIT(4) +#define RGB_APPLY_COLOR BIT(5) +#define RGB_LOGO_EFFECT BIT(6) +#define RGB_RAINBOW_EFFECT BIT(7) + +#define EC_ADDR_SWITCH_STATUS 0x0768 +#define SUPER_KEY_LOCK_STATUS BIT(0) +#define LIGHTBAR_STATUS BIT(1) +#define FAN_BOOST_STATUS BIT(2) +#define MACRO_KEY_STATUS BIT(3) +#define MY_BAT_POWER_BAT_STATUS BIT(4) + +#define EC_ADDR_RGB_RED 0x0769 + +#define EC_ADDR_RGB_GREEN 0x076A + +#define EC_ADDR_RGB_BLUE 0x076B + +#define EC_ADDR_ROMID_START 0x0770 +#define ROMID_LENGTH 14 + +#define EC_ADDR_ROMID_EXTRA_1 0x077E + +#define EC_ADDR_ROMID_EXTRA_2 0x077F + +#define EC_ADDR_BIOS_OEM_2 0x0782 +#define FAN_V2_NEW BIT(0) +#define FAN_QKEY BIT(1) +#define FAN_TABLE_OFFICE_MODE BIT(2) +#define FAN_V3 BIT(3) +#define DEFAULT_MODE BIT(4) + +#define EC_ADDR_PL1_SETTING 0x0783 + +#define EC_ADDR_PL2_SETTING 0x0784 + +#define EC_ADDR_PL4_SETTING 0x0785 + +#define EC_ADDR_FAN_DEFAULT 0x0786 +#define FAN_CURVE_LENGTH 5 + +#define EC_ADDR_KBD_STATUS 0x078C +#define KBD_WHITE_ONLY BIT(0) // ~single color +#define KBD_SINGLE_COLOR_OFF BIT(1) +#define KBD_TURBO_LEVEL_MASK GENMASK(3, 2) +#define KBD_APPLY BIT(4) +#define KBD_BRIGHTNESS GENMASK(7, 5) + +#define EC_ADDR_FAN_CTRL 0x078E +#define FAN3P5 BIT(1) +#define CHARGING_PROFILE BIT(3) +#define UNIVERSAL_FAN_CTRL BIT(6) + +#define EC_ADDR_BIOS_OEM_3 0x07A3 +#define FAN_REDUCED_DURY_CYCLE BIT(5) +#define FAN_ALWAYS_ON BIT(6) + +#define EC_ADDR_BIOS_BYTE 0x07A4 +#define FN_LOCK_SWITCH BIT(3) + +#define EC_ADDR_OEM_3 0x07A5 +#define POWER_LED_MASK GENMASK(1, 0) +#define POWER_LED_LEFT 0x00 +#define POWER_LED_BOTH 0x01 +#define POWER_LED_NONE 0x02 +#define FAN_QUIET BIT(2) +#define OVERBOOST BIT(4) +#define HIGH_POWER BIT(7) + +#define EC_ADDR_OEM_4 0x07A6 +#define OVERBOOST_DYN_TEMP_OFF BIT(1) +#define TOUCHPAD_TOGGLE_OFF BIT(6) + +#define EC_ADDR_CHARGE_CTRL 0x07B9 +#define CHARGE_CTRL_MASK GENMASK(6, 0) +#define CHARGE_CTRL_REACHED BIT(7) + +#define EC_ADDR_UNIVERSAL_FAN_CTRL 0x07C5 +#define SPLIT_TABLES BIT(7) + +#define EC_ADDR_AP_OEM_6 0x07C6 +#define ENABLE_UNIVERSAL_FAN_CTRL BIT(2) +#define BATTERY_CHARGE_FULL_OVER_24H BIT(3) +#define BATTERY_ERM_STATUS_REACHED BIT(4) + +#define EC_ADDR_CHARGE_PRIO 0x07CC +#define CHARGING_PERFORMANCE BIT(7) + +/* Same bits as EC_ADDR_LIGHTBAR_AC_CTRL except LIGHTBAR_S3_OFF */ +#define EC_ADDR_LIGHTBAR_BAT_CTRL 0x07E2 + +#define EC_ADDR_LIGHTBAR_BAT_RED 0x07E3 + +#define EC_ADDR_LIGHTBAR_BAT_GREEN 0x07E4 + +#define EC_ADDR_LIGHTBAR_BAT_BLUE 0x07E5 + +#define EC_ADDR_CPU_TEMP_END_TABLE 0x0F00 + +#define EC_ADDR_CPU_TEMP_START_TABLE 0x0F10 + +#define EC_ADDR_CPU_FAN_SPEED_TABLE 0x0F20 + +#define EC_ADDR_GPU_TEMP_END_TABLE 0x0F30 + +#define EC_ADDR_GPU_TEMP_START_TABLE 0x0F40 + +#define EC_ADDR_GPU_FAN_SPEED_TABLE 0x0F50 + +/* + * Those two registers technically allow for manual fan control, + * but are unstable on some models and are likely not meant to + * be used by applications. + */ +#define EC_ADDR_PWM_1_WRITEABLE 0x1804 + +#define EC_ADDR_PWM_2_WRITEABLE 0x1809 + +#define DRIVER_NAME "uniwill" +#define UNIWILL_GUID "ABBC0F6F-8EA1-11D1-00A0-C90629100000" + +#define PWM_MAX 200 +#define FAN_TABLE_LENGTH 16 + +#define LED_CHANNELS 3 +#define LED_MAX_BRIGHTNESS 200 + +#define UNIWILL_FEATURE_FN_LOCK BIT(0) +#define UNIWILL_FEATURE_SUPER_KEY_LOCK BIT(1) +#define UNIWILL_FEATURE_TOUCHPAD_TOGGLE BIT(2) +#define UNIWILL_FEATURE_LIGHTBAR BIT(3) +#define UNIWILL_FEATURE_BATTERY BIT(4) +#define UNIWILL_FEATURE_HWMON BIT(5) + +enum uniwill_method { + UNIWILL_GET_ULONG = 0x01, + UNIWILL_SET_ULONG = 0x02, + UNIWILL_FIRE_ULONG = 0x03, + UNIWILL_GET_SET_ULONG = 0x04, + UNIWILL_GET_BUTTON = 0x05, +}; + +struct uniwill_method_buffer { + __le16 address; + __le16 data; + __le16 operation; + __le16 reserved; +} __packed; + +struct uniwill_data { + struct wmi_device *wdev; + struct regmap *regmap; + struct acpi_battery_hook hook; + unsigned int last_charge_ctrl; + struct mutex battery_lock; /* Protects the list of currently registered batteries */ + unsigned int last_switch_status; + struct mutex super_key_lock; /* Protects the toggling of the super key lock state */ + struct list_head batteries; + struct led_classdev_mc led_mc_cdev; + struct mc_subled led_mc_subled_info[LED_CHANNELS]; + struct notifier_block nb; +}; + +struct uniwill_battery_entry { + struct list_head head; + struct power_supply *battery; +}; + +static bool force; +module_param_unsafe(force, bool, 0); +MODULE_PARM_DESC(force, "Force loading without checking for supported devices\n"); + +/* Feature bitmask since the associated registers are not reliable */ +static uintptr_t supported_features; + +/* + * "disable" is placed on index 0 so that the return value of sysfs_match_string() + * directly translates into a boolean value. + */ +static const char * const uniwill_enable_disable_strings[] = { + [0] = "disable", + [1] = "enable", +}; + +static const char * const uniwill_temp_labels[] = { + "CPU", + "GPU", +}; + +static const char * const uniwill_fan_labels[] = { + "Main", + "Secondary", +}; + +static int uniwill_get_set_ulong(struct wmi_device *wdev, struct uniwill_method_buffer *input, + u32 *output) +{ + struct acpi_buffer out = { ACPI_ALLOCATE_BUFFER, NULL }; + struct acpi_buffer in = { + .length = sizeof(*input), + .pointer = input, + }; + union acpi_object *obj; + acpi_status status; + int ret = 0; + + status = wmidev_evaluate_method(wdev, 0x0, UNIWILL_GET_SET_ULONG, &in, &out); + if (ACPI_FAILURE(status)) + return -EIO; + + obj = out.pointer; + if (!obj) + return -ENODATA; + + if (obj->type != ACPI_TYPE_BUFFER) { + ret = -ENOMSG; + goto free_obj; + } + + if (obj->buffer.length < sizeof(*output)) { + ret = -EPROTO; + goto free_obj; + } + + *output = get_unaligned_le32(obj->buffer.pointer); + +free_obj: + kfree(obj); + + return ret; +} + +static int uniwill_ec_reg_write(void *context, unsigned int reg, unsigned int val) +{ + struct uniwill_method_buffer input = { + .address = cpu_to_le16(reg), + .data = cpu_to_le16(val & U8_MAX), + .operation = 0x0000, + }; + struct uniwill_data *data = context; + u32 output; + int ret; + + ret = uniwill_get_set_ulong(data->wdev, &input, &output); + if (ret < 0) + return ret; + + if (output == 0xFEFEFEFE) + return -ENXIO; + + return 0; +} + +static int uniwill_ec_reg_read(void *context, unsigned int reg, unsigned int *val) +{ + struct uniwill_method_buffer input = { + .address = cpu_to_le16(reg), + .data = 0x0000, + .operation = cpu_to_le16(0x0100), + }; + struct uniwill_data *data = context; + u32 output; + int ret; + + ret = uniwill_get_set_ulong(data->wdev, &input, &output); + if (ret < 0) + return ret; + + if (output == 0xFEFEFEFE) + return -ENXIO; + + *val = (u8)output; + + return 0; +} + +static const struct regmap_bus uniwill_ec_bus = { + .reg_write = uniwill_ec_reg_write, + .reg_read = uniwill_ec_reg_read, + .reg_format_endian_default = REGMAP_ENDIAN_LITTLE, + .val_format_endian_default = REGMAP_ENDIAN_LITTLE, +}; + +static bool uniwill_writeable_reg(struct device *dev, unsigned int reg) +{ + switch (reg) { + case EC_ADDR_AP_OEM: + case EC_ADDR_LIGHTBAR_AC_CTRL: + case EC_ADDR_LIGHTBAR_AC_RED: + case EC_ADDR_LIGHTBAR_AC_GREEN: + case EC_ADDR_LIGHTBAR_AC_BLUE: + case EC_ADDR_BIOS_OEM: + case EC_ADDR_TRIGGER: + case EC_ADDR_OEM_4: + case EC_ADDR_CHARGE_CTRL: + case EC_ADDR_LIGHTBAR_BAT_CTRL: + case EC_ADDR_LIGHTBAR_BAT_RED: + case EC_ADDR_LIGHTBAR_BAT_GREEN: + case EC_ADDR_LIGHTBAR_BAT_BLUE: + return true; + default: + return false; + } +} + +static bool uniwill_readable_reg(struct device *dev, unsigned int reg) +{ + switch (reg) { + case EC_ADDR_CPU_TEMP: + case EC_ADDR_GPU_TEMP: + case EC_ADDR_MAIN_FAN_RPM_1: + case EC_ADDR_MAIN_FAN_RPM_2: + case EC_ADDR_SECOND_FAN_RPM_1: + case EC_ADDR_SECOND_FAN_RPM_2: + case EC_ADDR_BAT_ALERT: + case EC_ADDR_PROJECT_ID: + case EC_ADDR_AP_OEM: + case EC_ADDR_LIGHTBAR_AC_CTRL: + case EC_ADDR_LIGHTBAR_AC_RED: + case EC_ADDR_LIGHTBAR_AC_GREEN: + case EC_ADDR_LIGHTBAR_AC_BLUE: + case EC_ADDR_BIOS_OEM: + case EC_ADDR_PWM_1: + case EC_ADDR_PWM_2: + case EC_ADDR_TRIGGER: + case EC_ADDR_SWITCH_STATUS: + case EC_ADDR_OEM_4: + case EC_ADDR_CHARGE_CTRL: + case EC_ADDR_LIGHTBAR_BAT_CTRL: + case EC_ADDR_LIGHTBAR_BAT_RED: + case EC_ADDR_LIGHTBAR_BAT_GREEN: + case EC_ADDR_LIGHTBAR_BAT_BLUE: + return true; + default: + return false; + } +} + +static bool uniwill_volatile_reg(struct device *dev, unsigned int reg) +{ + switch (reg) { + case EC_ADDR_CPU_TEMP: + case EC_ADDR_GPU_TEMP: + case EC_ADDR_MAIN_FAN_RPM_1: + case EC_ADDR_MAIN_FAN_RPM_2: + case EC_ADDR_SECOND_FAN_RPM_1: + case EC_ADDR_SECOND_FAN_RPM_2: + case EC_ADDR_BAT_ALERT: + case EC_ADDR_PWM_1: + case EC_ADDR_PWM_2: + case EC_ADDR_TRIGGER: + case EC_ADDR_SWITCH_STATUS: + case EC_ADDR_CHARGE_CTRL: + return true; + default: + return false; + } +} + +static const struct regmap_config uniwill_ec_config = { + .reg_bits = 16, + .val_bits = 8, + .writeable_reg = uniwill_writeable_reg, + .readable_reg = uniwill_readable_reg, + .volatile_reg = uniwill_volatile_reg, + .can_sleep = true, + .max_register = 0xFFFF, + .cache_type = REGCACHE_MAPLE, + .use_single_read = true, + .use_single_write = true, +}; + +static ssize_t fn_lock_store(struct device *dev, struct device_attribute *attr, const char *buf, + size_t count) +{ + struct uniwill_data *data = dev_get_drvdata(dev); + unsigned int value; + int ret; + + ret = sysfs_match_string(uniwill_enable_disable_strings, buf); + if (ret < 0) + return ret; + + if (ret) + value = FN_LOCK_STATUS; + else + value = 0; + + ret = regmap_update_bits(data->regmap, EC_ADDR_BIOS_OEM, FN_LOCK_STATUS, value); + if (ret < 0) + return ret; + + return count; +} + +static ssize_t fn_lock_show(struct device *dev, struct device_attribute *attr, char *buf) +{ + struct uniwill_data *data = dev_get_drvdata(dev); + unsigned int value; + int ret; + + ret = regmap_read(data->regmap, EC_ADDR_BIOS_OEM, &value); + if (ret < 0) + return ret; + + return sysfs_emit(buf, "%s\n", str_enable_disable(value & FN_LOCK_STATUS)); +} + +static DEVICE_ATTR_RW(fn_lock); + +static ssize_t super_key_lock_store(struct device *dev, struct device_attribute *attr, + const char *buf, size_t count) +{ + struct uniwill_data *data = dev_get_drvdata(dev); + unsigned int value; + int ret; + + ret = sysfs_match_string(uniwill_enable_disable_strings, buf); + if (ret < 0) + return ret; + + guard(mutex)(&data->super_key_lock); + + ret = regmap_read(data->regmap, EC_ADDR_SWITCH_STATUS, &value); + if (ret < 0) + return ret; + + /* + * We can only toggle the super key lock, so we return early if the setting + * is already in the correct state. + */ + if (ret == !(value & SUPER_KEY_LOCK_STATUS)) + return count; + + ret = regmap_write_bits(data->regmap, EC_ADDR_TRIGGER, TRIGGER_SUPER_KEY_LOCK, + TRIGGER_SUPER_KEY_LOCK); + if (ret < 0) + return ret; + + return count; +} + +static ssize_t super_key_lock_show(struct device *dev, struct device_attribute *attr, char *buf) +{ + struct uniwill_data *data = dev_get_drvdata(dev); + unsigned int value; + int ret; + + ret = regmap_read(data->regmap, EC_ADDR_SWITCH_STATUS, &value); + if (ret < 0) + return ret; + + return sysfs_emit(buf, "%s\n", str_enable_disable(!(value & SUPER_KEY_LOCK_STATUS))); +} + +static DEVICE_ATTR_RW(super_key_lock); + +static ssize_t touchpad_toggle_store(struct device *dev, struct device_attribute *attr, + const char *buf, size_t count) +{ + struct uniwill_data *data = dev_get_drvdata(dev); + unsigned int value; + int ret; + + ret = sysfs_match_string(uniwill_enable_disable_strings, buf); + if (ret < 0) + return ret; + + if (ret) + value = 0; + else + value = TOUCHPAD_TOGGLE_OFF; + + ret = regmap_update_bits(data->regmap, EC_ADDR_OEM_4, TOUCHPAD_TOGGLE_OFF, value); + if (ret < 0) + return ret; + + return count; +} + +static ssize_t touchpad_toggle_show(struct device *dev, struct device_attribute *attr, char *buf) +{ + struct uniwill_data *data = dev_get_drvdata(dev); + unsigned int value; + int ret; + + ret = regmap_read(data->regmap, EC_ADDR_OEM_4, &value); + if (ret < 0) + return ret; + + return sysfs_emit(buf, "%s\n", str_enable_disable(!(value & TOUCHPAD_TOGGLE_OFF))); +} + +static DEVICE_ATTR_RW(touchpad_toggle); + +static ssize_t rainbow_animation_store(struct device *dev, struct device_attribute *attr, + const char *buf, size_t count) +{ + struct uniwill_data *data = dev_get_drvdata(dev); + unsigned int value; + int ret; + + ret = sysfs_match_string(uniwill_enable_disable_strings, buf); + if (ret < 0) + return ret; + + if (ret) + value = LIGHTBAR_WELCOME; + else + value = 0; + + ret = regmap_update_bits(data->regmap, EC_ADDR_LIGHTBAR_AC_CTRL, LIGHTBAR_WELCOME, value); + if (ret < 0) + return ret; + + ret = regmap_update_bits(data->regmap, EC_ADDR_LIGHTBAR_BAT_CTRL, LIGHTBAR_WELCOME, value); + if (ret < 0) + return ret; + + return count; +} + +static ssize_t rainbow_animation_show(struct device *dev, struct device_attribute *attr, char *buf) +{ + struct uniwill_data *data = dev_get_drvdata(dev); + unsigned int value; + int ret; + + ret = regmap_read(data->regmap, EC_ADDR_LIGHTBAR_AC_CTRL, &value); + if (ret < 0) + return ret; + + return sysfs_emit(buf, "%s\n", str_enable_disable(value & LIGHTBAR_WELCOME)); +} + +static DEVICE_ATTR_RW(rainbow_animation); + +static ssize_t breathing_in_suspend_store(struct device *dev, struct device_attribute *attr, + const char *buf, size_t count) +{ + struct uniwill_data *data = dev_get_drvdata(dev); + unsigned int value; + int ret; + + ret = sysfs_match_string(uniwill_enable_disable_strings, buf); + if (ret < 0) + return ret; + + if (ret) + value = 0; + else + value = LIGHTBAR_S3_OFF; + + ret = regmap_update_bits(data->regmap, EC_ADDR_LIGHTBAR_AC_CTRL, LIGHTBAR_S3_OFF, value); + if (ret < 0) + return ret; + + return count; +} + +static ssize_t breathing_in_suspend_show(struct device *dev, struct device_attribute *attr, + char *buf) +{ + struct uniwill_data *data = dev_get_drvdata(dev); + unsigned int value; + int ret; + + ret = regmap_read(data->regmap, EC_ADDR_LIGHTBAR_AC_CTRL, &value); + if (ret < 0) + return ret; + + return sysfs_emit(buf, "%s\n", str_enable_disable(!(value & LIGHTBAR_S3_OFF))); +} + +static DEVICE_ATTR_RW(breathing_in_suspend); + +static struct attribute *uniwill_attrs[] = { + /* Keyboard-related */ + &dev_attr_fn_lock.attr, + &dev_attr_super_key_lock.attr, + &dev_attr_touchpad_toggle.attr, + /* Lightbar-related */ + &dev_attr_rainbow_animation.attr, + &dev_attr_breathing_in_suspend.attr, + NULL +}; + +static umode_t uniwill_attr_is_visible(struct kobject *kobj, struct attribute *attr, int n) +{ + if (attr == &dev_attr_fn_lock.attr) { + if (supported_features & UNIWILL_FEATURE_FN_LOCK) + return attr->mode; + } + + if (attr == &dev_attr_super_key_lock.attr) { + if (supported_features & UNIWILL_FEATURE_SUPER_KEY_LOCK) + return attr->mode; + } + + if (attr == &dev_attr_touchpad_toggle.attr) { + if (supported_features & UNIWILL_FEATURE_TOUCHPAD_TOGGLE) + return attr->mode; + } + + if (attr == &dev_attr_rainbow_animation.attr || + attr == &dev_attr_breathing_in_suspend.attr) { + if (supported_features & UNIWILL_FEATURE_LIGHTBAR) + return attr->mode; + } + + return 0; +} + +static const struct attribute_group uniwill_group = { + .is_visible = uniwill_attr_is_visible, + .attrs = uniwill_attrs, +}; + +static const struct attribute_group *uniwill_groups[] = { + &uniwill_group, + NULL +}; + +static int uniwill_read(struct device *dev, enum hwmon_sensor_types type, u32 attr, int channel, + long *val) +{ + struct uniwill_data *data = dev_get_drvdata(dev); + unsigned int value; + __be16 rpm; + int ret; + + switch (type) { + case hwmon_temp: + switch (channel) { + case 0: + ret = regmap_read(data->regmap, EC_ADDR_CPU_TEMP, &value); + break; + case 1: + ret = regmap_read(data->regmap, EC_ADDR_GPU_TEMP, &value); + break; + default: + return -EOPNOTSUPP; + } + + if (ret < 0) + return ret; + + *val = value * MILLIDEGREE_PER_DEGREE; + return 0; + case hwmon_fan: + switch (channel) { + case 0: + ret = regmap_bulk_read(data->regmap, EC_ADDR_MAIN_FAN_RPM_1, &rpm, + sizeof(rpm)); + break; + case 1: + ret = regmap_bulk_read(data->regmap, EC_ADDR_SECOND_FAN_RPM_1, &rpm, + sizeof(rpm)); + break; + default: + return -EOPNOTSUPP; + } + + if (ret < 0) + return ret; + + *val = be16_to_cpu(rpm); + return 0; + case hwmon_pwm: + switch (channel) { + case 0: + ret = regmap_read(data->regmap, EC_ADDR_PWM_1, &value); + break; + case 1: + ret = regmap_read(data->regmap, EC_ADDR_PWM_2, &value); + break; + default: + return -EOPNOTSUPP; + } + + *val = fixp_linear_interpolate(0, 0, PWM_MAX, U8_MAX, value); + return 0; + default: + return -EOPNOTSUPP; + } +} + +static int uniwill_read_string(struct device *dev, enum hwmon_sensor_types type, u32 attr, + int channel, const char **str) +{ + switch (type) { + case hwmon_temp: + *str = uniwill_temp_labels[channel]; + return 0; + case hwmon_fan: + *str = uniwill_fan_labels[channel]; + return 0; + default: + return -EOPNOTSUPP; + } +} + +static const struct hwmon_ops uniwill_ops = { + .visible = 0444, + .read = uniwill_read, + .read_string = uniwill_read_string, +}; + +static const struct hwmon_channel_info * const uniwill_info[] = { + HWMON_CHANNEL_INFO(chip, HWMON_C_REGISTER_TZ), + HWMON_CHANNEL_INFO(temp, + HWMON_T_INPUT | HWMON_T_LABEL, + HWMON_T_INPUT | HWMON_T_LABEL), + HWMON_CHANNEL_INFO(fan, + HWMON_F_INPUT | HWMON_F_LABEL, + HWMON_F_INPUT | HWMON_F_LABEL), + HWMON_CHANNEL_INFO(pwm, + HWMON_PWM_INPUT, + HWMON_PWM_INPUT), + NULL +}; + +static const struct hwmon_chip_info uniwill_chip_info = { + .ops = &uniwill_ops, + .info = uniwill_info, +}; + +static int uniwill_hwmon_init(struct uniwill_data *data) +{ + struct device *hdev; + + if (!(supported_features & UNIWILL_FEATURE_HWMON)) + return 0; + + hdev = devm_hwmon_device_register_with_info(&data->wdev->dev, "uniwill", data, + &uniwill_chip_info, NULL); + + return PTR_ERR_OR_ZERO(hdev); +} + +static const unsigned int uniwill_led_channel_to_bat_reg[LED_CHANNELS] = { + EC_ADDR_LIGHTBAR_BAT_RED, + EC_ADDR_LIGHTBAR_BAT_GREEN, + EC_ADDR_LIGHTBAR_BAT_BLUE, +}; + +static const unsigned int uniwill_led_channel_to_ac_reg[LED_CHANNELS] = { + EC_ADDR_LIGHTBAR_AC_RED, + EC_ADDR_LIGHTBAR_AC_GREEN, + EC_ADDR_LIGHTBAR_AC_BLUE, +}; + +static int uniwill_led_brightness_set(struct led_classdev *led_cdev, enum led_brightness brightness) +{ + struct led_classdev_mc *led_mc_cdev = lcdev_to_mccdev(led_cdev); + struct uniwill_data *data = container_of(led_mc_cdev, struct uniwill_data, led_mc_cdev); + unsigned int value; + int ret; + + ret = led_mc_calc_color_components(led_mc_cdev, brightness); + if (ret < 0) + return ret; + + for (int i = 0; i < LED_CHANNELS; i++) { + /* Prevent the brightness values from overflowing */ + value = min(LED_MAX_BRIGHTNESS, data->led_mc_subled_info[i].brightness); + ret = regmap_write(data->regmap, uniwill_led_channel_to_ac_reg[i], value); + if (ret < 0) + return ret; + + ret = regmap_write(data->regmap, uniwill_led_channel_to_bat_reg[i], value); + if (ret < 0) + return ret; + } + + if (brightness) + value = 0; + else + value = LIGHTBAR_S0_OFF; + + ret = regmap_update_bits(data->regmap, EC_ADDR_LIGHTBAR_AC_CTRL, LIGHTBAR_S0_OFF, value); + if (ret < 0) + return ret; + + return regmap_update_bits(data->regmap, EC_ADDR_LIGHTBAR_BAT_CTRL, LIGHTBAR_S0_OFF, value); +} + +#define LIGHTBAR_MASK (LIGHTBAR_APP_EXISTS | LIGHTBAR_S0_OFF | LIGHTBAR_S3_OFF | LIGHTBAR_WELCOME) + +static int uniwill_led_init(struct uniwill_data *data) +{ + struct led_init_data init_data = { + .devicename = DRIVER_NAME, + .default_label = "multicolor:" LED_FUNCTION_STATUS, + .devname_mandatory = true, + }; + unsigned int color_indices[3] = { + LED_COLOR_ID_RED, + LED_COLOR_ID_GREEN, + LED_COLOR_ID_BLUE, + }; + unsigned int value; + int ret; + + if (!(supported_features & UNIWILL_FEATURE_LIGHTBAR)) + return 0; + + /* + * The EC has separate lightbar settings for AC and battery mode, + * so we have to ensure that both settings are the same. + */ + ret = regmap_read(data->regmap, EC_ADDR_LIGHTBAR_AC_CTRL, &value); + if (ret < 0) + return ret; + + value |= LIGHTBAR_APP_EXISTS; + ret = regmap_write(data->regmap, EC_ADDR_LIGHTBAR_AC_CTRL, value); + if (ret < 0) + return ret; + + /* + * The breathing animation during suspend is not supported when + * running on battery power. + */ + value |= LIGHTBAR_S3_OFF; + ret = regmap_update_bits(data->regmap, EC_ADDR_LIGHTBAR_BAT_CTRL, LIGHTBAR_MASK, value); + if (ret < 0) + return ret; + + data->led_mc_cdev.led_cdev.color = LED_COLOR_ID_MULTI; + data->led_mc_cdev.led_cdev.max_brightness = LED_MAX_BRIGHTNESS; + data->led_mc_cdev.led_cdev.flags = LED_REJECT_NAME_CONFLICT; + data->led_mc_cdev.led_cdev.brightness_set_blocking = uniwill_led_brightness_set; + + if (value & LIGHTBAR_S0_OFF) + data->led_mc_cdev.led_cdev.brightness = 0; + else + data->led_mc_cdev.led_cdev.brightness = LED_MAX_BRIGHTNESS; + + for (int i = 0; i < LED_CHANNELS; i++) { + data->led_mc_subled_info[i].color_index = color_indices[i]; + + ret = regmap_read(data->regmap, uniwill_led_channel_to_ac_reg[i], &value); + if (ret < 0) + return ret; + + /* + * Make sure that the initial intensity value is not greater than + * the maximum brightness. + */ + value = min(LED_MAX_BRIGHTNESS, value); + ret = regmap_write(data->regmap, uniwill_led_channel_to_ac_reg[i], value); + if (ret < 0) + return ret; + + ret = regmap_write(data->regmap, uniwill_led_channel_to_bat_reg[i], value); + if (ret < 0) + return ret; + + data->led_mc_subled_info[i].intensity = value; + data->led_mc_subled_info[i].channel = i; + } + + data->led_mc_cdev.subled_info = data->led_mc_subled_info; + data->led_mc_cdev.num_colors = LED_CHANNELS; + + return devm_led_classdev_multicolor_register_ext(&data->wdev->dev, &data->led_mc_cdev, + &init_data); +} + +static int uniwill_get_property(struct power_supply *psy, const struct power_supply_ext *ext, + void *drvdata, enum power_supply_property psp, + union power_supply_propval *val) +{ + struct uniwill_data *data = drvdata; + union power_supply_propval prop; + unsigned int regval; + int ret; + + switch (psp) { + case POWER_SUPPLY_PROP_HEALTH: + ret = power_supply_get_property_direct(psy, POWER_SUPPLY_PROP_PRESENT, &prop); + if (ret < 0) + return ret; + + if (!prop.intval) { + val->intval = POWER_SUPPLY_HEALTH_NO_BATTERY; + return 0; + } + + ret = power_supply_get_property_direct(psy, POWER_SUPPLY_PROP_STATUS, &prop); + if (ret < 0) + return ret; + + if (prop.intval == POWER_SUPPLY_STATUS_UNKNOWN) { + val->intval = POWER_SUPPLY_HEALTH_UNKNOWN; + return 0; + } + + ret = regmap_read(data->regmap, EC_ADDR_BAT_ALERT, ®val); + if (ret < 0) + return ret; + + if (regval) { + /* Charging issue */ + val->intval = POWER_SUPPLY_HEALTH_UNSPEC_FAILURE; + return 0; + } + + val->intval = POWER_SUPPLY_HEALTH_GOOD; + return 0; + case POWER_SUPPLY_PROP_CHARGE_CONTROL_END_THRESHOLD: + ret = regmap_read(data->regmap, EC_ADDR_CHARGE_CTRL, ®val); + if (ret < 0) + return ret; + + val->intval = clamp_val(FIELD_GET(CHARGE_CTRL_MASK, regval), 0, 100); + return 0; + default: + return -EINVAL; + } +} + +static int uniwill_set_property(struct power_supply *psy, const struct power_supply_ext *ext, + void *drvdata, enum power_supply_property psp, + const union power_supply_propval *val) +{ + struct uniwill_data *data = drvdata; + + switch (psp) { + case POWER_SUPPLY_PROP_CHARGE_CONTROL_END_THRESHOLD: + if (val->intval < 1 || val->intval > 100) + return -EINVAL; + + return regmap_update_bits(data->regmap, EC_ADDR_CHARGE_CTRL, CHARGE_CTRL_MASK, + val->intval); + default: + return -EINVAL; + } +} + +static int uniwill_property_is_writeable(struct power_supply *psy, + const struct power_supply_ext *ext, void *drvdata, + enum power_supply_property psp) +{ + if (psp == POWER_SUPPLY_PROP_CHARGE_CONTROL_END_THRESHOLD) + return true; + + return false; +} + +static const enum power_supply_property uniwill_properties[] = { + POWER_SUPPLY_PROP_HEALTH, + POWER_SUPPLY_PROP_CHARGE_CONTROL_END_THRESHOLD, +}; + +static const struct power_supply_ext uniwill_extension = { + .name = DRIVER_NAME, + .properties = uniwill_properties, + .num_properties = ARRAY_SIZE(uniwill_properties), + .get_property = uniwill_get_property, + .set_property = uniwill_set_property, + .property_is_writeable = uniwill_property_is_writeable, +}; + +static int uniwill_add_battery(struct power_supply *battery, struct acpi_battery_hook *hook) +{ + struct uniwill_data *data = container_of(hook, struct uniwill_data, hook); + struct uniwill_battery_entry *entry; + int ret; + + entry = kzalloc(sizeof(*entry), GFP_KERNEL); + if (!entry) + return -ENOMEM; + + ret = power_supply_register_extension(battery, &uniwill_extension, &data->wdev->dev, data); + if (ret < 0) { + kfree(entry); + return ret; + } + + scoped_guard(mutex, &data->battery_lock) { + entry->battery = battery; + list_add(&entry->head, &data->batteries); + } + + return 0; +} + +static int uniwill_remove_battery(struct power_supply *battery, struct acpi_battery_hook *hook) +{ + struct uniwill_data *data = container_of(hook, struct uniwill_data, hook); + struct uniwill_battery_entry *entry, *tmp; + + scoped_guard(mutex, &data->battery_lock) { + list_for_each_entry_safe(entry, tmp, &data->batteries, head) { + if (entry->battery == battery) { + list_del(&entry->head); + kfree(entry); + break; + } + } + } + + power_supply_unregister_extension(battery, &uniwill_extension); + + return 0; +} + +static int uniwill_battery_init(struct uniwill_data *data) +{ + int ret; + + if (!(supported_features & UNIWILL_FEATURE_BATTERY)) + return 0; + + ret = devm_mutex_init(&data->wdev->dev, &data->battery_lock); + if (ret < 0) + return ret; + + INIT_LIST_HEAD(&data->batteries); + data->hook.name = "Uniwill Battery Extension"; + data->hook.add_battery = uniwill_add_battery; + data->hook.remove_battery = uniwill_remove_battery; + + return devm_battery_hook_register(&data->wdev->dev, &data->hook); +} + +static int uniwill_notifier_call(struct notifier_block *nb, unsigned long action, void *dummy) +{ + struct uniwill_data *data = container_of(nb, struct uniwill_data, nb); + struct uniwill_battery_entry *entry; + + switch (action) { + case UNIWILL_OSD_BATTERY_ALERT: + scoped_guard(mutex, &data->battery_lock) { + list_for_each_entry(entry, &data->batteries, head) { + power_supply_changed(entry->battery); + } + } + + return NOTIFY_OK; + default: + return NOTIFY_DONE; + } +} + +static int uniwill_notifier_init(struct uniwill_data *data) +{ + data->nb.notifier_call = uniwill_notifier_call; + + return devm_uniwill_wmi_register_notifier(&data->wdev->dev, &data->nb); +} + +static void uniwill_disable_manual_control(void *context) +{ + struct uniwill_data *data = context; + + regmap_clear_bits(data->regmap, EC_ADDR_AP_OEM, ENABLE_MANUAL_CTRL); +} + +static int uniwill_ec_init(struct uniwill_data *data) +{ + unsigned int value; + int ret; + + ret = regmap_read(data->regmap, EC_ADDR_PROJECT_ID, &value); + if (ret < 0) + return ret; + + dev_dbg(&data->wdev->dev, "Project ID: %u\n", value); + + ret = regmap_set_bits(data->regmap, EC_ADDR_AP_OEM, ENABLE_MANUAL_CTRL); + if (ret < 0) + return ret; + + return devm_add_action_or_reset(&data->wdev->dev, uniwill_disable_manual_control, data); +} + +static int uniwill_probe(struct wmi_device *wdev, const void *context) +{ + struct uniwill_data *data; + struct regmap *regmap; + int ret; + + data = devm_kzalloc(&wdev->dev, sizeof(*data), GFP_KERNEL); + if (!data) + return -ENOMEM; + + data->wdev = wdev; + dev_set_drvdata(&wdev->dev, data); + + regmap = devm_regmap_init(&wdev->dev, &uniwill_ec_bus, data, &uniwill_ec_config); + if (IS_ERR(regmap)) + return PTR_ERR(regmap); + + data->regmap = regmap; + ret = devm_mutex_init(&wdev->dev, &data->super_key_lock); + if (ret < 0) + return ret; + + ret = uniwill_ec_init(data); + if (ret < 0) + return ret; + + ret = uniwill_battery_init(data); + if (ret < 0) + return ret; + + ret = uniwill_led_init(data); + if (ret < 0) + return ret; + + ret = uniwill_hwmon_init(data); + if (ret < 0) + return ret; + + return uniwill_notifier_init(data); +} + +static void uniwill_shutdown(struct wmi_device *wdev) +{ + struct uniwill_data *data = dev_get_drvdata(&wdev->dev); + + regmap_clear_bits(data->regmap, EC_ADDR_AP_OEM, ENABLE_MANUAL_CTRL); +} + +static int uniwill_suspend_keyboard(struct uniwill_data *data) +{ + if (!(supported_features & UNIWILL_FEATURE_SUPER_KEY_LOCK)) + return 0; + + /* + * The EC_ADDR_SWITCH_STATUS is maked as volatile, so we have to restore it + * ourself. + */ + return regmap_read(data->regmap, EC_ADDR_SWITCH_STATUS, &data->last_switch_status); +} + +static int uniwill_suspend_battery(struct uniwill_data *data) +{ + if (!(supported_features & UNIWILL_FEATURE_BATTERY)) + return 0; + + /* + * Save the current charge limit in order to restore it during resume. + * We cannot use the regmap code for that since this register needs to + * be declared as volatile due to CHARGE_CTRL_REACHED. + */ + return regmap_read(data->regmap, EC_ADDR_CHARGE_CTRL, &data->last_charge_ctrl); +} + +static int uniwill_suspend(struct device *dev) +{ + struct uniwill_data *data = dev_get_drvdata(dev); + int ret; + + ret = uniwill_suspend_keyboard(data); + if (ret < 0) + return ret; + + ret = uniwill_suspend_battery(data); + if (ret < 0) + return ret; + + regcache_cache_only(data->regmap, true); + regcache_mark_dirty(data->regmap); + + return 0; +} + +static int uniwill_resume_keyboard(struct uniwill_data *data) +{ + unsigned int value; + int ret; + + if (!(supported_features & UNIWILL_FEATURE_SUPER_KEY_LOCK)) + return 0; + + ret = regmap_read(data->regmap, EC_ADDR_SWITCH_STATUS, &value); + if (ret < 0) + return ret; + + if ((data->last_switch_status & SUPER_KEY_LOCK_STATUS) == (value & SUPER_KEY_LOCK_STATUS)) + return 0; + + return regmap_write_bits(data->regmap, EC_ADDR_TRIGGER, TRIGGER_SUPER_KEY_LOCK, + TRIGGER_SUPER_KEY_LOCK); +} + +static int uniwill_resume_battery(struct uniwill_data *data) +{ + if (!(supported_features & UNIWILL_FEATURE_BATTERY)) + return 0; + + return regmap_update_bits(data->regmap, EC_ADDR_CHARGE_CTRL, CHARGE_CTRL_MASK, + data->last_charge_ctrl); +} + +static int uniwill_resume(struct device *dev) +{ + struct uniwill_data *data = dev_get_drvdata(dev); + int ret; + + regcache_cache_only(data->regmap, false); + + ret = regcache_sync(data->regmap); + if (ret < 0) + return ret; + + ret = uniwill_resume_keyboard(data); + if (ret < 0) + return ret; + + return uniwill_resume_battery(data); +} + +static DEFINE_SIMPLE_DEV_PM_OPS(uniwill_pm_ops, uniwill_suspend, uniwill_resume); + +/* + * We cannot fully trust this GUID since Uniwill just copied the WMI GUID + * from the Windows driver example, and others probably did the same. + * + * Because of this we cannot use this WMI GUID for autoloading. + */ +static const struct wmi_device_id uniwill_id_table[] = { + { UNIWILL_GUID, NULL }, + { } +}; + +static struct wmi_driver uniwill_driver = { + .driver = { + .name = DRIVER_NAME, + .dev_groups = uniwill_groups, + .probe_type = PROBE_PREFER_ASYNCHRONOUS, + .pm = pm_sleep_ptr(&uniwill_pm_ops), + }, + .id_table = uniwill_id_table, + .probe = uniwill_probe, + .shutdown = uniwill_shutdown, + .no_singleton = true, +}; + +static const struct dmi_system_id uniwill_dmi_table[] __initconst = { + { + .ident = "Intel NUC x15", + .matches = { + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Intel(R) Client Systems"), + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "LAPAC71H"), + }, + .driver_data = (void *)(UNIWILL_FEATURE_FN_LOCK | + UNIWILL_FEATURE_SUPER_KEY_LOCK | + UNIWILL_FEATURE_TOUCHPAD_TOGGLE | + UNIWILL_FEATURE_BATTERY | + UNIWILL_FEATURE_HWMON), + }, + { + .ident = "Intel NUC x15", + .matches = { + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Intel(R) Client Systems"), + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "LAPKC71F"), + }, + .driver_data = (void *)(UNIWILL_FEATURE_FN_LOCK | + UNIWILL_FEATURE_SUPER_KEY_LOCK | + UNIWILL_FEATURE_TOUCHPAD_TOGGLE | + UNIWILL_FEATURE_LIGHTBAR | + UNIWILL_FEATURE_BATTERY | + UNIWILL_FEATURE_HWMON), + }, + { } +}; +MODULE_DEVICE_TABLE(dmi, uniwill_dmi_table); + +static int __init uniwill_init(void) +{ + const struct dmi_system_id *id; + + id = dmi_first_match(uniwill_dmi_table); + if (!id) { + if (!force) + return -ENODEV; + + /* Assume that the device supports all features */ + supported_features = UINTPTR_MAX; + pr_warn("Loading on a potentially unsupported device\n"); + } else { + supported_features = (uintptr_t)id->driver_data; + } + + return wmi_driver_register(&uniwill_driver); +} +module_init(uniwill_init); + +static void __exit uniwill_exit(void) +{ + wmi_driver_unregister(&uniwill_driver); +} +module_exit(uniwill_exit); + +MODULE_AUTHOR("Armin Wolf <W_Armin@gmx.de>"); +MODULE_DESCRIPTION("Uniwill notebook driver"); +MODULE_LICENSE("GPL"); +MODULE_IMPORT_NS("UNIWILL"); diff --git a/drivers/platform/x86/uniwill/uniwill-wmi.c b/drivers/platform/x86/uniwill/uniwill-wmi.c index f38e4bbcd8b6..65700121ef52 100644 --- a/drivers/platform/x86/uniwill/uniwill-wmi.c +++ b/drivers/platform/x86/uniwill/uniwill-wmi.c @@ -161,7 +161,8 @@ static int uniwill_wmi_probe(struct wmi_device *wdev, const void *context) * We cannot fully trust this GUID since Uniwill just copied the WMI GUID * from the Windows driver example, and others probably did the same. * - * Because of this we cannot use this WMI GUID for autoloading. + * Because of this we cannot use this WMI GUID for autoloading. The uniwill-laptop + * driver will instead load this module as a dependency. */ static const struct wmi_device_id uniwill_wmi_id_table[] = { { UNIWILL_EVENT_GUID, NULL }, -- 2.39.5 ^ permalink raw reply related [flat|nested] 11+ messages in thread
* Re: [External] : [PATCH 2/3] platform/x86: Add Uniwill laptop driver 2025-07-12 11:23 ` [PATCH 2/3] platform/x86: Add Uniwill laptop driver Armin Wolf @ 2025-07-12 12:31 ` ALOK TIWARI 2025-07-16 16:47 ` Armin Wolf 2025-07-13 2:56 ` kernel test robot 1 sibling, 1 reply; 11+ messages in thread From: ALOK TIWARI @ 2025-07-12 12:31 UTC (permalink / raw) To: Armin Wolf, ilpo.jarvinen, hdegoede, chumuzero, corbet, cs, wse, ggo Cc: linux-doc, linux-kernel, platform-driver-x86, rdunlap, linux-leds, lee, pobrn On 7/12/2025 4:53 PM, Armin Wolf wrote: > Add a new driver for Uniwill laptops. The driver uses a ACPI WMI > interface to talk with the embedded controller, but relies on a > DMI whitelist for autoloading since Uniwill just copied the WMI > GUID from the Windows driver example. > > The driver is reverse-engineered based on the following information: > - OEM software from intel > - https://urldefense.com/v3/__https://github.com/pobrn/qc71_laptop__;!!ACWV5N9M2RV99hQ!PYW0bhvxAIvo5Q628_nWz3JpVFEvKWLr7b7gsh_jVvTEAgryiLemldZWYQTMNVOlQHLFfZWCJ4XSA0Zht1c$ > - https://urldefense.com/v3/__https://gitlab.com/tuxedocomputers/development/packages/tuxedo-drivers__;!!ACWV5N9M2RV99hQ!PYW0bhvxAIvo5Q628_nWz3JpVFEvKWLr7b7gsh_jVvTEAgryiLemldZWYQTMNVOlQHLFfZWCJ4XSlSKbZG4$ > - https://urldefense.com/v3/__https://github.com/tuxedocomputers/tuxedo-control-center__;!!ACWV5N9M2RV99hQ!PYW0bhvxAIvo5Q628_nWz3JpVFEvKWLr7b7gsh_jVvTEAgryiLemldZWYQTMNVOlQHLFfZWCJ4XSGW2eamI$ > > The underlying EC supports various features, including hwmon sensors, > battery charge limiting, a RGB lightbar and keyboard-related controls. > > Reported-by: cyear <chumuzero@gmail.com> > Closes: https://urldefense.com/v3/__https://github.com/lm-sensors/lm-sensors/issues/508__;!!ACWV5N9M2RV99hQ!PYW0bhvxAIvo5Q628_nWz3JpVFEvKWLr7b7gsh_jVvTEAgryiLemldZWYQTMNVOlQHLFfZWCJ4XSUXC3pPE$ > Closes: https://urldefense.com/v3/__https://github.com/Wer-Wolf/uniwill-laptop/issues/3__;!!ACWV5N9M2RV99hQ!PYW0bhvxAIvo5Q628_nWz3JpVFEvKWLr7b7gsh_jVvTEAgryiLemldZWYQTMNVOlQHLFfZWCJ4XS1sL_cIM$ > Signed-off-by: Armin Wolf <W_Armin@gmx.de> > --- > .../ABI/testing/sysfs-driver-uniwill-laptop | 53 + > Documentation/wmi/devices/uniwill-laptop.rst | 118 ++ > MAINTAINERS | 8 + > drivers/platform/x86/uniwill/Kconfig | 17 + > drivers/platform/x86/uniwill/Makefile | 1 + > drivers/platform/x86/uniwill/uniwill-laptop.c | 1481 +++++++++++++++++ > drivers/platform/x86/uniwill/uniwill-wmi.c | 3 +- > 7 files changed, 1680 insertions(+), 1 deletion(-) > create mode 100644 Documentation/ABI/testing/sysfs-driver-uniwill-laptop > create mode 100644 Documentation/wmi/devices/uniwill-laptop.rst > create mode 100644 drivers/platform/x86/uniwill/uniwill-laptop.c > > diff --git a/Documentation/ABI/testing/sysfs-driver-uniwill-laptop b/Documentation/ABI/testing/sysfs-driver-uniwill-laptop > new file mode 100644 > index 000000000000..7a540a7b9f24 > --- /dev/null > +++ b/Documentation/ABI/testing/sysfs-driver-uniwill-laptop > @@ -0,0 +1,53 @@ > +What: /sys/bus/wmi/devices/ABBC0F6F-8EA1-11D1-00A0-C90629100000[-X]/fn_lock > +Date: June 2025 > +KernelVersion: 6.17 > +Contact: Armin Wolf <W_Armin@gmx.de> > +Description: > + Allows userspace applications to enable/disable the FN lock feature > + of the integrated keyboard by writing "enable"/"disable" into this file. > + > + Reading this file returns the current enable status of the FN lock functionality. > + > +What: /sys/bus/wmi/devices/ABBC0F6F-8EA1-11D1-00A0-C90629100000[-X]/super_key_lock > +Date: June 2025 > +KernelVersion: 6.17 > +Contact: Armin Wolf <W_Armin@gmx.de> > +Description: > + Allows userspace applications to enable/disable the super key functionality > + of the integrated keyboard by writing "enable"/"disable" into this file. > + > + Reading this file returns the current enable status of the super key functionality. > + > +What: /sys/bus/wmi/devices/ABBC0F6F-8EA1-11D1-00A0-C90629100000[-X]/touchpad_toggle > +Date: June 2025 > +KernelVersion: 6.17 > +Contact: Armin Wolf <W_Armin@gmx.de> > +Description: > + Allows userspace applications to enable/disable the touchpad toggle functionality > + of the integrated touchpad by writing "enable"/"disable" into this file. > + > + Reading this file returns the current enable status of the touchpad toggle > + functionality. > + > +What: /sys/bus/wmi/devices/ABBC0F6F-8EA1-11D1-00A0-C90629100000[-X]/rainbow_animation > +Date: June 2025 > +KernelVersion: 6.17 > +Contact: Armin Wolf <W_Armin@gmx.de> > +Description: > + Forces the integrated lightbar to display a rainbow animation when the machine > + is not suspended. Writing "enable"/"disable" into this file enables/disables > + this functionality. > + > + Reading this file returns the current status of the rainbow animation functionality. > + > +What: /sys/bus/wmi/devices/ABBC0F6F-8EA1-11D1-00A0-C90629100000[-X]/breathing_in_suspend > +Date: June 2025 > +KernelVersion: 6.17 > +Contact: Armin Wolf <W_Armin@gmx.de> > +Description: > + Causes the integrated lightbar to display a breathing animation when the machine > + has been suspended and is running on AC power. Writing "enable"/"disable" into > + this file enables/disables this functionality. > + > + Reading this file returns the current status of the breathing animation > + functionality. > diff --git a/Documentation/wmi/devices/uniwill-laptop.rst b/Documentation/wmi/devices/uniwill-laptop.rst > new file mode 100644 > index 000000000000..77a544b91f9e > --- /dev/null > +++ b/Documentation/wmi/devices/uniwill-laptop.rst > @@ -0,0 +1,118 @@ > +.. SPDX-License-Identifier: GPL-2.0-or-later > + > +============================================ > +Uniwill WMI Notebook driver (uniwill-laptop) > +============================================ > + > +Introduction > +============ > + > +Many notebooks manufactured by Uniwill (either directly or as ODM) provide a WMI-based > +EC interface for controlling various platform settings like sensors and fan control. > +This interface is used by the ``uniwill-laptop`` driver to map those features onto standard > +kernel interfaces. > + > +WMI interface description > +========================= > + > +The WMI interface description can be decoded from the embedded binary MOF (bmof) > +data using the `bmfdec <https://urldefense.com/v3/__https://github.com/pali/bmfdec__;!!ACWV5N9M2RV99hQ!PYW0bhvxAIvo5Q628_nWz3JpVFEvKWLr7b7gsh_jVvTEAgryiLemldZWYQTMNVOlQHLFfZWCJ4XS_REL1dI$ >`_ utility: > + > +:: > + > + [WMI, Dynamic, Provider("WmiProv"), Locale("MS\\0x409"), > + Description("Class used to operate methods on a ULong"), > + guid("{ABBC0F6F-8EA1-11d1-00A0-C90629100000}")] > + class AcpiTest_MULong { > + [key, read] string InstanceName; > + [read] boolean Active; > + > + [WmiMethodId(1), Implemented, read, write, Description("Return the contents of a ULong")] > + void GetULong([out, Description("Ulong Data")] uint32 Data); > + > + [WmiMethodId(2), Implemented, read, write, Description("Set the contents of a ULong")] > + void SetULong([in, Description("Ulong Data")] uint32 Data); > + > + [WmiMethodId(3), Implemented, read, write, > + Description("Generate an event containing ULong data")] > + void FireULong([in, Description("WMI requires a parameter")] uint32 Hack); > + > + [WmiMethodId(4), Implemented, read, write, Description("Get and Set the contents of a ULong")] > + void GetSetULong([in, Description("Ulong Data")] uint64 Data, > + [out, Description("Ulong Data")] uint32 Return); > + > + [WmiMethodId(5), Implemented, read, write, > + Description("Get and Set the contents of a ULong for Dollby button")] > + void GetButton([in, Description("Ulong Data")] uint64 Data, > + [out, Description("Ulong Data")] uint32 Return); > + }; > + > +Most of the WMI-related code was copied from the Windows driver samples, which unfortunately means > +that the WMI-GUID is not unique. This makes the WMI-GUID unusable for autoloading. > + > +WMI method GetULong() > +--------------------- > + > +This WMI method was copied from the Windows driver samples and has no function. > + > +WMI method SetULong() > +--------------------- > + > +This WMI method was copied from the Windows driver samples and has no function. > + > +WMI method FireULong() > +---------------------- > + > +This WMI method allows to inject a WMI event with a 32-bit payload. Its primary purpose seems > +to be debugging. > + > +WMI method GetSetULong() > +------------------------ > + > +This WMI method is used to communicate with the EC. The ``Data`` argument hold the following > +information (starting with the least significant byte): > + > +1. 16-bit address > +2. 16-bit data (set to ``0x0000`` when reading) > +3. 16-bit operation (``0x0100`` for reading and ``0x0000`` for writing) > +4. 16-bit reserved (set to ``0x0000``) > + > +The first 8 bits of the ``Return`` value contain the data returned by the EC when reading. > +The special value ``0xFEFEFEFE`` is used to indicate a communication failure with the EC. > + > +WMI method GetButton() > +---------------------- > + > +This WMI method is not implemented on all machines and has an unknown purpose. > + > +Relation with the ``INOU0000`` ACPI device > +========================================== > + > +It seems that many of the embedded controller registers can also be accessed by using the ``ECRR`` > +and ``ECRW`` ACPI control methods under the ``INOU0000`` ACPI device. This sidesteps the overhead > +of the WMI interface but does not work for the registers in the range between ``0x1800`` and > +``0x18FF``. More research is needed to determine whether this interface imposes addtional typo addtional > +restrictions. > + > +Reverse-Engineering the Uniwill WMI interface > +============================================= > + > +.. warning:: Randomly poking the EC can potentially cause damage to the machine and other unwanted > + side effects, please be careful. > + > +The EC behind the ``GetSetULong`` method is used by the OEM software supplied by the manufacturer. > +Reverse-engineering of this software is difficult since it uses an obfuscator, however some parts > +are not obfuscated. In this case `dnSpy <https://urldefense.com/v3/__https://github.com/dnSpy/dnSpy__;!!ACWV5N9M2RV99hQ!PYW0bhvxAIvo5Q628_nWz3JpVFEvKWLr7b7gsh_jVvTEAgryiLemldZWYQTMNVOlQHLFfZWCJ4XSRgqJyGQ$ >`_ could also be helpful. > + > +The EC can be accessed under Windows using powershell (requires admin privileges): > + > +:: > + > + > $obj = Get-CimInstance -Namespace root/wmi -ClassName AcpiTest_MULong | Select-Object -First 1 > + > Invoke-CimMethod -InputObject $obj -MethodName GetSetULong -Arguments @{Data = <input>} > + > +Special thanks go to github user `pobrn` which developed the > +`qc71_laptop <https://urldefense.com/v3/__https://github.com/pobrn/qc71_laptop__;!!ACWV5N9M2RV99hQ!PYW0bhvxAIvo5Q628_nWz3JpVFEvKWLr7b7gsh_jVvTEAgryiLemldZWYQTMNVOlQHLFfZWCJ4XSA0Zht1c$ >`_ driver on which this driver is partly based. > +The same is true for Tuxedo Computers, which developed the > +`tuxedo-drivers <https://urldefense.com/v3/__https://gitlab.com/tuxedocomputers/development/packages/tuxedo-drivers__;!!ACWV5N9M2RV99hQ!PYW0bhvxAIvo5Q628_nWz3JpVFEvKWLr7b7gsh_jVvTEAgryiLemldZWYQTMNVOlQHLFfZWCJ4XSlSKbZG4$ >`_ package > +which also served as a foundation for this driver. > diff --git a/MAINTAINERS b/MAINTAINERS > index 6c5879bd2ba2..3efec7a99262 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -25490,6 +25490,14 @@ L: linux-scsi@vger.kernel.org > S: Maintained > F: drivers/ufs/host/ufs-renesas.c > > +UNIWILL LAPTOP DRIVER > +M: Armin Wolf <W_Armin@gmx.de> > +L: platform-driver-x86@vger.kernel.org > +S: Maintained > +F: Documentation/ABI/testing/sysfs-driver-uniwill-laptop > +F: Documentation/wmi/devices/uniwill-laptop.rst > +F: drivers/platform/x86/uniwill/uniwill-laptop.c > + > UNIWILL WMI DRIVER > M: Armin Wolf <W_Armin@gmx.de> > L: platform-driver-x86@vger.kernel.org > diff --git a/drivers/platform/x86/uniwill/Kconfig b/drivers/platform/x86/uniwill/Kconfig > index 7571b30edb11..46d9af52b3f2 100644 > --- a/drivers/platform/x86/uniwill/Kconfig > +++ b/drivers/platform/x86/uniwill/Kconfig > @@ -16,6 +16,23 @@ menuconfig X86_PLATFORM_DRIVERS_UNIWILL > > if X86_PLATFORM_DRIVERS_UNIWILL > > +config UNIWILL_LAPTOP > + tristate "Uniwill Laptop Extras" > + default m > + depends on ACPI_WMI > + depends on ACPI_BATTERY > + depends on UNIWILL_WMI > + depends on HWMON > + depends on LEDS_CLASS_MULTICOLOR > + depends on DMI > + select REGMAP > + help > + This driver adds support for various extra features found on Uniwill laptops, > + like the lightbar and hwmon sensors. It also supports many OEM laptops > + originally manufactured by Uniwill. > + > + If you have such a laptop, say Y or M here. > + > config UNIWILL_WMI > tristate "Uniwill WMI Event Driver" > default m > diff --git a/drivers/platform/x86/uniwill/Makefile b/drivers/platform/x86/uniwill/Makefile > index a5a300be63f3..b55169a49e1e 100644 > --- a/drivers/platform/x86/uniwill/Makefile > +++ b/drivers/platform/x86/uniwill/Makefile > @@ -4,4 +4,5 @@ > # Uniwill X86 Platform Specific Drivers > # > > +obj-$(CONFIG_UNIWILL_LAPTOP) += uniwill-laptop.o > obj-$(CONFIG_UNIWILL_WMI) += uniwill-wmi.o > diff --git a/drivers/platform/x86/uniwill/uniwill-laptop.c b/drivers/platform/x86/uniwill/uniwill-laptop.c > new file mode 100644 > index 000000000000..141c58673525 > --- /dev/null > +++ b/drivers/platform/x86/uniwill/uniwill-laptop.c > @@ -0,0 +1,1481 @@ > +// SPDX-License-Identifier: GPL-2.0-or-later > +/* > + * Linux driver for Uniwill notebooks. > + * > + * Special thanks go to Pőcze Barnabás, Christoffer Sandberg and Werner Sembach > + * for supporting the development of this driver either through prior work or > + * by answering questions regarding the underlying WMI interface. > + * > + * Copyright (C) 2025 Armin Wolf <W_Armin@gmx.de> > + */ > + > +#define pr_format(fmt) KBUILD_MODNAME ": " fmt > + > +#include <linux/acpi.h> > +#include <linux/bits.h> > +#include <linux/bitfield.h> > +#include <linux/cleanup.h> > +#include <linux/debugfs.h> > +#include <linux/device.h> > +#include <linux/device/driver.h> > +#include <linux/dmi.h> > +#include <linux/errno.h> > +#include <linux/fixp-arith.h> > +#include <linux/hwmon.h> > +#include <linux/hwmon-sysfs.h> > +#include <linux/init.h> > +#include <linux/kernel.h> > +#include <linux/kstrtox.h> > +#include <linux/leds.h> > +#include <linux/led-class-multicolor.h> > +#include <linux/limits.h> > +#include <linux/list.h> > +#include <linux/minmax.h> > +#include <linux/module.h> > +#include <linux/mutex.h> > +#include <linux/notifier.h> > +#include <linux/pm.h> > +#include <linux/printk.h> > +#include <linux/regmap.h> > +#include <linux/string.h> > +#include <linux/string_choices.h> > +#include <linux/sysfs.h> > +#include <linux/types.h> > +#include <linux/unaligned.h> > +#include <linux/units.h> > +#include <linux/wmi.h> > + > +#include <acpi/battery.h> > + > +#include "uniwill-wmi.h" > + > +#define EC_ADDR_BAT_POWER_UNIT_1 0x0400 > + Unnecessary Blank Lines for same logical blocks > +#define EC_ADDR_BAT_POWER_UNIT_2 0x0401 > + > +#define EC_ADDR_BAT_DESIGN_CAPACITY_1 0x0402 > + > +#define EC_ADDR_BAT_DESIGN_CAPACITY_2 0x0403 > + > +#define EC_ADDR_BAT_FULL_CAPACITY_1 0x0404 > + > +#define EC_ADDR_BAT_FULL_CAPACITY_2 0x0405 > + > +#define EC_ADDR_BAT_DESIGN_VOLTAGE_1 0x0408 > + > +#define EC_ADDR_BAT_DESIGN_VOLTAGE_2 0x0409 > + > +#define EC_ADDR_BAT_STATUS_1 0x0432 > +#define BAT_DISCHARGING BIT(0) > + > +#define EC_ADDR_BAT_STATUS_2 0x0433 > + > +#define EC_ADDR_BAT_CURRENT_1 0x0434 > + > +#define EC_ADDR_BAT_CURRENT_2 0x0435 > + > +#define EC_ADDR_BAT_REMAIN_CAPACITY_1 0x0436 > + > +#define EC_ADDR_BAT_REMAIN_CAPACITY_2 0x0437 > + > +#define EC_ADDR_BAT_VOLTAGE_1 0x0438 > + > +#define EC_ADDR_BAT_VOLTAGE_2 0x0439 > + > +#define EC_ADDR_CPU_TEMP 0x043E > + > +#define EC_ADDR_GPU_TEMP 0x044F > + > +#define EC_ADDR_MAIN_FAN_RPM_1 0x0464 > + > +#define EC_ADDR_MAIN_FAN_RPM_2 0x0465 > + > +#define EC_ADDR_SECOND_FAN_RPM_1 0x046C > + > +#define EC_ADDR_SECOND_FAN_RPM_2 0x046D > + > +#define EC_ADDR_DEVICE_STATUS 0x047B > +#define WIFI_STATUS_ON BIT(7) > +/* BIT(5) is also unset depending on the rfkill state (bluetooth?) */ > + > +#define EC_ADDR_BAT_ALERT 0x0494 > + > +#define EC_ADDR_BAT_CYCLE_COUNT_1 0x04A6 > + > +#define EC_ADDR_BAT_CYCLE_COUNT_2 0x04A7 > + > +#define EC_ADDR_PROJECT_ID 0x0740 > + > +#define EC_ADDR_AP_OEM 0x0741 > +#define ENABLE_MANUAL_CTRL BIT(0) > +#define ITE_KBD_EFFECT_REACTIVE BIT(3) > +#define FAN_ABNORMAL BIT(5) > + > +#define EC_ADDR_SUPPORT_5 0x0742 > +#define FAN_TURBO_SUPPORTED BIT(4) > +#define FAN_SUPPORT BIT(5) > + > +#define EC_ADDR_CTGP_DB_CTRL 0x0743 > +#define CTGP_DB_GENERAL_ENABLE BIT(0) > +#define CTGP_DB_DB_ENABLE BIT(1) > +#define CTGP_DB_CTGP_ENABLE BIT(2) > + > +#define EC_ADDR_CTGP_OFFSET 0x0744 > + > +#define EC_ADDR_TPP_OFFSET 0x0745 > + > +#define EC_ADDR_MAX_TGP 0x0746 > + > +#define EC_ADDR_LIGHTBAR_AC_CTRL 0x0748 > +#define LIGHTBAR_APP_EXISTS BIT(0) > +#define LIGHTBAR_POWER_SAVE BIT(1) > +#define LIGHTBAR_S0_OFF BIT(2) > +#define LIGHTBAR_S3_OFF BIT(3) // Breathing animation when suspended > +#define LIGHTBAR_WELCOME BIT(7) // Rainbow animation > + > +#define EC_ADDR_LIGHTBAR_AC_RED 0x0749 > + > +#define EC_ADDR_LIGHTBAR_AC_GREEN 0x074A > + > +#define EC_ADDR_LIGHTBAR_AC_BLUE 0x074B > + > +#define EC_ADDR_BIOS_OEM 0x074E > +#define FN_LOCK_STATUS BIT(4) > + > +#define EC_ADDR_MANUAL_FAN_CTRL 0x0751 > +#define FAN_LEVEL_MASK GENMASK(2, 0) > +#define FAN_MODE_TURBO BIT(4) > +#define FAN_MODE_HIGH BIT(5) > +#define FAN_MODE_BOOST BIT(6) > +#define FAN_MODE_USER BIT(7) > + > +#define EC_ADDR_PWM_1 0x075B > + > +#define EC_ADDR_PWM_2 0x075C > + > +/* Unreliable */ > +#define EC_ADDR_SUPPORT_1 0x0765 > +#define AIRPLANE_MODE BIT(0) > +#define GPS_SWITCH BIT(1) > +#define OVERCLOCK BIT(2) > +#define MACRO_KEY BIT(3) > +#define SHORTCUT_KEY BIT(4) > +#define SUPER_KEY_LOCK BIT(5) > +#define LIGHTBAR BIT(6) > +#define FAN_BOOST BIT(7) > + > +#define EC_ADDR_SUPPORT_2 0x0766 > +#define SILENT_MODE BIT(0) > +#define USB_CHARGING BIT(1) > +#define RGB_KEYBOARD BIT(2) > +#define CHINA_MODE BIT(5) > +#define MY_BATTERY BIT(6) > + > +#define EC_ADDR_TRIGGER 0x0767 > +#define TRIGGER_SUPER_KEY_LOCK BIT(0) > +#define TRIGGER_LIGHTBAR BIT(1) > +#define TRIGGER_FAN_BOOST BIT(2) > +#define TRIGGER_SILENT_MODE BIT(3) > +#define TRIGGER_USB_CHARGING BIT(4) > +#define RGB_APPLY_COLOR BIT(5) > +#define RGB_LOGO_EFFECT BIT(6) > +#define RGB_RAINBOW_EFFECT BIT(7) > + > +#define EC_ADDR_SWITCH_STATUS 0x0768 > +#define SUPER_KEY_LOCK_STATUS BIT(0) > +#define LIGHTBAR_STATUS BIT(1) > +#define FAN_BOOST_STATUS BIT(2) > +#define MACRO_KEY_STATUS BIT(3) > +#define MY_BAT_POWER_BAT_STATUS BIT(4) > + > +#define EC_ADDR_RGB_RED 0x0769 > + > +#define EC_ADDR_RGB_GREEN 0x076A > + > +#define EC_ADDR_RGB_BLUE 0x076B > + > +#define EC_ADDR_ROMID_START 0x0770 > +#define ROMID_LENGTH 14 > + > +#define EC_ADDR_ROMID_EXTRA_1 0x077E > + > +#define EC_ADDR_ROMID_EXTRA_2 0x077F > + > +#define EC_ADDR_BIOS_OEM_2 0x0782 > +#define FAN_V2_NEW BIT(0) > +#define FAN_QKEY BIT(1) > +#define FAN_TABLE_OFFICE_MODE BIT(2) > +#define FAN_V3 BIT(3) > +#define DEFAULT_MODE BIT(4) > + > +#define EC_ADDR_PL1_SETTING 0x0783 > + > +#define EC_ADDR_PL2_SETTING 0x0784 > + > +#define EC_ADDR_PL4_SETTING 0x0785 > + > +#define EC_ADDR_FAN_DEFAULT 0x0786 > +#define FAN_CURVE_LENGTH 5 > + > +#define EC_ADDR_KBD_STATUS 0x078C > +#define KBD_WHITE_ONLY BIT(0) // ~single color > +#define KBD_SINGLE_COLOR_OFF BIT(1) > +#define KBD_TURBO_LEVEL_MASK GENMASK(3, 2) > +#define KBD_APPLY BIT(4) > +#define KBD_BRIGHTNESS GENMASK(7, 5) > + > +#define EC_ADDR_FAN_CTRL 0x078E > +#define FAN3P5 BIT(1) > +#define CHARGING_PROFILE BIT(3) > +#define UNIVERSAL_FAN_CTRL BIT(6) > + > +#define EC_ADDR_BIOS_OEM_3 0x07A3 > +#define FAN_REDUCED_DURY_CYCLE BIT(5) > +#define FAN_ALWAYS_ON BIT(6) > + > +#define EC_ADDR_BIOS_BYTE 0x07A4 > +#define FN_LOCK_SWITCH BIT(3) > + > +#define EC_ADDR_OEM_3 0x07A5 > +#define POWER_LED_MASK GENMASK(1, 0) > +#define POWER_LED_LEFT 0x00 > +#define POWER_LED_BOTH 0x01 > +#define POWER_LED_NONE 0x02 > +#define FAN_QUIET BIT(2) > +#define OVERBOOST BIT(4) > +#define HIGH_POWER BIT(7) > + > +#define EC_ADDR_OEM_4 0x07A6 > +#define OVERBOOST_DYN_TEMP_OFF BIT(1) > +#define TOUCHPAD_TOGGLE_OFF BIT(6) > + > +#define EC_ADDR_CHARGE_CTRL 0x07B9 > +#define CHARGE_CTRL_MASK GENMASK(6, 0) > +#define CHARGE_CTRL_REACHED BIT(7) > + > +#define EC_ADDR_UNIVERSAL_FAN_CTRL 0x07C5 > +#define SPLIT_TABLES BIT(7) > + > +#define EC_ADDR_AP_OEM_6 0x07C6 > +#define ENABLE_UNIVERSAL_FAN_CTRL BIT(2) > +#define BATTERY_CHARGE_FULL_OVER_24H BIT(3) > +#define BATTERY_ERM_STATUS_REACHED BIT(4) > + > +#define EC_ADDR_CHARGE_PRIO 0x07CC > +#define CHARGING_PERFORMANCE BIT(7) > + > +/* Same bits as EC_ADDR_LIGHTBAR_AC_CTRL except LIGHTBAR_S3_OFF */ > +#define EC_ADDR_LIGHTBAR_BAT_CTRL 0x07E2 > + > +#define EC_ADDR_LIGHTBAR_BAT_RED 0x07E3 > + > +#define EC_ADDR_LIGHTBAR_BAT_GREEN 0x07E4 > + > +#define EC_ADDR_LIGHTBAR_BAT_BLUE 0x07E5 > + > +#define EC_ADDR_CPU_TEMP_END_TABLE 0x0F00 > + > +#define EC_ADDR_CPU_TEMP_START_TABLE 0x0F10 > + > +#define EC_ADDR_CPU_FAN_SPEED_TABLE 0x0F20 > + > +#define EC_ADDR_GPU_TEMP_END_TABLE 0x0F30 > + > +#define EC_ADDR_GPU_TEMP_START_TABLE 0x0F40 > + > +#define EC_ADDR_GPU_FAN_SPEED_TABLE 0x0F50 > + > +/* > + * Those two registers technically allow for manual fan control, > + * but are unstable on some models and are likely not meant to > + * be used by applications. > + */ > +#define EC_ADDR_PWM_1_WRITEABLE 0x1804 > + > +#define EC_ADDR_PWM_2_WRITEABLE 0x1809 > + > +#define DRIVER_NAME "uniwill" > +#define UNIWILL_GUID "ABBC0F6F-8EA1-11D1-00A0-C90629100000" > + > +#define PWM_MAX 200 > +#define FAN_TABLE_LENGTH 16 > + > +#define LED_CHANNELS 3 > +#define LED_MAX_BRIGHTNESS 200 > + > +#define UNIWILL_FEATURE_FN_LOCK BIT(0) > +#define UNIWILL_FEATURE_SUPER_KEY_LOCK BIT(1) > +#define UNIWILL_FEATURE_TOUCHPAD_TOGGLE BIT(2) > +#define UNIWILL_FEATURE_LIGHTBAR BIT(3) > +#define UNIWILL_FEATURE_BATTERY BIT(4) > +#define UNIWILL_FEATURE_HWMON BIT(5) > + > +enum uniwill_method { > + UNIWILL_GET_ULONG = 0x01, > + UNIWILL_SET_ULONG = 0x02, > + UNIWILL_FIRE_ULONG = 0x03, > + UNIWILL_GET_SET_ULONG = 0x04, > + UNIWILL_GET_BUTTON = 0x05, > +}; > + > +struct uniwill_method_buffer { > + __le16 address; > + __le16 data; > + __le16 operation; > + __le16 reserved; > +} __packed; > + > +struct uniwill_data { > + struct wmi_device *wdev; > + struct regmap *regmap; > + struct acpi_battery_hook hook; > + unsigned int last_charge_ctrl; > + struct mutex battery_lock; /* Protects the list of currently registered batteries */ > + unsigned int last_switch_status; > + struct mutex super_key_lock; /* Protects the toggling of the super key lock state */ > + struct list_head batteries; > + struct led_classdev_mc led_mc_cdev; > + struct mc_subled led_mc_subled_info[LED_CHANNELS]; > + struct notifier_block nb; > +}; > + > +struct uniwill_battery_entry { > + struct list_head head; > + struct power_supply *battery; > +}; > + > +static bool force; > +module_param_unsafe(force, bool, 0); > +MODULE_PARM_DESC(force, "Force loading without checking for supported devices\n"); > + > +/* Feature bitmask since the associated registers are not reliable */ > +static uintptr_t supported_features; > + > +/* > + * "disable" is placed on index 0 so that the return value of sysfs_match_string() > + * directly translates into a boolean value. > + */ > +static const char * const uniwill_enable_disable_strings[] = { > + [0] = "disable", > + [1] = "enable", > +}; > + > +static const char * const uniwill_temp_labels[] = { > + "CPU", > + "GPU", > +}; > + > +static const char * const uniwill_fan_labels[] = { > + "Main", > + "Secondary", > +}; > + > +static int uniwill_get_set_ulong(struct wmi_device *wdev, struct uniwill_method_buffer *input, > + u32 *output) > +{ > + struct acpi_buffer out = { ACPI_ALLOCATE_BUFFER, NULL }; > + struct acpi_buffer in = { > + .length = sizeof(*input), > + .pointer = input, > + }; > + union acpi_object *obj; > + acpi_status status; > + int ret = 0; > + > + status = wmidev_evaluate_method(wdev, 0x0, UNIWILL_GET_SET_ULONG, &in, &out); > + if (ACPI_FAILURE(status)) > + return -EIO; > + > + obj = out.pointer; > + if (!obj) > + return -ENODATA; > + > + if (obj->type != ACPI_TYPE_BUFFER) { > + ret = -ENOMSG; > + goto free_obj; > + } > + > + if (obj->buffer.length < sizeof(*output)) { > + ret = -EPROTO; > + goto free_obj; > + } > + > + *output = get_unaligned_le32(obj->buffer.pointer); > + > +free_obj: > + kfree(obj); > + > + return ret; > +} > + > +static int uniwill_ec_reg_write(void *context, unsigned int reg, unsigned int val) > +{ > + struct uniwill_method_buffer input = { > + .address = cpu_to_le16(reg), > + .data = cpu_to_le16(val & U8_MAX), > + .operation = 0x0000, > + }; > + struct uniwill_data *data = context; > + u32 output; > + int ret; > + > + ret = uniwill_get_set_ulong(data->wdev, &input, &output); > + if (ret < 0) > + return ret; > + > + if (output == 0xFEFEFEFE) > + return -ENXIO; > + > + return 0; > +} > + > +static int uniwill_ec_reg_read(void *context, unsigned int reg, unsigned int *val) > +{ > + struct uniwill_method_buffer input = { > + .address = cpu_to_le16(reg), > + .data = 0x0000, > + .operation = cpu_to_le16(0x0100), > + }; > + struct uniwill_data *data = context; > + u32 output; > + int ret; > + > + ret = uniwill_get_set_ulong(data->wdev, &input, &output); > + if (ret < 0) > + return ret; > + > + if (output == 0xFEFEFEFE) > + return -ENXIO; > + > + *val = (u8)output; > + > + return 0; > +} > + > +static const struct regmap_bus uniwill_ec_bus = { > + .reg_write = uniwill_ec_reg_write, > + .reg_read = uniwill_ec_reg_read, > + .reg_format_endian_default = REGMAP_ENDIAN_LITTLE, > + .val_format_endian_default = REGMAP_ENDIAN_LITTLE, > +}; > + > +static bool uniwill_writeable_reg(struct device *dev, unsigned int reg) > +{ > + switch (reg) { > + case EC_ADDR_AP_OEM: > + case EC_ADDR_LIGHTBAR_AC_CTRL: > + case EC_ADDR_LIGHTBAR_AC_RED: > + case EC_ADDR_LIGHTBAR_AC_GREEN: > + case EC_ADDR_LIGHTBAR_AC_BLUE: > + case EC_ADDR_BIOS_OEM: > + case EC_ADDR_TRIGGER: > + case EC_ADDR_OEM_4: > + case EC_ADDR_CHARGE_CTRL: > + case EC_ADDR_LIGHTBAR_BAT_CTRL: > + case EC_ADDR_LIGHTBAR_BAT_RED: > + case EC_ADDR_LIGHTBAR_BAT_GREEN: > + case EC_ADDR_LIGHTBAR_BAT_BLUE: > + return true; > + default: > + return false; > + } > +} > + > +static bool uniwill_readable_reg(struct device *dev, unsigned int reg) > +{ > + switch (reg) { > + case EC_ADDR_CPU_TEMP: > + case EC_ADDR_GPU_TEMP: > + case EC_ADDR_MAIN_FAN_RPM_1: > + case EC_ADDR_MAIN_FAN_RPM_2: > + case EC_ADDR_SECOND_FAN_RPM_1: > + case EC_ADDR_SECOND_FAN_RPM_2: > + case EC_ADDR_BAT_ALERT: > + case EC_ADDR_PROJECT_ID: > + case EC_ADDR_AP_OEM: > + case EC_ADDR_LIGHTBAR_AC_CTRL: > + case EC_ADDR_LIGHTBAR_AC_RED: > + case EC_ADDR_LIGHTBAR_AC_GREEN: > + case EC_ADDR_LIGHTBAR_AC_BLUE: > + case EC_ADDR_BIOS_OEM: > + case EC_ADDR_PWM_1: > + case EC_ADDR_PWM_2: > + case EC_ADDR_TRIGGER: > + case EC_ADDR_SWITCH_STATUS: > + case EC_ADDR_OEM_4: > + case EC_ADDR_CHARGE_CTRL: > + case EC_ADDR_LIGHTBAR_BAT_CTRL: > + case EC_ADDR_LIGHTBAR_BAT_RED: > + case EC_ADDR_LIGHTBAR_BAT_GREEN: > + case EC_ADDR_LIGHTBAR_BAT_BLUE: > + return true; > + default: > + return false; > + } > +} > + > +static bool uniwill_volatile_reg(struct device *dev, unsigned int reg) > +{ > + switch (reg) { > + case EC_ADDR_CPU_TEMP: > + case EC_ADDR_GPU_TEMP: > + case EC_ADDR_MAIN_FAN_RPM_1: > + case EC_ADDR_MAIN_FAN_RPM_2: > + case EC_ADDR_SECOND_FAN_RPM_1: > + case EC_ADDR_SECOND_FAN_RPM_2: > + case EC_ADDR_BAT_ALERT: > + case EC_ADDR_PWM_1: > + case EC_ADDR_PWM_2: > + case EC_ADDR_TRIGGER: > + case EC_ADDR_SWITCH_STATUS: > + case EC_ADDR_CHARGE_CTRL: > + return true; > + default: > + return false; > + } > +} > + > +static const struct regmap_config uniwill_ec_config = { > + .reg_bits = 16, > + .val_bits = 8, > + .writeable_reg = uniwill_writeable_reg, > + .readable_reg = uniwill_readable_reg, > + .volatile_reg = uniwill_volatile_reg, > + .can_sleep = true, > + .max_register = 0xFFFF, > + .cache_type = REGCACHE_MAPLE, > + .use_single_read = true, > + .use_single_write = true, > +}; > + > +static ssize_t fn_lock_store(struct device *dev, struct device_attribute *attr, const char *buf, > + size_t count) > +{ > + struct uniwill_data *data = dev_get_drvdata(dev); > + unsigned int value; > + int ret; > + > + ret = sysfs_match_string(uniwill_enable_disable_strings, buf); > + if (ret < 0) > + return ret; > + > + if (ret) > + value = FN_LOCK_STATUS; > + else > + value = 0; > + > + ret = regmap_update_bits(data->regmap, EC_ADDR_BIOS_OEM, FN_LOCK_STATUS, value); > + if (ret < 0) > + return ret; > + > + return count; > +} > + > +static ssize_t fn_lock_show(struct device *dev, struct device_attribute *attr, char *buf) > +{ > + struct uniwill_data *data = dev_get_drvdata(dev); > + unsigned int value; > + int ret; > + > + ret = regmap_read(data->regmap, EC_ADDR_BIOS_OEM, &value); > + if (ret < 0) > + return ret; > + > + return sysfs_emit(buf, "%s\n", str_enable_disable(value & FN_LOCK_STATUS)); > +} > + > +static DEVICE_ATTR_RW(fn_lock); > + > +static ssize_t super_key_lock_store(struct device *dev, struct device_attribute *attr, > + const char *buf, size_t count) > +{ > + struct uniwill_data *data = dev_get_drvdata(dev); > + unsigned int value; > + int ret; > + > + ret = sysfs_match_string(uniwill_enable_disable_strings, buf); > + if (ret < 0) > + return ret; > + > + guard(mutex)(&data->super_key_lock); > + > + ret = regmap_read(data->regmap, EC_ADDR_SWITCH_STATUS, &value); > + if (ret < 0) > + return ret; > + > + /* > + * We can only toggle the super key lock, so we return early if the setting > + * is already in the correct state. > + */ > + if (ret == !(value & SUPER_KEY_LOCK_STATUS)) comparing integer ret with boolean result > + return count; > + > + ret = regmap_write_bits(data->regmap, EC_ADDR_TRIGGER, TRIGGER_SUPER_KEY_LOCK, > + TRIGGER_SUPER_KEY_LOCK); > + if (ret < 0) > + return ret; > + > + return count; > +} > + > +static ssize_t super_key_lock_show(struct device *dev, struct device_attribute *attr, char *buf) > +{ > + struct uniwill_data *data = dev_get_drvdata(dev); > + unsigned int value; > + int ret; > + > + ret = regmap_read(data->regmap, EC_ADDR_SWITCH_STATUS, &value); > + if (ret < 0) > + return ret; > + > + return sysfs_emit(buf, "%s\n", str_enable_disable(!(value & SUPER_KEY_LOCK_STATUS))); > +} > + > +static DEVICE_ATTR_RW(super_key_lock); > + > +static ssize_t touchpad_toggle_store(struct device *dev, struct device_attribute *attr, > + const char *buf, size_t count) > +{ > + struct uniwill_data *data = dev_get_drvdata(dev); > + unsigned int value; > + int ret; > + > + ret = sysfs_match_string(uniwill_enable_disable_strings, buf); > + if (ret < 0) > + return ret; > + > + if (ret) > + value = 0; > + else > + value = TOUCHPAD_TOGGLE_OFF; > + > + ret = regmap_update_bits(data->regmap, EC_ADDR_OEM_4, TOUCHPAD_TOGGLE_OFF, value); > + if (ret < 0) > + return ret; > + > + return count; > +} > + > +static ssize_t touchpad_toggle_show(struct device *dev, struct device_attribute *attr, char *buf) > +{ > + struct uniwill_data *data = dev_get_drvdata(dev); > + unsigned int value; > + int ret; > + > + ret = regmap_read(data->regmap, EC_ADDR_OEM_4, &value); > + if (ret < 0) > + return ret; > + > + return sysfs_emit(buf, "%s\n", str_enable_disable(!(value & TOUCHPAD_TOGGLE_OFF))); > +} > + > +static DEVICE_ATTR_RW(touchpad_toggle); > + > +static ssize_t rainbow_animation_store(struct device *dev, struct device_attribute *attr, > + const char *buf, size_t count) > +{ > + struct uniwill_data *data = dev_get_drvdata(dev); > + unsigned int value; > + int ret; > + > + ret = sysfs_match_string(uniwill_enable_disable_strings, buf); > + if (ret < 0) > + return ret; > + > + if (ret) > + value = LIGHTBAR_WELCOME; > + else > + value = 0; > + > + ret = regmap_update_bits(data->regmap, EC_ADDR_LIGHTBAR_AC_CTRL, LIGHTBAR_WELCOME, value); > + if (ret < 0) > + return ret; > + > + ret = regmap_update_bits(data->regmap, EC_ADDR_LIGHTBAR_BAT_CTRL, LIGHTBAR_WELCOME, value); > + if (ret < 0) > + return ret; > + > + return count; > +} > + > +static ssize_t rainbow_animation_show(struct device *dev, struct device_attribute *attr, char *buf) > +{ > + struct uniwill_data *data = dev_get_drvdata(dev); > + unsigned int value; > + int ret; > + > + ret = regmap_read(data->regmap, EC_ADDR_LIGHTBAR_AC_CTRL, &value); > + if (ret < 0) > + return ret; > + > + return sysfs_emit(buf, "%s\n", str_enable_disable(value & LIGHTBAR_WELCOME)); > +} > + > +static DEVICE_ATTR_RW(rainbow_animation); > + > +static ssize_t breathing_in_suspend_store(struct device *dev, struct device_attribute *attr, > + const char *buf, size_t count) > +{ > + struct uniwill_data *data = dev_get_drvdata(dev); > + unsigned int value; > + int ret; > + > + ret = sysfs_match_string(uniwill_enable_disable_strings, buf); > + if (ret < 0) > + return ret; > + > + if (ret) > + value = 0; > + else > + value = LIGHTBAR_S3_OFF; > + > + ret = regmap_update_bits(data->regmap, EC_ADDR_LIGHTBAR_AC_CTRL, LIGHTBAR_S3_OFF, value); > + if (ret < 0) > + return ret; > + > + return count; > +} > + > +static ssize_t breathing_in_suspend_show(struct device *dev, struct device_attribute *attr, > + char *buf) > +{ > + struct uniwill_data *data = dev_get_drvdata(dev); > + unsigned int value; > + int ret; > + > + ret = regmap_read(data->regmap, EC_ADDR_LIGHTBAR_AC_CTRL, &value); > + if (ret < 0) > + return ret; > + > + return sysfs_emit(buf, "%s\n", str_enable_disable(!(value & LIGHTBAR_S3_OFF))); > +} > + > +static DEVICE_ATTR_RW(breathing_in_suspend); > + > +static struct attribute *uniwill_attrs[] = { > + /* Keyboard-related */ > + &dev_attr_fn_lock.attr, > + &dev_attr_super_key_lock.attr, > + &dev_attr_touchpad_toggle.attr, > + /* Lightbar-related */ > + &dev_attr_rainbow_animation.attr, > + &dev_attr_breathing_in_suspend.attr, > + NULL > +}; > + > +static umode_t uniwill_attr_is_visible(struct kobject *kobj, struct attribute *attr, int n) > +{ > + if (attr == &dev_attr_fn_lock.attr) { > + if (supported_features & UNIWILL_FEATURE_FN_LOCK) > + return attr->mode; > + } > + > + if (attr == &dev_attr_super_key_lock.attr) { > + if (supported_features & UNIWILL_FEATURE_SUPER_KEY_LOCK) > + return attr->mode; > + } > + > + if (attr == &dev_attr_touchpad_toggle.attr) { > + if (supported_features & UNIWILL_FEATURE_TOUCHPAD_TOGGLE) > + return attr->mode; > + } > + > + if (attr == &dev_attr_rainbow_animation.attr || > + attr == &dev_attr_breathing_in_suspend.attr) { > + if (supported_features & UNIWILL_FEATURE_LIGHTBAR) > + return attr->mode; > + } > + > + return 0; > +} > + > +static const struct attribute_group uniwill_group = { > + .is_visible = uniwill_attr_is_visible, > + .attrs = uniwill_attrs, > +}; > + > +static const struct attribute_group *uniwill_groups[] = { > + &uniwill_group, > + NULL > +}; > + > +static int uniwill_read(struct device *dev, enum hwmon_sensor_types type, u32 attr, int channel, > + long *val) > +{ > + struct uniwill_data *data = dev_get_drvdata(dev); > + unsigned int value; > + __be16 rpm; > + int ret; > + > + switch (type) { > + case hwmon_temp: > + switch (channel) { > + case 0: > + ret = regmap_read(data->regmap, EC_ADDR_CPU_TEMP, &value); > + break; > + case 1: > + ret = regmap_read(data->regmap, EC_ADDR_GPU_TEMP, &value); > + break; > + default: > + return -EOPNOTSUPP; > + } > + > + if (ret < 0) > + return ret; > + > + *val = value * MILLIDEGREE_PER_DEGREE; > + return 0; > + case hwmon_fan: > + switch (channel) { > + case 0: > + ret = regmap_bulk_read(data->regmap, EC_ADDR_MAIN_FAN_RPM_1, &rpm, > + sizeof(rpm)); > + break; > + case 1: > + ret = regmap_bulk_read(data->regmap, EC_ADDR_SECOND_FAN_RPM_1, &rpm, > + sizeof(rpm)); __be16 rpm ? returns values in cpu endian > + break; > + default: > + return -EOPNOTSUPP; > + } > + > + if (ret < 0) > + return ret; > + > + *val = be16_to_cpu(rpm); > + return 0; > + case hwmon_pwm: > + switch (channel) { > + case 0: > + ret = regmap_read(data->regmap, EC_ADDR_PWM_1, &value); > + break; > + case 1: > + ret = regmap_read(data->regmap, EC_ADDR_PWM_2, &value); > + break; > + default: > + return -EOPNOTSUPP; > + } missing ret check > + > + *val = fixp_linear_interpolate(0, 0, PWM_MAX, U8_MAX, value); > + return 0; > + default: > + return -EOPNOTSUPP; > + } > +} > + > +static int uniwill_read_string(struct device *dev, enum hwmon_sensor_types type, u32 attr, > + int channel, const char **str) > +{ > + switch (type) { > + case hwmon_temp: > + *str = uniwill_temp_labels[channel]; > + return 0; > + case hwmon_fan: > + *str = uniwill_fan_labels[channel]; > + return 0; > + default: > + return -EOPNOTSUPP; > + } > +} > + > +static const struct hwmon_ops uniwill_ops = { > + .visible = 0444, > + .read = uniwill_read, > + .read_string = uniwill_read_string, > +}; > + > +static const struct hwmon_channel_info * const uniwill_info[] = { > + HWMON_CHANNEL_INFO(chip, HWMON_C_REGISTER_TZ), > + HWMON_CHANNEL_INFO(temp, > + HWMON_T_INPUT | HWMON_T_LABEL, > + HWMON_T_INPUT | HWMON_T_LABEL), > + HWMON_CHANNEL_INFO(fan, > + HWMON_F_INPUT | HWMON_F_LABEL, > + HWMON_F_INPUT | HWMON_F_LABEL), > + HWMON_CHANNEL_INFO(pwm, > + HWMON_PWM_INPUT, > + HWMON_PWM_INPUT), > + NULL > +}; > + > +static const struct hwmon_chip_info uniwill_chip_info = { > + .ops = &uniwill_ops, > + .info = uniwill_info, > +}; > + > +static int uniwill_hwmon_init(struct uniwill_data *data) > +{ > + struct device *hdev; > + > + if (!(supported_features & UNIWILL_FEATURE_HWMON)) > + return 0; > + > + hdev = devm_hwmon_device_register_with_info(&data->wdev->dev, "uniwill", data, > + &uniwill_chip_info, NULL); > + > + return PTR_ERR_OR_ZERO(hdev); > +} > + > +static const unsigned int uniwill_led_channel_to_bat_reg[LED_CHANNELS] = { > + EC_ADDR_LIGHTBAR_BAT_RED, > + EC_ADDR_LIGHTBAR_BAT_GREEN, > + EC_ADDR_LIGHTBAR_BAT_BLUE, > +}; > + > +static const unsigned int uniwill_led_channel_to_ac_reg[LED_CHANNELS] = { > + EC_ADDR_LIGHTBAR_AC_RED, > + EC_ADDR_LIGHTBAR_AC_GREEN, > + EC_ADDR_LIGHTBAR_AC_BLUE, > +}; > + > +static int uniwill_led_brightness_set(struct led_classdev *led_cdev, enum led_brightness brightness) > +{ > + struct led_classdev_mc *led_mc_cdev = lcdev_to_mccdev(led_cdev); > + struct uniwill_data *data = container_of(led_mc_cdev, struct uniwill_data, led_mc_cdev); > + unsigned int value; > + int ret; > + > + ret = led_mc_calc_color_components(led_mc_cdev, brightness); > + if (ret < 0) > + return ret; > + > + for (int i = 0; i < LED_CHANNELS; i++) { > + /* Prevent the brightness values from overflowing */ > + value = min(LED_MAX_BRIGHTNESS, data->led_mc_subled_info[i].brightness); > + ret = regmap_write(data->regmap, uniwill_led_channel_to_ac_reg[i], value); > + if (ret < 0) > + return ret; > + > + ret = regmap_write(data->regmap, uniwill_led_channel_to_bat_reg[i], value); > + if (ret < 0) > + return ret; > + } > + > + if (brightness) > + value = 0; > + else > + value = LIGHTBAR_S0_OFF; > + > + ret = regmap_update_bits(data->regmap, EC_ADDR_LIGHTBAR_AC_CTRL, LIGHTBAR_S0_OFF, value); > + if (ret < 0) > + return ret; > + > + return regmap_update_bits(data->regmap, EC_ADDR_LIGHTBAR_BAT_CTRL, LIGHTBAR_S0_OFF, value); > +} > + > +#define LIGHTBAR_MASK (LIGHTBAR_APP_EXISTS | LIGHTBAR_S0_OFF | LIGHTBAR_S3_OFF | LIGHTBAR_WELCOME) > + > +static int uniwill_led_init(struct uniwill_data *data) > +{ > + struct led_init_data init_data = { > + .devicename = DRIVER_NAME, > + .default_label = "multicolor:" LED_FUNCTION_STATUS, > + .devname_mandatory = true, > + }; > + unsigned int color_indices[3] = { > + LED_COLOR_ID_RED, > + LED_COLOR_ID_GREEN, > + LED_COLOR_ID_BLUE, > + }; > + unsigned int value; > + int ret; > + > + if (!(supported_features & UNIWILL_FEATURE_LIGHTBAR)) > + return 0; > + > + /* > + * The EC has separate lightbar settings for AC and battery mode, > + * so we have to ensure that both settings are the same. > + */ > + ret = regmap_read(data->regmap, EC_ADDR_LIGHTBAR_AC_CTRL, &value); > + if (ret < 0) > + return ret; > + > + value |= LIGHTBAR_APP_EXISTS; > + ret = regmap_write(data->regmap, EC_ADDR_LIGHTBAR_AC_CTRL, value); > + if (ret < 0) > + return ret; > + > + /* > + * The breathing animation during suspend is not supported when > + * running on battery power. > + */ > + value |= LIGHTBAR_S3_OFF; > + ret = regmap_update_bits(data->regmap, EC_ADDR_LIGHTBAR_BAT_CTRL, LIGHTBAR_MASK, value); > + if (ret < 0) > + return ret; > + > + data->led_mc_cdev.led_cdev.color = LED_COLOR_ID_MULTI; > + data->led_mc_cdev.led_cdev.max_brightness = LED_MAX_BRIGHTNESS; > + data->led_mc_cdev.led_cdev.flags = LED_REJECT_NAME_CONFLICT; > + data->led_mc_cdev.led_cdev.brightness_set_blocking = uniwill_led_brightness_set; > + > + if (value & LIGHTBAR_S0_OFF) > + data->led_mc_cdev.led_cdev.brightness = 0; > + else > + data->led_mc_cdev.led_cdev.brightness = LED_MAX_BRIGHTNESS; > + > + for (int i = 0; i < LED_CHANNELS; i++) { > + data->led_mc_subled_info[i].color_index = color_indices[i]; > + > + ret = regmap_read(data->regmap, uniwill_led_channel_to_ac_reg[i], &value); > + if (ret < 0) > + return ret; > + > + /* > + * Make sure that the initial intensity value is not greater than > + * the maximum brightness. > + */ > + value = min(LED_MAX_BRIGHTNESS, value); > + ret = regmap_write(data->regmap, uniwill_led_channel_to_ac_reg[i], value); > + if (ret < 0) > + return ret; > + > + ret = regmap_write(data->regmap, uniwill_led_channel_to_bat_reg[i], value); > + if (ret < 0) > + return ret; > + > + data->led_mc_subled_info[i].intensity = value; > + data->led_mc_subled_info[i].channel = i; > + } > + > + data->led_mc_cdev.subled_info = data->led_mc_subled_info; > + data->led_mc_cdev.num_colors = LED_CHANNELS; > + > + return devm_led_classdev_multicolor_register_ext(&data->wdev->dev, &data->led_mc_cdev, > + &init_data); > +} > + > +static int uniwill_get_property(struct power_supply *psy, const struct power_supply_ext *ext, > + void *drvdata, enum power_supply_property psp, > + union power_supply_propval *val) > +{ > + struct uniwill_data *data = drvdata; > + union power_supply_propval prop; > + unsigned int regval; > + int ret; > + > + switch (psp) { > + case POWER_SUPPLY_PROP_HEALTH: > + ret = power_supply_get_property_direct(psy, POWER_SUPPLY_PROP_PRESENT, &prop); > + if (ret < 0) > + return ret; > + > + if (!prop.intval) { > + val->intval = POWER_SUPPLY_HEALTH_NO_BATTERY; > + return 0; > + } > + > + ret = power_supply_get_property_direct(psy, POWER_SUPPLY_PROP_STATUS, &prop); > + if (ret < 0) > + return ret; > + > + if (prop.intval == POWER_SUPPLY_STATUS_UNKNOWN) { > + val->intval = POWER_SUPPLY_HEALTH_UNKNOWN; > + return 0; > + } > + > + ret = regmap_read(data->regmap, EC_ADDR_BAT_ALERT, ®val); > + if (ret < 0) > + return ret; > + > + if (regval) { > + /* Charging issue */ > + val->intval = POWER_SUPPLY_HEALTH_UNSPEC_FAILURE; > + return 0; > + } > + > + val->intval = POWER_SUPPLY_HEALTH_GOOD; > + return 0; > + case POWER_SUPPLY_PROP_CHARGE_CONTROL_END_THRESHOLD: > + ret = regmap_read(data->regmap, EC_ADDR_CHARGE_CTRL, ®val); > + if (ret < 0) > + return ret; > + > + val->intval = clamp_val(FIELD_GET(CHARGE_CTRL_MASK, regval), 0, 100); > + return 0; > + default: > + return -EINVAL; > + } > +} > + > +static int uniwill_set_property(struct power_supply *psy, const struct power_supply_ext *ext, > + void *drvdata, enum power_supply_property psp, > + const union power_supply_propval *val) > +{ > + struct uniwill_data *data = drvdata; > + > + switch (psp) { > + case POWER_SUPPLY_PROP_CHARGE_CONTROL_END_THRESHOLD: > + if (val->intval < 1 || val->intval > 100) > + return -EINVAL; > + > + return regmap_update_bits(data->regmap, EC_ADDR_CHARGE_CTRL, CHARGE_CTRL_MASK, > + val->intval); > + default: > + return -EINVAL; > + } > +} > + > +static int uniwill_property_is_writeable(struct power_supply *psy, > + const struct power_supply_ext *ext, void *drvdata, > + enum power_supply_property psp) > +{ > + if (psp == POWER_SUPPLY_PROP_CHARGE_CONTROL_END_THRESHOLD) > + return true; > + > + return false; > +} > + > +static const enum power_supply_property uniwill_properties[] = { > + POWER_SUPPLY_PROP_HEALTH, > + POWER_SUPPLY_PROP_CHARGE_CONTROL_END_THRESHOLD, > +}; > + > +static const struct power_supply_ext uniwill_extension = { > + .name = DRIVER_NAME, > + .properties = uniwill_properties, > + .num_properties = ARRAY_SIZE(uniwill_properties), > + .get_property = uniwill_get_property, > + .set_property = uniwill_set_property, > + .property_is_writeable = uniwill_property_is_writeable, > +}; > + > +static int uniwill_add_battery(struct power_supply *battery, struct acpi_battery_hook *hook) > +{ > + struct uniwill_data *data = container_of(hook, struct uniwill_data, hook); > + struct uniwill_battery_entry *entry; > + int ret; > + > + entry = kzalloc(sizeof(*entry), GFP_KERNEL); > + if (!entry) > + return -ENOMEM; > + > + ret = power_supply_register_extension(battery, &uniwill_extension, &data->wdev->dev, data); > + if (ret < 0) { > + kfree(entry); > + return ret; > + } > + > + scoped_guard(mutex, &data->battery_lock) { > + entry->battery = battery; > + list_add(&entry->head, &data->batteries); > + } > + > + return 0; > +} > + > +static int uniwill_remove_battery(struct power_supply *battery, struct acpi_battery_hook *hook) > +{ > + struct uniwill_data *data = container_of(hook, struct uniwill_data, hook); > + struct uniwill_battery_entry *entry, *tmp; > + > + scoped_guard(mutex, &data->battery_lock) { > + list_for_each_entry_safe(entry, tmp, &data->batteries, head) { > + if (entry->battery == battery) { > + list_del(&entry->head); > + kfree(entry); > + break; > + } > + } > + } > + > + power_supply_unregister_extension(battery, &uniwill_extension); > + > + return 0; > +} > + > +static int uniwill_battery_init(struct uniwill_data *data) > +{ > + int ret; > + > + if (!(supported_features & UNIWILL_FEATURE_BATTERY)) > + return 0; > + > + ret = devm_mutex_init(&data->wdev->dev, &data->battery_lock); > + if (ret < 0) > + return ret; > + > + INIT_LIST_HEAD(&data->batteries); > + data->hook.name = "Uniwill Battery Extension"; > + data->hook.add_battery = uniwill_add_battery; > + data->hook.remove_battery = uniwill_remove_battery; > + > + return devm_battery_hook_register(&data->wdev->dev, &data->hook); > +} > + > +static int uniwill_notifier_call(struct notifier_block *nb, unsigned long action, void *dummy) > +{ > + struct uniwill_data *data = container_of(nb, struct uniwill_data, nb); > + struct uniwill_battery_entry *entry; > + > + switch (action) { > + case UNIWILL_OSD_BATTERY_ALERT: > + scoped_guard(mutex, &data->battery_lock) { > + list_for_each_entry(entry, &data->batteries, head) { > + power_supply_changed(entry->battery); > + } > + } > + > + return NOTIFY_OK; > + default: > + return NOTIFY_DONE; > + } > +} > + > +static int uniwill_notifier_init(struct uniwill_data *data) > +{ > + data->nb.notifier_call = uniwill_notifier_call; > + > + return devm_uniwill_wmi_register_notifier(&data->wdev->dev, &data->nb); > +} > + > +static void uniwill_disable_manual_control(void *context) > +{ > + struct uniwill_data *data = context; > + > + regmap_clear_bits(data->regmap, EC_ADDR_AP_OEM, ENABLE_MANUAL_CTRL); > +} > + > +static int uniwill_ec_init(struct uniwill_data *data) > +{ > + unsigned int value; > + int ret; > + > + ret = regmap_read(data->regmap, EC_ADDR_PROJECT_ID, &value); > + if (ret < 0) > + return ret; > + > + dev_dbg(&data->wdev->dev, "Project ID: %u\n", value); > + > + ret = regmap_set_bits(data->regmap, EC_ADDR_AP_OEM, ENABLE_MANUAL_CTRL); > + if (ret < 0) > + return ret; > + > + return devm_add_action_or_reset(&data->wdev->dev, uniwill_disable_manual_control, data); > +} > + > +static int uniwill_probe(struct wmi_device *wdev, const void *context) > +{ > + struct uniwill_data *data; > + struct regmap *regmap; > + int ret; > + > + data = devm_kzalloc(&wdev->dev, sizeof(*data), GFP_KERNEL); > + if (!data) > + return -ENOMEM; > + > + data->wdev = wdev; > + dev_set_drvdata(&wdev->dev, data); > + > + regmap = devm_regmap_init(&wdev->dev, &uniwill_ec_bus, data, &uniwill_ec_config); > + if (IS_ERR(regmap)) > + return PTR_ERR(regmap); > + > + data->regmap = regmap; > + ret = devm_mutex_init(&wdev->dev, &data->super_key_lock); > + if (ret < 0) > + return ret; > + > + ret = uniwill_ec_init(data); > + if (ret < 0) > + return ret; > + > + ret = uniwill_battery_init(data); > + if (ret < 0) > + return ret; > + > + ret = uniwill_led_init(data); > + if (ret < 0) > + return ret; > + > + ret = uniwill_hwmon_init(data); > + if (ret < 0) > + return ret; > + > + return uniwill_notifier_init(data); > +} > + > +static void uniwill_shutdown(struct wmi_device *wdev) > +{ > + struct uniwill_data *data = dev_get_drvdata(&wdev->dev); > + > + regmap_clear_bits(data->regmap, EC_ADDR_AP_OEM, ENABLE_MANUAL_CTRL); > +} > + > +static int uniwill_suspend_keyboard(struct uniwill_data *data) > +{ > + if (!(supported_features & UNIWILL_FEATURE_SUPER_KEY_LOCK)) > + return 0; > + > + /* > + * The EC_ADDR_SWITCH_STATUS is maked as volatile, so we have to restore it > + * ourself. typo maked ->marked ourself -> ourselves > + */ > + return regmap_read(data->regmap, EC_ADDR_SWITCH_STATUS, &data->last_switch_status); > +} > + > +static int uniwill_suspend_battery(struct uniwill_data *data) > +{ > + if (!(supported_features & UNIWILL_FEATURE_BATTERY)) > + return 0; > + > + /* > + * Save the current charge limit in order to restore it during resume. > + * We cannot use the regmap code for that since this register needs to > + * be declared as volatile due to CHARGE_CTRL_REACHED. > + */ > + return regmap_read(data->regmap, EC_ADDR_CHARGE_CTRL, &data->last_charge_ctrl); > +} > + > +static int uniwill_suspend(struct device *dev) > +{ > + struct uniwill_data *data = dev_get_drvdata(dev); > + int ret; > + > + ret = uniwill_suspend_keyboard(data); > + if (ret < 0) > + return ret; > + > + ret = uniwill_suspend_battery(data); > + if (ret < 0) > + return ret; > + > + regcache_cache_only(data->regmap, true); > + regcache_mark_dirty(data->regmap); > + > + return 0; > +} > + > +static int uniwill_resume_keyboard(struct uniwill_data *data) > +{ > + unsigned int value; > + int ret; > + > + if (!(supported_features & UNIWILL_FEATURE_SUPER_KEY_LOCK)) > + return 0; > + > + ret = regmap_read(data->regmap, EC_ADDR_SWITCH_STATUS, &value); > + if (ret < 0) > + return ret; > + > + if ((data->last_switch_status & SUPER_KEY_LOCK_STATUS) == (value & SUPER_KEY_LOCK_STATUS)) > + return 0; > + > + return regmap_write_bits(data->regmap, EC_ADDR_TRIGGER, TRIGGER_SUPER_KEY_LOCK, > + TRIGGER_SUPER_KEY_LOCK); > +} > + > +static int uniwill_resume_battery(struct uniwill_data *data) > +{ > + if (!(supported_features & UNIWILL_FEATURE_BATTERY)) > + return 0; > + > + return regmap_update_bits(data->regmap, EC_ADDR_CHARGE_CTRL, CHARGE_CTRL_MASK, > + data->last_charge_ctrl); > +} > + > +static int uniwill_resume(struct device *dev) > +{ > + struct uniwill_data *data = dev_get_drvdata(dev); > + int ret; > + > + regcache_cache_only(data->regmap, false); > + > + ret = regcache_sync(data->regmap); > + if (ret < 0) > + return ret; > + > + ret = uniwill_resume_keyboard(data); > + if (ret < 0) > + return ret; > + > + return uniwill_resume_battery(data); > +} > + > +static DEFINE_SIMPLE_DEV_PM_OPS(uniwill_pm_ops, uniwill_suspend, uniwill_resume); > + > +/* > + * We cannot fully trust this GUID since Uniwill just copied the WMI GUID > + * from the Windows driver example, and others probably did the same. > + * > + * Because of this we cannot use this WMI GUID for autoloading. > + */ > +static const struct wmi_device_id uniwill_id_table[] = { > + { UNIWILL_GUID, NULL }, > + { } > +}; > + > +static struct wmi_driver uniwill_driver = { > + .driver = { > + .name = DRIVER_NAME, > + .dev_groups = uniwill_groups, > + .probe_type = PROBE_PREFER_ASYNCHRONOUS, > + .pm = pm_sleep_ptr(&uniwill_pm_ops), > + }, > + .id_table = uniwill_id_table, > + .probe = uniwill_probe, > + .shutdown = uniwill_shutdown, > + .no_singleton = true, > +}; > + > +static const struct dmi_system_id uniwill_dmi_table[] __initconst = { > + { > + .ident = "Intel NUC x15", > + .matches = { > + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Intel(R) Client Systems"), > + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "LAPAC71H"), > + }, > + .driver_data = (void *)(UNIWILL_FEATURE_FN_LOCK | > + UNIWILL_FEATURE_SUPER_KEY_LOCK | > + UNIWILL_FEATURE_TOUCHPAD_TOGGLE | > + UNIWILL_FEATURE_BATTERY | > + UNIWILL_FEATURE_HWMON), > + }, > + { > + .ident = "Intel NUC x15", > + .matches = { > + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Intel(R) Client Systems"), > + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "LAPKC71F"), > + }, > + .driver_data = (void *)(UNIWILL_FEATURE_FN_LOCK | > + UNIWILL_FEATURE_SUPER_KEY_LOCK | > + UNIWILL_FEATURE_TOUCHPAD_TOGGLE | > + UNIWILL_FEATURE_LIGHTBAR | > + UNIWILL_FEATURE_BATTERY | > + UNIWILL_FEATURE_HWMON), > + }, > + { } > +}; > +MODULE_DEVICE_TABLE(dmi, uniwill_dmi_table); > + > +static int __init uniwill_init(void) > +{ > + const struct dmi_system_id *id; > + > + id = dmi_first_match(uniwill_dmi_table); > + if (!id) { > + if (!force) > + return -ENODEV; > + > + /* Assume that the device supports all features */ > + supported_features = UINTPTR_MAX; > + pr_warn("Loading on a potentially unsupported device\n"); > + } else { > + supported_features = (uintptr_t)id->driver_data; > + } > + > + return wmi_driver_register(&uniwill_driver); > +} > +module_init(uniwill_init); > + > +static void __exit uniwill_exit(void) > +{ > + wmi_driver_unregister(&uniwill_driver); > +} > +module_exit(uniwill_exit); > + > +MODULE_AUTHOR("Armin Wolf <W_Armin@gmx.de>"); > +MODULE_DESCRIPTION("Uniwill notebook driver"); > +MODULE_LICENSE("GPL"); > +MODULE_IMPORT_NS("UNIWILL"); > diff --git a/drivers/platform/x86/uniwill/uniwill-wmi.c b/drivers/platform/x86/uniwill/uniwill-wmi.c > index f38e4bbcd8b6..65700121ef52 100644 > --- a/drivers/platform/x86/uniwill/uniwill-wmi.c > +++ b/drivers/platform/x86/uniwill/uniwill-wmi.c > @@ -161,7 +161,8 @@ static int uniwill_wmi_probe(struct wmi_device *wdev, const void *context) > * We cannot fully trust this GUID since Uniwill just copied the WMI GUID > * from the Windows driver example, and others probably did the same. > * > - * Because of this we cannot use this WMI GUID for autoloading. > + * Because of this we cannot use this WMI GUID for autoloading. The uniwill-laptop > + * driver will instead load this module as a dependency. > */ > static const struct wmi_device_id uniwill_wmi_id_table[] = { > { UNIWILL_EVENT_GUID, NULL }, Thanks, Alok ^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: [External] : [PATCH 2/3] platform/x86: Add Uniwill laptop driver 2025-07-12 12:31 ` [External] : " ALOK TIWARI @ 2025-07-16 16:47 ` Armin Wolf 0 siblings, 0 replies; 11+ messages in thread From: Armin Wolf @ 2025-07-16 16:47 UTC (permalink / raw) To: ALOK TIWARI, ilpo.jarvinen, hdegoede, chumuzero, corbet, cs, wse, ggo Cc: linux-doc, linux-kernel, platform-driver-x86, rdunlap, linux-leds, lee, pobrn Am 12.07.25 um 14:31 schrieb ALOK TIWARI: > > > On 7/12/2025 4:53 PM, Armin Wolf wrote: >> Add a new driver for Uniwill laptops. The driver uses a ACPI WMI >> interface to talk with the embedded controller, but relies on a >> DMI whitelist for autoloading since Uniwill just copied the WMI >> GUID from the Windows driver example. >> >> The driver is reverse-engineered based on the following information: >> - OEM software from intel >> - >> https://urldefense.com/v3/__https://github.com/pobrn/qc71_laptop__;!!ACWV5N9M2RV99hQ!PYW0bhvxAIvo5Q628_nWz3JpVFEvKWLr7b7gsh_jVvTEAgryiLemldZWYQTMNVOlQHLFfZWCJ4XSA0Zht1c$ >> - >> https://urldefense.com/v3/__https://gitlab.com/tuxedocomputers/development/packages/tuxedo-drivers__;!!ACWV5N9M2RV99hQ!PYW0bhvxAIvo5Q628_nWz3JpVFEvKWLr7b7gsh_jVvTEAgryiLemldZWYQTMNVOlQHLFfZWCJ4XSlSKbZG4$ >> - >> https://urldefense.com/v3/__https://github.com/tuxedocomputers/tuxedo-control-center__;!!ACWV5N9M2RV99hQ!PYW0bhvxAIvo5Q628_nWz3JpVFEvKWLr7b7gsh_jVvTEAgryiLemldZWYQTMNVOlQHLFfZWCJ4XSGW2eamI$ >> >> The underlying EC supports various features, including hwmon sensors, >> battery charge limiting, a RGB lightbar and keyboard-related controls. >> >> Reported-by: cyear <chumuzero@gmail.com> >> Closes: >> https://urldefense.com/v3/__https://github.com/lm-sensors/lm-sensors/issues/508__;!!ACWV5N9M2RV99hQ!PYW0bhvxAIvo5Q628_nWz3JpVFEvKWLr7b7gsh_jVvTEAgryiLemldZWYQTMNVOlQHLFfZWCJ4XSUXC3pPE$ >> Closes: >> https://urldefense.com/v3/__https://github.com/Wer-Wolf/uniwill-laptop/issues/3__;!!ACWV5N9M2RV99hQ!PYW0bhvxAIvo5Q628_nWz3JpVFEvKWLr7b7gsh_jVvTEAgryiLemldZWYQTMNVOlQHLFfZWCJ4XS1sL_cIM$ >> Signed-off-by: Armin Wolf <W_Armin@gmx.de> >> --- >> .../ABI/testing/sysfs-driver-uniwill-laptop | 53 + >> Documentation/wmi/devices/uniwill-laptop.rst | 118 ++ >> MAINTAINERS | 8 + >> drivers/platform/x86/uniwill/Kconfig | 17 + >> drivers/platform/x86/uniwill/Makefile | 1 + >> drivers/platform/x86/uniwill/uniwill-laptop.c | 1481 +++++++++++++++++ >> drivers/platform/x86/uniwill/uniwill-wmi.c | 3 +- >> 7 files changed, 1680 insertions(+), 1 deletion(-) >> create mode 100644 >> Documentation/ABI/testing/sysfs-driver-uniwill-laptop >> create mode 100644 Documentation/wmi/devices/uniwill-laptop.rst >> create mode 100644 drivers/platform/x86/uniwill/uniwill-laptop.c >> >> diff --git a/Documentation/ABI/testing/sysfs-driver-uniwill-laptop >> b/Documentation/ABI/testing/sysfs-driver-uniwill-laptop >> new file mode 100644 >> index 000000000000..7a540a7b9f24 >> --- /dev/null >> +++ b/Documentation/ABI/testing/sysfs-driver-uniwill-laptop >> @@ -0,0 +1,53 @@ >> +What: >> /sys/bus/wmi/devices/ABBC0F6F-8EA1-11D1-00A0-C90629100000[-X]/fn_lock >> +Date: June 2025 >> +KernelVersion: 6.17 >> +Contact: Armin Wolf <W_Armin@gmx.de> >> +Description: >> + Allows userspace applications to enable/disable the FN lock >> feature >> + of the integrated keyboard by writing "enable"/"disable" >> into this file. >> + >> + Reading this file returns the current enable status of the >> FN lock functionality. >> + >> +What: >> /sys/bus/wmi/devices/ABBC0F6F-8EA1-11D1-00A0-C90629100000[-X]/super_key_lock >> +Date: June 2025 >> +KernelVersion: 6.17 >> +Contact: Armin Wolf <W_Armin@gmx.de> >> +Description: >> + Allows userspace applications to enable/disable the >> super key functionality >> + of the integrated keyboard by writing >> "enable"/"disable" into this file. >> + >> + Reading this file returns the current enable status of the >> super key functionality. >> + >> +What: >> /sys/bus/wmi/devices/ABBC0F6F-8EA1-11D1-00A0-C90629100000[-X]/touchpad_toggle >> +Date: June 2025 >> +KernelVersion: 6.17 >> +Contact: Armin Wolf <W_Armin@gmx.de> >> +Description: >> + Allows userspace applications to enable/disable the touchpad >> toggle functionality >> + of the integrated touchpad by writing "enable"/"disable" >> into this file. >> + >> + Reading this file returns the current enable status of the >> touchpad toggle >> + functionality. >> + >> +What: >> /sys/bus/wmi/devices/ABBC0F6F-8EA1-11D1-00A0-C90629100000[-X]/rainbow_animation >> +Date: June 2025 >> +KernelVersion: 6.17 >> +Contact: Armin Wolf <W_Armin@gmx.de> >> +Description: >> + Forces the integrated lightbar to display a rainbow >> animation when the machine >> + is not suspended. Writing "enable"/"disable" into this file >> enables/disables >> + this functionality. >> + >> + Reading this file returns the current status of the rainbow >> animation functionality. >> + >> +What: >> /sys/bus/wmi/devices/ABBC0F6F-8EA1-11D1-00A0-C90629100000[-X]/breathing_in_suspend >> +Date: June 2025 >> +KernelVersion: 6.17 >> +Contact: Armin Wolf <W_Armin@gmx.de> >> +Description: >> + Causes the integrated lightbar to display a breathing >> animation when the machine >> + has been suspended and is running on AC power. Writing >> "enable"/"disable" into >> + this file enables/disables this functionality. >> + >> + Reading this file returns the current status of the >> breathing animation >> + functionality. >> diff --git a/Documentation/wmi/devices/uniwill-laptop.rst >> b/Documentation/wmi/devices/uniwill-laptop.rst >> new file mode 100644 >> index 000000000000..77a544b91f9e >> --- /dev/null >> +++ b/Documentation/wmi/devices/uniwill-laptop.rst >> @@ -0,0 +1,118 @@ >> +.. SPDX-License-Identifier: GPL-2.0-or-later >> + >> +============================================ >> +Uniwill WMI Notebook driver (uniwill-laptop) >> +============================================ >> + >> +Introduction >> +============ >> + >> +Many notebooks manufactured by Uniwill (either directly or as ODM) >> provide a WMI-based >> +EC interface for controlling various platform settings like sensors >> and fan control. >> +This interface is used by the ``uniwill-laptop`` driver to map those >> features onto standard >> +kernel interfaces. >> + >> +WMI interface description >> +========================= >> + >> +The WMI interface description can be decoded from the embedded >> binary MOF (bmof) >> +data using the `bmfdec >> <https://urldefense.com/v3/__https://github.com/pali/bmfdec__;!!ACWV5N9M2RV99hQ!PYW0bhvxAIvo5Q628_nWz3JpVFEvKWLr7b7gsh_jVvTEAgryiLemldZWYQTMNVOlQHLFfZWCJ4XS_REL1dI$ >> >`_ utility: >> + >> +:: >> + >> + [WMI, Dynamic, Provider("WmiProv"), Locale("MS\\0x409"), >> + Description("Class used to operate methods on a ULong"), >> + guid("{ABBC0F6F-8EA1-11d1-00A0-C90629100000}")] >> + class AcpiTest_MULong { >> + [key, read] string InstanceName; >> + [read] boolean Active; >> + >> + [WmiMethodId(1), Implemented, read, write, Description("Return >> the contents of a ULong")] >> + void GetULong([out, Description("Ulong Data")] uint32 Data); >> + >> + [WmiMethodId(2), Implemented, read, write, Description("Set the >> contents of a ULong")] >> + void SetULong([in, Description("Ulong Data")] uint32 Data); >> + >> + [WmiMethodId(3), Implemented, read, write, >> + Description("Generate an event containing ULong data")] >> + void FireULong([in, Description("WMI requires a parameter")] >> uint32 Hack); >> + >> + [WmiMethodId(4), Implemented, read, write, Description("Get and >> Set the contents of a ULong")] >> + void GetSetULong([in, Description("Ulong Data")] uint64 Data, >> + [out, Description("Ulong Data")] uint32 Return); >> + >> + [WmiMethodId(5), Implemented, read, write, >> + Description("Get and Set the contents of a ULong for Dollby >> button")] >> + void GetButton([in, Description("Ulong Data")] uint64 Data, >> + [out, Description("Ulong Data")] uint32 Return); >> + }; >> + >> +Most of the WMI-related code was copied from the Windows driver >> samples, which unfortunately means >> +that the WMI-GUID is not unique. This makes the WMI-GUID unusable >> for autoloading. >> + >> +WMI method GetULong() >> +--------------------- >> + >> +This WMI method was copied from the Windows driver samples and has >> no function. >> + >> +WMI method SetULong() >> +--------------------- >> + >> +This WMI method was copied from the Windows driver samples and has >> no function. >> + >> +WMI method FireULong() >> +---------------------- >> + >> +This WMI method allows to inject a WMI event with a 32-bit payload. >> Its primary purpose seems >> +to be debugging. >> + >> +WMI method GetSetULong() >> +------------------------ >> + >> +This WMI method is used to communicate with the EC. The ``Data`` >> argument hold the following >> +information (starting with the least significant byte): >> + >> +1. 16-bit address >> +2. 16-bit data (set to ``0x0000`` when reading) >> +3. 16-bit operation (``0x0100`` for reading and ``0x0000`` for writing) >> +4. 16-bit reserved (set to ``0x0000``) >> + >> +The first 8 bits of the ``Return`` value contain the data returned >> by the EC when reading. >> +The special value ``0xFEFEFEFE`` is used to indicate a communication >> failure with the EC. >> + >> +WMI method GetButton() >> +---------------------- >> + >> +This WMI method is not implemented on all machines and has an >> unknown purpose. >> + >> +Relation with the ``INOU0000`` ACPI device >> +========================================== >> + >> +It seems that many of the embedded controller registers can also be >> accessed by using the ``ECRR`` >> +and ``ECRW`` ACPI control methods under the ``INOU0000`` ACPI >> device. This sidesteps the overhead >> +of the WMI interface but does not work for the registers in the >> range between ``0x1800`` and >> +``0x18FF``. More research is needed to determine whether this >> interface imposes addtional > > typo addtional > >> +restrictions. >> + >> +Reverse-Engineering the Uniwill WMI interface >> +============================================= >> + >> +.. warning:: Randomly poking the EC can potentially cause damage to >> the machine and other unwanted >> + side effects, please be careful. >> + >> +The EC behind the ``GetSetULong`` method is used by the OEM software >> supplied by the manufacturer. >> +Reverse-engineering of this software is difficult since it uses an >> obfuscator, however some parts >> +are not obfuscated. In this case `dnSpy >> <https://urldefense.com/v3/__https://github.com/dnSpy/dnSpy__;!!ACWV5N9M2RV99hQ!PYW0bhvxAIvo5Q628_nWz3JpVFEvKWLr7b7gsh_jVvTEAgryiLemldZWYQTMNVOlQHLFfZWCJ4XSRgqJyGQ$ >> >`_ could also be helpful. >> + >> +The EC can be accessed under Windows using powershell (requires >> admin privileges): >> + >> +:: >> + >> + > $obj = Get-CimInstance -Namespace root/wmi -ClassName >> AcpiTest_MULong | Select-Object -First 1 >> + > Invoke-CimMethod -InputObject $obj -MethodName GetSetULong >> -Arguments @{Data = <input>} >> + >> +Special thanks go to github user `pobrn` which developed the >> +`qc71_laptop >> <https://urldefense.com/v3/__https://github.com/pobrn/qc71_laptop__;!!ACWV5N9M2RV99hQ!PYW0bhvxAIvo5Q628_nWz3JpVFEvKWLr7b7gsh_jVvTEAgryiLemldZWYQTMNVOlQHLFfZWCJ4XSA0Zht1c$ >> >`_ driver on which this driver is partly based. >> +The same is true for Tuxedo Computers, which developed the >> +`tuxedo-drivers >> <https://urldefense.com/v3/__https://gitlab.com/tuxedocomputers/development/packages/tuxedo-drivers__;!!ACWV5N9M2RV99hQ!PYW0bhvxAIvo5Q628_nWz3JpVFEvKWLr7b7gsh_jVvTEAgryiLemldZWYQTMNVOlQHLFfZWCJ4XSlSKbZG4$ >> >`_ package >> +which also served as a foundation for this driver. >> diff --git a/MAINTAINERS b/MAINTAINERS >> index 6c5879bd2ba2..3efec7a99262 100644 >> --- a/MAINTAINERS >> +++ b/MAINTAINERS >> @@ -25490,6 +25490,14 @@ L: linux-scsi@vger.kernel.org >> S: Maintained >> F: drivers/ufs/host/ufs-renesas.c >> +UNIWILL LAPTOP DRIVER >> +M: Armin Wolf <W_Armin@gmx.de> >> +L: platform-driver-x86@vger.kernel.org >> +S: Maintained >> +F: Documentation/ABI/testing/sysfs-driver-uniwill-laptop >> +F: Documentation/wmi/devices/uniwill-laptop.rst >> +F: drivers/platform/x86/uniwill/uniwill-laptop.c >> + >> UNIWILL WMI DRIVER >> M: Armin Wolf <W_Armin@gmx.de> >> L: platform-driver-x86@vger.kernel.org >> diff --git a/drivers/platform/x86/uniwill/Kconfig >> b/drivers/platform/x86/uniwill/Kconfig >> index 7571b30edb11..46d9af52b3f2 100644 >> --- a/drivers/platform/x86/uniwill/Kconfig >> +++ b/drivers/platform/x86/uniwill/Kconfig >> @@ -16,6 +16,23 @@ menuconfig X86_PLATFORM_DRIVERS_UNIWILL >> if X86_PLATFORM_DRIVERS_UNIWILL >> +config UNIWILL_LAPTOP >> + tristate "Uniwill Laptop Extras" >> + default m >> + depends on ACPI_WMI >> + depends on ACPI_BATTERY >> + depends on UNIWILL_WMI >> + depends on HWMON >> + depends on LEDS_CLASS_MULTICOLOR >> + depends on DMI >> + select REGMAP >> + help >> + This driver adds support for various extra features found on >> Uniwill laptops, >> + like the lightbar and hwmon sensors. It also supports many OEM >> laptops >> + originally manufactured by Uniwill. >> + >> + If you have such a laptop, say Y or M here. >> + >> config UNIWILL_WMI >> tristate "Uniwill WMI Event Driver" >> default m >> diff --git a/drivers/platform/x86/uniwill/Makefile >> b/drivers/platform/x86/uniwill/Makefile >> index a5a300be63f3..b55169a49e1e 100644 >> --- a/drivers/platform/x86/uniwill/Makefile >> +++ b/drivers/platform/x86/uniwill/Makefile >> @@ -4,4 +4,5 @@ >> # Uniwill X86 Platform Specific Drivers >> # >> +obj-$(CONFIG_UNIWILL_LAPTOP) += uniwill-laptop.o >> obj-$(CONFIG_UNIWILL_WMI) += uniwill-wmi.o >> diff --git a/drivers/platform/x86/uniwill/uniwill-laptop.c >> b/drivers/platform/x86/uniwill/uniwill-laptop.c >> new file mode 100644 >> index 000000000000..141c58673525 >> --- /dev/null >> +++ b/drivers/platform/x86/uniwill/uniwill-laptop.c >> @@ -0,0 +1,1481 @@ >> +// SPDX-License-Identifier: GPL-2.0-or-later >> +/* >> + * Linux driver for Uniwill notebooks. >> + * >> + * Special thanks go to Pőcze Barnabás, Christoffer Sandberg and >> Werner Sembach >> + * for supporting the development of this driver either through >> prior work or >> + * by answering questions regarding the underlying WMI interface. >> + * >> + * Copyright (C) 2025 Armin Wolf <W_Armin@gmx.de> >> + */ >> + >> +#define pr_format(fmt) KBUILD_MODNAME ": " fmt >> + >> +#include <linux/acpi.h> >> +#include <linux/bits.h> >> +#include <linux/bitfield.h> >> +#include <linux/cleanup.h> >> +#include <linux/debugfs.h> >> +#include <linux/device.h> >> +#include <linux/device/driver.h> >> +#include <linux/dmi.h> >> +#include <linux/errno.h> >> +#include <linux/fixp-arith.h> >> +#include <linux/hwmon.h> >> +#include <linux/hwmon-sysfs.h> >> +#include <linux/init.h> >> +#include <linux/kernel.h> >> +#include <linux/kstrtox.h> >> +#include <linux/leds.h> >> +#include <linux/led-class-multicolor.h> >> +#include <linux/limits.h> >> +#include <linux/list.h> >> +#include <linux/minmax.h> >> +#include <linux/module.h> >> +#include <linux/mutex.h> >> +#include <linux/notifier.h> >> +#include <linux/pm.h> >> +#include <linux/printk.h> >> +#include <linux/regmap.h> >> +#include <linux/string.h> >> +#include <linux/string_choices.h> >> +#include <linux/sysfs.h> >> +#include <linux/types.h> >> +#include <linux/unaligned.h> >> +#include <linux/units.h> >> +#include <linux/wmi.h> >> + >> +#include <acpi/battery.h> >> + >> +#include "uniwill-wmi.h" >> + >> +#define EC_ADDR_BAT_POWER_UNIT_1 0x0400 >> + > > Unnecessary Blank Lines for same logical blocks > I decided to leave blank lines between each register definition as it looks cleaner to me. In this regard each register definition should be considered a separate logical block. >> +#define EC_ADDR_BAT_POWER_UNIT_2 0x0401 >> + >> +#define EC_ADDR_BAT_DESIGN_CAPACITY_1 0x0402 >> + >> +#define EC_ADDR_BAT_DESIGN_CAPACITY_2 0x0403 >> + >> +#define EC_ADDR_BAT_FULL_CAPACITY_1 0x0404 >> + >> +#define EC_ADDR_BAT_FULL_CAPACITY_2 0x0405 >> + >> +#define EC_ADDR_BAT_DESIGN_VOLTAGE_1 0x0408 >> + >> +#define EC_ADDR_BAT_DESIGN_VOLTAGE_2 0x0409 >> + >> +#define EC_ADDR_BAT_STATUS_1 0x0432 >> +#define BAT_DISCHARGING BIT(0) >> + >> +#define EC_ADDR_BAT_STATUS_2 0x0433 >> + >> +#define EC_ADDR_BAT_CURRENT_1 0x0434 >> + >> +#define EC_ADDR_BAT_CURRENT_2 0x0435 >> + >> +#define EC_ADDR_BAT_REMAIN_CAPACITY_1 0x0436 >> + >> +#define EC_ADDR_BAT_REMAIN_CAPACITY_2 0x0437 >> + >> +#define EC_ADDR_BAT_VOLTAGE_1 0x0438 >> + >> +#define EC_ADDR_BAT_VOLTAGE_2 0x0439 >> + >> +#define EC_ADDR_CPU_TEMP 0x043E >> + >> +#define EC_ADDR_GPU_TEMP 0x044F >> + >> +#define EC_ADDR_MAIN_FAN_RPM_1 0x0464 >> + >> +#define EC_ADDR_MAIN_FAN_RPM_2 0x0465 >> + >> +#define EC_ADDR_SECOND_FAN_RPM_1 0x046C >> + >> +#define EC_ADDR_SECOND_FAN_RPM_2 0x046D >> + >> +#define EC_ADDR_DEVICE_STATUS 0x047B >> +#define WIFI_STATUS_ON BIT(7) >> +/* BIT(5) is also unset depending on the rfkill state (bluetooth?) */ >> + >> +#define EC_ADDR_BAT_ALERT 0x0494 >> + >> +#define EC_ADDR_BAT_CYCLE_COUNT_1 0x04A6 >> + >> +#define EC_ADDR_BAT_CYCLE_COUNT_2 0x04A7 >> + >> +#define EC_ADDR_PROJECT_ID 0x0740 >> + >> +#define EC_ADDR_AP_OEM 0x0741 >> +#define ENABLE_MANUAL_CTRL BIT(0) >> +#define ITE_KBD_EFFECT_REACTIVE BIT(3) >> +#define FAN_ABNORMAL BIT(5) >> + >> +#define EC_ADDR_SUPPORT_5 0x0742 >> +#define FAN_TURBO_SUPPORTED BIT(4) >> +#define FAN_SUPPORT BIT(5) >> + >> +#define EC_ADDR_CTGP_DB_CTRL 0x0743 >> +#define CTGP_DB_GENERAL_ENABLE BIT(0) >> +#define CTGP_DB_DB_ENABLE BIT(1) >> +#define CTGP_DB_CTGP_ENABLE BIT(2) >> + >> +#define EC_ADDR_CTGP_OFFSET 0x0744 >> + >> +#define EC_ADDR_TPP_OFFSET 0x0745 >> + >> +#define EC_ADDR_MAX_TGP 0x0746 >> + >> +#define EC_ADDR_LIGHTBAR_AC_CTRL 0x0748 >> +#define LIGHTBAR_APP_EXISTS BIT(0) >> +#define LIGHTBAR_POWER_SAVE BIT(1) >> +#define LIGHTBAR_S0_OFF BIT(2) >> +#define LIGHTBAR_S3_OFF BIT(3) // Breathing animation >> when suspended >> +#define LIGHTBAR_WELCOME BIT(7) // Rainbow animation >> + >> +#define EC_ADDR_LIGHTBAR_AC_RED 0x0749 >> + >> +#define EC_ADDR_LIGHTBAR_AC_GREEN 0x074A >> + >> +#define EC_ADDR_LIGHTBAR_AC_BLUE 0x074B >> + >> +#define EC_ADDR_BIOS_OEM 0x074E >> +#define FN_LOCK_STATUS BIT(4) >> + >> +#define EC_ADDR_MANUAL_FAN_CTRL 0x0751 >> +#define FAN_LEVEL_MASK GENMASK(2, 0) >> +#define FAN_MODE_TURBO BIT(4) >> +#define FAN_MODE_HIGH BIT(5) >> +#define FAN_MODE_BOOST BIT(6) >> +#define FAN_MODE_USER BIT(7) >> + >> +#define EC_ADDR_PWM_1 0x075B >> + >> +#define EC_ADDR_PWM_2 0x075C >> + >> +/* Unreliable */ >> +#define EC_ADDR_SUPPORT_1 0x0765 >> +#define AIRPLANE_MODE BIT(0) >> +#define GPS_SWITCH BIT(1) >> +#define OVERCLOCK BIT(2) >> +#define MACRO_KEY BIT(3) >> +#define SHORTCUT_KEY BIT(4) >> +#define SUPER_KEY_LOCK BIT(5) >> +#define LIGHTBAR BIT(6) >> +#define FAN_BOOST BIT(7) >> + >> +#define EC_ADDR_SUPPORT_2 0x0766 >> +#define SILENT_MODE BIT(0) >> +#define USB_CHARGING BIT(1) >> +#define RGB_KEYBOARD BIT(2) >> +#define CHINA_MODE BIT(5) >> +#define MY_BATTERY BIT(6) >> + >> +#define EC_ADDR_TRIGGER 0x0767 >> +#define TRIGGER_SUPER_KEY_LOCK BIT(0) >> +#define TRIGGER_LIGHTBAR BIT(1) >> +#define TRIGGER_FAN_BOOST BIT(2) >> +#define TRIGGER_SILENT_MODE BIT(3) >> +#define TRIGGER_USB_CHARGING BIT(4) >> +#define RGB_APPLY_COLOR BIT(5) >> +#define RGB_LOGO_EFFECT BIT(6) >> +#define RGB_RAINBOW_EFFECT BIT(7) >> + >> +#define EC_ADDR_SWITCH_STATUS 0x0768 >> +#define SUPER_KEY_LOCK_STATUS BIT(0) >> +#define LIGHTBAR_STATUS BIT(1) >> +#define FAN_BOOST_STATUS BIT(2) >> +#define MACRO_KEY_STATUS BIT(3) >> +#define MY_BAT_POWER_BAT_STATUS BIT(4) >> + >> +#define EC_ADDR_RGB_RED 0x0769 >> + >> +#define EC_ADDR_RGB_GREEN 0x076A >> + >> +#define EC_ADDR_RGB_BLUE 0x076B >> + >> +#define EC_ADDR_ROMID_START 0x0770 >> +#define ROMID_LENGTH 14 >> + >> +#define EC_ADDR_ROMID_EXTRA_1 0x077E >> + >> +#define EC_ADDR_ROMID_EXTRA_2 0x077F >> + >> +#define EC_ADDR_BIOS_OEM_2 0x0782 >> +#define FAN_V2_NEW BIT(0) >> +#define FAN_QKEY BIT(1) >> +#define FAN_TABLE_OFFICE_MODE BIT(2) >> +#define FAN_V3 BIT(3) >> +#define DEFAULT_MODE BIT(4) >> + >> +#define EC_ADDR_PL1_SETTING 0x0783 >> + >> +#define EC_ADDR_PL2_SETTING 0x0784 >> + >> +#define EC_ADDR_PL4_SETTING 0x0785 >> + >> +#define EC_ADDR_FAN_DEFAULT 0x0786 >> +#define FAN_CURVE_LENGTH 5 >> + >> +#define EC_ADDR_KBD_STATUS 0x078C >> +#define KBD_WHITE_ONLY BIT(0) // ~single color >> +#define KBD_SINGLE_COLOR_OFF BIT(1) >> +#define KBD_TURBO_LEVEL_MASK GENMASK(3, 2) >> +#define KBD_APPLY BIT(4) >> +#define KBD_BRIGHTNESS GENMASK(7, 5) >> + >> +#define EC_ADDR_FAN_CTRL 0x078E >> +#define FAN3P5 BIT(1) >> +#define CHARGING_PROFILE BIT(3) >> +#define UNIVERSAL_FAN_CTRL BIT(6) >> + >> +#define EC_ADDR_BIOS_OEM_3 0x07A3 >> +#define FAN_REDUCED_DURY_CYCLE BIT(5) >> +#define FAN_ALWAYS_ON BIT(6) >> + >> +#define EC_ADDR_BIOS_BYTE 0x07A4 >> +#define FN_LOCK_SWITCH BIT(3) >> + >> +#define EC_ADDR_OEM_3 0x07A5 >> +#define POWER_LED_MASK GENMASK(1, 0) >> +#define POWER_LED_LEFT 0x00 >> +#define POWER_LED_BOTH 0x01 >> +#define POWER_LED_NONE 0x02 >> +#define FAN_QUIET BIT(2) >> +#define OVERBOOST BIT(4) >> +#define HIGH_POWER BIT(7) >> + >> +#define EC_ADDR_OEM_4 0x07A6 >> +#define OVERBOOST_DYN_TEMP_OFF BIT(1) >> +#define TOUCHPAD_TOGGLE_OFF BIT(6) >> + >> +#define EC_ADDR_CHARGE_CTRL 0x07B9 >> +#define CHARGE_CTRL_MASK GENMASK(6, 0) >> +#define CHARGE_CTRL_REACHED BIT(7) >> + >> +#define EC_ADDR_UNIVERSAL_FAN_CTRL 0x07C5 >> +#define SPLIT_TABLES BIT(7) >> + >> +#define EC_ADDR_AP_OEM_6 0x07C6 >> +#define ENABLE_UNIVERSAL_FAN_CTRL BIT(2) >> +#define BATTERY_CHARGE_FULL_OVER_24H BIT(3) >> +#define BATTERY_ERM_STATUS_REACHED BIT(4) >> + >> +#define EC_ADDR_CHARGE_PRIO 0x07CC >> +#define CHARGING_PERFORMANCE BIT(7) >> + >> +/* Same bits as EC_ADDR_LIGHTBAR_AC_CTRL except LIGHTBAR_S3_OFF */ >> +#define EC_ADDR_LIGHTBAR_BAT_CTRL 0x07E2 >> + >> +#define EC_ADDR_LIGHTBAR_BAT_RED 0x07E3 >> + >> +#define EC_ADDR_LIGHTBAR_BAT_GREEN 0x07E4 >> + >> +#define EC_ADDR_LIGHTBAR_BAT_BLUE 0x07E5 >> + >> +#define EC_ADDR_CPU_TEMP_END_TABLE 0x0F00 >> + >> +#define EC_ADDR_CPU_TEMP_START_TABLE 0x0F10 >> + >> +#define EC_ADDR_CPU_FAN_SPEED_TABLE 0x0F20 >> + >> +#define EC_ADDR_GPU_TEMP_END_TABLE 0x0F30 >> + >> +#define EC_ADDR_GPU_TEMP_START_TABLE 0x0F40 >> + >> +#define EC_ADDR_GPU_FAN_SPEED_TABLE 0x0F50 >> + >> +/* >> + * Those two registers technically allow for manual fan control, >> + * but are unstable on some models and are likely not meant to >> + * be used by applications. >> + */ >> +#define EC_ADDR_PWM_1_WRITEABLE 0x1804 >> + >> +#define EC_ADDR_PWM_2_WRITEABLE 0x1809 >> + >> +#define DRIVER_NAME "uniwill" >> +#define UNIWILL_GUID "ABBC0F6F-8EA1-11D1-00A0-C90629100000" >> + >> +#define PWM_MAX 200 >> +#define FAN_TABLE_LENGTH 16 >> + >> +#define LED_CHANNELS 3 >> +#define LED_MAX_BRIGHTNESS 200 >> + >> +#define UNIWILL_FEATURE_FN_LOCK BIT(0) >> +#define UNIWILL_FEATURE_SUPER_KEY_LOCK BIT(1) >> +#define UNIWILL_FEATURE_TOUCHPAD_TOGGLE BIT(2) >> +#define UNIWILL_FEATURE_LIGHTBAR BIT(3) >> +#define UNIWILL_FEATURE_BATTERY BIT(4) >> +#define UNIWILL_FEATURE_HWMON BIT(5) >> + >> +enum uniwill_method { >> + UNIWILL_GET_ULONG = 0x01, >> + UNIWILL_SET_ULONG = 0x02, >> + UNIWILL_FIRE_ULONG = 0x03, >> + UNIWILL_GET_SET_ULONG = 0x04, >> + UNIWILL_GET_BUTTON = 0x05, >> +}; >> + >> +struct uniwill_method_buffer { >> + __le16 address; >> + __le16 data; >> + __le16 operation; >> + __le16 reserved; >> +} __packed; >> + >> +struct uniwill_data { >> + struct wmi_device *wdev; >> + struct regmap *regmap; >> + struct acpi_battery_hook hook; >> + unsigned int last_charge_ctrl; >> + struct mutex battery_lock; /* Protects the list of currently >> registered batteries */ >> + unsigned int last_switch_status; >> + struct mutex super_key_lock; /* Protects the toggling of the >> super key lock state */ >> + struct list_head batteries; >> + struct led_classdev_mc led_mc_cdev; >> + struct mc_subled led_mc_subled_info[LED_CHANNELS]; >> + struct notifier_block nb; >> +}; >> + >> +struct uniwill_battery_entry { >> + struct list_head head; >> + struct power_supply *battery; >> +}; >> + >> +static bool force; >> +module_param_unsafe(force, bool, 0); >> +MODULE_PARM_DESC(force, "Force loading without checking for >> supported devices\n"); >> + >> +/* Feature bitmask since the associated registers are not reliable */ >> +static uintptr_t supported_features; >> + >> +/* >> + * "disable" is placed on index 0 so that the return value of >> sysfs_match_string() >> + * directly translates into a boolean value. >> + */ >> +static const char * const uniwill_enable_disable_strings[] = { >> + [0] = "disable", >> + [1] = "enable", >> +}; >> + >> +static const char * const uniwill_temp_labels[] = { >> + "CPU", >> + "GPU", >> +}; >> + >> +static const char * const uniwill_fan_labels[] = { >> + "Main", >> + "Secondary", >> +}; >> + >> +static int uniwill_get_set_ulong(struct wmi_device *wdev, struct >> uniwill_method_buffer *input, >> + u32 *output) >> +{ >> + struct acpi_buffer out = { ACPI_ALLOCATE_BUFFER, NULL }; >> + struct acpi_buffer in = { >> + .length = sizeof(*input), >> + .pointer = input, >> + }; >> + union acpi_object *obj; >> + acpi_status status; >> + int ret = 0; >> + >> + status = wmidev_evaluate_method(wdev, 0x0, >> UNIWILL_GET_SET_ULONG, &in, &out); >> + if (ACPI_FAILURE(status)) >> + return -EIO; >> + >> + obj = out.pointer; >> + if (!obj) >> + return -ENODATA; >> + >> + if (obj->type != ACPI_TYPE_BUFFER) { >> + ret = -ENOMSG; >> + goto free_obj; >> + } >> + >> + if (obj->buffer.length < sizeof(*output)) { >> + ret = -EPROTO; >> + goto free_obj; >> + } >> + >> + *output = get_unaligned_le32(obj->buffer.pointer); >> + >> +free_obj: >> + kfree(obj); >> + >> + return ret; >> +} >> + >> +static int uniwill_ec_reg_write(void *context, unsigned int reg, >> unsigned int val) >> +{ >> + struct uniwill_method_buffer input = { >> + .address = cpu_to_le16(reg), >> + .data = cpu_to_le16(val & U8_MAX), >> + .operation = 0x0000, >> + }; >> + struct uniwill_data *data = context; >> + u32 output; >> + int ret; >> + >> + ret = uniwill_get_set_ulong(data->wdev, &input, &output); >> + if (ret < 0) >> + return ret; >> + >> + if (output == 0xFEFEFEFE) >> + return -ENXIO; >> + >> + return 0; >> +} >> + >> +static int uniwill_ec_reg_read(void *context, unsigned int reg, >> unsigned int *val) >> +{ >> + struct uniwill_method_buffer input = { >> + .address = cpu_to_le16(reg), >> + .data = 0x0000, >> + .operation = cpu_to_le16(0x0100), >> + }; >> + struct uniwill_data *data = context; >> + u32 output; >> + int ret; >> + >> + ret = uniwill_get_set_ulong(data->wdev, &input, &output); >> + if (ret < 0) >> + return ret; >> + >> + if (output == 0xFEFEFEFE) >> + return -ENXIO; >> + >> + *val = (u8)output; >> + >> + return 0; >> +} >> + >> +static const struct regmap_bus uniwill_ec_bus = { >> + .reg_write = uniwill_ec_reg_write, >> + .reg_read = uniwill_ec_reg_read, >> + .reg_format_endian_default = REGMAP_ENDIAN_LITTLE, >> + .val_format_endian_default = REGMAP_ENDIAN_LITTLE, >> +}; >> + >> +static bool uniwill_writeable_reg(struct device *dev, unsigned int reg) >> +{ >> + switch (reg) { >> + case EC_ADDR_AP_OEM: >> + case EC_ADDR_LIGHTBAR_AC_CTRL: >> + case EC_ADDR_LIGHTBAR_AC_RED: >> + case EC_ADDR_LIGHTBAR_AC_GREEN: >> + case EC_ADDR_LIGHTBAR_AC_BLUE: >> + case EC_ADDR_BIOS_OEM: >> + case EC_ADDR_TRIGGER: >> + case EC_ADDR_OEM_4: >> + case EC_ADDR_CHARGE_CTRL: >> + case EC_ADDR_LIGHTBAR_BAT_CTRL: >> + case EC_ADDR_LIGHTBAR_BAT_RED: >> + case EC_ADDR_LIGHTBAR_BAT_GREEN: >> + case EC_ADDR_LIGHTBAR_BAT_BLUE: >> + return true; >> + default: >> + return false; >> + } >> +} >> + >> +static bool uniwill_readable_reg(struct device *dev, unsigned int reg) >> +{ >> + switch (reg) { >> + case EC_ADDR_CPU_TEMP: >> + case EC_ADDR_GPU_TEMP: >> + case EC_ADDR_MAIN_FAN_RPM_1: >> + case EC_ADDR_MAIN_FAN_RPM_2: >> + case EC_ADDR_SECOND_FAN_RPM_1: >> + case EC_ADDR_SECOND_FAN_RPM_2: >> + case EC_ADDR_BAT_ALERT: >> + case EC_ADDR_PROJECT_ID: >> + case EC_ADDR_AP_OEM: >> + case EC_ADDR_LIGHTBAR_AC_CTRL: >> + case EC_ADDR_LIGHTBAR_AC_RED: >> + case EC_ADDR_LIGHTBAR_AC_GREEN: >> + case EC_ADDR_LIGHTBAR_AC_BLUE: >> + case EC_ADDR_BIOS_OEM: >> + case EC_ADDR_PWM_1: >> + case EC_ADDR_PWM_2: >> + case EC_ADDR_TRIGGER: >> + case EC_ADDR_SWITCH_STATUS: >> + case EC_ADDR_OEM_4: >> + case EC_ADDR_CHARGE_CTRL: >> + case EC_ADDR_LIGHTBAR_BAT_CTRL: >> + case EC_ADDR_LIGHTBAR_BAT_RED: >> + case EC_ADDR_LIGHTBAR_BAT_GREEN: >> + case EC_ADDR_LIGHTBAR_BAT_BLUE: >> + return true; >> + default: >> + return false; >> + } >> +} >> + >> +static bool uniwill_volatile_reg(struct device *dev, unsigned int reg) >> +{ >> + switch (reg) { >> + case EC_ADDR_CPU_TEMP: >> + case EC_ADDR_GPU_TEMP: >> + case EC_ADDR_MAIN_FAN_RPM_1: >> + case EC_ADDR_MAIN_FAN_RPM_2: >> + case EC_ADDR_SECOND_FAN_RPM_1: >> + case EC_ADDR_SECOND_FAN_RPM_2: >> + case EC_ADDR_BAT_ALERT: >> + case EC_ADDR_PWM_1: >> + case EC_ADDR_PWM_2: >> + case EC_ADDR_TRIGGER: >> + case EC_ADDR_SWITCH_STATUS: >> + case EC_ADDR_CHARGE_CTRL: >> + return true; >> + default: >> + return false; >> + } >> +} >> + >> +static const struct regmap_config uniwill_ec_config = { >> + .reg_bits = 16, >> + .val_bits = 8, >> + .writeable_reg = uniwill_writeable_reg, >> + .readable_reg = uniwill_readable_reg, >> + .volatile_reg = uniwill_volatile_reg, >> + .can_sleep = true, >> + .max_register = 0xFFFF, >> + .cache_type = REGCACHE_MAPLE, >> + .use_single_read = true, >> + .use_single_write = true, >> +}; >> + >> +static ssize_t fn_lock_store(struct device *dev, struct >> device_attribute *attr, const char *buf, >> + size_t count) >> +{ >> + struct uniwill_data *data = dev_get_drvdata(dev); >> + unsigned int value; >> + int ret; >> + >> + ret = sysfs_match_string(uniwill_enable_disable_strings, buf); >> + if (ret < 0) >> + return ret; >> + >> + if (ret) >> + value = FN_LOCK_STATUS; >> + else >> + value = 0; >> + >> + ret = regmap_update_bits(data->regmap, EC_ADDR_BIOS_OEM, >> FN_LOCK_STATUS, value); >> + if (ret < 0) >> + return ret; >> + >> + return count; >> +} >> + >> +static ssize_t fn_lock_show(struct device *dev, struct >> device_attribute *attr, char *buf) >> +{ >> + struct uniwill_data *data = dev_get_drvdata(dev); >> + unsigned int value; >> + int ret; >> + >> + ret = regmap_read(data->regmap, EC_ADDR_BIOS_OEM, &value); >> + if (ret < 0) >> + return ret; >> + >> + return sysfs_emit(buf, "%s\n", str_enable_disable(value & >> FN_LOCK_STATUS)); >> +} >> + >> +static DEVICE_ATTR_RW(fn_lock); >> + >> +static ssize_t super_key_lock_store(struct device *dev, struct >> device_attribute *attr, >> + const char *buf, size_t count) >> +{ >> + struct uniwill_data *data = dev_get_drvdata(dev); >> + unsigned int value; >> + int ret; >> + >> + ret = sysfs_match_string(uniwill_enable_disable_strings, buf); >> + if (ret < 0) >> + return ret; >> + >> + guard(mutex)(&data->super_key_lock); >> + >> + ret = regmap_read(data->regmap, EC_ADDR_SWITCH_STATUS, &value); >> + if (ret < 0) >> + return ret; >> + >> + /* >> + * We can only toggle the super key lock, so we return early if >> the setting >> + * is already in the correct state. >> + */ >> + if (ret == !(value & SUPER_KEY_LOCK_STATUS)) > > comparing integer ret with boolean result > I already made sure that said integer only contains 0 or 1. However i just noticed that i overwrite this integer with the result of regmap_read(). I will introduce a separate integer to hold the result of sysfs_match_string(). Thanks, Armin Wolf >> + return count; >> + >> + ret = regmap_write_bits(data->regmap, EC_ADDR_TRIGGER, >> TRIGGER_SUPER_KEY_LOCK, >> + TRIGGER_SUPER_KEY_LOCK); >> + if (ret < 0) >> + return ret; >> + >> + return count; >> +} >> + >> +static ssize_t super_key_lock_show(struct device *dev, struct >> device_attribute *attr, char *buf) >> +{ >> + struct uniwill_data *data = dev_get_drvdata(dev); >> + unsigned int value; >> + int ret; >> + >> + ret = regmap_read(data->regmap, EC_ADDR_SWITCH_STATUS, &value); >> + if (ret < 0) >> + return ret; >> + >> + return sysfs_emit(buf, "%s\n", str_enable_disable(!(value & >> SUPER_KEY_LOCK_STATUS))); >> +} >> + >> +static DEVICE_ATTR_RW(super_key_lock); >> + >> +static ssize_t touchpad_toggle_store(struct device *dev, struct >> device_attribute *attr, >> + const char *buf, size_t count) >> +{ >> + struct uniwill_data *data = dev_get_drvdata(dev); >> + unsigned int value; >> + int ret; >> + >> + ret = sysfs_match_string(uniwill_enable_disable_strings, buf); >> + if (ret < 0) >> + return ret; >> + >> + if (ret) >> + value = 0; >> + else >> + value = TOUCHPAD_TOGGLE_OFF; >> + >> + ret = regmap_update_bits(data->regmap, EC_ADDR_OEM_4, >> TOUCHPAD_TOGGLE_OFF, value); >> + if (ret < 0) >> + return ret; >> + >> + return count; >> +} >> + >> +static ssize_t touchpad_toggle_show(struct device *dev, struct >> device_attribute *attr, char *buf) >> +{ >> + struct uniwill_data *data = dev_get_drvdata(dev); >> + unsigned int value; >> + int ret; >> + >> + ret = regmap_read(data->regmap, EC_ADDR_OEM_4, &value); >> + if (ret < 0) >> + return ret; >> + >> + return sysfs_emit(buf, "%s\n", str_enable_disable(!(value & >> TOUCHPAD_TOGGLE_OFF))); >> +} >> + >> +static DEVICE_ATTR_RW(touchpad_toggle); >> + >> +static ssize_t rainbow_animation_store(struct device *dev, struct >> device_attribute *attr, >> + const char *buf, size_t count) >> +{ >> + struct uniwill_data *data = dev_get_drvdata(dev); >> + unsigned int value; >> + int ret; >> + >> + ret = sysfs_match_string(uniwill_enable_disable_strings, buf); >> + if (ret < 0) >> + return ret; >> + >> + if (ret) >> + value = LIGHTBAR_WELCOME; >> + else >> + value = 0; >> + >> + ret = regmap_update_bits(data->regmap, EC_ADDR_LIGHTBAR_AC_CTRL, >> LIGHTBAR_WELCOME, value); >> + if (ret < 0) >> + return ret; >> + >> + ret = regmap_update_bits(data->regmap, >> EC_ADDR_LIGHTBAR_BAT_CTRL, LIGHTBAR_WELCOME, value); >> + if (ret < 0) >> + return ret; >> + >> + return count; >> +} >> + >> +static ssize_t rainbow_animation_show(struct device *dev, struct >> device_attribute *attr, char *buf) >> +{ >> + struct uniwill_data *data = dev_get_drvdata(dev); >> + unsigned int value; >> + int ret; >> + >> + ret = regmap_read(data->regmap, EC_ADDR_LIGHTBAR_AC_CTRL, &value); >> + if (ret < 0) >> + return ret; >> + >> + return sysfs_emit(buf, "%s\n", str_enable_disable(value & >> LIGHTBAR_WELCOME)); >> +} >> + >> +static DEVICE_ATTR_RW(rainbow_animation); >> + >> +static ssize_t breathing_in_suspend_store(struct device *dev, struct >> device_attribute *attr, >> + const char *buf, size_t count) >> +{ >> + struct uniwill_data *data = dev_get_drvdata(dev); >> + unsigned int value; >> + int ret; >> + >> + ret = sysfs_match_string(uniwill_enable_disable_strings, buf); >> + if (ret < 0) >> + return ret; >> + >> + if (ret) >> + value = 0; >> + else >> + value = LIGHTBAR_S3_OFF; >> + >> + ret = regmap_update_bits(data->regmap, EC_ADDR_LIGHTBAR_AC_CTRL, >> LIGHTBAR_S3_OFF, value); >> + if (ret < 0) >> + return ret; >> + >> + return count; >> +} >> + >> +static ssize_t breathing_in_suspend_show(struct device *dev, struct >> device_attribute *attr, >> + char *buf) >> +{ >> + struct uniwill_data *data = dev_get_drvdata(dev); >> + unsigned int value; >> + int ret; >> + >> + ret = regmap_read(data->regmap, EC_ADDR_LIGHTBAR_AC_CTRL, &value); >> + if (ret < 0) >> + return ret; >> + >> + return sysfs_emit(buf, "%s\n", str_enable_disable(!(value & >> LIGHTBAR_S3_OFF))); >> +} >> + >> +static DEVICE_ATTR_RW(breathing_in_suspend); >> + >> +static struct attribute *uniwill_attrs[] = { >> + /* Keyboard-related */ >> + &dev_attr_fn_lock.attr, >> + &dev_attr_super_key_lock.attr, >> + &dev_attr_touchpad_toggle.attr, >> + /* Lightbar-related */ >> + &dev_attr_rainbow_animation.attr, >> + &dev_attr_breathing_in_suspend.attr, >> + NULL >> +}; >> + >> +static umode_t uniwill_attr_is_visible(struct kobject *kobj, struct >> attribute *attr, int n) >> +{ >> + if (attr == &dev_attr_fn_lock.attr) { >> + if (supported_features & UNIWILL_FEATURE_FN_LOCK) >> + return attr->mode; >> + } >> + >> + if (attr == &dev_attr_super_key_lock.attr) { >> + if (supported_features & UNIWILL_FEATURE_SUPER_KEY_LOCK) >> + return attr->mode; >> + } >> + >> + if (attr == &dev_attr_touchpad_toggle.attr) { >> + if (supported_features & UNIWILL_FEATURE_TOUCHPAD_TOGGLE) >> + return attr->mode; >> + } >> + >> + if (attr == &dev_attr_rainbow_animation.attr || >> + attr == &dev_attr_breathing_in_suspend.attr) { >> + if (supported_features & UNIWILL_FEATURE_LIGHTBAR) >> + return attr->mode; >> + } >> + >> + return 0; >> +} >> + >> +static const struct attribute_group uniwill_group = { >> + .is_visible = uniwill_attr_is_visible, >> + .attrs = uniwill_attrs, >> +}; >> + >> +static const struct attribute_group *uniwill_groups[] = { >> + &uniwill_group, >> + NULL >> +}; >> + >> +static int uniwill_read(struct device *dev, enum hwmon_sensor_types >> type, u32 attr, int channel, >> + long *val) >> +{ >> + struct uniwill_data *data = dev_get_drvdata(dev); >> + unsigned int value; >> + __be16 rpm; >> + int ret; >> + >> + switch (type) { >> + case hwmon_temp: >> + switch (channel) { >> + case 0: >> + ret = regmap_read(data->regmap, EC_ADDR_CPU_TEMP, &value); >> + break; >> + case 1: >> + ret = regmap_read(data->regmap, EC_ADDR_GPU_TEMP, &value); >> + break; >> + default: >> + return -EOPNOTSUPP; >> + } >> + >> + if (ret < 0) >> + return ret; >> + >> + *val = value * MILLIDEGREE_PER_DEGREE; >> + return 0; >> + case hwmon_fan: >> + switch (channel) { >> + case 0: >> + ret = regmap_bulk_read(data->regmap, >> EC_ADDR_MAIN_FAN_RPM_1, &rpm, >> + sizeof(rpm)); >> + break; >> + case 1: >> + ret = regmap_bulk_read(data->regmap, >> EC_ADDR_SECOND_FAN_RPM_1, &rpm, >> + sizeof(rpm)); > > __be16 rpm ? returns values in cpu endian > We are reading multiple registers here, and the register holding the lower 8 bits of the fan speed is read last (and thus ends up at the end of the buffer). Because of this we have to perform this conversion here. >> + break; >> + default: >> + return -EOPNOTSUPP; >> + } >> + >> + if (ret < 0) >> + return ret; >> + >> + *val = be16_to_cpu(rpm); >> + return 0; >> + case hwmon_pwm: >> + switch (channel) { >> + case 0: >> + ret = regmap_read(data->regmap, EC_ADDR_PWM_1, &value); >> + break; >> + case 1: >> + ret = regmap_read(data->regmap, EC_ADDR_PWM_2, &value); >> + break; >> + default: >> + return -EOPNOTSUPP; >> + } > > missing ret check > Good catch. Thanks, Armin Wolf >> + >> + *val = fixp_linear_interpolate(0, 0, PWM_MAX, U8_MAX, value); >> + return 0; >> + default: >> + return -EOPNOTSUPP; >> + } >> +} >> + >> +static int uniwill_read_string(struct device *dev, enum >> hwmon_sensor_types type, u32 attr, >> + int channel, const char **str) >> +{ >> + switch (type) { >> + case hwmon_temp: >> + *str = uniwill_temp_labels[channel]; >> + return 0; >> + case hwmon_fan: >> + *str = uniwill_fan_labels[channel]; >> + return 0; >> + default: >> + return -EOPNOTSUPP; >> + } >> +} >> + >> +static const struct hwmon_ops uniwill_ops = { >> + .visible = 0444, >> + .read = uniwill_read, >> + .read_string = uniwill_read_string, >> +}; >> + >> +static const struct hwmon_channel_info * const uniwill_info[] = { >> + HWMON_CHANNEL_INFO(chip, HWMON_C_REGISTER_TZ), >> + HWMON_CHANNEL_INFO(temp, >> + HWMON_T_INPUT | HWMON_T_LABEL, >> + HWMON_T_INPUT | HWMON_T_LABEL), >> + HWMON_CHANNEL_INFO(fan, >> + HWMON_F_INPUT | HWMON_F_LABEL, >> + HWMON_F_INPUT | HWMON_F_LABEL), >> + HWMON_CHANNEL_INFO(pwm, >> + HWMON_PWM_INPUT, >> + HWMON_PWM_INPUT), >> + NULL >> +}; >> + >> +static const struct hwmon_chip_info uniwill_chip_info = { >> + .ops = &uniwill_ops, >> + .info = uniwill_info, >> +}; >> + >> +static int uniwill_hwmon_init(struct uniwill_data *data) >> +{ >> + struct device *hdev; >> + >> + if (!(supported_features & UNIWILL_FEATURE_HWMON)) >> + return 0; >> + >> + hdev = devm_hwmon_device_register_with_info(&data->wdev->dev, >> "uniwill", data, >> + &uniwill_chip_info, NULL); >> + >> + return PTR_ERR_OR_ZERO(hdev); >> +} >> + >> +static const unsigned int >> uniwill_led_channel_to_bat_reg[LED_CHANNELS] = { >> + EC_ADDR_LIGHTBAR_BAT_RED, >> + EC_ADDR_LIGHTBAR_BAT_GREEN, >> + EC_ADDR_LIGHTBAR_BAT_BLUE, >> +}; >> + >> +static const unsigned int >> uniwill_led_channel_to_ac_reg[LED_CHANNELS] = { >> + EC_ADDR_LIGHTBAR_AC_RED, >> + EC_ADDR_LIGHTBAR_AC_GREEN, >> + EC_ADDR_LIGHTBAR_AC_BLUE, >> +}; >> + >> +static int uniwill_led_brightness_set(struct led_classdev *led_cdev, >> enum led_brightness brightness) >> +{ >> + struct led_classdev_mc *led_mc_cdev = lcdev_to_mccdev(led_cdev); >> + struct uniwill_data *data = container_of(led_mc_cdev, struct >> uniwill_data, led_mc_cdev); >> + unsigned int value; >> + int ret; >> + >> + ret = led_mc_calc_color_components(led_mc_cdev, brightness); >> + if (ret < 0) >> + return ret; >> + >> + for (int i = 0; i < LED_CHANNELS; i++) { >> + /* Prevent the brightness values from overflowing */ >> + value = min(LED_MAX_BRIGHTNESS, >> data->led_mc_subled_info[i].brightness); >> + ret = regmap_write(data->regmap, >> uniwill_led_channel_to_ac_reg[i], value); >> + if (ret < 0) >> + return ret; >> + >> + ret = regmap_write(data->regmap, >> uniwill_led_channel_to_bat_reg[i], value); >> + if (ret < 0) >> + return ret; >> + } >> + >> + if (brightness) >> + value = 0; >> + else >> + value = LIGHTBAR_S0_OFF; >> + >> + ret = regmap_update_bits(data->regmap, EC_ADDR_LIGHTBAR_AC_CTRL, >> LIGHTBAR_S0_OFF, value); >> + if (ret < 0) >> + return ret; >> + >> + return regmap_update_bits(data->regmap, >> EC_ADDR_LIGHTBAR_BAT_CTRL, LIGHTBAR_S0_OFF, value); >> +} >> + >> +#define LIGHTBAR_MASK (LIGHTBAR_APP_EXISTS | LIGHTBAR_S0_OFF | >> LIGHTBAR_S3_OFF | LIGHTBAR_WELCOME) >> + >> +static int uniwill_led_init(struct uniwill_data *data) >> +{ >> + struct led_init_data init_data = { >> + .devicename = DRIVER_NAME, >> + .default_label = "multicolor:" LED_FUNCTION_STATUS, >> + .devname_mandatory = true, >> + }; >> + unsigned int color_indices[3] = { >> + LED_COLOR_ID_RED, >> + LED_COLOR_ID_GREEN, >> + LED_COLOR_ID_BLUE, >> + }; >> + unsigned int value; >> + int ret; >> + >> + if (!(supported_features & UNIWILL_FEATURE_LIGHTBAR)) >> + return 0; >> + >> + /* >> + * The EC has separate lightbar settings for AC and battery mode, >> + * so we have to ensure that both settings are the same. >> + */ >> + ret = regmap_read(data->regmap, EC_ADDR_LIGHTBAR_AC_CTRL, &value); >> + if (ret < 0) >> + return ret; >> + >> + value |= LIGHTBAR_APP_EXISTS; >> + ret = regmap_write(data->regmap, EC_ADDR_LIGHTBAR_AC_CTRL, value); >> + if (ret < 0) >> + return ret; >> + >> + /* >> + * The breathing animation during suspend is not supported when >> + * running on battery power. >> + */ >> + value |= LIGHTBAR_S3_OFF; >> + ret = regmap_update_bits(data->regmap, >> EC_ADDR_LIGHTBAR_BAT_CTRL, LIGHTBAR_MASK, value); >> + if (ret < 0) >> + return ret; >> + >> + data->led_mc_cdev.led_cdev.color = LED_COLOR_ID_MULTI; >> + data->led_mc_cdev.led_cdev.max_brightness = LED_MAX_BRIGHTNESS; >> + data->led_mc_cdev.led_cdev.flags = LED_REJECT_NAME_CONFLICT; >> + data->led_mc_cdev.led_cdev.brightness_set_blocking = >> uniwill_led_brightness_set; >> + >> + if (value & LIGHTBAR_S0_OFF) >> + data->led_mc_cdev.led_cdev.brightness = 0; >> + else >> + data->led_mc_cdev.led_cdev.brightness = LED_MAX_BRIGHTNESS; >> + >> + for (int i = 0; i < LED_CHANNELS; i++) { >> + data->led_mc_subled_info[i].color_index = color_indices[i]; >> + >> + ret = regmap_read(data->regmap, >> uniwill_led_channel_to_ac_reg[i], &value); >> + if (ret < 0) >> + return ret; >> + >> + /* >> + * Make sure that the initial intensity value is not greater >> than >> + * the maximum brightness. >> + */ >> + value = min(LED_MAX_BRIGHTNESS, value); >> + ret = regmap_write(data->regmap, >> uniwill_led_channel_to_ac_reg[i], value); >> + if (ret < 0) >> + return ret; >> + >> + ret = regmap_write(data->regmap, >> uniwill_led_channel_to_bat_reg[i], value); >> + if (ret < 0) >> + return ret; >> + >> + data->led_mc_subled_info[i].intensity = value; >> + data->led_mc_subled_info[i].channel = i; >> + } >> + >> + data->led_mc_cdev.subled_info = data->led_mc_subled_info; >> + data->led_mc_cdev.num_colors = LED_CHANNELS; >> + >> + return >> devm_led_classdev_multicolor_register_ext(&data->wdev->dev, >> &data->led_mc_cdev, >> + &init_data); >> +} >> + >> +static int uniwill_get_property(struct power_supply *psy, const >> struct power_supply_ext *ext, >> + void *drvdata, enum power_supply_property psp, >> + union power_supply_propval *val) >> +{ >> + struct uniwill_data *data = drvdata; >> + union power_supply_propval prop; >> + unsigned int regval; >> + int ret; >> + >> + switch (psp) { >> + case POWER_SUPPLY_PROP_HEALTH: >> + ret = power_supply_get_property_direct(psy, >> POWER_SUPPLY_PROP_PRESENT, &prop); >> + if (ret < 0) >> + return ret; >> + >> + if (!prop.intval) { >> + val->intval = POWER_SUPPLY_HEALTH_NO_BATTERY; >> + return 0; >> + } >> + >> + ret = power_supply_get_property_direct(psy, >> POWER_SUPPLY_PROP_STATUS, &prop); >> + if (ret < 0) >> + return ret; >> + >> + if (prop.intval == POWER_SUPPLY_STATUS_UNKNOWN) { >> + val->intval = POWER_SUPPLY_HEALTH_UNKNOWN; >> + return 0; >> + } >> + >> + ret = regmap_read(data->regmap, EC_ADDR_BAT_ALERT, ®val); >> + if (ret < 0) >> + return ret; >> + >> + if (regval) { >> + /* Charging issue */ >> + val->intval = POWER_SUPPLY_HEALTH_UNSPEC_FAILURE; >> + return 0; >> + } >> + >> + val->intval = POWER_SUPPLY_HEALTH_GOOD; >> + return 0; >> + case POWER_SUPPLY_PROP_CHARGE_CONTROL_END_THRESHOLD: >> + ret = regmap_read(data->regmap, EC_ADDR_CHARGE_CTRL, ®val); >> + if (ret < 0) >> + return ret; >> + >> + val->intval = clamp_val(FIELD_GET(CHARGE_CTRL_MASK, regval), >> 0, 100); >> + return 0; >> + default: >> + return -EINVAL; >> + } >> +} >> + >> +static int uniwill_set_property(struct power_supply *psy, const >> struct power_supply_ext *ext, >> + void *drvdata, enum power_supply_property psp, >> + const union power_supply_propval *val) >> +{ >> + struct uniwill_data *data = drvdata; >> + >> + switch (psp) { >> + case POWER_SUPPLY_PROP_CHARGE_CONTROL_END_THRESHOLD: >> + if (val->intval < 1 || val->intval > 100) >> + return -EINVAL; >> + >> + return regmap_update_bits(data->regmap, EC_ADDR_CHARGE_CTRL, >> CHARGE_CTRL_MASK, >> + val->intval); >> + default: >> + return -EINVAL; >> + } >> +} >> + >> +static int uniwill_property_is_writeable(struct power_supply *psy, >> + const struct power_supply_ext *ext, void *drvdata, >> + enum power_supply_property psp) >> +{ >> + if (psp == POWER_SUPPLY_PROP_CHARGE_CONTROL_END_THRESHOLD) >> + return true; >> + >> + return false; >> +} >> + >> +static const enum power_supply_property uniwill_properties[] = { >> + POWER_SUPPLY_PROP_HEALTH, >> + POWER_SUPPLY_PROP_CHARGE_CONTROL_END_THRESHOLD, >> +}; >> + >> +static const struct power_supply_ext uniwill_extension = { >> + .name = DRIVER_NAME, >> + .properties = uniwill_properties, >> + .num_properties = ARRAY_SIZE(uniwill_properties), >> + .get_property = uniwill_get_property, >> + .set_property = uniwill_set_property, >> + .property_is_writeable = uniwill_property_is_writeable, >> +}; >> + >> +static int uniwill_add_battery(struct power_supply *battery, struct >> acpi_battery_hook *hook) >> +{ >> + struct uniwill_data *data = container_of(hook, struct >> uniwill_data, hook); >> + struct uniwill_battery_entry *entry; >> + int ret; >> + >> + entry = kzalloc(sizeof(*entry), GFP_KERNEL); >> + if (!entry) >> + return -ENOMEM; >> + >> + ret = power_supply_register_extension(battery, >> &uniwill_extension, &data->wdev->dev, data); >> + if (ret < 0) { >> + kfree(entry); >> + return ret; >> + } >> + >> + scoped_guard(mutex, &data->battery_lock) { >> + entry->battery = battery; >> + list_add(&entry->head, &data->batteries); >> + } >> + >> + return 0; >> +} >> + >> +static int uniwill_remove_battery(struct power_supply *battery, >> struct acpi_battery_hook *hook) >> +{ >> + struct uniwill_data *data = container_of(hook, struct >> uniwill_data, hook); >> + struct uniwill_battery_entry *entry, *tmp; >> + >> + scoped_guard(mutex, &data->battery_lock) { >> + list_for_each_entry_safe(entry, tmp, &data->batteries, head) { >> + if (entry->battery == battery) { >> + list_del(&entry->head); >> + kfree(entry); >> + break; >> + } >> + } >> + } >> + >> + power_supply_unregister_extension(battery, &uniwill_extension); >> + >> + return 0; >> +} >> + >> +static int uniwill_battery_init(struct uniwill_data *data) >> +{ >> + int ret; >> + >> + if (!(supported_features & UNIWILL_FEATURE_BATTERY)) >> + return 0; >> + >> + ret = devm_mutex_init(&data->wdev->dev, &data->battery_lock); >> + if (ret < 0) >> + return ret; >> + >> + INIT_LIST_HEAD(&data->batteries); >> + data->hook.name = "Uniwill Battery Extension"; >> + data->hook.add_battery = uniwill_add_battery; >> + data->hook.remove_battery = uniwill_remove_battery; >> + >> + return devm_battery_hook_register(&data->wdev->dev, &data->hook); >> +} >> + >> +static int uniwill_notifier_call(struct notifier_block *nb, unsigned >> long action, void *dummy) >> +{ >> + struct uniwill_data *data = container_of(nb, struct >> uniwill_data, nb); >> + struct uniwill_battery_entry *entry; >> + >> + switch (action) { >> + case UNIWILL_OSD_BATTERY_ALERT: >> + scoped_guard(mutex, &data->battery_lock) { >> + list_for_each_entry(entry, &data->batteries, head) { >> + power_supply_changed(entry->battery); >> + } >> + } >> + >> + return NOTIFY_OK; >> + default: >> + return NOTIFY_DONE; >> + } >> +} >> + >> +static int uniwill_notifier_init(struct uniwill_data *data) >> +{ >> + data->nb.notifier_call = uniwill_notifier_call; >> + >> + return devm_uniwill_wmi_register_notifier(&data->wdev->dev, >> &data->nb); >> +} >> + >> +static void uniwill_disable_manual_control(void *context) >> +{ >> + struct uniwill_data *data = context; >> + >> + regmap_clear_bits(data->regmap, EC_ADDR_AP_OEM, >> ENABLE_MANUAL_CTRL); >> +} >> + >> +static int uniwill_ec_init(struct uniwill_data *data) >> +{ >> + unsigned int value; >> + int ret; >> + >> + ret = regmap_read(data->regmap, EC_ADDR_PROJECT_ID, &value); >> + if (ret < 0) >> + return ret; >> + >> + dev_dbg(&data->wdev->dev, "Project ID: %u\n", value); >> + >> + ret = regmap_set_bits(data->regmap, EC_ADDR_AP_OEM, >> ENABLE_MANUAL_CTRL); >> + if (ret < 0) >> + return ret; >> + >> + return devm_add_action_or_reset(&data->wdev->dev, >> uniwill_disable_manual_control, data); >> +} >> + >> +static int uniwill_probe(struct wmi_device *wdev, const void *context) >> +{ >> + struct uniwill_data *data; >> + struct regmap *regmap; >> + int ret; >> + >> + data = devm_kzalloc(&wdev->dev, sizeof(*data), GFP_KERNEL); >> + if (!data) >> + return -ENOMEM; >> + >> + data->wdev = wdev; >> + dev_set_drvdata(&wdev->dev, data); >> + >> + regmap = devm_regmap_init(&wdev->dev, &uniwill_ec_bus, data, >> &uniwill_ec_config); >> + if (IS_ERR(regmap)) >> + return PTR_ERR(regmap); >> + >> + data->regmap = regmap; >> + ret = devm_mutex_init(&wdev->dev, &data->super_key_lock); >> + if (ret < 0) >> + return ret; >> + >> + ret = uniwill_ec_init(data); >> + if (ret < 0) >> + return ret; >> + >> + ret = uniwill_battery_init(data); >> + if (ret < 0) >> + return ret; >> + >> + ret = uniwill_led_init(data); >> + if (ret < 0) >> + return ret; >> + >> + ret = uniwill_hwmon_init(data); >> + if (ret < 0) >> + return ret; >> + >> + return uniwill_notifier_init(data); >> +} >> + >> +static void uniwill_shutdown(struct wmi_device *wdev) >> +{ >> + struct uniwill_data *data = dev_get_drvdata(&wdev->dev); >> + >> + regmap_clear_bits(data->regmap, EC_ADDR_AP_OEM, >> ENABLE_MANUAL_CTRL); >> +} >> + >> +static int uniwill_suspend_keyboard(struct uniwill_data *data) >> +{ >> + if (!(supported_features & UNIWILL_FEATURE_SUPER_KEY_LOCK)) >> + return 0; >> + >> + /* >> + * The EC_ADDR_SWITCH_STATUS is maked as volatile, so we have to >> restore it >> + * ourself. > > typo maked ->marked > ourself -> ourselves > >> + */ >> + return regmap_read(data->regmap, EC_ADDR_SWITCH_STATUS, >> &data->last_switch_status); >> +} >> + >> +static int uniwill_suspend_battery(struct uniwill_data *data) >> +{ >> + if (!(supported_features & UNIWILL_FEATURE_BATTERY)) >> + return 0; >> + >> + /* >> + * Save the current charge limit in order to restore it during >> resume. >> + * We cannot use the regmap code for that since this register >> needs to >> + * be declared as volatile due to CHARGE_CTRL_REACHED. >> + */ >> + return regmap_read(data->regmap, EC_ADDR_CHARGE_CTRL, >> &data->last_charge_ctrl); >> +} >> + >> +static int uniwill_suspend(struct device *dev) >> +{ >> + struct uniwill_data *data = dev_get_drvdata(dev); >> + int ret; >> + >> + ret = uniwill_suspend_keyboard(data); >> + if (ret < 0) >> + return ret; >> + >> + ret = uniwill_suspend_battery(data); >> + if (ret < 0) >> + return ret; >> + >> + regcache_cache_only(data->regmap, true); >> + regcache_mark_dirty(data->regmap); >> + >> + return 0; >> +} >> + >> +static int uniwill_resume_keyboard(struct uniwill_data *data) >> +{ >> + unsigned int value; >> + int ret; >> + >> + if (!(supported_features & UNIWILL_FEATURE_SUPER_KEY_LOCK)) >> + return 0; >> + >> + ret = regmap_read(data->regmap, EC_ADDR_SWITCH_STATUS, &value); >> + if (ret < 0) >> + return ret; >> + >> + if ((data->last_switch_status & SUPER_KEY_LOCK_STATUS) == (value >> & SUPER_KEY_LOCK_STATUS)) >> + return 0; >> + >> + return regmap_write_bits(data->regmap, EC_ADDR_TRIGGER, >> TRIGGER_SUPER_KEY_LOCK, >> + TRIGGER_SUPER_KEY_LOCK); >> +} >> + >> +static int uniwill_resume_battery(struct uniwill_data *data) >> +{ >> + if (!(supported_features & UNIWILL_FEATURE_BATTERY)) >> + return 0; >> + >> + return regmap_update_bits(data->regmap, EC_ADDR_CHARGE_CTRL, >> CHARGE_CTRL_MASK, >> + data->last_charge_ctrl); >> +} >> + >> +static int uniwill_resume(struct device *dev) >> +{ >> + struct uniwill_data *data = dev_get_drvdata(dev); >> + int ret; >> + >> + regcache_cache_only(data->regmap, false); >> + >> + ret = regcache_sync(data->regmap); >> + if (ret < 0) >> + return ret; >> + >> + ret = uniwill_resume_keyboard(data); >> + if (ret < 0) >> + return ret; >> + >> + return uniwill_resume_battery(data); >> +} >> + >> +static DEFINE_SIMPLE_DEV_PM_OPS(uniwill_pm_ops, uniwill_suspend, >> uniwill_resume); >> + >> +/* >> + * We cannot fully trust this GUID since Uniwill just copied the WMI >> GUID >> + * from the Windows driver example, and others probably did the same. >> + * >> + * Because of this we cannot use this WMI GUID for autoloading. >> + */ >> +static const struct wmi_device_id uniwill_id_table[] = { >> + { UNIWILL_GUID, NULL }, >> + { } >> +}; >> + >> +static struct wmi_driver uniwill_driver = { >> + .driver = { >> + .name = DRIVER_NAME, >> + .dev_groups = uniwill_groups, >> + .probe_type = PROBE_PREFER_ASYNCHRONOUS, >> + .pm = pm_sleep_ptr(&uniwill_pm_ops), >> + }, >> + .id_table = uniwill_id_table, >> + .probe = uniwill_probe, >> + .shutdown = uniwill_shutdown, >> + .no_singleton = true, >> +}; >> + >> +static const struct dmi_system_id uniwill_dmi_table[] __initconst = { >> + { >> + .ident = "Intel NUC x15", >> + .matches = { >> + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Intel(R) Client Systems"), >> + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "LAPAC71H"), >> + }, >> + .driver_data = (void *)(UNIWILL_FEATURE_FN_LOCK | >> + UNIWILL_FEATURE_SUPER_KEY_LOCK | >> + UNIWILL_FEATURE_TOUCHPAD_TOGGLE | >> + UNIWILL_FEATURE_BATTERY | >> + UNIWILL_FEATURE_HWMON), >> + }, >> + { >> + .ident = "Intel NUC x15", >> + .matches = { >> + DMI_EXACT_MATCH(DMI_SYS_VENDOR, "Intel(R) Client Systems"), >> + DMI_EXACT_MATCH(DMI_PRODUCT_NAME, "LAPKC71F"), >> + }, >> + .driver_data = (void *)(UNIWILL_FEATURE_FN_LOCK | >> + UNIWILL_FEATURE_SUPER_KEY_LOCK | >> + UNIWILL_FEATURE_TOUCHPAD_TOGGLE | >> + UNIWILL_FEATURE_LIGHTBAR | >> + UNIWILL_FEATURE_BATTERY | >> + UNIWILL_FEATURE_HWMON), >> + }, >> + { } >> +}; >> +MODULE_DEVICE_TABLE(dmi, uniwill_dmi_table); >> + >> +static int __init uniwill_init(void) >> +{ >> + const struct dmi_system_id *id; >> + >> + id = dmi_first_match(uniwill_dmi_table); >> + if (!id) { >> + if (!force) >> + return -ENODEV; >> + >> + /* Assume that the device supports all features */ >> + supported_features = UINTPTR_MAX; >> + pr_warn("Loading on a potentially unsupported device\n"); >> + } else { >> + supported_features = (uintptr_t)id->driver_data; >> + } >> + >> + return wmi_driver_register(&uniwill_driver); >> +} >> +module_init(uniwill_init); >> + >> +static void __exit uniwill_exit(void) >> +{ >> + wmi_driver_unregister(&uniwill_driver); >> +} >> +module_exit(uniwill_exit); >> + >> +MODULE_AUTHOR("Armin Wolf <W_Armin@gmx.de>"); >> +MODULE_DESCRIPTION("Uniwill notebook driver"); >> +MODULE_LICENSE("GPL"); >> +MODULE_IMPORT_NS("UNIWILL"); >> diff --git a/drivers/platform/x86/uniwill/uniwill-wmi.c >> b/drivers/platform/x86/uniwill/uniwill-wmi.c >> index f38e4bbcd8b6..65700121ef52 100644 >> --- a/drivers/platform/x86/uniwill/uniwill-wmi.c >> +++ b/drivers/platform/x86/uniwill/uniwill-wmi.c >> @@ -161,7 +161,8 @@ static int uniwill_wmi_probe(struct wmi_device >> *wdev, const void *context) >> * We cannot fully trust this GUID since Uniwill just copied the >> WMI GUID >> * from the Windows driver example, and others probably did the same. >> * >> - * Because of this we cannot use this WMI GUID for autoloading. >> + * Because of this we cannot use this WMI GUID for autoloading. The >> uniwill-laptop >> + * driver will instead load this module as a dependency. >> */ >> static const struct wmi_device_id uniwill_wmi_id_table[] = { >> { UNIWILL_EVENT_GUID, NULL }, > > > Thanks, > Alok ^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: [PATCH 2/3] platform/x86: Add Uniwill laptop driver 2025-07-12 11:23 ` [PATCH 2/3] platform/x86: Add Uniwill laptop driver Armin Wolf 2025-07-12 12:31 ` [External] : " ALOK TIWARI @ 2025-07-13 2:56 ` kernel test robot 1 sibling, 0 replies; 11+ messages in thread From: kernel test robot @ 2025-07-13 2:56 UTC (permalink / raw) To: Armin Wolf, ilpo.jarvinen, hdegoede, chumuzero, corbet, cs, wse, ggo Cc: oe-kbuild-all, linux-doc, linux-kernel, platform-driver-x86, rdunlap, alok.a.tiwari, linux-leds, lee, pobrn Hi Armin, kernel test robot noticed the following build errors: [auto build test ERROR on lwn/docs-next] [also build test ERROR on linus/master v6.16-rc5 next-20250711] [If your patch is applied to the wrong git tree, kindly drop us a note. And when submitting patch, we suggest to use '--base' as documented in https://git-scm.com/docs/git-format-patch#_base_tree_information] url: https://github.com/intel-lab-lkp/linux/commits/Armin-Wolf/platform-x86-Add-Uniwill-WMI-driver/20250712-192556 base: git://git.lwn.net/linux.git docs-next patch link: https://lore.kernel.org/r/20250712112310.19964-3-W_Armin%40gmx.de patch subject: [PATCH 2/3] platform/x86: Add Uniwill laptop driver config: i386-allmodconfig (https://download.01.org/0day-ci/archive/20250713/202507131049.84GJKlqK-lkp@intel.com/config) compiler: gcc-12 (Debian 12.2.0-14+deb12u1) 12.2.0 reproduce (this is a W=1 build): (https://download.01.org/0day-ci/archive/20250713/202507131049.84GJKlqK-lkp@intel.com/reproduce) If you fix the issue in a separate patch/commit (i.e. not just a new version of the same patch/commit), kindly add following tags | Reported-by: kernel test robot <lkp@intel.com> | Closes: https://lore.kernel.org/oe-kbuild-all/202507131049.84GJKlqK-lkp@intel.com/ All errors (new ones prefixed by >>): drivers/platform/x86/uniwill/uniwill-laptop.c: In function 'uniwill_get_property': >> drivers/platform/x86/uniwill/uniwill-laptop.c:1060:23: error: implicit declaration of function 'power_supply_get_property_direct'; did you mean 'power_supply_get_property'? [-Werror=implicit-function-declaration] 1060 | ret = power_supply_get_property_direct(psy, POWER_SUPPLY_PROP_PRESENT, &prop); | ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | power_supply_get_property cc1: some warnings being treated as errors vim +1060 drivers/platform/x86/uniwill/uniwill-laptop.c 1048 1049 static int uniwill_get_property(struct power_supply *psy, const struct power_supply_ext *ext, 1050 void *drvdata, enum power_supply_property psp, 1051 union power_supply_propval *val) 1052 { 1053 struct uniwill_data *data = drvdata; 1054 union power_supply_propval prop; 1055 unsigned int regval; 1056 int ret; 1057 1058 switch (psp) { 1059 case POWER_SUPPLY_PROP_HEALTH: > 1060 ret = power_supply_get_property_direct(psy, POWER_SUPPLY_PROP_PRESENT, &prop); 1061 if (ret < 0) 1062 return ret; 1063 1064 if (!prop.intval) { 1065 val->intval = POWER_SUPPLY_HEALTH_NO_BATTERY; 1066 return 0; 1067 } 1068 1069 ret = power_supply_get_property_direct(psy, POWER_SUPPLY_PROP_STATUS, &prop); 1070 if (ret < 0) 1071 return ret; 1072 1073 if (prop.intval == POWER_SUPPLY_STATUS_UNKNOWN) { 1074 val->intval = POWER_SUPPLY_HEALTH_UNKNOWN; 1075 return 0; 1076 } 1077 1078 ret = regmap_read(data->regmap, EC_ADDR_BAT_ALERT, ®val); 1079 if (ret < 0) 1080 return ret; 1081 1082 if (regval) { 1083 /* Charging issue */ 1084 val->intval = POWER_SUPPLY_HEALTH_UNSPEC_FAILURE; 1085 return 0; 1086 } 1087 1088 val->intval = POWER_SUPPLY_HEALTH_GOOD; 1089 return 0; 1090 case POWER_SUPPLY_PROP_CHARGE_CONTROL_END_THRESHOLD: 1091 ret = regmap_read(data->regmap, EC_ADDR_CHARGE_CTRL, ®val); 1092 if (ret < 0) 1093 return ret; 1094 1095 val->intval = clamp_val(FIELD_GET(CHARGE_CTRL_MASK, regval), 0, 100); 1096 return 0; 1097 default: 1098 return -EINVAL; 1099 } 1100 } 1101 -- 0-DAY CI Kernel Test Service https://github.com/intel/lkp-tests/wiki ^ permalink raw reply [flat|nested] 11+ messages in thread
* [PATCH 3/3] Documentation: laptops: Add documentation for uniwill laptops 2025-07-12 11:23 [PATCH 0/3] platform/x86: Add support for Uniwill laptop features Armin Wolf 2025-07-12 11:23 ` [PATCH 1/3] platform/x86: Add Uniwill WMI driver Armin Wolf 2025-07-12 11:23 ` [PATCH 2/3] platform/x86: Add Uniwill laptop driver Armin Wolf @ 2025-07-12 11:23 ` Armin Wolf 2025-07-12 12:54 ` [External] : " ALOK TIWARI 2 siblings, 1 reply; 11+ messages in thread From: Armin Wolf @ 2025-07-12 11:23 UTC (permalink / raw) To: ilpo.jarvinen, hdegoede, chumuzero, corbet, cs, wse, ggo Cc: linux-doc, linux-kernel, platform-driver-x86, rdunlap, alok.a.tiwari, linux-leds, lee, pobrn Add documentation for admins regarding Uniwill laptops. This should help users to setup the uniwill-laptop and uniwill-wmi drivers, which sadly cannot be loaded automatically. Reported-by: cyear <chumuzero@gmail.com> Closes: https://github.com/lm-sensors/lm-sensors/issues/508 Closes: https://github.com/Wer-Wolf/uniwill-laptop/issues/3 Signed-off-by: Armin Wolf <W_Armin@gmx.de> --- Documentation/admin-guide/laptops/index.rst | 1 + .../admin-guide/laptops/uniwill-laptop.rst | 68 +++++++++++++++++++ MAINTAINERS | 1 + 3 files changed, 70 insertions(+) create mode 100644 Documentation/admin-guide/laptops/uniwill-laptop.rst diff --git a/Documentation/admin-guide/laptops/index.rst b/Documentation/admin-guide/laptops/index.rst index db842b629303..6432c251dc95 100644 --- a/Documentation/admin-guide/laptops/index.rst +++ b/Documentation/admin-guide/laptops/index.rst @@ -17,3 +17,4 @@ Laptop Drivers sonypi thinkpad-acpi toshiba_haps + uniwill-laptop diff --git a/Documentation/admin-guide/laptops/uniwill-laptop.rst b/Documentation/admin-guide/laptops/uniwill-laptop.rst new file mode 100644 index 000000000000..29f6ee88063b --- /dev/null +++ b/Documentation/admin-guide/laptops/uniwill-laptop.rst @@ -0,0 +1,68 @@ +.. SPDX-License-Identifier: GPL-2.0+ + +Uniwill laptop extra features +============================= + +On laptops manufactured by Uniwill (either directly or as ODM), the ``uniwill-laptop`` and +``uniwill-wmi`` driver both handle various platform-specific features. +However due to a design flaw in the underlying firmware interface, both drivers might need +to be loaded manually on some devices. + +.. warning:: Not all devices supporting the firmware interface will necessarily support those + drivers, please be careful. + +Module Loading +-------------- + +The ``uniwill-laptop`` driver relies on a DMI table to automatically load on supported devices. +When using the ``force`` module parameter, this DMI check will be omitted, allowing the driver +to be loaded on unsupported devices for testing purposes. + +The ``uniwill-wmi`` driver always needs to be loaded manually. However the ``uniwill-laptop`` +driver will automatically load it as a dependency. + +Hotkeys +------- + +Usually the FN keys work without a special driver. However as soon as the ``uniwill-laptop`` driver +is loaded, the FN keys need to be handled manually. This is done by the ``uniwill-wmi`` driver. + +Keyboard settings +----------------- + +The ``uniwill-laptop`` driver allows the user to enable/disable: + + - the FN and super key lock functionality of the integrated keyboard + - the touchpad toggle functionality of the integrated touchpad + +See Documentation/ABI/testing/sysfs-driver-uniwill-laptop for details. + +Hwmon interface +--------------- + +The ``uniwill-laptop`` driver supports reading of the CPU and GPU temperature and supports up to +two fans. Userspace applications can access sensor readings over the hwmon sysfs interface. + +Platform profile +---------------- + +Support for changing the platform performance mode is currently not implemented. + +Battery Charging Control +------------------------ + +The ``uniwill-laptop`` driver supports controlling the battery charge limit. This happens over +the standard ``charge_control_end_threshold`` power supply sysfs attribute. All values +between 1 and 100 percent are supported. + +Additionally the driver signals the presence of battery charging issues thru the standard ``health`` +power supply sysfs attribute. + +Lightbar +-------- + +The ``uniwill-laptop`` driver exposes the lightbar found on some models as a standard multicolor +LED class device. The default name of this LED class device is ``uniwill:multicolor:status``. + +See Documentation/ABI/testing/sysfs-driver-uniwill-laptop for details on how to control the various +animation modes of the lightbar. diff --git a/MAINTAINERS b/MAINTAINERS index 3efec7a99262..fe302a610fe6 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -25495,6 +25495,7 @@ M: Armin Wolf <W_Armin@gmx.de> L: platform-driver-x86@vger.kernel.org S: Maintained F: Documentation/ABI/testing/sysfs-driver-uniwill-laptop +F: Documentation/admin-guide/laptops/uniwill-laptop.rst F: Documentation/wmi/devices/uniwill-laptop.rst F: drivers/platform/x86/uniwill/uniwill-laptop.c -- 2.39.5 ^ permalink raw reply related [flat|nested] 11+ messages in thread
* Re: [External] : [PATCH 3/3] Documentation: laptops: Add documentation for uniwill laptops 2025-07-12 11:23 ` [PATCH 3/3] Documentation: laptops: Add documentation for uniwill laptops Armin Wolf @ 2025-07-12 12:54 ` ALOK TIWARI 2025-07-16 16:51 ` Armin Wolf 0 siblings, 1 reply; 11+ messages in thread From: ALOK TIWARI @ 2025-07-12 12:54 UTC (permalink / raw) To: Armin Wolf, ilpo.jarvinen, hdegoede, chumuzero, corbet, cs, wse, ggo Cc: linux-doc, linux-kernel, platform-driver-x86, rdunlap, linux-leds, lee, pobrn On 7/12/2025 4:53 PM, Armin Wolf wrote: > Add documentation for admins regarding Uniwill laptops. This should > help users to setup the uniwill-laptop and uniwill-wmi drivers, which > sadly cannot be loaded automatically. > > Reported-by: cyear <chumuzero@gmail.com> > Closes: https://urldefense.com/v3/__https://github.com/lm-sensors/lm-sensors/issues/508__;!!ACWV5N9M2RV99hQ!MfQKq-XQLt4Lj_zRVzpbw1q-Y2RgiAMwHHbA8oE3H1FH_iL99Vb9H29zjLtdHf1xmTUNkT6ZM-xUiZmfJew$ > Closes: https://urldefense.com/v3/__https://github.com/Wer-Wolf/uniwill-laptop/issues/3__;!!ACWV5N9M2RV99hQ!MfQKq-XQLt4Lj_zRVzpbw1q-Y2RgiAMwHHbA8oE3H1FH_iL99Vb9H29zjLtdHf1xmTUNkT6ZM-xU2Vmgr2k$ > Signed-off-by: Armin Wolf <W_Armin@gmx.de> > --- > Documentation/admin-guide/laptops/index.rst | 1 + > .../admin-guide/laptops/uniwill-laptop.rst | 68 +++++++++++++++++++ > MAINTAINERS | 1 + > 3 files changed, 70 insertions(+) > create mode 100644 Documentation/admin-guide/laptops/uniwill-laptop.rst > > diff --git a/Documentation/admin-guide/laptops/index.rst b/Documentation/admin-guide/laptops/index.rst > index db842b629303..6432c251dc95 100644 > --- a/Documentation/admin-guide/laptops/index.rst > +++ b/Documentation/admin-guide/laptops/index.rst > @@ -17,3 +17,4 @@ Laptop Drivers > sonypi > thinkpad-acpi > toshiba_haps > + uniwill-laptop > diff --git a/Documentation/admin-guide/laptops/uniwill-laptop.rst b/Documentation/admin-guide/laptops/uniwill-laptop.rst > new file mode 100644 > index 000000000000..29f6ee88063b > --- /dev/null > +++ b/Documentation/admin-guide/laptops/uniwill-laptop.rst > @@ -0,0 +1,68 @@ > +.. SPDX-License-Identifier: GPL-2.0+ > + > +Uniwill laptop extra features > +============================= > + > +On laptops manufactured by Uniwill (either directly or as ODM), the ``uniwill-laptop`` and > +``uniwill-wmi`` driver both handle various platform-specific features. > +However due to a design flaw in the underlying firmware interface, both drivers might need might need or may need (optional) > +to be loaded manually on some devices. > + > +.. warning:: Not all devices supporting the firmware interface will necessarily support those > + drivers, please be careful. > + > +Module Loading > +-------------- > + > +The ``uniwill-laptop`` driver relies on a DMI table to automatically load on supported devices. > +When using the ``force`` module parameter, this DMI check will be omitted, allowing the driver > +to be loaded on unsupported devices for testing purposes. > + > +The ``uniwill-wmi`` driver always needs to be loaded manually. However the ``uniwill-laptop`` > +driver will automatically load it as a dependency. > + > +Hotkeys > +------- > + > +Usually the FN keys work without a special driver. However as soon as the ``uniwill-laptop`` driver > +is loaded, the FN keys need to be handled manually. This is done by the ``uniwill-wmi`` driver. > + > +Keyboard settings > +----------------- > + > +The ``uniwill-laptop`` driver allows the user to enable/disable: > + > + - the FN and super key lock functionality of the integrated keyboard > + - the touchpad toggle functionality of the integrated touchpad > + > +See Documentation/ABI/testing/sysfs-driver-uniwill-laptop for details. > + > +Hwmon interface > +--------------- > + > +The ``uniwill-laptop`` driver supports reading of the CPU and GPU temperature and supports up to > +two fans. Userspace applications can access sensor readings over the hwmon sysfs interface. > + > +Platform profile > +---------------- > + > +Support for changing the platform performance mode is currently not implemented. > + > +Battery Charging Control > +------------------------ > + > +The ``uniwill-laptop`` driver supports controlling the battery charge limit. This happens over > +the standard ``charge_control_end_threshold`` power supply sysfs attribute. All values > +between 1 and 100 percent are supported. > + > +Additionally the driver signals the presence of battery charging issues thru the standard ``health`` thru -> through > +power supply sysfs attribute. > + > +Lightbar > +-------- > + > +The ``uniwill-laptop`` driver exposes the lightbar found on some models as a standard multicolor > +LED class device. The default name of this LED class device is ``uniwill:multicolor:status``. > + > +See Documentation/ABI/testing/sysfs-driver-uniwill-laptop for details on how to control the various > +animation modes of the lightbar. > diff --git a/MAINTAINERS b/MAINTAINERS > index 3efec7a99262..fe302a610fe6 100644 > --- a/MAINTAINERS > +++ b/MAINTAINERS > @@ -25495,6 +25495,7 @@ M: Armin Wolf <W_Armin@gmx.de> > L: platform-driver-x86@vger.kernel.org > S: Maintained > F: Documentation/ABI/testing/sysfs-driver-uniwill-laptop > +F: Documentation/admin-guide/laptops/uniwill-laptop.rst > F: Documentation/wmi/devices/uniwill-laptop.rst > F: drivers/platform/x86/uniwill/uniwill-laptop.c > Thanks, Alok ^ permalink raw reply [flat|nested] 11+ messages in thread
* Re: [External] : [PATCH 3/3] Documentation: laptops: Add documentation for uniwill laptops 2025-07-12 12:54 ` [External] : " ALOK TIWARI @ 2025-07-16 16:51 ` Armin Wolf 0 siblings, 0 replies; 11+ messages in thread From: Armin Wolf @ 2025-07-16 16:51 UTC (permalink / raw) To: ALOK TIWARI, ilpo.jarvinen, hdegoede, chumuzero, corbet, cs, wse, ggo Cc: linux-doc, linux-kernel, platform-driver-x86, rdunlap, linux-leds, lee, pobrn Am 12.07.25 um 14:54 schrieb ALOK TIWARI: > On 7/12/2025 4:53 PM, Armin Wolf wrote: >> Add documentation for admins regarding Uniwill laptops. This should >> help users to setup the uniwill-laptop and uniwill-wmi drivers, which >> sadly cannot be loaded automatically. >> >> Reported-by: cyear <chumuzero@gmail.com> >> Closes: >> https://urldefense.com/v3/__https://github.com/lm-sensors/lm-sensors/issues/508__;!!ACWV5N9M2RV99hQ!MfQKq-XQLt4Lj_zRVzpbw1q-Y2RgiAMwHHbA8oE3H1FH_iL99Vb9H29zjLtdHf1xmTUNkT6ZM-xUiZmfJew$ >> Closes: >> https://urldefense.com/v3/__https://github.com/Wer-Wolf/uniwill-laptop/issues/3__;!!ACWV5N9M2RV99hQ!MfQKq-XQLt4Lj_zRVzpbw1q-Y2RgiAMwHHbA8oE3H1FH_iL99Vb9H29zjLtdHf1xmTUNkT6ZM-xU2Vmgr2k$ >> Signed-off-by: Armin Wolf <W_Armin@gmx.de> >> --- >> Documentation/admin-guide/laptops/index.rst | 1 + >> .../admin-guide/laptops/uniwill-laptop.rst | 68 +++++++++++++++++++ >> MAINTAINERS | 1 + >> 3 files changed, 70 insertions(+) >> create mode 100644 >> Documentation/admin-guide/laptops/uniwill-laptop.rst >> >> diff --git a/Documentation/admin-guide/laptops/index.rst >> b/Documentation/admin-guide/laptops/index.rst >> index db842b629303..6432c251dc95 100644 >> --- a/Documentation/admin-guide/laptops/index.rst >> +++ b/Documentation/admin-guide/laptops/index.rst >> @@ -17,3 +17,4 @@ Laptop Drivers >> sonypi >> thinkpad-acpi >> toshiba_haps >> + uniwill-laptop >> diff --git a/Documentation/admin-guide/laptops/uniwill-laptop.rst >> b/Documentation/admin-guide/laptops/uniwill-laptop.rst >> new file mode 100644 >> index 000000000000..29f6ee88063b >> --- /dev/null >> +++ b/Documentation/admin-guide/laptops/uniwill-laptop.rst >> @@ -0,0 +1,68 @@ >> +.. SPDX-License-Identifier: GPL-2.0+ >> + >> +Uniwill laptop extra features >> +============================= >> + >> +On laptops manufactured by Uniwill (either directly or as ODM), the >> ``uniwill-laptop`` and >> +``uniwill-wmi`` driver both handle various platform-specific features. >> +However due to a design flaw in the underlying firmware interface, >> both drivers might need > > might need or may need (optional) > >> +to be loaded manually on some devices. >> + >> +.. warning:: Not all devices supporting the firmware interface will >> necessarily support those >> + drivers, please be careful. >> + >> +Module Loading >> +-------------- >> + >> +The ``uniwill-laptop`` driver relies on a DMI table to automatically >> load on supported devices. >> +When using the ``force`` module parameter, this DMI check will be >> omitted, allowing the driver >> +to be loaded on unsupported devices for testing purposes. >> + >> +The ``uniwill-wmi`` driver always needs to be loaded manually. >> However the ``uniwill-laptop`` >> +driver will automatically load it as a dependency. >> + >> +Hotkeys >> +------- >> + >> +Usually the FN keys work without a special driver. However as soon >> as the ``uniwill-laptop`` driver >> +is loaded, the FN keys need to be handled manually. This is done by >> the ``uniwill-wmi`` driver. >> + >> +Keyboard settings >> +----------------- >> + >> +The ``uniwill-laptop`` driver allows the user to enable/disable: >> + >> + - the FN and super key lock functionality of the integrated keyboard >> + - the touchpad toggle functionality of the integrated touchpad >> + >> +See Documentation/ABI/testing/sysfs-driver-uniwill-laptop for details. >> + >> +Hwmon interface >> +--------------- >> + >> +The ``uniwill-laptop`` driver supports reading of the CPU and GPU >> temperature and supports up to >> +two fans. Userspace applications can access sensor readings over the >> hwmon sysfs interface. >> + >> +Platform profile >> +---------------- >> + >> +Support for changing the platform performance mode is currently not >> implemented. >> + >> +Battery Charging Control >> +------------------------ >> + >> +The ``uniwill-laptop`` driver supports controlling the battery >> charge limit. This happens over >> +the standard ``charge_control_end_threshold`` power supply sysfs >> attribute. All values >> +between 1 and 100 percent are supported. >> + >> +Additionally the driver signals the presence of battery charging >> issues thru the standard ``health`` > > thru -> through > Will fix. Thanks, Armin Wolf >> +power supply sysfs attribute. >> + >> +Lightbar >> +-------- >> + >> +The ``uniwill-laptop`` driver exposes the lightbar found on some >> models as a standard multicolor >> +LED class device. The default name of this LED class device is >> ``uniwill:multicolor:status``. >> + >> +See Documentation/ABI/testing/sysfs-driver-uniwill-laptop for >> details on how to control the various >> +animation modes of the lightbar. >> diff --git a/MAINTAINERS b/MAINTAINERS >> index 3efec7a99262..fe302a610fe6 100644 >> --- a/MAINTAINERS >> +++ b/MAINTAINERS >> @@ -25495,6 +25495,7 @@ M: Armin Wolf <W_Armin@gmx.de> >> L: platform-driver-x86@vger.kernel.org >> S: Maintained >> F: Documentation/ABI/testing/sysfs-driver-uniwill-laptop >> +F: Documentation/admin-guide/laptops/uniwill-laptop.rst >> F: Documentation/wmi/devices/uniwill-laptop.rst >> F: drivers/platform/x86/uniwill/uniwill-laptop.c > > Thanks, > Alok > ^ permalink raw reply [flat|nested] 11+ messages in thread
end of thread, other threads:[~2025-07-16 16:51 UTC | newest] Thread overview: 11+ messages (download: mbox.gz follow: Atom feed -- links below jump to the message on this page -- 2025-07-12 11:23 [PATCH 0/3] platform/x86: Add support for Uniwill laptop features Armin Wolf 2025-07-12 11:23 ` [PATCH 1/3] platform/x86: Add Uniwill WMI driver Armin Wolf 2025-07-12 11:46 ` [External] : " ALOK TIWARI 2025-07-16 16:37 ` Armin Wolf 2025-07-12 11:23 ` [PATCH 2/3] platform/x86: Add Uniwill laptop driver Armin Wolf 2025-07-12 12:31 ` [External] : " ALOK TIWARI 2025-07-16 16:47 ` Armin Wolf 2025-07-13 2:56 ` kernel test robot 2025-07-12 11:23 ` [PATCH 3/3] Documentation: laptops: Add documentation for uniwill laptops Armin Wolf 2025-07-12 12:54 ` [External] : " ALOK TIWARI 2025-07-16 16:51 ` Armin Wolf
This is a public inbox, see mirroring instructions for how to clone and mirror all data and code used for this inbox; as well as URLs for NNTP newsgroup(s).