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