Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

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: 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>
Link: https://patch.msgid.link/20251102172942.17879-3-W_Armin@gmx.de
Reviewed-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>
Signed-off-by: Ilpo Järvinen <ilpo.jarvinen@linux.intel.com>

authored by

Armin Wolf and committed by
Ilpo Järvinen
cec551ec d0504796

+62
+1
Documentation/admin-guide/laptops/index.rst
··· 17 17 sonypi 18 18 thinkpad-acpi 19 19 toshiba_haps 20 + uniwill-laptop
+60
Documentation/admin-guide/laptops/uniwill-laptop.rst
··· 1 + .. SPDX-License-Identifier: GPL-2.0+ 2 + 3 + Uniwill laptop extra features 4 + ============================= 5 + 6 + On laptops manufactured by Uniwill (either directly or as ODM), the ``uniwill-laptop`` driver 7 + handles various platform-specific features. 8 + 9 + Module Loading 10 + -------------- 11 + 12 + The ``uniwill-laptop`` driver relies on a DMI table to automatically load on supported devices. 13 + When using the ``force`` module parameter, this DMI check will be omitted, allowing the driver 14 + to be loaded on unsupported devices for testing purposes. 15 + 16 + Hotkeys 17 + ------- 18 + 19 + Usually the FN keys work without a special driver. However as soon as the ``uniwill-laptop`` driver 20 + is loaded, the FN keys need to be handled manually. This is done automatically by the driver itself. 21 + 22 + Keyboard settings 23 + ----------------- 24 + 25 + The ``uniwill-laptop`` driver allows the user to enable/disable: 26 + 27 + - the FN and super key lock functionality of the integrated keyboard 28 + - the touchpad toggle functionality of the integrated touchpad 29 + 30 + See Documentation/ABI/testing/sysfs-driver-uniwill-laptop for details. 31 + 32 + Hwmon interface 33 + --------------- 34 + 35 + The ``uniwill-laptop`` driver supports reading of the CPU and GPU temperature and supports up to 36 + two fans. Userspace applications can access sensor readings over the hwmon sysfs interface. 37 + 38 + Platform profile 39 + ---------------- 40 + 41 + Support for changing the platform performance mode is currently not implemented. 42 + 43 + Battery Charging Control 44 + ------------------------ 45 + 46 + The ``uniwill-laptop`` driver supports controlling the battery charge limit. This happens over 47 + the standard ``charge_control_end_threshold`` power supply sysfs attribute. All values 48 + between 1 and 100 percent are supported. 49 + 50 + Additionally the driver signals the presence of battery charging issues through the standard 51 + ``health`` power supply sysfs attribute. 52 + 53 + Lightbar 54 + -------- 55 + 56 + The ``uniwill-laptop`` driver exposes the lightbar found on some models as a standard multicolor 57 + LED class device. The default name of this LED class device is ``uniwill:multicolor:status``. 58 + 59 + See Documentation/ABI/testing/sysfs-driver-uniwill-laptop for details on how to control the various 60 + animation modes of the lightbar.
+1
MAINTAINERS
··· 26381 26381 L: platform-driver-x86@vger.kernel.org 26382 26382 S: Maintained 26383 26383 F: Documentation/ABI/testing/sysfs-driver-uniwill-laptop 26384 + F: Documentation/admin-guide/laptops/uniwill-laptop.rst 26384 26385 F: Documentation/wmi/devices/uniwill-laptop.rst 26385 26386 F: drivers/platform/x86/uniwill/uniwill-acpi.c 26386 26387 F: drivers/platform/x86/uniwill/uniwill-wmi.c