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..8b977c09e747
--- /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 5b12cc498d56..fa72aaf94bcb 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -25501,6 +25501,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.5Hi, On 6/15/25 10:59 AM, 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://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/uniwill-laptop.rst b/Documentation/admin-guide/laptops/uniwill-laptop.rst > new file mode 100644 > index 000000000000..8b977c09e747 > --- /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 What is this touchpad toggle functionality, please? > + > +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``. s/led/LED/ 2 places, preferably. > + > +See Documentation/ABI/testing/sysfs-driver-uniwill-laptop for details on how to control the various > +animation modes of the lightbar. -- ~Randy
Am 18.06.25 um 08:23 schrieb Randy Dunlap: > Hi, > > On 6/15/25 10:59 AM, 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://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/uniwill-laptop.rst b/Documentation/admin-guide/laptops/uniwill-laptop.rst >> new file mode 100644 >> index 000000000000..8b977c09e747 >> --- /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 > What is this touchpad toggle functionality, please? The integrated touchpad has a button to enable/disable touchpad input. This feature can be enabled/disabled using this setting. Thanks, Armin Wolf >> + >> +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``. > s/led/LED/ 2 places, preferably. > >> + >> +See Documentation/ABI/testing/sysfs-driver-uniwill-laptop for details on how to control the various >> +animation modes of the lightbar.
© 2016 - 2025 Red Hat, Inc.