Re: [External] : [PATCH 3/3] Documentation: laptops: Add documentation for uniwill laptops

[ALOK TIWARI <alok.a.tiwari@oracle.com>]

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