Unverified Commit cec551ec authored by Armin Wolf's avatar Armin Wolf Committed by Ilpo Järvinen
Browse files

Documentation: laptops: Add documentation for uniwill laptops 



Add documentation for admins regarding Uniwill laptops. This should
help them to setup the uniwill-laptop driver, which sadly cannot be
loaded automatically.

Reported-by: default avatarcyear <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: default avatarArmin Wolf <W_Armin@gmx.de>
Link: https://patch.msgid.link/20251102172942.17879-3-W_Armin@gmx.de


Reviewed-by: default avatarIlpo Järvinen <ilpo.jarvinen@linux.intel.com>
Signed-off-by: default avatarIlpo Järvinen <ilpo.jarvinen@linux.intel.com>
parent d0504796

Documentation/admin-guide/laptops/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -17,3 +17,4 @@ Laptop Drivers 
   sonypi

   thinkpad-acpi

   toshiba_haps

   uniwill-laptop

Documentation/admin-guide/laptops/uniwill-laptop.rst

0 → 100644
+60 −0
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GPL-2.0+



Uniwill laptop extra features

=============================



On laptops manufactured by Uniwill (either directly or as ODM), the ``uniwill-laptop`` driver

handles various platform-specific features.



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.



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 automatically by the driver itself.



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 through 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.

MAINTAINERS

+1 −0
Original line number Diff line number Diff line
@@ -26381,6 +26381,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-acpi.c

F:	drivers/platform/x86/uniwill/uniwill-wmi.c